xref: /illumos-gate/usr/src/lib/libfru/libfru/Parser.h (revision 1da57d55)
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 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 #ifdef	__cplusplus
35 }
36 #endif
37 
38 #include "fru_tag.h"
39 #include "libfrureg.h"
40 #include "Ancestor.h"
41 
42 struct PathDef
43 {
44 	fru_regdef_t *def;
45 	static const int lastIteration = -1;
46 	static const int addIteration = -2;
47 	int iterIndex; // index of the iteration. (or special)
48 			// -1 if '$' specified.
49 			// -2 if '+' specified.
50 	PathDef *next;
51 
~PathDefPathDef52 	~PathDef() { delete next; }
53 };
54 
55 // returns the top PathData object.
56 // and a NULL terminated list of Ancestor objects.
57 // USER MUST delete the PathDef and Ancestor returned.
58 fru_errno_t fru_field_parser(const char *path, Ancestor **ancestors,
59 				int *absolute, PathDef **pathDef);
60 
61 #ifdef __cplusplus
62 extern "C" {
63 #endif
64 
65 #ifdef	__cplusplus
66 }
67 #endif
68 
69 #endif /* _PARSER_H */
70