xref: /trunk/main/autodoc/source/parser/inc/tokens/stmstate.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef ADC_STMSTATE_HXX
29 #define ADC_STMSTATE_HXX
30 
31 // USED SERVICES
32     // BASE CLASSES
33     // COMPONENTS
34     // PARAMETERS
35 class StmArrayStatus;
36 class StmBoundsStatus;
37 
38 /** A StmStatus is a state within a StateMachine.
39     There are two kinds of it.  Either its an array of pointers to
40     other states within the state machine - an ArrayStatus.
41 
42     Or it is a BoundsStatus, which shows, the token cannot be
43     followed further within the StateMachine.
44 **/
45 class StmStatus // := "State machine status"
46 {
47   public:
48     typedef intt        Branch;         /// Values >= 0 give a next #Status' ID.
49                                         /// Values <= 0 tell, that a token is finished.
50                                         /// a value < 0 returns the status back to an upper level state machine.
51         // LIFECYCLE
52     virtual             ~StmStatus() {}
53 
54         // OPERATIONS
55     virtual StmArrayStatus *
56                         AsArray();
57     virtual StmBoundsStatus *
58                         AsBounds();
59 
60         // INQUIRY
61     virtual bool        IsADefault() const = 0;
62 };
63 
64 
65 
66 #endif
67 
68 
69