aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/hyperscan/src/parser/ComponentRepeat.h
blob: 8565f1bb2617a1e7cc177d53051cc8b59a211d36 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/*
 * Copyright (c) 2015, Intel Corporation
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *  * Neither the name of Intel Corporation nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/** \file
 * \brief Repeats ('*', '+', '?', '{M,N}', etc)
 */

#ifndef RE_COMPONENTREPEAT_H
#define RE_COMPONENTREPEAT_H

#include "Component.h"
#include "position.h"
#include "ue2common.h"

#include <memory>
#include <utility>

namespace ue2 {

/** 
 * \brief Encapsulates a repeat of a subexpression ('*', '+', '?', '{M,N}', 
 * etc).
 *
 * ASCII Art Time: 
 *
 * Our standard representation of standard repeats. Other constructions (fan-in
 * vs fan-out) would also be possible and equivalent for our purposes.
 *
 * {n,m}
 *
 *     S->M->M->M->O->O->O->T 
 *              |     ^  ^  ^ 
 *              |     |  |  | 
 *              \-----------/ 
 *
 * {0,m}
 *
 *     /-----------\ 
 *     |           | 
 *     |           V 
 *     S->O->O->O->T 
 *        |  ^  ^  ^ 
 *        |  |  |  | 
 *        \--------/ 
 *
 */
class ComponentRepeat : public Component {
    friend class ConstructLiteralVisitor;
    friend class DumpVisitor;
    friend class PrintVisitor;
    friend class SimplifyVisitor;
public:
    /** \brief Value representing no maximum bound. */
    static constexpr u32 NoLimit = 0xffffffff;

    /** \brief Type of this repeat, characterising its
     * greediness/possessiveness. */
    enum RepeatType {
        /** Minimising repeat, like 'a*?'. */
        REPEAT_NONGREEDY,
        /** Maximising repeat, like 'a*'. This is the default in PCRE. */
        REPEAT_GREEDY,
        /** Possessive, maximising repeat, like 'a*+'. Possessive repeats are
         * only currently supported in prefiltering mode, where we treat them
         * the same way we treat normal greedy repeats. */
        REPEAT_POSSESSIVE,
    };

    ComponentRepeat(std::unique_ptr<Component> sub_comp, u32 min, u32 max,
                    RepeatType t);
    ~ComponentRepeat() override;
    ComponentRepeat *clone() const override;
    Component *accept(ComponentVisitor &v) override;
    void accept(ConstComponentVisitor &v) const override;

    std::vector<PositionInfo> first() const override;
    std::vector<PositionInfo> last() const override;
    bool empty() const override;
    bool repeatable() const override;
    bool vacuous_everywhere() const override;
    void notePositions(GlushkovBuildState &bs) override;
    void buildFollowSet(GlushkovBuildState &bs,
                        const std::vector<PositionInfo> &lastPos) override;
    bool checkEmbeddedStartAnchor(bool at_start) const override;
    bool checkEmbeddedEndAnchor(bool at_end) const override;

    void optimise(bool connected_to_sds) override;

    virtual std::pair<u32, u32> getBounds() const {
        return std::make_pair(m_min, m_max);
    }

    /** \brief From declared behaviour (not taking into account the
     * sub-component).  */
    enum RepeatType type;

protected:
    void postSubNotePositionHook();
    void wireRepeats(GlushkovBuildState &bs); 

    std::unique_ptr<Component> sub_comp;
    u32 m_min;
    u32 m_max;

    std::vector<std::vector<PositionInfo> > m_firsts;
    std::vector<std::vector<PositionInfo> > m_lasts;
    Position posFirst;
    Position posLast;

    ComponentRepeat(const ComponentRepeat &other);
};

std::unique_ptr<ComponentRepeat>
makeComponentRepeat(std::unique_ptr<Component> sub_comp, u32 min, u32 max,
                    ComponentRepeat::RepeatType t);

} // namespace ue2

#endif // _RE_COMPONENTREPEAT_H_