diff options
Diffstat (limited to 'libdb/db_storage.h')
| -rw-r--r-- | libdb/db_storage.h | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/libdb/db_storage.h b/libdb/db_storage.h new file mode 100644 index 0000000..6db37bb --- /dev/null +++ b/libdb/db_storage.h @@ -0,0 +1,104 @@ +/* + * db_storage.h: define mandata structure, some macros and prototypes + * + * Copyright (C) 1994, 1995 Graeme W. Wilford. (Wilf.) + * Copyright (C) 2002, 2003, 2007, 2008 Colin Watson. + * + * This file is part of man-db. + * + * man-db 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. + * + * man-db 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 man-db; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + * + * Sat Oct 29 13:09:31 GMT 1994 Wilf. (G.Wilford@ee.surrey.ac.uk) + */ + +#ifndef DB_STORAGE_H +#define DB_STORAGE_H + +/* These definitions give an inherent precedence to each particular type + of manual page: + + ULT_MAN: ultimate manual page, the full source nroff file. + SO_MAN: source nroff file containing .so request to an ULT_MAN. + WHATIS_MAN: virtual `whatis referenced' page pointing to an ULT_MAN. + STRAY_CAT: pre-formatted manual page with no source. + WHATIS_CAT: virtual `whatis referenced' page pointing to a STRAY_CAT. */ + +/* WHATIS_MAN and WHATIS_CAT are deprecated. */ + +#define ULT_MAN 'A' +#define SO_MAN 'B' +#define WHATIS_MAN 'C' +#define STRAY_CAT 'D' +#define WHATIS_CAT 'E' + +#define FIELDS 10 /* No of fields in each database page `content' */ + +#include "timespec.h" + +#include "xalloc.h" + +#include "mydbm.h" + +struct mandata { + struct mandata *next; /* ptr to next structure, if any */ + char *addr; /* ptr to memory containing the fields */ + + char *name; /* Name of page, if != key */ + + /* The following are all const because they should be pointers to + * parts of strings allocated elsewhere (often the addr field above) + * and should not be written through or freed themselves. + */ + const char *ext; /* Filename ext w/o comp ext */ + const char *sec; /* Section name/number */ + char id; /* id for this entry */ + const char *pointer; /* id related file pointer */ + const char *comp; /* Compression extension */ + const char *filter; /* filters needed for the page */ + const char *whatis; /* whatis description for page */ + struct timespec mtime; /* mod time for file */ +}; + +/* used by the world */ +extern struct mandata *dblookup_all (MYDBM_FILE dbf, const char *page, + const char *section, int match_case); +extern struct mandata *dblookup_exact (MYDBM_FILE dbf, const char *page, + const char *section, int match_case); +extern struct mandata *dblookup_pattern (MYDBM_FILE dbf, const char *page, + const char *section, int match_case, + int pattern_regex, + int try_descriptions); +extern int dbstore (MYDBM_FILE dbf, struct mandata *in, const char *base); +extern int dbdelete (MYDBM_FILE dbf, const char *name, struct mandata *in); +extern void dbprintf (const struct mandata *info); +extern void free_mandata_elements (struct mandata *pinfo); +extern void free_mandata_struct (struct mandata *pinfo); +extern void split_content (char *cont_ptr, struct mandata *pinfo); +extern int compare_ids (char a, char b, int promote_links); + +/* local to db routines */ +extern void gripe_lock (char *filename); +extern void gripe_corrupt_data (void); +extern datum make_multi_key (const char *page, const char *ext); + +/* allocate a mandata structure */ +#define infoalloc() XZALLOC (struct mandata) + +extern char *name_to_key (const char *name); +extern int list_extensions (char *data, char ***names, char ***ext); +extern void gripe_replace_key (const char *data); +extern const char *dash_if_unset (const char *str); + +#endif |