xref: /trunk/main/autodoc/source/parser/inc/adoc/cx_a_std.hxx (revision 914d351e5f5b84e4342a86d6ab8d4aca7308b9bd)
1*1c78a5d6SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*1c78a5d6SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*1c78a5d6SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*1c78a5d6SAndrew Rist  * distributed with this work for additional information
6*1c78a5d6SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*1c78a5d6SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*1c78a5d6SAndrew Rist  * "License"); you may not use this file except in compliance
9*1c78a5d6SAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11*1c78a5d6SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13*1c78a5d6SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*1c78a5d6SAndrew Rist  * software distributed under the License is distributed on an
15*1c78a5d6SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*1c78a5d6SAndrew Rist  * KIND, either express or implied.  See the License for the
17*1c78a5d6SAndrew Rist  * specific language governing permissions and limitations
18*1c78a5d6SAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20*1c78a5d6SAndrew Rist  *************************************************************/
21*1c78a5d6SAndrew Rist 
22*1c78a5d6SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef ADC_ADOC_CX_A_STD_HXX
25cdf0e10cSrcweir #define ADC_ADOC_CX_A_STD_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir // USED SERVICES
28cdf0e10cSrcweir     // BASE CLASSES
29cdf0e10cSrcweir #include <tokens/tkpcontx.hxx>
30cdf0e10cSrcweir     // COMPONENTS
31cdf0e10cSrcweir #include <tokens/tkpstama.hxx>
32cdf0e10cSrcweir     // PARAMETERS
33cdf0e10cSrcweir 
34cdf0e10cSrcweir class TextToken;
35cdf0e10cSrcweir 
36cdf0e10cSrcweir 
37cdf0e10cSrcweir namespace adoc {
38cdf0e10cSrcweir 
39cdf0e10cSrcweir class Cx_LineStart;
40cdf0e10cSrcweir class Cx_CheckStar;
41cdf0e10cSrcweir class Cx_AtTagCompletion;
42cdf0e10cSrcweir 
43cdf0e10cSrcweir 
44cdf0e10cSrcweir /**
45cdf0e10cSrcweir @descr
46cdf0e10cSrcweir */
47cdf0e10cSrcweir class Context_AdocStd : public autodoc::TkpDocuContext,
48cdf0e10cSrcweir                         private StateMachineContext
49cdf0e10cSrcweir {
50cdf0e10cSrcweir   public:
51cdf0e10cSrcweir     //  LIFECYCLE
52cdf0e10cSrcweir                         Context_AdocStd();
53cdf0e10cSrcweir     virtual void        SetParentContext(
54cdf0e10cSrcweir                             TkpContext &        io_rParentContext,
55cdf0e10cSrcweir                             const char *        i_sMultiLineEndToken );
56cdf0e10cSrcweir                         ~Context_AdocStd();
57cdf0e10cSrcweir 
58cdf0e10cSrcweir     //  OPERATIONS
59cdf0e10cSrcweir     virtual void        AssignDealer(
60cdf0e10cSrcweir                             TokenDealer &       o_rDealer );
61cdf0e10cSrcweir 
62cdf0e10cSrcweir     virtual void        ReadCharChain(
63cdf0e10cSrcweir                             CharacterSource &   io_rText );
64cdf0e10cSrcweir     virtual bool        PassNewToken();
65cdf0e10cSrcweir     virtual void        SetMode_IsMultiLine(
66cdf0e10cSrcweir                             bool                i_bTrue );
67cdf0e10cSrcweir     //  INQUIRY
68cdf0e10cSrcweir     virtual TkpContext &
69cdf0e10cSrcweir                         FollowUpContext();
70cdf0e10cSrcweir   private:
71cdf0e10cSrcweir     //  SERVICE FUNCTIONS
72cdf0e10cSrcweir     virtual void        PerformStatusFunction(
73cdf0e10cSrcweir                             uintt               i_nStatusSignal,
74cdf0e10cSrcweir                             F_CRTOK             i_fTokenCreateFunction,
75cdf0e10cSrcweir                             CharacterSource &   io_rText );
76cdf0e10cSrcweir 
77cdf0e10cSrcweir     void                SetupStateMachine();
78cdf0e10cSrcweir 
79cdf0e10cSrcweir     //  DATA
80cdf0e10cSrcweir     StateMachine        aStateMachine;
81cdf0e10cSrcweir     TokenDealer *       pDealer;
82cdf0e10cSrcweir 
83cdf0e10cSrcweir         // Contexts
84cdf0e10cSrcweir     TkpContext *        pParentContext;
85cdf0e10cSrcweir     TkpContext *        pFollowUpContext;
86cdf0e10cSrcweir     Dyn<Cx_LineStart>   pCx_LineStart;
87cdf0e10cSrcweir     Dyn<Cx_CheckStar>   pCx_CheckStar;
88cdf0e10cSrcweir     Dyn<Cx_AtTagCompletion>
89cdf0e10cSrcweir                         pCx_AtTagCompletion;
90cdf0e10cSrcweir 
91cdf0e10cSrcweir         // Temporary data, used during ReadCharChain()
92cdf0e10cSrcweir     Dyn<TextToken>      pNewToken;
93cdf0e10cSrcweir     bool                bIsMultiline;
94cdf0e10cSrcweir };
95cdf0e10cSrcweir 
96cdf0e10cSrcweir 
97cdf0e10cSrcweir }   // namespace adoc
98cdf0e10cSrcweir 
99cdf0e10cSrcweir 
100cdf0e10cSrcweir #endif
101