src/FDM/LaRCsim/ls_sym.h

   1 /***************************************************************************
   2
   3         TITLE:          ls_sym.h
   4
   5 ----------------------------------------------------------------------------
   6
   7         FUNCTION:       Header file for symbol table routines
   8
   9 ----------------------------------------------------------------------------
  10
  11         MODULE STATUS:  production
  12
  13 ----------------------------------------------------------------------------
  14
  15         GENEALOGY:      Created 930629 by E. B. Jackson
  16
  17 ----------------------------------------------------------------------------
  18
  19         DESIGNED BY:    Bruce Jackson
  20
  21         CODED BY:       same
  22
  23         MAINTAINED BY:
  24
  25 ----------------------------------------------------------------------------
  26
  27         MODIFICATION HISTORY:
  28
  29         DATE    PURPOSE                                         BY
  30
  31         950227  Added header and declarations for ls_print_findsym_error(),
  32                 ls_get_double(), and ls_get_double() routines.  EBJ
  33
  34         950302  Added structure for symbol description.         EBJ
  35
  36         950306  Added ls_get_sym_val() and ls_set_sym_val() routines.
  37                 This is now the production version.             EBJ
  38
  39         CURRENT RCS HEADER:
  40
  41 $Header$
  42 $Log$
  43 Revision 1.1  1999/06/17 18:07:33  curt
  44 Initial revision
  45
  46 Revision 1.1.1.1  1999/04/05 21:32:45  curt
  47 Start of 0.6.x branch.
  48
  49 Revision 1.3  1998/08/06 12:46:40  curt
  50 Header change.
  51
  52 Revision 1.2  1998/01/22 02:59:34  curt
  53 Changed #ifdef FILE_H to #ifdef _FILE_H
  54
  55 Revision 1.1  1997/05/29 00:10:00  curt
  56 Initial Flight Gear revision.
  57
  58  * Revision 1.9  1995/03/07  12:52:33  bjax
  59  * This production version now specified ls_get_sym_val() and ls_put_sym_val().
  60  *
  61  * Revision 1.6.1.2  1995/03/06  18:45:41  bjax
  62  * Added def'n of ls_get_sym_val() and ls_set_sym_val(); changed symbol_rec
  63  * Addr field from void * to char *.
  64  *  EBJ
  65  *
  66  * Revision 1.6.1.1  1995/03/03  01:17:44  bjax
  67  * Experimental version with just ls_get_double and ls_set_double() routines.
  68  *
  69  * Revision 1.6  1995/02/27  19:50:49  bjax
  70  * Added header and declarations for ls_print_findsym_error(),
  71  * ls_get_double(), and ls_set_double().  EBJ
  72  *
  73
  74 ----------------------------------------------------------------------------
  75
  76         REFERENCES:
  77
  78 ----------------------------------------------------------------------------
  79
  80         CALLED BY:
  81
  82 ----------------------------------------------------------------------------
  83
  84         CALLS TO:
  85
  86 ----------------------------------------------------------------------------
  87
  88         INPUTS:
  89
  90 ----------------------------------------------------------------------------
  91
  92         OUTPUTS:
  93
  94 --------------------------------------------------------------------------*/
  95
  96 #ifndef _LS_SYM_H
  97 #define _LS_SYM_H
  98
  99
 100 /* Return codes */
 101
 102 #define SYM_NOT_LOADED -2
 103 #define SYM_UNEXPECTED_ERR -1
 104 #define SYM_OK 0
 105 #define SYM_OPEN_ERR 1
 106 #define SYM_NO_SYMS 2
 107 #define SYM_MOD_NOT_FOUND 3
 108 #define SYM_VAR_NOT_FOUND 4
 109 #define SYM_NOT_SCALAR 5
 110 #define SYM_NOT_STATIC 6
 111 #define SYM_MEMORY_ERR 7
 112 #define SYM_UNMATCHED_PAREN 8
 113 #define SYM_BAD_SYNTAX 9
 114 #define SYM_INDEX_BOUNDS_ERR 10
 115
 116 typedef enum {Unknown, Char, UChar, SHint, USHint, Sint, Uint, Slng, Ulng, flt, dbl} vartype;
 117
 118 typedef char            SYMBOL_NAME[64];
 119 typedef vartype         SYMBOL_TYPE;
 120
 121
 122
 123 typedef struct
 124 {
 125     SYMBOL_NAME Mod_Name;
 126     SYMBOL_NAME Par_Name;
 127     SYMBOL_TYPE Par_Type;
 128     SYMBOL_NAME Alias;
 129     char        *Addr;
 130 }       symbol_rec;
 131
 132
 133 extern int      ls_findsym( const char *modname, const char *varname,
 134                             char **addr, vartype *vtype );
 135
 136 extern void     ls_print_findsym_error(int result,
 137                                        char *mod_name,
 138                                        char *var_name);
 139
 140 extern double   ls_get_double(vartype sym_type, void *addr );
 141
 142 extern void     ls_set_double(vartype sym_type, void *addr, double value );
 143
 144 extern double   ls_get_sym_val( symbol_rec *symrec, int *error );
 145
 146         /* This routine attempts to return the present value of the symbol
 147            described in symbol_rec. If Addr is non-zero, the value of that
 148            location, interpreted as type double, will be returned. If Addr
 149            is zero, and Mod_Name and Par_Name are both not null strings,
 150            the ls_findsym() routine is used to try to obtain the address
 151            by looking at debugger symbol tables in the executable image, and
 152            the value of the double contained at that address is returned,
 153            and the symbol record is updated to contain the address of that
 154            symbol. If an error is discovered, 'error' will be non-zero and
 155            and error message is printed on stderr.                      */
 156
 157 extern void     ls_set_sym_val( symbol_rec *symrec, double value );
 158
 159         /* This routine sets the value of a double at the location pointed
 160            to by the symbol_rec's Addr field, if Addr is non-zero. If Addr
 161            is zero, and Mod_Name and Par_Name are both not null strings,
 162            the ls_findsym() routine is used to try to obtain the address
 163            by looking at debugger symbol tables in the executable image, and
 164            the value of the double contained at that address is returned,
 165            and the symbol record is updated to contain the address of that
 166            symbol. If an error is discovered, 'error' will be non-zero and
 167            and error message is printed on stderr.                      */
 168
 169
 170 #endif /* _LS_SYM_H */
 171
 172