Menu

[r4761]: / branches / parsnip / Src / USnippetSourceGen.pas  Maximize  Restore  History

Download this file

241 lines (215 with data), 7.3 kB

  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
{
* This Source Code Form is subject to the terms of the Mozilla Public License,
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
* obtain one at http://mozilla.org/MPL/2.0/
*
* Copyright (C) 2006-2014, Peter Johnson (www.delphidabbler.com).
*
* $Rev$
* $Date$
*
* Implements a static class that generates source code for code snippet(s)
* contained in a routine snippet or tag view.
}
unit USnippetSourceGen;
interface
uses
// Project
CS.Database.Types,
CS.SourceCode.Pascal.SourceGen,
UBaseObjects,
UIStringList,
UView;
type
{
TSnippetSourceGen:
Static class that generates source code for code snippet(s) contained in a
routine snippet or tag view.
}
TSnippetSourceGen = class sealed(TNoPublicConstructObject)
strict private
fGenerator: TPascalSourceGen;
{Object used to generate the source code}
procedure Initialize(View: IView);
{Initializes source code generator using information from a snippet or tag
tag view.
@param View [in] View from which to retrieve source code.
}
function BuildHeaderComments: IStringList;
{Creates and stores header comments to be written to head of snippet.
@return String list containing comments.
}
class function GetTagSnippets(const Tag: TTag): ISnippetIDList;
function DoGenerate(const CommentStyle: TPascalCommentStyle;
const TruncateComments: Boolean): string;
{Generates source code for included snippets.
@param CommentStyle [in] Style of commenting to use in source code.
@param TruncateComments [in] Whether to truncate multi paragraph
snippet description to first paragraph in comments.
@return Required source code.
}
strict protected
constructor InternalCreate(View: IView);
{Class constructor. Sets up object to record and generate source code for
a view.
@param View [in] View for which we are generating source code.
}
public
destructor Destroy; override;
{Class destructor. Tears down object.
}
class function CanGenerate(View: IView): Boolean;
{Checks if a valid source code snippet can be generated from a view.
@param View [in] View to be checked.
@return True if View is a routine snippet or a tag that contains routine
snippets for current query.
}
class function Generate(View: IView;
const CommentStyle: TPascalCommentStyle; const TruncateComments: Boolean):
string;
{Generates source code of all routine snippets or tags in a view.
@param View [in] View containing required snippet(s).
@param CommentStyle [in] Style of commenting to use in source code.
@param TruncateComments [in] Whether to truncate multi paragraph
snippet description to first paragraph in comments.
@return Required source code.
}
end;
implementation
uses
// Delphi
SysUtils,
// Project
CS.Utils.Dates,
DB.UMain,
UAppInfo,
UQuery;
{ TSnippetSourceGen }
function TSnippetSourceGen.BuildHeaderComments: IStringList;
{Creates and stores header comments to be written to head of snippet.
@return String list containing comments.
}
var
Header: string; // format string for header comment
resourcestring
// Comment to be included at top of snippet
sHeader = 'This code snippet was generated by %0:s %1:s on %2:s.';
begin
Header := sHeader;
// Add the comments
Result := TIStringList.Create;
Result.Add(
Format(
Header,
[
TAppInfo.FullProgramName,
TAppInfo.ProgramReleaseInfo,
TUTCDateTime.Now.ToRFC1123String
]
)
);
end;
class function TSnippetSourceGen.CanGenerate(View: IView): Boolean;
{Checks if a valid source code snippet can be generated from a view.
@param View [in] View to be checked.
@return True if View is a routine snippet or a tag that contains routine
snippets for current query.
}
var
SnipView: ISnippetView; // snippets view if supported
TagView: ITagView; // tag view if supported
begin
if Supports(View, ISnippetView, SnipView) then
Result := Database.LookupSnippet(SnipView.SnippetID).KindID = skRoutine
else if Supports(View, ITagView, TagView) then
Result := not GetTagSnippets(TagView.Tag).IsEmpty
else
Result := False;
end;
destructor TSnippetSourceGen.Destroy;
{Class destructor. Tears down object.
}
begin
fGenerator.Free;
inherited;
end;
function TSnippetSourceGen.DoGenerate(const CommentStyle: TPascalCommentStyle;
const TruncateComments: Boolean): string;
{Generates source code for included snippets.
@param CommentStyle [in] Style of commenting to use in source code.
@param TruncateComments [in] Whether to truncate multi paragraph snippet
description to first paragraph in comments.
@return Required source code.
}
begin
Result := fGenerator.IncFileAsString(
CommentStyle, TruncateComments, BuildHeaderComments
);
end;
class function TSnippetSourceGen.Generate(View: IView;
const CommentStyle: TPascalCommentStyle; const TruncateComments: Boolean):
string;
{Generates source code of all routine snippets or tags in a view.
@param View [in] View containing required snippet(s).
@param CommentStyle [in] Style of commenting to use in source code.
@param TruncateComments [in] Whether to truncate multi paragraph snippet
description to first paragraph in comments.
@return Required source code.
}
begin
with InternalCreate(View) do
try
Result := DoGenerate(CommentStyle, TruncateComments);
finally
Free;
end;
end;
class function TSnippetSourceGen.GetTagSnippets(const Tag: TTag):
ISnippetIDList;
begin
if not Tag.IsNull then
// non-null tag => we want all associated snippets
Result := Query.FilterSelection(
function (Snippet: ISnippet): Boolean
begin
Result := Snippet.Tags.Contains(Tag) and (Snippet.KindID = skRoutine);
end
)
else
// null tag => we want all snippets with no tag
Result := Query.FilterSelection(
function (Snippet: ISnippet): Boolean
begin
Result := Snippet.Tags.IsEmpty and (Snippet.KindID = skRoutine);
end
);
end;
procedure TSnippetSourceGen.Initialize(View: IView);
{Initializes source code generator using information from a snippet or tags
view.
@param View [in] View from which to retrieve source code.
}
begin
// Record required snippet(s)
if Supports(View, ISnippetView) then
// view is single snippet: just record that
fGenerator.IncludeSnippet(
Database.LookupSnippet((View as ISnippetView).SnippetID)
)
else
// view is tag: record all skRoutine snippets for tag in current query
fGenerator.IncludeSnippets(GetTagSnippets((View as ITagView).Tag));
end;
constructor TSnippetSourceGen.InternalCreate(View: IView);
{Class constructor. Sets up object to record and generate source code for a
view.
@param View [in] View for which we are generating source code.
}
begin
Assert(Assigned(View), ClassName + '.InternalCreate: View is nil');
Assert(CanGenerate(View), ClassName + '.InternalCreate: View not supported');
inherited InternalCreate;
fGenerator := TPascalSourceGen.Create;
Initialize(View);
end;
end.
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.