autodoc/source/parser/cpp/pe_enum.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: pe_enum.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ADC_CPP_PE_ENUM_HXX
  32 #define ADC_CPP_PE_ENUM_HXX
  33
  34
  35
  36
  37 // USED SERVICES
  38     // BASE CLASSES
  39 #include "cpp_pe.hxx"
  40     // COMPONENTS
  41 #include <semantic/callf.hxx>
  42 #include <semantic/sub_peu.hxx>
  43     // PARAMETERS
  44 // #include "all_toks.hxx"
  45
  46
  47 namespace cpp {
  48
  49
  50 class PE_EnumValue;
  51
  52 class PE_Enum : public cpp::Cpp_PE
  53 {
  54   public:
  55     enum E_State
  56     {
  57         expectName,             /// after "enum"
  58         gotName,                /// after name, before : or {
  59         bodyStd,                        /// after {
  60         afterBlock,         /// after ending }
  61         size_of_states
  62     };
  63
  64     enum E_KindOfResult
  65     {
  66         is_declaration,                 // normal
  67         is_implicit_declaration,    // like in: enum Abc { rot, gelb, blau } aAbc;
  68         is_qualified_typename           // like in: enum Abc * fx();
  69
  70     };
  71                         PE_Enum(
  72                             Cpp_PE *                    i_pParent );
  73                         ~PE_Enum();
  74
  75     virtual void                Call_Handler(
  76                             const cpp::Token &  i_rTok );
  77
  78     E_KindOfResult              Result_KindOf() const;
  79     const String  &             Result_LocalName() const;
  80     const String  &             Result_FirstNameSegment() const;
  81
  82   private:
  83     typedef SubPe< PE_Enum, PE_EnumValue >              SP_EnumValue;
  84     typedef SubPeUse< PE_Enum, PE_EnumValue>    SPU_EnumValue;
  85
  86     void                                Setup_StatusFunctions();
  87     virtual void                InitData();
  88     virtual void                TransferData();
  89     void                                Hdl_SyntaxError( const char *);
  90
  91     void                                On_expectName_Identifier( const char * );
  92     void                                On_expectName_SwBracket_Left( const char * );
  93
  94     void                                On_gotName_SwBracket_Left( const char * );
  95     void                On_gotName_Return2Type( const char * );
  96
  97     void                                On_bodyStd_Identifier( const char * );
  98     void                                On_bodyStd_SwBracket_Right( const char * );
  99
 100     void                                On_afterBlock_Semicolon( const char * );
 101     void                                On_afterBlock_Return2Type( const char * );
 102
 103     // DATA
 104     Dyn< PeStatusArray<PE_Enum> >
 105                         pStati;
 106     Dyn<SP_EnumValue>   pSpValue;
 107     Dyn<SPU_EnumValue>  pSpuValue;
 108
 109     String              sLocalName;
 110     ary::cpp::Enum *    pCurObject;
 111
 112     E_KindOfResult              eResult_KindOf;
 113 };
 114
 115
 116
 117 // IMPLEMENTATION
 118 inline PE_Enum::E_KindOfResult
 119 PE_Enum::Result_KindOf() const
 120 {
 121     return eResult_KindOf;
 122 }
 123
 124 inline const String  &
 125 PE_Enum::Result_LocalName() const
 126 {
 127     return sLocalName;
 128 }
 129
 130 inline const String  &
 131 PE_Enum::Result_FirstNameSegment() const
 132 {
 133     return sLocalName;
 134 }
 135
 136
 137 }   // namespace cpp
 138
 139
 140 #endif
 141