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
|
unit WarnAssignToFunctionName;
{(*}
(*------------------------------------------------------------------------------
Delphi Code formatter source code
The Original Code is WarnAssignToFunctionName, released May 2003.
The Initial Developer of the Original Code is Anthony Steele.
Portions created by Anthony Steele are Copyright (C) 1999-2008 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
------------------------------------------------------------------------------*)
{*)}
{$I JcfGlobal.inc}
interface
{ AFS 21 Sept 2001
warn of assignment to function name in old TurboPascal code
ie
function Fred: integer;
begin
Fred := 3;
end;
should be
function Fred: integer;
begin
Result := 3;
end;
}
uses Warning;
type
TWarnAssignToFunctionName = class(TWarning)
private
procedure WarnAllAssigns(const psFnName: string; const pcRoot: TObject);
public
constructor Create; override;
procedure PreVisitParseTreeNode(const pcNode: TObject); override;
end;
implementation
uses
{ delphi }
{$IFNDEF FPC}Windows,{$ENDIF} SysUtils,
{ local }
ParseTreeNode, ParseTreeNodeType, SourceToken, Tokens, TokenUtils;
{ get the node that represents the identifier that is being assigned to
node passed in will be statement
looking for the last id before the ':=',
e.g. in "TFoo(bar.baz) := fish;" we want "baz"
NB this may not work in complex examples as the id may be under an expr node
but may suffice for this fn name assign detection
}
function GetIdentifierBeforeAssign(const pcNode: TParseTreeNode): TSourceToken;
var
liLoop: integer;
lcDes: TParseTreeNode;
lcChildNode: TParseTreeNode;
lcSourceToken: TSourceToken;
begin
Result := nil;
Assert(pcNode <> nil);
lcDes := pcNode.GetImmediateChild(nDesignator);
Assert(lcDes <> nil);
for liLoop := 0 to lcDes.ChildNodeCount - 1 do
begin
lcChildNode := lcDes.ChildNodes[liLoop];
if lcChildNode.NodeType = nIdentifier then
begin
lcSourceToken := lcChildNode.FirstSolidLeaf as TSourceToken;
if lcSourceToken.WordType in IdentifierTypes then
Result := lcSourceToken;
end
else if lcChildNode.NodeType = nBracketedQual then
begin
// go inside the brackets - should be a designator in there
Result := GetIdentifierBeforeAssign(lcChildNode);
end
else if lcChildNode.NodeType = nAssignment then
break;
end;
end;
constructor TWarnAssignToFunctionName.Create;
begin
inherited;
HasPreVisit := True;
HasPostVisit := False;
HasSourceTokenVisit := False;
end;
procedure TWarnAssignToFunctionName.PreVisitParseTreeNode(const pcNode: TObject);
var
lcNode: TParseTreeNode;
lcFunctionHeading: TParseTreeNode;
lsName: string;
begin
lcNode := TParseTreeNode(pcNode);
if lcNode.NodeType <> nFunctionDecl then
exit;
{ we now have a function decl
Find the name, find the assign statements. Compare }
lcFunctionHeading := lcNode.GetImmediateChild([nFunctionHeading]);
Assert(lcFunctionHeading <> nil);
lsName := ExtractNameFromFunctionHeading(lcFunctionHeading, False);
WarnAllAssigns(lsName, lcNode);
end;
procedure TWarnAssignToFunctionName.WarnAllAssigns(const psFnName: string;
const pcRoot: TObject);
var
lcNode: TParseTreeNode;
lcLeftName: TSourceToken;
liLoop: integer;
begin
Assert(pcRoot <> nil);
lcNode := TParseTreeNode(pcRoot);
if (lcNode.NodeType = nStatement) and (lcNode.HasChildNode(nAssignment, 1)) then
begin
// this is an assign statement. Look at the LHS
lcLeftName := GetIdentifierBeforeAssign(lcNode);
Assert(lcLeftName <> nil, 'No id before assign');
if AnsiSameText(lcLeftName.SourceCode, psFnName) then
begin
SendWarning(lcLeftName,
'Assignment to the function name "' + psFnName +
'" is deprecated, Use assignment to "Result"');
end;
end
else
begin
// look at all nodes under here
for liLoop := 0 to lcNode.ChildNodeCount - 1 do
WarnAllAssigns(psFnName, lcNode.ChildNodes[liLoop]);
end;
end;
end.
|
