1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef ADC_TKP_HXX
29*cdf0e10cSrcweir #define ADC_TKP_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir // USED SERVICES
32*cdf0e10cSrcweir 	// BASE CLASSES
33*cdf0e10cSrcweir 	// COMPONENTS
34*cdf0e10cSrcweir class CharacterSource;
35*cdf0e10cSrcweir class TkpContext;
36*cdf0e10cSrcweir 	// PARAMETRS
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir /** This is the interface for parser classes, which get a sequence of tokens from
41*cdf0e10cSrcweir 	a text.
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir 	Start() starts to parse the text from the given i_rSource.
44*cdf0e10cSrcweir 	GetNextToken() returns a Token on the heap as long as there are
45*cdf0e10cSrcweir 	still characters in the text left. This can be checked by
46*cdf0e10cSrcweir     HasMore().
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir 	The algorithms for parsing tokens from the text are an issue of
49*cdf0e10cSrcweir 	the derived classes.
50*cdf0e10cSrcweir */
51*cdf0e10cSrcweir #if 0
52*cdf0e10cSrcweir /**
53*cdf0e10cSrcweir     Parsing can be interrupted for a different source by PushSource().
54*cdf0e10cSrcweir     The parsing before interruption is continued after PopSource().
55*cdf0e10cSrcweir */
56*cdf0e10cSrcweir #endif // 0
57*cdf0e10cSrcweir 
58*cdf0e10cSrcweir class TokenParser
59*cdf0e10cSrcweir {
60*cdf0e10cSrcweir   public:
61*cdf0e10cSrcweir 	// LIFECYCLE
62*cdf0e10cSrcweir 						TokenParser();
63*cdf0e10cSrcweir 	virtual				~TokenParser() {}
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir 	// OPERATIONS
66*cdf0e10cSrcweir     /** Start parsing a character source. Any previously parsed sources
67*cdf0e10cSrcweir         are discarded.
68*cdf0e10cSrcweir     */
69*cdf0e10cSrcweir 	virtual void   		Start(
70*cdf0e10cSrcweir 							CharacterSource &
71*cdf0e10cSrcweir 											i_rSource );
72*cdf0e10cSrcweir 
73*cdf0e10cSrcweir 	/** @short	Gets the next identifiable token out of the
74*cdf0e10cSrcweir 		source code.
75*cdf0e10cSrcweir 	*/
76*cdf0e10cSrcweir 	void				GetNextToken();
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir     /// @return true, if there are more tokens to parse.
79*cdf0e10cSrcweir 	bool				HasMore() const			{ return bHasMore; }
80*cdf0e10cSrcweir 
81*cdf0e10cSrcweir   private:
82*cdf0e10cSrcweir     void                InitSource(
83*cdf0e10cSrcweir 							CharacterSource &
84*cdf0e10cSrcweir 											i_rSource );
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir 	virtual void		SetStartContext() = 0;
87*cdf0e10cSrcweir 	virtual void        SetCurrentContext(
88*cdf0e10cSrcweir 							TkpContext &		io_rContext ) = 0;
89*cdf0e10cSrcweir 	virtual TkpContext &
90*cdf0e10cSrcweir 						CurrentContext() = 0;
91*cdf0e10cSrcweir 	// DATA
92*cdf0e10cSrcweir 	CharacterSource *	pChars;
93*cdf0e10cSrcweir 	bool				bHasMore;
94*cdf0e10cSrcweir };
95*cdf0e10cSrcweir 
96*cdf0e10cSrcweir 
97*cdf0e10cSrcweir #endif
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir 
100