Console/Parse.hh

   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 public header */
  25
  26 #ifndef HH_Parse_
  27 #define HH_Parse_ 1
  28
  29 /** \defgroup console_parser The parser
  30
  31     The console/config library defines a simple language used to interact with the console or to
  32     configure the application.  The parser is not concerned about interpreting commands or
  33     arguments, checking that a command exists or managing directories. The parser just takes the
  34     input and parses it.
  35
  36     \autotoc
  37
  38     \section console_language The Language
  39
  40     The config/console language is used in configuration files and interactively at the
  41     console. Some features of the language are more useful in config files, others at the
  42     interactive console but the language is the same in both cases.
  43
  44     Let's start with a sample of the config/console language. The following is written as a
  45     configuration file
  46     \code
  47     # My someserver configuration file
  48
  49     /server/port 1234;
  50
  51     /logger/targets {
  52         console {
  53             accept senf::log::Debug IMPORTANT;
  54             accept server::ServerLog CRITICAL;
  55         }
  56
  57         provide serverlog senf::log::FileTarget "/var/log/server.log";
  58         serverlog {
  59             reject senf::log::Debug senf::Console::Server NOTICE;
  60             accept senf::log::Debug NOTICE;
  61             accept server::ServerLog;
  62         }
  63     }
  64
  65     /server/stuffing (UDPPacket x"01 02 03 04");
  66     /server/allow_hosts 10.1.2.3               # our internal server
  67                         10.2.3.4 10.4.3.5      # client workstations
  68         ;
  69
  70     /help/infoUrl "http://senf.j32.de/src/doc";
  71     \endcode
  72
  73     The interactive syntax is the same with some notes:
  74     \li All commands must be complete on a single line. This includes grouping constructs which must
  75         be closed on the same line they are opened.
  76     \li The last ';' is optional. However, multiple commands may be entered on a single line when
  77         they are separated by ';'.
  78     \li An empty line on the interactive console will repeat the last command.
  79
  80     The language consists of a small number of syntactic entities:
  81
  82     \subsection console_special_chars Special characters
  83
  84     These are characters, which have a special meaning. Some are used internally, others are just
  85     returned as punctuation tokens
  86
  87     <table class="senf">
  88     <tr><td>/</td><td>path component separator</td></tr>
  89     <tr><td>( )</td><td>argument grouping</td></tr>
  90     <tr><td>{ }</td><td>directory grouping</td></tr>
  91     <tr><td>;</td><td>command terminator</td></tr>
  92     <tr><td>, =</td><td>punctuation tokens</td></tr>
  93     </table>
  94
  95     \subsection console_basic Basic elements
  96
  97     A <b>word</b> is \e any sequence of consecutive characters which does not include any special
  98     character. Examples for words are thus
  99     <pre>
 100     12.34
 101     jens@fokus.fraunhofer.de
 102     eth0
 103     1>2
 104     </pre>
 105
 106     The following are \e not valid words:
 107     <pre>
 108     a/b/c
 109     a,b
 110     </pre>
 111
 112     A <b>string literal</b> is just that: A double-quoted string (C/C++ style) possibly with
 113     embedded escape chars:
 114     <pre>
 115     "\"foo\nbar\""
 116     "\x04test"
 117     </pre>
 118
 119     A <b>hex-string literal</b> is used to represent binary data. It looks like a string which has
 120     only hexadecimal bytes or whitespace as contents (comments and newlines are Ok when not read
 121     from the interactive console)
 122     <pre>
 123     x"01 02 03 0405"
 124     x"01 02   # ID header
 125       0405    # payload
 126       "
 127     </pre>
 128
 129     A <b>token</b> is a \e word, \e string or \e hex-string, or a single special character (that's
 130     true, any special character is allowed as a token). '(' and ')' must be properly nested.
 131
 132     A <b>path</b> is a sequence of \e words separated by '/' (and optional whitespace). A path may
 133     have an optional initial and/or a terminating '/'.
 134     <pre>
 135     a/b/c
 136     foo / bar /
 137     /server
 138     </pre>
 139
 140     \subsection console_statements Statements
 141
 142     There are several types of statements:
 143     \li The bulk of all statements are \e path statements
 144     \li There are some \e built-in statements which are mostly useful at the interactive console
 145     \li A special form of statement is the <em>directory group</em>
 146
 147     A <b>path</b> statement consists of a (possibly relative) path followed by any number of
 148     arguments and terminated with a ';' (or end-of-input)
 149     <pre>
 150     /path/to/command arg1 "arg2" (complex=(1 2) another) ;
 151     </pre>
 152     Every argument is either
 153     \li A single word, string or hex-string
 154     \li or a parenthesized list of tokens.
 155
 156     So above command has three arguments: 'arg1', 'arg2' (a single token each) and one argument with
 157     the 7 tokens 'complex', '=', '(', '1', '2', ')', 'another'. The interpretation of the arguments
 158     is completely up to the command.
 159
 160     A <b>built-in</b> statement is one of
 161
 162     <table class="senf">
 163     <tr><td>\c cd \e path</td><td>Change current directory</td></tr>
 164     <tr><td>\c ls [ \e path ]</td><td>List contents of \e path or current directory</td></tr>
 165     <tr><td>\c exit</td><td>Exit interactive console</td></tr>
 166     <tr><td>\c help [ \e path ]</td><td>Show help for \e path or current directory</td></tr>
 167     </table>
 168
 169     A <b>directory group</b> statement is a block of statements all executed relatively to a fixed
 170     directory.
 171     <pre>
 172     /some/path {
 173         statement ;
 174         . . .
 175     }
 176     </pre>
 177     At the beginning of the block, the current directory is saved and the directory is changed to
 178     the given directory. All commands are executed and at the end of the block, the saved directory
 179     is restored.
 180
 181     \section console_parse_api The parser API
 182
 183     The senf::console::CommandParser is responsible for taking text input and turning it into a
 184     sequence of senf::console::ParseCommandInfo structures. The structures are returned by passing
 185     them successively to a callback function.
 186
 187     Every statement is returned as a senf::console::ParseCommandInfo instance. Directory groups are
 188     handled specially: They are divided into two special built-in commands called PUSHD and POPD.
 189  */
 190
 191 // Custom includes
 192 #include <string>
 193 #include <vector>
 194 #include <boost/utility.hpp>
 195 #include <boost/scoped_ptr.hpp>
 196 #include <boost/range/iterator_range.hpp>
 197 #include <boost/function.hpp>
 198
 199 //#include "Parse.mpp"
 200 ///////////////////////////////hh.p////////////////////////////////////////
 201
 202 namespace senf {
 203 namespace console {
 204
 205     namespace detail { struct ParserAccess; }
 206
 207     /** \brief Single argument token
 208
 209         All command arguments are split into tokens by the parser. Each token is returned as an
 210         ArgumentToken instance.
 211
 212         \ingroup console_parser
 213       */
 214     class ArgumentToken
 215     {
 216     public:
 217         std::string const & value() const; ///< String value of token
 218                                         /**< This value is properly unquoted */
 219
 220     protected:
 221
 222     private:
 223         explicit ArgumentToken(std::string token);
 224
 225         std::string token_;
 226
 227         friend class detail::ParserAccess;
 228     };
 229
 230     /** \brief Single parsed console command
 231
 232         Every command parsed is returned in a ParseCommandInfo instance. This information is purely
 233         taken from the parser, no semantic information is attached at this point, the config/console
 234         node tree is not involved in any why. ParseCommandInfo consist of
 235
 236         \li the type of command: built-in or normal command represented by a possibly relative path
 237             into the command tree.
 238         \li the command
 239         \li the arguments. Every argument consists of a range of ArgumentToken instances.
 240
 241         \ingroup console_parser
 242
 243         \todo Completely change the 'arguments()' member implementation: let the parser just
 244             generate a flat list of tokens and implement an 'argument iterator' with the following
 245             features: 1. return argument ranges, automatically detecting paranthesis 2. trying to
 246             increment the iterator beyond it's range just throws an argument syntax error. For this
 247             to work, the parser needs to not drop the outermost '()' pair 3. detect bad paranthesis
 248             (should not be necessary since the parser already does this). This allows to use this
 249             same iterator to parse nested complex arguments.
 250       */
 251     class ParseCommandInfo
 252     {
 253         typedef std::vector<ArgumentToken> Tokens;
 254         typedef std::vector<std::string> CommandPath;
 255
 256     public:
 257         typedef CommandPath::const_iterator path_iterator;
 258         typedef Tokens::const_iterator token_iterator;
 259         typedef boost::iterator_range<token_iterator> argument_value_type;
 260
 261
 262     private:
 263         typedef std::vector<argument_value_type> Arguments;
 264
 265     public:
 266         typedef Arguments::const_iterator argument_iterator;
 267         typedef Arguments::size_type size_type;
 268
 269         typedef boost::iterator_range<path_iterator> CommandPathRange;
 270         typedef boost::iterator_range<argument_iterator> ArgumentsRange;
 271         typedef boost::iterator_range<token_iterator> TokensRange;
 272
 273         enum BuiltinCommand { NoBuiltin,
 274                               BuiltinCD,
 275                               BuiltinLS,
 276                               BuiltinPUSHD,
 277                               BuiltinPOPD,
 278                               BuiltinEXIT,
 279                               BuiltinHELP };
 280
 281         BuiltinCommand builtin() const; ///< Command type
 282                                         /**< \returns \c NoBuiltin, if the command is an ordinary
 283                                              command, otherwise the id of the built-in command */
 284         CommandPathRange commandPath() const; ///< Command path
 285                                         /**< This is the path to the command if it is not a built-in
 286                                              command. Every element of the returned range
 287                                              constitutes one path element. If the first element is
 288                                              empty, the path is an absolute path, otherwise it is
 289                                              relative. If the last element is an empty string, the
 290                                              path ends with a '/' char. */
 291         ArgumentsRange arguments() const; ///< Command arguments
 292                                         /**< The returned range contains one TokensRange for each
 293                                              argument. */
 294         TokensRange tokens() const;     ///< All argument tokens
 295                                         /**< The returned range contains \e all argument tokens in a
 296                                              single range not divided into separate arguments. */
 297     protected:
 298
 299     private:
 300         void init();
 301         void setBuiltin(BuiltinCommand builtin);
 302         void setCommand(std::vector<std::string> & commandPath);
 303         void startArgument();
 304         void endArgument();
 305         void addToken(ArgumentToken const & token);
 306         void finalize();
 307
 308         struct MakeRange;
 309
 310         std::vector<std::string> commandPath_;
 311
 312         typedef std::pair<Tokens::size_type, Tokens::size_type> TempArgumentRange;
 313         typedef std::vector<TempArgumentRange> TempArguments;
 314
 315         BuiltinCommand builtin_;
 316         Tokens tokens_;
 317         Arguments arguments_;
 318         TempArguments tempArguments_;
 319
 320         friend class detail::ParserAccess;
 321     };
 322
 323     /**< \brief Output ParseCommandInfo instance
 324          \related ParseCommandInfo
 325       */
 326     std::ostream & operator<<(std::ostream & stream, ParseCommandInfo const & info);
 327
 328     /** \brief Parse commands
 329
 330         This class implements a parser for the console/config language. It supports parsing strings
 331         as well as files. For every parsed command, a callback function is called.
 332
 333         \implementation The implementation is based on Boost.Spirit. See the file \ref Parse.ih for
 334             the formal language grammar.
 335
 336         \implementation Parsing an arbitrary iostream is not supported since arbitrary streams are
 337             not seekable. If this is needed, it can however be provided using stream iterators and
 338             some special iterator adaptors from Boost.Spirit. However, the amount of backtracking
 339             needs to be analyzed before this is viable.
 340
 341         \todo Implement more detailed error reporting and error recovery.
 342
 343         \ingroup console_parser
 344       */
 345     class CommandParser
 346         : boost::noncopyable
 347     {
 348     public:
 349         ///////////////////////////////////////////////////////////////////////////
 350         // Types
 351
 352         typedef boost::function<void (ParseCommandInfo const &)> Callback;
 353
 354         ///////////////////////////////////////////////////////////////////////////
 355         ///\name Structors and default members
 356         ///@{
 357
 358         CommandParser();
 359         ~CommandParser();
 360
 361         ///@}
 362         ///////////////////////////////////////////////////////////////////////////
 363
 364         bool parse(std::string command, Callback cb); ///< Parse string
 365         bool parseFile(std::string filename, Callback cb); ///< Parse file
 366                                         /**< \throws SystemException if the file cannot be
 367                                              read. */
 368
 369     private:
 370         struct Impl;
 371
 372         Impl & impl();
 373
 374         boost::scoped_ptr<Impl> impl_;
 375     };
 376
 377 }}
 378
 379 ///////////////////////////////hh.e////////////////////////////////////////
 380 #include "Parse.cci"
 381 //#include "Parse.ct"
 382 //#include "Parse.cti"
 383 #endif
 384
 385 \f
 386 // Local Variables:
 387 // mode: c++
 388 // fill-column: 100
 389 // comment-column: 40
 390 // c-file-style: "senf"
 391 // indent-tabs-mode: nil
 392 // ispell-local-dictionary: "american"
 393 // compile-command: "scons -u test"
 394 // End: