autodoc/source/parser/cpp/cx_base.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: cx_base.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_CPP_CX_BASE_HXX
  32 #define ADC_CPP_CX_BASE_HXX
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36 #include <tokens/tkpcontx.hxx>
  37     // COMPONENTS
  38     // PARAMETERS
  39
  40
  41 class TextToken;
  42
  43
  44 namespace cpp
  45 {
  46
  47 class Distributor;
  48
  49
  50 class Cx_Base : public ::TkpContext
  51 {
  52   public:
  53     virtual bool                PassNewToken();
  54     virtual TkpContext &
  55                         FollowUpContext();
  56
  57     virtual void        AssignDealer(
  58                             Distributor &       o_rDealer );
  59   protected:
  60     // LIFECYCLE
  61                         Cx_Base(
  62                             TkpContext *                io_pFollowUpContext );
  63
  64     void                                SetNewToken(
  65                             DYN ::TextToken *   let_dpToken );
  66     void                                SetFollowUpContext(
  67                             TkpContext  *           io_pContext );
  68
  69     Distributor &       Dealer() const;
  70
  71   private:
  72     // DATA
  73     Distributor *               pDealer;
  74     TkpContext *                pFollowUpContext;
  75     Dyn< ::TextToken >  pNewToken;
  76 };
  77
  78
  79
  80
  81 inline void
  82 Cx_Base::SetNewToken( DYN ::TextToken * let_dpToken )
  83     { pNewToken = let_dpToken; }
  84 inline void
  85 Cx_Base::SetFollowUpContext( TkpContext * io_pContext )
  86     { pFollowUpContext = io_pContext; }
  87 inline Distributor &
  88 Cx_Base::Dealer() const
  89     { csv_assert(pDealer != 0);
  90       return *pDealer; }
  91
  92
  93
  94
  95
  96 } // namespace cpp
  97
  98 #endif
  99