Resources: res_new() requires an active pool

[libucw.git] / ucw / conf.h

diff --git a/ucw/conf.h b/ucw/conf.h
index 53547daef20ef29fa0260afcc4afcc49ed66101d..50dbddc1712ea109b7c9fc24357e91a825d7b0e8 100644 (file)
--- a/ucw/conf.h
+++ b/ucw/conf.h
@@ -132,7 +132,7 @@ struct cf_section {                 /** A section. **/
  *     uns value;
  *   };
  *
- *   struct clist nodes;
+ *   static struct clist nodes;
  *
  *   static struct cf_section node = {
  *     CF_TYPE(struct list_node),
@@ -148,7 +148,7 @@ struct cf_section {                 /** A section. **/
  *     CF_END
  *   };
  *
- * You could use <<def_CF_STATIC,`def_CF_STATIC`>> or <<def_CF_DYNAMIC,`def_CF_DYNAMIC`>>
+ * You could use <<def_CF_STATIC,`CF_STATIC`>> or <<def_CF_DYNAMIC,`CF_DYNAMIC`>>
  * macros to create arrays.
  */
 #define CF_TYPE(s)     .size = sizeof(s)
@@ -215,17 +215,17 @@ struct cf_section {                       /** A section. **/
  * * @c -- count.
  **/
 #define CF_INT(n,p)            CF_STATIC(n,p,INT,int,1)                /** Single `int` value. **/
-#define CF_INT_ARY(n,p,c)      CF_STATIC(n,p,INT,int,c)                /** Static array of `int` s. **/
-#define CF_INT_DYN(n,p,c)      CF_DYNAMIC(n,p,INT,int,c)               /** Dynamic array of `int` s. **/
+#define CF_INT_ARY(n,p,c)      CF_STATIC(n,p,INT,int,c)                /** Static array of integers. **/
+#define CF_INT_DYN(n,p,c)      CF_DYNAMIC(n,p,INT,int,c)               /** Dynamic array of integers. **/
 #define CF_UNS(n,p)            CF_STATIC(n,p,INT,uns,1)                /** Single `uns` (`unsigned`) value. **/
-#define CF_UNS_ARY(n,p,c)      CF_STATIC(n,p,INT,uns,c)                /** Static array of `uns` es. **/
-#define CF_UNS_DYN(n,p,c)      CF_DYNAMIC(n,p,INT,uns,c)               /** Dynamic array of `uns` es. **/
+#define CF_UNS_ARY(n,p,c)      CF_STATIC(n,p,INT,uns,c)                /** Static array of unsigned integers. **/
+#define CF_UNS_DYN(n,p,c)      CF_DYNAMIC(n,p,INT,uns,c)               /** Dynamic array of unsigned integers. **/
 #define CF_U64(n,p)            CF_STATIC(n,p,U64,u64,1)                /** Single unsigned 64bit integer (`u64`). **/
-#define CF_U64_ARY(n,p,c)      CF_STATIC(n,p,U64,u64,c)                /** Static array of `u64` s. **/
-#define CF_U64_DYN(n,p,c)      CF_DYNAMIC(n,p,U64,u64,c)               /** Dynamic array of `u64` s. **/
+#define CF_U64_ARY(n,p,c)      CF_STATIC(n,p,U64,u64,c)                /** Static array of u64s. **/
+#define CF_U64_DYN(n,p,c)      CF_DYNAMIC(n,p,U64,u64,c)               /** Dynamic array of u64s. **/
 #define CF_DOUBLE(n,p)         CF_STATIC(n,p,DOUBLE,double,1)          /** Single instance of `double`. **/
-#define CF_DOUBLE_ARY(n,p,c)   CF_STATIC(n,p,DOUBLE,double,c)          /** Static array of `double` s. **/
-#define CF_DOUBLE_DYN(n,p,c)   CF_DYNAMIC(n,p,DOUBLE,double,c)         /** Dynamic array of `double` s. **/
+#define CF_DOUBLE_ARY(n,p,c)   CF_STATIC(n,p,DOUBLE,double,c)          /** Static array of doubles. **/
+#define CF_DOUBLE_DYN(n,p,c)   CF_DYNAMIC(n,p,DOUBLE,double,c)         /** Dynamic array of doubles. **/
 #define CF_IP(n,p)             CF_STATIC(n,p,IP,u32,1)                 /** Single IPv4 address. **/
 #define CF_IP_ARY(n,p,c)       CF_STATIC(n,p,IP,u32,c)                 /** Static array of IP addresses. **/.
 #define CF_IP_DYN(n,p,c)       CF_DYNAMIC(n,p,IP,u32,c)                /** Dynamic array of IP addresses. **/
@@ -310,8 +310,14 @@ struct cf_section {                        /** A section. **/
  * You should use these routines when implementing custom parsers.
  ***/
 struct mempool;
-extern struct mempool *cf_pool;        /** A <<mempool:type_mempool,memory pool>> for configuration parser needs. **/
-void *cf_malloc(uns size);     /** Returns @size bytes of memory. **/
+/**
+ * A <<mempool:type_mempool,memory pool>> for configuration parser needs.
+ * Memory allocated from here is valid as long as the current config is loaded
+ * (if you allocate some memory and rollback the transaction or you load some
+ * other configuration, it gets lost).
+ **/
+extern struct mempool *cf_pool;
+void *cf_malloc(uns size);     /** Returns @size bytes of memory. Allocates from <<var_cf_pool,`cf_pool`>>. **/
 void *cf_malloc_zero(uns size);        /** Like @cf_malloc(), but zeroes the memory. **/
 char *cf_strdup(const char *s);        /** Copy a string into @cf_malloc()ed memory. **/
 char *cf_printf(const char *fmt, ...) FORMAT_CHECK(printf,1,2); /** printf() into @cf_malloc()ed memory. **/
@@ -365,6 +371,8 @@ void cf_init_section(const char *name, struct cf_section *sec, void *ptr, uns do
  *
  * Each of them gets a string to parse and pointer to store the value.
  * It returns either NULL or error message.
+ *
+ * The parsers support units. See <<config:units,their list>>.
  ***/
 char *cf_parse_int(const char *str, int *ptr);         /** Parser for integers. **/
 char *cf_parse_u64(const char *str, u64 *ptr);         /** Parser for 64 unsigned integers. **/