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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/***************************************************************************
*
* Copyright (C) 2005 Elad Lahav (elad_lahav@users.sourceforge.net)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
***************************************************************************/
#ifndef FRONTEND_H
#define FRONTEND_H
#include <ntqobject.h>
#include <kprocess.h>
/**
* Represents a single token in the parsed output stream.
* @author Elad Lahav
*/
class FrontendToken
{
public:
/**
* Class constructor.
*/
FrontendToken() : m_pNext(NULL) {}
/**
* @return The text associated with this token
*/
const TQString& getData() const { return m_sData; }
/**
* @return A pointer to the next token in the strem.
*/
FrontendToken* getNext() const { return m_pNext; }
protected:
/** Free text associated with the token. */
TQString m_sData;
/** A pointer to the next token in the stream. */
FrontendToken* m_pNext;
friend class Frontend;
};
/**
* Abstract base class that provides a front-end to console-based programmes.
* Provides a parsing infrastructure which is based on a list of records, all
* of the same structure. Each record is composed of a number of delimited
* fields (tokens.)
* @author Elad Lahav
*/
class Frontend : public KProcess
{
Q_OBJECT
public:
Frontend(uint, bool bAutoDelete = false);
~Frontend();
virtual bool run(const TQString&, const TQStringList&,
const TQString& sWorkDir = "", bool bBlock = false);
void kill();
/**
* @return An string describing the error which made run() fail
*/
const TQString& getRunError() { return m_sError; }
signals:
/**
* Indicates tokens can be read.
* The Frontend object parses the back-end output and creates a list of
* tokens. This signal is emitted when a batch of characters has been
* converted into a token list.
* @param pToken The head of the token list
*/
void dataReady(FrontendToken* pToken);
/**
* Emitted when the back-end process terminates.
* @param nRecords The number of complete records parsed
*/
void finished(uint nRecords);
/**
* Indicates that the Cscope process was terminated.
*/
void aborted();
/**
* This signal is used to report the progress of the back-end process.
* @param nProgress The current progress value
* @param nTotal The progress value that indicates the process
* is finished
*/
void progress(int nProgress, int nTotal);
/**
* Emitted when an error message is produced by the back-end process.
*/
void error(const TQString& sMsg);
protected:
/** A set of possible delimiters for parsing process output. */
enum ParserDelim { Newline = 0x01, Space = 0x02, Tab = 0x04,
WSpace = Space | Tab, All = WSpace | Newline };
/** Defines the set of return values for parseStdout(). Determines what
needs to be done with a new token passed to this method. */
enum ParseResult {
DiscardToken /** Delete this token */,
AcceptToken /** Add this token to the list */,
RecordReady /** This token completes a record */,
Abort /** Kill the process */
};
/** Number of complete records read so far. */
uint m_nRecords;
/** The head of the list of parsed output tokens. */
FrontendToken* m_pHeadToken;
/** The tail of the list of parsed output tokens. */
FrontendToken* m_pTailToken;
/** An iterator on the list of parsed output tokens. */
FrontendToken* m_pCurToken;
/** The current delimiters used for parsing the output. */
ParserDelim m_delim;
/** An error string produced if run() fails. */
TQString m_sError;
/**
* Handles a text token received on the Standard Output stream of the
* controlled process.
* This is called by slotReadStdout whenever a new token is recognised.
* Inheriting classes should implement this method to parse the resutling
* stream of tokens.
* @param sToken A part of the text received on the Standard Output,
* disected according to current delimiter settings
* @param delim The delimiter that ended this token
* @result A ParseResult value, indicating what should be done with the
* new token
*/
virtual ParseResult parseStdout(TQString& sToken, ParserDelim delim) = 0;
virtual void parseStderr(const TQString&);
/**
* Called when the process exits.
* Allows inheriting classes to implement process termination handlers.
*/
virtual void finalize() {}
protected slots:
virtual void slotProcessExit(KProcess*);
private:
/** Determines whether the object should be deleted once the process has
exited */
bool m_bAutoDelete;
/** Determines whether the parser is in the middle of a token, or between
two tokens */
bool m_bInToken;
/** The number of fields in each parsed record. Should be defined for
every sub-class. */
uint m_nRecordSize;
/** This flag is raised when kill() is called. It signifies that even
though the process may not be dead yet, it should be considered as
such. */
bool m_bKilled;
void addToken(FrontendToken*);
void removeToken();
void removeRecord();
bool tokenize(char**, int*, TQString&, ParserDelim&);
private slots:
void slotReadStdout(KProcess*, char*, int);
void slotReadStderr(KProcess*, char*, int);
};
#endif
|
