adam_callback_suite_t Class Reference [Property Model Parser]

Callback class for the Adam parser. More...

#include <adobe/adam_parser.hpp>

List of all members.

Classes
class	relation_t
	Struct containing details of a relation expression for client callbacks from the Adam parser. More...
Public Types
typedef boost::function< void(cell_type_t type, name_t cell_name, const line_position_t &position, const array_t &expr_or_init, const std::string &brief, const std::string &detailed)>	add_cell_proc_t
typedef boost::function< void(name_t cell_name, const line_position_t &position, const std::string &brief, const std::string &detailed)>	add_external_proc_t
typedef boost::function< void(name_t cell_name, bool linked, const line_position_t &position1, const array_t &initializer, const line_position_t &position2, const array_t &expression, const std::string &brief, const std::string &detailed)>	add_interface_proc_t
typedef boost::function< void(const line_position_t &position, const array_t &conditional, const relation_t *first, const relation_t *last, const std::string &brief, const std::string &detailed)	add_relation_proc_t )
enum	cell_type_t {   input_k, output_k, constant_k, logic_k,   invariant_k }
Public Attributes
add_cell_proc_t	add_cell_proc_m
add_external_proc_t	add_external_proc_m
add_interface_proc_t	add_interface_proc_m
add_relation_proc_t	add_relation_proc_m

---

Detailed Description

Client-defined callback function used by the Adam parser to communicate with the client code. The Adam parser will discover cell declarations and will signal callbacks herein of those declarations.

Definition at line 133 of file adam_parser.hpp.

---

Member Typedef Documentation

add_cell_proc_t

A callback function signature for a ConvertibleToFunction that needs to be supplied. During the parsing of an Adam definition, the client will receive cell declaration notifications through this callback.

Parameters:

type	cell type declared in the defintion.
cell_name	name of the cell specified.
position	position in the parse of the declaration.
expr_or_init	array of tokens representing one of several things.
brief	trailing comment to this cell.
detailed	leading comment to this cell.

Definition at line 158 of file adam_parser.hpp.

typedef boost::function<void ( name_t cell_name, const line_position_t& position, const std::string& brief, const std::string& detailed)> add_external_proc_t

Definition at line 179 of file adam_parser.hpp.

add_interface_proc_t

A callback function signature for a ConvertibleToFunction that needs to be supplied. During the parsing of an Adam definition, the client will receive interface cell declaration notifications through this callback.

Parameters:

cell_name	name of the cell specified.
linked	specifies if the output cell is back-linked to the input cell.
position1	position1 in the parse of the declaration.
initializer	array of tokens representing the input cell initializer.
position2	position2 in the parse of the declaration.
expression	array of tokens representing the output cell relation expression.
brief	trailing comment to this cell.
detailed	leading comment to this cell.

Definition at line 174 of file adam_parser.hpp.

add_relation_proc_t

A callback function signature for a ConvertibleToFunction that needs to be supplied. During the parsing of an Adam definition, the client will receive relation declaration notifications through this callback.

Parameters:

position	position in the parse of the relation set declaration
conditional	tokenized expression array representing the optional conditional enabling this relation set.
first	first relation in the set.
last	one-past-the-last relation in the set.
brief	trailing comment to relation set.
detailed	leading comment to relation set.

See also:

adobe::adam_callback_suite_t::relation_t for more information on the relation_t type.

Definition at line 165 of file adam_parser.hpp.

---

Member Enumeration Documentation

enum cell_type_t

Enumeration type denoting the kind of cell found in the parse.

Enumerator:

input_k	Specifies a linked input cell for the add_cell_proc_m callback routine. If this cell type is specified the expression in the array_t is the cell initializer.
output_k	Specifies an output cell for the add_cell_proc_m callback routine. If this cell type is specified the expression in the array_t is the relation expression.
constant_k	Specifies a constant cell for the add_cell_proc_m callback routine. If this cell type is specified the expression in the array_t is the cell initializer.
logic_k	Specifies a logic cell for the add_cell_proc_m callback routine. If this cell type is specified the expression in the array_t is the relation expression.
invariant_k	Specifies an invariant cell for the add_cell_proc_m callback routine. If this cell type is specified the expression in the array_t is the relation expression.

Definition at line 135 of file adam_parser.hpp.

---

Member Data Documentation

add_cell_proc_t add_cell_proc_m

Definition at line 181 of file adam_parser.hpp.

add_external_proc_t add_external_proc_m

Definition at line 184 of file adam_parser.hpp.

add_interface_proc_t add_interface_proc_m

Definition at line 183 of file adam_parser.hpp.

add_relation_proc_t add_relation_proc_m

Definition at line 182 of file adam_parser.hpp.