autodoc/source/parser/inc/adoc/cx_a_std.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_a_std.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_ADOC_CX_A_STD_HXX
  32 #define ADC_ADOC_CX_A_STD_HXX
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36 #include <tokens/tkpcontx.hxx>
  37     // COMPONENTS
  38 #include <tokens/tkpstama.hxx>
  39     // PARAMETERS
  40
  41 class TextToken;
  42
  43
  44 namespace adoc {
  45
  46 class Cx_LineStart;
  47 class Cx_CheckStar;
  48 class Cx_AtTagCompletion;
  49
  50
  51 /**
  52 @descr
  53 */
  54 class Context_AdocStd : public autodoc::TkpDocuContext,
  55                         private StateMachineContext
  56 {
  57   public:
  58     //  LIFECYCLE
  59                         Context_AdocStd();
  60     virtual void                SetParentContext(
  61                             TkpContext &                io_rParentContext,
  62                             const char *                i_sMultiLineEndToken );
  63                         ~Context_AdocStd();
  64
  65     //  OPERATIONS
  66     virtual void                AssignDealer(
  67                             TokenDealer &               o_rDealer );
  68
  69     virtual void                ReadCharChain(
  70                             CharacterSource &   io_rText );
  71     virtual bool                PassNewToken();
  72     virtual void                SetMode_IsMultiLine(
  73                             bool                                i_bTrue );
  74     //  INQUIRY
  75     virtual TkpContext &
  76                         FollowUpContext();
  77   private:
  78     //  SERVICE FUNCTIONS
  79     virtual     void            PerformStatusFunction(
  80                             uintt                               i_nStatusSignal,
  81                             F_CRTOK                     i_fTokenCreateFunction,
  82                             CharacterSource &   io_rText );
  83
  84     void                                SetupStateMachine();
  85
  86     //  DATA
  87     StateMachine                aStateMachine;
  88     TokenDealer *               pDealer;
  89
  90         // Contexts
  91     TkpContext *        pParentContext;
  92     TkpContext *                pFollowUpContext;
  93     Dyn<Cx_LineStart>   pCx_LineStart;
  94     Dyn<Cx_CheckStar>   pCx_CheckStar;
  95     Dyn<Cx_AtTagCompletion>
  96                         pCx_AtTagCompletion;
  97
  98         // Temporary data, used during ReadCharChain()
  99     Dyn<TextToken>              pNewToken;
 100     bool                bIsMultiline;
 101 };
 102
 103
 104 }   // namespace adoc
 105
 106
 107 #endif
 108