docs/api-2.1/properties_8h_source.html

 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 2017 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 "ucx.h"
 #include "map.h"

 #ifdef  __cplusplus
 extern "C" {
 #endif

 typedef struct {
     char   *buffer;

     size_t buflen;

     size_t pos;

     char   *tmp;

     size_t tmplen;

     size_t tmpcap;

     int    error;

     char   delimiter;

     char   comment1;

     char   comment2;

     char   comment3;
 } UcxProperties;


 UcxProperties *ucx_properties_new();

 void ucx_properties_free(UcxProperties *prop);

 void ucx_properties_fill(UcxProperties *prop, char *buf, size_t len);

 int ucx_properties_next(UcxProperties *prop, sstr_t *name, sstr_t *value);

 int ucx_properties2map(UcxProperties *prop, UcxMap *map);

 int ucx_properties_load(UcxMap *map, FILE *file);

 int ucx_properties_store(UcxMap *map, FILE *file);

 #ifdef  __cplusplus
 }
 #endif

 #endif  /* UCX_PROPERTIES_H */

sstr_t
The UCX string structure.
Definition: string.h:90

universe@390: ucx_properties_new
UcxProperties * ucx_properties_new()
Constructs a new UcxProperties object.
Definition: properties.c:35

universe@390: UcxProperties::comment3
char comment3
The third comment character.
Definition: properties.h:119

universe@390: ucx.h
Main UCX Header providing most common definitions.

universe@390: UcxProperties::pos
size_t pos
Current buffer position (don&#39;t set manually).
Definition: properties.h:70

universe@390: UcxProperties::comment2
char comment2
The second comment character.
Definition: properties.h:113

universe@390: ucx_properties_load
int ucx_properties_load(UcxMap *map, FILE *file)
Loads a properties file to a UcxMap.
Definition: properties.c:222

universe@390: UcxProperties
UcxProperties object for parsing properties data.
Definition: properties.h:53

universe@390: UcxProperties::buflen
size_t buflen
Length of the input buffer (don&#39;t set manually).
Definition: properties.h:64

universe@390: UcxProperties::buffer
char * buffer
Input buffer (don&#39;t set manually).
Definition: properties.h:58

universe@390: UcxProperties::error
int error
Parser error code.
Definition: properties.h:95

universe@390: UcxProperties::tmplen
size_t tmplen
Internal temporary buffer length (don&#39;t set manually).
Definition: properties.h:82

universe@390: UcxProperties::comment1
char comment1
The first comment character.
Definition: properties.h:107

universe@390: ucx_properties_next
int ucx_properties_next(UcxProperties *prop, sstr_t *name, sstr_t *value)
Retrieves the next key/value-pair.
Definition: properties.c:80

universe@390: ucx_properties2map
int ucx_properties2map(UcxProperties *prop, UcxMap *map)
Retrieves all available key/value-pairs and puts them into a UcxMap.
Definition: properties.c:200

universe@390: UcxProperties::delimiter
char delimiter
The delimiter that shall be used.
Definition: properties.h:101

universe@390: UcxProperties::tmp
char * tmp
Internal temporary buffer (don&#39;t set manually).
Definition: properties.h:76

universe@390: UcxMap
Structure for the UCX map.
Definition: map.h:81

universe@390: UcxProperties::tmpcap
size_t tmpcap
Internal temporary buffer capacity (don&#39;t set manually).
Definition: properties.h:88

universe@390: map.h
Hash map implementation.

universe@390: ucx_properties_fill
void ucx_properties_fill(UcxProperties *prop, char *buf, size_t len)
Sets the input buffer for the properties parser.
Definition: properties.c:64

universe@390: ucx_properties_store
int ucx_properties_store(UcxMap *map, FILE *file)
Stores a UcxMap to a file.
Definition: properties.c:242

universe@390: ucx_properties_free
void ucx_properties_free(UcxProperties *prop)
Destroys a UcxProperties object.
Definition: properties.c:57

universe@390: