Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Quick Reference

Common Notation
Predefined Primitive Parsers
Compound Attribute Rules
Lazy Arguments
Non-terminals
Semantic Actions
Phoenix

This quick reference section is provided for convenience. You can use this section as a sort of a "cheat-sheet" on the most commonly used Qi components. It is not intended to be complete, but should give you an easy way to recall a particular component without having to dig up on pages and pages of reference doumentation.

Notation

P

Parser type

p, a, b, c

Parser objects

A, B, C

Attribute types of parsers A, B and C

I

The iterator type used for parsing

Unused

An unused_type

Context

The enclosing rule's Context type

Attr

An attribute type

b

A boolean expression

fp

A (lazy parser) function with signature P(Unused, Context)

fa

A (semantic action) function with signature void(Attr, Context, bool&). The third parameter is a boolean flag that can be set to false to force the parse to fail. Both Context and the boolean flag are optional.

first

An iterator pointing to the start of input

last

An iterator pointing to the end of input

Ch

Character-class specific character type (See __char_classtypes_)

ch

Character-class specific character (See __char_classtypes_)

ch2

Character-class specific character (See __char_classtypes_)

chset

Character-set specifier string (example: "a-z0-9")

str

Character-class specific string (See __char_classtypes_)

Str

Attribute of str: std::basic_string<T> where T is the underlying character type of str

tuple<>

Used as a placeholder for a fusion sequence

vector<>

Used as a placeholder for an STL container

variant<>

Used as a placeholder for a boost::variant

optional<>

Used as a placeholder for a boost::optional


PrevUpHomeNext