source/include/nclopt.h

0001 /**
0002  * @brief Common command line options handler
0003  *
0004  * @file nclopt.h
0005  */
0006 /* -----------------------------------------------------------------------------
0007  * Enduro/X Middleware Platform for Distributed Transaction Processing
0008  * Copyright (C) 2009-2016, ATR Baltic, Ltd. All Rights Reserved.
0009  * Copyright (C) 2017-2023, Mavimax, Ltd. All Rights Reserved.
0010  * This software is released under one of the following licenses:
0011  * AGPL (with Java and Go exceptions) or Mavimax's license for commercial use.
0012  * See LICENSE file for full text.
0013  * -----------------------------------------------------------------------------
0014  * AGPL license:
0015  *
0016  * This program is free software; you can redistribute it and/or modify it under
0017  * the terms of the GNU Affero General Public License, version 3 as published
0018  * by the Free Software Foundation;
0019  *
0020  * This program is distributed in the hope that it will be useful, but WITHOUT ANY
0021  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
0022  * PARTICULAR PURPOSE. See the GNU Affero General Public License, version 3
0023  * for more details.
0024  *
0025  * You should have received a copy of the GNU Affero General Public License along
0026  * with this program; if not, write to the Free Software Foundation, Inc.,
0027  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
0028  *
0029  * -----------------------------------------------------------------------------
0030  * A commercial use license is available from Mavimax, Ltd
0031  * contact@mavimax.com
0032  * -----------------------------------------------------------------------------
0033  */
0034 #ifndef NCLOPT_H
0035 #define NCLOPT_H
0036
0037 #ifdef  __cplusplus
0038 extern "C" {
0039 #endif
0040 /*---------------------------Includes-----------------------------------*/
0041 /*---------------------------Externs------------------------------------*/
0042 /*---------------------------Macros-------------------------------------*/
0043 #define NCLOPT_MAND               0x1        /* Mandatory field             */
0044 #define NCLOPT_OPT                0x2        /* Optiona field               */
0045 #define NCLOPT_HAVE_VALUE         0x4        /* Have value                  */
0046 #define NCLOPT_TRUEBOOL           0x8        /* Boolean flag (default)      */
0047 /*---------------------------Enums--------------------------------------*/
0048 /*---------------------------Typedefs-----------------------------------*/
0049
0050 typedef struct ncloptmap ncloptmap_t;
0051 struct ncloptmap
0052 {
0053     char key;
0054     int datatype; /* UBF based data type */
0055     void *ptr;
0056     int buf_size;    /* Number of chars in buffer, used for strings... */
0057     int flags;
0058     char *descr;            /* Field description */
0059     int have_loaded;        /* Dynamic field, used per parse session... */
0060 };
0061 /*---------------------------Globals------------------------------------*/
0062 /*---------------------------Statics------------------------------------*/
0063 /*---------------------------Prototypes---------------------------------*/
0064 extern NDRX_API int nstd_parse_clopt(ncloptmap_t *opts, int print_values,
0065         int argc, char **argv, int ignore_unk);
0066
0067 #ifdef  __cplusplus
0068 }
0069 #endif
0070
0071 #endif  /* NCLOPT_H */
0072
0073 /* vim: set ts=4 sw=4 et smartindent: */