Wave: a Standard conformant C++ preprocessor library

Hartmut Kaiser

Rate me:

4.96/5 (58 votes)

10 Jan 200413 min read

395.4K

4.4K

Describes a free and fully Standard conformant C++ preprocessor library

wave_preprocessor_src.zip
- wave
  - doc
    - acknowledgements.html
    - class_reference_context.html
    - class_reference_fileposition.html
    - class_reference_inputpolicy.html
    - class_reference_lexer.html
    - class_reference_tokentype.html
    - class_reference_tracepolicy.html
    - compiletime_config.html
    - index.html
    - introduction.html
    - macro_expansion_process.html
    - predefined_macros.html
    - preface.html
    - preliminary_cpp0x_support.html
    - quickstart.html
    - references.html
    - supported_pragmas.html
    - theme
      - bkd.gif
      - bkd2.gif
      - bullet.gif
      - l_arr.gif
      - l_arr_disabled.gif
      - r_arr.gif
      - r_arr_disabled.gif
      - style.css
      - u_arr.gif
      - uc.gif
      - wave.gif
    - token_ids.html
    - tracing_facility.html
    - wave_driver.html
  - test
    - boost-build.jam
    - cpp_tokens
    - Jamfile.v2
    - list_includes
    - project-root.jam
    - wave.vcproj
    - wave
      - cpp.cpp
      - cpp.hpp
      - cpp_config.hpp
      - cpp_version.hpp
      - instantiate_cpp_exprgrammar.cpp
      - instantiate_cpp_grammar.cpp
      - instantiate_cpp_literalgrammars.cpp
      - instantiate_defined_grammar.cpp
      - instantiate_predef_macros.cpp
      - instantiate_re2c_idllexer.cpp
      - instantiate_re2c_lexer.cpp
      - instantiate_slex_lexer.cpp
      - Jamfile
      - Jamfile.v2
      - runtests.sh
      - test_files
        
        scope1.cpp
        
        scope10.cpp
        
        scope11.cpp
        
        scope12.cpp
        
        scope13.cpp
        
        scope14.cpp
        
        scope15.cpp
        
        scope16.cpp
        
        scope17.cpp
        
        scope18.cpp
        
        scope19.cpp
        
        scope2.cpp
        
        scope20.cpp
        
        scope21.cpp
        
        scope22.cpp
        
        scope23.cpp
        
        scope24.cpp
        
        scope25.cpp
        
        scope26.cpp
        
        scope27.cpp
        
        scope3.cpp
        
        scope4.cpp
        
        scope5.cpp
        
        scope6.cpp
        
        scope7.cpp
        
        scope8.cpp
        
        scope9.cpp
        
        test1.cpp
        
        test10.cpp
        
        test11.cpp
        
        test12.cpp
        
        test13.cpp
        
        test14.cpp
        
        test15.cpp
        
        test16.cpp
        
        test17.cpp
        
        test18.cpp
        
        test19.cpp
        
        test2.cpp
        
        test20.cpp
        
        test21.cpp
        
        test22.cpp
        
        test23.cpp
        
        test24.cpp
        
        test25.cpp
        
        test26.cpp
        
        test27.cpp
        
        test28.cpp
        
        test29.cpp
        
        test3.cpp
        
        test30.cpp
        
        test31.cpp
        
        test32.cpp
        
        test33.cpp
        
        test34.cpp
        
        test35.cpp
        
        test36.cpp
        
        test37.cpp
        
        test38.cpp
        
        test39.cpp
        
        test4.cpp
        
        test40.cpp
        
        test41.cpp
        
        test41_0.hpp
        
        test41_1.hpp
        
        test42.cpp
        
        test43.cpp
        
        test44.cpp
        
        test45.cpp
        
        test46.cpp
        
        test47.cpp
        
        test48.cpp
        
        test49.cpp
        
        test5.cpp
        
        test50.cpp
        
        test51.cpp
        
        test52.cpp
        
        test53.cpp
        
        test54.cpp
        
        test55.cpp
        
        test56.cpp
        
        test57.cpp
        
        test58.cpp
        
        test59.cpp
        
        test6.cpp
        
        test60.cpp
        
        test61.cpp
        
        test62.cpp
        
        test63.cpp
        
        test64.cpp
        
        test65.cpp
        
        test66.cpp
        
        test67.cpp
        
        test68.cpp
        
        test69.cpp
        
        test7.cpp
        
        test70.cpp
        
        test71.cpp
        
        test72.cpp
        
        test73.cpp
        
        test74.cpp
        
        test75.cpp
        
        test76.cpp
        
        test77.cpp
        
        test78.cpp
        
        test79.cpp
        
        test8.cpp
        
        test9.cpp
      - trace_macro_expansion.hpp
  - wave
    - cpp_context.hpp
    - cpp_exceptions.hpp
    - cpp_iteration_context.hpp
    - cpplexer
      - cpp_lex_interface.hpp
      - cpp_lex_iterator.hpp
      - cpp_lex_token.hpp
      - cpp_token_ids.hpp
      - cpplexer_exceptions.hpp
      - macro_scoping_tokens.hpp
      - re2c_functor.hpp
      - re2clex
        
        aq.cpp
        
        aq.hpp
        
        cpp.re
        
        cpp.re.cpp
        
        cpp_re2c_lexer.hpp
        
        scanner.hpp
        
        test
        
        lextest.in
        
        lextest.output
        
        run_tests.sh
        
        test_lexer.c
        
        test_lexer.in
        
        test_lexer.output
      - slex
        
        cpp_slex_lexer.hpp
      - slex_functor.hpp
      - test
        
        instantiate_re2c_lexer.cpp
        
        instantiate_slex_lexer.cpp
        
        lextest.in
        
        lextest.re2c.output
        
        lextest.slex.output
        
        run_tests.sh
        
        test_re2c_lexer.cpp
        
        test_re2c_lexer.hpp
        
        test_slex_lexer.cpp
        
        test_slex_lexer.hpp
      - validate_universal_char.hpp
    - grammars
    - idllexer
      - idl_lex_interface.hpp
      - idl_lex_iterator.hpp
      - idl_lex_token.hpp
      - idl_token_ids.hpp
      - re2clex
        
        aq.cpp
        
        aq.hpp
        
        idl.re
        
        idl.re.cpp
        
        idl_re2c_lexer.hpp
        
        scanner.hpp
    - language_support.hpp
    - lex_iterator.hpp
    - lex_token.hpp
    - token_ids.hpp
    - trace_policies.hpp
    - util
    - wave.hpp
    - wave_version.hpp
