parse.hpp File Reference

text parsing and AST generation More...

Include dependency graph for parse.hpp:

Go to the source code of this file.

Data Structures
class	xtd::parse::and_<>
	Represents a parse algorithm where all specified elements parse are contiguously present in the input stream All the terminals and rules listed in the parameter pack must parse successfully to satisfy the parse rule. More...
class	xtd::parse::character< _value >
	Character terminal parsing algorithm. More...
class	xtd::parse::one_or_more_< _Ty >
	Represents a parse algorithm where where the terminal or rule is repeated one or more times in the input stream The specified item must parse successfully at least once to satisfy the parse rule. More...
class	xtd::parse::or_<>
	Represents a parse algorithm where one of the listed elements is present in the input stream One of the terminals or rules listed in the parameter pack must parse successfully to satisfy the parse rule. More...
class	xtd::parser< _RuleT, _IgnoreCase, _WhitespaceT >
	Main parser class. More...
class	xtd::parse::regex< _Ty, >
	regular expression parsing algorithm. More...
class	xtd::parse::rule< _DeclT, _ImplT >
	Curiously recurring template pattern to simplify creation of rule_base implementations Rules and terminals implement the rule_base interface through this pattern. More...
class	xtd::parse::rule_base
	Base class of both rules and terminals Though rules and terminals are technically different they share the rule_base ancestor in XTL to have a cleaner object model and simpler parsing algorithms. More...
class	xtd::parse::string< _Ty, >
	String terminal parsing algorithm. More...
class	xtd::parse::whitespace< _Ch >
	list of whitespace characters to ignore in the input stream. More...
class	xtd::parse::zero_or_more_< _Ty >
	Represents a parse algorithm where the terminal or rule repeats zero or more times in the input stream Always successfully parses whether or not the element parses. More...
class	xtd::parse::zero_or_one_< _Ty >
	Represents a parse algorithm where the terminal or rule repeats exactly zero or one time in the input stream Always successfully parses whether or not the element parses. More...

Namespaces
	xtd
	The main namespace of the XTL library.
	xtd::parse
	Grammar and AST declarations.

Macros
#define	CHARACTER_(_name, _value)
	Declares a single character terminal. More...
#define	REGEX(_name, _value)
	Declares a regular expression terminal. More...
#define	STRING(_name, _value)
	Declares a string terminal Must be used at namespace scope. More...
#define	STRING_(x)
	Declares a string terminal with the value equal to the name. More...

Detailed Description

text parsing and AST generation

Copyright

David Mott (c) 2016. Distributed under the Boost Software License Version 1.0. See LICENSE.md or http://boost.org/LICENSE_1_0.txt for details.

Definition in file parse.hpp.

---

Data Structure Documentation

class xtd::parse::and_

template<typename...>
class xtd::parse::and_<>

Represents a parse algorithm where all specified elements parse are contiguously present in the input stream All the terminals and rules listed in the parameter pack must parse successfully to satisfy the parse rule.

Template Parameters

...	list of child rules and terminals to parse

Examples:

example_parse1.cpp, and example_parse2.cpp.

Definition at line 131 of file parse.hpp.

Collaboration diagram for xtd::parse::and_<>:

class xtd::parse::or_

template<typename...>
class xtd::parse::or_<>

Represents a parse algorithm where one of the listed elements is present in the input stream One of the terminals or rules listed in the parameter pack must parse successfully to satisfy the parse rule.

Template Parameters

...	list of child rules and terminals to parse

Examples:

example_parse1.cpp, and example_parse2.cpp.

Definition at line 153 of file parse.hpp.

Collaboration diagram for xtd::parse::or_<>:

class xtd::parse::regex

template<typename _Ty, _Ty &>
class xtd::parse::regex< _Ty, >

regular expression parsing algorithm.

This template is infrequently used directly. The REGEX macro is provided to declare a regular expression terminal.

Definition at line 243 of file parse.hpp.

Collaboration diagram for xtd::parse::regex< _Ty, >:

class xtd::parse::string

template<typename _Ty, _Ty &>
class xtd::parse::string< _Ty, >

String terminal parsing algorithm.

This template is infrequently used directly. The STRING and STRING_ macros are provided to declare string terminals.

Definition at line 224 of file parse.hpp.

Collaboration diagram for xtd::parse::string< _Ty, >:

class xtd::parse::whitespace

template<char... _Ch>
class xtd::parse::whitespace< _Ch >

list of whitespace characters to ignore in the input stream.

Whitespace characters are parsed and discarded from the input stream when encountered between rules or terminals. A typical whitespace declaration for written language might be: whitespace<'\r', '\n', '\t', ' '>;

Template Parameters

_Ch...

list of characters to ignore.

Definition at line 215 of file parse.hpp.

Collaboration diagram for xtd::parse::whitespace< _Ch >:

Data Fields
	whitespace_type

Macro Definition Documentation

#define CHARACTER_	(		_name,
			_value
	)

Value:

namespace _{} \
  using _name = xtd::parse::character<_value>

Declares a single character terminal.

Must be used at namespace scope.

Parameters

_name	name of the terminal.
_value	value of the terminal. Must be a single character enclosed in single quotes.

Definition at line 50 of file parse.hpp.

#define REGEX	(		_name,
			_value
	)

Value:

namespace _{ char _name[] = _value; } \
      using _name = xtd::parse::regex< decltype(_::_name), _::_name>;

Declares a regular expression terminal.

Must be used at namespace scope.

Parameters

_name	name of the terminal.
_value	regular expression of the terminal.

Definition at line 61 of file parse.hpp.

#define STRING	(		_name,
			_value
	)

Value:

namespace _{ char _name[] = _value; } \
      using _name = xtd::parse::string< decltype(_::_name), _::_name>;

Declares a string terminal Must be used at namespace scope.

Parameters

_name	name of the terminal
_value	string value of the terminal. Must be enclosed in double quotes.

Examples:

example_parse1.cpp, and example_parse2.cpp.

Definition at line 38 of file parse.hpp.

#define STRING_

(

x

)

Value:

namespace _{ char x[] = #x; } \
      using x = xtd::parse::string< decltype(_::x), _::x>;

Declares a string terminal with the value equal to the name.

Must be used at namespace scope

Parameters

x	name and value of the terminal

Examples:

example_parse2.cpp.

Definition at line 28 of file parse.hpp.