toolkit: comparison ucx/cx/properties.h

-:ab3125bd8b5f
+:f421aef8f865
 #include "common.h"
 #include "string.h"
 #include "map.h"
 #include "buffer.h"
-#include <stdio.h>
-#include <string.h>
 #ifdef __cplusplus
 extern "C" {
 #endif
 /**
 char comment3;
 /*
 * The character, when appearing at the end of a line, continues that line.
 * This is '\' by default.
-*/
-/**
-* Reserved for future use.
 */
 char continuation;
 };
 /**
 /**
 * More internal buffer was needed, but could not be allocated.
 */
 CX_PROPERTIES_BUFFER_ALLOC_FAILED,
 /**
-* Initializing the properties source failed.
+* A file operation failed.
-*
+* Only for cxPropertiesLoad().
-* @see cx_properties_read_init_func
+* It is system-specific if errno is set.
 */
-CX_PROPERTIES_READ_INIT_FAILED,
+CX_PROPERTIES_FILE_ERROR,
 /**
-* Reading from a properties source failed.
+* A map operation failed.
-*
+* Only for cxPropertiesLoad().
-* @see cx_properties_read_func
+*/
-*/
+CX_PROPERTIES_MAP_ERROR,
-CX_PROPERTIES_READ_FAILED,
-/**
-* Sinking a k/v-pair failed.
-*
-* @see cx_properties_sink_func
-*/
-CX_PROPERTIES_SINK_FAILED,
 };
 /**
 * Typedef for the properties status enum.
 */
 /**
 * Typedef for the properties interface.
 */
 typedef struct cx_properties_s CxProperties;
