Menu

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

Download this file

179 lines (152 with data), 5.1 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
{
* 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) 2009-2013, Peter Johnson (www.delphidabbler.com).
*
* $Rev$
* $Date$
*
* Implements a class that renders a document that describes a snippet as plain
* text.
}
unit UTextSnippetDoc;
interface
uses
// Delphi
Classes,
// Project
CS.ActiveText,
UEncodings,
UIStringList,
USnippetDoc;
type
/// <summary>Renders a document that describes a snippet as plain text.
/// </summary>
TTextSnippetDoc = class(TSnippetDoc)
strict private
var
/// <summary>Object used to build plain text document.</summary>
fWriter: TStringWriter;
const
/// <summary>Width of output in characters.</summary>
cPageWidth = 80;
/// <summary>Size of a single level of indentation in characters.
/// </summary>
cIndent = 2;
strict private
/// <summary>Renders given active text as word-wrapped paragraphs of width
/// cPageWidth and given indent. Blank lines are added between paragraphs
/// iff SpaceParas in True.</summary>
procedure RenderActiveText(ActiveText: IActiveText; const Indent: Cardinal;
const SpaceParas: Boolean);
strict protected
/// <summary>Initialises plain text document.</summary>
procedure InitialiseDoc; override;
/// <summary>Adds given heading to document.</summary>
procedure RenderHeading(const Heading: string); override;
/// <summary>Interprets and adds given snippet description to document.
/// </summary>
/// <remarks>Active text is converted to word-wrapped plain text
/// paragraphs.</remarks>
procedure RenderDescription(const Desc: IActiveText); override;
/// <summary>Adds given source code to document.</summary>
procedure RenderSourceCode(const SourceCode: string); override;
/// <summary>Adds given title followed by given text to document.</summary>
procedure RenderTitledText(const Title, Text: string); override;
/// <summary>Adds a comma-separated list of text, preceded by given title,
/// to document.</summary>
procedure RenderTitledList(const Title: string; List: IStringList);
override;
/// <summary>Adds given compiler info, preceeded by given heading, to
/// document.</summary>
procedure RenderCompilerInfo(const Heading: string;
const Info: TCompileDocInfoArray); override;
/// <summary>Interprets and adds given notes to document.</summary>
/// <remarks>Active text is converted to word-wrapped plain text
/// paragraphs.</remarks>
procedure RenderNotes(const NotesText: IActiveText); override;
/// <summary>Finalises document and returns content as encoded data.
/// </summary>
function FinaliseDoc: TEncodedData; override;
end;
implementation
uses
// Delphi
SysUtils,
// Project
CS.ActiveText.Renderers.PlainText,
UConsts,
UStrUtils;
{ TTextSnippetDoc }
function TTextSnippetDoc.FinaliseDoc: TEncodedData;
begin
Result := TEncodedData.Create(fWriter.ToString, etUnicode);
fWriter.Free;
end;
procedure TTextSnippetDoc.InitialiseDoc;
begin
fWriter := TStringWriter.Create;
end;
procedure TTextSnippetDoc.RenderActiveText(ActiveText: IActiveText;
const Indent: Cardinal; const SpaceParas: Boolean);
var
Lines: TStringList;
begin
Lines := TStringList.Create;
try
Lines.Text := TActiveTextPlainTextRenderer.Render(
ActiveText, EOL, [ptrIgnoreInterBlockText, ptrIncludeURLs]
);
fWriter.WriteLine(
StrTrimRight(
StrWrap(Lines, cPageWidth - Indent, Indent, True)
)
);
finally
Lines.Free;
end;
end;
procedure TTextSnippetDoc.RenderCompilerInfo(const Heading: string;
const Info: TCompileDocInfoArray);
var
Idx: Integer; // loops compiler information table
begin
fWriter.WriteLine;
fWriter.WriteLine(Heading);
for Idx := Low(Info) to High(Info) do
fWriter.WriteLine('%-20s%s', [Info[Idx].Compiler, Info[Idx].Result]);
end;
procedure TTextSnippetDoc.RenderDescription(const Desc: IActiveText);
begin
fWriter.WriteLine;
RenderActiveText(Desc, 0, True);
end;
procedure TTextSnippetDoc.RenderHeading(const Heading: string);
begin
fWriter.WriteLine(Heading);
end;
procedure TTextSnippetDoc.RenderNotes(const NotesText: IActiveText);
begin
Assert(not NotesText.IsEmpty, ClassName + '.RenderNotes: NotesText is empty');
fWriter.WriteLine;
RenderActiveText(NotesText, 0, True);
end;
procedure TTextSnippetDoc.RenderSourceCode(const SourceCode: string);
begin
fWriter.WriteLine;
fWriter.WriteLine(SourceCode);
fWriter.WriteLine;
end;
procedure TTextSnippetDoc.RenderTitledList(const Title: string;
List: IStringList);
begin
RenderTitledText(Title, CommaList(List));
end;
procedure TTextSnippetDoc.RenderTitledText(const Title, Text: string);
begin
fWriter.WriteLine(Title);
fWriter.WriteLine(StrWrap(Text, cPageWidth - cIndent, cIndent));
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.