s3-registry: handle registration entries (.reg) files
authorGregor Beck <gbeck@sernet.de>
Mon, 20 Sep 2010 12:46:25 +0000 (14:46 +0200)
committerMichael Adam <obnox@samba.org>
Wed, 22 Sep 2010 04:30:00 +0000 (06:30 +0200)
Signed-off-by: Michael Adam <obnox@samba.org>
source3/Makefile.in
source3/registry/reg_format.c [new file with mode: 0644]
source3/registry/reg_format.h [new file with mode: 0644]
source3/registry/reg_import.c [new file with mode: 0644]
source3/registry/reg_import.h [new file with mode: 0644]
source3/registry/reg_parse.c [new file with mode: 0644]
source3/registry/reg_parse.h [new file with mode: 0644]
source3/registry/reg_parse_dox.cfg [new file with mode: 0644]
source3/registry/reg_parse_internal.c [new file with mode: 0644]
source3/registry/reg_parse_internal.h [new file with mode: 0644]

index 1e0ab00717ea49eaa0468d5882c5f823631e5728..256d799afe872ef1f837b7a28553fcab427cf5d3 100644 (file)
@@ -1151,6 +1151,8 @@ NET_OBJ1 = utils/net.o utils/net_ads.o utils/net_help.o \
           $(RPC_CLIENT_SCHANNEL_OBJ) \
           rpc_client/init_netlogon.o \
           rpc_client/init_samr.o \
+          registry/reg_parse.o registry/reg_format.o \
+          registry/reg_parse_internal.o registry/reg_import.o \
           lib/cbuf.o lib/srprs.o
 
 # these are not processed by make proto
