toolkit: comparison ucx/cx/properties.h

-:118e2386d5b4
+:063a9f29098c
 * This is '=' by default.
 */
 char delimiter;
 /**
+* The first comment character.
+* This is '#' by default.
+*/
+char comment1;
+/**
+* The second comment character.
+* This is not set by default.
+*/
+char comment2;
+/**
+* The third comment character.
+* This is not set by default.
+*/
+char comment3;
+/*
 * The character, when appearing at the end of a line, continues that line.
 * This is '\' by default.
 */
-// char continuation; // TODO: line continuation in properties
+/**
+* Reserved for future use.
-/**
+*/
-* The first comment character.
+char continuation;
-* This is '#' by default.
-*/
-char comment1;
-/**
-* The second comment character.
-* This is not set by default.
-*/
-char comment2;
-/**
-* The third comment character.
-* This is not set by default.
-*/
-char comment3;
 };
 /**
 * Typedef for the properties config.
 */
 typedef struct cx_properties_config_s CxPropertiesConfig;
 /**
 * Default properties configuration.
 */
+cx_attr_export
 extern const CxPropertiesConfig cx_properties_config_default;
 /**
 * Status codes for the properties interface.
 */
 * @param prop the properties interface
 * @param config the properties configuration
 * @see cxPropertiesInitDefault()
 */
 cx_attr_nonnull
+cx_attr_export
 void cxPropertiesInit(CxProperties *prop, CxPropertiesConfig config);
 /**
 * Destroys the properties interface.
 *
 * add call to this function.
 *
 * @param prop the properties interface
 */
 cx_attr_nonnull
+cx_attr_export
 void cxPropertiesDestroy(CxProperties *prop);
 /**
 * Destroys and re-initializes the properties interface.
 *
 * @retval non-zero a memory allocation was necessary but failed
 * @see cxPropertiesFill()
 */
 cx_attr_nonnull
 cx_attr_access_r(2, 3)
+cx_attr_export
 int cxPropertiesFilln(
 CxProperties *prop,
 const char *buf,
 size_t len
 );
 * @param prop the properties interface
 * @param buf a pointer to stack memory
 * @param capacity the capacity of the stack memory
 */
 cx_attr_nonnull
+cx_attr_export
 void cxPropertiesUseStack(
 CxProperties *prop,
 char *buf,
 size_t capacity
 );
 * @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
 */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 CxPropertiesStatus cxPropertiesNext(
 CxProperties *prop,
 cxstring *key,
 cxstring *value
 );
 * @return the sink
 * @see cxPropertiesLoad()
 */
 cx_attr_nonnull
 cx_attr_nodiscard
+cx_attr_export
 CxPropertiesSink cxPropertiesMapSink(CxMap *map);
 /**
 * Creates a properties source based on an UCX string.
 *
 * @param str the string
 * @return the properties source
 * @see cxPropertiesLoad()
 */
 cx_attr_nodiscard
+cx_attr_export
 CxPropertiesSource cxPropertiesStringSource(cxstring str);
 /**
 * Creates a properties source based on C string with the specified length.
 *
 * @see cxPropertiesLoad()
 */
 cx_attr_nonnull
 cx_attr_nodiscard
 cx_attr_access_r(1, 2)
+cx_attr_export
 CxPropertiesSource cxPropertiesCstrnSource(const char *str, size_t len);
 /**
 * Creates a properties source based on a C string.
 *
 * @see cxPropertiesLoad()
 */
 cx_attr_nonnull
 cx_attr_nodiscard
 cx_attr_cstr_arg(1)
+cx_attr_export
 CxPropertiesSource cxPropertiesCstrSource(const char *str);
 /**
 * Creates a properties source based on an FILE.
 *
 * @see cxPropertiesLoad()
 */
 cx_attr_nonnull
 cx_attr_nodiscard
 cx_attr_access_r(1)
+cx_attr_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
 */
 cx_attr_nonnull
+cx_attr_export
 CxPropertiesStatus cxPropertiesLoad(
 CxProperties *prop,
 CxPropertiesSink sink,
 CxPropertiesSource source
 );

Mercurial > hg > toolkit / file comparison

comparison: ucx/cx/properties.h

ucx/cx/properties.h