pantheios/util/backends/arguments.h

Go to the documentation of this file.

/* /////////////////////////////////////////////////////////////////////////
 * File:        pantheios/util/backends/arguments.h
 *
 * Purpose:     Pantheios back end API
 *
 * Created:     21st June 2005
 * Updated:     10th August 2009
 *
 * Home:        http://www.pantheios.org/
 *
 * Copyright (c) 2005-2009, Matthew Wilson and Synesis Software
 * Copyright (c) 1999-2005, Synesis Software and Matthew Wilson
 * 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(s) of Matthew Wilson and Synesis Software nor the
 *   names of any 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 PANTHEIOS_INCL_PANTHEIOS_UTIL_BACKENDS_H_ARGUMENTS
#define PANTHEIOS_INCL_PANTHEIOS_UTIL_BACKENDS_H_ARGUMENTS

/* /////////////////////////////////////////////////////////////////////////
 * Version information
 */

#ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
# define PANTHEIOS_VER_PANTHEIOS_UTIL_BACKENDS_H_ARGUMENTS_MAJOR    2
# define PANTHEIOS_VER_PANTHEIOS_UTIL_BACKENDS_H_ARGUMENTS_MINOR    1
# define PANTHEIOS_VER_PANTHEIOS_UTIL_BACKENDS_H_ARGUMENTS_REVISION 1
# define PANTHEIOS_VER_PANTHEIOS_UTIL_BACKENDS_H_ARGUMENTS_EDIT     22
#endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Includes
 */

#ifndef PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS
# include <pantheios/pantheios.h>
#endif /* !PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS */

/* /////////////////////////////////////////////////////////////////////////
 * Parsing functions
 */

PANTHEIOS_CALL(int) pantheios_be_parseBooleanArg(size_t                         numArgs
#ifdef PANTHEIOS_NO_NAMESPACE
                                            ,   pan_slice_t* const              args
                                            ,   pan_char_t const*               argName
                                            ,   int                             flagSuppressesAction
                                            ,   pan_uint32_t                    flagValue
                                            ,   pan_uint32_t*                   flags);
#else /* ? PANTHEIOS_NO_NAMESPACE */
                                            ,   pantheios::pan_slice_t* const   args
                                            ,   pantheios::pan_char_t const*    argName
                                            ,   int                             flagSuppressesAction
                                            ,   pantheios::pan_uint32_t         flagValue
                                            ,   pantheios::uint32_t*            flags);
#endif /* PANTHEIOS_NO_NAMESPACE */


PANTHEIOS_CALL(int) pantheios_be_parseStringArg(size_t                          numArgs
#ifdef PANTHEIOS_NO_NAMESPACE
                                            ,   pan_slice_t* const              args
                                            ,   pan_char_t const*               argName
                                            ,   pan_slice_t*                    argValue);
#else /* ? PANTHEIOS_NO_NAMESPACE */
                                            ,   pantheios::pan_slice_t* const   args
                                            ,   pantheios::pan_char_t const*    argName
                                            ,   pantheios::pan_slice_t*         argValue);
#endif /* PANTHEIOS_NO_NAMESPACE */


PANTHEIOS_CALL(int) pantheios_be_parseStockArgs(size_t                          numArgs
#ifdef PANTHEIOS_NO_NAMESPACE
                                            ,   pan_slice_t* const              args
                                            ,   pan_uint32_t*                   flags);
#else /* ? PANTHEIOS_NO_NAMESPACE */
                                            ,   pantheios::pan_slice_t* const   args
                                            ,   pantheios::uint32_t*            flags);
#endif /* PANTHEIOS_NO_NAMESPACE */


/* ////////////////////////////////////////////////////////////////////// */

#endif /* !PANTHEIOS_INCL_PANTHEIOS_UTIL_BACKENDS_H_ARGUMENTS */

/* ///////////////////////////// end of file //////////////////////////// */

pantheios Library documentation © Matthew Wilson & Synesis Software, 2006-2011