rte_cfgfile.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   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
 *   OWNER 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 __INCLUDE_RTE_CFGFILE_H__
#define __INCLUDE_RTE_CFGFILE_H__

#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifndef CFG_NAME_LEN
#define CFG_NAME_LEN 64
#endif

#ifndef CFG_VALUE_LEN
#define CFG_VALUE_LEN 256
#endif

struct rte_cfgfile;

struct rte_cfgfile_entry {
    char name[CFG_NAME_LEN]; 
    char value[CFG_VALUE_LEN]; 
};

struct rte_cfgfile_parameters {
    char comment_character;
};

enum {
    CFG_FLAG_GLOBAL_SECTION = 1,

    CFG_FLAG_EMPTY_VALUES = 2,
};
#define CFG_DEFAULT_COMMENT_CHARACTER ';'

struct rte_cfgfile *rte_cfgfile_load(const char *filename, int flags);

struct rte_cfgfile *rte_cfgfile_load_with_params(const char *filename,
    int flags, const struct rte_cfgfile_parameters *params);

struct rte_cfgfile *rte_cfgfile_create(int flags);

int
rte_cfgfile_add_section(struct rte_cfgfile *cfg, const char *sectionname);

int rte_cfgfile_add_entry(struct rte_cfgfile *cfg,
        const char *sectionname, const char *entryname,
        const char *entryvalue);

int rte_cfgfile_set_entry(struct rte_cfgfile *cfg, const char *sectionname,
        const char *entryname, const char *entryvalue);

int rte_cfgfile_save(struct rte_cfgfile *cfg, const char *filename);

int rte_cfgfile_num_sections(struct rte_cfgfile *cfg, const char *sec_name,
    size_t length);

int rte_cfgfile_sections(struct rte_cfgfile *cfg, char *sections[],
    int max_sections);

int rte_cfgfile_has_section(struct rte_cfgfile *cfg, const char *sectionname);

int rte_cfgfile_section_num_entries(struct rte_cfgfile *cfg,
    const char *sectionname);

int rte_cfgfile_section_num_entries_by_index(struct rte_cfgfile *cfg,
    char *sectionname,
    int index);

int rte_cfgfile_section_entries(struct rte_cfgfile *cfg,
    const char *sectionname,
    struct rte_cfgfile_entry *entries,
    int max_entries);

int rte_cfgfile_section_entries_by_index(struct rte_cfgfile *cfg,
    int index,
    char *sectionname,
    struct rte_cfgfile_entry *entries,
    int max_entries);

const char *rte_cfgfile_get_entry(struct rte_cfgfile *cfg,
    const char *sectionname,
    const char *entryname);

int rte_cfgfile_has_entry(struct rte_cfgfile *cfg, const char *sectionname,
    const char *entryname);

int rte_cfgfile_close(struct rte_cfgfile *cfg);

#ifdef __cplusplus
}
#endif

#endif