xref: /titanic_51/usr/src/cmd/logadm/opts.h (revision 7c478bd95313f5f23a4c958a745db2134aa03244)
1*7c478bd9Sstevel@tonic-gate /*
2*7c478bd9Sstevel@tonic-gate  * CDDL HEADER START
3*7c478bd9Sstevel@tonic-gate  *
4*7c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*7c478bd9Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*7c478bd9Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*7c478bd9Sstevel@tonic-gate  * with the License.
8*7c478bd9Sstevel@tonic-gate  *
9*7c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*7c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*7c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*7c478bd9Sstevel@tonic-gate  * and limitations under the License.
13*7c478bd9Sstevel@tonic-gate  *
14*7c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*7c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*7c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*7c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*7c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*7c478bd9Sstevel@tonic-gate  *
20*7c478bd9Sstevel@tonic-gate  * CDDL HEADER END
21*7c478bd9Sstevel@tonic-gate  */
22*7c478bd9Sstevel@tonic-gate /*
23*7c478bd9Sstevel@tonic-gate  * Copyright (c) 2001 by Sun Microsystems, Inc.
24*7c478bd9Sstevel@tonic-gate  * All rights reserved.
25*7c478bd9Sstevel@tonic-gate  *
26*7c478bd9Sstevel@tonic-gate  * logadm/opts.h -- public definitions for opts module
27*7c478bd9Sstevel@tonic-gate  */
28*7c478bd9Sstevel@tonic-gate 
29*7c478bd9Sstevel@tonic-gate #ifndef	_LOGADM_OPTS_H
30*7c478bd9Sstevel@tonic-gate #define	_LOGADM_OPTS_H
31*7c478bd9Sstevel@tonic-gate 
32*7c478bd9Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
33*7c478bd9Sstevel@tonic-gate 
34*7c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
35*7c478bd9Sstevel@tonic-gate extern "C" {
36*7c478bd9Sstevel@tonic-gate #endif
37*7c478bd9Sstevel@tonic-gate 
38*7c478bd9Sstevel@tonic-gate /* various types of options we allow */
39*7c478bd9Sstevel@tonic-gate enum opttype {
40*7c478bd9Sstevel@tonic-gate 	OPTTYPE_BOOLEAN,	/* simple boolean flag */
41*7c478bd9Sstevel@tonic-gate 	OPTTYPE_INT,		/* simple number */
42*7c478bd9Sstevel@tonic-gate 	OPTTYPE_STRING		/* string (like a pathname) */
43*7c478bd9Sstevel@tonic-gate };
44*7c478bd9Sstevel@tonic-gate 
45*7c478bd9Sstevel@tonic-gate struct opts;
46*7c478bd9Sstevel@tonic-gate 
47*7c478bd9Sstevel@tonic-gate /* info that drives option parsing (table of these is passed to opts_init()) */
48*7c478bd9Sstevel@tonic-gate struct optinfo {
49*7c478bd9Sstevel@tonic-gate 	char *oi_o;	/* the option */
50*7c478bd9Sstevel@tonic-gate 	enum opttype oi_t;	/* the type of this option */
51*7c478bd9Sstevel@tonic-gate 	/* parser, if set, is called to parse optarg */
52*7c478bd9Sstevel@tonic-gate 	int (*oi_parser)(const char *o, const char *optarg);
53*7c478bd9Sstevel@tonic-gate 	int oi_flags;
54*7c478bd9Sstevel@tonic-gate };
55*7c478bd9Sstevel@tonic-gate 
56*7c478bd9Sstevel@tonic-gate /* flags for struct optinfo */
57*7c478bd9Sstevel@tonic-gate #define	OPTF_CLI	1
58*7c478bd9Sstevel@tonic-gate #define	OPTF_CONF	2
59*7c478bd9Sstevel@tonic-gate 
60*7c478bd9Sstevel@tonic-gate void opts_init(struct optinfo *table, int numentries);
61*7c478bd9Sstevel@tonic-gate struct opts *opts_parse(char **args, int flags);
62*7c478bd9Sstevel@tonic-gate void opts_free(struct opts *opts);
63*7c478bd9Sstevel@tonic-gate void opts_set(struct opts *opts, const char *o, const char *optarg);
64*7c478bd9Sstevel@tonic-gate int opts_count(struct opts *opts, const char *options);
65*7c478bd9Sstevel@tonic-gate const char *opts_optarg(struct opts *opts, const char *o);
66*7c478bd9Sstevel@tonic-gate int opts_optarg_int(struct opts *opts, const char *o);
67*7c478bd9Sstevel@tonic-gate struct fn_list *opts_cmdargs(struct opts *opts);
68*7c478bd9Sstevel@tonic-gate struct opts *opts_merge(struct opts *back, struct opts *front);
69*7c478bd9Sstevel@tonic-gate 
70*7c478bd9Sstevel@tonic-gate #define	OPTP_NOW (-1)
71*7c478bd9Sstevel@tonic-gate #define	OPTP_NEVER (-2)
72*7c478bd9Sstevel@tonic-gate 
73*7c478bd9Sstevel@tonic-gate int opts_parse_ctime(const char *o, const char *optarg);
74*7c478bd9Sstevel@tonic-gate int opts_parse_bytes(const char *o, const char *optarg);
75*7c478bd9Sstevel@tonic-gate int opts_parse_atopi(const char *o, const char *optarg);
76*7c478bd9Sstevel@tonic-gate int opts_parse_seconds(const char *o, const char *optarg);
77*7c478bd9Sstevel@tonic-gate 
78*7c478bd9Sstevel@tonic-gate void opts_print(struct opts *opts, FILE *stream, char *exclude);
79*7c478bd9Sstevel@tonic-gate void opts_printword(const char *word, FILE *stream);
80*7c478bd9Sstevel@tonic-gate 
81*7c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
82*7c478bd9Sstevel@tonic-gate }
83*7c478bd9Sstevel@tonic-gate #endif
84*7c478bd9Sstevel@tonic-gate 
85*7c478bd9Sstevel@tonic-gate #endif	/* _LOGADM_OPTS_H */
86