canonical< What > Struct Template Reference

template class canonical<What> encapsulates the canonical representation of values of type What. More...

#include <canonical.h>

Inheritance diagram for canonical< What >:

Public Member Functions
template<class CharSeq >
	canonical (CharSeq &seq)
	Explicitly construct from a character-sequence. More...
template<class CharSeq >
	canonical (chewer< CharSeq > &chew)
	Explicitly construct from a chewer<CharSeq> More...
Public Member Functions inherited from innards::canonical_base
	operator std::string () const
	Implicitly cast the canonical representation to string.

Private Member Functions
template<class CharSeq >
void	canonicalize (chewer< CharSeq > &chew)
	Canonicalize from a chewer<CharSeq> More...
template<class CharSeq >
void	canonicalize (CharSeq &seq)
	Canonicalize from a CharSeq> More...

Additional Inherited Members
Protected Member Functions inherited from innards::canonical_base
bool	cxx () const
	Canonicalizing C/C++ source?
Protected Attributes inherited from innards::canonical_base
std::string	_canonical
	String storing the canonical representation of a value.

Detailed Description

template<class What>
struct canonical< What >

template class canonical<What> encapsulates the canonical representation of values of type What.

Template Parameters

What	The type that is canonically represented.

Definition at line 82 of file canonical.h.

Constructor & Destructor Documentation

template<class What>

template<class CharSeq >

canonical< What >::canonical ( CharSeq &  seq )

inlineexplicit

Explicitly construct from a character-sequence.

Template Parameters

CharSeq

A character-sequence type

Parameters

seq

A CharSeq

Definition at line 89 of file canonical.h.

template<class What>

template<class CharSeq >

canonical< What >::canonical ( chewer< CharSeq > &  chew )

inlineexplicit

Explicitly construct from a chewer<CharSeq>

Template Parameters

CharSeq

A character-sequence type

Parameters

chew	A chewer<CharSeq> positioned at the offset in the associated CharSeq at which canonicalization is to start. The canonical form of the remainder of the CharSeq is constructed.

Definition at line 100 of file canonical.h.

Member Function Documentation

template<class What>

template<class CharSeq >

void canonical< What >::canonicalize ( chewer< CharSeq > &  chew )

private

Canonicalize from a chewer<CharSeq>

Template Parameters

CharSeq

A character-sequence type

Parameters

chew	A chewer<CharSeq> positioned at the offset in the associated CharSeq at which canonicalization is to start. The canonical form of the remainder of the CharSeq is canonicalized.

template<class What>

template<class CharSeq >

void canonical< What >::canonicalize ( CharSeq &  seq )

inlineprivate

Canonicalize from a CharSeq>

Template Parameters

CharSeq

A character-sequence type

Parameters

seq	A CharSeq to be canonicalized.

Definition at line 122 of file canonical.h.

---

The documentation for this struct was generated from the following file:

• canonical.h