summaryrefslogtreecommitdiff
path: root/autodoc/source/parser/cpp/pe_class.hxx
blob: 86b13d5b415ae3be2834040630b966547a0bdaeb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: pe_class.hxx,v $
 * $Revision: 1.4 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef ADC_CPP_PE_CLASS_HXX
#define ADC_CPP_PE_CLASS_HXX



// USED SERVICES
    // BASE CLASSES
#include "cpp_pe.hxx"
    // OTHER
#include <semantic/callf.hxx>
#include <semantic/sub_peu.hxx>
#include <ary/cpp/c_types4cpp.hxx>
#include <ary/cpp/c_slntry.hxx>
#include "all_toks.hxx"

namespace ary
{
namespace cpp
{
    class Class;
}
}


namespace cpp
{


using ary::cpp::E_Protection;
using ary::cpp::E_Virtuality;


class PE_Base;
class PE_Enum;
class PE_Typedef;
class PE_VarFunc;
class PE_Ignore;
class PE_Defines;


class PE_Class : public cpp::Cpp_PE
{
  public:
    enum E_State
    {
        start,              /// before class, struct or union
        expectName,         /// after class, struct or union
        gotName,            /// after name, before : or {
        bodyStd,            /// after {
        inProtection,       /// after public, protected or private and before ":"
        afterDecl,          /// after ending }
        size_of_states
    };

    enum E_KindOfResult
    {
        is_declaration,             // normal
        is_implicit_declaration,    // like in: class Abc { public int n; } aAbc;
        is_predeclaration,          // like:    class Abc;
        is_qualified_typename       // like in: class Abc * fx();

    };

                        PE_Class(
                            Cpp_PE *            i_pParent );
                        ~PE_Class();

    virtual void        Call_Handler(
                            const cpp::Token &  i_rTok );
    virtual Cpp_PE *    Handle_ChildFailure();

    E_KindOfResult      Result_KindOf() const;
    const String  &     Result_LocalName() const;
    const String  &     Result_FirstNameSegment() const;

  private:
    typedef SubPe< PE_Class, PE_Base >          SP_Base;
//  typedef SubPe< PE_Class, PE_Enum>           SP_Enum;
    typedef SubPe< PE_Class, PE_Typedef>        SP_Typedef;
    typedef SubPe< PE_Class, PE_VarFunc>        SP_VarFunc;
    typedef SubPe< PE_Class, PE_Ignore >        SP_Ignore;
    typedef SubPe< PE_Class, PE_Defines>        SP_Defines;

    typedef SubPeUse< PE_Class, PE_Base>        SPU_Base;
//  typedef SubPeUse< PE_Class, PE_Enum>            SPU_Enum;
    typedef SubPeUse< PE_Class, PE_Typedef>     SPU_Typedef;
    typedef SubPeUse< PE_Class, PE_VarFunc>     SPU_VarFunc;
    typedef SubPeUse< PE_Class, PE_Ignore>      SPU_Ignore;
    typedef SubPeUse< PE_Class, PE_Defines>     SPU_Defines;

    typedef ary::cpp::List_Bases                BaseList;
    typedef ary::cpp::S_Classes_Base            Base;
    typedef ary::cpp::E_Protection              E_Protection;

    void                Setup_StatusFunctions();
    virtual void        InitData();
    virtual void        TransferData();
    void                Hdl_SyntaxError( const char *);
    void                Init_CurObject();

    void                SpReturn_Base();

    void                On_start_class( const char * );
    void                On_start_struct( const char * );
    void                On_start_union( const char * );

    void                On_expectName_Identifier( const char * );
    void                On_expectName_SwBracket_Left( const char * );
    void                On_expectName_Colon( const char * );

    void                On_gotName_SwBracket_Left( const char * );
    void                On_gotName_Semicolon( const char * );
    void                On_gotName_Colon( const char * );
    void                On_gotName_Return2Type( const char * );

    void                On_bodyStd_VarFunc( const char * );
    void                On_bodyStd_ClassKey( const char * );
    void                On_bodyStd_enum( const char * );
    void                On_bodyStd_typedef( const char * );
    void                On_bodyStd_public( const char * );
    void                On_bodyStd_protected( const char * );
    void                On_bodyStd_private( const char * );
    void                On_bodyStd_template( const char * );
    void                On_bodyStd_friend( const char * );
    void                On_bodyStd_using( const char * );
    void                On_bodyStd_SwBracket_Right( const char * );
    void                On_bodyStd_DefineName(const char * );
    void                On_bodyStd_MacroName(const char * );

    void                On_inProtection_Colon( const char * );

    void                On_afterDecl_Semicolon( const char * );
    void                On_afterDecl_Return2Type( const char * );

    // DATA
    Dyn< PeStatusArray<PE_Class> >
                        pStati;

    Dyn<SP_Base>        pSpBase;
//  Dyn<SP_Enum>        pSpEnum;
    Dyn<SP_Typedef>     pSpTypedef;
    Dyn<SP_VarFunc>     pSpVarFunc;
    Dyn<SP_Ignore>      pSpIgnore;
    Dyn<SP_Defines>     pSpDefs;

    Dyn<SPU_Base>       pSpuBase;
//  Dyn<SPU_Enum>       pSpuEnum;
    Dyn<SPU_Typedef>    pSpuTypedef;
    Dyn<SPU_VarFunc>    pSpuVarFunc;

    Dyn<SPU_Ignore>     pSpuTemplate;
    Dyn<SPU_Ignore>     pSpuUsing;
    Dyn<SPU_Ignore>     pSpuIgnoreFailure;
    Dyn<SPU_Defines>    pSpuDefs;



    String              sLocalName;
    ary::cpp::E_ClassKey
                        eClassKey;
    ary::cpp::Class *   pCurObject;
    BaseList            aBases;

    E_KindOfResult      eResult_KindOf;
};



// IMPLEMENTATION

inline PE_Class::E_KindOfResult
PE_Class::Result_KindOf() const
{
    return eResult_KindOf;
}

inline const String  &
PE_Class::Result_LocalName() const
{
    return sLocalName;
}

inline const String  &
PE_Class::Result_FirstNameSegment() const
{
    return sLocalName;
}




}   // namespace cpp


#if 0   // Branches

class struct union
    -> Class
    -> Predeclaration

typedef
    -> Typedef

enum
    -> Enum

TypeDeclaration
    -> Function In Class
    -> Variable

public, protected, private
    -> Protection declaration

friend
    ->  Friend Class
    ->  Friend Function

virtual
    -> Function In Class

using
    -> Using Declaration


#endif // 0


#endif