ucx: ucx/ucx.h@5a0859739b76 (annotated)

ucx/ucx.h@5a0859739b76 (annotated)

ucx/ucx.h

Wed, 17 Jul 2013 11:47:02 +0200

author: Mike Becker <universe@uap-core.de>
date: Wed, 17 Jul 2013 11:47:02 +0200
changeset 114: 5a0859739b76
parent 103: 08018864fb91
child 115: 965fd17ed9cf
permissions: -rw-r--r--

added doxyfile and documentation for ucx.h

 /*
  * 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.
  */
 /**
  * Main UCX Header providing most common definitions.
  *
  * @file   ucx.h
  * @author Olaf Wintermann
  */
 #ifndef UCX_H
 #define	UCX_H
 #include <stdlib.h>
 #ifdef	__cplusplus
 #ifndef _Bool
 #define _Bool bool
 #define restrict
 #endif
 extern "C" {
 #endif
 /**
  * Generic loop statement for lists.
  *
  * The first argument is the type of the list and its elements (e.g. UcxList).
  * The structure invariant of the list must be as follows:
  * <ul>
  *   <li>a first (non-<code>NULL</code>) element</li>
  *   <li>for each element a reference to the <code>next</code> element (the
  *       variable name of the pointer MUST be <code>next</code>)</li>
  *   <li>the last element of the list MUST have the <code>next</code> pointer
  *       set to <code>NULL</code></li>
  * </ul>
  *
  * The second argument is a pointer to the list. In most cases this will be the
  * pointer to the first element of the list, but it may also be an arbitrary
  * element of the list. The iteration will then start with that element.
  *
  * The third argument is the name of the iteration variable. The scope of
  * this variable is limited to the <code>UCX_FOREACH</code> statement.
  *
  * @param type The type of <b>both</b> the list and the element
  * @param list The first element of the list
  * @param elem The variable name of the element
  */
 #define UCX_FOREACH(type,list,elem) \
         for (type elem = list ; elem != NULL ; elem = elem->next)
 /**
  * Function pointer to a compare function.
  *
  * The compare function shall take three arguments: the two values that shall be
  * compared and optional additional data.
  * The function shall then return -1 if the first argument is less than the
  * second argument, 1 if the first argument is greater than the second argument
  * and 0 if both arguments are equal. If the third argument is
  * <code>NULL</code>, it shall be ignored.
  */
 typedef int(*cmp_func)(void*,void*,void*);
 /**
  * Function pointer to a copy function.
  *
  * The copy function shall create a copy of the first argument and may use
  * additional data provided by the second argument. If the second argument is
  * <code>NULL</code>, it shall be ignored.
  * <b>Attention:</b> if pointers returned by functions of this type may be
  * passed to <code>free()</code> depends on the implementation of the
  * respective <code>copy_func</code>.
  */
 typedef void*(*copy_func)(void*,void*);
 /**
  * Function pointer to a write function.
  *
  * The signature of the write function shall be compatible to the signature
  * of standard <code>fwrite</code>, though it may use arbitrary data types for
  * source and destination.
  *
  * The arguments shall contain (in ascending order): a pointer to the source,
  * the length of one element, the element count, a pointer to the destination.
  */
 typedef size_t(*write_func)(const void*, size_t, size_t, void*);
 /**
  * Function pointer to a read function.
  *
  * The signature of the read function shall be compatible to the signature
  * of standard <code>fread</code>, though it may use arbitrary data types for
  * source and destination.
  *
  * The arguments shall contain (in ascending order): a pointer to the
  * destination, the length of one element, the element count, a pointer to the
  * source.
  */
 typedef size_t(*read_func)(void*, size_t, size_t, void*);
 #ifdef	__cplusplus
 }
 #endif
 #endif	/* UCX_H */

Mercurial > hg > ucx / annotate

ucx/ucx.h@5a0859739b76 (annotated)

ucx/ucx.h