ucimap.h

   1 /*
   2  * ucimap - library for mapping uci sections into data structures
   3  * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2
   7  * as published by the Free Software Foundation
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  */
  14 #include <stdbool.h>
  15 #include "uci_list.h"
  16 #include "uci.h"
  17
  18 #ifndef ARRAY_SIZE
  19 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
  20 #endif
  21
  22 #define BITFIELD_SIZE(_fields) (((_fields) / 8) + 1)
  23
  24 #define CLR_BIT(_name, _bit) do { \
  25         _name[(_bit) / 8] &= ~(1 << ((_bit) % 8)); \
  26 } while (0)
  27
  28 #define SET_BIT(_name, _bit) do { \
  29         _name[(_bit) / 8] |=  (1 << ((_bit) % 8)); \
  30 } while (0)
  31
  32 #define TEST_BIT(_name, _bit) \
  33         (_name[(_bit) / 8] & (1 << ((_bit) % 8)))
  34
  35 #define OPTMAP_OPTION(_maptype, _type, _field, ...) \
  36         { \
  37                 .type = _maptype, \
  38                 .name = #_field, \
  39                 .offset = offsetof(_type, _field), \
  40                 __VA_ARGS__  \
  41         }
  42
  43 struct uci_sectmap;
  44 struct uci_optmap;
  45
  46 struct uci_map {
  47         struct uci_sectmap *sections;
  48         unsigned int n_sections;
  49         struct list_head sdata;
  50
  51         void *priv; /* user data */
  52 };
  53
  54 enum ucimap_type {
  55         UCIMAP_STRING,
  56         UCIMAP_BOOL,
  57         UCIMAP_INT,
  58 };
  59
  60 /* ucimap internal */
  61 struct uci_sectmap_data {
  62         struct list_head list;
  63         struct uci_sectmap *sm;
  64         const char *section_name;
  65         unsigned long allocmap_len;
  66
  67         /* list of allocations done by ucimap */
  68         void **allocmap;
  69
  70         /* map for changed fields */
  71         unsigned char *cmap;
  72 };
  73
  74 struct uci_sectmap {
  75         /* type string for the uci section */
  76         const char *type;
  77
  78         /* length of the struct to map into */
  79         unsigned int alloc_len;
  80
  81         /* give the caller time to initialize the preallocated struct */
  82         int (*init_section)(struct uci_map *map, void *section, struct uci_section *s);
  83
  84         /* pass the fully processed struct to the callback after the section end */
  85         int (*add_section)(struct uci_map *map, void *section);
  86
  87         /* let the callback clean up its own stuff in the section */
  88         int (*free_section)(struct uci_map *map, void *section);
  89
  90         /* list of option mappings for this section */
  91         struct uci_optmap *options;
  92         unsigned int n_options;
  93 };
  94
  95 struct uci_optmap {
  96         unsigned int offset;
  97         const char *name;
  98         enum ucimap_type type;
  99         union {
 100                 struct {
 101                         int base;
 102                         int min;
 103                         int max;
 104                 } i;
 105                 struct {
 106                         int maxlen;
 107                 } s;
 108         } data;
 109 };
 110
 111 extern int ucimap_init(struct uci_map *map);
 112 extern void ucimap_cleanup(struct uci_map *map);
 113 extern void ucimap_set_changed(void *section, void *field);
 114 extern int ucimap_store_section(struct uci_map *map, struct uci_package *p, void *section);
 115 extern void ucimap_parse(struct uci_map *map, struct uci_package *pkg);
 116