-/**
-* Typedef for a properties sink.
-*/
-typedef struct cx_properties_sink_s CxPropertiesSink;
-/**
-* A function that consumes a k/v-pair in a sink.
-*
-* The sink could be a map, and the sink function would be calling
-* a map function to store the k/v-pair.
-*
-* @param prop the properties interface that wants to sink a k/v-pair
-* @param sink the sink
-* @param key the key
-* @param value the value
-* @retval zero success
-* @retval non-zero sinking the k/v-pair failed
-*/
-typedef int(*cx_properties_sink_func)(
-CxProperties *prop,
-CxPropertiesSink *sink,
-cxstring key,
-cxstring value
-);
-/**
-* Defines a sink for k/v-pairs.
-*/
-struct cx_properties_sink_s {
-/**
-* The sink object.
-*/
-void *sink;
-/**
-* Optional custom data.
-*/
-void *data;
-/**
-* A function for consuming k/v-pairs into the sink.
-*/
-cx_properties_sink_func sink_func;
-};
-/**
-* Typedef for a properties source.
-*/
-typedef struct cx_properties_source_s CxPropertiesSource;
-/**
-* A function that reads data from a source.
-*
-* When the source is depleted, implementations SHALL provide an empty
-* string in the @p target and return zero.
-* A non-zero return value is only permitted in case of an error.
-*
-* The meaning of the optional parameters is implementation-dependent.
-*
-* @param prop the properties interface that wants to read from the source
-* @param src the source
-* @param target a string buffer where the read data shall be stored
-* @retval zero success
-* @retval non-zero reading the data failed
-*/
-typedef int(*cx_properties_read_func)(
-CxProperties *prop,
-CxPropertiesSource *src,
-cxstring *target
-);
-/**
-* A function that may initialize additional memory for the source.
-*
-* @param prop the properties interface that wants to read from the source
-* @param src the source
-* @retval zero initialization was successful
-* @retval non-zero otherwise
-*/
-typedef int(*cx_properties_read_init_func)(
-CxProperties *prop,
-CxPropertiesSource *src
-);
-/**
-* A function that cleans memory initialized by the read_init_func.
-*
-* @param prop the properties interface that wants to read from the source
-* @param src the source
-*/
-typedef void(*cx_properties_read_clean_func)(
-CxProperties *prop,
-CxPropertiesSource *src
-);
-/**
-* Defines a properties source.
-*/
-struct cx_properties_source_s {
-/**
-* The source object.
-*
-* For example, a file stream or a string.
-*/
-void *src;
-/**
-* Optional additional data pointer.
-*/
-void *data_ptr;
-/**
-* Optional size information.
-*/
-size_t data_size;
-/**
-* A function that reads data from the source.
-*/
-cx_properties_read_func read_func;
-/**
-* Optional function that may prepare the source for reading data.
-*/
-cx_properties_read_init_func read_init_func;
-/**
-* Optional function that cleans additional memory allocated by the
-* read_init_func.
-*/
-cx_properties_read_clean_func read_clean_func;
-};
 /**
 * Initialize a properties interface.
 *
 * @param prop the properties interface
 */
 cx_attr_nonnull cx_attr_nodiscard
 CX_EXPORT CxPropertiesStatus cxPropertiesNext(CxProperties *prop, cxstring *key, cxstring *value);
 /**
-* Creates a properties sink for an UCX map.
+* The size of the stack memory that `cxPropertiesLoad()` will reserve with `cxPropertiesUseStack()`.
-*
+*/
-* The values stored in the map will be pointers to freshly allocated,
+CX_EXPORT extern const unsigned cx_properties_load_buf_size;
-* zero-terminated C strings (@c char*), which means the @p map should have been
-* created with #CX_STORE_POINTERS.
+/**
-*
+* The size of the stack memory that `cxPropertiesLoad()` will use to read contents from the file.
-* The cxDefaultAllocator will be used unless you specify a custom
+*/
-* allocator in the optional @c data field of the returned sink.
+CX_EXPORT extern const unsigned cx_properties_load_fill_size;
-*
-* @param map the map that shall consume the k/v-pairs.
+/**
-* @return the sink
+* Internal function - use cxPropertiesLoad() instead.
-* @see cxPropertiesLoad()
+*
-*/
+* @param config the parser config
-cx_attr_nonnull cx_attr_nodiscard
+* @param allocator the allocator for the values
-CX_EXPORT CxPropertiesSink cxPropertiesMapSink(CxMap *map);
+* @param filename the file name
+* @param target the target map
-/**
+* @return status code
-* Creates a properties source based on an UCX string.
+*/
-*
+cx_attr_nonnull_arg(4)
-* @param str the string
+CX_EXPORT CxPropertiesStatus cx_properties_load(CxPropertiesConfig config,
-* @return the properties source
+const CxAllocator *allocator, cxstring filename, CxMap *target);
-* @see cxPropertiesLoad()
-*/
+/**
-cx_attr_nodiscard
+* Loads properties from a file and inserts them into a map.
-CX_EXPORT CxPropertiesSource cxPropertiesStringSource(cxstring str);
+*
+* Entries are added to the map, possibly overwriting existing entries.
-/**
+*
-* Creates a properties source based on C string with the specified length.
+* The map must either store pointers of type @c char*, or elements of type cxmutstr.
-*
+* Any other configuration is not supported.
-* @param str the string
+*
-* @param len the length
+* @note When the parser finds an error, all successfully parsed keys before the error
-* @return the properties source
+* are added to the map nonetheless.
-* @see cxPropertiesLoad()
+*
-*/
+* @param config the parser config
-cx_attr_nonnull cx_attr_nodiscard cx_attr_access_r(1, 2)
+* @param allocator the allocator for the values that will be stored in the map
-CX_EXPORT CxPropertiesSource cxPropertiesCstrnSource(const char *str, size_t len);
+* @param filename (any string) the absolute or relative path to the file
+* @param target (@c CxMap*) the map where the properties shall be added
-/**
+* @retval CX_PROPERTIES_NO_ERROR (zero) at least one key/value pair was found
-* Creates a properties source based on a C string.
+* @retval CX_PROPERTIES_NO_DATA the file is syntactically OK, but does not contain properties
-*
+* @retval CX_PROPERTIES_INCOMPLETE_DATA unexpected end of file
-* The length will be determined with strlen(), so the string MUST be
-* zero-terminated.
-*
-* @param str the string
-* @return the properties source
-* @see cxPropertiesLoad()
-*/
-cx_attr_nonnull cx_attr_nodiscard cx_attr_cstr_arg(1)
-CX_EXPORT CxPropertiesSource cxPropertiesCstrSource(const char *str);
-/**
-* Creates a properties source based on an FILE.
-*
-* @param file the file
-* @param chunk_size how many bytes may be read in one operation
-*
-* @return the properties source
-* @see cxPropertiesLoad()
-*/
-cx_attr_nonnull cx_attr_nodiscard cx_attr_access_r(1)
-CX_EXPORT CxPropertiesSource cxPropertiesFileSource(FILE *file, size_t chunk_size);
-/**
-* Loads properties data from a source and transfers it to a sink.
-*
-* This function tries to read as much data from the source as possible.
-* When the source was completely consumed and at least on k/v-pair was found,
-* the return value will be #CX_PROPERTIES_NO_ERROR.
-* When the source was consumed but no k/v-pairs were found, the return value
-* will be #CX_PROPERTIES_NO_DATA.
-* In case the source data ends unexpectedly, the #CX_PROPERTIES_INCOMPLETE_DATA
-* is returned. In that case you should call this function again with the same
-* sink and either an updated source or the same source if the source is able to
-* yield the missing data.
-*
-* The other result codes apply, according to their description.
-*
-* @param prop the properties interface
-* @param sink the sink
-* @param source the source
-* @retval CX_PROPERTIES_NO_ERROR (zero) a key/value pair was found
-* @retval CX_PROPERTIES_READ_INIT_FAILED initializing the source failed
-* @retval CX_PROPERTIES_READ_FAILED reading from the source failed
-* @retval CX_PROPERTIES_SINK_FAILED sinking the properties into the sink failed
-* @retval CX_PROPERTIES_NO_DATA the source did not provide any key/value pairs
-* @retval CX_PROPERTIES_INCOMPLETE_DATA the source did not provide enough data
 * @retval CX_PROPERTIES_INVALID_EMPTY_KEY the properties data contains an illegal empty key
 * @retval CX_PROPERTIES_INVALID_MISSING_DELIMITER the properties data contains a line without delimiter
 * @retval CX_PROPERTIES_BUFFER_ALLOC_FAILED an internal allocation was necessary but failed
-*/
+* @retval CX_PROPERTIES_FILE_ERROR a file operation failed; depending on the system @c errno might be set
-cx_attr_nonnull
+* @retval CX_PROPERTIES_MAP_ERROR storing a key/value pair in the map failed
-CX_EXPORT CxPropertiesStatus cxPropertiesLoad(CxProperties *prop,
+* @see cxPropertiesLoadDefault()
-CxPropertiesSink sink, CxPropertiesSource source);
+*/
+#define cxPropertiesLoad(config, allocator, filename, target) \
+cx_properties_load(config, allocator, cx_strcast(filename), target)
+/**
+* Loads properties from a file and inserts them into a map with a default config.
+*
+* Entries are added to the map, possibly overwriting existing entries.
+*
+* The map must either store pointers of type @c char*, or elements of type cxmutstr.
+* Any other configuration is not supported.
+*
+* @note When the parser finds an error, all successfully parsed keys before the error
+* are added to the map nonetheless.
+*
+* @param allocator the allocator for the values that will be stored in the map
+* @param filename (any string) the absolute or relative path to the file
+* @param target (@c CxMap*) the map where the properties shall be added
+* @retval CX_PROPERTIES_NO_ERROR (zero) at least one key/value pair was found
+* @retval CX_PROPERTIES_NO_DATA the file is syntactically OK, but does not contain properties
+* @retval CX_PROPERTIES_INCOMPLETE_DATA unexpected end of file
+* @retval CX_PROPERTIES_INVALID_EMPTY_KEY the properties data contains an illegal empty key
+* @retval CX_PROPERTIES_INVALID_MISSING_DELIMITER the properties data contains a line without delimiter
+* @retval CX_PROPERTIES_BUFFER_ALLOC_FAILED an internal allocation was necessary but failed
+* @retval CX_PROPERTIES_FILE_ERROR a file operation failed; depending on the system @c errno might be set
+* @retval CX_PROPERTIES_MAP_ERROR storing a key/value pair in the map failed
+* @see cxPropertiesLoad()
+*/
+#define cxPropertiesLoadDefault(allocator, filename, target) \
+cx_properties_load(cx_properties_config_default, allocator, cx_strcast(filename), target)
 #ifdef __cplusplus
 } // extern "C"
 #endif

Mercurial > hg > toolkit / file comparison

comparison: ucx/cx/properties.h

ucx/cx/properties.h