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
|
{(*}
(*------------------------------------------------------------------------------
Delphi Code formatter source code
The Original Code is MozComment.pas, released April 2000.
The Initial Developer of the Original Code is Anthony Steele.
Portions created by Anthony Steele are Copyright (C) 1999-2000 Anthony Steele.
All Rights Reserved.
Contributor(s): Anthony Steele.
The contents of this file are subject to the Mozilla Public License Version 1.1
(the "License"). you may not use this file except in compliance with the License.
You may obtain a copy of the License at http://www.mozilla.org/NPL/
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied.
See the License for the specific language governing rights and limitations
under the License.
Alternatively, the contents of this file may be used under the terms of
the GNU General Public License Version 2 or later (the "GPL")
See http://www.gnu.org/licenses/gpl.html
------------------------------------------------------------------------------*)
{*)}
unit MozComment;
{ AFS 24 march 2K
The Mozilla public licence requires that all files include a header comment
that specifies the licence.
Right now, my files don't
The easiest way to fix that, is this code below:
}
{$I JcfGlobal.inc}
interface
uses BaseVisitor, SourceToken;
type
TMozComment = class(TBaseTreeNodeVisitor)
private
fbWorkIsDone: boolean;
protected
public
constructor Create; override;
function VisitSourceToken(const pcToken: TObject): Boolean; override;
function IsIncludedInSettings: boolean; override;
end;
implementation
uses
{ delphi }
SysUtils,
{ local }
Tokens, TokenUtils, JcfSettings, JcfStringUtils,
SettingsTypes, ParseTreeNodeType, SetClarify;
const
{ this comment will be inserted in all files above the unit header }
MozURL = 'http://www.mozilla.org/NPL/';
MozCommentString: string =
NOFORMAT_ON + NativeLineBreak + // so this program can't easily obfuscate it out
'(*------------------------------------------------------------------------------' +
NativeLineBreak +
' Delphi Code formatter source code ' + NativeLineBreak + NativeLineBreak +
'The Original Code is <FileName>, released <Date>.' + NativeLineBreak +
'The Initial Developer of the Original Code is Anthony Steele. ' + NativeLineBreak +
'Portions created by Anthony Steele are Copyright (C) 1999-2000 Anthony Steele.' +
NativeLineBreak +
'All Rights Reserved. ' + NativeLineBreak +
'Contributor(s): Anthony Steele. ' + NativeLineBreak + NativeLineBreak +
'The contents of this file are subject to the Mozilla Public License Version 1.1' +
NativeLineBreak +
'(the "License"). you may not use this file except in compliance with the License.' +
NativeLineBreak +
'You may obtain a copy of the License at ' + MozURL + NativeLineBreak + NativeLineBreak +
'Software distributed under the License is distributed on an "AS IS" basis,' +
NativeLineBreak +
'WITHOUT WARRANTY OF ANY KIND, either express or implied.' + NativeLineBreak +
'See the License for the specific language governing rights and limitations ' +
NativeLineBreak +
'under the License.' + NativeLineBreak +
'------------------------------------------------------------------------------*)' +
NativeLineBreak + NOFORMAT_OFF + NativeLineBreak + NativeLineBreak;
function FirstOpportunityForMozInsert(const pt: TSourceToken): boolean;
begin
Result := False;
if (pt.TokenType = ttUses) and pt.HasParentNode(nUses, 2) and
pt.HasParentNode(TopOfProgramSections, 2) then
begin
{ just before first uses clause in program, etc }
Result := True;
end
else if (pt.TokenType = ttInterface) and pt.HasParentNode(nUnit, 2) then
begin
// before interface in unit
Result := True;
end;
end;
constructor TMozComment.Create;
begin
inherited;
fbWorkIsDone := False;
end;
function TMozComment.IsIncludedInSettings: boolean;
begin
Result := (not FormattingSettings.Obfuscate.Enabled) and
(FormattingSettings.Clarify.OnceOffs <> eDoNotRun)
end;
function TMozComment.VisitSourceToken(const pcToken: TObject): Boolean;
var
lsFile: string;
lsComment: string;
lcToken, lcNewComment: TSourceToken;
lbInContext: boolean;
begin
Result := False;
if fbWorkIsDone then
exit;
lcToken := TSourceToken(pcToken);
if (lcToken.TokenType = ttComment) and (Pos(MozURL, lcToken.SourceCode) > 0) then
begin
fbWorkIsDone := True;
exit;
end;
lbInContext := FirstOpportunityForMozInsert(lcToken);
if not lbInContext then
exit;
{ get the file name but remove the path
This will be inserted into the standard comment string
}
lsFile := JCFUnitName(lcToken);
lsComment := MozCommentString;
lsComment := StringReplace(lsComment, '<FileName>', lsFile, [rfReplaceAll]);
lsComment := StringReplace(lsComment, '<Date>', FormatDateTime('mmmm yyyy', Date),
[rfReplaceAll]);
// put the comment in front of the unit start word
lcNewComment := TSourceToken.Create;
lcNewComment.TokenType := ttComment;
lcNewComment.SourceCode := lsComment;
lcToken.Parent.InsertChild(lcToken.IndexOfSelf, lcNewComment);
fbWorkIsDone := True;
end;
end.
|
