idav: comparison ucx/cx/properties.h

-:c3f2f16fa4b8
+:dde28a806552
 typedef struct cx_properties_config_s CxPropertiesConfig;
 /**
 * Default properties configuration.
 */
-cx_attr_export
+CX_EXPORT extern const CxPropertiesConfig cx_properties_config_default;
-extern const CxPropertiesConfig cx_properties_config_default;
 /**
 * Status codes for the properties interface.
 */
 enum cx_properties_status {
 * @param key the key
 * @param value the value
 * @retval zero success
 * @retval non-zero sinking the k/v-pair failed
 */
-cx_attr_nonnull
 typedef int(*cx_properties_sink_func)(
 CxProperties *prop,
 CxPropertiesSink *sink,
 cxstring key,
 cxstring value
 * @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
 */
-cx_attr_nonnull
 typedef int(*cx_properties_read_func)(
 CxProperties *prop,
 CxPropertiesSource *src,
 cxstring *target
 );
 * @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
 */
-cx_attr_nonnull
 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
 */
-cx_attr_nonnull
 typedef void(*cx_properties_read_clean_func)(
 CxProperties *prop,
 CxPropertiesSource *src
 );
 * @param prop the properties interface
 * @param config the properties configuration
 * @see cxPropertiesInitDefault()
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT void cxPropertiesInit(CxProperties *prop, CxPropertiesConfig config);
-void cxPropertiesInit(CxProperties *prop, CxPropertiesConfig config);
 /**
 * Destroys the properties interface.
 *
 * @note Even when you are certain that you did not use the interface in a
 * add a call to this function.
 *
 * @param prop the properties interface
 */
 cx_attr_nonnull
-cx_attr_export
+CX_EXPORT void cxPropertiesDestroy(CxProperties *prop);
-void cxPropertiesDestroy(CxProperties *prop);
 /**
 * Destroys and re-initializes the properties interface.
 *
 * You might want to use this to reset the parser after
 * encountering a syntax error.
 *
 * @param prop the properties interface
 */
 cx_attr_nonnull
-static inline void cxPropertiesReset(CxProperties *prop) {
+CX_EXPORT void cxPropertiesReset(CxProperties *prop);
-CxPropertiesConfig config = prop->config;
-cxPropertiesDestroy(prop);
-cxPropertiesInit(prop, config);
-}
 /**
 * Initialize a properties parser with the default configuration.
 *
 * @param prop (@c CxProperties*) the properties interface
 * @see cxPropertiesInit()
 */
 #define cxPropertiesInitDefault(prop) \
 cxPropertiesInit(prop, cx_properties_config_default)
 /**
 * Fills the input buffer with data.
 *
 * After calling this function, you can parse the data by calling
 * @param len the length of the data
 * @retval zero success
 * @retval non-zero a memory allocation was necessary but failed
 * @see cxPropertiesFill()
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_access_r(2, 3)
-cx_attr_access_r(2, 3)
+CX_EXPORT int cxPropertiesFilln(CxProperties *prop, const char *buf, size_t len);
-cx_attr_export
-int cxPropertiesFilln(
-CxProperties *prop,
-const char *buf,
-size_t len
-);
 /**
 * Internal function, do not use.
 *
 * @param prop the properties interface
 * @param str the text to fill in
 * @retval zero success
 * @retval non-zero a memory allocation was necessary but failed
 */
 cx_attr_nonnull
-static inline int cx_properties_fill(
+CX_INLINE int cx_properties_fill(CxProperties *prop, cxstring str) {
-CxProperties *prop,
-cxstring str
-) {
 return cxPropertiesFilln(prop, str.ptr, str.length);
 }
 /**
 * Fills the input buffer with data.
 * @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
+CX_EXPORT void cxPropertiesUseStack(CxProperties *prop, char *buf, size_t capacity);
-void cxPropertiesUseStack(
-CxProperties *prop,
-char *buf,
-size_t capacity
-);
 /**
 * Retrieves the next key/value-pair.
 *
 * This function returns zero as long as there are key/value-pairs found.
 * @retval CX_PROPERTIES_NULL_INPUT the input buffer was never filled
 * @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_nonnull cx_attr_nodiscard
-cx_attr_nodiscard
+CX_EXPORT CxPropertiesStatus cxPropertiesNext(CxProperties *prop, cxstring *key, cxstring *value);
-cx_attr_export
-CxPropertiesStatus cxPropertiesNext(
-CxProperties *prop,
-cxstring *key,
-cxstring *value
-);
 /**
 * Creates a properties sink for an UCX map.
 *
 * The values stored in the map will be pointers to freshly allocated,
 *
 * @param map the map that shall consume the k/v-pairs.
 * @return the sink
 * @see cxPropertiesLoad()
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_nodiscard
-cx_attr_nodiscard
+CX_EXPORT CxPropertiesSink cxPropertiesMapSink(CxMap *map);
-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
+CX_EXPORT CxPropertiesSource cxPropertiesStringSource(cxstring str);
-CxPropertiesSource cxPropertiesStringSource(cxstring str);
 /**
 * Creates a properties source based on C string with the specified length.
 *
 * @param str the string
 * @param len the length
 * @return the properties source
 * @see cxPropertiesLoad()
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_nodiscard cx_attr_access_r(1, 2)
-cx_attr_nodiscard
+CX_EXPORT CxPropertiesSource cxPropertiesCstrnSource(const char *str, size_t len);
-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.
 *
 * The length will be determined with strlen(), so the string MUST be
 *
 * @param str the string
 * @return the properties source
 * @see cxPropertiesLoad()
 */
-cx_attr_nonnull
+cx_attr_nonnull cx_attr_nodiscard cx_attr_cstr_arg(1)
-cx_attr_nodiscard
+CX_EXPORT CxPropertiesSource cxPropertiesCstrSource(const char *str);
-cx_attr_cstr_arg(1)
-cx_attr_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_nonnull cx_attr_nodiscard cx_attr_access_r(1)
-cx_attr_nodiscard
+CX_EXPORT CxPropertiesSource cxPropertiesFileSource(FILE *file, size_t chunk_size);
-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.
 *
 * @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
+CX_EXPORT CxPropertiesStatus cxPropertiesLoad(CxProperties *prop,
-CxPropertiesStatus cxPropertiesLoad(
+CxPropertiesSink sink, CxPropertiesSource source);
-CxProperties *prop,
-CxPropertiesSink sink,
-CxPropertiesSource source
-);
 #ifdef __cplusplus
 } // extern "C"
 #endif

Mercurial > hg > idav / file comparison

comparison: ucx/cx/properties.h

ucx/cx/properties.h