xref: /trunk/main/autodoc/source/parser/inc/tokens/tokproct.hxx (revision 914d351e5f5b84e4342a86d6ab8d4aca7308b9bd)
11c78a5d6SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
31c78a5d6SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
41c78a5d6SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
51c78a5d6SAndrew Rist  * distributed with this work for additional information
61c78a5d6SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
71c78a5d6SAndrew Rist  * to you under the Apache License, Version 2.0 (the
81c78a5d6SAndrew Rist  * "License"); you may not use this file except in compliance
91c78a5d6SAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
111c78a5d6SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
131c78a5d6SAndrew Rist  * Unless required by applicable law or agreed to in writing,
141c78a5d6SAndrew Rist  * software distributed under the License is distributed on an
151c78a5d6SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
161c78a5d6SAndrew Rist  * KIND, either express or implied.  See the License for the
171c78a5d6SAndrew Rist  * specific language governing permissions and limitations
181c78a5d6SAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
201c78a5d6SAndrew Rist  *************************************************************/
211c78a5d6SAndrew Rist 
221c78a5d6SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef ADC_CPP_TOKPROCT_HXX
25cdf0e10cSrcweir #define ADC_CPP_TOKPROCT_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir 
28cdf0e10cSrcweir 
29cdf0e10cSrcweir // USED SERVICES
30cdf0e10cSrcweir     // BASE CLASSES
31cdf0e10cSrcweir     // COMPONENTS
32cdf0e10cSrcweir     // PARAMETERS
33cdf0e10cSrcweir 
34cdf0e10cSrcweir 
35cdf0e10cSrcweir class ParseEnvironment;
36cdf0e10cSrcweir 
37cdf0e10cSrcweir /** is a parent class for classes, which take part in parsing tokens semantically.
38cdf0e10cSrcweir     It provides some types for them.
39cdf0e10cSrcweir */
40cdf0e10cSrcweir class TokenProcessing_Types
41cdf0e10cSrcweir {
42cdf0e10cSrcweir   public:
43cdf0e10cSrcweir     enum E_TokenDone
44cdf0e10cSrcweir     {
45cdf0e10cSrcweir         not_done = 0,
46cdf0e10cSrcweir         done = 1
47cdf0e10cSrcweir     };
48cdf0e10cSrcweir 
49cdf0e10cSrcweir     enum E_EnvStackAction
50cdf0e10cSrcweir     {
51cdf0e10cSrcweir         stay,           // same parse environment
52cdf0e10cSrcweir         push,           // push sub environment
53cdf0e10cSrcweir         pop_success,    // return to parent environment, parsing was successful
54*07a3d7f1SPedro Giffuni         pop_failure     // return to parent environment, but an error occurred.
55cdf0e10cSrcweir     };
56cdf0e10cSrcweir 
57cdf0e10cSrcweir     struct TokenProcessing_Result
58cdf0e10cSrcweir     {
59cdf0e10cSrcweir         E_TokenDone         eDone;
60cdf0e10cSrcweir         E_EnvStackAction    eStackAction;
61cdf0e10cSrcweir         ParseEnvironment *  pEnv2Push;
62cdf0e10cSrcweir 
TokenProcessing_ResultTokenProcessing_Types::TokenProcessing_Result63cdf0e10cSrcweir                             TokenProcessing_Result()
64cdf0e10cSrcweir                                                 : eDone(not_done), eStackAction(stay), pEnv2Push(0) {}
ResetTokenProcessing_Types::TokenProcessing_Result65cdf0e10cSrcweir         void                Reset()             { eDone = not_done; eStackAction = stay; pEnv2Push = 0; }
66cdf0e10cSrcweir     };
67cdf0e10cSrcweir 
68cdf0e10cSrcweir     enum E_ParseResult
69cdf0e10cSrcweir     {
70cdf0e10cSrcweir         res_error,
71cdf0e10cSrcweir         res_complete,
72cdf0e10cSrcweir         res_predeclaration
73cdf0e10cSrcweir     };
74cdf0e10cSrcweir };
75cdf0e10cSrcweir 
76cdf0e10cSrcweir 
77cdf0e10cSrcweir 
78cdf0e10cSrcweir #endif
79