diff --git a/source3/registry/reg_format.c b/source3/registry/reg_format.c
new file mode 100644 (file)
index 0000000..946380d
--- /dev/null
@@ -0,0 +1,808 @@
+/*
+ * Samba Unix/Linux SMB client library
+ *
+ * Copyright (C) Gregor Beck 2010
+ *
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @brief  Format dot.reg files
+ * @file   reg_format.c
+ * @author Gregor Beck <gb@sernet.de>
+ * @date   Sep 2010
+ */
+
+#include "reg_format.h"
+#include "reg_parse.h"
+#include "reg_parse_internal.h"
+#include "cbuf.h"
+#include "srprs.h"
+#include "registry.h"
+#include "registry/reg_objects.h"
+#include <assert.h>
+
+static void cstr_unescape(char* val)
+{
+       all_string_sub(val, "\\r", "\r", 0);
+       all_string_sub(val, "\\n", "\n", 0);
+       all_string_sub(val, "\\t", "\t", 0);
+       all_string_sub(val, "\\\\", "\\", 0);
+}
+
+/******************************************************************************/
+
+/**
+ * Print value assign to stream.
+ *
+ * @param[out] ost outstream
+ * @param[in]  name string
+ *
+ * @return numner of bytes written, -1 on error
+ * @see srprs_val_name
+ */
+static int cbuf_print_value_assign(cbuf* ost, const char* name) {
+       int ret, n;
+       if (*name == '\0') {
+               ret = cbuf_putc(ost, '@');
+       } else {
+               ret = cbuf_print_quoted_string(ost, name);
+       }
+
+       if (ret<0) {
+               return ret;
+       }
+
+       n = cbuf_putc(ost, '=');
+       if (n < 0) {
+               return n;
+       }
+       ret += n;
+
+       return ret;
+}
+
+enum fmt_hive {
+       FMT_HIVE_PRESERVE=0,
+       FMT_HIVE_SHORT,
+       FMT_HIVE_LONG
+};
+
+
+struct fmt_key {
+       enum fmt_hive hive_fmt;
+       enum fmt_case hive_case;
+       enum fmt_case key_case;
+       const char*   sep;
+};
+
+
+static int
+cbuf_print_hive(cbuf* ost, const char* hive, int len, const struct fmt_key* fmt)
+{
+       if (fmt->hive_fmt != FMT_HIVE_PRESERVE) {
+               const struct hive_info* hinfo = hive_info(hive, len);
+               if (hinfo == NULL) {
+                       DEBUG(0, ("Unknown hive %*s", len, hive));
+               } else {
+                       switch(fmt->hive_fmt) {
+                       case FMT_HIVE_SHORT:
+                               hive = hinfo->short_name;
+                               len  = hinfo->short_name_len;
+                               break;
+                       case FMT_HIVE_LONG:
+                               hive = hinfo->long_name;
+                               len  = hinfo->long_name_len;
+                               break;
+                       default:
+                               DEBUG(0, ("Unsupported hive format %d",
+                                         (int)fmt->hive_fmt));
+                               return -1;
+                       }
+               }
+       }
+
+       return cbuf_puts_case(ost, hive, len, fmt->hive_case);
+}
+
+static int
+cbuf_print_keyname(cbuf* ost, const char* key[], int n, const struct fmt_key* fmt)
+{
+       int r, ret=0;
+       size_t pos = cbuf_getpos(ost);
+       bool hive = true;
+
+       for (; n>0; key++, n--) {
+               const char* start = *key;
+               while(*start != '\0') {
+                       const char* end = start;
+                       while(*end != '\\' && *end != '\0') {
+                               end++;
+                       }
+
+                       if (hive) {
+                               r = cbuf_print_hive(ost, start, end-start, fmt);
+                               if (r < 0) {
+                                       goto fail;
+                               }
+
+                               ret += r;
+                               hive = false;
+                       } else {
+                               r = cbuf_puts(ost, fmt->sep, -1);
+                               if (r < 0) {
+                                       goto fail;
+                               }
+                               ret += r;
+
+                               r = cbuf_puts_case(ost, start, end-start, fmt->key_case);
+                               if (r < 0) {
+                                       goto fail;
+                               }
+                               ret += r;
+                       }
+
+                       while(*end == '\\') {
+                               end++;
+                       }
+                       start = end;
+               }
+       }
+       return ret;
+fail:
+       cbuf_setpos(ost, pos);
+       return r;
+}
+/**@}*/
+
+/**
+ * @defgroup reg_format Format dot.reg file.
+ * @{
+ */
+
+struct reg_format
+{
+       struct reg_parse_callback reg_parse_callback;
+       struct reg_format_callback call;
+       unsigned flags;
+       smb_iconv_t fromUTF16;
+       const char* sep;
+};
+
+int reg_format_value_delete(struct reg_format* f, const char* name)
+{
+       int ret;
+       cbuf* line = cbuf_new(f);
+
+       ret = cbuf_print_value_assign(line, name);
+       if (ret < 0) {
+               goto done;
+       }
+
+       ret = cbuf_putc(line, '-');
+       if (ret < 0 ) {
+               goto done;
+       }
+
+       ret = f->call.writeline(f->call.data, cbuf_gets(line, 0));
+done:
+       talloc_free(line);
+       return ret;
+}
+
+/* Todo: write hex if str contains CR or LF */
+static int
+reg_format_value_sz(struct reg_format* f, const char* name, const char* str)
+{
+       int ret;
+       cbuf* line = cbuf_new(f);
+
+       ret = cbuf_print_value_assign(line, name);
+       if (ret < 0) {
+               goto done;
+       }
+
+       ret = cbuf_print_quoted_string(line, str);
+       if (ret < 0) {
+               goto done;
+       }
+
+       ret = f->call.writeline(f->call.data, cbuf_gets(line, 0));
+
+done:
+       talloc_free(line);
+       return ret;
+}
+
+static int reg_format_value_dw(struct reg_format* f, const char* name, uint32_t dw)
+{
+       int ret;
+       cbuf* line = cbuf_new(f);
+
+       ret = cbuf_print_value_assign(line, name);
+       if (ret < 0) {
+               goto done;
+       }
+
+       ret = cbuf_printf(line, "dword:%08x", dw);
+       if (ret < 0) {
+               goto done;
+       }
+
+       ret = f->call.writeline(f->call.data, cbuf_gets(line, 0));
+done:
+       talloc_free(line);
+       return ret;
+}
+
+static int reg_format_value_hex(struct reg_format* f, const char* name, uint32_t type,
+                               const void* data, size_t len)
+{
+       int n;
+       int cpl=0;
+       int ret=0;
+       const unsigned char* ptr;
+
+       cbuf* line = cbuf_new(f);
+
+       n = cbuf_print_value_assign(line, name);
+       if (n < 0) {
+               ret = n;
+               goto done;
+       }
+
+       cpl += n;
+
+       if (type==REG_BINARY && !(f->flags & REG_FMT_HEX_BIN)) {
+               n=cbuf_puts(line, "hex:", -1);
+       } else {
+               n=cbuf_printf(line, "hex(%x):", type);
+       }
+       if (n < 0) {
+               ret = n;
+               goto done;
+       }
+
+       cpl += n;
+
+       for (ptr=data; len>1; len--,ptr++) {
+               n = cbuf_printf(line, "%02x,", (unsigned)(*ptr));
+               if (n < 0) {
+                       return n;
+               }
+               cpl += n;
+
+               if ( cpl > 76 ) {
+                       n = cbuf_putc(line, '\\');
+                       if (n< 0) {
+                               return n;
+                       }
+
+                       n = f->call.writeline(f->call.data, cbuf_gets(line,0));
+                       if (n < 0) {
+                               ret = n;
+                               goto done;
+                       }
+                       ret += n;
+
+                       cbuf_clear(line);
+                       cpl = cbuf_puts(line, "  ", -1);
+                       if (cpl < 0) {
+                               ret = cpl;
+                               goto done;
+                       }
+               }
+       }
+
+       if ( len > 0 ) {
+               n = cbuf_printf(line, "%02x", (unsigned)(*ptr));
+               if (n < 0) {
+                       ret = n;
+                       goto done;
+               }
+               cpl += n;
+       }
+
+       n = f->call.writeline(f->call.data, cbuf_gets(line,0));
+       if (n < 0) {
+               ret = n;
+               goto done;
+       }
+       ret += n;
+done:
+       talloc_free(line);
+       return ret;
+}
+
+int reg_format_value(struct reg_format* f, const char* name, uint32_t type,
+                    const uint8_t* data, size_t len)
+{
+       int ret = 0;
+       void* mem_ctx = talloc_new(f);
+
+       switch (type) {
+       case REG_SZ:
+               if (!(f->flags & REG_FMT_HEX_SZ)) {
+                       char* str = NULL;
+                       size_t dlen;
+                       if (pull_ucs2_talloc(mem_ctx, &str, (const smb_ucs2_t*)data, &dlen)) {
+                               ret = reg_format_value_sz(f, name, str);
+                               goto done;
+                       } else {
+                               DEBUG(0, ("reg_format_value %s: "
+                                         "pull_ucs2_talloc failed"
+                                         ", try to write hex\n", name));
+                       }
+               }
+               break;
+
+       case REG_DWORD:
+               if (!(f->flags & REG_FMT_HEX_SZ) && (len == sizeof(uint32_t))) {
+                       uint32_t dw = IVAL(data,0);
+                       ret = reg_format_value_dw(f, name, dw);
+                       goto done;
+               }
+               break;
+
+       case REG_MULTI_SZ:
+       case REG_EXPAND_SZ:
+               if (f->fromUTF16 && (f->fromUTF16 != ((smb_iconv_t)-1))) {
+                       char* str = NULL;
+                       size_t dlen = iconvert_talloc(mem_ctx, f->fromUTF16,
+                                                     (const char*)data, len, &str);
+                       if (dlen != -1) {
+                               ret = reg_format_value_hex(f, name, type, str, dlen);
+                               goto done;
+                       } else {
+                               DEBUG(0, ("reg_format_value %s: "
+                                         "iconvert_talloc failed"
+                                         ", try to write hex\n", name));
+                       }
+               }
+               break;
+       default:
+               break;
+       }
+
+       ret = reg_format_value_hex(f, name, type, data, len);
+done:
+       talloc_free(mem_ctx);
+       return ret;
+}
+
+
+int reg_format_comment(struct reg_format* f, const char* txt)
+{
+       int ret;
+       cbuf* line = cbuf_new(f);
+
+       ret = cbuf_putc(line,';');
+       if (ret<0) {
+               goto done;
+       }
+
+       ret = cbuf_puts(line, txt, -1);
+       if (ret < 0) {
+               goto done;
+       }
+
+       ret = f->call.writeline(f->call.data, cbuf_gets(line, 0));
+done:
+       talloc_free(line);
+       return ret;
+}
+
+
+/******************************************************************************/
+
+
+
+struct reg_format* reg_format_new(const void* talloc_ctx,
+                                 struct reg_format_callback cb,
+                                 const char* str_enc, unsigned flags,
+                                 const char* sep)
+{
+       static const struct reg_parse_callback reg_parse_callback_default = {
+               .key = (reg_parse_callback_key_t)&reg_format_key,
+               .val = (reg_parse_callback_val_t)&reg_format_value,
+               .val_del = (reg_parse_callback_val_del_t)&reg_format_value_delete,
+               .comment = (reg_parse_callback_comment_t)&reg_format_comment,
+       };
+
+       struct reg_format* f = talloc_zero(talloc_ctx, struct reg_format);
+       if (f == NULL) {
+               return NULL;
+       }
+
+       f->reg_parse_callback = reg_parse_callback_default;
+       f->reg_parse_callback.data = f;
+
+       f->call = cb;
+       f->flags = flags;
+       f->sep   = sep;
+
+       if (str_enc && !set_iconv(&f->fromUTF16, str_enc, "UTF-16LE")) {
+               DEBUG(0, ("reg_format_new: failed to set encoding: %s\n",
+                         str_enc));
+               goto fail;
+       }
+
+       assert(&f->reg_parse_callback == (struct reg_parse_callback*)f);
+       return f;
+fail:
+       talloc_free(f);
+       return NULL;
+}
+
+int reg_format_set_options(struct reg_format* fmt, const char* options)
+{
+       static const char* DEFAULT ="enc=unix,flags=0,sep=\\";
+
+       int ret = 0;
+       char *key, *val;
+       void* ctx = talloc_new(fmt);
+
+       if (options == NULL) {
+               options = DEFAULT;
+       }
+
+       while (srprs_option(&options, ctx, &key, &val)) {
+               if ((strcmp(key, "enc") == 0) || (strcmp(key, "strenc") == 0)) {
+                       if (!set_iconv(&fmt->fromUTF16, val, "UTF-16LE")) {
+                               DEBUG(0, ("Failed to set encoding: %s\n", val));
+                               ret = -1;
+                       }
+               } else if ((strcmp(key, "flags") == 0) && (val != NULL)) {
+                       char* end = NULL;
+                       if (val != NULL) {
+                               fmt->flags = strtol(val, &end, 0);
+                       }
+                       if ((end==NULL) || (*end != '\0')) {
+                               DEBUG(0, ("Invalid flags format: %s\n",
+                                         val ? val : "<NULL>"));
+                               ret = -1;
+                       }
+               } else if ((strcmp(key, "sep") == 0) && (val != NULL)) {
+                       cstr_unescape(val);
+                       fmt->sep = talloc_steal(fmt, val);
+               }
+
+               /* else if (strcmp(key, "hive") == 0) { */
+               /*      if (strcmp(val, "short") == 0) { */
+               /*              f->hive_fmt = REG_FMT_SHORT_HIVES; */
+               /*      } else if (strcmp(val, "long") == 0) { */
+               /*              f->hive_fmt = REG_FMT_LONG_HIVES; */
+               /*      } else if (strcmp(val, "preserve") == 0) { */
+               /*              f->hive_fmt = REG_FMT_PRESERVE_HIVES; */
+               /*      } else { */
+               /*              DEBUG(0, ("Invalid hive format: %s\n", val)); */
+               /*              ret = -1; */
+               /*      } */
+               /* } */
+       }
+       talloc_free(ctx);
+       return ret;
+}
+
+int reg_format_key(struct reg_format* f, const char* key[], size_t n, bool del)
+{
+       int ret, r;
+       cbuf* line = cbuf_new(f);
+       struct fmt_key key_fmt = {
+               .key_case  = (f->flags >>  4) & 0x0F,
+               .hive_case = (f->flags >>  8) & 0x0F,
+               .hive_fmt  = (f->flags >> 12) & 0x0F,
+               .sep       = f->sep,
+       };
+
+       ret = cbuf_putc(line, '[');
+       if (ret < 0) {
+               goto done;
+       }
+
+       if (del) {
+               ret = cbuf_putc(line, '-');
+               if (ret < 0) {
+                       goto done;
+               }
+       }
+
+       ret = cbuf_print_keyname(line, key, n, &key_fmt);
+       if (ret < 0) {
+               goto done;
+       }
+
+       ret = cbuf_putc(line, ']');
+       if (ret < 0) {
+               goto done;
+       }
+
+       ret = f->call.writeline(f->call.data, "");
+       if (ret < 0) {
+               goto done;
+       }
+
+       r = f->call.writeline(f->call.data, cbuf_gets(line, 0));
+       if (r < 0) {
+               ret = r;
+               goto done;
+       }
+       ret += r;
+
+done:
+       talloc_free(line);
+       return ret;
+}
+
+
+int reg_format_registry_key(struct reg_format* f, struct registry_key* key,
+                           bool del)
+{
+       return reg_format_key(f, (const char**)&key->key->name, 1, del);
+}
+
+int reg_format_registry_value(struct reg_format* f, const char* name,
+                             struct registry_value* val)
+{
+       return reg_format_value(f, name, val->type,
+                               val->data.data, val->data.length);
+}
+
+int reg_format_regval_blob(struct reg_format* f, const char* name,
+                          struct regval_blob* val)
+{
+
+       return reg_format_value(f,
+                               name ? name : regval_name(val),
+                               regval_type(val),
+                               regval_data_p(val),
+                               regval_size(val));
+}
+
+/**@}*/
+
+
+struct reg_format_file
+{
+       FILE* file;
+       const char* encoding;
+       smb_iconv_t fromUnix;
+       char* nl;
+       size_t nl_len;
+};
+
+
+static int reg_format_file_close(struct reg_format* fmt)
+{
+       struct reg_format_file* fmt_ctx
+               = (struct reg_format_file*) fmt->call.data;
+       int ret = 0;
+       FILE* file = fmt_ctx->file;
+
+       if (fmt_ctx->encoding) {
+               char buf[32];
+               snprintf(buf, sizeof(buf), "coding: %s", fmt_ctx->encoding);
+               reg_format_comment(fmt, "Local Variables:");
+               reg_format_comment(fmt, buf);
+               reg_format_comment(fmt, "End:");
+       }
+
+       if (file != NULL) {
+               ret = fclose(file);
+       }
+
+       return ret;
+}
+
+static int reg_format_file_writeline(void* ptr, const char* line)
+{
+       size_t size;
+       char* dst=NULL;
+       struct reg_format_file* fmt_ctx = (struct reg_format_file*)ptr;
+       int ret, r;
+
+       size = iconvert_talloc(ptr, fmt_ctx->fromUnix, line, strlen(line), &dst);
+       if (size == -1 ) {
+               DEBUG(0, ("reg_format_file_writeline: iconvert_talloc failed >%s<\n",  line));
+               return -1;
+       }
+
+       ret = fwrite(dst, 1, size, fmt_ctx->file);
+       if (ret < 0) {
+               goto done;
+       }
+
+       r = fwrite(fmt_ctx->nl, 1, fmt_ctx->nl_len, fmt_ctx->file);
+       ret = (r < 0) ? r : ret + r;
+
+done:
+       talloc_free(dst);
+       return ret;
+}
+
+struct reg_format_file_opt {
+       const char* head;
+       const char* nl;
+       const char* enc;
+       bool bom;
+       const char* str_enc;
+       unsigned flags;
+       const char* sep;
+};
+
+struct reg_format_file_opt reg_format_file_opt(void* mem_ctx, const char* opt)
+{
+       static const struct reg_format_file_opt REG4 = {
+               .head = "REGEDIT4",
+               .nl   = "\r\n",
+               .enc  = "dos",
+               .str_enc = "dos",
+               .bom  = false,
+               .flags = (FMT_HIVE_LONG << 12),
+               .sep   = "\\",
+       };
+
+       static const struct reg_format_file_opt REG5 = {
+               .head = "Windows Registry Editor Version 5.00",
+               .nl   = "\r\n",
+               .enc  = "UTF-16LE",
+               .str_enc = "UTF-16LE",
+               .bom  = true,
+               .flags = (FMT_HIVE_LONG << 12),
+               .sep   = "\\",
+       };
+
+       struct reg_format_file_opt ret = {
+               .head = REG5.head,
+               .nl   = "\n",
+               .enc  = "unix",
+               .bom  = false,
+               .str_enc = "UTF-16LE",
+               .flags = 0,
+               .sep   = "\\",
+       };
+
+       void* tmp_ctx = talloc_new(mem_ctx);
+
+       char *key, *val;
+
+       if (opt == NULL) {
+               goto done;
+       }
+
+       while(srprs_option(&opt, tmp_ctx, &key, &val)) {
+               if (strcmp(key, "enc") == 0) {
+                       ret.enc     = talloc_steal(mem_ctx, val);
+                       ret.str_enc = ret.enc;
+               } else if (strcmp(key, "strenc") == 0) {
+                       ret.str_enc = talloc_steal(mem_ctx, val);
+               } else if (strcmp(key, "fileenc") == 0) {
+                       ret.enc = talloc_steal(mem_ctx, val);
+               } else if ((strcmp(key, "flags") == 0) && (val != NULL)) {
+                       char* end = NULL;
+                       if (val != NULL) {
+                               ret.flags = strtol(val, &end, 0);
+                       }
+                       if ((end==NULL) || (*end != '\0')) {
+                               DEBUG(0, ("Invalid flags format: %s\n",
+                                         val ? val : "<NULL>"));
+                       }
+               } else if ((strcmp(key, "sep") == 0) && (val != NULL)) {
+                       cstr_unescape(val);
+                       ret.sep = talloc_steal(mem_ctx, val);
+               } else if (strcmp(key, "head") == 0) {
+                       cstr_unescape(val);
+                       ret.head = talloc_steal(mem_ctx, val);
+               } else if (strcmp(key, "nl") == 0) {
+                       cstr_unescape(val);
+                       ret.nl = talloc_steal(mem_ctx, val);
+               } else if (strcmp(key, "bom") == 0) {
+                       if (val == NULL) {
+                               ret.bom = true;
+                       } else {
+                               ret.bom = atoi(val);
+                       }
+               } else if (strcmp(key, "regedit4") == 0) {
+                       ret = REG4;
+               } else if (strcmp(key, "regedit5") == 0) {
+                       ret = REG5;
+               }
+       }
+done:
+       talloc_free(tmp_ctx);
+       return ret;
+}
+
+
+struct reg_format* reg_format_file(const void* talloc_ctx,
+                                  const char* filename,
+                                  const char* options)
+{
+       struct reg_format_file* fmt_ctx;
+       struct reg_format* fmt;
+       int ret;
+       struct reg_format_file_opt opt;
+
+       struct reg_format_callback reg_format_cb = {
+               .writeline = &reg_format_file_writeline
+       };
+
+       fmt_ctx = talloc_zero(talloc_ctx, struct reg_format_file);
+       if (fmt_ctx == NULL) {
+               errno = ENOMEM;
+               return NULL;
+       }
+
+       opt = reg_format_file_opt(fmt_ctx, options);
+
+       reg_format_cb.data = fmt_ctx;
+
+       fmt = reg_format_new(talloc_ctx, reg_format_cb,
+                            opt.str_enc, opt.flags, opt.sep);
+       if (fmt == NULL) {
+               errno = ENOMEM;
+               talloc_free(fmt_ctx);
+               return NULL;
+       }
+
+       talloc_steal(fmt, fmt_ctx);
+
+       if (!set_iconv(&fmt->fromUTF16, opt.str_enc, "UTF-16LE")) { /* HACK */
+               DEBUG(0, ("reg_format_file: failed to set string encoding %s",
+                             opt.str_enc));
+               goto fail;
+       }
+
+       if (!set_iconv(&fmt_ctx->fromUnix, opt.enc, "unix")) {
+               DEBUG(0, ("reg_format_file: failed to set file encoding %s",
+                         opt.enc));
+               goto fail;
+       }
+       fmt_ctx->encoding = talloc_strdup(fmt_ctx, get_charset(opt.enc));
+
+       fmt_ctx->file = fopen(filename, "w");
+       if (fmt_ctx->file == NULL) {
+               DEBUG(0, ("reg_format_file: fopen failed: %s\n", strerror(errno)));
+               goto fail;
+       }
+
+       if (setvbuf(fmt_ctx->file, NULL, _IOFBF, 64000) < 0) {
+               DEBUG(0, ("reg_format_file: setvbuf failed: %s\n", strerror(errno)));
+       }
+
+       talloc_set_destructor(fmt, reg_format_file_close);
+
+       fmt_ctx->nl_len = iconvert_talloc(fmt, fmt_ctx->fromUnix, opt.nl, strlen(opt.nl), &fmt_ctx->nl);
+       if (fmt_ctx->nl_len == -1) {
+               DEBUG(0, ("iconvert_talloc failed\n"));
+               goto fail;
+       }
+
+       if (opt.bom) {
+               ret = write_bom(fmt_ctx->file, opt.enc, -1);
+               if (ret < 0) {
+                       goto fail;
+               }
+       }
+
+       ret = fmt->call.writeline(fmt->call.data, opt.head);
+       if (ret < 0) {
+               goto fail;
+       }
+
+       return fmt;
+fail:
+       talloc_free(fmt);
+       return NULL;
+}
diff --git a/source3/registry/reg_format.h b/source3/registry/reg_format.h
new file mode 100644 (file)
index 0000000..5d0a4f2
--- /dev/null
@@ -0,0 +1,219 @@
+/*
+ * Samba Unix/Linux SMB client library
+ *
+ * Copyright (C) Gregor Beck 2010
+ *
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @brief  Format registration entries (.reg) files.
+ * A formater is a talloced incarnation of an opaque struct reg_format.
+ * It is fed with registry key's and value's and emits output by calling
+ * writeline from its reg_format_callback.
+ * @file   reg_format.h
+ * @author Gregor Beck <gb@sernet.de>
+ * @date   Sep 2010
+ */
+#ifndef __REG_FORMAT_H
+#define __REG_FORMAT_H
+
+#include <stdbool.h>
+#include <stdint.h>
+#include <stddef.h>
+
+struct registry_key;
+struct registry_value;
+struct regval_blob;
+
+
+/**
+ * A Formater for registration entries (.reg) files.
+ *
+ * It may be used as a reg_parse_callback, so the following is valid:
+ * @code
+ * reg_parse* p = reg_parse_new(mem_ctx,
+ *                             (reg_parse_callback)reg_format_new(mem_ctx, cb, NULL, 0, "\\"),
+ *                                NULL, 0);
+ * @endcode
+ * @see reg_parse
+ */
+typedef struct reg_format reg_format;
+
+/**
+ * Protoype for function called to output a line.
+ *
+ * @param private_data
+ * @param line line to write in UNIX charset
+ *
+ * @return number of characters written, < 0 on error
+ *
+ * @see reg_parse
+ */
+typedef int (*reg_format_callback_writeline_t)(void* private_data,
+                                              const char* line);
+/**
+ * Type handling the output of a reg_format object.
+ * It containes the functions to call and an opaque data pointer.
+ */
+typedef struct reg_format_callback {
+       /**< Function called to write a line */
+       reg_format_callback_writeline_t writeline;
+       void* data; /**< Private data passed to callback function */
+} reg_format_callback;
+
+/**
+ * Create a new reg_format object.
+ *
+ * @param talloc_ctx the talloc parent
+ * @param cb         the output handler
+ * @param str_enc    the charset of hex encoded strings (REG_MULTI_SZ, REG_EXAND_SZ) if not UTF-16
+ * @param flags
+ * @param sep        the separator for subkeys
+ *
+ * @return a talloc'ed reg_format object, NULL on error
+ */
+reg_format* reg_format_new(const void* talloc_ctx,
+                          reg_format_callback cb,
+                          const char* str_enc,
+                          unsigned flags,
+                          const char* sep);
+
+/**
+ * Create a new reg_format object, writing to a file.
+ *
+ * @param talloc_ctx the talloc parent
+ * @param filename   the file to write to
+ * @param options
+ *
+ * @return a talloc'ed reg_format object, NULL on error
+ */
+reg_format* reg_format_file(const void* talloc_ctx,
+                           const char* filename,
+                           const char* options);
+
+/**
+ * Format a registry key given as struct registry_key.
+ * Create/Open or Delete
+ *
+ * @param f   the formater.
+ * @param key the key to output.
+ * @param del wheter to format the deletion of the key
+ *
+ * @retval >= 0 on success.
+ */
+int reg_format_registry_key(reg_format* f,
+                           struct registry_key* key,
+                           bool del);
+
+/**
+ * Format a registry value given as struct registry_value.
+ *
+ * @param f    the formater.
+ * @param name the values name
+ * @param val  the values value.
+ *
+ * @retval >= 0 on success.
+ */
+int reg_format_registry_value(reg_format* f,
+                             const char* name,
+                             struct registry_value* val);
+
+/**
+ * Format a registry value given as struct regval_blob.
+ *
+ * @param f    the formater.
+ * @param name the values name, if NULL use val->valname which is limited in size;
+ * @param val  the values value.
+ *
+ * @retval >= 0 on success.
+ */
+int reg_format_regval_blob(reg_format* f,
+                          const char* name,
+                          struct regval_blob* val);
+
+
+/**
+ * Format deletion of a registry value.
+ *
+ * @param f    the formater.
+ * @param name the values name
+ *
+ * @retval >= 0 on success.
+ *
+ * @see reg_parse_callback_val_del_t
+ */
+int reg_format_value_delete(reg_format* f, const char* name);
+
+/**
+ * Format a comment.
+ *
+ * @param f   the formater.
+ * @param txt the comment in UNIX charset, may not contain newlines.
+ *
+ * @retval >= 0 on success.
+ *
+ * @see reg_parse_callback_comment_t
+ */
+int reg_format_comment(reg_format* f, const char* txt);
+
+
+int reg_format_set_options(reg_format* f, const char* options);
+
+
+/* reg_format flags */
+#define REG_FMT_HEX_SZ  1
+#define REG_FMT_HEX_DW  2
+#define REG_FMT_HEX_BIN 4
+#define REG_FMT_HEX_ALL (REG_FMT_HEX_SZ | REG_FMT_HEX_DW | REG_FMT_HEX_BIN);
+#define REG_FMT_LONG_HIVES 16
+#define REG_FMT_SHORT_HIVES 32
+
+/* lowlevel */
+
+/**
+ * Format a registry key.
+ * Create/Open or Delete
+ *
+ * @param f   the formater
+ * @param key the key to output
+ * @param klen number of elements in key
+ * @param del wheter to format the deletion of the key
+ *
+ * @retval >= 0 on success.
+ *
+ * @see reg_parse_callback_key_t
+ */
+int reg_format_key(reg_format* f,
+                  const char* key[], size_t klen,
+                  bool del);
+
+/**
+ * Format a registry value.
+ *
+ * @param f    the formater
+ * @param name the values name
+ * @param type the values type
+ * @param data the values value
+ * @param len  the number of bytes of data
+ *
+ * @retval >= 0 on success.
+ *
+ * @see reg_parse_callback_val_hex_t
+ */
+int reg_format_value(reg_format* f,
+                    const char* name, uint32_t type,
+                    const uint8_t* data, size_t len);
+
+#endif /* __REG_FORMAT_H */
diff --git a/source3/registry/reg_import.c b/source3/registry/reg_import.c
new file mode 100644 (file)
index 0000000..ce3cd97
--- /dev/null
@@ -0,0 +1,290 @@
+/*
+ * Samba Unix/Linux SMB client library
+ * Adapter to use reg_parse with the registry api
+ *
+ * Copyright (C) Gregor Beck 2010
+ *
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "includes.h"
+#include "reg_parse.h"
+#include "reg_import.h"
+#include "registry.h"
+#include "registry/reg_objects.h"
+#include <assert.h>
+
+/* Debuglevel for tracing */
+static const int TL = 2;
+
+struct reg_import
+{
+       struct reg_parse_callback reg_parse_callback;
+       struct reg_import_callback call;
+       void* open_key;
+};
+
+static int
+reg_parse_callback_key(struct reg_import* cb_private,
+                      const char* key[], size_t n,
+                      bool del);
+
+static int
+reg_parse_callback_val(struct reg_import* cb_private,
+                      const char* name, uint32_t type,
+                      const uint8_t* data, uint32_t len);
+
+static int
+reg_parse_callback_val_registry_value(struct reg_import* cb_private,
+                                     const char* name, uint32_t type,
+                                     const uint8_t* data, uint32_t len);
+
+static int
+reg_parse_callback_val_regval_blob(struct reg_import* cb_private,
+                                  const char* name, uint32_t type,
+                                  const uint8_t* data, uint32_t len);
+
+static int
+reg_parse_callback_val_del(struct reg_import* cb_private,
+                          const char* name);
+
+static int
+reg_parse_callback_comment(struct reg_import* cb_private,
+                          const char* txt);
+
+
+/*******************************************************************************/
+
+int reg_parse_callback_key(struct reg_import* p,
+                          const char* key[], size_t n, bool del)
+{
+       WERROR werr = WERR_OK;
+
+       DEBUG(TL, ("%s: %s\n", __FUNCTION__, key[0]));
+
+       if (p->open_key != NULL ) {
+               werr = p->call.closekey(p->call.data, p->open_key);
+               if (!W_ERROR_IS_OK(werr)) {
+                       DEBUG(0, ("closekey failed: %s\n", win_errstr(werr)));
+               }
+       }
+
+       if (del) {
+               werr = p->call.deletekey(p->call.data, NULL, key[0]);
+               if (W_ERROR_EQUAL(werr, WERR_BADFILE)) {
+                       /* the key didn't exist, treat as success */
+                       werr = WERR_OK;
+               }
+               if (!W_ERROR_IS_OK(werr)) {
+                       DEBUG(0, ("deletekey %s failed: %s\n",
+                                 key[0], win_errstr(werr)));
+               }
+       }
+       else {
+               bool existing;
+               werr = p->call.createkey(p->call.data, NULL, key[0],
+                                        &p->open_key, &existing);
+               if (W_ERROR_IS_OK(werr)) {
+                       DEBUG(TL, ("createkey %s %s\n",
+                                 existing ? "opened" : "created", key[0]));
+               } else {
+                       DEBUG(0, ("createkey %s failed: %s\n",
+                                 key[0], win_errstr(werr)));
+               }
+       }
+
+       return W_ERROR_IS_OK(werr) ? 0 : -1;
+}
+
+#define DEBUG_ADD_HEX(LEV, PTR, LEN)                                   \
+       do {                                                            \
+               int i;                                                  \
+               const unsigned char* ptr = (const unsigned char*)PTR;   \
+               for (i=0; i<LEN; i++) {                                 \
+                       DEBUGADD(LEV, ("'%c'(%02x)%s",                  \
+                                      isprint(ptr[i]) ? ptr[i] : '.',  \
+                                      (unsigned)ptr[i],                \
+                                      ((i+1 < LEN) && (i+1)%8)         \
+                                      ? ",  " : "\n"));                \
+               }                                                       \
+       } while(0)
+
+/*----------------------------------------------------------------------------*/
+int reg_parse_callback_val(struct reg_import* p,
+                          const char* name, uint32_t type,
+                          const uint8_t* data, uint32_t len)
+{
+       WERROR werr = WERR_OK;
+
+       DEBUG(TL, ("%s(%x): >%s< = [%x]\n",  __FUNCTION__, type, name, len));
+       DEBUG_ADD_HEX(TL, data, len);
+
+       werr = p->call.setval.blob(p->call.data, p->open_key, name, type,
+                                  data, len);
+       if (!W_ERROR_IS_OK(werr)) {
+               DEBUG(0, ("setval %s failed: %s\n",
+                         name, win_errstr(werr)));
+       }
+
+       return W_ERROR_IS_OK(werr) ? 0 : -1;
+}
+
+/*----------------------------------------------------------------------------*/
+int reg_parse_callback_val_registry_value(struct reg_import* p,
+                                         const char* name, uint32_t type,
+                                         const uint8_t* data, uint32_t len)
+{
+       WERROR werr = WERR_OK;
+       struct registry_value val = {
+               .type = type,
+               .data = data_blob_talloc(p, data, len),
+       };
+
+       DEBUG(TL, ("%s(%x): >%s< = [%x]\n", __FUNCTION__, type, name, len));
+       DEBUG_ADD_HEX(TL, data, len);
+
+       werr = p->call.setval.registry_value(p->call.data, p->open_key,
+                                            name, &val);
+       if (!W_ERROR_IS_OK(werr)) {
+               DEBUG(0, ("setval %s failed: %s\n",
+                         name, win_errstr(werr)));
+       }
+
+       data_blob_free(&val.data);
+       return W_ERROR_IS_OK(werr) ? 0 : -1;
+}
+
+/*----------------------------------------------------------------------------*/
+int reg_parse_callback_val_regval_blob(struct reg_import* p,
+                                      const char* name, uint32_t type,
+                                      const uint8_t* data, uint32_t len)
+{
+       WERROR werr = WERR_OK;
+       void* mem_ctx = talloc_new(p);
+       struct regval_blob* v = NULL;
+
+       DEBUG(TL, ("%s(%x): >%s< = [%x]\n", __FUNCTION__, type, name, len));
+       DEBUG_ADD_HEX(TL, data, len);
+
+       v = regval_compose(mem_ctx, name, type, data, len);
+       if (v == NULL) {
+               DEBUG(0, ("regval_compose %s failed\n", name));
+               werr = WERR_NOMEM;
+               goto done;
+       }
+
+       werr = p->call.setval.regval_blob(p->call.data, p->open_key, v);
+       if (!W_ERROR_IS_OK(werr)) {
+               DEBUG(0, ("setval %s failed: %s\n",
+                         name, win_errstr(werr)));
+       }
+
+done:
+       talloc_free(mem_ctx);
+
+       return W_ERROR_IS_OK(werr) ? 0 : -1;
+}
+
+
+/*----------------------------------------------------------------------------*/
+
+int reg_parse_callback_val_del(struct reg_import* p,
+                              const char* name)
+{
+       WERROR werr = WERR_OK;
+
+       DEBUG(TL, ("%s: %s\n", __FUNCTION__, name));
+
+       werr = p->call.deleteval(p->call.data, p->open_key, name);
+       if (!W_ERROR_IS_OK(werr)) {
+               DEBUG(0, ("deleteval %s failed: %s\n",
+                         name, win_errstr(werr)));
+       }
+
+       return W_ERROR_IS_OK(werr) ? 0 : -1;
+}
+
+
+int reg_parse_callback_comment(struct reg_import* cb_private,
+                              const char* txt)
+{
+       DEBUG(TL, ("%s: %s\n", __FUNCTION__, txt));
+       return 0;
+}
+
+/******************************************************************************/
+static int nop(void* data)
+{
+       return 0;
+}
+
+
+struct reg_parse_callback* reg_import_adapter(const void* talloc_ctx,
+                                             struct reg_import_callback cb)
+{
+       struct reg_parse_callback* ret;
+       struct reg_import* p = talloc_zero(talloc_ctx, struct reg_import);
+       if (p == NULL) {
+               goto fail;
+       }
+       if (cb.openkey == NULL ) {
+               cb.openkey = (reg_import_callback_openkey_t)&nop;
+       }
+       if (cb.closekey == NULL ) {
+               cb.closekey = (reg_import_callback_closekey_t)&nop;
+       }
+       if (cb.createkey == NULL ) {
+               cb.createkey = (reg_import_callback_createkey_t)&nop;
+       }
+       if (cb.deletekey == NULL ) {
+               cb.deletekey = (reg_import_callback_deletekey_t)&nop;
+       }
+       if (cb.deleteval == NULL ) {
+               cb.deleteval = (reg_import_callback_deleteval_t)&nop;
+       }
+
+       p->call = cb;
+
+       ret = &p->reg_parse_callback;
+       ret->key     = (reg_parse_callback_key_t)     &reg_parse_callback_key;
+       ret->val_del = (reg_parse_callback_val_del_t) &reg_parse_callback_val_del;
+       ret->comment = (reg_parse_callback_comment_t) &reg_parse_callback_comment;
+       ret->data = p;
+
+       switch (cb.setval_type) {
+       case BLOB:
+               assert(cb.setval.blob != NULL);
+               ret->val = (reg_parse_callback_val_t) &reg_parse_callback_val;
+               break;
+       case REGISTRY_VALUE:
+               assert(cb.setval.registry_value != NULL);
+               ret->val = (reg_parse_callback_val_t) &reg_parse_callback_val_registry_value;
+               break;
+       case REGVAL_BLOB:
+               assert(cb.setval.regval_blob != NULL);
+               ret->val = (reg_parse_callback_val_t) &reg_parse_callback_val_regval_blob;
+               break;
+       case NONE:
+               ret->val = NULL;
+               break;
+       default:
+               assert(false);
+       }
+
+       assert((struct reg_parse_callback*)p == ret);
+       return ret;
+fail:
+       talloc_free(p);
+       return NULL;
+}
diff --git a/source3/registry/reg_import.h b/source3/registry/reg_import.h
new file mode 100644 (file)
index 0000000..5922f9d
--- /dev/null
@@ -0,0 +1,199 @@
+/*
+ * Samba Unix/Linux SMB client library
+ *
+ * Copyright (C) Gregor Beck 2010
+ *
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @brief  Adapter to use reg_parse with the registry api
+ * @file   reg_import.h
+ * @author Gregor Beck <gb@sernet.de>
+ * @date   Jun 2010
+ */
+
+
+#ifndef REG_IMPORT_H
+#define REG_IMPORT_H
+
+#include "reg_parse.h"
+
+struct registry_value;
+struct regval_blob;
+
+/**
+ * Protoype for function called to open a key.
+ *
+ * @param private_data
+ * @param[in] parent    the parent of the key to open, may be NULL
+ * @param[in] name      the name of the key relative to parent.
+ * @param[out] key      the opened key
+ *
+ * @return WERR_OK on success
+ */
+typedef        WERROR (*reg_import_callback_openkey_t) (void* private_data,
+                                               void* parent,
+                                               const char* name,
+                                               void** key);
+
+/**
+ * Protoype for function called to close a key.
+ *
+ * @param private_data
+ * @param key the key to close
+ *
+ * @return WERR_OK on success
+ */
+typedef        WERROR (*reg_import_callback_closekey_t) (void* private_data,
+                                                 void* key);
+
+/**
+ * Protoype for function called to create (or open an existing) key.
+ *
+ * @param private_data
+ * @param[in] parent    the parent of the key to create, may be NULL
+ * @param[in] name      the name of the key relative to parent.
+ * @param[out] key      the opened key
+ * @param[out] existing whether we opened an existing key
+ *
+ * @return WERR_OK on success
+ */
+typedef        WERROR (*reg_import_callback_createkey_t)(void* private_data,
+                                               void* parent,
+                                               const char* name,
+                                               void** key,
+                                               bool* existing);
+
+/**
+ * Protoype for function called to delete a key.
+ *
+ * @param private_data
+ * @param parent    the parent of the key to delete, may be NULL
+ * @param[in] name  the name of the key relative to parent.
+ *
+ * @return WERR_OK on success
+ */
+typedef        WERROR (*reg_import_callback_deletekey_t)(void* private_data,
+                                                 void* parent,
+                                                 const char* name);
+
+/**
+ * Protoype for function called to delete a value.
+ *
+ * @param private_data
+ * @param parent    the key of the value to delete
+ * @param[in] name  the name of the value to delete.
+ *
+ * @return WERR_OK on success
+ */
+typedef        WERROR (*reg_import_callback_deleteval_t)(void* private_data,
+                                               void* parent,
+                                               const char* name);
+
+/**
+ * Protoype for function called to set a value.
+ *
+ * @param private_data
+ * @param parent the key of the value to set
+ * @param name   the name of the value
+ * @param type   the type of the value
+ * @param data   the value of the value
+ * @param size   the number of bytes of data
+ *
+ * @return WERR_OK on success
+ */
+typedef        WERROR (*reg_import_callback_setval_blob_t)(void* private_data,
+                                                 void* parent,
+                                                 const char* name,
+                                                 uint32_t type,
+                                                 const uint8_t* data,
+                                                 uint32_t size);
+
+/**
+ * Protoype for function called to set a value given as struct registry_value.
+ *
+ * @param private_data
+ * @param parent the key of the value to set
+ * @param name   the name of the value
+ * @param val    the value of the value
+ *
+ * @return WERR_OK on success
+ */
+typedef        WERROR (*reg_import_callback_setval_registry_value_t) (
+       void* private_data,
+       void* parent,
+       const char* name,
+       const struct registry_value* val);
+
+/**
+ * Protoype for function called to set a value given as struct struct regval_blob.
+ *
+ * @param private_data
+ * @param parent the key of the value to set
+ * @param val    the value
+ *
+ * @return WERR_OK on success
+ */
+typedef        WERROR (*reg_import_callback_setval_regval_blob_t)(
+       void* private_data,
+       void* parent,
+       const struct regval_blob* val);
+
+/**
+ * Type handling the output of a reg_import object.
+ * It containes the functions to call and an opaque data pointer.
+ */
+struct reg_import_callback {
+       /** Function called to open key */
+       reg_import_callback_openkey_t   openkey;
+       /** Function called to close key */
+       reg_import_callback_closekey_t  closekey;
+       /** Function called to create or open key */
+       reg_import_callback_createkey_t createkey;
+       /** Function called to delete key */
+       reg_import_callback_deletekey_t deletekey;
+       /** Function called to delete value */
+       reg_import_callback_deleteval_t deleteval;
+
+       /** Function called to set value */
+       union {
+               reg_import_callback_setval_blob_t           blob;
+               reg_import_callback_setval_registry_value_t registry_value;
+               reg_import_callback_setval_regval_blob_t    regval_blob;
+       } setval;
+       /** Which function is called to set a value */
+       enum {
+               NONE=0,         /**< no setval function used */
+               BLOB,           /**< @ref reg_import_callback_setval_blob_t blob */
+               REGISTRY_VALUE, /**< @ref reg_import_callback_setval_registry_value_t registry_value */
+               REGVAL_BLOB,    /**< @ref reg_import_callback_setval_regval_blob_t regval_blob */
+       } setval_type;
+       void* data; /**< Private data passed to callback function */
+};
+
+
+/**
+ * Create a new reg_import object.
+ * Because its only purpose is to act as an reg_parse_callback the return type
+ * is accordingly.
+ *
+ * @param talloc_ctx the talloc parent
+ * @param cb         the output handler
+ *
+ * @return a talloc'ed reg_import object, NULL on error
+ */
+struct reg_parse_callback* reg_import_adapter(const void* talloc_ctx,
+                                             struct reg_import_callback cb);
+#endif
diff --git a/source3/registry/reg_parse.c b/source3/registry/reg_parse.c
new file mode 100644 (file)
index 0000000..388eecd
--- /dev/null
@@ -0,0 +1,958 @@
+/*
+ * Samba Unix/Linux SMB client library
+ *
+ * Copyright (C) Gregor Beck 2010
+ *
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @brief  Parser for dot.reg files
+ * @file   reg_parse.c
+ * @author Gregor Beck <gb@sernet.de>
+ * @date   Jun 2010
+ *
+ */
+
+#include "includes.h"
+#include "cbuf.h"
+#include "srprs.h"
+#include "reg_parse_internal.h"
+#include "reg_parse.h"
+#include "reg_format.h"
+
+#include <stdio.h>
+#include <unistd.h>
+#include <wchar.h>
+#include <talloc.h>
+#include <stdbool.h>
+#include <string.h>
+#include <sys/types.h>
+#include <regex.h>
+#include <assert.h>
+#include <stdint.h>
+
+enum reg_parse_state {
+       STATE_DEFAULT,
+       STATE_KEY_OPEN,
+       STATE_VAL_HEX_CONT,
+       STATE_VAL_SZ_CONT
+};
+
+struct reg_parse {
+       struct reg_format_callback reg_format_callback;
+       cbuf* key;
+       cbuf* valname;
+       uint32_t   valtype;
+       cbuf* valblob;
+       cbuf* tmp;
+       struct reg_parse_callback call;
+       int ret;
+       int linenum;
+       enum reg_parse_state state;
+       struct reg_parse_options* opt;
+       smb_iconv_t str2UTF16;
+       unsigned flags;
+};
+
+/**
+ * @defgroup action Action
+ * @{
+ */
+static bool act_key(struct reg_parse* p, cbuf* keyname, bool del)
+{
+       const char* name = cbuf_gets(keyname, 0);
+       cbuf_swap(p->key, keyname);
+
+       assert(p->state == STATE_DEFAULT || p->state == STATE_KEY_OPEN);
+       p->state = del ? STATE_DEFAULT : STATE_KEY_OPEN;
+
+       assert(p->call.key);
+       p->ret = p->call.key(p->call.data, &name, 1, del);
+       return p->ret >= 0;
+}
+
+static bool value_callback(struct reg_parse* p)
+{
+       const char* name = cbuf_gets(p->valname,0);
+       const uint8_t* val = (const uint8_t*)cbuf_gets(p->valblob,0);
+       size_t len = cbuf_getpos(p->valblob);
+
+       assert(p->call.val);
+       p->ret = p->call.val(p->call.data, name, p->valtype, val, len);
+       return p->ret >= 0;
+}
+
+static bool act_val_hex(struct reg_parse* p, cbuf* value, bool cont)
+{
+       cbuf_swap(p->valblob, value);
+       assert((p->state == STATE_KEY_OPEN) || (p->state == STATE_VAL_HEX_CONT));
+
+       if (cont) {
+               p->state = STATE_VAL_HEX_CONT;
+       } else {
+               p->state = STATE_KEY_OPEN;
+
+               switch (p->valtype) {
+               case REG_EXPAND_SZ:
+               case REG_MULTI_SZ:
+                       if (p->str2UTF16 != NULL) {
+                               char* dst = NULL;
+                               const char* src = cbuf_gets(p->valblob, 0);
+                               const size_t slen = cbuf_getpos(p->valblob);
+                               size_t dlen = iconvert_talloc(p,
+                                                             p->str2UTF16,
+                                                             src, slen,
+                                                             &dst);
+                               if (dlen != -1) {
+                                       cbuf_swapptr(p->valblob, &dst, dlen);
+                               } else {
+                                       DEBUG(0, ("iconvert_talloc failed\n"));
+                               }
+                               talloc_free(dst);
+                       }
+               default:
+                       break;
+               }
+               return value_callback(p);
+       }
+       return true;
+}
+
+static bool act_val_dw(struct reg_parse* p, uint32_t val)
+{
+       assert(p->valtype == REG_DWORD);
+       assert(p->state == STATE_KEY_OPEN);
+
+       cbuf_clear(p->valblob);
+
+       if (cbuf_putdw(p->valblob, val) < 0) {
+               return false;
+       }
+       return value_callback(p);
+}
+
+static bool act_val_sz(struct reg_parse* p, cbuf* value, bool cont)
+{
+       cbuf_swap(p->valblob, value);
+
+       assert(p->valtype == REG_SZ);
+       assert((p->state == STATE_KEY_OPEN) || (p->state == STATE_VAL_SZ_CONT));
+
+       if (cont) {
+               p->state = STATE_VAL_SZ_CONT;
+       } else {
+               char* dst = NULL;
+               size_t dlen;
+               const char* src = cbuf_gets(p->valblob, 0);
+
+               p->state = STATE_KEY_OPEN;
+
+
+               if (convert_string_talloc(p->valblob, CH_UNIX, CH_UTF16LE,
+                                         src, strlen(src)+1,
+                                         &dst, &dlen, true))
+               {
+                       cbuf_swapptr(p->valblob, &dst, dlen);
+               } else {
+                       DEBUG(0, ("convert_string_talloc failed: >%s<\n"
+                                 "use it as is\t", src));
+               }
+               talloc_free(dst);
+
+               return value_callback(p);
+       }
+       return true;
+}
+
+static bool act_val_del(struct reg_parse* p)
+{
+       const char* name = cbuf_gets(p->valname, 0);
+
+       assert(p->call.val_del);
+       p->ret = p->call.val_del(p->call.data, name);
+       return p->ret >= 0;
+}
+
+static bool act_comment (struct reg_parse* p, const char* txt)
+{
+       assert(p->call.comment);
+       p->ret = p->call.comment(p->call.data, txt);
+       return p->ret >= 0;
+}
+/**@}*/
+
+
+static int nop(void* data)
+{
+       return 0;
+}
+
+
+struct reg_parse* reg_parse_new(const void* ctx,
+                               struct reg_parse_callback cb,
+                               const char* str_enc, unsigned flags)
+{
+       struct reg_parse* s = talloc_zero(ctx, struct reg_parse);
+       if (s == NULL)
+               return NULL;
+       s->key     = cbuf_new(s);
+       s->valname = cbuf_new(s);
+       s->valblob = cbuf_new(s);
+       s->tmp     = cbuf_new(s);
+       if ( (s->tmp == NULL) || (s->valblob == NULL)
+            || (s->valname == NULL) || (s->key == NULL) )
+       {
+               goto fail;
+       }
+
+       s->reg_format_callback.writeline = (reg_format_callback_writeline_t)&reg_parse_line;
+       s->reg_format_callback.data      = s;
+
+       s->valtype = 0;
+       if (cb.key == NULL) {
+               cb.key = (reg_parse_callback_key_t)&nop;
+       }
+       if (cb.val == NULL) {
+               cb.val = (reg_parse_callback_val_t)&nop;
+       }
+       if (cb.val_del == NULL) {
+               cb.val_del = (reg_parse_callback_val_del_t)&nop;
+       }
+       if (cb.comment == NULL) {
+               cb.comment = (reg_parse_callback_comment_t)&nop;
+       }
+
+       s->call = cb;
+       s->linenum = 0;
+       s->state = STATE_DEFAULT;
+       s->flags = flags;
+
+       if (str_enc && !set_iconv(&s->str2UTF16, "UTF-16LE", str_enc)) {
+               DEBUG(0, ("reg_parse_new: failed to set encoding: %s",
+                         str_enc));
+               goto fail;
+       }
+
+       assert(&s->reg_format_callback == (struct reg_format_callback*)s);
+       return s;
+fail:
+       talloc_free(s);
+       return NULL;
+}
+
+/**
+ * @defgroup parse Parser Primitive
+ * @ingroup internal
+ * @{
+ */
+
+
+static bool srprs_key(const char** ptr, cbuf* key, bool* del)
+{
+       const char* pos = *ptr;
+       const char* closing_bracket_pos = NULL;
+       size_t      closing_bracket_idx;
+
+       if (!srprs_skipws(&pos) || !srprs_char(&pos, '[')) {
+               return false;
+       }
+
+       *del = srprs_char(&pos, '-');
+
+       cbuf_clear(key);
+
+       while (true) {
+               while (srprs_charsetinv(&pos, "]\\", key))
+                       ;
+
+               switch (*pos) {
+
+               case ']':
+                       closing_bracket_idx = cbuf_getpos(key);
+                       closing_bracket_pos = pos;
+                       cbuf_putc(key, ']');
+                       pos++;
+                       break;
+
+               case '\\':
+                       cbuf_putc(key, '\\');
+                       /* n++; */
+                       /* cbuf_puts(subkeyidx, cbuf_getpos(key), sizeof(size_t)) */
+                       while (srprs_char(&pos,'\\'))
+                               ;
+                       break;
+
+               case '\0':
+                       if (closing_bracket_pos == NULL) {
+                               return false;
+                       }
+
+                       /* remove trailing backslash (if any) */
+                       if (*(closing_bracket_pos-1)=='\\') {
+                               closing_bracket_idx--;
+                       }
+
+                       cbuf_setpos(key, closing_bracket_idx);
+                       *ptr = closing_bracket_pos+1;
+                       return true;
+
+               default:
+                       assert(false);
+               }
+       }
+}
+
+static bool srprs_val_name(const char** ptr, cbuf* name)
+{
+       const char* pos = *ptr;
+       const size_t spos = cbuf_getpos(name);
+
+       if ( !srprs_skipws(&pos) ) {
+               goto fail;
+       }
+
+       if ( srprs_char(&pos, '@') ) {
+               cbuf_puts(name, "", -1);
+       }
+       else if (!srprs_quoted_string(&pos, name, NULL)) {
+               goto fail;
+       }
+
+       if (!srprs_skipws(&pos) || !srprs_char(&pos, '=')) {
+               goto fail;
+       }
+
+       *ptr = pos;
+       return true;
+
+fail:
+       cbuf_setpos(name, spos);
+       return false;
+}
+
+static bool srprs_val_dword(const char** ptr, uint32_t* type, uint32_t* val)
+{
+       const char* pos = *ptr;
+
+       if (!srprs_str(&pos, "dword:", -1)) {
+               return false;
+       }
+
+       if (!srprs_hex(&pos, 8, val)) {
+               return false;
+       }
+
+       *type = REG_DWORD;
+       *ptr  = pos;
+       return true;
+}
+
+static bool srprs_val_sz(const char** ptr, uint32_t* type, cbuf* val, bool* cont)
+{
+       if (!srprs_quoted_string(ptr, val, cont)) {
+               return false;
+       }
+
+       *type = REG_SZ;
+       return true;
+}
+
+
+static bool srprs_nl_no_eos(const char** ptr, cbuf* str, bool eof)
+{
+       const char* pos = *ptr;
+       const size_t spos = cbuf_getpos(str);
+
+       if( srprs_nl(&pos, str) && (eof || *pos != '\0')) {
+               *ptr = pos;
+               return true;
+       }
+       cbuf_setpos(str, spos);
+       return false;
+}
+
+
+static bool srprs_eol_cont(const char** ptr, bool* cont)
+{
+       const char* pos = *ptr;
+       bool bs = srprs_char(&pos, '\\');
+
+       if (!srprs_eol(&pos, NULL)) {
+               return false;
+       }
+
+       *cont = bs;
+       *ptr = pos;
+       return true;
+}
+
+/* matches the empty string, for zero length lists */
+static bool srprs_val_hex_values(const char** ptr, cbuf* val, bool* cont)
+{
+       const char* pos = *ptr;
+       unsigned u;
+
+       do {
+               if (!srprs_skipws(&pos) || !srprs_hex(&pos, 2, &u) || !srprs_skipws(&pos)) {
+                       break;
+               }
+               cbuf_putc(val, (char)u);
+       } while(srprs_char(&pos, ','));
+
+       *ptr = pos;
+
+       if (srprs_skipws(&pos) && srprs_eol_cont(&pos, cont)) {
+               *ptr = pos;
+       }
+
+       return true;
+}
+
+static bool srprs_val_hex(const char** ptr, uint32_t* ptype, cbuf* val,
+                      bool* cont)
+{
+       const char* pos = *ptr;
+       uint32_t type;
+
+       if (!srprs_str(&pos, "hex", -1)) {
+               return false;
+       }
+
+       if (srprs_char(&pos, ':')) {
+               type = REG_BINARY;
+       }
+       else if (!srprs_char(&pos, '(') ||
+                !srprs_hex(&pos, 8, &type) ||
+                !srprs_char(&pos,')') ||
+                !srprs_char(&pos, ':'))
+       {
+               return false;
+       }
+
+       if (!srprs_val_hex_values(&pos, val, cont)) {
+               return false;
+       }
+
+       *ptype = type;
+       *ptr = pos;
+       return true;
+}
+
+
+static bool srprs_comment(const char** ptr, cbuf* str)
+{
+       return srprs_char(ptr, ';') && srprs_line(ptr, str);
+}
+
+/**@}*/
+
+int reg_parse_set_options(struct reg_parse* parser, const char* options)
+{
+       static const char* DEFAULT ="enc=unix,flags=0";
+
+       int ret = 0;
+       char *key, *val;
+       void* ctx = talloc_new(parser);
+
+       if (options == NULL) {
+               options = DEFAULT;
+       }
+
+       while (srprs_option(&options, ctx, &key, &val)) {
+               if ((strcmp(key, "enc") == 0) || (strcmp(key, "strenc") == 0)) {
+               } else if ((strcmp(key, "flags") == 0) && (val != NULL)) {
+                       char* end = NULL;
+                       if (val != NULL) {
+                               parser->flags = strtol(val, &end, 0);
+                       }
+                       if ((end==NULL) || (*end != '\0')) {
+                               DEBUG(0, ("Invalid flags format: %s\n",
+                                         val ? val : "<NULL>"));
+                               ret = -1;
+                       }
+               }
+               /* else if (strcmp(key, "hive") == 0) { */
+               /*      if (strcmp(val, "short") == 0) { */
+               /*              f->hive_fmt = REG_FMT_SHORT_HIVES; */
+               /*      } else if (strcmp(val, "long") == 0) { */
+               /*              f->hive_fmt = REG_FMT_LONG_HIVES; */
+               /*      } else if (strcmp(val, "preserve") == 0) { */
+               /*              f->hive_fmt = REG_FMT_PRESERVE_HIVES; */
+               /*      } else { */
+               /*              DEBUG(0, ("Invalid hive format: %s\n", val)); */
+               /*              ret = -1; */
+               /*      } */
+               /* } */
+       }
+       talloc_free(ctx);
+       return ret;
+}
+
+
+int reg_parse_line(struct reg_parse* parser, const char* line)
+{
+       const char* pos;
+       bool del=false;
+       cbuf* tmp=cbuf_clear(parser->tmp);
+       bool cb_ok = true;
+       bool cont = true;
+
+       if (!line) {
+               return -4;
+       }
+
+       parser->linenum++;
+       pos = line;
+
+       switch (parser->state) {
+       case STATE_VAL_HEX_CONT:
+               if (srprs_val_hex_values(&pos, parser->valblob, &cont)) {
+                       cb_ok = act_val_hex(parser, parser->valblob, cont);
+               }
+               goto done;
+       case STATE_VAL_SZ_CONT:
+               if (srprs_quoted_string(&pos, parser->valblob, &cont)) {
+                       cb_ok = act_val_sz(parser, parser->valblob, cont);
+               }
+               goto done;
+       default:
+               cont = false;
+       }
+
+       if ( !srprs_skipws(&pos) ) {
+               return -4;
+       }
+
+       /* empty line ?*/
+       if ( srprs_eol(&pos, NULL) ) {
+               return 0;
+       }
+
+       /* key line ?*/
+       else if (srprs_key(&pos, tmp, &del)) {
+               cb_ok = act_key(parser, tmp, del);
+       }
+
+       /* comment line ? */
+       else if (srprs_comment(&pos, tmp)) {
+               cb_ok = act_comment(parser, cbuf_gets(tmp, 0));
+       }
+
+       /* head line */
+       else if ((parser->linenum == 1) && srprs_line(&pos, tmp) ) {
+               /* cb_ok = act_head(parser, cbuf_gets(tmp, 0)); */
+       }
+
+       /* value line ?*/
+       else if (srprs_val_name(&pos, tmp)) {
+               uint32_t dw;
+               cbuf_swap(parser->valname, tmp);
+               cbuf_clear(tmp);
+
+               if (parser->state != STATE_KEY_OPEN) {
+                       DEBUG(0, ("value \"%s\" without a key at line: %i",
+                                 cbuf_gets(parser->valname, 0), parser->linenum));
+                       return -3;
+               }
+
+               if (!srprs_skipws(&pos)) {
+                       return -4;
+               }
+
+               if (srprs_char(&pos, '-')) {
+                       cb_ok = act_val_del(parser);
+               }
+               else if (srprs_val_dword(&pos, &parser->valtype, &dw)) {
+                       cb_ok = act_val_dw(parser, dw);
+               }
+               else if (srprs_val_sz(&pos, &parser->valtype, tmp, &cont)) {
+                       cb_ok = act_val_sz(parser, tmp, cont);
+               }
+               else if (srprs_val_hex(&pos, &parser->valtype, tmp, &cont)){
+                       cb_ok = act_val_hex(parser, tmp, cont);
+               }
+               else {
+                       DEBUG(0, ("value \"%s\" parse error"
+                                 "at line: %i pos: %li : %s",
+                                 cbuf_gets(parser->valname, 0), parser->linenum,
+                                 pos-line, pos));
+                       return -3;
+               }
+       }
+       else {
+               DEBUG(0, ("unrecognized line %i : %s\n", parser->linenum, line));
+               return -3;
+       }
+
+done:
+       if (!cb_ok)
+               return -2;
+
+       if (!srprs_skipws(&pos) || !srprs_eol(&pos, NULL)) {
+               DEBUG(0, ("trailing garbage at line: %i pos: %li : %s\n",
+                         parser->linenum, pos-line, pos));
+               return -1;
+       }
+       return 0;
+}
+
+/******************************************************************************/
+/**
+ * @addtogroup misc
+ * @{
+ */
+static bool lookslike_utf16(const char* line, size_t len, bool* little_endian)
+{
+       static const uint16_t M_LE = 0xFF80;
+       static const uint16_t M_BE = 0x80FF;
+       uint16_t mask;
+       bool le;
+
+       size_t l = MIN(len/2, 64);
+       uint16_t* u = (uint16_t*)line;
+       int i;
+
+       assert(len >= 2);
+
+       if ( u[0] & M_LE ) {
+               le = true;
+               mask = M_LE;
+       } else  if ( u[0] & M_BE ) {
+               le = false;
+               mask = M_BE;
+       } else {
+               return false;
+       }
+
+       for (i=1; i<l; i++) {
+               if ( u[i] & mask ) {
+                       return false;
+               }
+       }
+
+       *little_endian = le;
+       return true;
+}
+
+static bool lookslike_dos(const char* line, size_t len)
+{
+       int i;
+       for (i=0; i<len; i++) {
+               if ( (line[i] == '\0') || (line[i] & 0x80) ) {
+                       return false;
+               }
+               if ( (line[i] == '\r') && (i+1 < len) && (line[i+1] == '\n') ) {
+                       return true;
+               }
+       }
+       return false;
+}
+
+static bool guess_charset(const char** ptr,
+                         size_t* len,
+                         const char** file_enc,
+                         const char** str_enc)
+{
+       const char* charset = NULL;
+       const char* pos = *ptr;
+
+       if (*len < 4) {
+               return false;
+       }
+
+       if (srprs_bom(&pos, &charset, NULL)) {
+               *len -= (pos - *ptr);
+               *ptr = pos;
+               if (*file_enc == NULL) {
+                       *file_enc = charset;
+               }
+               else if( strcmp(*file_enc, charset) != 0 ) {
+                       DEBUG(0, ("file encoding forced to %s\n",
+                                 *file_enc));
+               }
+       }
+       else if (*file_enc == NULL) {
+               bool le;
+               if (lookslike_utf16(*ptr, *len, &le)) {
+                       *file_enc = le ? "UTF-16LE" : "UTF-16BE";
+               }
+               else if (lookslike_dos(*ptr, *len)) {
+                       *file_enc = "dos";
+               }
+               else {
+                       *file_enc = "unix";
+               }
+       }
+
+       if ((str_enc != NULL) && (*str_enc == NULL)) {
+               *str_enc = ( strncmp(*ptr, "REGEDIT4", 8) == 0)
+                       ? *file_enc
+                       : "UTF-16LE";
+       }
+
+       return true;
+}
+/**@}*/
+
+struct reg_parse_fd_opt {
+       const char* file_enc;
+       const char* str_enc;
+       unsigned flags;
+       int fail_level;
+};
+
+static struct reg_parse_fd_opt
+reg_parse_fd_opt(void* mem_ctx, const char* options)
+{
+       struct reg_parse_fd_opt ret = {
+               .file_enc = NULL,
+               .str_enc  = NULL,
+               .flags    = 0,
+       };
+
+       void* ctx = talloc_new(mem_ctx);
+       char *key, *val;
+
+       if (options == NULL) {
+               goto done;
+       }
+
+       while (srprs_option(&options, ctx, &key, &val)) {
+               if (strcmp(key, "enc") == 0) {
+                       ret.file_enc = talloc_steal(mem_ctx, val);
+                       ret.str_enc  = ret.file_enc;
+               } else if (strcmp(key, "strenc") == 0) {
+                       ret.str_enc = talloc_steal(mem_ctx, val);
+               } else if (strcmp(key, "fileenc") == 0) {
+                       ret.file_enc = talloc_steal(mem_ctx, val);
+               } else if ((strcmp(key, "flags") == 0) && (val != NULL)) {
+                       char* end = NULL;
+                       if (val != NULL) {
+                               ret.flags = strtol(val, &end, 0);
+                       }
+                       if ((end==NULL) || (*end != '\0')) {
+                               DEBUG(0, ("Invalid format \"%s\": %s\n",
+                                         key, val ? val : "<NULL>"));
+                       }
+               } else if ((strcmp(key, "fail") == 0) && (val != NULL)) {
+                       char* end = NULL;
+                       if (val != NULL) {
+                               ret.fail_level = -strtol(val, &end, 0);
+                       }
+                       if ((end==NULL) || (*end != '\0')) {
+                               DEBUG(0, ("Invalid format \"%s\": %s\n",
+                                         key, val ? val : "<NULL>"));
+                       }
+               }
+       }
+done:
+       talloc_free(ctx);
+       return ret;
+}
+
+
+static void
+handle_iconv_errno(int err, const char* obuf, size_t linenum,
+                  smb_iconv_t cd, const char** iptr, size_t* ilen,
+                  char** optr, size_t *olen)
+{
+       const char *pos = obuf;
+       const char *ptr = obuf;
+       switch(err) {
+       case EINVAL:
+               /* DEBUG(0, ("Incomplete multibyte sequence\n")); */
+       case E2BIG:
+               return;
+       case EILSEQ:
+               break;
+       default:
+               assert(false);
+       }
+
+       **optr = '\0';
+       while (srprs_line(&ptr, NULL) && srprs_nl(&ptr, NULL)) {
+               pos = ptr;
+               linenum++;
+       }
+       if (pos == *optr) {
+               pos = MAX(obuf, *optr-60);
+       }
+       DEBUG(0, ("Illegal multibyte sequence at line %lu: %s", linenum+1, pos));
+
+       assert(ilen > 0);
+       do {
+               size_t il = 1;
+               DEBUGADD(0, ("<%02x>", (unsigned char)**iptr));
+
+               if (olen > 0) {
+                       *(*optr)++ = '\?';
+                       (*iptr)++;
+                       /* Todo: parametrize, e.g. skip: *optr++ = *iptr++; */
+                       (*ilen)--;
+               }
+
+               if (smb_iconv(cd, iptr, &il, optr, olen) != (size_t)-1 || (errno != EILSEQ)) {
+                       if(il == 0)
+                               (*ilen)-- ;
+                       break;
+               }
+
+       }
+       while ((*ilen > 0) && (*olen > 0));
+
+       DEBUGADD(0, ("\n"));
+
+}
+
+int reg_parse_fd(int fd, const struct reg_parse_callback* cb, const char* opts)
+{
+       void* mem_ctx            = talloc_stackframe();
+       cbuf* line               = cbuf_new(mem_ctx);
+       smb_iconv_t cd           = (smb_iconv_t)-1;
+       struct reg_parse* parser = NULL;
+       char buf_raw[1024];
+       char buf_unix[1025];
+
+       ssize_t nread;
+       size_t  nconv;
+       const char* pos;
+       const char* iptr;
+       char* optr;
+        size_t ilen;
+       size_t olen;
+       int ret = -1;
+       bool eof = false;
+       size_t linenum = 0;
+
+       struct reg_parse_fd_opt opt = reg_parse_fd_opt(mem_ctx, opts);
+
+       if (cb == NULL) {
+               DEBUG(0,("reg_parse_fd: NULL callback\n"));
+               goto done;
+       }
+
+       nread = read(fd, buf_raw, sizeof(buf_raw));
+       if (nread < 0) {
+               DEBUG(0, ("reg_parse_fd: read failed: %s\n", strerror(errno)));
+               ret = nread;
+               goto done;
+       }
+
+       iptr = &buf_raw[0];
+       ilen = nread;
+
+       if (!guess_charset(&iptr, &ilen,
+                          &opt.file_enc, &opt.str_enc))
+       {
+               DEBUG(0, ("reg_parse_fd: failed to guess encoding\n"));
+               goto done;
+       }
+
+       DEBUG(0, ("reg_parse_fd: encoding file: %s str: %s\n",
+                 opt.file_enc, opt.str_enc));
+
+
+       if (!set_iconv(&cd, "unix", opt.file_enc)) {
+               DEBUG(0, ("reg_parse_fd: failed to set file encoding %s\n",
+                         opt.file_enc));
+               goto done;
+       }
+
+       parser = reg_parse_new(mem_ctx, *cb, opt.str_enc, opt.flags);
+
+       optr = &buf_unix[0];
+       while (!eof) {
+               olen = sizeof(buf_unix) - (optr - buf_unix) - 1 ;
+               while ( olen > 0 ) {
+                       memmove(buf_raw, iptr, ilen);
+
+                       nread = read(fd, buf_raw + ilen, sizeof(buf_raw) - ilen);
+                       if (nread < 0) {
+                               DEBUG(0, ("reg_parse_fd: read failed: %s\n", strerror(errno)));
+                               ret = nread;
+                               goto done;
+                       }
+
+                       iptr =  buf_raw;
+                       ilen += nread;
+
+                       if (ilen == 0) {
+                               smb_iconv(cd, NULL, NULL, &optr, &olen);
+                               eof = true;
+                               break;
+                       }
+
+                       nconv = smb_iconv(cd, &iptr, &ilen, &optr, &olen);
+
+                       if (nconv == (size_t)-1) {
+                               handle_iconv_errno(errno, buf_unix, linenum,
+                                                  cd, &iptr, &ilen,
+                                                  &optr, &olen);
+                               break;
+                       }
+               }
+       /* process_lines: */
+               *optr = '\0';
+               pos = &buf_unix[0];
+
+               while ( srprs_line(&pos, line) && srprs_nl_no_eos(&pos, line, eof)) {
+                       linenum ++;
+                       ret = reg_parse_line(parser, cbuf_gets(line, 0));
+                       if (ret < opt.fail_level) {
+                               goto done;
+                       }
+                       cbuf_clear(line);
+               }
+               memmove(buf_unix, pos, optr - pos);
+               optr -= (pos - buf_unix);
+       }
+
+       ret = 0;
+done:
+       set_iconv(&cd, NULL, NULL);
+       talloc_free(mem_ctx);
+       return ret;
+}
+
+int reg_parse_file(const char* fname, const struct reg_parse_callback* cb,
+                  const char* opt)
+{
+       int ret = -1;
+       int fd;
+
+       fd = open(fname, O_RDONLY);
+       if (fd < 0) {
+               DEBUG(0, ("reg_parse_file: open failed: %s\n", strerror(errno)));
+               return -1;
+       }
+
+       ret = reg_parse_fd(fd, cb, opt);
+
+       close(fd);
+       return ret;
+}
+
+/* static struct registry_key *find_regkey_by_hnd(pipes_struct *p, */
+/*                                            struct policy_handle *hnd) */
+/* { */
+/*     struct registry_key *regkey = NULL; */
+
+/*     if(!find_policy_by_hnd(p,hnd,(void **)(void *)&regkey)) { */
+/*             DEBUG(2,("find_regkey_index_by_hnd: Registry Key not found: ")); */
+/*             return NULL; */
+/*     } */
+
+/*     return regkey; */
+/* } */
diff --git a/source3/registry/reg_parse.h b/source3/registry/reg_parse.h
new file mode 100644 (file)
index 0000000..0694225
--- /dev/null
@@ -0,0 +1,190 @@
+/*
+ * Samba Unix/Linux SMB client library
+ *
+ * Copyright (C) Gregor Beck 2010
+ *
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @brief  Parser for registration entries (.reg) files.
+ * A parser is a talloced incarnation of an opaque struct reg_parse.
+ * It is fed with the (.reg) file line by line calling @ref reg_parse_line
+ * and emits output by calling functions from its reg_parse_callback.
+ * @file   reg_parse.h
+ * @author Gregor Beck <gb@sernet.de>
+ * @date   Jun 2010
+ */
+
+#ifndef REG_PARSE_H
+#define REG_PARSE_H
+
+#include <stdint.h>
+#include <stdbool.h>
+
+/**
+ * Protoype for function called on key found.
+ * The usual action to take is delete the key if del==true, open it if
+ * already existing or create a new one.
+ *
+ * @param private_data
+ * @param key
+ * @param klen number of elements in key
+ * @param del whether to delete the key
+ *
+ * @retval >=0 on success
+ *
+ * @see reg_format_key
+ */
+typedef int (*reg_parse_callback_key_t) (void* private_data,
+                                        const char* key[],
+                                        size_t klen,
+                                        bool del);
+
+/**
+ * Protoype for function called on value found.
+ * The usual action to take is set the value of the last opened key.
+ *
+ * @param private_data
+ * @param name the values name
+ * @param type the values type
+ * @param data the values value
+ * @param len  the number of bytes of data
+ *
+ * @retval >=0 on success
+ *
+ * @see reg_format_value
+ */
+typedef int (*reg_parse_callback_val_t) (void*  private_data,
+                                        const char* name,
+                                        uint32_t type,
+                                        const uint8_t* data,
+                                        uint32_t len);
+
+/**
+ * Protoype for function called on value delete found.
+ * Delete value from the last opened key. It is usually no error if
+ * no such value exist.
+ *
+ * @param private_data
+ * @param name
+ *
+ * @retval >=0 on success
+ *
+ * @see reg_format_value_delete
+ */
+typedef int (*reg_parse_callback_val_del_t) (void* private_data,
+                                            const char* name);
+
+
+/**
+ * Protoype for function called on comment found.
+ *
+ * @param private_data
+ * @param line comment with marker removed.
+ *
+ * @retval  >=0 on success
+ *
+ * @see reg_format_comment
+ */
+typedef int (*reg_parse_callback_comment_t) (void* private_data,
+                                            const char* line);
+
+/**
+ * Type handling the output of a reg_parse object.
+ * It containes the functions to call and an opaque data pointer.
+ */
+typedef struct reg_parse_callback {
+       reg_parse_callback_key_t key; /**< Function called on key found */
+       reg_parse_callback_val_t val; /**< Function called on value found */
+        /** Function called on value delete found */
+       reg_parse_callback_val_del_t val_del;
+       /** Function called on comment found */
+       reg_parse_callback_comment_t comment;
+       void* data; /**< Private data passed to callback function */
+} reg_parse_callback;
+
+/**
+ * A Parser for a registration entries (.reg) file.
+ *
+ * It may be used as a reg_format_callback, so the following is valid:
+ * @code
+ * reg_format* f = reg_format_new(mem_ctx,
+ *                                (reg_format_callback)reg_parse_new(mem_ctx, cb, NULL, 0),
+ *                                NULL, 0, "\\");
+ * @endcode
+ * @see reg_format
+ */
+typedef struct reg_parse reg_parse;
+
+/**
+ * Create a new reg_parse object.
+ *
+ * @param talloc_ctx the talloc parent
+ * @param cb         the output handler
+ * @param str_enc    the charset of hex encoded strings (REG_MULTI_SZ, REG_EXAND_SZ) if not UTF-16
+ * @param flags
+ *
+ * @return a talloc'ed reg_parse object, NULL on error
+ */
+reg_parse* reg_parse_new(const void* talloc_ctx,
+                        reg_parse_callback cb,
+                        const char* str_enc,
+                        unsigned flags);
+
+/**
+ * Feed one line to the parser.
+ *
+ * @param parser
+ * @param line one line from a (.reg) file, in UNIX charset
+ *
+ * @return 0 on success
+ *
+ * @see reg_format_callback_writeline_t
+ */
+int reg_parse_line(struct reg_parse* parser, const char* line);
+
+
+/**
+ * Parse a (.reg) file, read from a file descriptor.
+ *
+ * @param fd the file descriptor
+ * @param cb the output handler
+ * @param opts
+ *
+ * @return 0 on success
+ */
+int reg_parse_fd(int fd,
+                const reg_parse_callback* cb,
+                const char* opts);
+
+/**
+ * Parse a (.reg) file
+ *
+ * @param filename the file to open
+ * @param cb the output handler
+ * @param opts
+ *
+ * @return 0 on success
+ */
+int reg_parse_file(const char* filename,
+                  const reg_parse_callback* cb,
+                  const char* opts);
+
+int reg_parse_set_options(reg_parse* parser, const char* opt);
+
+/******************************************************************************/
+
+
+#endif /* REG_PARSE_H */
diff --git a/source3/registry/reg_parse_dox.cfg b/source3/registry/reg_parse_dox.cfg
new file mode 100644 (file)
index 0000000..06448cf
--- /dev/null
@@ -0,0 +1,1562 @@
+# Doxyfile 1.6.3
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+#       TAG = value [value, ...]
+# For lists items can also be appended using:
+#       TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING      = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME           = Registry Import / Export
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER         =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY       =
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS         = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+
+OUTPUT_LANGUAGE        = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC      = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF           = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF       =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC    = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB  = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES        = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH        =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH    =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES            = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF      = YES
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF           = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS           = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES  = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE               = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES                =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C  = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA   = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN   = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL   = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it parses.
+# With this tag you can assign which parser to use for a given extension.
+# Doxygen has a built-in mapping, but you can override or extend it using this tag.
+# The format is ext=language, where ext is a file extension, and language is one of
+# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
+# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
+# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
+# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+
+EXTENSION_MAPPING      =
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT    = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT        = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT            = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen to replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT   = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC   = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING            = YES
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT   = NO
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penality.
+# If the system has enough physical memory increasing the cache will improve the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will rougly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols
+
+SYMBOL_CACHE_SIZE      = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL            = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE        = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC         = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES  = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS  = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespace are hidden.
+
+EXTRACT_ANON_NSPACES   = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS     = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES     = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS  = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS      = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS          = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES       = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES       = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES     = YES
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
+# will list include files with double quotes in the documentation
+# rather than with sharp brackets.
+
+FORCE_LOCAL_INCLUDES   = NO
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO            = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS       = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS        = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES       = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME     = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST      = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST      = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST       = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS       =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES  = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES        = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES       = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES             = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page.
+# This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES        = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER    =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
+# doxygen. The layout file controls the global structure of the generated output files
+# in an output format independent way. The create the layout file that represents
+# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
+# file name after the option, if omitted DoxygenLayout.xml will be used as the name
+# of the layout file.
+
+LAYOUT_FILE            =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET                  = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS               = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED   = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR      = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC       = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT            = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE           =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = reg_parse.c reg_parse.h \
+       reg_import.c reg_import.h \
+       reg_format.c reg_format.h \
+       reg_parse_internal.c reg_parse_internal.h \
+       net_registry.c net_rpc_registry.c \
+       cbuf.c cbuf.h \
+       srprs.c srprs.h
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING         = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+
+FILE_PATTERNS          =
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE              = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+EXCLUDE                =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS       = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS       =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS        =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH           =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS       =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE      = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH             =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output.
+# If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER           =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis.
+# Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match.
+# The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
+
+FILTER_PATTERNS        =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES    = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER         = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES         = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS    = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION    = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code.
+# Otherwise they will link to the documentation.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS              = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS       = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX     = NO
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX    = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX          =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML          = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT            = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION    = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER            =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER            =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET        =
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting
+# this to NO can help when comparing the output of multiple runs.
+
+HTML_TIMESTAMP         = YES
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS     = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded. For this to work a browser that supports
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS  = NO
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
+
+GENERATE_DOCSET        = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product suite)
+# can be grouped.
+
+DOCSET_FEEDNAME        = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID       = org.doxygen.Project
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP      = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE               =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION           =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI           = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING     =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC             = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND             = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
+# are set, an additional index file will be generated that can be used as input for
+# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
+# HTML documentation.
+
+GENERATE_QHP           = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
+# be used to specify the file name of the resulting .qch file.
+# The path specified is relative to the HTML output folder.
+
+QCH_FILE               =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#namespace
+
+QHP_NAMESPACE          = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+
+QHP_VIRTUAL_FOLDER     = doc
+
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
+# For more information please see
+# http://doc.trolltech.com/qthelpproject.html#custom-filters
+
+QHP_CUST_FILTER_NAME   =
+
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS  =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
+
+QHP_SECT_FILTER_ATTRS  =
+
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
+# be used to specify the location of Qt's qhelpgenerator.
+# If non-empty doxygen will try to run qhelpgenerator on the generated
+# .qhp file.
+
+QHG_LOCATION           =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+#  will be generated, which together with the HTML files, form an Eclipse help
+#  plugin. To install this plugin and make it available under the help contents
+# menu in Eclipse, the contents of the directory containing the HTML and XML
+# files needs to be copied into the plugins directory of eclipse. The name of
+# the directory within the plugins directory should be the same as
+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.
+
+GENERATE_ECLIPSEHELP   = NO
+
+# A unique identifier for the eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have
+# this name.
+
+ECLIPSE_DOC_ID         = org.doxygen.Project
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX          = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE   = 4
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to YES, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
+# Windows users are probably better off using the HTML help feature.
+
+GENERATE_TREEVIEW      = NO
+
+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list.
+
+USE_INLINE_TREES       = NO
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH         = 250
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE       = 10
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
+# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
+# typically be disabled. For large projects the javascript based search engine
+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+
+SEARCHENGINE           = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
+# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
+# and does not have live searching capabilities.
+
+SERVER_BASED_SEARCH    = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX         = YES
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT           = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
+
+LATEX_CMD_NAME         = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME     = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX          = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE             = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES         =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER           =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS         = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX           = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE        = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES     = NO
+
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
+
+LATEX_SOURCE_CODE      = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF           = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT             = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF            = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS         = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE    =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE    =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN           = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT             = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION          = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS              = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML           = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT             = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA             =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD                =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING     = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF   = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD       = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX          = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader.
+# This is useful
+# if you want to understand what is going on.
+# On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY         = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING   = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION        = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF     = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES        = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH           =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS  =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED             =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED      =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse
+# the parser if not removed.
+
+SKIP_FUNCTION_MACROS   = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+#
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+#
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES               =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE       =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS           = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS        = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH              = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option is superseded by the HAVE_DOT option below. This is only a
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
+
+CLASS_DIAGRAMS         = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH            =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS   = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT               = NO
+
+# By default doxygen will write a font called FreeSans.ttf to the output
+# directory and reference it in all dot files that doxygen generates. This
+# font does not include all possible unicode characters however, so when you need
+# these (or just want a differently looking font) you can specify the font name
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
+# which can be done by putting it in a standard location or by setting the
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
+# containing the font.
+
+DOT_FONTNAME           = FreeSans
+
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
+# The default size is 10pt.
+
+DOT_FONTSIZE           = 10
+
+# By default doxygen will tell dot to use the output directory to look for the
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a
+# different font using DOT_FONTNAME you can set the path where dot
+# can find it using this tag.
+
+DOT_FONTPATH           =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH            = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH    = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS           = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK               = NO
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS     = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH          = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH      = YES
+
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
+
+CALL_GRAPH             = NO
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH           = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY    = YES
+
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH        = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT       = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH               =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS           =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES    = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH    = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not
+# seem to support this out of the box. Warning: Depending on the platform used,
+# enabling this option may lead to badly anti-aliased labels on the edges of
+# a graph (i.e. they become hard to read).
+
+DOT_TRANSPARENT        = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS      = YES
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND        = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP            = YES
+
+# Local Variables:
+# mode: makefile
+# compile-command: "doxygen reg_parse_dox.cfg"
+# End:
diff --git a/source3/registry/reg_parse_internal.c b/source3/registry/reg_parse_internal.c
new file mode 100644 (file)
index 0000000..995bc96
--- /dev/null
@@ -0,0 +1,346 @@
+/* * Samba Unix/Linux SMB client library
+ *
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+/**
+ * @file   reg_parse_internal.h
+ * @author Gregor Beck <gb@sernet.de>
+ * @date   Sep 2010
+ * @brief
+ */
+
+#include "reg_parse_internal.h"
+#include "cbuf.h"
+#include "srprs.h"
+#include "registry.h"
+
+size_t iconvert_talloc(const void* ctx,
+                      smb_iconv_t cd,
+                      const char* src, size_t srclen,
+                      char** pdst)
+{
+       size_t dstlen, ret;
+       size_t obytes, ibytes;
+       char *optr, *dst, *tmp;
+       const char* iptr;
+
+       if (cd == NULL || cd == ((smb_iconv_t)-1)) {
+               return -1;
+       }
+
+       dst = *pdst;
+
+       if (dst == NULL) {
+               /* dstlen = 2*srclen + 2; */
+               dstlen = srclen;
+               dst = talloc_size(ctx, dstlen);
+               if (dst == NULL) {
+                       DEBUG(0,("iconver_talloc no mem\n"));
+                       return -1;
+               }
+       } else {
+               dstlen = talloc_get_size(dst);
+       }
+convert:
+       iptr   = src;
+       ibytes = srclen;
+       optr   = dst;
+       obytes = dstlen-2;
+
+       ret = smb_iconv(cd, &iptr, &ibytes, &optr, &obytes);
+
+       if(ret == -1) {
+               const char *reason="unknown error";
+               switch(errno) {
+               case EINVAL:
+                       reason="Incomplete multibyte sequence";
+                       break;
+               case E2BIG:
+                       dstlen = 2*dstlen + 2;
+                       tmp    = talloc_realloc(ctx, dst, char, dstlen);
+                       if (tmp == NULL) {
+                               reason="talloc_realloc failed";
+                               break;
+                       }
+                       dst = tmp;
+                       goto convert;
+               case EILSEQ:
+                       reason="Illegal multibyte sequence";
+                       break;
+               }
+               DEBUG(0,("Conversion error: %s(%.80s) %li\n", reason, iptr, iptr-src));
+               talloc_free(dst);
+               return -1;
+       }
+
+       dstlen = (dstlen-2) - obytes;
+
+       SSVAL(dst, dstlen, 0);
+
+       *pdst = dst;
+       return dstlen;
+}
+
+#ifndef HKEY_CURRENT_CONFIG
+#define HKEY_CURRENT_CONFIG            0x80000005
+#endif
+#ifndef HKEY_DYN_DATA
+#define HKEY_DYN_DATA                  0x80000006
+#endif
+#ifndef HKEY_PERFORMANCE_TEXT
+#define HKEY_PERFORMANCE_TEXT          0x80000050
+#endif
+#ifndef HKEY_PERFORMANCE_NLSTEXT
+#define HKEY_PERFORMANCE_NLSTEXT       0x80000060
+#endif
+
+#define HIVE_INFO_ENTRY(SHORT,LONG)                    \
+static const struct hive_info HIVE_INFO_##SHORT = {    \
+       .handle = LONG,                                 \
+       .short_name = #SHORT,                           \
+       .short_name_len = sizeof(#SHORT)-1,             \
+       .long_name = #LONG,                             \
+       .long_name_len = sizeof(#LONG)-1,               \
+}
+
+HIVE_INFO_ENTRY(HKLM, HKEY_LOCAL_MACHINE);
+HIVE_INFO_ENTRY(HKCU, HKEY_CURRENT_USER);
+HIVE_INFO_ENTRY(HKCR, HKEY_CLASSES_ROOT);
+HIVE_INFO_ENTRY(HKU , HKEY_USERS);
+HIVE_INFO_ENTRY(HKCC, HKEY_CURRENT_CONFIG);
+HIVE_INFO_ENTRY(HKDD, HKEY_DYN_DATA);
+HIVE_INFO_ENTRY(HKPD, HKEY_PERFORMANCE_DATA);
+HIVE_INFO_ENTRY(HKPT, HKEY_PERFORMANCE_TEXT);
+HIVE_INFO_ENTRY(HKPN, HKEY_PERFORMANCE_NLSTEXT);
+#undef HIVE_INFO_ENTRY
+
+static const struct hive_info* HIVE_INFO[] = {
+       &HIVE_INFO_HKLM, &HIVE_INFO_HKCU, &HIVE_INFO_HKCR, &HIVE_INFO_HKU,
+       &HIVE_INFO_HKCC, &HIVE_INFO_HKDD, &HIVE_INFO_HKPD, &HIVE_INFO_HKPT,
+       &HIVE_INFO_HKPN, NULL
+};
+
+const struct hive_info* hive_info(const char* name, int nlen)
+{
+       const struct hive_info** info;
+       char buf[32];
+       int s;
+
+       if (nlen >= sizeof(buf)) {
+               return NULL;
+       }
+       for (s=0; s<nlen; s++) {
+               buf[s] = toupper(name[s]);
+       }
+       buf[s] = '\0';
+
+       if ((s < 3) || (strncmp(buf, "HK", 2) != 0)) {
+               return NULL;
+       }
+
+       if (s <= 4) {
+               for(info = HIVE_INFO; *info; info++) {
+                       if (strcmp(buf+2, (*info)->short_name+2) == 0) {
+                               return *info;
+                       }
+               }
+               return NULL;
+       }
+
+       if ((s < 10) || (strncmp(buf, "HKEY_", 5)) != 0) {
+               return NULL;
+       }
+
+       for(info = HIVE_INFO; *info; info++) {
+               if (strcmp(buf+5, (*info)->long_name+5) == 0) {
+                       return *info;
+               }
+       }
+       return NULL;
+}
+
+const char* get_charset(const char* c)
+{
+       if (strcmp(c, "dos") == 0) {
+               return lp_dos_charset();
+       } else if (strcmp(c, "unix") == 0) {
+               return lp_unix_charset();
+       } else {
+               return c;
+       }
+}
+
+bool set_iconv(smb_iconv_t* t, const char* to, const char* from)
+{
+       smb_iconv_t cd = (smb_iconv_t)-1;
+
+       if (to && from) {
+               to   = get_charset(to);
+               from = get_charset(from);
+               cd   = smb_iconv_open(to, from);
+               if (cd == ((smb_iconv_t)-1)) {
+                       return false;
+               }
+       }
+       if ((*t != (smb_iconv_t)NULL) && (*t != (smb_iconv_t)-1)) {
+               smb_iconv_close(*t);
+       }
+       *t = cd;
+       return true;
+}
+
+/**
+ * Parse option string
+ * @param[in,out] ptr parse position
+ * @param[in] mem_ctx talloc context
+ * @param[out] name ptr 2 value
+ * @param[out] value ptr 2 value
+ * @return true on success
+ */
+bool srprs_option(const char** ptr, const void* mem_ctx, char** name, char** value)
+{
+       const char* pos = *ptr;
+       void* ctx = talloc_new(mem_ctx);
+
+       cbuf* key = cbuf_new(ctx);
+       cbuf* val = NULL;
+
+       while(srprs_charsetinv(&pos, ",= \t\n\r", key))
+               ;
+       if (pos == *ptr) {
+               talloc_free(ctx);
+               return false;
+       }
+
+       if (name != NULL) {
+               *name = talloc_steal(mem_ctx, cbuf_gets(key, 0));
+       }
+
+       if (*pos == '=') {
+               val = cbuf_new(ctx);
+               pos++;
+               if (!srprs_quoted_string(ptr, val, NULL)) {
+                       while(srprs_charsetinv(&pos, ", \t\n\r", val))
+                               ;
+               }
+               if (value != NULL) {
+                       *value = talloc_steal(mem_ctx, cbuf_gets(val, 0));
+               }
+       } else {
+               if (value != NULL) {
+                       *value = NULL;
+               }
+       }
+
+       while(srprs_char(&pos, ','))
+               ;
+
+       *ptr = pos;
+       return true;
+}
+
+#define CH_INVALID ((charset_t)-1)
+static const struct {
+       const char* const name;
+       charset_t ctype;
+       int  len;
+       char seq[4];
+} BOM[] = {
+       {"UTF-8",    CH_UTF8,    3, {0xEF, 0xBB, 0xBF}},
+       {"UTF-32LE", CH_INVALID, 4, {0xFF, 0xFE, 0x00, 0x00}},
+       {"UTF-16LE", CH_UTF16LE, 2, {0xFF, 0xFE}},
+       {"UTF-16BE", CH_UTF16BE, 2, {0xFE, 0xFF}},
+       {"UTF-32BE", CH_INVALID, 4, {0x00, 0x00, 0xFE, 0xFF}},
+       {NULL,       CH_INVALID, 0, {}}
+};
+
+bool srprs_bom(const char** ptr, const char** name, charset_t* ctype)
+{
+       int i;
+       for (i=0; BOM[i].name; i++) {
+               if (memcmp(*ptr, BOM[i].seq, BOM[i].len) == 0) {
+                       break;
+               }
+       }
+
+       if (BOM[i].name != NULL) {
+               DEBUG(0, ("Found Byte Order Mark for : %s\n", BOM[i].name));
+
+               if (name != NULL) {
+                       *name  = BOM[i].name;
+               }
+
+               if (ctype != NULL) {
+                       *ctype = BOM[i].ctype;
+               }
+
+               *ptr  += BOM[i].len;
+
+               return true;
+       }
+       return false;
+}
+
+int write_bom(FILE* file, const char* charset, charset_t ctype)
+{
+       int i;
+       if ( charset == NULL ) {
+               for (i=0; BOM[i].name; i++) {
+                       if (BOM[i].ctype == ctype) {
+                               return fwrite(BOM[i].seq, 1, BOM[i].len, file);
+                       }
+               }
+               DEBUG(0, ("No Byte Order Mark for charset_t: %u\n", (unsigned)ctype));
+       } else {
+               for (i=0; BOM[i].name; i++) {
+                       if (StrCaseCmp(BOM[i].name, charset) == 0) {
+                               return fwrite(BOM[i].seq, 1, BOM[i].len, file);
+                       }
+               }
+               DEBUG(0, ("No Byte Order Mark for charset_t: %s\n", charset));
+       }
+       return 0;
+}
+
+
+int cbuf_puts_case(cbuf* s, const char* str, size_t len, enum fmt_case fmt)
+{
+       size_t pos = cbuf_getpos(s);
+       int ret = cbuf_puts(s, str, len);
+       char* ptr = cbuf_gets(s,pos);
+
+       if (ret <= 0) {
+               return ret;
+       }
+
+       switch (fmt) {
+       case FMT_CASE_PRESERVE:
+               break;
+       case FMT_CASE_UPPER:
+               while(*ptr != '\0') {
+                       *ptr = toupper(*ptr);
+                       ptr++;
+               }
+               break;
+       case FMT_CASE_TITLE:
+               *ptr = toupper(*ptr);
+               ptr++;
+       case FMT_CASE_LOWER:
+               while(*ptr != '\0') {
+                       *ptr = tolower(*ptr);
+                       ptr++;
+               }
+       }
+       return ret;
+}
diff --git a/source3/registry/reg_parse_internal.h b/source3/registry/reg_parse_internal.h
new file mode 100644 (file)
index 0000000..56e2127
--- /dev/null
@@ -0,0 +1,102 @@
+/* Samba Unix/Linux SMB client library
+ *
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @brief  Some stuff used by reg_parse and reg_format.
+ * It might be usefull elsewehre but need some review of the interfaces.
+ * @file   reg_parse_internal.h
+ * @author Gregor Beck <gb@sernet.de>
+ * @date   Sep 2010
+ */
+#ifndef __REG_PARSE_INTERNAL_H
+#define __REG_PARSE_INTERNAL_H
+
+#include "includes.h"
+
+struct cbuf;
+
+#define USE_NATIVE_ICONV
+#ifdef USE_NATIVE_ICONV
+#  define smb_iconv_t     iconv_t
+#  define smb_iconv(CD, IPTR, ILEN, OPTR, OLEN) \
+       iconv(CD, (char**)(IPTR), ILEN, OPTR, OLEN)
+#  define smb_iconv_open  iconv_open
+#  define smb_iconv_close iconv_close
+#endif
+
+size_t iconvert_talloc(const void* ctx,
+                      smb_iconv_t cd,
+                      const char* src, size_t srclen,
+                      char** pdst);
+
+struct hive_info {
+       uint32_t handle;
+       const char* short_name;
+       size_t short_name_len;
+       const char* long_name;
+       size_t long_name_len;
+};
+
+const struct hive_info* hive_info(const char* name, int nlen);
+
+const char* get_charset(const char* c);
+
+bool set_iconv(smb_iconv_t* t, const char* to, const char* from);
+
+/**
+ * Parse option string
+ * @param[in,out] ptr parse position
+ * @param[in] mem_ctx talloc context
+ * @param[out] name ptr 2 value
+ * @param[out] value ptr 2 value
+ * @return true on success
+ */
+bool srprs_option(const char** ptr, const void* mem_ctx, char** name, char** value);
+
+/**
+ * Write Byte Order Mark for \p charset to file.
+ * If \c charset==NULL write BOM for \p ctype.
+ *
+ * @param[in] file file to write to
+ * @param[in] charset
+ * @param[in] ctype
+ *
+ * @return number of bytes written, -1 on error
+ * @todo write to cbuf
+ */
+int write_bom(FILE* file, const char* charset, charset_t ctype);
+
+/**
+ * Parse Byte Order Mark.
+ *
+ * @param[in,out] ptr parse position
+ * @param[out] name name of characterset
+ * @param[out] ctype charset_t
+ *
+ * @return true if found
+ * @ingroup parse bom
+ */
+bool srprs_bom(const char** ptr, const char** name, charset_t* ctype);
+
+enum fmt_case {
+       FMT_CASE_PRESERVE=0,
+       FMT_CASE_UPPER,
+       FMT_CASE_LOWER,
+       FMT_CASE_TITLE
+};
+int cbuf_puts_case(struct cbuf* s, const char* str, size_t len, enum fmt_case fmt);
+
+#endif /* __REG_PARSE_INTERNAL_H */