xref: /trunk/main/autodoc/source/parser_i/inc/tokens/tkp2.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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_TKP2_HXX
29*cdf0e10cSrcweir #define ADC_TKP2_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 Token s 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. The last time GetNextToken()
46*cdf0e10cSrcweir     returns NULL.
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 class TokenParse2
52*cdf0e10cSrcweir {
53*cdf0e10cSrcweir   public:
54*cdf0e10cSrcweir     // LIFECYCLE
55*cdf0e10cSrcweir                         TokenParse2();
56*cdf0e10cSrcweir     virtual             ~TokenParse2() {}
57*cdf0e10cSrcweir 
58*cdf0e10cSrcweir     // OPERATIONS
59*cdf0e10cSrcweir     virtual void        Start(
60*cdf0e10cSrcweir                             CharacterSource &
61*cdf0e10cSrcweir                                             i_rSource );
62*cdf0e10cSrcweir 
63*cdf0e10cSrcweir     /** @short  Gets the next identifiable token out of the
64*cdf0e10cSrcweir         source code.
65*cdf0e10cSrcweir         @return true, if there was passed a valid token.
66*cdf0e10cSrcweir                 false, if the parsed stream is finished or
67*cdf0e10cSrcweir                        an error occured.
68*cdf0e10cSrcweir     */
69*cdf0e10cSrcweir     bool                GetNextToken();
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir   private:
72*cdf0e10cSrcweir     virtual void        SetStartContext() = 0;
73*cdf0e10cSrcweir     virtual void        SetCurrentContext(
74*cdf0e10cSrcweir                             TkpContext &        io_rContext ) = 0;
75*cdf0e10cSrcweir     virtual TkpContext &
76*cdf0e10cSrcweir                         CurrentContext() = 0;
77*cdf0e10cSrcweir     // DATA
78*cdf0e10cSrcweir     CharacterSource *   pChars;
79*cdf0e10cSrcweir };
80*cdf0e10cSrcweir 
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir #endif
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir 
85