wave_preprocessor_demo.zip
- wave.exe
wave_preprocessor_src1.zip
- acknowledgements.html
- class_reference_context.html
- class_reference_fileposition.html
- class_reference_inputpolicy.html
- class_reference_lexer.html
- class_reference_tokentype.html
- class_reference_tracepolicy.html
- compiletime_config.html
- index.html
- introduction.html
- macro_expansion_process.html
- predefined_macros.html
- preface.html
- preliminary_cpp0x_support.html
- quickstart.html
- references.html
- supported_pragmas.html
- bkd.gif
- bkd2.gif
- bullet.gif
- l_arr.gif
- l_arr_disabled.gif
- r_arr.gif
- r_arr_disabled.gif
- style.css
- u_arr.gif
- uc.gif
- wave.gif
- token_ids.html
- tracing_facility.html
- wave_driver.html
- boost-build.jam
- cpp_tokens.cpp
- cpp_tokens_config.hpp
- instantiate_cpp_exprgrammar.cpp
- instantiate_cpp_grammar.cpp
- instantiate_cpp_literalgrammars.cpp
- instantiate_re2c_lexer.cpp
- instantiate_slex_lexer.cpp
- Jamfile.v2
- instantiate_cpp_exprgrammar.cpp
- instantiate_cpp_grammar.cpp
- instantiate_cpp_literalgrammars.cpp
- instantiate_re2c_lexer.cpp
- instantiate_slex_lexer.cpp
- list_includes.cpp
- list_includes.hpp
- list_includes_version.hpp
- Readme.txt
- project-root.jam
- wave.vcproj
- cpp.cpp
- cpp.hpp
- cpp_config.hpp
- cpp_version.hpp
- instantiate_cpp_exprgrammar.cpp
- instantiate_cpp_grammar.cpp
- instantiate_cpp_literalgrammars.cpp
- instantiate_defined_grammar.cpp
- instantiate_predef_macros.cpp
- instantiate_re2c_lexer.cpp
- instantiate_slex_lexer.cpp
- Jamfile
- Jamfile.v2
- runtests.sh
- test1.cpp
- test10.cpp
- test11.cpp
- test12.cpp
- test13.cpp
- test14.cpp
- test15.cpp
- test16.cpp
- test17.cpp
- test18.cpp
- test19.cpp
- test2.cpp
- test20.cpp
- test21.cpp
- test22.cpp
- test23.cpp
- test24.cpp
- test25.cpp
- test26.cpp
- test27.cpp
- test28.cpp
- test29.cpp
- test3.cpp
- test30.cpp
- test31.cpp
- test32.cpp
- test33.cpp
- test4.cpp
- test5.cpp
- test6.cpp
- test7.cpp
- test8.cpp
- test9.cpp
- trace_macro_expansion.hpp
- cpp_context.hpp
- cpp_exceptions.hpp
- cpp_iteration_context.hpp
- cpp_lex_interface.hpp
- cpp_lex_iterator.hpp
- cpp_lex_token.hpp
- cpp_token_ids.hpp
- cpplexer_exceptions.hpp
- macro_scoping_tokens.hpp
- re2c_functor.hpp
- aq.cpp
- aq.hpp
- cpp.re
- cpp.re.cpp
- cpp_re2c_lexer.hpp
- scanner.hpp
- lextest.in
- lextest.output
- run_tests.sh
- test_lexer.c
- test_lexer.in
- test_lexer.output
- cpp_slex_lexer.hpp
- slex_functor.hpp
- instantiate_re2c_lexer.cpp
- instantiate_slex_lexer.cpp
- lextest.in
- lextest.re2c.output
- lextest.slex.output
- run_tests.sh
- test_re2c_lexer.cpp
- test_re2c_lexer.hpp
- test_slex_lexer.cpp
- test_slex_lexer.hpp
- validate_universal_char.hpp
- cpp_chlit_grammar.hpp
- cpp_defined_grammar.hpp
- cpp_defined_grammar_gen.hpp
- cpp_expression_grammar.hpp
- cpp_expression_grammar_gen.hpp
- cpp_floatlit_grammar.hpp
- cpp_grammar.hpp
- cpp_grammar_gen.hpp
- cpp_intlit_grammar.hpp
- cpp_literal_grammar_gen.hpp
- cpp_predef_macros_gen.hpp
- cpp_predef_macros_grammar.hpp
- language_support.hpp
- macro_trace_policies.hpp
- cpp_ifblock.hpp
- cpp_include_pathes.hpp
- cpp_iterator.hpp
- cpp_macromap.hpp
- eat_whitespace.hpp
- file_position.hpp
- flex_string.hpp
- insert_whitespace_detection.hpp
- interpret_pragma.hpp
- iteration_context.hpp
- macro_definition.hpp
- macro_helpers.hpp
- pattern_parser.hpp
- symbol_table.hpp
- time_conversion_helper.hpp
- transform_iterator.hpp
- unput_queue_iterator.hpp
- wave_version.hpp
wave_preprocessor_demo1.zip
- wave.exe

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>The File Position</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link href="theme/style.css" rel="stylesheet" type="text/css">
</head>

