xtl_metaphor.h File Reference

---

Detailed Description

Defines CTTL metaphor functions, which encapsulate complex expressions relying on other CTTL primitives, such as overloaded operators and lexemes.

Warning:

This is internal CTTL header file and should not be included by user programs.

Definition in file xtl_metaphor.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	cttl
Defines
#define	CTTL_QWERTY_   "QWERTYUIOPASDFGHJKLZXCVBNM_qwertyuiopasdfghjklzxcvbnm"
	String literal containing alphabetic characters and underscore.
#define	CTTL_QWERTY_123_   "QWERTYUIOPASDFGHJKLZXCVBNM_qwertyuiopasdfghjklzxcvbnm1234567890"
	String literal containing alphabetic characters, underscore, and digits.
#define	CTTL_WCHAR_QWERTY_   L"QWERTYUIOPASDFGHJKLZXCVBNM_qwertyuiopasdfghjklzxcvbnm"
	Wide-character string literal containing alphabetic characters and underscore.
#define	CTTL_WCHAR_QWERTY_123_   L"QWERTYUIOPASDFGHJKLZXCVBNM_qwertyuiopasdfghjklzxcvbnm1234567890"
	Wide-character string literal containing alphabetic characters, underscore, and numbers.
Functions
xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_begin< CTTL_STD_STRING > >, xtl_wrap< xtl_text_end< CTTL_STD_STRING > > > >	literal ()
	Implements behavior of literal metaphor inside CTTL grammar expression.
xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_begin< CTTL_STD_STRING > >, xtl_wrap< xtl_text_end< CTTL_STD_STRING > > > >	literal (CTTL_STD_CHAR const *text_begin_, CTTL_STD_CHAR const *text_end_)
	Implements behavior of literal metaphor inside CTTL grammar expression.
xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_begin< CTTL_STD_STRING > >, xtl_wrap< xtl_text_end< CTTL_STD_STRING > > > >	literal (CTTL_STD_STRING const &text_begin_, CTTL_STD_STRING const &text_end_)
	Implements behavior of literal metaphor inside CTTL grammar expression.
xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_ref_begin< CTTL_STD_STRING > >, xtl_wrap< xtl_text_ref_end< CTTL_STD_STRING > > > >	literal (CTTL_STD_STRING const *text_begin_, CTTL_STD_STRING const *text_end_)
	Implements behavior of literal metaphor inside CTTL grammar expression.
xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_begin< CTTL_STD_WSTRING > >, xtl_wrap< xtl_text_end< CTTL_STD_WSTRING > > > >	wchar_literal ()
	Implements behavior of wide character literal metaphor inside CTTL grammar expression.
xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_begin< CTTL_STD_WSTRING > >, xtl_wrap< xtl_text_end< CTTL_STD_WSTRING > > > >	wchar_literal (CTTL_STD_WCHAR const *text_begin_, CTTL_STD_WCHAR const *text_end_)
	Implements behavior of wide character literal metaphor inside CTTL grammar expression.
xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_begin< CTTL_STD_WSTRING > >, xtl_wrap< xtl_text_end< CTTL_STD_WSTRING > > > >	wchar_literal (CTTL_STD_WSTRING const &text_begin_, CTTL_STD_WSTRING const &text_end_)
	Implements behavior of wide character literal metaphor inside CTTL grammar expression.
xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_ref_begin< CTTL_STD_WSTRING > >, xtl_wrap< xtl_text_ref_end< CTTL_STD_WSTRING > > > >	wchar_literal (CTTL_STD_WSTRING const *text_begin_, CTTL_STD_WSTRING const *text_end_)
	Implements behavior of wide character literal metaphor inside CTTL grammar expression.
template<typename ExprT>
xtl_wrap< xtl_entity< xtl_wrap< ExprT > >>	entity (xtl_wrap< ExprT > const &expr_)
	Helper function to create implemention object for entity expression adaptor which filters successful result of grammar evaluation based on non-empty match.
universe_T	entity ()
	Helper function to create implemention object for entity lexeme.

---

Function Documentation

universe_T entity (   )  [inline]

Helper function to create implemention object for entity lexeme. Returns: Instance of C++ implementation class that matches current universe. Definition at line 334 of file xtl_metaphor.h. References cttl::end(), cttl_impl::relaxed_bool_T, and cttl_impl::universe_T.

xtl_wrap< xtl_entity< xtl_wrap< ExprT > >> entity (  xtl_wrap< ExprT > const &  expr_  )

Helper function to create implemention object for entity expression adaptor which filters successful result of grammar evaluation based on non-empty match. ExprT Template parameter specifying type of grammar expression, which is determined by the C++ compiler at compile time. Parameters: expr_  constant reference to C++ object representing CTTL grammar expression. Returns: Instance of C++ implementation class for entity adaptor. Definition at line 313 of file xtl_metaphor.h.

xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_ref_begin< CTTL_STD_STRING > >, xtl_wrap< xtl_text_ref_end< CTTL_STD_STRING > > > > literal (  CTTL_STD_STRING const *  text_begin_, CTTL_STD_STRING const *  text_end_ )  [inline]

