GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > RIM / V0-0-2

Constituent: lrd_parser     Tag: linux-gcc


Interface   Data Structures   File List   Data Fields   Globals  

state_p.h File Reference

Definition of RegState structure. More...

#include "XLX/state.h"
#include "files_p.h"
#include "cptDetail_p.h"
#include <stdio.h>

Include dependency graph for state_p.h:

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


Data Structures

struct  GenFiles
 Collects together all the file structures used by the parser. More...
struct  RegState
 State of a lrd parser. More...

Enumerations

enum  { REG_NAME_LEN = 40 }
enum  REG_TYPE {
  REG_TYPE_IGN = 0,
  REG_TYPE_LATC = 1,
  REG_TYPE_INIT = 2
}
 Classification of a register.

Functions

void init_regState (RegState *state, int verbose)
 Initialises a RegState object for parsing XML files.
void scpt_regState (RegState *state, const char *name, unsigned regWidth, unsigned multi, unsigned suppress)
 Handle the start of a new component by recording some information on a stack and calling the various scpt_file functions.
void sreg_regState (RegState *state, const char *name, unsigned regId, REG_TYPE type)
 Handle the start of a new register updating some state information and calling the various sreg_file functions.
void sfld_regState (RegState *state, const char *name, unsigned width, unsigned offset)
 handle the start of a new field by calling the various sfld_file functions
void ereg_regState (RegState *state)
 Call the ereg_file functions.
void ecpt_regState (RegState *state)
 Round out a component by popping some information off the stack and calling the various ecpt_file functions.
void fini_regState (RegState *state)
 Finishes off the parsing by closing all the files and clearing the state information.

Detailed Description

Definition of RegState structure.

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

Function Documentation

void ecpt_regState RegState state  ) 
 

Round out a component by popping some information off the stack and calling the various ecpt_file functions.

Parameters:
state Parser state being manipulated

void ereg_regState RegState state  ) 
 

Call the ereg_file functions.

Parameters:
state Parser state being manipulated

void fini_regState RegState state  ) 
 

Finishes off the parsing by closing all the files and clearing the state information.

Parameters:
state State to end

void init_regState RegState state,
int  verbose
 

Initialises a RegState object for parsing XML files.

Parameters:
state State to initialise
verbose Verbosity level for the parser, zero is quiet, non-zero is not

void scpt_regState RegState state,
const char *  name,
unsigned  regWidth,
unsigned  multi,
unsigned  suppress
 

Handle the start of a new component by recording some information on a stack and calling the various scpt_file functions.

Parameters:
state Parser state being manipulated
name Name of the component
regWidth Width (in bits) of the registers of this component
multi Multiplicity of this component
suppress 1 indicates that this component is not handled by LATC, so the parser should be suppressed.

void sfld_regState RegState state,
const char *  name,
unsigned  width,
unsigned  offset
 

handle the start of a new field by calling the various sfld_file functions

Parameters:
state Parser state being manipulated
name Field name
width Number of bits in the field
offset Start bit of the field

void sreg_regState RegState state,
const char *  name,
unsigned  regId,
REG_TYPE  type
 

Handle the start of a new register updating some state information and calling the various sreg_file functions.

Parameters:
state Parser state being manipulated
name Register name
regId Register ID
type Type of register, IGN, LATC or INIT


Generated on Thu Apr 13 23:38:51 2006 by  doxygen 1.4.4