src/resource/resource.h

   1 /*! \file resource.h
   2
   3 */
   4
   5 #ifndef XUNI_GUARD_RESOURCE_H
   6 #define XUNI_GUARD_RESOURCE_H
   7
   8 #include <stdio.h>  /* for BUFSIZ */
   9 #include <stdarg.h>
  10
  11 #ifdef __cplusplus
  12 extern "C" {
  13 #endif
  14
  15 enum {
  16     RESOURCE_BUFFER_SIZE = BUFSIZ
  17 };
  18
  19 enum resource_data_type_t {
  20     RESOURCE_TEXT,
  21     RESOURCE_TAG,
  22     RESOURCE_REF,
  23     RESOURCES
  24 };
  25
  26 struct resource_text_t {
  27     char *data;
  28 };
  29
  30 struct resource_tag_t {
  31     char *name;
  32     struct resource_list_t *list;
  33 };
  34
  35 struct resource_ref_t {
  36     char *name;
  37     struct resource_data_t *ref;
  38 };
  39
  40 struct resource_data_t {
  41     struct resource_data_t *base;
  42     enum resource_data_type_t type;
  43
  44     union {
  45         struct resource_text_t *text;
  46         struct resource_tag_t *tag;
  47         struct resource_ref_t *ref;
  48     } data;
  49 };
  50
  51 struct resource_list_t {
  52     struct resource_data_t **data;
  53     size_t n;
  54 };
  55
  56 struct resource_t {
  57     struct resource_data_t *data;
  58 };
  59
  60 typedef void (*search_resource_func_t)(void *vdata,
  61     struct resource_data_t *data);
  62
  63 /* Public functions. */
  64
  65 void init_resource(struct resource_t *resource);
  66 void write_resource(struct resource_data_t *resource, const char *filename);
  67 void update_resource(struct resource_t *resource, const char *filename);
  68 int parse_resource(struct resource_data_t *resource, const char *filename);
  69 int parse_resource_filename(struct resource_data_t *resource,
  70     const char *filename);
  71 struct resource_list_t *first_resource_tag(struct resource_list_t *list,
  72     const char *name);
  73 char *first_resource_text(struct resource_list_t *list);
  74 char **first_resource_text_address(struct resource_list_t *list);
  75 char *find_resource_text(struct resource_list_t *list, const char *data);
  76 const char *lookup_resource_string(struct resource_t *resource,
  77     const char *def, ...);
  78 double lookup_resource_number(struct resource_t *resource, double def, ...);
  79 struct resource_list_t *lookup_resource_tag(struct resource_t *resource,
  80     struct resource_list_t *def, ...);
  81 void search_resource_tag(struct resource_data_t *list, const char *data,
  82     int recursive, search_resource_func_t search_resource_func, void *vdata);
  83 void free_resource(struct resource_t *resource);
  84
  85 /* Resource functions. */
  86
  87 struct resource_list_t *new_resource_list(void);
  88 struct resource_data_t *new_resource_data(
  89     enum resource_data_type_t type, struct resource_data_t *base);
  90 struct resource_data_t *create_element(struct resource_data_t *base,
  91     const char *name);
  92 struct resource_list_t *append_resource_list(
  93     struct resource_list_t *list, struct resource_data_t *data);
  94
  95 void make_paths_relative_to_xuni(struct resource_data_t *data, char **path);
  96
  97 const char *lookup_resource_va(struct resource_t *resource,
  98     va_list arg);
  99
 100 void free_resource_data(struct resource_data_t *data);
 101 void free_resource_list(struct resource_list_t *list);
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #include "../config.h"
 108
 109 #ifdef HAVE_LIBEXPAT
 110     #define RESOURCE_LIBRARY_EXPAT
 111     #include "libexpat.h"
 112     #include "xmlwrite.h"
 113 #elif defined(HAVE_LIBMXML)
 114     #define RESOURCE_LIBRARY_MXML
 115     #include "libmxml.h"
 116 #else
 117     #error "No resource parsing library specified"
 118 #endif
 119
 120 #endif