<body>
<table width="100%" border="0" cellspacing="2" background="theme/bkd2.gif">
  <tr> 
    <td width="21"> <h1></h1></td>
    <td width="885"> <font face="Verdana, Arial, Helvetica, sans-serif"><b><font size="6">The 
      File Position</font></b></font></td>
    <td width="96"><a href="http://spirit.sf.net"><img src="theme/wave.gif" width="93" height="68" align="right" border="0"></a></td>
  </tr>
</table>
<br>
<table border="0">
  <tr> 
    <td width="10"></td>
    <td width="30"><a href="index.html"><img src="theme/u_arr.gif" border="0"></a></td>
    <td width="30"><a href="token_ids.html"><img src="theme/l_arr.gif" width="20" height="19" border="0"></a></td>
    <td width="30"><a href="predefined_macros.html"><img src="theme/r_arr.gif" border="0"></a></td>
  </tr>
</table>
<blockquote> 
  <p><a href="class_reference_fileposition.html#introduction">Introduction</a><br>
    <a href="class_reference_fileposition.html#header_synopsis">Header 'wave/util/file_position.hpp' 
    synopsis</a><br>
    <a href="class_reference_fileposition.html#template_parameters">Template parameters</a><br>
    <a href="class_reference_fileposition.html#member_functions">Member functions</a></p>
</blockquote>
<h2><b><a name="introduction"></a>Introduction</b></h2>
<p>The file position template is used to represent a concrete token position inside 
  the underlying input stream. This token position contains the corresponding 
  filename, the line number and the column number, where the token was recognized.</p>
<h2><b><a name="header_synopsis"></a>Header <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/spirit/spirit/wave/wave/util/file_position.h?rev=HEAD&content-type=text/vnd.viewcvs-markup">wave/util/file_position.hpp</a> 
  synopsis</b></h2>
