Private Volksdata API

Collaboration diagram for Private Volksdata API:

Topics
	Private codec API
	Store interface module

Macros
#define	CALLOC_GUARD(var, rc)
	Allocate one pointer with calloc and return rc if it fails.
#define	CHECK(exp, marker)
	Jump to marker if exp does not return VOLK_OK.
#define	log_debug(...)
#define	LOG_RC(rc)
	Log an error or warning for return codes that are not VOLK_OK.
#define	log_trace(...)
#define	MALLOC_GUARD(var, rc)
	Allocate one pointer with malloc and return rc if it fails.
#define	NLCHECK(exp, marker)
	Log error and jump to marker if exp is NULL.
#define	NLNL(exp)
	Log error and return NULL if exp is NULL.
#define	NLRCCK(exp, _rc)
	Return return codes return code if exp is NULL.
#define	PCHECK(exp, marker)
	Jump to marker if exp returns a negative value (skip warnings).
#define	PRCCK(exp)
	Return exp return value if it is of VOLK_rc type and negative (=error).
#define	PRCNL(exp)
	Return NULL if exp returns a negative value (=error).
#define	RCCK(exp)
	Return exp return value if it is of VOLK_rc type and nonzero.
#define	RCNL(exp)
	Return NULL if exp returns a nonzero value.
#define	VOLK_MAX_ERROR   -88000
#define	VOLK_MAX_WARNING   88899
#define	VOLK_MIN_ERROR   VOLK_ERROR
	Minimum error value.
#define	VOLK_MIN_WARNING   VOLK_NOACTION
	First warning value.

Functions
VOLK_rc	mkdir_p (const char *path, mode_t mode)
	Make recursive directories.
VOLK_rc	rm_r (const char *path)
	Remove a directory recursively, as in Unix "rm -r".
char *	strdup (const char *src)
	Replacement for GNU strdup.
char *	strndup (const char *src, size_t max)
	Replacement for GNU strndup.
int	utf8_encode (const uint32_t utf, unsigned char *out)
	Encode a code point using UTF-8.

Detailed Description

Macro Definition Documentation

CALLOC_GUARD

#define CALLOC_GUARD	(		var,
			rc )

Value:

    do {                                  \
    (var) = calloc (1, sizeof *(var));                              \
    if (UNLIKELY (var == NULL)) return (rc);                        \
} while (0)

Allocate one pointer with calloc and return rc if it fails.

Definition at line 388 of file core.h.

CHECK

#define CHECK	(		exp,
			marker )

Value:

    do {                                     \
    VOLK_rc _rc = (exp);                                            \
    LOG_RC(_rc);                                                    \
    if (UNLIKELY (_rc != VOLK_OK)) {                                \
        log_error (                                                 \
                "*** PREMATURE EXIT due to error: %s",              \
                VOLK_strerror (_rc));                               \
        goto marker;                                                \
    }                                                               \
} while (0)

Jump to marker if exp does not return VOLK_OK.

Definition at line 290 of file core.h.

log_debug

#define log_debug

(

...

)

Value:

do {} while(0)

Definition at line 273 of file core.h.

LOG_RC

#define LOG_RC

(

rc

)

Value:

    do {                                             \
    if ((rc) < 0) log_error (VOLK_strerror (rc));                   \
    else if ((rc) > 0) log_warn (VOLK_strerror (rc));              \
} while (0)

Log an error or warning for return codes that are not VOLK_OK.

Note that, if used outside of the other macros below, care must be taken to pass it an actual return code rather than an expression, otherwise the expression will be evaluated multiple times.

Definition at line 284 of file core.h.

log_trace

#define log_trace

(

...

)

Value:

do {} while(0)

Definition at line 275 of file core.h.

MALLOC_GUARD

#define MALLOC_GUARD	(		var,
			rc )

Value:

    do {                                  \
    (var) = malloc (sizeof *(var));                                 \
    if (UNLIKELY (var == NULL)) return (rc);                        \
} while (0)

Allocate one pointer with malloc and return rc if it fails.

Definition at line 382 of file core.h.

NLCHECK

#define NLCHECK	(		exp,
			marker )

Value:

    do {                                   \
    if (UNLIKELY ((exp) == NULL)) {                                 \
        log_error ("*** PREMATURE EXIT due to NULL result.");       \
        goto marker;                                                \
    }                                                               \
} while (0);

Log error and jump to marker if exp is NULL.

Definition at line 314 of file core.h.

NLNL

#define NLNL

(

exp

)

Value:

    do {                                              \
    if (UNLIKELY ((exp) == NULL)) {                                 \
        log_error ("*** PREMATURE EXIT due to NULL result.");       \
        return NULL;                                                \
    }                                                               \
} while (0)

Log error and return NULL if exp is NULL.

Definition at line 374 of file core.h.

NLRCCK

#define NLRCCK	(		exp,
			_rc )

Value:

    do {                                       \
    if (UNLIKELY ((exp) == NULL)) {                                 \
        log_error ("*** PREMATURE EXIT due to NULL result.");       \
        return _rc;                                                 \
    }                                                               \
} while (0)

Return return codes return code if exp is NULL.

Definition at line 344 of file core.h.

PCHECK

