Annotation of parser3/src/lib/sdbm/apr-include/apu.h, revision 1.3

1.1       paf         1: /* ====================================================================
                      2:  * The Apache Software License, Version 1.1
                      3:  *
                      4:  * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
                      5:  * reserved.
                      6:  *
                      7:  * Redistribution and use in source and binary forms, with or without
                      8:  * modification, are permitted provided that the following conditions
                      9:  * are met:
                     10:  *
                     11:  * 1. Redistributions of source code must retain the above copyright
                     12:  *    notice, this list of conditions and the following disclaimer.
                     13:  *
                     14:  * 2. Redistributions in binary form must reproduce the above copyright
                     15:  *    notice, this list of conditions and the following disclaimer in
                     16:  *    the documentation and/or other materials provided with the
                     17:  *    distribution.
                     18:  *
                     19:  * 3. The end-user documentation included with the redistribution,
                     20:  *    if any, must include the following acknowledgment:
                     21:  *       "This product includes software developed by the
                     22:  *        Apache Software Foundation (http://www.apache.org/)."
                     23:  *    Alternately, this acknowledgment may appear in the software itself,
                     24:  *    if and wherever such third-party acknowledgments normally appear.
                     25:  *
                     26:  * 4. The names "Apache" and "Apache Software Foundation" must
                     27:  *    not be used to endorse or promote products derived from this
                     28:  *    software without prior written permission. For written
                     29:  *    permission, please contact apache@apache.org.
                     30:  *
                     31:  * 5. Products derived from this software may not be called "Apache",
                     32:  *    nor may "Apache" appear in their name, without prior written
                     33:  *    permission of the Apache Software Foundation.
                     34:  *
                     35:  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
                     36:  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
                     37:  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
                     38:  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
                     39:  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
                     40:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
                     41:  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
                     42:  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
                     43:  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
                     44:  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
                     45:  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     46:  * SUCH DAMAGE.
                     47:  * ====================================================================
                     48:  *
                     49:  * This software consists of voluntary contributions made by many
                     50:  * individuals on behalf of the Apache Software Foundation.  For more
                     51:  * information on the Apache Software Foundation, please see
                     52:  * <http://www.apache.org/>.
                     53:  */
                     54: 
                     55: /*
                     56:  * apu.h is generated from apu.h.in by configure -- do not edit apu.h
                     57:  */
                     58: /* @file apu.h
                     59:  * @brief APR-Utility main file
                     60:  */
                     61: /**
                     62:  * @defgroup APR_Util APR Utility Functions
                     63:  * @{
                     64:  */
                     65: 
                     66: 
                     67: #ifndef APU_H
                     68: #define APU_H
                     69: 
                     70: /**
                     71:  * APU_DECLARE_EXPORT is defined when building the APR-UTIL dynamic library,
                     72:  * so that all public symbols are exported.
                     73:  *
                     74:  * APU_DECLARE_STATIC is defined when including the APR-UTIL public headers,
                     75:  * to provide static linkage when the dynamic library may be unavailable.
                     76:  *
                     77:  * APU_DECLARE_STATIC and APU_DECLARE_EXPORT are left undefined when
                     78:  * including the APR-UTIL public headers, to import and link the symbols from 
                     79:  * the dynamic APR-UTIL library and assure appropriate indirection and calling
                     80:  * conventions at compile time.
                     81:  */
                     82: 
                     83: /**
                     84:  * The public APR-UTIL functions are declared with APU_DECLARE(), so they may
                     85:  * use the most appropriate calling convention.  Public APR functions with 
                     86:  * variable arguments must use APU_DECLARE_NONSTD().
                     87:  *
                     88:  * @deffunc APU_DECLARE(rettype) apr_func(args);
                     89:  */
                     90: #define APU_DECLARE(type)            type
                     91: /**
                     92:  * The public APR-UTIL functions using variable arguments are declared with 
                     93:  * APU_DECLARE_NONSTD(), as they must use the C language calling convention.
                     94:  *
                     95:  * @deffunc APU_DECLARE_NONSTD(rettype) apr_func(args, ...);
                     96:  */
                     97: #define APU_DECLARE_NONSTD(type)     type
                     98: /**
                     99:  * The public APR-UTIL variables are declared with APU_DECLARE_DATA.
                    100:  * This assures the appropriate indirection is invoked at compile time.
                    101:  *
                    102:  * @deffunc APU_DECLARE_DATA type apr_variable;
                    103:  * @tip APU_DECLARE_DATA extern type apr_variable; syntax is required for
                    104:  * declarations within headers to properly import the variable.
                    105:  */
                    106: #define APU_DECLARE_DATA
                    107: /*
                    108:  * we always have SDBM (it's in our codebase)
                    109:  */
                    110: #define APU_HAVE_SDBM
                    111: 
                    112: #endif /* APU_H */
                    113: /** @} */

E-mail: