-
-
Notifications
You must be signed in to change notification settings - Fork 6
/
XMLCommentsParserImpl.pas
411 lines (365 loc) · 11.8 KB
/
XMLCommentsParserImpl.pas
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
// Productivity Experts by Chua Chee Wee, Singapore
//
// Chua Chee Wee,
// Singapore
// 19 April 2005.
//
// Blog: http://chuacw.ath.cx/chuacw/category/78.aspx
unit XMLCommentsParserImpl;
interface
uses
SysUtils;
// References
// 1) ...use regular expressions in Delphi? - http://www.swissdelphicenter.ch/torry/printcode.php?id=1478
// 2) Introduction to Regular Expressions - http://msdn.microsoft.com/library/default.asp?url=/library/en-us/script56/html/reconIntroductionToRegularExpressions.asp
type
TRoutineType = (rtFunction, rtProcedure, rtMethod, rtConstructor, rtDestructor, rtOperator,
rtGetter, rtSetter);
// consider operator as a function instead?
TParamKind = (pkByVal, pkByRef, pkConst);
TParamType = record
ParamKind: TParamKind;
Name, _Type, Default: string;
end;
TRoutine = record
Name, _Type: string;
Params: array of TParamType;
end;
TRoutineDeclaration = class
protected
FXML,
FIsClass, FType, FClassName, FName, FReturnType: string;
FParams: array of TParamType;
function GetXML: string;
function IsFunction(const AText: string): Boolean; virtual;
public
procedure AddParam(AParamKind: TParamKind; const AName, AType, ADefault: string);
constructor Create(const AIsClass, AType, AClassName, AName, AReturnType: string); virtual;
property XML: string read GetXML;
end;
function GetIndentation(const AText: string): string;
function WithinCodeCommentsRegion(const AText: string; out Slashes: string): Boolean;
implementation
uses
ActiveX, Windows,
DeclParserIntf, TextUtils, CSharpParserImpl;
function GetIndentation(const AText: string): string;
var
Parser: IRegExp2;
MatchCollection: IMatchCollection2;
Match: IMatch2;
Submatches: ISubMatches;
begin
Result := '';
Parser := CoRegExp.Create;
Parser.Global := False;
Parser.Pattern := '^(\s*)(?:(.))';
MatchCollection := Parser.Execute(AText) as IMatchCollection2;
if MatchCollection.Count = 0 then
exit;
Match := MatchCollection.Item[0] as IMatch2;
Submatches := Match.SubMatches as ISubMatches;
Result := Submatches[0];
end;
function ParseReturnType(const AText: string): string;
var
Parser: IRegExp2;
MatchCollection: IMatchCollection2;
Match: IMatch2;
begin
Result := '';
Parser := CoRegExp.Create;
Parser.Global := True;
// Look for one of the following
// 1) : [Namespace.[Namespace. ...]]Type
Parser.Pattern := '((\w+)\.)*\w+';
MatchCollection := Parser.Execute(AText) as IMatchCollection2;
if MatchCollection.Count = 0 then
exit;
Match := MatchCollection.Item[0] as IMatch2;
Result := Match.Value;
end;
function ParseDefaultValue(const AText: string): string;
var
Parser: IRegExp2;
MatchCollection: IMatchCollection2;
Match: IMatch2;
Submatches: ISubMatches;
Text: string;
begin
Result := '';
Parser := CoRegExp.Create;
Parser.Global := True;
// Look for one of
// 1) = 'some string'
// 2) = Identifier
// 3) = nnnn (where nnnn is digits) // not supporting real numbers...
Parser.Pattern := '\s*\=\s*(''.*''|\w+|(\+|\-)?\d+\.\d+)';
MatchCollection := Parser.Execute(AText) as IMatchCollection2;
if MatchCollection.Count = 0 then exit;
Match := MatchCollection.Item[0] as IMatch2;
Submatches := Match.SubMatches as ISubMatches;
Text := Submatches[0];
Result := Text;
end;
function ParseTypeName(const AText: string): string;
var
Parser: IRegExp2;
MatchCollection: IMatchCollection2;
Match: IMatch2;
Submatches: ISubMatches;
Text: string;
begin
Parser := CoRegExp.Create;
Parser.Global := True;
// Look for one of the following
// 1) : Type
// 2) : [Namespace.[Namespace. ...]]Type
Parser.Pattern := '(?:\s*\:\s*)&?(((\w+)\.)*(\w+))';
MatchCollection := Parser.Execute(AText) as IMatchCollection2;
Assert(MatchCollection.Count = 1);
Match := MatchCollection.Item[0] as IMatch2;
Submatches := Match.SubMatches as ISubMatches;
Text := Submatches[0];
Result := Text;
end;
procedure ParseParamNames(Routine: TRoutineDeclaration; const AText: string);
var
Parser: IRegExp2;
MatchCollection: IMatchCollection2;
Match: IMatch2;
Submatches: ISubMatches;
I: Integer;
ParamName, Token, TypeName, Default: string;
begin
TypeName := ParseTypeName(AText);
Default := ParseDefaultValue(AText);
Parser := CoRegExp.Create;
Parser.IgnoreCase := True;
// Look for identifiers, or identifiers:
Parser.Pattern := '&?(((\w+)\.)*\w+)(?:\s*,|:)';
Parser.Global := True;
MatchCollection := Parser.Execute(AText) as IMatchCollection2;
for I := 0 to MatchCollection.Count - 1 do
begin
Match := MatchCollection.Item[I] as IMatch2;
Token := Match.Value;
Submatches := Match.SubMatches as ISubMatches;
ParamName := Submatches[0];
Routine.AddParam(pkByVal, ParamName, TypeName, Default);
end;
end;
function ParseSingleDeclaration(Routine: TRoutineDeclaration; const AText: string): TParamType;
var
Parser: IRegExp2;
MatchCollection: IMatchCollection2;
Match: IMatch2;
I: Integer;
begin
Parser := CoRegExp.Create;
Parser.IgnoreCase := True;
Parser.Pattern := '((const|var|out)?(?:\s)*&?(\w+)(\s*,\s*\w+)*(?:\s*\:\s*)&?((\w+)\.)*(\w+)(\s*\=\s*(''.*''|\w+|\d+))?)';
MatchCollection := Parser.Execute(AText) as IMatchCollection2;
for I := 0 to MatchCollection.Count - 1 do
begin
Match := MatchCollection.Item[I] as IMatch2;
ParseParamNames(Routine, Match.Value);
end;
end;
function ParseTypeDeclaration(Routine: TRoutineDeclaration; const AText: string): TParamType;
var
Parser: IRegExp2;
MatchCollection: IMatchCollection2;
Match: IMatch2;
I: Integer;
Text: string;
begin
Parser := CoRegExp.Create;
Parser.Global := True; Parser.IgnoreCase := True;
// A single type declaration is something that is followed by (optionally) a semicolon
Parser.Pattern := '([^;]*)(\;)?';
MatchCollection := Parser.Execute(AText) as IMatchCollection2;
for I := 0 to MatchCollection.Count - 1 do
begin
Match := MatchCollection.Item[I] as IMatch2;
Text := Match.Value;
if Text <> '' then
ParseSingleDeclaration(Routine, Text);
end;
end;
procedure ParseParams(const AText: string);
var
Parser: IRegExp2;
begin
Parser := CoRegExp.Create;
Parser.Pattern := '';
end;
/// <summary>
/// Parses a valid Delphi routine declaration.
/// NOTE: Free the return class after use.
/// </summary>
/// <param name="AText" type="string">Contains one or more lines of text in the editor</param>
/// <returns>TRoutineDeclaration</returns>
function Parse(const AText: string): TRoutineDeclaration;
var
Parser: IRegExp2;
MatchCollection: IMatchCollection2;
Match: IMatch2;
Submatches: ISubMatches;
I: Integer;
Pattern, ReturnType,
IsClass, ClassName, RoutineType, RoutineName, Text: string;
Routine: TRoutineDeclaration;
begin
Routine := nil;
Parser := CoRegExp.Create;
try
Parser.IgnoreCase := True;
Parser.Global := False;
Pattern :=
'^' + // beginning of line
Whitespace +
'(class)?' + // optional static class
Whitespace +
// '((con|de)structor|function|operator|procedure)'+
'(constructor|destructor|function|operator|procedure)' +
Whitespace +
'(\w+\.)*' + // optional class identifier followed by a dot
'(\w+)' + // routine name
Whitespace +
'((?:\()((?:\;?\s*)(const|var|out)?' +
Whitespace +
'&?(\w+)' + // (optional &) parameter name
'(,\s*\w+)*' + // additional parameters
'(?:\s*\:\s*)' + // type separator
// (optional &) (optional scope/namespace) parameter type name
'&?((\w*)\.)*(\w+)' +
'(\s*\=\s*(''.*''|\w+|\d+))?' + // default parameters, no set support
')*(?:\)))*((?:\:\s*)' + // grr...
'((\w*)\.)*(\w+))?;'; // optional return type
Parser.Pattern := Pattern;
if Parser.Test(AText) then
begin
MatchCollection := Parser.Execute(AText) as IMatchCollection2;
for I := 0 to MatchCollection.Count - 1 do
begin
Match := MatchCollection.Item[I] as IMatch2;
Submatches := Match.SubMatches as ISubMatches;
IsClass := Submatches[0];
RoutineType := Submatches[1];
ClassName := Submatches[2];
RoutineName := Submatches[3];
Text := Submatches[14];
ReturnType := ParseReturnType(Text);
Routine := TRoutineDeclaration.Create(IsClass, RoutineType,
ClassName, RoutineName, ReturnType);
if Submatches.Count > 4 then
begin
Text := Submatches.Item[4];
if Length(Text) > 0 then
begin
if Text[1] = '(' then Delete(Text, 1, 1);
if Text[Length(Text)] = ')' then Delete(Text, Length(Text), 1);
ParseTypeDeclaration(Routine, Text);
end;
end;
end;
end else
begin
raise Exception.CreateFmt('Unable to parse declaration: %s', [AText]);
end;
finally
Result := Routine;
end;
end;
/// <summary>
/// Returns the number of slashes found in AText
/// </summary>
/// <param name="AText" type="string"></param>
/// <param name="Slashes" type="string"></param>
/// <returns>Boolean</returns>
function WithinCodeCommentsRegion(const AText: string; out Slashes: string): Boolean;
var
Parser: IRegExp2;
MatchCollection: IMatchCollection2;
Match: IMatch2;
begin
Match := nil;
Parser := CoRegExp.Create;
// A simple test for whether we're inside the code comments region
// is by looking at whether the text is beginning of line, some spaces,
// followed by ///
Parser.Pattern := '^(?:\s*)?(/{2,3})';
Parser.IgnoreCase := True;
Parser.Global := False;
// this cannot be done with a simple .Test, as it gives false results
MatchCollection := Parser.Execute(AText) as IMatchCollection2;
if MatchCollection.Count <> 0 then
begin
Match := MatchCollection[0] as IMatch2;
if Assigned(Match.SubMatches) and (ISubMatches(Match.SubMatches).Count>=1) then
Slashes := ISubMatches(Match.SubMatches)[0] else
Slashes := Match.Value;
end;
Result := Assigned(Match);
end;
{ TRoutineDeclaration }
procedure TRoutineDeclaration.AddParam(AParamKind: TParamKind;
const AName, AType, ADefault: string);
var
LParam: TParamType;
begin
LParam.ParamKind := AParamKind;
LParam.Name := AName;
// I should use LParam.&Type, but then, I want to give D7 users the same support
// so, I used _Type
LParam._Type := AType;
LParam.Default := ADefault;
SetLength(FParams, Length(FParams) + 1);
FParams[High(FParams)] := LParam;
end;
constructor TRoutineDeclaration.Create(const AIsClass, AType, AClassName, AName,
AReturnType: string);
begin
FIsClass := AIsClass;
FType := AType;
FClassName := AClassName;
FName := AName;
FReturnType := AReturnType;
end;
function TRoutineDeclaration.GetXML: string;
var
Data, LParam, Default, Params, Return: string;
I: Integer;
begin
if FXML = '' then
begin
Data := '/// <summary>'#13#10 +
'/// '#13#10 +
'/// </summary>'#13#10;
if IsFunction(Lowercase(FType)) then
Return := Format('/// <returns>%s</returns>'#13#10, [FReturnType]) else
Return := '';
Params := '';
for I := Low(FParams) to High(FParams) do
begin
if FParams[I].Default <> '' then
Default := Format(' default="%s"', [FParams[I].Default]) else
Default := '';
LParam := Format('/// <param name="%s" type="%s"%s></param>'#13#10,
[FParams[I].Name, FParams[I]._Type, Default]);
Params := Format('%s%s', [Params, LParam]);
end;
FXML := Format('%s%s%s', [Data, Params, Return]);
end;
Result := FXML;
end;
function TRoutineDeclaration.IsFunction(const AText: string): Boolean;
begin
Result := (AText = 'function');
end;
initialization
CoInitialize(nil);
finalization
CoUninitialize;
end.