xref: /illumos-gate/usr/src/tools/ctf/stabs/common/forth.h (revision 69a119caa6570c7077699161b7c28b6ee9f8b0f4)
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 2002 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _FORTH_H
28 #define	_FORTH_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 #include "ctfstabs.h"
37 
38 /*
39  * The macros emitted for structs/unions and enums differ, but their
40  * formatting in the input file and construction method is roughly the same.
41  * If any of the ops return -1, the remainder of the type being processed is
42  * skipped, and an error is signaled to the main portion of ctfstabs.
43  */
44 typedef struct fth_type_ops {
45 	/*
46 	 * Called to start a definition.
47 	 */
48 	int (*fto_header)(ctf_id_t);
49 
50 	/*
51 	 * When a specific-member request for a struct or union type is
52 	 * encountered, this op will be invoked for each requested member.
53 	 */
54 	int (*fto_members)(char *, char *);
55 
56 	/*
57 	 * Invoked when the current open definition is to be finished.
58 	 */
59 	int (*fto_trailer)(void);
60 } fth_type_ops_t;
61 
62 /* forth.c */
63 extern char *fth_curtype;
64 
65 /* fth_struct.c */
66 extern fth_type_ops_t fth_enum_ops;
67 extern fth_type_ops_t fth_struct_ops;
68 
69 #ifdef __cplusplus
70 }
71 #endif
72 
73 #endif /* _FORTH_H */
74