Includes

Modules

Spirit is designed to be header only. Generally, there are no libraries to build and link against. Certain features, however, require additional libraries; in particular the regular expression parser requires Boost.Regex and multithreading support requires Boost.Threads.

Using Spirit is as easy as including the main header file:

    #include <boost/spirit.hpp>

Doing so will include all the header files. This might not be desirable. A low cholesterol alternative is to include only the module that you need. Each of the modules has its own header file. The master spirit header file actually includes all the module files. To avoid unnecessary inclusion of features that you do not need, it is better to include only the modules that you need.

    #include <boost/spirit/actor.hpp>
    #include <boost/spirit/attribute.hpp>
    #include <boost/spirit/core.hpp>
    #include <boost/spirit/debug.hpp>
    #include <boost/spirit/dynamic.hpp>
    #include <boost/spirit/error_handling.hpp>
    #include <boost/spirit/iterator.hpp>
    #include <boost/spirit/meta.hpp>
    #include <boost/spirit/symbols.hpp>
    #include <boost/spirit/tree.hpp>
    #include <boost/spirit/utility.hpp>

Sub-Modules

For even finer control over header file inclusion, you can include only the specific files that you need. Each module is in its own sub-directory:

actor

    #include <boost/spirit/actor/assign_actor.hpp>
    #include <boost/spirit/actor/assign_key.hpp>
    #include <boost/spirit/actor/clear_actor.hpp>
    #include <boost/spirit/actor/decrement_actor.hpp>
    #include <boost/spirit/actor/erase_actor.hpp> 
    #include <boost/spirit/actor/increment_actor.hpp>
    #include <boost/spirit/actor/insert_key_actor.hpp>
    #include <boost/spirit/actor/push_back_actor.hpp>
    #include <boost/spirit/actor/push_front_actor.hpp>
    #include <boost/spirit/actor/swap_actor.hpp>

attribute

    #include <boost/spirit/attribute/closure.hpp>
    #include <boost/spirit/attribute/closure_context.hpp>
    #include <boost/spirit/attribute/parametric.hpp>

debug

The debug module should not be directly included. See Debugging for more info on how to use Spirit's debugger.

dynamic

    #include <boost/spirit/dynamic/for.hpp>
    #include <boost/spirit/dynamic/if.hpp>
    #include <boost/spirit/dynamic/lazy.hpp> 
    #include <boost/spirit/dynamic/rule_alias.hpp>
    #include <boost/spirit/dynamic/select.hpp>
    #include <boost/spirit/dynamic/stored_rule.hpp>
    #include <boost/spirit/dynamic/switch.hpp>
    #include <boost/spirit/dynamic/while.hpp> 

error_handling

    #include <boost/spirit/error_handling/exceptions.hpp>

iterator

    #include <boost/spirit/iterator/file_iterator.hpp>
    #include <boost/spirit/iterator/fixed_size_queue.hpp>
    #include <boost/spirit/iterator/multi_pass.hpp> 
    #include <boost/spirit/iterator/position_iterator.hpp>

meta

    #include <boost/spirit/meta/as_parser.hpp>
    #include <boost/spirit/meta/fundamental.hpp>
    #include <boost/spirit/meta/parser_traits.hpp> 
    #include <boost/spirit/meta/refactoring.hpp>
    #include <boost/spirit/meta/traverse.hpp>

tree

    #include <boost/spirit/tree/ast.hpp>
    #include <boost/spirit/tree/parse_tree.hpp>
    #include <boost/spirit/tree/parse_tree_utils.hpp>
    #include <boost/spirit/tree/tree_to_xml.hpp>

utility

    #include <boost/spirit/utility/chset.hpp> 
    #include <boost/spirit/utility/chset_operators.hpp>
    #include <boost/spirit/utility/confix.hpp>
    #include <boost/spirit/utility/distinct.hpp>
    #include <boost/spirit/utility/escape_char.hpp>
    #include <boost/spirit/utility/flush_multi_pass.hpp>
    #include <boost/spirit/utility/functor_parser.hpp>
    #include <boost/spirit/utility/lists.hpp>
    #include <boost/spirit/utility/loops.hpp>
    #include <boost/spirit/utility/regex.hpp>
    #include <boost/spirit/utility/scoped_lock.hpp>

Copyright © 1998-2003 Joel de Guzman

Use, modification and distribution is subject to the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)