0a2eecbc18c253c35d4eab8e21aa56091869232a
[srvx.git] / src / saxdb.h
1 /* saxdb.h - srvx database manager
2  * Copyright 2002-2004 srvx Development Team
3  *
4  * This file is part of srvx.
5  *
6  * srvx is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with srvx; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
19  */
20
21 #if !defined(DBMGR_H)
22 #define DBMGR_H
23
24 #include "recdb.h"
25
26 DECLARE_LIST(int_list, int);
27
28 struct saxdb;
29 /* This definition should ONLY be used so callers of
30  * saxdb_open_context() can initialize jbuf properly. */
31 struct saxdb_context {
32     FILE *output;
33     unsigned int indent;
34     struct int_list complex;
35     jmp_buf jbuf;
36 };
37
38
39 #define SAXDB_READER(NAME) int NAME(struct dict *db)
40 typedef SAXDB_READER(saxdb_reader_func_t);
41
42 #define SAXDB_WRITER(NAME) int NAME(struct saxdb_context *ctx)
43 typedef SAXDB_WRITER(saxdb_writer_func_t);
44
45 void saxdb_init(void);
46 void saxdb_finalize(void);
47 struct saxdb *saxdb_register(const char *name, saxdb_reader_func_t *reader, saxdb_writer_func_t *writer);
48 void saxdb_write(const char *db_name);
49 void saxdb_write_all(void);
50 int write_database(FILE *out, struct dict *db);
51
52 /* Callbacks for SAXDB_WRITERs */
53 void saxdb_start_record(struct saxdb_context *dest, const char *name, int complex);
54 void saxdb_end_record(struct saxdb_context *dest);
55 void saxdb_write_string_list(struct saxdb_context *dest, const char *name, struct string_list *list);
56 void saxdb_write_string(struct saxdb_context *dest, const char *name, const char *value);
57 void saxdb_write_int(struct saxdb_context *dest, const char *name, unsigned long value);
58 void saxdb_write_sint(struct saxdb_context *dest, const char *name, long value);
59
60 /* For doing db writing by hand */
61 struct saxdb_context *saxdb_open_context(FILE *f);
62 void saxdb_close_context(struct saxdb_context *ctx);
63
64 #endif /* !defined(DBMGR_H) */