1/*
2 * Copyright (c) 2015, Intel Corporation
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * * Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Intel Corporation nor the names of its contributors
13 * may be used to endorse or promote products derived from this software
14 * without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** \file
30 * \brief Sequence of Component objects.
31 */
32
33#ifndef COMPONENT_SEQUENCE_H
34#define COMPONENT_SEQUENCE_H
35
36#include "Component.h"
37#include "ComponentRepeat.h" // for ComponentRepeat::RepeatType
38#include "ue2common.h"
39
40#include <memory>
41#include <set>
42#include <vector>
43
44namespace ue2 {
45
46class ComponentAlternation;
47class GlushkovBuildState;
48
49// Encapsulates a number of sub expressions to be applied sequentially
50class ComponentSequence : public Component {
51 friend class DumpVisitor;
52 friend class PrintVisitor;
53 friend class SimplifyVisitor;
54public:
55 /** \brief capture index representing a sequence that ISN'T capturing */
56 static constexpr unsigned int NOT_CAPTURED = 65536;
57
58 ComponentSequence();
59 ~ComponentSequence() override;
60 ComponentSequence *clone() const override;
61 Component *accept(ComponentVisitor &v) override;
62 void accept(ConstComponentVisitor &v) const override;
63
64 bool addRepeat(u32 min, u32 max, ComponentRepeat::RepeatType type);
65
66 // overridden by ComponentCondReference, which can only have 1 or 2
67 // branches.
68 virtual void addAlternation();
69
70 virtual void finalize();
71
72 void addComponent(std::unique_ptr<Component> comp);
73
74 std::vector<PositionInfo> first() const override;
75 std::vector<PositionInfo> last() const override;
76 bool empty(void) const override;
77 bool vacuous_everywhere() const override;
78 void notePositions(GlushkovBuildState &bs) override;
79 void buildFollowSet(GlushkovBuildState &bs,
80 const std::vector<PositionInfo> &lastPos) override;
81 bool checkEmbeddedStartAnchor(bool at_start) const override;
82 bool checkEmbeddedEndAnchor(bool at_end) const override;
83
84 void optimise(bool connected_to_sds) override;
85
86 void setCaptureIndex(unsigned int idx) { capture_index = idx; }
87 unsigned int getCaptureIndex() const { return capture_index; }
88 void setCaptureName(const std::string &s) { capture_name = s; }
89 const std::string &getCaptureName() const { return capture_name; }
90
91 virtual const std::vector<std::unique_ptr<Component>> &getChildren() const {
92 return children;
93 }
94
95protected:
96 ComponentSequence(const ComponentSequence &other);
97
98 std::vector<std::unique_ptr<Component>> children;
99 std::unique_ptr<ComponentAlternation> alternation;
100
101private:
102 unsigned int capture_index;
103 std::string capture_name; //!< empty means no name
104};
105
106} // namespace ue2
107
108#endif
109