autodoc/source/parser/cpp/pe_param.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_param.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
  32 #ifndef ADC_CPP_PE_PARAM_HXX
  33 #define ADC_CPP_PE_PARAM_HXX
  34
  35 // BASE CLASSES
  36 #include "cpp_pe.hxx"
  37 // USED SERVICES
  38 #include <semantic/callf.hxx>
  39 #include <semantic/sub_peu.hxx>
  40 #include <ary/cpp/c_vfflag.hxx>
  41
  42
  43
  44
  45 namespace cpp
  46 {
  47     class PE_Type;
  48     class PE_Variable;
  49
  50
  51
  52
  53 class PE_Parameter : public Cpp_PE
  54 {
  55   public:
  56     enum E_State
  57     {
  58         start,
  59         expectName,
  60         afterName,
  61         finished,
  62         size_of_states
  63     };
  64     typedef ary::cpp::S_Parameter       S_ParamInfo;
  65
  66     explicit                    PE_Parameter(
  67                             Cpp_PE *                    i_pParent );
  68                         ~PE_Parameter();
  69
  70     virtual void                Call_Handler(
  71                             const cpp::Token &  i_rTok );
  72
  73     ary::cpp::Type_id   Result_FrontType() const;
  74     const S_ParamInfo & Result_ParamInfo() const;
  75
  76   private:
  77     typedef SubPe< PE_Parameter, PE_Type >                  SP_Type;
  78     typedef SubPeUse< PE_Parameter, PE_Type >           SPU_Type;
  79     typedef SubPe< PE_Parameter, PE_Variable >      SP_Variable;
  80     typedef SubPeUse< PE_Parameter, PE_Variable >       SPU_Variable;
  81
  82     void                                Setup_StatusFunctions();
  83     virtual void                InitData();
  84     virtual void                TransferData();
  85     void                                Hdl_SyntaxError( const char *);
  86
  87     void                                SpInit_Type();       // Type and Ignore.
  88     void                                SpInit_Variable();
  89     void                                SpReturn_Type();
  90     void                                SpReturn_Variable();
  91
  92     void                                On_start_Type(const char * i_sText);
  93     void                                On_start_Bracket_Right(const char * i_sText);
  94     void                On_start_Ellipse(const char * i_sText);
  95
  96     void                                On_expectName_Identifier(const char * i_sText);
  97     void                                On_expectName_ArrayBracket_Left(const char * i_sText);
  98     void                                On_expectName_Bracket_Right(const char * i_sText);
  99     void                                On_expectName_Comma(const char * i_sText);
 100
 101     void                                On_afterName_ArrayBracket_Left(const char * i_sText);
 102     void                                On_afterName_Bracket_Right(const char * i_sText);
 103     void                                On_afterName_Comma(const char * i_sText);
 104     void                                On_afterName_Assign(const char * i_sText);
 105
 106     void                                On_finished_Bracket_Right(const char * i_sText);
 107     void                                On_finished_Comma(const char * i_sText);
 108
 109     // DATA
 110     Dyn< PeStatusArray<PE_Parameter> >
 111                         pStati;
 112
 113     Dyn<SP_Type>            pSpType;
 114     Dyn<SPU_Type>               pSpuType;
 115     Dyn<SP_Variable>    pSpVariable;
 116     Dyn<SPU_Variable>   pSpuVariable;
 117
 118     S_ParamInfo         aResultParamInfo;
 119 };
 120
 121
 122
 123
 124 // IMPLEMENTATION
 125 inline ary::cpp::Type_id
 126 PE_Parameter::Result_FrontType() const
 127 {
 128     return aResultParamInfo.nType;
 129 }
 130
 131 inline const PE_Parameter::S_ParamInfo &
 132 PE_Parameter::Result_ParamInfo() const
 133 {
 134     return aResultParamInfo;
 135 }
 136
 137
 138
 139
 140 }   // namespace cpp
 141 #endif