-
Notifications
You must be signed in to change notification settings - Fork 21
/
EditorEngine.pas
7818 lines (6881 loc) · 217 KB
/
EditorEngine.pas
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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
unit EditorEngine;
{$mode objfpc}{$H+}
{$ModeSwitch advancedrecords}
{$modeswitch arrayoperators}
{$INTERFACES CORBA}//Needed for interfaces without guid
{**
* Mini Edit
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Zaher Dirkey
*}
{**
FileName = c:\temp\myfile.ext
File = myfile.ext
NickName = myfile
FilePath = c:\temp\
Categories: list
Category: object have have highlighter, autocomplete ...
Groups: list
Group: object Have multiple extension externsions that all same type, Group.Name is not an extension
Extensions (pas, pp, inc)
Portable Notes:
Main folder related to project folder, Project folder related to Project File folder
Paths in Variables should not delimited by PathDelimiter, use ExcludePathDelimiter()
}
interface
uses
Messages, SysUtils, Forms, StdCtrls, StrUtils, DateUtils, Dialogs, Variants, Classes, Menus, Controls,
LMessages, LCLIntf, LConvEncoding, LazUTF8, LazStringUtils, fgl, LCLType,
FileUtil, LazFileUtils, Math, Masks,
Graphics, Contnrs, Types, IniFiles,
EditorOptions, EditorColors, EditorProfiles,
SynBeautifier, SynEditMarks, mnSynCompletion, mnSynParamsHint, SynEditAutoComplete,
SynEditTypes, SynEditMiscClasses, SynEditPlugins, SynPluginTemplateEdit,
SynEditHighlighter, SynEditKeyCmds, SynEditMarkupBracket, SynEditSearch, ColorUtils,
SynEdit, SynEditTextTrimmer, SynTextDrawer, SynGutterBase, SynEditPointClasses, SynMacroRecorder,
mncCSV, mnXMLRttiProfile, mnXMLUtils, mnClasses,
mnUtils, EditorClasses, EditorRun,
ntvUtils;
type
TThreeStates = (stateNone, stateFalse, stateTrue);
TSynCompletionType = (ctCode, ctHint, ctParams);
TEditorEngine = class;
TVirtualCategory = class;
TVirtualCategoryClass = class of TVirtualCategory;
TFileGroup = class;
TFileGroups = class;
TEditorFile = class;
TEditorProject = class;
TRunOptions = class;
EEditorException = class(Exception)
private
FErrorLine: Integer;
public
property ErrorLine: Integer read FErrorLine write FErrorLine;
end;
IEditorOptions = interface
['{3D32B7C6-7D6A-4E95-B616-4374BCDAAD37}']
procedure Apply;
procedure Retrieve;
end;
IEditorProjectFrame = interface
['{C5D191FE-D449-4EB4-9D7D-E3E53DBB89FA}']
function GetProject: TEditorProject;
property Project: TEditorProject read GetProject;
end;
IEditorControl = interface
['{8C2646A1-2738-4830-8107-CF8753D14EBD}']
end;
{ GXMLItems }
generic GXMLItems<_Object_> = class(TmnXMLItems) //TODO move it to mnXMLRttiProfile
private
function GetItem(Index: Integer): _Object_;
procedure SetItem(Index: Integer; const Value: _Object_);
public
function DoCreateItem(AClass: TmnXMLItemClass): TmnXMLItem; override;
property Items[Index: Integer]: _Object_ read GetItem write SetItem; default;
published
end;
{ TStringsHelper }
TStringsHelper = class helper for TStrings
public
procedure Merge(FromStrings: TStrings; Overwrite: Boolean = False);
procedure Merge(Name, Value: String; Overwrite: Boolean = False);
end;
TScannedValue = class(TmnObject)
public
Line: Integer;
X1,X2: Integer;
Text: string;
Value: string;
end;
{ TScannedValues }
TScannedValues = class(specialize TmnObjectList<TScannedValue>)
public
procedure Add(
Line: Integer;
X1,X2: Integer;
Text: string;
Value: string
);
end;
{ TKeywordItem }
TKeywordItem = class(TmnNamedObject)
private
FParams: TStringList;
public
Display: string;
AttributeType: TAttributeType;
AttributeName: string; //* keyword, const, function, event, value etc
Template: string; //* name(count: integer) { | }
Description: string;
Temp: Boolean; //*
constructor Create;
destructor Destroy; override;
property Params: TStringList read FParams;
end;
{ TKeywordList }
TKeywordList = class(specialize TmnNamedObjectList<TKeywordItem>)
public
procedure LoadFromFile(FileName: string); virtual;
procedure Clean;// Delete temp items
function AddItem(AName, ADisplay, AttributeName: string; AttributeType: TAttributeType; AsTemp: Boolean = False): TKeywordItem;
procedure Sort;
end;
{ TmneSynCompletionForm }
TmneSynCompletionForm = class(TSynVirtualCompletionForm)
private
FKeywords: TKeywordList;
protected
function GetItemText(Index: Integer): string; override;
function GetItemDisplay(Index: Integer): string; override;
function GetItemsCount: Integer; override;
public
constructor Create(AOwner: Tcomponent); override;
destructor Destroy; override;
property Keywords: TKeywordList read FKeywords;
end;
{ TmneSynCompletion }
TmneSynCompletion = class(TSynBaseCompletion)
protected
function GetCompletionFormClass: TSynVirtualCompletionFormClass; override;
function OwnedByEditor: Boolean; override;
procedure OnSynCompletionNextChar(Sender: TObject);
procedure OnSynCompletionPrevChar(Sender: TObject);
procedure OnSynCompletionKeyPress(Sender: TObject; var Key: Char);
procedure OnSynCompletionUTF8KeyPress(Sender: TObject; var UTF8Key: TUTF8Char);
public
constructor Create(AOwner: TComponent); override;
procedure Sort; override;
procedure Clear; override;
end;
{ TmneSynEditAutoComplete }
TmneSynEditAutoComplete = class(TSynEditAutoComplete)
public
procedure ParseCompletionList; override;
end;
TmneSynEditCommand = (mscUUID); // msPaused = paused recording
{ TmneSynEditPlugin }
TmneSynEditPlugin = class(TAbstractSynHookerPlugin)
protected
FCommandIDs: array [TmneSynEditCommand] of TSynEditorCommand;
FShortCuts: array [TmneSynEditCommand] of TShortCut;
procedure OnCommand(Sender: TObject; AfterProcessing: Boolean; var Handled: Boolean; var Command: TSynEditorCommand; var aChar: TUTF8Char; Data: pointer; HandlerData: pointer); override;
procedure DoEditorAdded(AValue: TCustomSynEdit); override;
procedure DoEditorRemoving(AValue: TCustomSynEdit); override;
public
constructor Create(aOwner: TComponent); override;
end;
{ TmneSynBeautifier }
TmneSynBeautifier = class(TSynBeautifier)
protected
procedure DoBeforeCommand(const ACaret: TSynEditCaret; var Command: TSynEditorCommand); override;
public
constructor Create(AOwner: TComponent); override;
end;
{ TEditorExtension }
TEditorExtension = class(TmnNamedObject)
public
ImageIndex: Integer;
end;
{ TEditorExtensions }
TEditorExtensions = class(specialize TmnNamedObjectList<TEditorExtension>)
private
public
procedure Add(Name: String; ImageIndex: Integer = -1);
end;
TTextEditorFile = class;
{ TmneSynEdit }
TmneSynEdit = class(TSynEdit)
protected
FEditorFile: TTextEditorFile;
FmneSynBeautifier: TmneSynBeautifier;
procedure DoOnShowHint(HintInfo: PHintInfo); override;
public
constructor Create(AOwner: TComponent); override;
destructor Destroy; override;
procedure ExecuteCommand(Command: TSynEditorCommand; const AChar: TUTF8Char; Data: pointer); override;
property EditorFile: TTextEditorFile read FEditorFile;
end;
{ TEditorDesktopFile }
TEditorDesktopFile = class(TCollectionItem)
private
FFileName: String;
FFileParams: String;
FCaretY: Integer;
FCaretX: Integer;
FTopLine: Integer;
public
constructor Create(ACollection: TCollection); override;
published
property FileName: String read FFileName write FFileName;
property FileParams: String read FFileParams write FFileParams;
property CaretX: Integer read FCaretX write FCaretX default 1;
property CaretY: Integer read FCaretY write FCaretY default 1;
property TopLine: Integer read FTopLine write FTopLine default 1;
end;
{ TEditorDesktopFiles }
TEditorDesktopFiles = class(TCollection)
private
FCurrentFile: String;
FCurrentFolder: String;
function GetItems(Index: Integer): TEditorDesktopFile;
protected
public
function Add(FileName: String): TEditorDesktopFile;
function Find(vName: String): TEditorDesktopFile;
function IsExist(vName: String): Boolean;
property Items[Index: Integer]: TEditorDesktopFile read GetItems; default;
published
property CurrentFile: String read FCurrentFile write FCurrentFile;
property CurrentFolder: String read FCurrentFolder write FCurrentFolder;
end;
{ TmneBreakpoint }
TmneBreakpoint = class(TmnXMLItem)
private
FFileName: String;
FLineNo: Integer;
public
ID: Integer;
Handle: Integer;
published
property FileName: String read FFileName write FFileName;
property LineNo: Integer read FLineNo write FLineNo;
end;
{ TmneBreakpoints }
TmneBreakpoints = class(specialize GXMLItems<TmneBreakpoint>)
private
public
procedure Add(AFileName: String; ALineNo: Integer);
end;
{ TmneWatch }
TmneWatch = class(TmnXMLItem)
private
FName: String;
public
ID: Integer;
Handle: Integer;
published
property Name: String read FName write FName;
end;
{ TmneWatches }
TmneWatches = class(specialize GXMLItems<TmneWatch>)
private
public
procedure Add(AName: String);
end;
TEditorDesktop = class(TPersistent)
private
FBreakpoints: TmneBreakpoints;
FWatches: TmneWatches;
FFiles: TEditorDesktopFiles;
FProject: TEditorProject;
public
constructor Create;
destructor Destroy; override;
procedure Load;
procedure Save;
property Project: TEditorProject read FProject;
published
property Breakpoints: TmneBreakpoints read FBreakpoints; //for saving loading Breakpoints
property Watches: TmneWatches read FWatches; //same
property Files: TEditorDesktopFiles read FFiles;
end;
TAddFrameCallBack = procedure(AFrame: TFrame) of object;
TAddClickCallBack = procedure(Name, Caption, ParentMenu: String; OnClickEvent: TNotifyEvent; ShortCut: TShortCut = 0) of object;
TEnumVariablesSkip = (evsFile, evsCategory, evsTendicy, evsProject, evsEngine, evsDefaultPath, evsEnviroment);
TEnumVariablesSkips = set of TEnumVariablesSkip;
TFileGroupKind = (
fgkDefault,
fgkText, //Is it an Text Editor like SQL or PHP
fgkUneditable, // Can't be editable
fgkBinary, // Like Database SQLite
fgkShell,//TODO: Executable but hi priority, override the main file or project tendency
fgkMain,//this can be the main file for project
fgkResult,//Result file, generated, like: exe or .o or .hex
fgkBrowsable,//When open file show it in the extension list
fgkAssociated, //Editor can be the editor of this files, like .php, .inc, but .txt is not
//fgkTemporary, //No need to save it to run, but save it when user ask to save
fgkFolding,
fgkVirtual //Not a real file, like output console
);
TFileGroupKinds = set of TFileGroupKind;
{
Tendency
Run, Compile, Collect file groups and have special properties
}
TRunCapability = (
capErrors,
capStop, //Stop executing or compiling
capLint, //Check error of file without compiling or run
capCompile, //Can compile this file
capExecute, //Can run this file
capLink, //Can need link before run
capDebug, //we can debug the project/file
capEval, //Debugger can evaluate
capTrace, //Steps (Step Into, Step Over etc...)
capUpload, //Have upload, like avr projects need to upload to mcu
capDebugServer, //PHP style need to start debug server
capTransaction //Database
);
TRunCapabilities = set of TRunCapability;
{ TEditorProjectOptions }
TEditorProjectOptions = class(TPersistent)
private
FIndentMode: TIndentMode;
FOverrideEditorOptions: Boolean;
FTabWidth: Integer;
public
constructor Create; virtual; //do delete it, need to override it
destructor Destroy; override;
procedure CreateOptionsFrame(AOwner: TComponent; AProject: TEditorProject; AddFrame: TAddFrameCallBack); virtual;
procedure CreateProjectPanel(AOwner: TComponent; AProject: TEditorProject; var AFrame: TFrame); virtual;
published
property OverrideEditorOptions: Boolean read FOverrideEditorOptions write FOverrideEditorOptions default False;
property TabWidth: Integer read FTabWidth write FTabWidth default 4;
property IndentMode: TIndentMode read FIndentMode write FIndentMode default idntTabsToSpaces;
end;
{ TEditorTendency }
TEditorTendency = class abstract(TTendency)
private
FDefaultPath: string;
FEnableMacros: Boolean;
FGroups: TFileGroups;
FOutputExtension: String;
FRunOptions: TRunOptions;
FIndentMode: TIndentMode;
FOverrideEditorOptions: Boolean;
FTabWidth: Integer;
function GetIsDefault: Boolean; virtual; //Keep it private
protected
IsPrepared: Boolean;
FCapabilities: TRunCapabilities;
FHaveOptions: Boolean;
procedure AddGroup(vName: String; vCategory: TVirtualCategory);
procedure AddGroup(vName, vCategory: String);
procedure AddGroup(vName: String; vCategoryClass: TVirtualCategoryClass);
function CreateDebugger: TEditorDebugger; virtual;
procedure Init; virtual;
procedure Created; virtual;
procedure DoRun(Info: TmneRunInfo); virtual;
procedure InternalRun(RunActions: TmneRunActions);
public
constructor Create; override;
destructor Destroy; override;
procedure HelpKeyword(AWord: String); virtual;
procedure Run(RunActions: TmneRunActions);
procedure SendMessage(S: String; vMessageType: TNotifyMessageType); override;
procedure CreateOptionsFrame(AOwner: TComponent; AddFrame: TAddFrameCallBack); virtual;
function CreateProjectOptions: TEditorProjectOptions; virtual;
function CreateProject: TEditorProject; virtual;
property HaveOptions: Boolean read FHaveOptions;
procedure PrepareSynEdit(SynEdit: TSynEdit); virtual;
procedure EnumRunCommands(Items: TStrings); virtual;
function GetDefaultGroup: TFileGroup;
//OSDepended: When save to file, the filename changed depend on the os system name
procedure Prepare;
procedure Unprepare;
//
property Capabilities: TRunCapabilities read FCapabilities;
function Can(ACapability: TRunCapability): Boolean;
function CanAny(ACapability: TRunCapabilities): Boolean;
procedure EnumVariables(Values: TStringList; EnumSkips: TEnumVariablesSkips); virtual;
function ReplaceVariables(S: String; EnumSkips: TEnumVariablesSkips): String; virtual;
procedure UpdatePath; virtual;
property Groups: TFileGroups read FGroups;
property IsDefault: Boolean read GetIsDefault;
property OutputExtension: String read FOutputExtension write FOutputExtension;
property DefaultPath: string read FDefaultPath;
published
//Override options
property OverrideEditorOptions: Boolean read FOverrideEditorOptions write FOverrideEditorOptions default False;
property TabWidth: Integer read FTabWidth write FTabWidth default 4;
property IndentMode: TIndentMode read FIndentMode write FIndentMode default idntTabsToSpaces;
property RunOptions: TRunOptions read FRunOptions;// write FRunOptions;
property EnableMacros: Boolean read FEnableMacros write FEnableMacros default False;
end;
TEditorTendencyClass = class of TEditorTendency;
{ TDefaultTendency }
{
used only if no Tendency defined
}
TDefaultTendency = class(TEditorTendency)
private
function GetIsDefault: Boolean; override;
protected
procedure Init; override;
procedure Created; override;
public
end;
TSCMCapability = set of (scmPush, scmCommit, scmCommitFile, scmCommitPath, scmUpdateFile);
{ TEditorSCM }
TEditorSCM = class(TEditorElement)
private
protected
procedure Execute(App, Cmd: String); virtual; abstract;
public
constructor Create; override;
destructor Destroy; override;
procedure CommitDirectory(Directory: String); virtual; abstract;
procedure Commit; virtual;
procedure Push; virtual;
procedure CommitFile(FileName: String); virtual; abstract;
procedure UpdateDirectory(Directory: String); virtual; abstract;
procedure UpdateFile(FileName: String); virtual; abstract;
procedure RevertDirectory(Directory: String); virtual; abstract;
procedure RevertFile(FileName: String); virtual; abstract;
procedure DiffFile(FileName: String); virtual; abstract;
procedure DiffToFile(FileName, ToFileName: String); virtual; abstract;
procedure AddFile(FileName: String); virtual; abstract;
function GetCapability: TSCMCapability; virtual;
end;
TEditorSCMClass = class of TEditorSCM;
{ TRunOptions }
TRunProjectInfo = record
Command: String;
MainPath: String;
Params: String;
Console: TThreeStates;
Pause: TThreeStates;
MainFile: String;
OutputFile: String;
Require: String;
ConfigFile: String;
ExpandPaths: Boolean;
SharedLib: Boolean;
end;
TRunOptions = class(TPersistent)
private
FInfo: TRunProjectInfo;
FPaths: TStrings;
public
constructor Create; virtual;
destructor Destroy; override;
procedure SetPaths(AValue: TStrings);
procedure Merge(AOptions: TRunOptions);
procedure Copy(AOptions: TRunOptions);
procedure Assign(Source: TPersistent); override;
published
property Pause: TThreeStates read FInfo.Pause write FInfo.Pause default stateTrue;
property Console: TThreeStates read FInfo.Console write FInfo.Console default stateNone;
property Command: String read FInfo.Command write FInfo.Command;
property Params: String read FInfo.Params write FInfo.Params;
property Require: String read FInfo.Require write FInfo.Require;
property MainPath: String read FInfo.MainPath write FInfo.MainPath;
property MainFile: String read FInfo.MainFile write FInfo.MainFile;
property OutputFile: String read FInfo.OutputFile write FInfo.OutputFile;
property ExpandPaths: Boolean read FInfo.ExpandPaths write FInfo.ExpandPaths;
property ConfigFile: String read FInfo.ConfigFile write FInfo.ConfigFile;
property Paths: TStrings read FPaths write SetPaths;
property SharedLib: Boolean read FInfo.SharedLib write FInfo.SharedLib; //dll or so shared lib
end;
TCreateMaskProc = function(vGroup: TFileGroup): Boolean of object;
{ TEditorProject }
TEditorProject = class abstract(TmnXMLProfile)
private
FDefaultPath: string;
FIgnoreNames: String;
FFileFilter: String;
FOptions: TEditorProjectOptions;
FRunOptions: TRunOptions;
FTendencyName: String;
FDescription: String;
FFileName: String;
FName: String;
FSaveDesktop: Boolean;
FDesktop: TEditorDesktop;
FTendency: TEditorTendency;
FSCM: TEditorSCM;
FTitle: String;
function GetIsActive: Boolean;
function GetPath: String;
procedure SetTendency(AValue: TEditorTendency);
procedure SetTendencyName(AValue: String);
procedure SetSCM(AValue: TEditorSCM);
protected
procedure RecreateOptions;
procedure RttiCreateObject(var vObject: TObject; vInstance: TObject; vObjectClass: TClass; const vClassName, vName: String); override;
procedure Loaded(Failed: Boolean); override;
procedure Saving; override;
public
constructor Create; virtual;
destructor Destroy; override;
procedure LoadFromFile(FileName: String); override;
property FileName: String read FFileName write FFileName;
property Path: String read GetPath;
procedure UpdatePath;
procedure SetSCMClass(SCMClass: TEditorSCM);
function CreateMask(CreateMaskProc: TCreateMaskProc): String;
//Tendency here point to one of Engine.Tendencies so it is not owned by project
property Tendency: TEditorTendency read FTendency write SetTendency;
property RunOptions: TRunOptions read FRunOptions write FRunOptions;
property IsActive: Boolean read GetIsActive;
property DefaultPath: string read FDefaultPath;
published
property Name: String read FName write FName;
property Title: String read FTitle write FTitle;
property TendencyName: String read FTendencyName write SetTendencyName;
//SCM now owned by project and saved or loaded with it, the SCM object so assigned to will be freed with the project
property SCM: TEditorSCM read FSCM write SetSCM;
property Description: String read FDescription write FDescription;
property SaveDesktop: Boolean read FSaveDesktop write FSaveDesktop default True;
property Desktop: TEditorDesktop read FDesktop stored FSaveDesktop;
property Options: TEditorProjectOptions read FOptions write FOptions default nil;
property FileFilter: String read FFileFilter write FFileFilter;
property IgnoreNames: String read FIgnoreNames write FIgnoreNames;
end;
TTendencyProject = class(TEditorProject)
public
published
property FileFilter;
end;
TRunProject = class(TTendencyProject)
published
property RunOptions;
end;
{* Default project to used when no project opened
}
{ TDefaultProject }
TDefaultProject = class sealed(TEditorProject)
public
end;
{ TDebugMarksPart }
TSynDebugMarksPart = class(TSynGutterPartBase)
protected
FEditorFile: TEditorFile;
procedure Init; override;
public
constructor Create(AOwner: TComponent); override;
destructor Destroy; override;
procedure Paint(Canvas: TCanvas; AClip: TRect; FirstLine, LastLine: Integer); override;
published
property MarkupInfo;
end;
TEditorSaveOption = (saveNew, saveAsNew, saveTemporary, saveUnmodified);
TEditorSaveOptions = set of TEditorSaveOption;
TSwitchControls = specialize TFPGList<TWinControl>;
TEditorLinesMode = (efmUnix, efmWindows, efmMac);
TEditCapabilities = set of (ecpAllowCopy, ecpAllowPaste, ecpAllowCut, ecpAllowUndo);
{ TEditorFile }
TEditorFile = class(TCollectionItem, IFileEditor)
private
FFileEncoding: String;
FFileName: String;
FIsNew: Boolean;
FIsChanged: Boolean;
FFileDate: TDateTime;
FFileSize: Int64;
FGroup: TFileGroup;
FParams: String;
FRelated: String;
FLinesMode: TEditorLinesMode;
FIsTemporary: Boolean;
FTitle: String;
function GetEditCapability: TEditCapabilities;
function GetRunCapability: TRunCapabilities;
function GetIsText: Boolean;
function GetBaseName: String;
function GetNickName: String;
function GetExtension: String;
function GetPath: String;
function GetTendency: TEditorTendency;
procedure SetFileEncoding(AValue: String);
procedure SetGroup(const Value: TFileGroup);
procedure SetIsChanged(const Value: Boolean);
procedure SetIsNew(AValue: Boolean);
function GetLinesModeAsText: String;
procedure SetLinesMode(const Value: TEditorLinesMode);
procedure SetExtension(AValue: String);
procedure SetBaseName(AValue: String);
procedure SetNickName(AValue: String);
protected
procedure InitContents; virtual;
procedure GroupChanged; virtual;
function GetIsReadonly: Boolean; virtual;
procedure SetIsReadonly(const Value: Boolean); virtual;
function GetContent: TWinControl; virtual;
function GetControl: TWinControl; virtual;
function GetSynEdit: TSynEdit; virtual;
procedure DoGetEditCapability(var vEditCapability: TEditCapabilities); virtual;
procedure DoGetRunCapability(var vRunCapability: TRunCapabilities); virtual;
protected
procedure Edit;
procedure DoEdit(Sender: TObject); virtual;
procedure DoStatusChange(Sender: TObject; Changes: TSynStatusChanges); virtual;
procedure Update; virtual;
procedure UpdateAge; virtual;
procedure NewContent; virtual;
procedure DoLoad(FileName: String); virtual; abstract;
procedure DoSave(FileName: String); virtual; abstract;
function Execute(RunInfo: TmneRunInfo): Boolean; virtual;
public
constructor Create(ACollection: TCollection); override;
procedure BeforeDestruction; override;
destructor Destroy; override;
procedure Assign(Source: TPersistent); override;
procedure AssignTo(Dest: TPersistent); override;
procedure LoadFromFile(AFileName: String);
procedure Load;
procedure SaveToFile(AFileName: String);
procedure Save(SaveOptions: TEditorSaveOptions = []; Extension: String = ''); virtual;
procedure Save;
//Utils for SynEdit loading/saving
procedure ContentsLoadFromStream(SynEdit: TSynEdit; AStream: TStream);
procedure ContentsSaveToStream(SynEdit: TSynEdit; AStream: TStream);
procedure ContentsLoadFromFile(SynEdit: TSynEdit; FileName: String); //used if u have synedit
procedure ContentsSaveToFile(SynEdit: TSynEdit; FileName: String);
procedure Rename(ToName: String); //only name not with the path
procedure Delete; //only name not with the path
procedure Show; virtual; //Need to activate it after show to focus editor
procedure Hide; virtual;
function Visible: Boolean;
procedure Activate; virtual;
function Activated: Boolean;
procedure Close;
procedure OpenInclude; virtual;
function CanAddRecentFiles: Boolean; virtual;
function CanOpenInclude: Boolean; virtual;
function CheckChanged(Force: Boolean = False): Boolean;
//
procedure GotoLine; virtual;
procedure Find; virtual;
procedure FindNext; virtual;
procedure FindPrevious; virtual;
procedure Replace; virtual;
procedure Refresh; virtual;
function GetHint(HintControl: TControl; CursorPos: TPoint; out vHint: String): Boolean; virtual;
function GetGlance: String; virtual; //Simple string to show in the corner of mainform
//
function GetCaption: String; virtual; //Name or Title or *
function GetLanguageName: String; virtual; //TODO need to get more good name to this function
procedure SetLine(Line: Integer); virtual;
procedure SetHighlightLine(AValue: Integer); virtual;
//Clipboard
function CanCopy: Boolean;
function CanPaste: Boolean;
function CanUndo: Boolean;
property EditCapability: TEditCapabilities read GetEditCapability;
property RunCapability: TRunCapabilities read GetRunCapability;
procedure Paste; virtual;
procedure Copy; virtual;
procedure Cut; virtual;
procedure SelectAll; virtual;
procedure Undo; virtual;
procedure Redo; virtual;
procedure ClearUndo; virtual;
procedure ScanValues(Values: TStringList; UpdateValues: Boolean = False);
procedure EnumVariables(Values: TStringList; EnumSkips: TEnumVariablesSkips); virtual;
function ReplaceVariables(S: String; EnumSkips: TEnumVariablesSkips; AValues: TStringList = nil): String;
//When main form needs to switch focus (F6), add to the list all control can take focus
procedure EnumSwitchControls(vList: TSwitchControls); virtual;
//run the file or run the project depend on the project tendenc
property LinesMode: TEditorLinesMode read FLinesMode write SetLinesMode default efmUnix;
property FileEncoding: String read FFileEncoding write SetFileEncoding;
property LinesModeAsText: String read GetLinesModeAsText;
property IsText: Boolean read GetIsText;
property FileName: String read FFileName write FFileName;
property BaseName: String read GetBaseName write SetBaseName; //no path with ext
property NickName: String read GetNickName write SetNickName; //no path without ext
property Title: String read FTitle write FTitle; //used only if Name is empty for temporary files
property Path: String read GetPath;
property FileDate: TDateTime read FFileDate;
property Params: String read FParams write FParams;
property Extension: String read GetExtension write SetExtension;
property Tendency: TEditorTendency read GetTendency;
property Related: String read FRelated write FRelated;
property IsChanged: Boolean read FIsChanged write SetIsChanged;
property IsNew: Boolean read FIsNew write SetIsNew default False;
property IsTemporary: Boolean read FIsTemporary write FIsTemporary default False;
property IsReadOnly: Boolean read GetIsReadonly write SetIsReadonly;
property Group: TFileGroup read FGroup write SetGroup;
property Content: TWinControl read GetContent; //Container of SynEdit or Grids or Images and all child contrls
//Control we need to know about it to focus it after open file or changing focus by F6
property Control: TWinControl read GetControl; //Control if available, maybe Grid or SynEdit or same the content
//TODO Should not have this here
property SynEdit: TSynEdit read GetSynEdit; //SynEdit if available
published
end;
{ TSyntaxEditorFile }
TSyntaxEditorFile = class abstract(TEditorFile, ITextEditor)
private
FHighlightLine: Integer;
protected
LastGotoLine: Integer;
function GetIsReadonly: Boolean; override;
procedure SetIsReadonly(const Value: Boolean); override;
function GetContent: TWinControl; override;
procedure DoLoad(AFileName: String); override;
procedure DoSave(AFileName: String); override;
procedure GroupChanged; override;
procedure DoEdit(Sender: TObject); override;
procedure DoStatusChange(Sender: TObject; Changes: TSynStatusChanges); override;
procedure DoGutterClickEvent(Sender: TObject; X, Y, Line: Integer; Mark: TSynEditMark);
procedure DoSpecialLineMarkup(Sender: TObject; Line: Integer; var Special: Boolean; Markup: TSynSelectedColor);
procedure DoGetEditCapability(var vEditCapability: TEditCapabilities); override;
procedure SynEditKeyDown(Sender: TObject; var Key: Word; Shift: TShiftState);
public
constructor Create(ACollection: TCollection); override;
destructor Destroy; override;
procedure BeforeDestruction; override;
procedure Assign(Source: TPersistent); override;
procedure AssignTo(Dest: TPersistent); override;
procedure Find; override;
procedure FindNext; override;
procedure FindPrevious; override;
procedure Replace; override;
procedure Refresh; override;
procedure SetHighlightLine(AValue: Integer); override;
function GetHint(HintControl: TControl; CursorPos: TPoint; out vHint: String): Boolean; override;
function GetGlance: String; override;
function EvalByMouse(p: TPoint; out v, s, t: String): Boolean;
function EvalByCursor(out v, s, t: String): Boolean;
procedure UpdateAge; override;
function GetLanguageName: String; override;
procedure Copy; override;
procedure Paste; override;
procedure Cut; override;
procedure SelectAll; override;
procedure Undo; override;
procedure Redo; override;
procedure ClearUndo; override;
procedure SetLine(Line: Integer); override;
procedure GotoLine; override;
property HighlightLine: Integer read FHighlightLine write SetHighlightLine;
end;
{ TTextEditorFile }
TTextEditorFile = class(TSyntaxEditorFile)
private
FSynEdit: TSynEdit;
protected
procedure InitContents; override;
function GetSynEdit: TSynEdit; override;
public
constructor Create(ACollection: TCollection); override;
destructor Destroy; override;
end;
{ TSourceEditorFile }
TSourceEditorFile = class(TTextEditorFile, IExecuteEditor, IWatchEditor)
public
end;
{ TControlEditorFile }
TControlEditorFile = class abstract(TEditorFile, IControlEditor)
private
protected
public
end;
TOpenFileOption = (ofoActivate, ofoByParam, ofoCheckExists);
TOpenFileOptions = set of TOpenFileOption;
{ TEditorFiles }
TEditorFiles = class(TCollection)
private
FCheckingChanged: Boolean;
FCurrent: TEditorFile;
function GetItems(Index: Integer): TEditorFile;
function GetCurrent: TEditorFile;
procedure SetCurrent(const Value: TEditorFile);
protected
function SetActiveFile(FileName: String): TEditorFile;
public
destructor Destroy; override;
function FindFile(const vFileName: String): TEditorFile;
function IsExist(vName: String): Boolean;
function InternalOpenFile(FileName, FileParams: String; AppendToRecent: Boolean): TEditorFile;
function LoadFile(vFileName, vFileParams: String; AppendToRecent: Boolean = True): TEditorFile;
function ShowFile(vFileName: String): TEditorFile; overload; //open it without add to recent, for debuging
function ShowFile(const FileName: String; Line: Integer): TEditorFile; overload;
function OpenFile(vFileName: String; vFileParams: String = ''; OpenFileOptions: TOpenFileOptions = []): TEditorFile;
procedure SetCurrentIndex(Index: Integer; vRefresh: Boolean);
function New(vGroup: TFileGroup = nil): TEditorFile; overload;
function New(GroupName: String): TEditorFile; overload;
procedure Open;
procedure SaveCurrent(SaveOptions: TEditorSaveOptions = []);
procedure SaveAll(SaveOptions: TEditorSaveOptions = []);
procedure CancelAll;
procedure ReloadAll;
procedure CheckAll;
procedure UpdateAll;
procedure SaveAs;
procedure Revert;
procedure Refresh;
procedure Next;
procedure Prior;
procedure Edited;
procedure Replace;
procedure Find;
procedure FindNext;
procedure FindPrevious;
procedure CheckChanged;
procedure CheckChanged(AFileName: string; Force: Boolean); //slient function
procedure CloseAll;
procedure CloseOthers;
function GetEditedCount: Integer;
property CheckingChanged: Boolean read FCheckingChanged write FCheckingChanged; //public to use it in SearchInFiles
property Current: TEditorFile read GetCurrent write SetCurrent;
property Items[Index: Integer]: TEditorFile read GetItems; default;
published
end;
{ TRecentItem }
TRecentItem = class(TmnXMLItem)
private
FName: String;
FParams: String;
public
published
property Name: String read FName write FName;
property Params: String read FParams write FParams;
constructor Create; overload;
constructor Create(AName: String; AParams: String = ''); overload;
procedure Assign(Source: TPersistent); override;
end;
{ TRecentItems }
TRecentItems = class(specialize GXMLItems<TRecentItem>)
private
FMax: Integer;
protected
public
constructor Create(AMax: Integer);
function IndexOf(AName: String): Integer;
function Find(AName: String): TRecentItem;
procedure Insert(AName: String; AParams: String);
procedure Add(AName: String; AParams: String);
property Max: Integer read FMax write FMax;
end;
TSynBreakPointItem = class(TSynObjectListItem)
public
IsBreakPoint: Boolean;
end;
TSortFolderFiles = (srtfByNames, srtfByExt);
TShowFolderFiles = (sffRelated, sffProject, sffKnown, sffAll);
TEditorFileClass = class of TEditorFile;
TAutoStartDebug = (asdNo, asdStartup, asdRun);
TOnEngineChanged = procedure of object;
{ TEditorOptions }
TEditorOptions = class(TmnXMLProfile)
private
FAutoOpenProject: Boolean;
FMainPath: String;
FFallbackToText: Boolean;
FIgnoreNames: String;
FLastFolder: String;