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
|
{
***************************************************************************
* *
* This source is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This code is distributed in the hope that it will be useful, but *
* WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* General Public License for more details. *
* *
* A copy of the GNU General Public License is available on the World *
* Wide Web at <http://www.gnu.org/copyleft/gpl.html>. You can also *
* obtain it by writing to the Free Software Foundation, *
* Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1335, USA. *
* *
***************************************************************************
Abstract:
This package (QuickFixExample.lpk) demonstrates:
- How to write an IDE package.
When You install it will register a Quick Fix item.
- How to write Quick Fix item for compiler messages
'Parameter "Sender" not used'
- How to use the codetools to
* parsing a unit
* conversion of Filename,Line,Column to codetools source position
* finding a codetools node at a cursor position
* finding a procedure node and the begin..end node
* creating a nice insertion position for a statement at the beginning of
the begin..end block
* getting the indentation of a line, so that the new line will
work in sub procedure as well
* inserting code with the codetools
}
unit QuickFixDemo1;
{$mode objfpc}{$H+}
interface
uses
Classes, SysUtils, LCLProc, Dialogs,
CodeTree, PascalParserTool, SourceChanger, CodeCache, CodeToolManager,
IDEMsgIntf, LazIDEIntf, IDEExternToolIntf;
type
{ TQuickFixParemNotUsedAddAssert }
TQuickFixParemNotUsedAddAssert = class(TMsgQuickFix)
public
function IsApplicable(Msg: TMessageLine; out Identifier: string): boolean;
procedure CreateMenuItems(Fixes: TMsgQuickFixes); override;
procedure QuickFix({%H-}Fixes: TMsgQuickFixes; Msg: TMessageLine); override;
end;
function ParseCode(Msg: TMessageLine;
out CodeBuf: TCodeBuffer; out ACodeTool: TCodeTool): boolean;
function CaretToSourcePosition(ACodeTool: TCodeTool; CodeBuf: TCodeBuffer;
Line, Column: integer; out CleanPos: Integer): boolean;
procedure Register;
implementation
function ParseCode(Msg: TMessageLine; out CodeBuf: TCodeBuffer; out
ACodeTool: TCodeTool): boolean;
// commits any editor changes to the codetools, parses the unit
// and if there is a syntax error, tells the IDE jump to it
begin
Result:=false;
if Msg=nil then exit;
CodeBuf:=CodeToolBoss.LoadFile(Msg.GetFullFilename,true,false);
if CodeBuf=nil then exit;
if not LazarusIDE.BeginCodeTools then begin
DebugLn(['QuickFixDemo1 ParseCode failed because IDE busy']);
exit;
end;
if not CodeToolBoss.Explore(CodeBuf,ACodeTool,false) then begin
LazarusIDE.DoJumpToCodeToolBossError;
exit;
end;
Result:=true;
end;
function CaretToSourcePosition(ACodeTool: TCodeTool;
CodeBuf: TCodeBuffer; Line, Column: integer;
out CleanPos: Integer): boolean;
// find the source position in the parsed
// The parsed source is the source combined of all include files
// stripped of irrelevant IFDEFs and parsed macros.
var
CursorPos: TCodeXYPosition;
begin
CursorPos.X:=Column;
CursorPos.Y:=Line;
CursorPos.Code:=CodeBuf;
if ACodeTool.CaretToCleanPos(CursorPos,CleanPos)<>0 then begin
DebugLn('QuickFixSenderParameterNotUsed invalid code position line=',dbgs(line),' col=',dbgs(Column));
Result:=false;
end else
Result:=true;
end;
procedure Register;
begin
MsgQuickFixes.RegisterQuickFix(TQuickFixParemNotUsedAddAssert.Create);
end;
{ TQuickFixParemNotUsedAddAssert }
function TQuickFixParemNotUsedAddAssert.IsApplicable(Msg: TMessageLine; out
Identifier: string): boolean;
var
Dummy: string;
begin
Result:=false;
// Check: Parameter "$1" not used
if not IDEFPCParser.MsgLineIsId(Msg,5024,Identifier,Dummy) then
exit;
if not Msg.HasSourcePosition or not IsValidIdent(Identifier) then exit;
Result:=true;
end;
procedure TQuickFixParemNotUsedAddAssert.CreateMenuItems(Fixes: TMsgQuickFixes);
var
i: Integer;
Msg: TMessageLine;
Identifier: string;
begin
for i:=0 to Fixes.LineCount-1 do begin
Msg:=Fixes.Lines[i];
if not IsApplicable(Msg,Identifier) then continue;
Fixes.AddMenuItem(Self, Msg, 'Add Assert('+Identifier+'=nil);');
exit;
end;
end;
procedure TQuickFixParemNotUsedAddAssert.QuickFix(Fixes: TMsgQuickFixes;
Msg: TMessageLine);
var
Identifier: string;
CodeBuf: TCodeBuffer;
ACodeTool: TCodeTool;
CleanPos: Integer;
ProcNode: TCodeTreeNode;
BeginNode: TCodeTreeNode;
SourceChangeCache: TSourceChangeCache;
InsertPos: Integer;
Indent: Integer;
Beauty: TBeautifyCodeOptions;
begin
if not IsApplicable(Msg,Identifier) then exit;
// parse the code and find the source position
if not ParseCode(Msg,CodeBuf,ACodeTool) then exit;
if not CaretToSourcePosition(ACodeTool,CodeBuf,Msg.Line,Msg.Column,CleanPos) then exit;
// find procedure node
ProcNode:=ACodeTool.FindDeepestNodeAtPos(CleanPos,false);
if ProcNode<>nil then
ProcNode:=ProcNode.GetNodeOfType(ctnProcedure);
if ProcNode=nil then begin
DebugLn('TQuickFixParemNotUsedAddAssert.QuickFix no procedure with begin..end at code position line=',dbgs(Msg.Line),' col=',dbgs(Msg.Column));
exit;
end;
BeginNode:=ACodeTool.FindProcBody(ProcNode);
if BeginNode=nil then begin
// this procedure has no begin..end -> search corresponding pocedure node
ProcNode:=ACodeTool.FindCorrespondingProcNode(ProcNode,[phpAddClassName,phpInUpperCase]);
if ProcNode=nil then begin
DebugLn('TQuickFixParemNotUsedAddAssert.QuickFix no corresponding procedure with begin..end at code position line=',dbgs(Msg.Line),' col=',dbgs(Msg.Column));
exit;
end;
BeginNode:=ACodeTool.FindProcBody(ProcNode);
if BeginNode=nil then begin
DebugLn('TQuickFixParemNotUsedAddAssert.QuickFix corresponding procedure at code position line=',dbgs(Msg.Line),' col=',dbgs(Msg.Column),' has no begin..end');
exit;
end;
end;
// find insert postion after the 'begin' keyword
SourceChangeCache:=CodeToolBoss.SourceChangeCache;
SourceChangeCache.MainScanner:=ACodeTool.Scanner;
InsertPos:=BeginNode.StartPos+length('begin');
Beauty:=SourceChangeCache.BeautifyCodeOptions;
// define a nice indentation
Indent:=Beauty.GetLineIndent(ACodeTool.Src,InsertPos);
inc(Indent,SourceChangeCache.BeautifyCodeOptions.Indent);
// change source
try
if not SourceChangeCache.Replace(gtNewLine,gtNewLine,InsertPos,InsertPos,
Beauty.GetIndentStr(Indent)+'Assert(Sender=nil);')
then
raise Exception.Create('TQuickFixParemNotUsedAddAssert.QuickFix insertion impossible');
if not SourceChangeCache.Apply then
raise Exception.Create('TQuickFixParemNotUsedAddAssert.QuickFix changing source failed');
// message fixed -> clean
Msg.Msg:='';
except
on E: Exception do begin
MessageDlg('Error',E.Message,mtError,[mbCancel],0);
end;
end;
end;
end.
|
