dbStaticLib.h

Defines

dbCalloc(nobj, size)
dbMalloc(size)
S_dbLib_recordTypeNotFound
S_dbLib_recExists
S_dbLib_recNotFound
S_dbLib_flddesNotFound
S_dbLib_fieldNotFound
S_dbLib_badField
S_dbLib_menuNotFound
S_dbLib_nameLength
S_dbLib_noRecSup
S_dbLib_strLen
S_dbLib_noSizeOffset
S_dbLib_outMem
S_dbLib_infoNotFound

Typedefs

typedef dbBase DBBASE

Functions

DBBASE *dbAllocBase(void)
void dbFreeBase(DBBASE *pdbbase)
DBENTRY *dbAllocEntry(DBBASE *pdbbase)
void dbFreeEntry(DBENTRY *pdbentry)
void dbInitEntry(DBBASE *pdbbase, DBENTRY *pdbentry)
void dbFinishEntry(DBENTRY *pdbentry)
DBENTRY *dbCopyEntry(const DBENTRY *pdbentry)
void dbCopyEntryContents(const DBENTRY *pfrom, DBENTRY *pto)
long dbReadDatabase(DBBASE **ppdbbase, const char *filename, const char *path, const char *substitutions)

Open .dbd or .db file and read definitions.

Parameters:
  • ppdbbase – The database. Typically the “pdbbase” global

  • filename – Filename to read/search. May be absolute, or relative.

  • path – If !NULL, search path when filename is relative, of for ‘include’ statements. Split by ‘:’ or ‘;’ (cf. OSI_PATH_LIST_SEPARATOR)

  • substitutions – If !NULL, macro definitions like “NAME=VAL,OTHER=SOME”

Returns:

0 on success

long dbReadDatabaseFP(DBBASE **ppdbbase, FILE *fp, const char *path, const char *substitutions)

Read definitions from already opened .dbd or .db file.

Note

This function will always close the provided ‘fp’.

Parameters:
  • ppdbbase – The database. Typically the “&pdbbase” global

  • fp – FILE* from which to read definitions. Will always be fclose()’d

  • path – If !NULL, search path when filename is relative, of for ‘include’ statements. Split by ‘:’ or ‘;’ (cf. OSI_PATH_LIST_SEPARATOR)

  • substitutions – If !NULL, macro definitions like “NAME=VAL,OTHER=SOME”

Returns:

0 on success

