xref: /AOO41X/main/autodoc/source/parser/inc/tokens/stmstate.hxx (revision 1c78a5d6c0093dece4c096ba53051800fbad6e33)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef ADC_STMSTATE_HXX
25 #define ADC_STMSTATE_HXX
26 
27 // USED SERVICES
28     // BASE CLASSES
29     // COMPONENTS
30     // PARAMETERS
31 class StmArrayStatus;
32 class StmBoundsStatus;
33 
34 /** A StmStatus is a state within a StateMachine.
35     There are two kinds of it.  Either its an array of pointers to
36     other states within the state machine - an ArrayStatus.
37 
38     Or it is a BoundsStatus, which shows, the token cannot be
39     followed further within the StateMachine.
40 **/
41 class StmStatus // := "State machine status"
42 {
43   public:
44     typedef intt        Branch;         /// Values >= 0 give a next #Status' ID.
45                                         /// Values <= 0 tell, that a token is finished.
46                                         /// a value < 0 returns the status back to an upper level state machine.
47         // LIFECYCLE
~StmStatus()48     virtual             ~StmStatus() {}
49 
50         // OPERATIONS
51     virtual StmArrayStatus *
52                         AsArray();
53     virtual StmBoundsStatus *
54                         AsBounds();
55 
56         // INQUIRY
57     virtual bool        IsADefault() const = 0;
58 };
59 
60 
61 
62 #endif
63 
64 
65