Hide dict and list internals from getdns.h

src/dict.c

@@ -32,7 +32,7 @@
 #include <stdio.h>
 #include <search.h>
 #include <string.h>
-#include <getdns/getdns.h>
+#include "dict.h"
 
 /* TODO: change this to make the walk safe for reentrant/multi-thread calls */
 struct getdns_list *walkresultlist;

src/dict.h

@@ -0,0 +1,62 @@
+/**
+ *
+ * /brief getdns contect management functions
+ *
+ * This is the meat of the API
+ * Originally taken from the getdns API description pseudo implementation.
+ *
+ */
+/* The MIT License (MIT)
+ * Copyright (c) 2013 Verisign, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+#ifndef _GETDNS_DICT_H_
+#define _GETDNS_DICT_H_
+
+#include <getdns/getdns.h>
+
+/**
+ * this structure represents a single item in a dictionary type
+ */
+struct getdns_dict_item {
+    char *key;
+    getdns_data_type dtype;
+    union {
+        struct getdns_list    *list;
+        struct getdns_dict    *dict;
+        int                   n;
+        struct getdns_bindata *bindata;
+    } data;
+};
+
+/**
+ * getdns dictionary data type
+ * Use helper functions getdns_dict_* to manipulate and iterate dictionaries
+ * dict is implemented using the t*() functions for manipulating binary search
+ * trees in the std library.  The internal implementation may change so the
+ * application should stick to the helper functions.
+ */
+struct getdns_dict {
+    void *rootp;
+};
+
+
+#endif
+

src/getdns/getdns.h

@@ -380,30 +380,11 @@ typedef struct getdns_bindata {
     uint8_t *data;
 } getdns_bindata;
 
-/**
- * this structure represents a single item in a dictionary type
- */
-struct getdns_dict_item {
-    char *key;
-    getdns_data_type dtype;
-    union {
-        struct getdns_list    *list;
-        struct getdns_dict    *dict;
-        int                   n;
-        struct getdns_bindata *bindata;
-    } data;
-};
-
 /**
  * getdns dictionary data type
  * Use helper functions getdns_dict_* to manipulate and iterate dictionaries
- * dict is implemented using the t*() functions for manipulating binary search
- * trees in the std library.  The internal implementation may change so the
- * application should stick to the helper functions.
  */
-typedef struct getdns_dict {
-    void *rootp;
-} getdns_dict;
+typedef struct getdns_dict getdns_dict;
 
 /**
  * translate an error code to a string value, not in the original api description
@@ -415,36 +396,13 @@ typedef struct getdns_dict {
  */
 getdns_return_t getdns_strerror(getdns_return_t err, char *buf, size_t buflen);
 
-#define GETDNS_LIST_BLOCKSZ 10
 
 /**
  * getdns list data type
  * Use helper functions getdns_list_* to manipulate and iterate lists
- * lists are implemented as arrays internally since the helper functions
- * like to reference indexes in the list.  Elements are allocated in blocks
- * and then marked valid as they are used and invalid as they are not used
- * The use cases do not justify working too hard at shrinking the structures.
  * Indexes are 0 based.
  */
-typedef struct getdns_list {
-    int numalloc;
-    int numinuse;
-    struct getdns_list_item *items;
-} getdns_list;
-
-/**
- * this structure represents a single item in a list
- */
-struct getdns_list_item {
-    int inuse;
-    getdns_data_type dtype;
-    union {
-        getdns_list    *list;
-        getdns_dict    *dict;
-        int            n;
-        getdns_bindata *bindata;
-    } data;
-};
+typedef struct getdns_list getdns_list;
 
 /**
  * get the length of the specified list (returned in *answer)

src/list.c

@@ -29,7 +29,7 @@
  */
 
 #include <string.h>
-#include <getdns/getdns.h>
+#include "list.h"
 
 /*---------------------------------------- getdns_list_get_length */
 getdns_return_t

src/list.h

@@ -0,0 +1,67 @@
+/**
+ *
+ * /brief getdns contect management functions
+ *
+ * This is the meat of the API
+ * Originally taken from the getdns API description pseudo implementation.
+ *
+ */
+/* The MIT License (MIT)
+ * Copyright (c) 2013 Verisign, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+#ifndef _GETDNS_LIST_H_
+#define _GETDNS_LIST_H_
+
+#include <getdns/getdns.h>
+
+#define GETDNS_LIST_BLOCKSZ 10
+
+/**
+ * this structure represents a single item in a list
+ */
+struct getdns_list_item {
+    int inuse;
+    getdns_data_type dtype;
+    union {
+        getdns_list    *list;
+        getdns_dict    *dict;
+        int            n;
+        getdns_bindata *bindata;
+    } data;
+};
+
+/**
+ * getdns list data type
+ * Use helper functions getdns_list_* to manipulate and iterate lists
+ * lists are implemented as arrays internally since the helper functions
+ * like to reference indexes in the list.  Elements are allocated in blocks
+ * and then marked valid as they are used and invalid as they are not used
+ * The use cases do not justify working too hard at shrinking the structures.
+ * Indexes are 0 based.
+ */
+typedef struct getdns_list {
+    int numalloc;
+    int numinuse;
+    struct getdns_list_item *items;
+} getdns_list;
+
+#endif
+