4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 \brief Parse internal header */
31 #include <boost/regex.hpp>
32 #include <boost/spirit.hpp>
33 #include <boost/spirit/utility/grammar_def.hpp>
34 #include <boost/spirit/actor.hpp>
35 #include <boost/bind.hpp>
36 #include <boost/function.hpp>
37 #include <boost/ref.hpp>
39 ///////////////////////////////ih.p////////////////////////////////////////
47 template <class T, class Value>
48 void act(T & ref, Value const & value) const
49 { ref += T(1, value); }
51 template <class T, class Iterator>
52 void act(T & ref, Iterator const & f, Iterator const & l) const
57 inline boost::spirit::ref_value_actor<T, append_action>
60 return boost::spirit::ref_value_actor<T, append_action>(ref);
63 template <class T, class Value>
64 inline boost::spirit::ref_const_ref_actor<T, Value, append_action>
65 append_a(T & ref, Value const & value)
67 return boost::spirit::ref_const_ref_actor<T, Value, append_action>(ref, value);
70 template <class ParseDispatcher>
71 struct CommandGrammar : boost::spirit::grammar<CommandGrammar<ParseDispatcher> >
73 ///////////////////////////////////////////////////////////////////////////
76 enum { CommandParser, SkipParser };
78 ///////////////////////////////////////////////////////////////////////////
79 // The parse context (variables needed while parsing)
83 std::vector<std::string> path;
89 ///////////////////////////////////////////////////////////////////////////
90 // Dispatching semantic actions
92 ParseDispatcher & dispatcher;
96 Dispatch_actor(boost::function<void ()> fn_) : fn (fn_) {}
98 template <class Value>
99 void operator()(Value const & value) const
102 template <class Iterator>
103 void operator()(Iterator const & f, Iterator const & l) const
106 boost::function<void ()> fn;
109 template <class Callback>
110 Dispatch_actor dispatch(Callback cb) const
111 { return Dispatch_actor(boost::bind(cb, boost::ref(dispatcher))); }
113 template <class Callback, class Arg>
114 Dispatch_actor dispatch(Callback cb, Arg const & arg) const
115 { return Dispatch_actor(boost::bind(cb, boost::ref(dispatcher), arg)); }
117 ///////////////////////////////////////////////////////////////////////////
119 CommandGrammar(ParseDispatcher & d, Context & c)
120 : context(c), dispatcher(d) {}
122 template <class Scanner>
124 : public boost::spirit::grammar_def< boost::spirit::rule<Scanner>,
125 boost::spirit::rule<Scanner> >
127 boost::spirit::rule<Scanner> command, path, argument, word, string, hexstring, token,
128 punctuation, hexbyte, balanced_tokens, simple_argument, complex_argument, builtin,
129 skip, commands, block, statement, relpath, abspath;
130 boost::spirit::chset<> special_p, punctuation_p, space_p, invalid_p, word_p;
131 boost::spirit::distinct_parser<> keyword_p;
133 definition(CommandGrammar const & self) :
135 // Characters with a special meaning within the parser
136 special_p ("/(){};"),
138 // Characters which are returned as punctuation tokens
139 punctuation_p (",="),
141 // Whitespace characters
144 // Invalid characters: All chars below \x20 (space) which are not space_p
145 // (don't put a \0 in the chset<> argument *string* ...)
147 boost::spirit::chset<>('\0') | boost::spirit::chset<>("\x01-\x20") - space_p ),
149 // Valid word characters
151 boost::spirit::anychar_p - special_p - punctuation_p - space_p - invalid_p),
153 // Keywords must not be followed by a word char or '/'
154 keyword_p ( word_p | boost::spirit::ch_p('/') )
157 using namespace boost::spirit;
158 typedef ParseDispatcher PD;
160 ///////////////////////////////////////////////////////////////////
164 // This is EBNF with some minor tweaks to accommodate C++ syntax
166 // * and + precede their argument
169 // a % b match any number of a's separated by b
170 // a - b match a but not b
172 // Beside this, we use some special parsers (ch_p, eps_p, confix_p, lex_escape_ch_p,
173 // keyword_p, comment_p) and directives (lexeme_d), however, the parser should be
176 // ch_p match character
177 // eps_p always matches nothing (to attach unconditional actions)
178 // confix_p(a,b,c) match b, preceded by a and terminated by c. Used to parse
179 // string literals and comments
180 // lex_escape_ch_p match a lex style escape char. This is like a C++ style
181 // literal string escape char, however \x will be replaced by 'x'
182 // for any char 'x' if it has no special meaning.
183 // keyword_p match a delimited keyword
184 // comment_p(a,b) match comment starting with a and terminated with b. b
185 // defaults to end-of-line
187 // lexeme_d don't skip whitespace (as defined by the skip parser)
189 // Aligned to the right at column 50 are semantic actions.
191 // For clarity, I have used 'ch_p' explicitly throughout even though it is auxiliary
194 // More info is in the Boost.Spirit documentation
201 = builtin >> (ch_p(';') | end_p)
202 | path >> ( block | statement )
203 | ch_p(';') // Ignore empty commands
209 >> eps_p [ self.dispatch(&PD::builtin_cd,
210 boost::ref(self.context.path)) ]
213 >> eps_p [ self.dispatch(&PD::builtin_ls,
214 boost::ref(self.context.path)) ]
215 | keyword_p("exit") [ self.dispatch(&PD::builtin_exit) ]
219 >> eps_p [ self.dispatch(&PD::builtin_help,
220 boost::ref(self.context.path)) ]
224 = ch_p('{') [ self.dispatch(&PD::pushDirectory,
225 boost::ref(self.context.path)) ]
227 >> ch_p('}') [ self.dispatch(&PD::popDirectory) ]
231 = eps_p [ self.dispatch(&PD::beginCommand,
232 boost::ref(self.context.path)) ]
234 >> (ch_p(';') | end_p)
235 >> eps_p [ self.dispatch(&PD::endCommand) ]
239 = simple_argument [ self.dispatch(&PD::pushArgument,
240 boost::ref(self.context.str)) ]
244 simple_argument // All these return their value in context.str
250 complex_argument // Argument consists of multiple tokens
251 = ch_p('(') [ self.dispatch(&PD::openGroup) ]
253 >> ch_p(')') [ self.dispatch(&PD::closeGroup) ]
256 string // Returns value in context.str
257 = eps_p [ clear_a(self.context.str) ]
261 >> * ( ( lex_escape_ch_p[ assign_a(self.context.ch) ]
263 ) [ append_a(self.context.str,
270 hexstring // Returns value in context.str
271 = eps_p [ clear_a(self.context.str) ]
272 >> confix_p( "x\"", * hexbyte, '"' )
275 path // Returns value in context.path
276 = eps_p [ clear_a(self.context.path) ]
281 = ( word [ push_back_a(self.context.path) ]
283 >> ( ! ch_p('/') [ push_back_a(self.context.path,"") ] )
287 = ch_p('/') [ push_back_a(self.context.path, "") ]
289 | eps_p [ push_back_a(self.context.path, "") ] )
293 = ch_p('(') [ self.dispatch(&PD::pushPunctuation, "(") ]
295 >> ch_p(')') [ self.dispatch(&PD::pushPunctuation, ")") ]
299 = simple_argument [ self.dispatch(&PD::pushWord,
300 boost::ref(self.context.str)) ]
301 | punctuation [ self.dispatch(&PD::pushPunctuation,
302 boost::ref(self.context.str)) ]
306 punctuation // Returns value in context.str
307 = punctuation_p [ assign_a(self.context.str) ]
310 word // Returns value in context.str
311 = lexeme_d[ + word_p ] [ assign_a(self.context.str) ]
315 = uint_parser<char, 16, 2, 2>()
316 [ append_a(self.context.str) ]
320 = space_p | comment_p('#')
323 ///////////////////////////////////////////////////////////////////
326 commands, // CommandParser
330 BOOST_SPIRIT_DEBUG_TRACE_RULE(command,1);
331 BOOST_SPIRIT_DEBUG_TRACE_RULE(path,1);
332 BOOST_SPIRIT_DEBUG_TRACE_RULE(argument,1);
333 BOOST_SPIRIT_DEBUG_TRACE_RULE(word,1);
334 BOOST_SPIRIT_DEBUG_TRACE_RULE(string,1);
335 BOOST_SPIRIT_DEBUG_TRACE_RULE(hexstring,1);
336 BOOST_SPIRIT_DEBUG_TRACE_RULE(token,1);
337 BOOST_SPIRIT_DEBUG_TRACE_RULE(punctuation,1);
338 BOOST_SPIRIT_DEBUG_TRACE_RULE(hexbyte,1);
339 BOOST_SPIRIT_DEBUG_TRACE_RULE(balanced_tokens,1);
340 BOOST_SPIRIT_DEBUG_TRACE_RULE(simple_argument,1);
341 BOOST_SPIRIT_DEBUG_TRACE_RULE(complex_argument,1);
342 BOOST_SPIRIT_DEBUG_TRACE_RULE(builtin,1);
343 BOOST_SPIRIT_DEBUG_TRACE_RULE(commands,1);
344 BOOST_SPIRIT_DEBUG_TRACE_RULE(block,1);
345 BOOST_SPIRIT_DEBUG_TRACE_RULE(statement,1);
346 BOOST_SPIRIT_DEBUG_TRACE_RULE(relpath,1);
347 BOOST_SPIRIT_DEBUG_TRACE_RULE(abspath,1);
354 ///////////////////////////////ih.e////////////////////////////////////////
361 // comment-column: 40
362 // c-file-style: "senf"
363 // indent-tabs-mode: nil
364 // ispell-local-dictionary: "american"
365 // compile-command: "scons -u test"