Add GNU LGPL headers to all .c .C and .h files
[oweals/cde.git] / cde / programs / dtappbuilder / src / abmf / parse_cP.h
1 /*
2  * CDE - Common Desktop Environment
3  *
4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
5  *
6  * These libraries and programs are free software; you can
7  * redistribute them and/or modify them under the terms of the GNU
8  * Lesser General Public License as published by the Free Software
9  * Foundation; either version 2 of the License, or (at your option)
10  * any later version.
11  *
12  * These libraries and programs are distributed in the hope that
13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15  * PURPOSE. See the GNU Lesser General Public License for more
16  * details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with these librararies and programs; if not, write
20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
21  * Floor, Boston, MA 02110-1301 USA
22  */
23
24 /*
25  *      $XConsortium: parse_cP.h /main/3 1995/11/06 18:11:57 rswiston $
26  *
27  *      @(#)parse_cP.h  1.5 13 Sep 1994 cde_app_builder/src/abmf
28  *
29  *      RESTRICTED CONFIDENTIAL INFORMATION:
30  *      
31  *      The information in this document is subject to special
32  *      restrictions in a confidential disclosure agreement between
33  *      HP, IBM, Sun, USL, SCO and Univel.  Do not distribute this
34  *      document outside HP, IBM, Sun, USL, SCO, or Univel without
35  *      Sun's specific written approval.  This document and all copies
36  *      and derivative works thereof must be returned or destroyed at
37  *      Sun's request.
38  *
39  *      Copyright 1993 Sun Microsystems, Inc.  All rights reserved.
40  *
41  */
42
43 /*
44  * parse_cP.h
45  *
46  * Parses a C file into "segments" to help determine what changes the
47  * user has made.
48  */
49 #ifndef _ABMF_PARSE_CP_H_
50 #define _ABMF_PARSE_CP_H_
51
52 #include "abmfP.h"
53
54 #define MAX_USER_SEGS_PER_CSEG 10
55
56 typedef enum
57 {
58     CSEG_UNDEF = 0,
59     CSEG_AGGREGATE_TYPE,
60     CSEG_AGGREGATE_VAR,
61     CSEG_COMMENT,
62     CSEG_FUNC,
63     CSEG_GLOBAL,
64     CSEG_TYPE_NUM_VALUES        /* must be last */
65 } CSEG_TYPE;
66
67 typedef struct C_USER_SEG_REC
68 {
69     long                line;
70     long                offset;
71     long                length;
72     STRING              text;
73     struct C_USER_SEG_REC       *next;          /* next userseg, bypasses segments */
74     void                *clientData;
75 } CUserSegRec, *CUserSeg;
76
77 typedef struct /* this struct tag is here as a test */ C_USER_SEGS_REG
78 {
79     int         numSegs;
80     CUserSegRec segs[MAX_USER_SEGS_PER_CSEG];
81 } CUserSegsRec, *CUserSegs;
82
83
84 typedef struct
85 {
86     CSEG_TYPE           type;
87     STRING              name;           /* type or func name */
88     long                offset;
89     long                length;
90
91     /* these fields may be NULL */
92     STRING              text;           /* actual text from file */
93     STRING              declaration;
94     int                 numUserSegs;
95     CUserSegsRec        userSegs;
96     void                *clientData;    /* client controls this */
97 } CSegRec, *CSeg;
98
99 typedef struct
100 {
101     int                 numSegs;
102     CSeg                segs;
103     CUserSeg            firstUserSeg;
104 } CSegArrayRec, *CSegArray;
105
106
107 int     abmfP_parse_c_file(FILE *c_file, CSegArray *segmentsOut);
108
109 CSegArray       cseg_array_create(void);
110 int             cseg_array_destroy(CSegArray);
111
112
113 /*
114  * Private symbols
115  */
116 #define cseg_array_destroy(array) (cseg_arrayP_destroy_impl(&(array)))
117 int             cseg_arrayP_destroy_impl(CSegArray *);
118
119 #endif /* _ABMF_PARSE_CP_H_ */