xref: /trunk/main/autodoc/source/parser/inc/tokens/stmstate.hxx (revision 1c78a5d6c0093dece4c096ba53051800fbad6e33)
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_STMSTATE_HXX
25cdf0e10cSrcweir #define ADC_STMSTATE_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir // USED SERVICES
28cdf0e10cSrcweir     // BASE CLASSES
29cdf0e10cSrcweir     // COMPONENTS
30cdf0e10cSrcweir     // PARAMETERS
31cdf0e10cSrcweir class StmArrayStatus;
32cdf0e10cSrcweir class StmBoundsStatus;
33cdf0e10cSrcweir 
34cdf0e10cSrcweir /** A StmStatus is a state within a StateMachine.
35cdf0e10cSrcweir     There are two kinds of it.  Either its an array of pointers to
36cdf0e10cSrcweir     other states within the state machine - an ArrayStatus.
37cdf0e10cSrcweir 
38cdf0e10cSrcweir     Or it is a BoundsStatus, which shows, the token cannot be
39cdf0e10cSrcweir     followed further within the StateMachine.
40cdf0e10cSrcweir **/
41cdf0e10cSrcweir class StmStatus // := "State machine status"
42cdf0e10cSrcweir {
43cdf0e10cSrcweir   public:
44cdf0e10cSrcweir     typedef intt        Branch;         /// Values >= 0 give a next #Status' ID.
45cdf0e10cSrcweir                                         /// Values <= 0 tell, that a token is finished.
46cdf0e10cSrcweir                                         /// a value < 0 returns the status back to an upper level state machine.
47cdf0e10cSrcweir         // LIFECYCLE
48cdf0e10cSrcweir     virtual             ~StmStatus() {}
49cdf0e10cSrcweir 
50cdf0e10cSrcweir         // OPERATIONS
51cdf0e10cSrcweir     virtual StmArrayStatus *
52cdf0e10cSrcweir                         AsArray();
53cdf0e10cSrcweir     virtual StmBoundsStatus *
54cdf0e10cSrcweir                         AsBounds();
55cdf0e10cSrcweir 
56cdf0e10cSrcweir         // INQUIRY
57cdf0e10cSrcweir     virtual bool        IsADefault() const = 0;
58cdf0e10cSrcweir };
59cdf0e10cSrcweir 
60cdf0e10cSrcweir 
61cdf0e10cSrcweir 
62cdf0e10cSrcweir #endif
63cdf0e10cSrcweir 
64cdf0e10cSrcweir 
65