#define PCHECK	(		exp,
			marker )

Value:

    do {                                    \
    VOLK_rc _rc = (exp);                                            \
    if (UNLIKELY (_rc < VOLK_OK)) {                                 \
        log_error (                                                 \
                "*** PREMATURE EXIT due to error: %s",              \
                VOLK_strerror (_rc));                               \
        LOG_RC(_rc);                                                \
        goto marker;                                                \
    }                                                               \
} while (0)

Jump to marker if exp returns a negative value (skip warnings).

Definition at line 302 of file core.h.

PRCCK

#define PRCCK

(

exp

)

Value:

    do {                                             \
    VOLK_rc _rc = (exp);                                            \
    if (UNLIKELY (_rc < VOLK_OK)) {                                 \
        log_error (                                                 \
                "*** PREMATURE EXIT due to error: %s (%d)",         \
                VOLK_strerror (_rc), _rc);                          \
        return _rc;                                                 \
    }                                                               \
} while (0)

Return exp return value if it is of VOLK_rc type and negative (=error).

Definition at line 333 of file core.h.

PRCNL

#define PRCNL

(

exp

)

Value:

    do {                                             \
    VOLK_rc _rc = (exp);                                            \
    if (UNLIKELY (_rc < VOLK_OK)) {                                 \
        log_error (                                                 \
                "*** PREMATURE EXIT due to error: %s (%d)",         \
                VOLK_strerror (_rc), _rc);                          \
        return NULL;                                                \
    }                                                               \
} while (0)

Return NULL if exp returns a negative value (=error).

Definition at line 363 of file core.h.

RCCK

#define RCCK

(

exp

)

Value:

    do {                                              \
    VOLK_rc _rc = (exp);                                            \
    if (UNLIKELY (_rc != VOLK_OK)) {                                \
        log_error (                                                 \
                "*** PREMATURE EXIT due to error: %s (%d)",         \
                VOLK_strerror (_rc), _rc);                          \
        return _rc;                                                 \
    }                                                               \
} while (0)

Return exp return value if it is of VOLK_rc type and nonzero.

Definition at line 322 of file core.h.

RCNL

#define RCNL

(

exp

)

Value:

    do {                                              \
    VOLK_rc _rc = (exp);                                            \
    if (UNLIKELY (_rc != VOLK_OK)) {                                \
        log_error (                                                 \
                "*** PREMATURE EXIT due to error: %s (%d)",         \
                VOLK_strerror (_rc), _rc);                          \
        return NULL;                                                \
    }                                                               \
} while (0);

Return NULL if exp returns a nonzero value.

Definition at line 352 of file core.h.

VOLK_MAX_ERROR

#define VOLK_MAX_ERROR   -88000

brief Maximum error value.

Note

When adding new error codes, use a value smaller than this.

Definition at line 254 of file core.h.

VOLK_MAX_WARNING

#define VOLK_MAX_WARNING   88899

brief Maximum warning value.

Note

When adding new warning codes, use a value smaller than this.

Definition at line 263 of file core.h.

VOLK_MIN_ERROR

#define VOLK_MIN_ERROR   VOLK_ERROR

Minimum error value.

Definition at line 249 of file core.h.

VOLK_MIN_WARNING

#define VOLK_MIN_WARNING   VOLK_NOACTION

First warning value.

Definition at line 257 of file core.h.

Function Documentation

mkdir_p()

VOLK_rc mkdir_p	(	const char *	path,
		mode_t	mode )

Make recursive directories.

Modified from https://gist.github.com/JonathonReinhart/8c0d90191c38af2dcadb102c4e202950

Definition at line 50 of file core.c.

rm_r()

VOLK_rc rm_r

(

const char *

path

)

Remove a directory recursively, as in Unix "rm -r".

Parameters

[in]

path

Path of directory to remove.

Remove a directory recursively, as in Unix "rm -r".

Adapted from https://stackoverflow.com/questions/5467725/how-to-delete-a-directory-and-its-contents-in-posix-c/42596507#42596507

Definition at line 124 of file core.c.

strdup()

char * strdup

(

const char *

src

)

Replacement for GNU strdup.

param[in] str String to duplicate.

return Duplicated string. The caller is in charge of freeing it after use.

Definition at line 109 of file core.c.

strndup()

char * strndup	(	const char *	src,
		size_t	max )

Replacement for GNU strndup.

param[in] src String to duplicate. param[in] max Max number of characters to duplicate. The length is capped to the smaller value between this and the source string length (characters up to the trailing \0).

return Duplicated string. The caller is in charge of freeing it after use.

Definition at line 92 of file core.c.

utf8_encode()

int utf8_encode ( const uint32_t utf, unsigned char * out )

inline

Encode a code point using UTF-8.

https://gist.github.com/MightyPork/52eda3e5677b4b03524e40c9f0ab1da5

Author

Ondřej Hruška ondra.nosp@m.@ond.nosp@m.rovo..nosp@m.com

Copyright

MIT

Parameters

out	- output buffer (min 5 characters), will be 0-terminated
utf	- code point 0-0x10FFFF

Returns

number of bytes on success, 0 on failure (also produces U+FFFD, which uses 3 bytes)

Definition at line 452 of file core.h.