Implements behavior of literal metaphor inside CTTL grammar expression. Parameters: text_begin_  address of character entity string specifying upper boundary of the literal. text_end_  address of character entity string specifying lower boundary of the literal. Returns: Instance of C++ implementation class for grammar expression begin( text_begin_ ) ^ end( text_end_ ) Precondition: This function generates reference-based implementation. Therefore, strings pointed by text_begin_ and text_end_ should stay in scope while literal is in use. Definition at line 174 of file xtl_metaphor.h. References cttl::begin(), and cttl::end().

xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_begin< CTTL_STD_STRING > >, xtl_wrap< xtl_text_end< CTTL_STD_STRING > > > > literal (  CTTL_STD_STRING const &  text_begin_, CTTL_STD_STRING const &  text_end_ )  [inline]

Implements behavior of literal metaphor inside CTTL grammar expression. Parameters: text_begin_  character entity specifying upper boundary of the literal. text_end_  character entity specifying lower boundary of the literal. Returns: Instance of C++ implementation class for grammar expression begin( text_begin_ ) ^ end( text_end_ ) Definition at line 143 of file xtl_metaphor.h. References cttl::begin(), and cttl::end().

xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_begin< CTTL_STD_STRING > >, xtl_wrap< xtl_text_end< CTTL_STD_STRING > > > > literal (  CTTL_STD_CHAR const *  text_begin_, CTTL_STD_CHAR const *  text_end_ )  [inline]

Implements behavior of literal metaphor inside CTTL grammar expression. Parameters: text_begin_  character entity specifying upper boundary of the literal. text_end_  character entity specifying lower boundary of the literal. Returns: Instance of C++ implementation class for grammar expression begin( text_begin_ ) ^ end( text_end_ ) Definition at line 115 of file xtl_metaphor.h. References cttl::begin(), and cttl::end().

xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_begin< CTTL_STD_STRING > >, xtl_wrap< xtl_text_end< CTTL_STD_STRING > > > > literal (   )  [inline]

Implements behavior of literal metaphor inside CTTL grammar expression. Returns: Instance of C++ implementation class for grammar expression begin( CTTL_QWERTY_ ) ^ end( CTTL_QWERTY_123_ ) Definition at line 84 of file xtl_metaphor.h. References cttl::begin(), CTTL_STD_CHAR, CTTL_STD_STRING, and cttl::end().

xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_ref_begin< CTTL_STD_WSTRING > >, xtl_wrap< xtl_text_ref_end< CTTL_STD_WSTRING > > > > wchar_literal (  CTTL_STD_WSTRING const *  text_begin_, CTTL_STD_WSTRING const *  text_end_ )  [inline]

Implements behavior of wide character literal metaphor inside CTTL grammar expression. Parameters: text_begin_  address of character entity string specifying upper boundary of the literal. text_end_  address of character entity string specifying lower boundary of the literal. Returns: Instance of C++ implementation class for grammar expression begin( text_begin_ ) ^ end( text_end_ ) Precondition: This function generates reference-based implementation. Therefore, strings pointed by text_begin_ and text_end_ should stay in scope while literal is in use. Definition at line 280 of file xtl_metaphor.h. References cttl::begin(), and cttl::end().

xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_begin< CTTL_STD_WSTRING > >, xtl_wrap< xtl_text_end< CTTL_STD_WSTRING > > > > wchar_literal (  CTTL_STD_WSTRING const &  text_begin_, CTTL_STD_WSTRING const &  text_end_ )  [inline]

Implements behavior of wide character literal metaphor inside CTTL grammar expression. Parameters: text_begin_  character entity specifying upper boundary of the literal. text_end_  character entity specifying lower boundary of the literal. Returns: Instance of C++ implementation class for grammar expression begin( text_begin_ ) ^ end( text_end_ ) Definition at line 248 of file xtl_metaphor.h. References cttl::begin(), and cttl::end().

xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_begin< CTTL_STD_WSTRING > >, xtl_wrap< xtl_text_end< CTTL_STD_WSTRING > > > > wchar_literal (  CTTL_STD_WCHAR const *  text_begin_, CTTL_STD_WCHAR const *  text_end_ )  [inline]

Implements behavior of wide character literal metaphor inside CTTL grammar expression. Parameters: text_begin_  character entity specifying upper boundary of the literal. text_end_  character entity specifying lower boundary of the literal. Returns: Instance of C++ implementation class for grammar expression begin( text_begin_ ) ^ end( text_end_ ) Definition at line 221 of file xtl_metaphor.h. References cttl::begin(), and cttl::end().

xtl_wrap< xtl_opbinconcat< xtl_wrap< xtl_text_begin< CTTL_STD_WSTRING > >, xtl_wrap< xtl_text_end< CTTL_STD_WSTRING > > > > wchar_literal (   )  [inline]

Implements behavior of wide character literal metaphor inside CTTL grammar expression. Returns: Instance of C++ implementation class for grammar expression begin( CTTL_WCHAR_QWERTY_ ) ^ end( CTTL_WCHAR_QWERTY_123_ ) Definition at line 194 of file xtl_metaphor.h. References cttl::begin(), CTTL_STD_WSTRING, CTTL_WCHAR_QWERTY_, CTTL_WCHAR_QWERTY_123_, and cttl::end().

---