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_TKP_HXX
29 #define ADC_TKP_HXX
30 
31 // USED SERVICES
32 	// BASE CLASSES
33 	// COMPONENTS
34 class CharacterSource;
35 class TkpContext;
36 	// PARAMETRS
37 
38 
39 
40 /** This is the interface for parser classes, which get a sequence of tokens from
41 	a text.
42 
43 	Start() starts to parse the text from the given i_rSource.
44 	GetNextToken() returns a Token on the heap as long as there are
45 	still characters in the text left. This can be checked by
46     HasMore().
47 
48 	The algorithms for parsing tokens from the text are an issue of
49 	the derived classes.
50 */
51 #if 0
52 /**
53     Parsing can be interrupted for a different source by PushSource().
54     The parsing before interruption is continued after PopSource().
55 */
56 #endif // 0
57 
58 class TokenParser
59 {
60   public:
61 	// LIFECYCLE
62 						TokenParser();
63 	virtual				~TokenParser() {}
64 
65 	// OPERATIONS
66     /** Start parsing a character source. Any previously parsed sources
67         are discarded.
68     */
69 	virtual void   		Start(
70 							CharacterSource &
71 											i_rSource );
72 
73 	/** @short	Gets the next identifiable token out of the
74 		source code.
75 	*/
76 	void				GetNextToken();
77 
78     /// @return true, if there are more tokens to parse.
79 	bool				HasMore() const			{ return bHasMore; }
80 
81   private:
82     void                InitSource(
83 							CharacterSource &
84 											i_rSource );
85 
86 	virtual void		SetStartContext() = 0;
87 	virtual void        SetCurrentContext(
88 							TkpContext &		io_rContext ) = 0;
89 	virtual TkpContext &
90 						CurrentContext() = 0;
91 	// DATA
92 	CharacterSource *	pChars;
93 	bool				bHasMore;
94 };
95 
96 
97 #endif
98 
99 
100