xref: /AOO41X/main/autodoc/source/parser/inc/tokens/tokproct.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_CPP_TOKPROCT_HXX
29 #define ADC_CPP_TOKPROCT_HXX
30 
31 
32 
33 // USED SERVICES
34 	// BASE CLASSES
35 	// COMPONENTS
36 	// PARAMETERS
37 
38 
39 class ParseEnvironment;
40 
41 /**	is a parent class for classes, which take part in parsing tokens semantically.
42 	It provides some types for them.
43 */
44 class TokenProcessing_Types
45 {
46   public:
47 	enum E_TokenDone
48 	{
49 		not_done = 0,
50 		done = 1
51 	};
52 
53 	enum E_EnvStackAction
54 	{
55 		stay,			// same parse environment
56 		push,      		// push sub environment
57 		pop_success,    // return to parent environment, parsing was successful
58 		pop_failure     // return to parent environment, but an error occured.
59 	};
60 
61 	struct TokenProcessing_Result
62 	{
63 		E_TokenDone			eDone;
64 		E_EnvStackAction	eStackAction;
65 		ParseEnvironment *	pEnv2Push;
66 
67 							TokenProcessing_Result()
68 												: eDone(not_done), eStackAction(stay), pEnv2Push(0) {}
69 		void				Reset()				{ eDone = not_done; eStackAction = stay; pEnv2Push = 0; }
70 	};
71 
72 	enum E_ParseResult
73 	{
74 		res_error,
75 		res_complete,
76 		res_predeclaration
77 	};
78 };
79 
80 
81 
82 #endif
83 
84