1 |
/* $Id: DD.h,v 1.1 1997/03/22 20:02:35 cnh Exp $*/ |
2 |
|
3 |
/* =================== Data Dictionary dd routines ================ */ |
4 |
|
5 |
/* Return codes */ |
6 |
#define ddNONAME 0 /* No name in record passed to routine */ |
7 |
#define ddALLOCERR -1 /* Memory allocation failure */ |
8 |
|
9 |
/* Structure of data dictionary record */ |
10 |
struct ddRecord { |
11 |
char *name; /* Variable name */ |
12 |
int id; /* Numeric identifier */ |
13 |
char *key; /* Character key ( used to reduce HTML file |
14 |
size. */ |
15 |
char *hrefEntry; |
16 |
char *textEntry; |
17 |
char *footNotesEntry; |
18 |
char *unitsEntry; |
19 |
int active; |
20 |
int isInNameList; /* Flag that name is used in a */ |
21 |
/* namelist. */ |
22 |
int isInIfdef; /* Flag that name is used in a */ |
23 |
/* ifdef. */ |
24 |
int isProcName; /* Flag that name is used a */ |
25 |
/* procedure name. */ |
26 |
}; |
27 |
typedef struct ddRecord ddRecord; |
28 |
|
29 |
ddRecord *ddAdd(/* ddRecord * */); |
30 |
/* Add record at end of dictionary. */ |
31 |
/* Returns ddRecord.id for new entry. <=0 means failed. */ |
32 |
/* ddRecord needs to have char *name set on entry. Other*/ |
33 |
/* entries are optional. NULL or 0 is used to indicate */ |
34 |
/* unspecified parameter. int id is set by ddInsert. */ |
35 |
/* int id value on entry is ignored. */ |
36 |
/* Record is inserted at current record and current */ |
37 |
/* record is moved forward one. */ |
38 |
|
39 |
int ddSort(/* */); |
40 |
/* Sort dictionary. */ |
41 |
/* Current record is set to first record. */ |
42 |
|
43 |
int ddGetCurrent(/* ddRecord * */); |
44 |
/* Returns current record. 0 indicates end of table. */ |
45 |
/* Moves current record pointer forward one. */ |
46 |
|
47 |
ddRecord *ddFind(/* *ddRecord */); |
48 |
/* Find a record that matches ddRecord->name */ |
49 |
|
50 |
int ddDestroy(/* */); |
51 |
/* Free up dictionary. */ |