long dbPath(DBBASE *pdbbase, const char *path)
long dbAddPath(DBBASE *pdbbase, const char *path)
char *dbGetPromptGroupNameFromKey(DBBASE *pdbbase, const short key)
short dbGetPromptGroupKeyFromName(DBBASE *pdbbase, const char *name)
long dbWriteRecord(DBBASE *ppdbbase, const char *filename, const char *precordTypename, int level)
long dbWriteRecordFP(DBBASE *ppdbbase, FILE *fp, const char *precordTypename, int level)
long dbWriteMenu(DBBASE *pdbbase, const char *filename, const char *menuName)
long dbWriteMenuFP(DBBASE *pdbbase, FILE *fp, const char *menuName)
long dbWriteRecordType(DBBASE *pdbbase, const char *filename, const char *recordTypeName)
long dbWriteRecordTypeFP(DBBASE *pdbbase, FILE *fp, const char *recordTypeName)
long dbWriteDevice(DBBASE *pdbbase, const char *filename)
long dbWriteDeviceFP(DBBASE *pdbbase, FILE *fp)
long dbWriteDriver(DBBASE *pdbbase, const char *filename)
long dbWriteDriverFP(DBBASE *pdbbase, FILE *fp)
long dbWriteLinkFP(DBBASE *pdbbase, FILE *fp)
long dbWriteRegistrarFP(DBBASE *pdbbase, FILE *fp)
long dbWriteFunctionFP(DBBASE *pdbbase, FILE *fp)
long dbWriteVariableFP(DBBASE *pdbbase, FILE *fp)
long dbWriteBreaktable(DBBASE *pdbbase, const char *filename)
long dbWriteBreaktableFP(DBBASE *pdbbase, FILE *fp)
long dbFindRecordType(DBENTRY *pdbentry, const char *recordTypename)
long dbFirstRecordType(DBENTRY *pdbentry)
long dbNextRecordType(DBENTRY *pdbentry)
char *dbGetRecordTypeName(DBENTRY *pdbentry)
int dbGetNRecordTypes(DBENTRY *pdbentry)
long dbPutRecordAttribute(DBENTRY *pdbentry, const char *name, const char *value)
long dbGetRecordAttribute(DBENTRY *pdbentry, const char *name)
long dbGetAttributePart(DBENTRY *pdbentry, const char **ppname)
long dbFirstField(DBENTRY *pdbentry, int dctonly)
long dbNextField(DBENTRY *pdbentry, int dctonly)
int dbGetNFields(DBENTRY *pdbentry, int dctonly)
char *dbGetFieldName(DBENTRY *pdbentry)
int dbGetFieldDbfType(DBENTRY *pdbentry)
char *dbGetDefault(DBENTRY *pdbentry)
char *dbGetPrompt(DBENTRY *pdbentry)
int dbGetPromptGroup(DBENTRY *pdbentry)
long dbCreateRecord(DBENTRY *pdbentry, const char *pname)
long dbDeleteRecord(DBENTRY *pdbentry)
long dbFreeRecords(DBBASE *pdbbase)
long dbFindRecordPart(DBENTRY *pdbentry, const char **ppname)
long dbFindRecord(DBENTRY *pdbentry, const char *pname)
long dbFirstRecord(DBENTRY *pdbentry)
long dbNextRecord(DBENTRY *pdbentry)
int dbGetNRecords(DBENTRY *pdbentry)
int dbGetNAliases(DBENTRY *pdbentry)
char *dbGetRecordName(DBENTRY *pdbentry)
long dbCopyRecord(DBENTRY *pdbentry, const char *newRecordName, int overWriteOK)
long dbVisibleRecord(DBENTRY *pdbentry)
long dbInvisibleRecord(DBENTRY *pdbentry)
int dbIsVisibleRecord(DBENTRY *pdbentry)
long dbCreateAlias(DBENTRY *pdbentry, const char *paliasName)
int dbIsAlias(DBENTRY *pdbentry)
int dbFollowAlias(DBENTRY *pdbentry)
long dbDeleteAliases(DBENTRY *pdbentry)
long dbFindFieldPart(DBENTRY *pdbentry, const char **ppname)
long dbFindField(DBENTRY *pdbentry, const char *pfieldName)
int dbFoundField(DBENTRY *pdbentry)
char *dbGetString(DBENTRY *pdbentry)
long dbPutString(DBENTRY *pdbentry, const char *pstring)
char *dbVerify(DBENTRY *pdbentry, const char *pstring)
int dbIsDefaultValue(DBENTRY *pdbentry)
long dbFirstInfo(DBENTRY *pdbentry)
long dbNextInfo(DBENTRY *pdbentry)
long dbFindInfo(DBENTRY *pdbentry, const char *name)
long dbNextMatchingInfo(DBENTRY *pdbentry, const char *pattern)
long dbDeleteInfo(DBENTRY *pdbentry)
const char *dbGetInfoName(DBENTRY *pdbentry)
const char *dbGetInfoString(DBENTRY *pdbentry)
long dbPutInfoString(DBENTRY *pdbentry, const char *string)
long dbPutInfoPointer(DBENTRY *pdbentry, void *pointer)
void *dbGetInfoPointer(DBENTRY *pdbentry)
const char *dbGetInfo(DBENTRY *pdbentry, const char *name)
long dbPutInfo(DBENTRY *pdbentry, const char *name, const char *string)
brkTable *dbFindBrkTable(DBBASE *pdbbase, const char *name)
const char *dbGetFieldTypeString(int dbfType)
int dbFindFieldType(const char *type)
dbMenu *dbFindMenu(DBBASE *pdbbase, const char *name)
char **dbGetMenuChoices(DBENTRY *pdbentry)
int dbGetMenuIndex(DBENTRY *pdbentry)
long dbPutMenuIndex(DBENTRY *pdbentry, int index)
int dbGetNMenuChoices(DBENTRY *pdbentry)
char *dbGetMenuStringFromIndex(DBENTRY *pdbentry, int index)
int dbGetMenuIndexFromString(DBENTRY *pdbentry, const char *choice)
drvSup *dbFindDriver(dbBase *pdbbase, const char *name)
char *dbGetRelatedField(DBENTRY *pdbentry)
linkSup *dbFindLinkSup(dbBase *pdbbase, const char *name)
int dbGetNLinks(DBENTRY *pdbentry)
long dbGetLinkField(DBENTRY *pdbentry, int index)
void dbDumpPath(DBBASE *pdbbase)
void dbDumpRecord(DBBASE *pdbbase, const char *precordTypename, int level)
void dbDumpMenu(DBBASE *pdbbase, const char *menuName)
void dbDumpRecordType(DBBASE *pdbbase, const char *recordTypeName)
void dbDumpField(DBBASE *pdbbase, const char *recordTypeName, const char *fname)
void dbDumpDevice(DBBASE *pdbbase, const char *recordTypeName)
void dbDumpDriver(DBBASE *pdbbase)
void dbDumpLink(DBBASE *pdbbase)
void dbDumpRegistrar(DBBASE *pdbbase)
void dbDumpFunction(DBBASE *pdbbase)
void dbDumpVariable(DBBASE *pdbbase)
void dbDumpBreaktable(DBBASE *pdbbase, const char *name)
void dbPvdDump(DBBASE *pdbbase, int verbose)
void dbReportDeviceConfig(DBBASE *pdbbase, FILE *report)
void dbCatString(char **string, int *stringLength, char *pnew, char *separator)

Variables

int dbBptNotMonotonic
int dbStaticDebug
int dbConvertStrict
struct DBENTRY

Public Members

DBBASE *pdbbase
dbRecordType *precordType
dbFldDes *pflddes
dbRecordNode *precnode
dbInfoNode *pinfonode
void *pfield
char *message
short indfield