<pre><span class="keyword">namespace</span> <span class="identifier">wave</span> {
<span class="keyword">namespace</span> <span class="identifier">util</span> {

    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> StringT = <span class="keyword">std::string</span>&gt;
    <span class="keyword">class</span> file_position {
 
    <span class="keyword">public</span>:
        <a href="class_reference_fileposition.html#constructors">file_position</a>();
        <span class="keyword">explicit</span> <a href="class_reference_fileposition.html#constructors">file_position</a>(StringT const &amp;file, 
            int line_ = 1, int column_ = 1);

    // accessors
        StringT <span class="keyword">const</span> &amp;<a href="class_reference_fileposition.html#get_accessors">get_file</a>() <span class="keyword">const</span>;
        <span class="keyword">int</span> <a href="class_reference_fileposition.html#get_accessors">get_line</a>() <span class="keyword">const</span>;
        <span class="keyword">int</span> <a href="class_reference_fileposition.html#get_accessors">get_column</a>() <span class="keyword">const</span>;
    
        <span class="keyword">void</span> <a href="class_reference_fileposition.html#set_accessors">set_file</a>(StringT <span class="keyword">const</span> &amp;file);
        <span class="keyword">void</span> <a href="class_reference_fileposition.html#set_accessors">set_line</a>(<span class="keyword">int</span> line);
        <span class="keyword">void</span> <a href="class_reference_fileposition.html#set_accessors">set_column</a>(<span class="keyword">int</span> column);
    };

}   <span class="comment">// namespace util</span>
}   <span class="comment">// namespace wave</span></pre>
<h2><a name="template_parameters"></a>Template parameters</h2>
<p>The <tt>file_position</tt> template may be instantiatet with one template parameter, 
  which gives the string type to use for storing the file name member of the file 
  position. If this parameter isn't given, it defaults to a <tt>std::string</tt>. 
  Please note, that the type given as the template parameter must be compatible 
  with a <tt>std::string</tt>.</p>
<h2><a name="member_functions"></a>Member functions</h2>
<h3><a name="constructors"></a>Constructors</h3>
<pre>        <a href="class_reference_fileposition.html#constructors">file_position</a>();
        <span class="keyword">explicit</span> <a href="class_reference_fileposition.html#constructors">file_position</a>(StringT const &amp;file, 
            int line_ = 1, int column_ = 1);
</pre>
<blockquote>
  <p>The constructors initialize a new instance of a <tt>file_position</tt> in 
    correspondence to the supplied parameters. The parameters default to an empty 
    filename and the line number and column number set to one.</p>
</blockquote>
<p><a name="get_accesssors"></a><b>get_file</b>, <b>get_line</b>, <b>get_column</b></p>
<pre>        StringT <span class="keyword">const</span> &amp;<a href="class_reference_fileposition.html#get_accessors">get_file</a>() <span class="keyword">const</span>;
        <span class="keyword">int</span> <a href="class_reference_fileposition.html#get_accessors">get_line</a>() <span class="keyword">const</span>;
        <span class="keyword">int</span> <a href="class_reference_fileposition.html#get_accessors">get_column</a>() <span class="keyword">const</span>;
</pre>
<blockquote>
  <p>The <tt>get_...</tt> functions are used to access the current values of the 
    file position members: the filename (<tt>get_file</tt>), the line number (<tt>get_line</tt>) 
    and the column number (<tt>get_column</tt>).</p>
</blockquote>
<p><a name="set_accessors"></a><b>set_file</b>, <b>set_line</b>, <b>set_column</b></p>
<pre>        <span class="keyword">void</span> <a href="class_reference_fileposition.html#set_accessors">set_file</a>(StringT <span class="keyword">const</span> &amp;file);
        <span class="keyword">void</span> <a href="class_reference_fileposition.html#set_accessors">set_line</a>(<span class="keyword">int</span> line);
        <span class="keyword">void</span> <a href="class_reference_fileposition.html#set_accessors">set_column</a>(<span class="keyword">int</span> column);
</pre>
<blockquote>
  <p>The <tt>set_...</tt> functions are used to set new values to the file position 
    members: the filename (<tt>set_file</tt>), the line number (<tt>set_line</tt>) 
    and the column number (<tt>set_column</tt>).</p>
</blockquote>
<table border="0">
  <tr> 
    <td width="10"></td>
    <td width="30"><a href="index.html"><img src="theme/u_arr.gif" border="0"></a></td>
    <td width="30"><a href="token_ids.html"><img src="theme/l_arr.gif" width="20" height="19" border="0"></a></td>
    <td width="30"><a href="predefined_macros.html"><img src="theme/r_arr.gif" border="0"></a></td>
  </tr>
</table>
<hr size="1">
<p class="copyright">Copyright &copy; 2003-2004 Hartmut Kaiser<br>
  <br>
  <font size="2">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) 
  </font> </p>
<span class="updated">Last updated: 
  <!-- #BeginDate format:fcAm1m -->Monday, January 5, 2004  14:57<!-- #EndDate -->
  </span></body>
</html>

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Written By

Hartmut Kaiser

United States

Actively involved in Boost and the development of the Spirit parser construction framework.

Wave: a Standard conformant C++ preprocessor library

License

Comments and Discussions