xref: /illumos-gate/usr/src/lib/libfru/libfru/Parser.h (revision 7c478bd9)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright (c) 2000-2001 by Sun Microsystems, Inc.
24  * All rights reserved.
25  */
26 
27 #ifndef	_PARSER_H
28 #define	_PARSER_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 #ifdef	__cplusplus
37 }
38 #endif
39 
40 #include "fru_tag.h"
41 #include "libfrureg.h"
42 #include "Ancestor.h"
43 
44 struct PathDef
45 {
46 	fru_regdef_t *def;
47 	static const int lastIteration = -1;
48 	static const int addIteration = -2;
49 	int iterIndex; // index of the iteration. (or special)
50 			// -1 if '$' specified.
51 			// -2 if '+' specified.
52 	PathDef *next;
53 
~PathDefPathDef54 	~PathDef() { delete next; }
55 };
56 
57 // returns the top PathData object.
58 // and a NULL terminated list of Ancestor objects.
59 // USER MUST delete the PathDef and Ancestor returned.
60 fru_errno_t fru_field_parser(const char *path, Ancestor **ancestors,
61 				int *absolute, PathDef **pathDef);
62 
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
66 
67 #ifdef	__cplusplus
68 }
69 #endif
70 
71 #endif /* _PARSER_H */
72