aboutsummaryrefslogtreecommitdiff
path: root/build2/test/script/parser
blob: e018548ac077fcfb0560ada3f931ef5d33c6be41 (plain)
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
// file      : build2/test/script/parser -*- C++ -*-
// copyright : Copyright (c) 2014-2017 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

#ifndef BUILD2_TEST_SCRIPT_PARSER
#define BUILD2_TEST_SCRIPT_PARSER

#include <build2/types>
#include <build2/utility>

#include <build2/parser>
#include <build2/diagnostics>

#include <build2/test/script/token>
#include <build2/test/script/script>

namespace build2
{
  namespace test
  {
    namespace script
    {
      class lexer;
      class runner;

      class parser: protected build2::parser
      {
        // Pre-parse. Issue diagnostics and throw failed in case of an error.
        //
      public:
        void
        pre_parse (script&);

        void
        pre_parse (istream&, script&);

        // Helpers.
        //
        // Parse attribute string and perform attribute-guided assignment.
        // Issue diagnostics and throw failed in case of an error.
        //
        void
        apply_value_attributes (const variable*, // Optional.
                                value& lhs,
                                value&& rhs,
                                const string& attributes,
                                token_type assign_kind,
                                const path& name); // For diagnostics.

        // Recursive descent parser.
        //
        // Usually (but not always) parse functions receive the token/type
        // from which it should start consuming and in return the token/type
        // should contain the first token that has not been consumed.
        //
        // Functions that are called parse_*() rather than pre_parse_*() are
        // used for both stages.
        //
      protected:
        bool
        pre_parse_demote_group_scope (unique_ptr<scope>&);

        token
        pre_parse_scope_body ();

        unique_ptr<group>
        pre_parse_scope_block (token&, token_type&, const string&);

        bool
        pre_parse_line (token&, token_type&,
                        optional<description>&,
                        lines* = nullptr,
                        bool one = false);

        bool
        pre_parse_if_else (token&, token_type&,
                           optional<description>&,
                           lines&);

        bool
        pre_parse_if_else_scope (token&, token_type&,
                                 optional<description>&,
                                 lines&);

        bool
        pre_parse_if_else_command (token&, token_type&,
                                   optional<description>&,
                                   lines&);

        void
        pre_parse_directive (token&, token_type&);

        void
        pre_parse_include_line (names, location);

        description
        pre_parse_leading_description (token&, token_type&);

        description
        parse_trailing_description (token&, token_type&);

        value
        parse_variable_line (token&, token_type&);

        command_expr
        parse_command_line (token&, token_type&);

        // Ordered sequence of here-document redirects that we can expect to
        // see after the command line.
        //
        struct here_redirect
        {
          size_t expr; // Index in command_expr.
          size_t pipe; // Index in command_pipe.
          int fd;      // Redirect fd (0 - in, 1 - out, 2 - err).
        };

        struct here_doc
        {
          // Redirects that share here_doc. Most of the time we will have no
          // more than 2 (2 - for the roundtrip test cases).
          //
          small_vector<here_redirect, 2> redirects;

          string end;
          bool literal;     // Literal (single-quote).
          string modifiers;

          // Regex introducer ('\0' if not a regex, so can be used as bool).
          //
          char regex;

          // Regex global flags. Meaningful if regex != '\0'.
          //
          string regex_flags;
        };
        using here_docs = vector<here_doc>;

        pair<command_expr, here_docs>
        parse_command_expr (token&, token_type&);

        command_exit
        parse_command_exit (token&, token_type&);

        void
        parse_here_documents (token&, token_type&,
                              pair<command_expr, here_docs>&);

        struct parsed_doc
        {
          union
          {
            string str;        // Here-document literal.
            regex_lines regex; // Here-document regex.
          };

          bool re;             // True if regex.
          uint64_t end_line;   // Here-document end marker location.
          uint64_t end_column;

          parsed_doc (string, uint64_t line, uint64_t column);
          parsed_doc (regex_lines&&, uint64_t line, uint64_t column);
          parsed_doc (parsed_doc&&); // Note: move constuctible-only type.
          ~parsed_doc ();
        };

        parsed_doc
        parse_here_document (token&, token_type&,
                             const string&,
                             const string& mode,
                             char re_intro);      // '\0' if not a regex.

        // Execute. Issue diagnostics and throw failed in case of an error.
        //
      public:
        void
        execute (script& s, runner& r);

        void
        execute (scope&, script&, runner&);

      protected:
        void
        exec_scope_body ();

        void
        exec_lines (lines::iterator, lines::iterator, size_t&, command_type);

        // Customization hooks.
        //
      protected:
        virtual lookup
        lookup_variable (name&&, string&&, const location&) override;

        // Number of quoted tokens since last reset. Note that this includes
        // the peeked token, if any.
        //
      protected:
        size_t
        quoted () const;

        void
        reset_quoted (token& current);

        size_t replay_quoted_;

        // Insert id into the id map checking for duplicates.
        //
      protected:
        const string&
        insert_id (string, location);

        // Set lexer pointers for both the current and the base classes.
        //
      protected:
        void
        set_lexer (lexer* l);

      protected:
        using base_parser = build2::parser;

        script* script_;

        // Pre-parse state.
        //
        using id_map = std::unordered_map<string, location>;
        using include_set = std::set<path>;

        group* group_;
        id_map* id_map_;
        include_set* include_set_; // Testscripts already included in this
                                   // scope. Must be absolute and normalized.
        lexer* lexer_;
        string id_prefix_; // Auto-derived id prefix.

        // Execute state.
        //
        runner* runner_;
        scope* scope_;
      };
    }
  }
}

#endif // BUILD2_TEST_SCRIPT_PARSER