properties.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2024 Mike Becker, Olaf Wintermann All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef UCX_PROPERTIES_H
#define UCX_PROPERTIES_H
 
#include "common.h"
#include "string.h"
#include "map.h"
#include "buffer.h"

struct cx_properties_config_s {
    char delimiter;

    char comment1;

    char comment2;

    char comment3;

    char continuation;
};

typedef struct cx_properties_config_s CxPropertiesConfig;

CX_EXPORT extern const CxPropertiesConfig cx_properties_config_default;

enum cx_properties_status {
    CX_PROPERTIES_NO_ERROR,
    CX_PROPERTIES_NO_DATA,
    CX_PROPERTIES_INCOMPLETE_DATA,
    CX_PROPERTIES_OK,
    CX_PROPERTIES_NULL_INPUT,
    CX_PROPERTIES_INVALID_EMPTY_KEY,
    CX_PROPERTIES_INVALID_MISSING_DELIMITER,
    CX_PROPERTIES_BUFFER_ALLOC_FAILED,
    CX_PROPERTIES_FILE_ERROR,
    CX_PROPERTIES_MAP_ERROR,
};

typedef enum cx_properties_status CxPropertiesStatus;

struct cx_properties_s {
    CxPropertiesConfig config;

    CxBuffer input;

    CxBuffer buffer;
};

typedef struct cx_properties_s CxProperties;

CX_EXTERN CX_NONNULL
void cxPropertiesInit(CxProperties *prop, CxPropertiesConfig config);

CX_EXTERN CX_NONNULL
void cxPropertiesDestroy(CxProperties *prop);

CX_EXTERN CX_NONNULL
void cxPropertiesReset(CxProperties *prop);

#define cxPropertiesInitDefault(prop) \
        cxPropertiesInit(prop, cx_properties_config_default)

CX_EXTERN CX_NONNULL CX_ACCESS_R(2, 3)
int cxPropertiesFilln(CxProperties *prop, const char *buf, size_t len);

CX_NONNULL CX_INLINE
int cx_properties_fill(CxProperties *prop, cxstring str) {
    return cxPropertiesFilln(prop, str.ptr, str.length);
}

#define cxPropertiesFill(prop, str) cx_properties_fill(prop, cx_strcast(str))

CX_EXTERN CX_NONNULL
void cxPropertiesUseStack(CxProperties *prop, char *buf, size_t capacity);

CX_EXTERN CX_NONNULL CX_NODISCARD
CxPropertiesStatus cxPropertiesNext(CxProperties *prop, cxstring *key, cxstring *value);

CX_EXPORT extern const unsigned cx_properties_load_buf_size;

CX_EXPORT extern const unsigned cx_properties_load_fill_size;

CX_EXTERN CX_NONNULL_ARG(3)
CxPropertiesStatus cx_properties_load(const CxAllocator *allocator,
        cxstring filename, CxMap *target, CxPropertiesConfig config);

#define cxPropertiesLoad(allocator, filename, target, config) \
    cx_properties_load(allocator, cx_strcast(filename), target, config)

#define cxPropertiesLoadDefault(allocator, filename, target) \
    cx_properties_load(allocator, cx_strcast(filename), target, cx_properties_config_default)
 
#endif // UCX_PROPERTIES_H