GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > XLX / V6-4-1

Constituent: parser     Tag: sun-gcc


Interface   Data Structures   File List   Data Fields   Globals  

state.h File Reference

Definition of state structure and declaration of associated functions. More...

#include "XLX/stack.h"

Include dependency graph for state.h:

Include dependency graph

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

Included by dependency graph

Data Structures

struct  _XLX_state
 Current state of the parsing - stack pointing to current element and address of leaf on the configuration tree. More...


Typedefs

typedef _XLX_state XLX_state
 Forward declaration of the state structure.

typedef void(* XLX_pCharacter )(XLX_state *, const char *, int)
 Pointer to function called to perform unique actions inside a char tag.

typedef void(* XLX_pEnter )(XLX_state *, const char **)
 Pointer to function called to perform additional (attribute parsing) actions on entry to a tag.

typedef void(* XLX_pExit )(XLX_state *)
 Pointer to function called to perform additional actions on exit from a tag.


Functions

void XLX_initState (XLX_state *state, unsigned stackLimit, void *stackSeed, XLX_pEnter enter, XLX_pExit exit, XLX_pCharacter character, int verbose)
 Initialises the state of the parser.

void XLX_start (void *data, const char *element, const char **attribute)
 Handles a start tag.

void XLX_end (void *data, const char *element)
 Handles an end tag.

void XLX_character (void *data, const char *element, int len)
 Handles a character element.

void XLX_printout_down (XLX_state *state, const char *element)
 Print an starting tag.

void XLX_printout_up (XLX_state *state, const char *element)
 Print an ending tag.

void XLX_character_noop (XLX_state *state, const char *element, int len)
 No-op character element handler.

void XLX_enter_noop (XLX_state *state, const char **attribute)
 No-op enter element handler.

void XLX_exit_noop (XLX_state *state)
 No-op exit element handler.

void XLX_character_tag (XLX_state *state, const char *element, int len)
 Handles a character element inside a parent tag by delegating the work to the first child.


Detailed Description

Definition of state structure and declaration of associated functions.

Author:
James Swain -- jswain@slac.stanford.edu

Function Documentation

void XLX_character void *  data,
const char *  element,
int  len
 

Handles a character element.

Parameters:
data Current state of the parser
element Charater element
len Length of the character element

Here is the call graph for this function:

void XLX_character_noop XLX_state state,
const char *  element,
int  len
 

No-op character element handler.

Parameters:
state Pointer to the current state of the parser
element The text string from the current element
len Length of element

void XLX_character_tag XLX_state state,
const char *  element,
int  len
 

Handles a character element inside a parent tag by delegating the work to the first child.

Parameters:
state Current state of the parser
element Charater element
len Length of the character element
/para If there are valid characters in the character element then the first child of the current tag is pushed onto the stack and then XLX_character is called to handle the character parsing. After the parsing is complete the child is popped off the stack.

Here is the call graph for this function:

void XLX_end void *  data,
const char *  element
 

Handles an end tag.

Parameters:
data Current state of the parser
element Element name from end tag

Here is the call graph for this function:

void XLX_enter_noop XLX_state state,
const char **  attribute
 

No-op enter element handler.

Parameters:
state Pointer to the current state of the parser
attribute Attribute list for the current element

void XLX_exit_noop XLX_state state  ) 
 

No-op exit element handler.

Parameters:
state Pointer to the current state of the parser

void XLX_initState XLX_state state,
unsigned  stackLimit,
void *  stackSeed,
XLX_pEnter  enter,
XLX_pExit  exit,
XLX_pCharacter  character,
int  verbose
 

Initialises the state of the parser.

Parameters:
state State to initialise
stackLimit Initial depth of the stack
stackSeed Initial item on the stack
enter Parser default action on encountering an enter tag
exit Parser default action on encountering an exit tag
character Parser default action on encountering a character tag
verbose Vebosity level of the parser, 0 is quiet, non-zero is not

Here is the call graph for this function:

void XLX_printout_down XLX_state state,
const char *  element
 

Print an starting tag.

Parameters:
state Current state of the parser
element Text string from the current tag

void XLX_printout_up XLX_state state,
const char *  element
 

Print an ending tag.

Parameters:
state Current state of the parser
element Text string from the current tag

void XLX_start void *  data,
const char *  element,
const char **  attribute
 

Handles a start tag.

Parameters:
data Current state of the parser
element Element name from start tag
attribute Attribute list from the start tag

Here is the call graph for this function:


Generated on Wed Aug 3 21:14:40 2005 by doxygen 1.3.3