xref: /illumos-gate/usr/src/lib/libsmbfs/cflib.h (revision b4a8b33babbf9a7a5de61ea06d09e1eb537f1f6e)
1 /*
2  * Copyright (c) 2000, Boris Popov
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *    This product includes software developed by Boris Popov.
16  * 4. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * $Id: cflib.h,v 1.1.1.1 2001/06/09 00:28:11 zarzycki Exp $
33  */
34 
35 /*
36  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
37  * Use is subject to license terms.
38  *
39  * Copyright 2018 Nexenta Systems, Inc.  All rights reserved.
40  */
41 
42 #ifndef _CFLIB_H_
43 #define	_CFLIB_H_
44 
45 struct rcfile;
46 
47 /*
48  * A unified options parser
49  */
50 enum opt_argtype {OPTARG_STR, OPTARG_INT, OPTARG_BOOL};
51 
52 struct opt_args;
53 
54 typedef int opt_callback_t (struct opt_args *);
55 
56 #define	OPTFL_NONE	0x0000
57 #define	OPTFL_HAVEMIN	0x0001
58 #define	OPTFL_HAVEMAX	0x0002
59 #define	OPTFL_MINMAX	NAFL_HAVEMIN | NAFL_HAVEMAX
60 
61 struct opt_args {
62 	enum opt_argtype type;
63 	int	opt;		/* command line option */
64 	char	*name;		/* rc file equiv */
65 	int	flag;		/* OPTFL_* */
66 	int	ival;		/* int/bool values, or max len for str value */
67 	char	*str;		/* string value */
68 	int	min;		/* min for ival */
69 	int	max;		/* max for ival */
70 	opt_callback_t *fn;	/* call back to validate */
71 };
72 typedef struct opt_args opt_args_t;
73 
74 extern int cf_opterr, cf_optind, cf_optopt, cf_optreset;
75 extern const char *cf_optarg;
76 extern struct rcfile *smb_rc;
77 
78 #ifdef __cplusplus
79 extern "C" {
80 #endif
81 
82 int  opt_args_parse(struct rcfile *, struct opt_args *, const char *,
83 	opt_callback_t *);
84 int  opt_args_parseopt(struct opt_args *, int, char *, opt_callback_t *);
85 
86 int  cf_getopt(int, char * const *, const char *);
87 void cf_opt_lock(void);
88 void cf_opt_unlock(void);
89 
90 char *cf_get_client_uuid(void);
91 
92 int  rc_getstringptr(struct rcfile *, const char *, const char *, char **);
93 int  rc_getstring(struct rcfile *, const char *, const char *, size_t, char *);
94 int  rc_getint(struct rcfile *, const char *, const char *, int *);
95 int  rc_getbool(struct rcfile *, const char *, const char *, int *);
96 
97 int smb_open_rcfile(char *);
98 void smb_close_rcfile(void);
99 
100 #ifdef __cplusplus
101 }
102 #endif
103 
104 #endif	/* _CFLIB_H_ */
105