Console/Parse.ih

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   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.
  12 //
  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.
  17 //
  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.
  22
  23 /** \file
  24     \brief Parse internal header */
  25
  26 #ifndef IH_Parse_
  27 #define IH_Parse_ 1
  28
  29 // Custom includes
  30 #include <vector>
  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>
  38
  39 ///////////////////////////////ih.p////////////////////////////////////////
  40
  41 namespace senf {
  42 namespace console {
  43 namespace detail {
  44
  45     struct append_action
  46     {
  47         template <class T, class Value>
  48         void act(T & ref, Value const & value) const
  49             { ref += T(1, value); }
  50
  51         template <class T, class Iterator>
  52         void act(T & ref, Iterator const & f, Iterator const & l) const
  53             { ref += T(f,l); }
  54     };
  55
  56     template <class T>
  57     inline boost::spirit::ref_value_actor<T, append_action>
  58     append_a(T & ref)
  59     {
  60         return boost::spirit::ref_value_actor<T, append_action>(ref);
  61     }
  62
  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)
  66     {
  67         return boost::spirit::ref_const_ref_actor<T, Value, append_action>(ref, value);
  68     }
  69
  70     template <class ParseDispatcher>
  71     struct CommandGrammar : boost::spirit::grammar<CommandGrammar<ParseDispatcher> >
  72     {
  73         ///////////////////////////////////////////////////////////////////////////
  74         // Start rules
  75
  76         enum { CommandParser, SkipParser };
  77
  78         ///////////////////////////////////////////////////////////////////////////
  79         // The parse context (variables needed while parsing)
  80
  81         struct Context {
  82             std::string str;
  83             std::vector<std::string> path;
  84             char ch;
  85         };
  86
  87         Context & context;
  88
  89         ///////////////////////////////////////////////////////////////////////////
  90         // Dispatching semantic actions
  91
  92         ParseDispatcher & dispatcher;
  93
  94         struct Dispatch_actor
  95         {
  96             Dispatch_actor(boost::function<void ()> fn_) : fn (fn_) {}
  97
  98             template <class Value>
  99             void operator()(Value const & value) const
 100                 { fn(); }
 101
 102             template <class Iterator>
 103             void operator()(Iterator const & f, Iterator const & l) const
 104                 { fn(); }
 105
 106             boost::function<void ()> fn;
 107         };
 108
 109         template <class Callback>
 110         Dispatch_actor dispatch(Callback cb) const
 111             { return Dispatch_actor(boost::bind(cb, boost::ref(dispatcher))); }
 112
 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)); }
 116
 117         ///////////////////////////////////////////////////////////////////////////
 118
 119         CommandGrammar(ParseDispatcher & d, Context & c)
 120             : context(c), dispatcher(d) {}
 121
 122         template <class Scanner>
 123         struct definition
 124             : public boost::spirit::grammar_def< boost::spirit::rule<Scanner>,
 125                                                  boost::spirit::rule<Scanner> >
 126         {
 127             boost::spirit::rule<Scanner> command, path, argument, word, string, hexstring, token;
 128             boost::spirit::rule<Scanner> punctuation, hexbyte, balanced_tokens, simple_argument;
 129             boost::spirit::rule<Scanner> complex_argument, builtin, skip;
 130
 131             boost::spirit::chset<> special_p, punctuation_p, space_p, invalid_p, word_p;
 132
 133             boost::spirit::distinct_parser<> keyword_p;
 134
 135             definition(CommandGrammar const & self) :
 136
 137                 // Characters with a special meaning within the parser
 138                 // and characters reserved for future extensions
 139                 special_p ("/(){};"),
 140
 141                 // Characters which are returned as punctuation tokens
 142                 punctuation_p (",="),
 143
 144                 // Whitespace characters (we don't want newlines in there)
 145                 space_p (" \t"),
 146
 147                 // Invalid characters: All chars below \x20 (space) which are not space_p
 148                 // (don't put a \0 in the chset<> argument *string* ...)
 149                 invalid_p (
 150                     boost::spirit::chset<>('\0') | boost::spirit::chset<>("\x01-\x20") - space_p ),
 151
 152                 // Valid word characters
 153                 word_p (
 154                     boost::spirit::anychar_p - special_p - punctuation_p - space_p - invalid_p),
 155
 156                 // Keywords must not be followed by a word char or '/'
 157                 keyword_p ( word_p | boost::spirit::ch_p('/') )
 158
 159             {
 160                 using namespace boost::spirit;
 161                 typedef ParseDispatcher PD;
 162
 163                 builtin
 164                     =    keyword_p("cd")
 165                       >> path
 166                       >> eps_p                    [ self.dispatch(&PD::builtin_cd,
 167                                                                   boost::ref(self.context.path)) ]
 168                     |    keyword_p("ls")
 169                       >> ! path
 170                       >> eps_p                    [ self.dispatch(&PD::builtin_cd,
 171                                                                   boost::ref(self.context.path)) ]
 172                     ;
 173
 174                 command
 175                     =    builtin
 176                     |    path                     [ self.dispatch(&PD::beginCommand,
 177                                                                   boost::ref(self.context.path)) ]
 178                       >> * argument
 179                       >> ! ch_p(';')
 180                       >> eps_p                    [ self.dispatch(&PD::endCommand) ]
 181                     ;
 182
 183                 argument
 184                     =    simple_argument          [ self.dispatch(&PD::pushArgument,
 185                                                                   boost::ref(self.context.str)) ]
 186                     |    complex_argument
 187                     ;
 188
 189                 simple_argument         // All these return their value in context.str
 190                     =    string
 191                     |    hexstring
 192                     |    word
 193                     ;
 194
 195                 complex_argument        // Argument consists of multiple tokens
 196                     =    ch_p('(')                [ self.dispatch(&PD::openGroup) ]
 197                        >> * token
 198                        >> ch_p(')')               [ self.dispatch(&PD::closeGroup) ]
 199                     ;
 200
 201                 string                  // Returns value in context.str
 202                     =    eps_p                    [ clear_a(self.context.str) ]
 203                       >> lexeme_d
 204                          [
 205                              ch_p('"')
 206                           >> * ( ( lex_escape_ch_p[ assign_a(self.context.ch) ]
 207                                    - '"'
 208                                  )                [ append_a(self.context.str,
 209                                                              self.context.ch) ]
 210                                )
 211                           >> ch_p('"')
 212                          ]
 213                     ;
 214
 215                 hexstring               // Returns value in context.str
 216                     =    eps_p                    [ clear_a(self.context.str) ]
 217                       >> confix_p( "x\"", * hexbyte, '"' )
 218                     ;
 219
 220                 path                    // Returns value in context.path
 221                     =    eps_p                    [ clear_a(self.context.path) ]
 222                       >> ( ! ch_p('/')            [ push_back_a(self.context.path, "") ] )
 223                       >> (   word                 [ push_back_a(self.context.path) ]
 224                            % ch_p('/') )
 225                       >> ( ! ch_p('/')            [ push_back_a(self.context.path,"") ] )
 226                     ;
 227
 228                 balanced_tokens
 229                     =    ch_p('(')                [ self.dispatch(&PD::pushPunctuation, "(") ]
 230                       >> * token
 231                       >> ch_p(')')                [ self.dispatch(&PD::pushPunctuation, ")") ]
 232                     ;
 233
 234                 token
 235                     =    simple_argument          [ self.dispatch(&PD::pushWord,
 236                                                                   boost::ref(self.context.str)) ]
 237                     |    punctuation              [ self.dispatch(&PD::pushPunctuation,
 238                                                                   boost::ref(self.context.str)) ]
 239                     |    balanced_tokens
 240                     ;
 241
 242                 punctuation             // Returns value in context.str
 243                     =    punctuation_p            [ assign_a(self.context.str) ]
 244                     ;
 245
 246                 word                    // Returns value in context.str
 247                     =    lexeme_d[ + word_p ]     [ assign_a(self.context.str) ]
 248                     ;
 249
 250                 hexbyte
 251                     =    uint_parser<char, 16, 2, 2>()
 252                                                   [ append_a(self.context.str) ]
 253                     ;
 254
 255                 skip
 256                     =    space_p
 257                     |    comment_p('#')
 258                     ;
 259
 260                 BOOST_SPIRIT_DEBUG_TRACE_RULE(command,1);
 261                 BOOST_SPIRIT_DEBUG_TRACE_RULE(path,1);
 262                 BOOST_SPIRIT_DEBUG_TRACE_RULE(argument,1);
 263                 BOOST_SPIRIT_DEBUG_TRACE_RULE(word,1);
 264                 BOOST_SPIRIT_DEBUG_TRACE_RULE(string,1);
 265                 BOOST_SPIRIT_DEBUG_TRACE_RULE(hexstring,1);
 266                 BOOST_SPIRIT_DEBUG_TRACE_RULE(token,1);
 267                 BOOST_SPIRIT_DEBUG_TRACE_RULE(punctuation,1);
 268                 BOOST_SPIRIT_DEBUG_TRACE_RULE(hexbyte,1);
 269                 BOOST_SPIRIT_DEBUG_TRACE_RULE(balanced_tokens,1);
 270                 BOOST_SPIRIT_DEBUG_TRACE_RULE(simple_argument,1);
 271                 BOOST_SPIRIT_DEBUG_TRACE_RULE(complex_argument,1);
 272                 BOOST_SPIRIT_DEBUG_TRACE_RULE(builtin,1);
 273
 274                 start_parsers(
 275                     command,            // CommandParser
 276                     skip                // SkipParser
 277                 );
 278
 279             }
 280         };
 281     };
 282
 283 }}}
 284
 285 ///////////////////////////////ih.e////////////////////////////////////////
 286 #endif
 287
 288 \f
 289 // Local Variables:
 290 // mode: c++
 291 // fill-column: 100
 292 // comment-column: 40
 293 // c-file-style: "senf"
 294 // indent-tabs-mode: nil
 295 // ispell-local-dictionary: "american"
 296 // compile-command: "scons -u test"
 297 // End: