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/iterator/iterator_facade.hpp>
 198 #include <boost/function.hpp>
 199 #include "../Utils/safe_bool.hh"
 200
 201 //#include "Parse.mpp"
 202 ///////////////////////////////hh.p////////////////////////////////////////
 203
 204 namespace senf {
 205 namespace console {
 206
 207     namespace detail { struct ParserAccess; }
 208
 209     /** \brief Single argument token
 210
 211         All command arguments are split into tokens by the parser. Each token is returned as an
 212         Token instance.
 213
 214         \ingroup console_parser
 215       */
 216     class Token
 217     {
 218     public:
 219         enum TokenType {
 220             None                = 0,
 221             PathSeparator       = 0x0001, // '/'
 222             ArgumentGroupOpen   = 0x0002, // '('
 223             ArgumentGroupClose  = 0x0004, // ')'
 224             DirectoryGroupOpen  = 0x0008, // '{'
 225             DirectoryGroupClose = 0x0010, // '}'
 226             CommandTerminator   = 0x0020, // ';'
 227             OtherPunctuation    = 0x0040,
 228             BasicString         = 0x0080,
 229             HexString           = 0x0100,
 230             Word                = 0x0200
 231         };
 232
 233         enum TokenGroup {
 234             ArgumentGrouper     = ArgumentGroupOpen
 235                                 | ArgumentGroupClose,
 236
 237             DirectoryGrouper    = DirectoryGroupOpen
 238                                 | DirectoryGroupClose,
 239
 240             Punctuation         = DirectoryGroupOpen
 241                                 | DirectoryGroupClose
 242                                 | PathSeparator
 243                                 | CommandTerminator
 244                                 | OtherPunctuation,
 245
 246             String              = BasicString
 247                                 | HexString,
 248
 249             SimpleArgument      = Word
 250                                 | BasicString
 251                                 | HexString
 252         };
 253
 254         Token();
 255         Token(TokenType type, std::string token);
 256
 257         std::string const & value() const; ///< String value of token
 258                                         /**< This value is properly unquoted */
 259
 260         TokenType type() const;         ///< Token type
 261
 262         bool is(unsigned tokens) const; ///< Check, whether tokens type matches \a tokens
 263                                         /**< \a tokens is a bit-mask of token types to check. */
 264
 265         bool operator==(Token const & other) const;
 266         bool operator!=(Token const & other) const;
 267
 268     protected:
 269
 270     private:
 271         TokenType type_;
 272         std::string token_;
 273     };
 274
 275     std::ostream & operator<<(std::ostream & os, Token const & token);
 276
 277     /** \brief Single parsed console command
 278
 279         Every command parsed is returned in a ParseCommandInfo instance. This information is purely
 280         taken from the parser, no semantic information is attached at this point, the config/console
 281         node tree is not involved in any why. ParseCommandInfo consist of
 282
 283         \li the type of command: built-in or normal command represented by a possibly relative path
 284             into the command tree.
 285         \li the command
 286         \li the arguments. Every argument consists of a range of Token instances.
 287
 288         \ingroup console_parser
 289       */
 290     class ParseCommandInfo
 291     {
 292         typedef std::vector<Token> Tokens;
 293         typedef std::vector<std::string> CommandPath;
 294
 295     public:
 296         class ArgumentIterator;
 297
 298         typedef CommandPath::const_iterator path_iterator;
 299         typedef Tokens::const_iterator token_iterator;
 300         typedef ArgumentIterator argument_iterator;
 301         typedef Tokens::size_type size_type;
 302
 303         typedef boost::iterator_range<path_iterator> CommandPathRange;
 304         typedef boost::iterator_range<argument_iterator> ArgumentsRange;
 305         typedef boost::iterator_range<token_iterator> TokensRange;
 306
 307         enum BuiltinCommand { NoBuiltin,
 308                               BuiltinCD,
 309                               BuiltinLS,
 310                               BuiltinPUSHD,
 311                               BuiltinPOPD,
 312                               BuiltinEXIT,
 313                               BuiltinHELP };
 314
 315         BuiltinCommand builtin() const; ///< Command type
 316                                         /**< \returns \c NoBuiltin, if the command is an ordinary
 317                                              command, otherwise the id of the built-in command */
 318         TokensRange commandPath() const; ///< Command path
 319                                         /**< This is the path to the command if it is not a built-in
 320                                              command. Every element of the returned range
 321                                              constitutes one path element. If the first element is
 322                                              empty, the path is an absolute path, otherwise it is
 323                                              relative. If the last element is an empty string, the
 324                                              path ends with a '/' char. */
 325         ArgumentsRange arguments() const; ///< Command arguments
 326                                         /**< The returned range contains one TokensRange for each
 327                                              argument. */
 328         TokensRange tokens() const;     ///< All argument tokens
 329                                         /**< The returned range contains \e all argument tokens in a
 330                                              single range not divided into separate arguments. */
 331     protected:
 332
 333     private:
 334         void init();
 335         void setBuiltin(BuiltinCommand builtin);
 336         void setCommand(std::vector<Token> & commandPath);
 337         void addToken(Token const & token);
 338
 339         struct MakeRange;
 340
 341         std::vector<Token> commandPath_;
 342         BuiltinCommand builtin_;
 343         Tokens tokens_;
 344
 345         friend class detail::ParserAccess;
 346     };
 347
 348     /** \brief Iterator parsing argument groups
 349
 350         This special iterator parses a token range returned by the parser into argument ranges. An
 351         argument range is either a single token or it is a range of tokens enclosed in matching
 352         parenthesis. The ParseCommandInfo::arguments() uses this iterator type. To recursively parse
 353         complex arguments, you can however use this iterator to divide a multi-token argument into
 354         further argument groups (e.g. to parse a list or vector of items).
 355
 356         This iterator is a bidirectional iterator \e not a random access iterator.
 357      */
 358     class ParseCommandInfo::ArgumentIterator
 359         : public boost::iterator_facade< ParseCommandInfo::ArgumentIterator,
 360                                          ParseCommandInfo::TokensRange,
 361                                          boost::bidirectional_traversal_tag,
 362                                          ParseCommandInfo::TokensRange >
 363     {
 364     public:
 365         ArgumentIterator();
 366         explicit ArgumentIterator(ParseCommandInfo::TokensRange::iterator i);
 367
 368     private:
 369         reference dereference() const;
 370         bool equal(ArgumentIterator const & other) const;
 371         void increment();
 372         void decrement();
 373
 374         mutable ParseCommandInfo::TokensRange::iterator b_;
 375         mutable ParseCommandInfo::TokensRange::iterator e_;
 376
 377         void setRange() const;
 378
 379         friend class boost::iterator_core_access;
 380         friend class ParseCommandInfo;
 381     };
 382
 383     /**  \brief Syntax error parsing command arguments exception
 384
 385         All errors while parsing the arguments of a command must be signaled by throwing an instance
 386         of SyntaxErrorException. This is important, so command overloading works.
 387      */
 388     struct SyntaxErrorException : public std::exception
 389     {
 390         explicit SyntaxErrorException(std::string const & msg = "");
 391         virtual ~SyntaxErrorException() throw();
 392
 393         virtual char const * what() const throw();
 394         std::string const & message() const;
 395
 396     private:
 397         std::string message_;
 398     };
 399
 400     /** \brief Wrapper checking argument iterator access for validity
 401
 402         CheckedArgumentIteratorWrapper is a wrapper around a range of arguments parsed using the
 403         ParseCommandInfo::ArgumentIterator. It is used to parse arguments either in a command
 404         (registered with manual argument parsing) or when defining a custom parser.
 405         \code
 406         void fn(std::ostream & out, senf::console::ParseCommandInfo command)
 407         {
 408             std:;string arg1;
 409             unsigned arg2 (0);
 410
 411             {
 412                 senf::console::CheckedArgumentIteratorWrapper arg (command.arguments());
 413                 senf::console::parse( *(arg++), arg1 );
 414                 senf::console::parse( *(arg++), arg2 );
 415             }
 416
 417             // ...
 418         }
 419         \endcode
 420
 421         To use the wrapper, you must ensure that:
 422         \li You increment the iterator \e past all arguments you parse. The iterator must point to
 423             the end of the range when parsing is complete.
 424         \li The iterator wrapper is destroyed after parsing but before executing the command itself
 425             begins.
 426
 427         Accessing a non-existent argument or failing to parse all arguments will raise a
 428         senf::console::SyntaxErrorException.
 429
 430         \see \link console_arg_custom Example customer parser \endlink
 431       */
 432     class CheckedArgumentIteratorWrapper
 433         : boost::noncopyable,
 434           public boost::iterator_facade< CheckedArgumentIteratorWrapper,
 435                                          ParseCommandInfo::TokensRange,
 436                                          boost::forward_traversal_tag,
 437                                          ParseCommandInfo::TokensRange >,
 438           public senf::safe_bool<CheckedArgumentIteratorWrapper>
 439
 440     {
 441         typedef boost::iterator_facade< CheckedArgumentIteratorWrapper,
 442                                         ParseCommandInfo::TokensRange,
 443                                         boost::forward_traversal_tag,
 444                                         ParseCommandInfo::TokensRange > IteratorFacade;
 445
 446     public:
 447         explicit CheckedArgumentIteratorWrapper(
 448             ParseCommandInfo::ArgumentsRange const & range,
 449             std::string const & msg = "invalid number of arguments");
 450                                         ///< Make wrapper from ArgumentsRange
 451                                         /**< This constructs a wrapper from a
 452                                              ParseCommandInfo::ArgumentsRange.
 453                                              \param[in] range Range of arguments to parse
 454                                              \param[in] msg Error message */
 455         explicit CheckedArgumentIteratorWrapper(
 456             ParseCommandInfo::TokensRange const & range,
 457             std::string const & msg = "invalid number of arguments");
 458                                         ///< Make wrapper from TokensRange
 459                                         /**< This constructs a wrapper from a
 460                                              ParseCommandInfo::TokensRange. The TokensRange is first
 461                                              converted into an ParseCommandInfo::ArgumentsRange
 462                                              which is then wrapped.
 463                                              \param[in] range Range of tokens to  parse
 464                                              \param[in] msg Error message */
 465
 466         ~CheckedArgumentIteratorWrapper(); ///< Check, if all arguments are parsed
 467                                         /**< The destructor validates, that all arguments are parsed
 468                                              correctly when leaving the scope, in which the wrapper
 469                                              is instantiated normally (not by an exception).
 470
 471                                              \warning This destructor will throw a
 472                                              SyntaxErrorException, if not all arguments are parsed
 473                                              and when no other exception is in progress. */
 474
 475         operator ParseCommandInfo::ArgumentIterator();
 476                                         ///< Use wrapper as ParseCommandInfo::ArgumentIterator
 477
 478         bool boolean_test() const;      ///< \c true, if more arguments are available
 479         bool done() const;              ///< \c true, if all arguments are parsed
 480
 481         void clear();                   ///< Set range empty
 482                                         /**< This call will point the current iterator to the end of
 483                                              the tokens range.
 484                                              \post done() == \c true; */
 485
 486         bool operator==(ParseCommandInfo::ArgumentIterator const & other) const;
 487                                         ///< Compare wrapper against ArgumentIterator
 488         bool operator!=(ParseCommandInfo::ArgumentIterator const & other) const;
 489                                         ///< Compare wrapper against ArgumentIterator
 490
 491         using IteratorFacade::operator++;
 492         ParseCommandInfo::ArgumentIterator operator++(int);
 493
 494     private:
 495         reference dereference() const;
 496         void increment();
 497
 498         ParseCommandInfo::ArgumentIterator i_;
 499         ParseCommandInfo::ArgumentIterator e_;
 500         std::string msg_;
 501
 502         friend class boost::iterator_core_access;
 503     };
 504
 505     /**< \brief Output ParseCommandInfo instance
 506          \related ParseCommandInfo
 507       */
 508     std::ostream & operator<<(std::ostream & stream, ParseCommandInfo const & info);
 509
 510     /** \brief Parse commands
 511
 512         This class implements a parser for the console/config language. It supports parsing strings
 513         as well as files. For every parsed command, a callback function is called.
 514
 515         \implementation The implementation is based on Boost.Spirit. See the file \ref Parse.ih for
 516             the formal language grammar.
 517
 518         \implementation Parsing an arbitrary iostream is not supported since arbitrary streams are
 519             not seekable. If this is needed, it can however be provided using stream iterators and
 520             some special iterator adaptors from Boost.Spirit. However, the amount of backtracking
 521             needs to be analyzed before this is viable.
 522
 523         \todo Implement more detailed error reporting and error recovery.
 524
 525         \ingroup console_parser
 526       */
 527     class CommandParser
 528         : boost::noncopyable
 529     {
 530     public:
 531         ///////////////////////////////////////////////////////////////////////////
 532         // Types
 533
 534         typedef boost::function<void (ParseCommandInfo const &)> Callback;
 535
 536         ///////////////////////////////////////////////////////////////////////////
 537         ///\name Structors and default members
 538         ///@{
 539
 540         CommandParser();
 541         ~CommandParser();
 542
 543         ///@}
 544         ///////////////////////////////////////////////////////////////////////////
 545
 546         bool parse(std::string command, Callback cb); ///< Parse string
 547         bool parseFile(std::string filename, Callback cb); ///< Parse file
 548                                         /**< \throws SystemException if the file cannot be
 549                                              read. */
 550
 551     private:
 552         struct Impl;
 553
 554         Impl & impl();
 555
 556         boost::scoped_ptr<Impl> impl_;
 557     };
 558
 559 }}
 560
 561 ///////////////////////////////hh.e////////////////////////////////////////
 562 #include "Parse.cci"
 563 //#include "Parse.ct"
 564 //#include "Parse.cti"
 565 #endif
 566
 567 \f
 568 // Local Variables:
 569 // mode: c++
 570 // fill-column: 100
 571 // comment-column: 40
 572 // c-file-style: "senf"
 573 // indent-tabs-mode: nil
 574 // ispell-local-dictionary: "american"
 575 // compile-command: "scons -u test"
 576 // End: