Woolz Image Processing  Version 1.7.5
bibFile.h File Reference

Types and constants for the bibtex based file syntax used for serial section data, .... More...

Go to the source code of this file.

Data Structures

struct  _BibFileField
 
struct  BibFileRecord
 

Typedefs

typedef struct _BibFileField BibFileField
 

Enumerations

enum  BibFileError {
  BIBFILE_ER_NONE = 0,
  BIBFILE_ER_MALLOC,
  BIBFILE_ER_SYNTAX,
  BIBFILE_ER_WRITE,
  BIBFILE_ER_READ,
  BIBFILE_ER_EOF
}
 

Functions

BibFileRecordBibFileRecordMake (char *name, char *id, BibFileField *field)
 Given record name and id strings and a field pointer a new record is created. More...
 
BibFileFieldBibFileFieldMake (char *name, char *value, BibFileField *next)
 Given field name and value strings and a field pointer for the next field, a new field is created. More...
 
BibFileFieldBibFileFieldMakeVa (char *name, char *value,...)
 Given a list of field name and value string pairs which is terminated by a NULL. A hierarchy of new fields is created. More...
 
BibFileFieldBibFileFieldJoin (BibFileField *field0, BibFileField *field1,...)
 Given a NULL terminated varargs list of fields, these are joined by filling in the appropriate next fields. More...
 
void BibFileRecordFree (BibFileRecord **record)
 Free's the given record and sets it to NULL. More...
 
void BibFileFieldFree (BibFileField **field)
 Recursively free's the given field and sets it to NULL. More...
 
char * BibFileStrDup (const char *s1)
 
BibFileError BibFileRecordRead (BibFileRecord **record, char **eMsg, FILE *fP)
 Read a bibtex style record from the given stream and allocate storage as required. More...
 
BibFileError BibFileRecordWrite (FILE *fP, char **eMsg, BibFileRecord *record)
 Write a bibtex style record to the given stream. More...
 
BibFileError BibFileFieldRead (BibFileField **field, char **eMsg, int *endFlag, FILE *fP)
 Read a bibtex style field from the given stream and allocate storage as required. More...
 
BibFileError BibFileFieldWrite (FILE *fP, char **eMsg, BibFileField *field)
 Write a bibtex style field to the given stream. More...
 
BibFileError BibFileEscapeRestrictedChar (char *pString, char **outString)
 Replace any special character with ESC+spacial char. More...
 
BibFileError BibFileUnEscapeRestrictedChar (char *pString, char **outString)
 Replace any special caracter with ESC+spacial char. More...
 
int BibFileFieldParseFmt (BibFileField *topField, void *value, char *fmt, char *name,...)
 Given the top most field from which to parse fields and a NULL terminated varargs list of field value pointers, format strings (for sscanf) and field name strings. All fields are parsed for all name strings. Parsed values are allowed to overwrite those previously parsed. Note that string values are parsed using a char ** and are AlcStrDup()'d. More...
 

Detailed Description

Types and constants for the bibtex based file syntax used for serial section data, ....

Author
Bill Hill
Date
March 1999
Version
Id
dfb46d3cb9fb45092c0c9e68fa015d1db3fc1e0c
Address: MRC Human Genetics Unit, MRC Institute of Genetics and Molecular Medicine, University of Edinburgh, Western General Hospital, Edinburgh, EH4 2XU, UK.
Copyright (C), [2012], The University Court of the University of Edinburgh, Old College, Edinburgh, UK.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Typedef Documentation

typedef struct _BibFileField BibFileField

Enumeration Type Documentation

Enumerator
BIBFILE_ER_NONE 
BIBFILE_ER_MALLOC 
BIBFILE_ER_SYNTAX 
BIBFILE_ER_WRITE 
BIBFILE_ER_READ 
BIBFILE_ER_EOF 

Function Documentation

char* BibFileStrDup ( const char *  s1)