ucx: ucx/properties.h@633f15ce2ee4 (annotated)

ucx/properties.h@633f15ce2ee4 (annotated)

ucx/properties.h

Mon, 05 Aug 2013 14:38:37 +0200

author: Mike Becker <universe@uap-core.de>
date: Mon, 05 Aug 2013 14:38:37 +0200
changeset 130: 633f15ce2ee4
parent 120: 8170f658f017
child 133: 0a70e0d36949
permissions: -rw-r--r--

started documentation of UcxProperties + some fixes

 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 2013 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.
  */
 /**
  * @file properties.h
  *
  * Load / store utilities for properties files.
  *
  * @author Mike Becker
  * @author Olaf Wintermann
  */
 #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;
 /**
  * Constructs a new UcxProperties object.
  * @return A pointer to the new UcxProperties object.
  */
 UcxProperties *ucx_properties_new();
 /**
  * Destroys an UcxProperties object.
  * @param prop The UcxProperties object to destroy.
  */
 void ucx_properties_free(UcxProperties *prop);
 /**
  * Refills the input buffer.
  * @param prop The UcxProperties object.
  * @param buf A pointer to the new buffer.
  * @param len The payload length of the buffer.
  */
 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);
 /**
  * Loads a properties file to an UcxMap.
  *
  * This is a convenience function that reads chunks of 1 KB from an input
  * stream until the end of the stream is reached.
  *
  * An UcxProperties object is implicitly created and destroyed.
  *
  * @param map The map object to write the key/value-pairs to.
  * @param file The <code>FILE*</code> stream to read from.
  * @return 0 on success, or a non-zero value on error
  *
  * @see ucx_properties_fill()
  * @see ucx_properties2map()
  */
 int ucx_properties_load(UcxMap *map, FILE *file);
 /**
  * Stores an UcxMap to a file.
  *
  * The key/value-pairs are written by using the following format:
  *
  * <code>[key] = [value]\\n</code>
  *
  * @param map The map to store.
  * @param file The <code>FILE*</code> stream to write to.
  * @return 0 on success, or a non-zero value on error
  */
 int ucx_properties_store(UcxMap *map, FILE *file);
 #ifdef	__cplusplus
 }
 #endif
 #endif	/* UCX_PROPERTIES_H */

Mercurial > hg > ucx / annotate

ucx/properties.h@633f15ce2ee4 (annotated)

ucx/properties.h