xref: /onnv-gate/usr/src/uts/common/sys/kobj_lex.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _SYS_KOBJ_LEX_H
28*0Sstevel@tonic-gate #define	_SYS_KOBJ_LEX_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef	__cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate /*
37*0Sstevel@tonic-gate  * This file contains declarations for lex and its associated functions that
38*0Sstevel@tonic-gate  * are used by the kernel to parse the contents of system files.
39*0Sstevel@tonic-gate  *
40*0Sstevel@tonic-gate  * These lex functions are for a few selected kernel modules that are required
41*0Sstevel@tonic-gate  * to parse contents of file(s) on disk. This file is not for general kernel
42*0Sstevel@tonic-gate  * usage.
43*0Sstevel@tonic-gate  */
44*0Sstevel@tonic-gate 
45*0Sstevel@tonic-gate #define	isunary(ch)	((ch) == '~' || (ch) == '-')
46*0Sstevel@tonic-gate 
47*0Sstevel@tonic-gate #define	iswhite(ch)	((ch) == ' ' || (ch) == '\t')
48*0Sstevel@tonic-gate 
49*0Sstevel@tonic-gate #define	isnewline(ch)	((ch) == '\n' || (ch) == '\r' || (ch) == '\f')
50*0Sstevel@tonic-gate 
51*0Sstevel@tonic-gate #define	isdigit(ch)	((ch) >= '0' && (ch) <= '9')
52*0Sstevel@tonic-gate 
53*0Sstevel@tonic-gate #define	isxdigit(ch)	(isdigit(ch) || ((ch) >= 'a' && (ch) <= 'f') || \
54*0Sstevel@tonic-gate 			((ch) >= 'A' && (ch) <= 'F'))
55*0Sstevel@tonic-gate 
56*0Sstevel@tonic-gate #define	isalpha(ch)	(((ch) >= 'a' && (ch) <= 'z') || \
57*0Sstevel@tonic-gate 			((ch) >= 'A' && (ch) <= 'Z'))
58*0Sstevel@tonic-gate 
59*0Sstevel@tonic-gate #define	isalphanum(ch)	(isalpha(ch) || isdigit(ch))
60*0Sstevel@tonic-gate 
61*0Sstevel@tonic-gate #define	isnamechar(ch)	(isalphanum(ch) || (ch) == '_' || (ch) == '-')
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate typedef enum {
64*0Sstevel@tonic-gate 	EQUALS,
65*0Sstevel@tonic-gate 	AMPERSAND,
66*0Sstevel@tonic-gate 	BIT_OR,
67*0Sstevel@tonic-gate 	STAR,
68*0Sstevel@tonic-gate 	POUND,
69*0Sstevel@tonic-gate 	COLON,
70*0Sstevel@tonic-gate 	SEMICOLON,
71*0Sstevel@tonic-gate 	COMMA,
72*0Sstevel@tonic-gate 	SLASH,
73*0Sstevel@tonic-gate 	WHITE_SPACE,
74*0Sstevel@tonic-gate 	NEWLINE,
75*0Sstevel@tonic-gate 	EOF,
76*0Sstevel@tonic-gate 	STRING,
77*0Sstevel@tonic-gate 	HEXVAL,
78*0Sstevel@tonic-gate 	DECVAL,
79*0Sstevel@tonic-gate 	NAME
80*0Sstevel@tonic-gate } token_t;
81*0Sstevel@tonic-gate 
82*0Sstevel@tonic-gate #ifdef DEBUG
83*0Sstevel@tonic-gate /* string values for token_t */
84*0Sstevel@tonic-gate extern char *tokennames[];
85*0Sstevel@tonic-gate #endif /* DEBUG */
86*0Sstevel@tonic-gate 
87*0Sstevel@tonic-gate /*
88*0Sstevel@tonic-gate  * return 1 with sptr pointing to the string represented by token
89*0Sstevel@tonic-gate  * On error returns NULL. The memory pointed to by sptr should be
90*0Sstevel@tonic-gate  * freed using free_string function.
91*0Sstevel@tonic-gate  */
92*0Sstevel@tonic-gate int kobj_get_string(u_longlong_t *sptr, char *token);
93*0Sstevel@tonic-gate void kobj_free_string(void *ptr, int len);
94*0Sstevel@tonic-gate 
95*0Sstevel@tonic-gate /*
96*0Sstevel@tonic-gate  * returns decimal/octal/hex number in valuep
97*0Sstevel@tonic-gate  * return 0 on success, -1 on failure
98*0Sstevel@tonic-gate  */
99*0Sstevel@tonic-gate int kobj_getvalue(const char *token, u_longlong_t *valuep);
100*0Sstevel@tonic-gate 
101*0Sstevel@tonic-gate /* prints a formated message via cmn_err */
102*0Sstevel@tonic-gate /*PRINTFLIKE3*/
103*0Sstevel@tonic-gate extern void kobj_file_err(int type,  struct _buf *file, char *fmt, ...)
104*0Sstevel@tonic-gate 	__KPRINTFLIKE(3);
105*0Sstevel@tonic-gate 
106*0Sstevel@tonic-gate /*
107*0Sstevel@tonic-gate  * returns the next token in the file on success,
108*0Sstevel@tonic-gate  * return -1 on failure
109*0Sstevel@tonic-gate  */
110*0Sstevel@tonic-gate token_t kobj_lex(struct _buf *file, char *val, size_t size);
111*0Sstevel@tonic-gate 
112*0Sstevel@tonic-gate void kobj_find_eol(struct _buf *file);
113*0Sstevel@tonic-gate 
114*0Sstevel@tonic-gate #ifdef	__cplusplus
115*0Sstevel@tonic-gate }
116*0Sstevel@tonic-gate #endif
117*0Sstevel@tonic-gate 
118*0Sstevel@tonic-gate #endif /* !_SYS_KOBJ_LEX_H */
119