autodoc/source/parser/cpp/cpp_pe.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: cpp_pe.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_CPP_PE_HXX
  32 #define ADC_CPP_CPP_PE_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <semantic/parseenv.hxx>
  39 #include "tokintpr.hxx"
  40     // COMPONENTS
  41 #include "pev.hxx"
  42     // PARAMETERS
  43 #include <ary/cpp/c_types4cpp.hxx>
  44
  45
  46 namespace cpp {
  47
  48 class Cpp_PE : public ::ParseEnvironment,
  49                public TokenInterpreter
  50 {
  51   public:
  52     typedef cpp::PeEnvironment  EnvData;
  53
  54     void                                SetTokenResult(
  55                             E_TokenDone                 i_eDone,
  56                             E_EnvStackAction    i_eWhat2DoWithEnvStack,
  57                             ParseEnvironment *  i_pParseEnv2Push = 0 );
  58
  59     virtual Cpp_PE *    Handle_ChildFailure();  // Defaulted to 0.
  60
  61   protected:
  62                         Cpp_PE(
  63                             Cpp_PE *                    io_pParent );
  64                         Cpp_PE(
  65                             EnvData &                   i_rEnv );
  66
  67     EnvData &                   Env() const;
  68
  69     void                StdHandlingOfSyntaxError(
  70                             const char *        i_sText );
  71
  72   private:
  73     // DATA
  74     EnvData &                   rMyEnv;
  75 };
  76
  77 inline  Cpp_PE::EnvData &
  78 Cpp_PE::Env() const
  79     { return rMyEnv; }
  80
  81 }   // namespace cpp
  82
  83 #endif
  84