1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef ADC_TKPCONTX_HXX
#define ADC_TKPCONTX_HXX
// USED SERVICES
// BASE CLASSES
// COMPONENTS
// PARAMETERS
#include <tokens/token.hxx>
class CharacterSource;
class TkpNullContext;
/** @task
Specifies a context within which tokens are interpreted in a special
way. For example in parsing C++ there could be a context for code,
one for comments and a third one for preprocessor statements, because
each of these would give the same token different meanings.
The three functions
ReadCharChain()
PassNewToken()
FollowUpContext()
have to be called in this sequence.
**/
class TkpContext
{
public:
// LIFECYCLE
virtual ~TkpContext() {}
// OPERATIONS
/** @descr
The functions starts to parse with the CurChar() of io_rText.
It leaves io_rText.CurChar() at the first char of the following Token or
the following Context.
This function returns, when a context has parsed some characterss
and completed a token OR left the context.
If the token is to be ignored, it is cut from io_rText.
If the token is to be parsed further in a different context,
it is NOT cut from io_rText.
After this function PassNewToken() has to be called.
If the function has found a valid and complete token, PassNewToken()
passes the parsed token to the internally known receiver and
returns true. The token is cut from io_rText.
**/
virtual void ReadCharChain(
CharacterSource & io_rText ) = 0;
/** Has to pass the parsed token to a known receiver.
If the token is to be parsed further in a different context,
PassNewToken() returns false, but the token is NOT cut from io_rText.
@return true, if a token was passed.
false, if the token was not parsed completely by this context
or if the token is to be ignored.
*/
virtual bool PassNewToken() = 0;
virtual TkpContext &
FollowUpContext() = 0;
static TkpNullContext &
Null_();
};
class StateMachineContext
{
public:
typedef TextToken::F_CRTOK F_CRTOK;
virtual ~StateMachineContext() {}
/// Is used by StmBoundsStatus only.
virtual void PerformStatusFunction(
uintt i_nStatusSignal,
F_CRTOK i_fTokenCreateFunction,
CharacterSource & io_rText ) = 0;
};
class TkpNullContext : public TkpContext
{
public:
~TkpNullContext();
virtual void ReadCharChain(
CharacterSource & io_rText );
virtual bool PassNewToken();
virtual TkpContext &
FollowUpContext();
};
namespace autodoc
{
class TkpDocuContext : public TkpContext
{
public:
virtual void SetParentContext(
TkpContext & io_rParentContext,
const char * i_sMultiLineEndToken ) = 0;
virtual void AssignDealer(
TokenDealer & o_rDealer ) = 0;
virtual void SetMode_IsMultiLine(
bool i_bTrue ) = 0;
};
} // namespace autodoc
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
