OpenDNSSEC-enforcer  1.4.7
parser.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008-2009 Nominet UK. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
19  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
21  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
22  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
23  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  */
26 
27 #ifndef KSM_PARSER_H
28 #define KSM_PARSER_H
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 /*+
35  * parser.h - Parser Include File
36  *
37  * Description:
38  * Defines the functions and structures used by the parser.
39 -*/
40 
41 #include "commands.h"
42 
43 /* Command Option Descriptor */
44 
45 typedef struct {
46  char option; /* The single letter option found */
47  char* string; /* Value of the option, or NULL if no value found */
48  /* It is up to the caller to free this string */
49  long value; /* Value of the string as long value */
50  int valid; /* 1 if the "string"->"value" conversion succeeded */
51 } par_option;
52 
53 typedef par_option **PAR_OPTLIST; /* PAR_OPTLIST is the basic type now */
54 
55 /* Function definitions */
56 
57 void ParAdd(par_option*** optlist, char option, const char* string);
58 void ParFree(par_option*** optlist);
59 
60 int ParPresent(par_option** optlist, char option);
61 int ParValid(par_option** optlist, char option);
62 const char* ParString(par_option** optlist, char option);
63 long ParValue(par_option** optlist, char option);
64 
65 int ParCommand(int argc, char** argv, CMD_DESCRIPTOR* cmdlist);
66 
67 #ifdef __cplusplus
68 };
69 #endif
70 
71 #endif /* KSM_PARSER_H */
int valid
Definition: parser.h:50
char option
Definition: parser.h:46
par_option ** PAR_OPTLIST
Definition: parser.h:53
long value
Definition: parser.h:49
int ParPresent(par_option **optlist, char option)
long ParValue(par_option **optlist, char option)
char * string
Definition: parser.h:47
void ParAdd(par_option ***optlist, char option, const char *string)
int ParCommand(int argc, char **argv, CMD_DESCRIPTOR *cmdlist)
const char * ParString(par_option **optlist, char option)
int ParValid(par_option **optlist, char option)
void ParFree(par_option ***optlist)