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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
|
unit EditorConverter;
{(*}
(*------------------------------------------------------------------------------
Delphi Code formatter source code
The Original Code is EditorConverter.pas, released January 2001.
The Initial Developer of the Original Code is Anthony Steele.
Portions created by Anthony Steele are Copyright (C) 2001 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
------------------------------------------------------------------------------*)
{*)}
{ AFS 12 Jan 2K
Converter class for the IDE pluggin
}
{$I JcfGlobal.inc}
interface
uses
Classes,
{$ifdef fpc}
{ lazarus design time }
SrcEditorIntf, LazUTF8,
{$else}
{ delphi design time }
ToolsAPI,
{$endif}
{ local }
Converter, ConvertTypes;
type
TEditorConverter = class(TObject)
private
{ the string -> string converter }
fcConverter: TConverter;
{ state }
fOnStatusMessage: TStatusMessageProc;
fsCurrentUnitName: string;
fiConvertCount: integer;
procedure SendStatusMessage(const psUnit, psMessage: string;
const peMessageType: TStatusMessageType;
const piY, piX: integer);
function GetOnStatusMessage: TStatusMessageProc;
procedure SetOnStatusMessage(const Value: TStatusMessageProc);
{$ifdef fpc}
function ReadFromIDE(const pcUnit: TSourceEditorInterface): string;
procedure WriteToIDE(const pcUnit: TSourceEditorInterface; const psText: string);
{$else}
function ReadFromIDE(const pcUnit: IOTASourceEditor): string;
procedure WriteToIDE(const pcUnit: IOTASourceEditor; const psText: string);
{$endif}
procedure FinalSummary;
function OriginalFileName: string;
protected
public
constructor Create;
destructor Destroy; override;
{$ifdef fpc}
procedure Convert(const pciUnit: TSourceEditorInterface);
{$else}
procedure Convert(const pciUnit: IOTASourceEditor);
{$endif}
procedure Clear;
function ConvertError: Boolean;
function TokenCount: integer;
procedure BeforeConvert;
procedure AfterConvert;
property OnStatusMessage: TStatusMessageProc read GetOnStatusMessage write SetOnStatusMessage;
end;
implementation
uses
{ delphi }
SysUtils, Math,
{ local }
JcfLog, JcfRegistrySettings, JcfMiscFunctions;
constructor TEditorConverter.Create;
begin
inherited;
fcConverter := TConverter.Create;
fcConverter.OnStatusMessage := SendStatusMessage;
end;
destructor TEditorConverter.Destroy;
begin
FreeAndNil(fcConverter);
inherited;
end;
{$ifdef fpc}
procedure TEditorConverter.Convert(const pciUnit: TSourceEditorInterface);
begin
Assert(pciUnit <> nil);
if not GetRegSettings.HasRead then
GetRegSettings.ReadAll;
{ check for read-only }
if pciUnit.ReadOnly then
begin
SendStatusMessage(pciUnit.FileName, 'Unit is read only. Cannot format ',
mtInputError, -1, -1);
exit;
end;
fsCurrentUnitName := pciUnit.FileName;
fcConverter.InputCode := ReadFromIDE(pciUnit);
// now convert
fcConverter.Convert;
fsCurrentUnitName := '';
if not ConvertError then
begin
WriteToIDE(pciUnit, fcConverter.OutputCode);
SendStatusMessage(pciUnit.FileName, 'Formatted unit', mtProgress, -1, -1);
Inc(fiConvertCount);
end;
end;
function TEditorConverter.ReadFromIDE(const pcUnit: TSourceEditorInterface): string;
begin
Result := pcUnit.Lines.Text;
end;
procedure TEditorConverter.WriteToIDE(const pcUnit: TSourceEditorInterface; const psText: string);
var
lcSourceLines, lcDestLines: TStrings;
lcSameStart, lcSameEnd: TStrings;
lsSourceLine, lsDestLine: string;
liStart, liIndex, liMaxIndex: integer;
hasSourceLine: Boolean;
begin
if pcUnit = nil then
exit;
lcSourceLines := TStringList.Create;
lcSourceLines.Text := fcConverter.InputCode;
lcDestLines := TStringList.Create;
lcDestLines.Text := psText;
lcSameStart := TStringList.Create;
lcSameEnd := TStringList.Create;
SplitIntoChangeSections(lcSourceLines, lcDestLines, lcSameStart, lcSameEnd);
try
pcUnit.BeginUpdate;
pcUnit.BeginUndoBlock;
liStart := lcSameStart.Count;
liIndex := 0;
liMaxIndex := Max(lcSourceLines.Count, lcDestLines.Count);
while (liIndex < liMaxIndex) do
begin
hasSourceLine := liIndex < lcSourceLines.Count;
if hasSourceLine then
lsSourceLine := lcSourceLines[liIndex]
else
lsSourceLine := '';
if liIndex < lcDestLines.Count then
lsDestLine := lcDestLines[liIndex]
else
lsDestLine := '';
if not hasSourceLine then
pcUnit.InsertLine(liStart + liIndex + 1, lsDestLine, True)
else
if not AnsiSameStr(lsSourceLine, lsDestLine) then
// the line is different, replace it
pcUnit.ReplaceLines(liStart + liIndex + 1, liStart + liIndex + 1, lsDestLine, True);
inc(liIndex);
end;
finally
pcUnit.EndUndoBlock;
pcUnit.EndUpdate;
lcSourceLines.Free;
lcDestLines.Free;
lcSameStart.Free;
lcSameEnd.Free;
end;
end;
{$else}
procedure TEditorConverter.Convert(const pciUnit: IOTASourceEditor);
var
lcBuffer: IOTAEditBuffer;
begin
Assert(pciUnit <> nil);
if not GetRegSettings.HasRead then
GetRegSettings.ReadAll;
{ check for read-only }
pciUnit.QueryInterface(IOTAEditBuffer, lcBuffer);
if pciUnit <> nil then
begin
lcBuffer := pciUnit as IOTAEditBuffer;
if lcBuffer.IsReadOnly then
begin
SendStatusMessage(lcBuffer.FileName, 'Unit is read only. Cannot format ',
mtInputError, -1, -1);
exit;
end;
end;
fsCurrentUnitName := lcBuffer.FileName;
fcConverter.InputCode := ReadFromIDE(pciUnit);
// now convert
fcConverter.Convert;
fsCurrentUnitName := '';
if not ConvertError then
begin
WriteToIDE(pciUnit, fcConverter.OutputCode);
SendStatusMessage(lcBuffer.FileName, 'Formatted unit', mtProgress, -1, -1);
Inc(fiConvertCount);
end;
end;
function TEditorConverter.ReadFromIDE(const pcUnit: IOTASourceEditor): string;
const
// 10 kb at a time should do it
BUF_SIZE = 10240;
//BUF_SIZE = 120; // small for testing
var
lciEditorReader: IOTAEditReader;
lsBuf: AnsiString;
lpBuf: PAnsiChar;
liActualSize, liPos: integer;
lbDone: boolean;
//liLoopCount: integer;
begin
{ get a reader from the unit }
Assert(pcUnit <> nil);
lciEditorReader := pcUnit.CreateReader;
Assert(lciEditorReader <> nil);
Result := '';
// read it all. Unfortunately the API dictates that we will work in chunks
liPos := 0;
//liLoopCount := 0;
lbDone := False;
while not lbDone do
begin
// clear the buffer
SetLength(lsBuf, BUF_SIZE);
lpBuf := PAnsiChar(lsBuf);
FillChar(lpBuf^, BUF_SIZE, 0);
// get some text into the buffer
liActualSize := lciEditorReader.GetText(liPos, lpBuf, BUF_SIZE);
// store it
{WP: Do not add the entire lsBuf to fsSource, as in cases where the entire source is less
than 10Kb in total, there will be junk in the last part of the buffer.
If this is copied, it shows up as extraneous tokens in the token list
after the end of the unit proper.
This then causes an assertion failure in procedure DoConvertUnit in unit Converter.pas,
When these extra tokens are found that were not consumed by BuildParseTree
The way is to ensure that you only append as many characters as you've actually read (liActualSize bytes)
from the buffer into the result. }
Result := Result + string(Copy(lsBuf, 1, liActualSize));
//WP: Changed from just adding lsBuf
// more stuff to read after this?
liPos := liPos + liActualSize;
lbDone := (liActualSize < BUF_SIZE);
//inc(liLoopCount);
end;
end;
{ write the text back to the ide
this is not as simple as you may think
identical lines of text are skipped over not written
( not in all cases, but the simple cases are covered)
so as to preserve the editor's notion of what has changed and what has not
}
procedure TEditorConverter.WriteToIDE(const pcUnit: IOTASourceEditor; const psText: string);
var
lciEditorWriter: IOTAEditWriter;
lsOriginalSource: string;
liSourcePos{, liDestPos}: integer;
lcSourceLines, lcDestLines: TStrings;
lcSameStart, lcSameEnd: TStrings;
lsSourceLine, lsDestLine: string;
liIndex, liMaxIndex: integer;
begin
if pcUnit = nil then
exit;
lciEditorWriter := pcUnit.CreateUndoableWriter;
Assert(lciEditorWriter <> nil);
liSourcePos := 0;
lsOriginalSource := fcConverter.InputCode;
lcSourceLines := SplitIntoLines(lsOriginalSource);
lcDestLines := SplitIntoLines(psText);
lcSameStart := TStringList.Create;
lcSameEnd := TStringList.Create;
SplitIntoChangeSections(lcSourceLines, lcDestLines, lcSameStart, lcSameEnd);
try
// clear off identical text at the start
for liIndex := 0 to lcSameStart.Count - 1 do
begin
liSourcePos := liSourcePos + Length(lcSameStart[liIndex]);
end;
lciEditorWriter.CopyTo(liSourcePos);
//liDestPos := liSourcePos;
{ loop through all lines in in and out
if they're the same, copy the line
else overwrite }
liIndex := 0;
liMaxIndex := Max(lcSourceLines.Count, lcDestLines.Count);
while (liIndex < liMaxIndex) do
begin
if liIndex < lcSourceLines.Count then
lsSourceLine := lcSourceLines[liIndex]
else
lsSourceLine := '';
if liIndex < lcDestLines.Count then
lsDestLine := lcDestLines[liIndex]
else
lsDestLine := '';
liSourcePos := liSourcePos + Length(lsSourceLine);
//liDestPos := liDestPos + Length(lsDestLine);
if AnsiSameStr(lsSourceLine, lsDestLine) then
begin
// the line is the same, copy it
lciEditorWriter.CopyTo(liSourcePos);
end
else
begin
// the line is different, replace it
lciEditorWriter.DeleteTo(liSourcePos);
if lsDestLine <> '' then
lciEditorWriter.Insert(PAnsiChar(AnsiString(lsDestLine)));
end;
inc(liIndex);
end;
// clear off identical text at the end
for liIndex := 0 to lcSameEnd.Count - 1 do
begin
liSourcePos := liSourcePos + Length(lcSameEnd[liIndex]);
end;
lciEditorWriter.CopyTo(liSourcePos);
finally
lcSourceLines.Free;
lcDestLines.Free;
lcSameStart.Free;
lcSameEnd.Free;
end;
end;
{$endif}
procedure TEditorConverter.AfterConvert;
begin
FinalSummary;
Log.CloseLog;
if GetRegSettings.ViewLogAfterRun then
GetRegSettings.ViewLog;
end;
procedure TEditorConverter.Clear;
begin
fcConverter.Clear;
end;
function TEditorConverter.ConvertError: Boolean;
begin
Result := fcConverter.ConvertError;
end;
function TEditorConverter.GetOnStatusMessage: TStatusMessageProc;
begin
Result := fOnStatusMessage;
end;
function TEditorConverter.OriginalFileName: string;
begin
if fsCurrentUnitName <> '' then
Result := fsCurrentUnitName
else
Result := 'IDE';
end;
procedure TEditorConverter.SendStatusMessage(const psUnit, psMessage: string;
const peMessageType: TStatusMessageType;
const piY, piX: integer);
var
lsUnit: string;
begin
lsUnit := psUnit;
if lsUnit = '' then
lsUnit := OriginalFileName;
if Assigned(fOnStatusMessage) then
fOnStatusMessage(lsUnit, psMessage, peMessageType, piY, piX);
end;
procedure TEditorConverter.SetOnStatusMessage(const Value: TStatusMessageProc);
begin
fOnStatusMessage := Value;
end;
function TEditorConverter.TokenCount: integer;
begin
Result := fcConverter.TokenCount;
end;
procedure TEditorConverter.FinalSummary;
var
lsMessage: string;
begin
if fiConvertCount = 0 then
begin
if ConvertError then
lsMessage := 'Aborted due to error'
else
lsMessage := 'Nothing done';
end
{
else if fbAbort then
lsMessage := 'Aborted after ' + DescribeFileCount(fiConvertCount)
}
else if fiConvertCount > 1 then
lsMessage := 'Finished processing ' + DescribeFileCount(fiConvertCount)
else
lsMessage := '';
if lsMessage <> '' then
SendStatusMessage('', lsMessage, mtFinalSummary, -1, -1);
Log.EmptyLine;
Log.Write(lsMessage);
end;
procedure TEditorConverter.BeforeConvert;
begin
fiConvertCount := 0;
end;
end.
|