idav: comparison ucx/cx/properties.h

-:81c4f73236a4
+:c3f2f16fa4b8
 * Not used as a status and never returned by any function.
 *
 * You can use this enumerator to check for all "good" status results
 * by checking if the status is less than @c CX_PROPERTIES_OK.
 *
-* A "good" status means, that you can refill data and continue parsing.
+* A "good" status means that you can refill data and continue parsing.
 */
 CX_PROPERTIES_OK,
 /**
 * Input buffer is @c NULL.
 */
 CX_PROPERTIES_NULL_INPUT,
 /**
-* The line contains a delimiter, but no key.
+* The line contains a delimiter but no key.
 */
 CX_PROPERTIES_INVALID_EMPTY_KEY,
 /**
-* The line contains data, but no delimiter.
+* The line contains data but no delimiter.
 */
 CX_PROPERTIES_INVALID_MISSING_DELIMITER,
 /**
 * More internal buffer was needed, but could not be allocated.
 */
 typedef struct cx_properties_sink_s CxPropertiesSink;
 /**
 * A function that consumes a k/v-pair in a sink.
 *
-* The sink could be e.g. a map and the sink function would be calling
+* 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
 */
 struct cx_properties_source_s {
 /**
 * The source object.
 *
-* For example a file stream or a string.
+* For example, a file stream or a string.
 */
 void *src;
 /**
 * Optional additional data pointer.
 */
 /**
 * Destroys the properties interface.
 *
 * @note Even when you are certain that you did not use the interface in a
 * way that caused a memory allocation, you should call this function anyway.
-* Future versions of the library might add features that need additional memory
+* Future versions of the library might add features that need additional memory,
-* and you really don't want to search the entire code where you might need
+* and you really don't want to search the entire code where you might need to
-* add call to this function.
+* add a 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.
 *
-* You might want to use this, to reset the parser after
+* You might want to use this to reset the parser after
 * encountering a syntax error.
 *
 * @param prop the properties interface
 */
 cx_attr_nonnull
 CxProperties *prop,
 const char *buf,
 size_t len
 );
-#ifdef __cplusplus
+/**
-} // extern "C"
+* Internal function, do not use.
-cx_attr_nonnull
+*
-static inline int cxPropertiesFill(
+* @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(
 CxProperties *prop,
 cxstring str
 ) {
 return cxPropertiesFilln(prop, str.ptr, str.length);
 }
-cx_attr_nonnull
-static inline int cxPropertiesFill(
-CxProperties *prop,
-cxmutstr str
-) {
-return cxPropertiesFilln(prop, str.ptr, str.length);
-}
-cx_attr_nonnull
-cx_attr_cstr_arg(2)
-static inline int cxPropertiesFill(
-CxProperties *prop,
-const char *str
-) {
-return cxPropertiesFilln(prop, str, strlen(str));
-}
-extern "C" {
-#else // __cplusplus
 /**
 * Fills the input buffer with data.
 *
 * After calling this function, you can parse the data by calling
 * cxPropertiesNext().
 * @param str the text to fill in
 * @retval zero success
 * @retval non-zero a memory allocation was necessary but failed
 * @see cxPropertiesFilln()
 */
-#define cxPropertiesFill(prop, str) _Generic((str), \
+#define cxPropertiesFill(prop, str) cx_properties_fill(prop, cx_strcast(str))
-cxstring: cx_properties_fill_cxstr,             \
-cxmutstr: cx_properties_fill_mutstr,            \
+/**
-char*: cx_properties_fill_str,                  \
+* Specifies stack memory that shall be used as an internal buffer.
-const char*: cx_properties_fill_str)            \
-(prop, str)
-/**
-* @copydoc cxPropertiesFill()
-*/
-cx_attr_nonnull
-static inline int cx_properties_fill_cxstr(
-CxProperties *prop,
-cxstring str
-) {
-return cxPropertiesFilln(prop, str.ptr, str.length);
-}
-/**
-* @copydoc cxPropertiesFill()
-*/
-cx_attr_nonnull
-static inline int cx_properties_fill_mutstr(
-CxProperties *prop,
-cxmutstr str
-) {
-return cxPropertiesFilln(prop, str.ptr, str.length);
-}
-/**
-* @copydoc cxPropertiesFill()
-*/
-cx_attr_nonnull
-cx_attr_cstr_arg(2)
-static inline int cx_properties_fill_str(
-CxProperties *prop,
-const char *str
-) {
-return cxPropertiesFilln(prop, str, strlen(str));
-}
-#endif
-/**
-* Specifies stack memory that shall be used as internal buffer.
 *
 * @param prop the properties interface
 * @param buf a pointer to stack memory
 * @param capacity the capacity of the stack memory
 */

Mercurial > hg > idav / file comparison

comparison: ucx/cx/properties.h

ucx/cx/properties.h