autodoc/source/parser/inc/semantic/parseenv.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: parseenv.hxx,v $
  10  * $Revision: 1.3 $
  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_PARSEENV_HXX
  32 #define ADC_PARSEENV_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <tokens/tokproct.hxx>
  39     // COMPONENTS
  40     // PARAMETERS
  41
  42
  43 namespace ary
  44 {
  45 namespace info
  46 {
  47 class CodeInfo;
  48 }   // namespace info
  49 }   // namespace ary)
  50
  51
  52
  53 class SubPeUseIfc;
  54
  55
  56 class ParseEnvironment : protected TokenProcessing_Types
  57 {
  58   public:
  59     virtual                             ~ParseEnvironment() {}
  60
  61     // Parsing
  62     void                                Enter(
  63                             E_EnvStackAction    i_eWayOfEntering );
  64     void                                Leave(
  65                             E_EnvStackAction    i_eWayOfLeaving );
  66     void                                SetCurSPU(
  67                             const SubPeUseIfc * i_pCurSPU );
  68
  69     ParseEnvironment *  Parent() const;
  70
  71
  72     // ACCESS
  73   protected:
  74                         ParseEnvironment(
  75                             ParseEnvironment *  i_pParent );
  76     const SubPeUseIfc * CurSubPeUse() const;
  77   private:
  78     virtual void                InitData() = 0;
  79     virtual void                TransferData() = 0;
  80
  81     ParseEnvironment *  pParent;
  82     const SubPeUseIfc * pCurSubPe;
  83 };
  84
  85 class SubPeUseIfc
  86 {
  87   public:
  88     virtual                             ~SubPeUseIfc() {}
  89
  90     virtual void                InitParse() const = 0;
  91     virtual void                GetResults() const = 0;
  92 };
  93
  94
  95
  96 // IMPLEMENTATION
  97
  98 inline void
  99 ParseEnvironment::SetCurSPU( const SubPeUseIfc * i_pCurSPU )
 100     { pCurSubPe = i_pCurSPU; }
 101
 102 inline ParseEnvironment *
 103 ParseEnvironment::Parent() const
 104     { return pParent; }
 105
 106 inline const SubPeUseIfc *
 107 ParseEnvironment::CurSubPeUse() const
 108     { return pCurSubPe; }
 109
 110
 111
 112 #endif
 113