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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
|
unit ideinstantsearch;
{$mode ObjFPC}{$H+}
{$modeswitch typehelpers}
interface
uses
Classes, SysUtils, idemcindexer, lazideintf, idemsgintf, LazConfigStorage, BaseIDEIntf, projectintf,
ExtCtrls;
Const
RTLTree = 'RTL';
FCLTree = 'FCL';
CompilerTree = 'Compiler';
LCLTree = 'LCL';
LazTree = 'Lazarus';
// Disconnect after timeout. in seconds
DefaultIdleDisconnectTimeOut = 30;
DefaultMaxStartSearchLength = 255;
DefaultMaxResultCount = 100;
// Number of seconds to wait after project was opened before start indexing in case of pmiOnOpen
DefaultOpenDelay = 5;
// Number of seconds to wait after project was opened before marking it for indexing.
DefaultTimedDelay = 5 * 60;
// Source tree ID in project custom data
SInstantSearchID = 'InstantSearchID';
// Source tree ID in project custom data
SInstantSearchProjFileName = 'InstantSearchProjFileName';
Type
TIndexProjectMoment = (
ipmOnOpen, // after open project, index project
ipmManual, // User manually starts indexing operation
ipmFirstsave // Indexing starts when first save happens.
);
TIndexProjectStrategy = (
ipsAll, // All projects are marked for indexing.
ipsTimed, // A project is marked for indexing if it is open after TimedDelay
ipsManual // a project is marked for indexing by user
);
{ TIndexProjectMomentHelper }
TIndexProjectMomentHelper = Type helper for TIndexProjectMoment
Function ToString : string;
end;
{ TIndexProjectStrategyHelper }
TIndexProjectStrategyHelper = Type helper for TIndexProjectStrategy
Function ToString : string;
end;
{ TSourceTreeDefinition }
TSourceTreeDefinition = Class(TCollectionItem)
private
FAllFiles: Boolean;
FBaseDir: String;
FEnabled: Boolean;
FExtensions: String;
FName: String;
FRecurse: Boolean;
FSystem: Boolean;
Public
procedure Assign(aSource : TPersistent); override;
Published
Property System : Boolean Read FSystem Write FSystem;
Property Name : String Read FName Write FName;
Property BaseDir : String Read FBaseDir Write FBaseDir;
Property Recurse : Boolean Read FRecurse Write FRecurse;
Property AllFiles : Boolean Read FAllFiles Write FAllFiles;
Property Extensions : String Read FExtensions Write FExtensions;
Property Enabled : Boolean Read FEnabled Write FEnabled;
end;
{ TSourceTreeDefinitionList }
TSourceTreeDefinitionList = class(TOwnedCollection)
private
function GetDef(aIndex : Integer): TSourceTreeDefinition;
procedure SetDef(aIndex : Integer; AValue: TSourceTreeDefinition);
Protected
procedure Update(Item: TCollectionItem); override;
Public
Function AddTree(const aName : String): TSourceTreeDefinition;
Function IndexOfName(const aName : String) : Integer;
Function FindByName(const aName : String): TSourceTreeDefinition;
Property Definitions[aIndex : Integer] : TSourceTreeDefinition Read GetDef Write SetDef; default;
end;
{ TIDEInstantSearchManager }
TIDEInstantSearchManager = class(TComponent)
Private
FConfigured: Boolean;
FIdleDisconnectTimeOut: Integer;
FIndexer: TManticoreSearchSources;
FIndexProjectDelay: Cardinal;
FMaxStartSearchLength: Integer;
FMinSearchLength: Integer;
FIndexProjectMoment: TIndexProjectMoment;
FIndexProjectStrategy: TIndexProjectStrategy;
FOnIndexStart: TNotifyEvent;
FOnSourceTreesChanged: TNotifyEvent;
FProjectTreeName: string;
FSearchProject: boolean;
FServerTrees: TStringList;
FSourceTrees: TSourceTreeDefinitionList;
FIndexThread : TThread;
FOnIndexDone : TNotifyEvent;
FMarkProject : TLazProject;
FMarkProjectTimer : TTimer;
FStartIndexTimer : TTimer;
class var _instance : TIDEInstantSearchManager;
procedure DoOnIndexDone(Sender: TObject);
procedure DoManticoreLog(Sender: TObject; aKind: TMCLogKind; const aMessage: String);
procedure DoRefreshTimer(Sender: TObject);
procedure GetProjectFiles(aProject: TLazProject; aList: TStrings);
procedure SetMinSearchLength(AValue: Integer);
procedure SetRefreshTimer;
procedure SetServerTrees(AValue: TStringList);
procedure SetSourceTrees(AValue: TSourceTreeDefinitionList);
procedure DoMarkProjectIndexed(Sender: TObject);
Protected
procedure CallIndexDone;
procedure DoStartIndexing;
Procedure SourceTreesChanged; virtual;
Public
Class constructor Init;
Class Destructor Done;
Class Property Instance : TIDEInstantSearchManager Read _Instance;
Constructor Create(aOwner : TComponent); override;
Destructor Destroy; override;
// Load/Save config
function GetDefaultConfigFileName: String;
Procedure LoadConfig(const aFileName : String);
Procedure SaveConfig(const aFileName : string);
Procedure Load;
Procedure Save;
// Start timer to mark project as indexable
procedure StartMarkProjectTimer(aProject: TLazProject);
// Refresh system trees
procedure RefreshSystemTrees(Force : Boolean);
// Assign a tree ID to a project
function AssignProjectTreeID(aProject: TLazProject): String;
// Index files of project
Procedure IndexProjectFiles(aProject : TLazProject);
// Rescan FPC directory trees
procedure RescanFPCDir;
// Clear mark project timer
procedure ClearMarkProjectTimer;
// Mark a project indexable
procedure MarkProjectIndexed(aProject: TLazProject);
// Do search, taking into account active trees.
function Search(const aTerm: String): TMCSearchResultArray;
// Create default trees. Only call in or after register, it needs IDE macros.
procedure CreateDefaultTrees;
// Are all properties to connect set ?
function CanConnect : Boolean;
// Test connection. If aIndexList is assigned, fill list with names of existing trees.
function TestConnect(aIndexList : TStrings) : Boolean;
// Returns empty string if we can search. Returns what needs to be configured.
Function CanSearch : string;
// Start indexing operation for tree.
function IndexTree(aTree : TSourceTreeDefinition) : Boolean;
// Start indexing operation on a list of trees.
function IndexTrees(aList: TSourceTreeDefinitionList; aFreeList : Boolean): Boolean;
// Active project tree name
Property ProjectTreeName : string Read FProjectTreeName Write FProjectTreeName;
// Search project or not. If yes, projecttreeName Will be added to the list of tree to search in.
Property SearchProject : boolean Read FSearchProject Write FSearchProject;
// When to index a project when it is marked for indexing
Property IndexProjectMoment : TIndexProjectMoment Read FIndexProjectMoment Write FIndexProjectMoment default ipmManual;
// When to mark a project for indexing
Property IndexProjectStrategy : TIndexProjectStrategy Read FIndexProjectStrategy Write FIndexProjectStrategy default ipsManual;
// when IndexProjectStrategy is ipsTimed, Time (minutes) to wait when a project is opened
Property IndexProjectDelay : Cardinal Read FIndexProjectDelay Write FIndexProjectDelay default DefaultTimedDelay;
// Check whether one of the source tree indexes must be refreshed, and start an index operation
procedure CheckRefresh(aExisting: TStrings; aForceRefresh : Boolean);
// Is an index job currently running ?
Function IsIndexing : Boolean;
// Global indexer instance, use only for searching.
Property Indexer : TManticoreSearchSources Read FIndexer;
// Minimum number of characters needed before a search can be started.
Property MinSearchLength : Integer Read FMinSearchLength Write SetMinSearchLength default DefaultMCMinInfixLen;
// When checking clipboard content, maximum length for text to be accepted as search text
Property MaxStartSearchLength : Integer Read FMaxStartSearchLength Write FMaxStartSearchLength default DefaultMaxStartSearchLength;
// Our server trees.
Property SourceTrees : TSourceTreeDefinitionList Read FSourceTrees Write SetSourceTrees;
// Source trees on server
Property ServerTrees : TStringList Read FServerTrees Write SetServerTrees;
// Get notification when index operation is done.
Property OnIndexStart : TNotifyEvent Read FOnIndexStart Write FOnIndexStart;
// Get notification when index operation is done.
Property OnIndexDone : TNotifyEvent Read FOnIndexDone Write FOnIndexDone ;
// Get notification when source trees change
Property OnSourceTreesChanged : TNotifyEvent Read FOnSourceTreesChanged Write FOnSourceTreesChanged;
// Configured.
Property Configured : Boolean Read FConfigured Write FConfigured;
// Timeout before disconnecting. In seconds
Property IdleDisconnectTimeOut : Integer Read FIdleDisconnectTimeOut Write FIdleDisconnectTimeOut;
end;
Function IDEInstantSearchManager : TIDEInstantSearchManager;
implementation
uses TypInfo, DateUtils, Strutils, IDEExternToolIntf, MacroIntf, IDEOptionsIntf, instantsearchstrings;
function IDEInstantSearchManager: TIDEInstantSearchManager;
begin
Result:=TIDEInstantSearchManager.Instance;
end;
Type
{ TInstantSearchIndexThread }
TInstantSearchIndexThread = class(TThread)
Private
FIndexer : TManticoreSearchSources;
Protected
procedure DoLog(aKind: TMCLogKind; const aMessage: string); overload;
procedure DoLog(aKind: TMCLogKind; const aFmt: String; const aArgs: array of const); overload;
Property Indexer : TManticoreSearchSources Read FIndexer;
Public
Constructor Create(aIndexer : TManticoreSearchSources; aOnTerminate : TNotifyEvent);
end;
TInstantSearchIndexTreeThread = class(TInstantSearchIndexThread)
private
FTrees : TSourceTreeDefinitionList;
FCurrentTree : string;
FProcessedCount : Integer;
procedure DoCheckTerminate(Sender: TObject; const aFileName: String; var aContinue: Boolean);
function IndexTree(aTree: TSourceTreeDefinition): Integer;
Public
Constructor Create(aIndexer : TManticoreSearchSources; aTrees : TSourceTreeDefinitionList; aOnTerminate : TNotifyEvent);
Destructor Destroy; override;
Procedure Execute; override;
end;
{ TIndexFilesData }
TIndexFilesData = class
private
FName : String;
FBaseDir: String;
Flist: TStrings;
FTree: string;
Public
Constructor Create(aName,aTree,aBaseDir : String; aList : TStrings);
Destructor destroy; override;
Property Name : string Read FName;
Property Tree : string Read FTree;
Property BaseDir : String Read FBaseDir;
Property List : TStrings Read Flist;
end;
{ TInstantSearchIndexFilesThread }
TInstantSearchIndexFilesThread = class(TInstantSearchIndexThread)
Private
FData : TIndexFilesData;
Protected
Property Data : TIndexFilesData Read FData;
Public
Constructor Create(aIndexer : TManticoreSearchSources; const aData : TIndexFilesdata; aOnTerminate : TNotifyEvent);
Destructor Destroy; override;
Procedure Execute; override;
end;
{ TIndexFilesData }
constructor TIndexFilesData.Create(aName, aTree, aBaseDir: String;
aList: TStrings);
begin
FName:=aName;
FTree:=aTree;
FBaseDir:=IncludeTrailingPathDelimiter(aBaseDir);
FList:=aList;
end;
destructor TIndexFilesData.destroy;
begin
FreeAndNil(Flist);
inherited destroy;
end;
{ TInstantSearchIndexFilesThread }
constructor TInstantSearchIndexFilesThread.Create(
aIndexer: TManticoreSearchSources; const aData: TIndexFilesdata;
aOnTerminate: TNotifyEvent);
begin
FData:=aData;
Inherited Create(aIndexer,aOnTerminate);
end;
destructor TInstantSearchIndexFilesThread.Destroy;
begin
FreeAndNil(FData);
inherited Destroy;
end;
procedure TInstantSearchIndexFilesThread.Execute;
var
aCount,I : Integer;
FN,RelFN,Msg : string;
begin
aCount:=0;
try
if not Indexer.Connected then
Indexer.Connect;
DoLog(mlkProgress,lrsStartIndexingProject,[Data.Name,Data.BaseDir]);
FIndexer.DeleteTree(Data.Tree);
For I:=0 to Data.List.Count-1 do
begin
inc(aCount);
FN:=Data.list[i];
if Data.BaseDir='' then
RelFN:=FN
else
RelFN:=ExtractRelativePath(Data.BaseDir,FN);
Indexer.IndexSourceFile(Data.Tree,RelFN,FN);
if Terminated then
break;
end;
if Terminated then
Msg:=lrsIndexingProjectTerminated
else
Msg:=lrsFinishedIndexingProject;
DoLog(mlkProgress,Msg,[Data.Name,aCount])
except
On E : exception do
DoLog(mlkError,'Exception %s while indexing project %s : %s',[E.ClassName,Data.Name,E.Message]);
end;
end;
{ TInstantSearchIndexThread }
constructor TInstantSearchIndexThread.Create(aIndexer: TManticoreSearchSources; aOnTerminate: TNotifyEvent);
begin
FIndexer:=aIndexer;
OnTerminate:=aOnTerminate;
Inherited Create(False);
end;
destructor TInstantSearchIndexTreeThread.Destroy;
begin
FreeAndNil(FTrees);
inherited Destroy;
end;
Procedure TInstantSearchIndexThread.DoLog(aKind : TMCLogKind; Const aMessage : string);
begin
if Assigned(FIndexer) and Assigned(FIndexer.Onlog) then
FIndexer.Onlog(Self,aKind,aMessage);
end;
Procedure TInstantSearchIndexThread.DoLog(aKind : TMCLogKind; Const aFmt : String; Const aArgs : Array of const);
begin
DoLog(aKind,Format(aFmt,aArgs));
end;
{ TInstantSearchIndexTreeThread }
Constructor TInstantSearchIndexTreeThread.Create(aIndexer : TManticoreSearchSources; aTrees : TSourceTreeDefinitionList; aOnTerminate : TNotifyEvent);
begin
FTrees:=aTrees;
Inherited Create(aIndexer,aOnTerminate);
end;
Function TInstantSearchIndexTreeThread.IndexTree(aTree : TSourceTreeDefinition) : Integer;
Var
Options : TMCIndexOptions;
begin
Findexer.Extensions:=aTree.Extensions.Split([';'],TStringSplitOptions.ExcludeEmpty);
if not FIndexer.Connected then
FIndexer.Connect;
Options:=[ioStoreRelativeNames];
if aTree.AllFiles then
Include(Options,ioAllFiles);
if aTree.Recurse then
Include(Options,ioRecurse);
FIndexer.DeleteTree(aTree.Name);
Result:=FIndexer.IndexSources(aTree.Name,aTree.BaseDir,Options,@DoCheckTerminate);
end;
procedure TInstantSearchIndexTreeThread.DoCheckTerminate(Sender: TObject;
const aFileName: String; var aContinue: Boolean);
begin
inc(FProcessedCount);
if (FProcessedCount mod 100)=0 then
DoLog(mlkProgress,lrsIndexingTreeFileCount,[FCurrentTree,FProcessedCount]);
if Terminated then
aContinue:=False;
end;
procedure TInstantSearchIndexTreeThread.Execute;
var
I,aCount : Integer;
aTree : TSourceTreeDefinition;
aStart,aEnd : TDateTime;
begin
For I:=0 to FTrees.Count-1 do
try
FProcessedCount:=0;
aTree:=FTrees[i];
FCurrentTree:=aTree.Name;
DoLog(mlkProgress,lrsStartIndexingTree,[FCurrentTree,aTree.BaseDir]);
aStart:=Now;
aCount:=IndexTree(aTree);
aEnd:=Now;
DoLog(mlkProgress,lrsFinishedIndexingTree,[FCurrentTree,aCount,MinutesBetween(aEnd,aStart)]);
if Terminated then
Break;
except
On E : exception do
DoLog(mlkError,'Exception %s while indexing tree %s : %s',[E.ClassName,FCurrentTree,E.Message]);
end;
end;
{ TIndexProjectStrategyHelper }
function TIndexProjectStrategyHelper.ToString: string;
begin
Case self of
ipsAll : Result:=lrsAllProjects;
ipsTimed : Result:=lrsTimed;
ipsManual : Result:=lrsManual;
else
Result:='?';
end;
end;
{ TIndexProjectMomentHelper }
function TIndexProjectMomentHelper.ToString: string;
begin
Case self of
ipmOnOpen : Result:=lrsOnOpen;
ipmManual : Result:=lrsManual;
ipmFirstsave : Result:=lrsOnFirstSave;
else
Result:='?';
end;
end;
{ TIDEInstantSearchManager }
procedure TIDEInstantSearchManager.SetMinSearchLength(AValue: Integer);
begin
if FMinSearchLength=AValue then Exit;
if aValue<2 then
Raise EManticoreSearch.Create(lrsErrorMinLengthIs2);
FMinSearchLength:=AValue;
FIndexer.MinInfixLen:=AValue;
end;
procedure TIDEInstantSearchManager.CallIndexDone;
begin
// Must be called in main thread
If Assigned(FonIndexDone) then
FonIndexDone(Self);
DoManticoreLog(self,mlkProgress,lrsIndexingOperationFinished);
end;
procedure TIDEInstantSearchManager.DoMarkProjectIndexed(Sender: TObject);
begin
if assigned(FMarkProject) and (FMarkProject=LazarusIDE.ActiveProject) then
begin
MarkProjectIndexed(FMarkProject);
end;
end;
procedure TIDEInstantSearchManager.SourceTreesChanged;
begin
if assigned(FOnSourceTreesChanged) then
FOnSourceTreesChanged(Self);
end;
procedure TIDEInstantSearchManager.DoOnIndexDone(Sender: TObject);
begin
if Sender=FIndexThread then
FIndexThread:=Nil;
if assigned(FonIndexDone) then
TThread.Synchronize(TThread.CurrentThread,@CallIndexDone);
end;
procedure TIDEInstantSearchManager.DoManticoreLog(Sender: TObject;
aKind: TMCLogKind; const aMessage: String);
Var
mlu : TMessageLineUrgency;
begin
// Writeln(aKind,': ',aMessage);
if (aKind in [mlkError,mlkProgress]) and Assigned(IDEMessagesWindow) then
begin
if aKind=mlkError then
mlu:=mluError
else
mlu:=mluProgress;
IDEMessagesWindow.AddCustomMessage(mlu,lrsInstantSearch+': '+aMessage,'',0,0,lrsInstantSearch);
end;
end;
procedure TIDEInstantSearchManager.SetServerTrees(AValue: TStringList);
begin
if FServerTrees=AValue then Exit;
FServerTrees.Assign(AValue);
end;
procedure TIDEInstantSearchManager.SetSourceTrees(
AValue: TSourceTreeDefinitionList);
begin
if FSourceTrees=AValue then Exit;
FSourceTrees.Assign(AValue);
end;
class constructor TIDEInstantSearchManager.Init;
begin
_Instance:=TIDEInstantSearchManager.Create(Nil);
end;
class destructor TIDEInstantSearchManager.Done;
begin
FreeAndNil(_Instance);
end;
constructor TIDEInstantSearchManager.Create(aOwner: TComponent);
begin
Inherited;
IdleDisconnectTimeOut:=DefaultIdleDisconnectTimeOut;
FMinSearchLength:=DefaultMCMinInfixLen;
FIndexer:=TManticoreSearchSources.Create(Nil);
FIndexer.OnLog:=@DoManticoreLog;
FIndexer.Extensions:=['pp','pas','lpr','inc'];
FIndexer.Limit:=DefaultMaxResultCount;
FServerTrees:=TStringList.Create;
FSourceTrees:=TSourceTreeDefinitionList.Create(Self,TSourceTreeDefinition);
FMaxStartSearchLength:=DefaultMaxStartSearchLength;
FIndexProjectMoment:=ipmManual;
FIndexProjectStrategy:=ipsManual;
FIndexProjectDelay:=DefaultTimedDelay;
end;
procedure TIDEInstantSearchManager.CreateDefaultTrees;
function GetCurrentFPCSourceDirectory: string;
begin
Result:='$(FPCSrcDir)';
if not IDEMacros.SubstituteMacros(Result) then
raise Exception.Create('unable to retrieve FPCSrcDir');
end;
Var
FPCDir : String;
begin
FPCDir:=IncludeTrailingPathDelimiter(GetCurrentFPCSourceDirectory);
With FSourceTrees.AddTree(RTLTree) do
begin
BaseDir:=FPCDir+'rtl';
Recurse:=True;
System:=true;
Extensions:='pp;pas;inc';
end;
With FSourceTrees.AddTree(FCLTree) do
begin
BaseDir:=FPCDir+'packages';
Recurse:=True;
System:=true;
Extensions:='pp;pas;inc';
end;
With FSourceTrees.AddTree(CompilerTree) do
begin
BaseDir:=FPCDir+'compiler';
Recurse:=True;
System:=true;
Extensions:='pp;pas;inc';
end;
With FSourceTrees.AddTree(LCLTree) do
begin
BaseDir:=IncludeTrailingPathDelimiter(IDEEnvironmentOptions.GetParsedLazarusDirectory)+'lcl'+PathDelim;
Recurse:=True;
System:=true;
Extensions:='pp;pas;inc';
end;
end;
procedure TIDEInstantSearchManager.LoadConfig(const aFileName: String);
var
Cfg: TConfigStorage;
List,S,aEnableds : String;
aTree : TSourceTreeDefinition;
I : integer;
begin
List:='';
Cfg:=GetIDEConfigStorage(aFilename,True);
try
Configured:=Cfg.GetValue('Search/Configured',Configured);
MaxStartSearchLength:=Cfg.GetValue('Search/MaxStartSearchLength',MaxStartSearchLength);
Findexer.Limit:=Cfg.GetValue('Indexer/Limit',Findexer.Limit);
MinSearchLength:=Cfg.GetValue('Indexer/MinSearchLength',MinSearchLength);
Findexer.Extensions:=Cfg.GetValue('Indexer/Extensions','').Split(';',TStringSplitOptions.ExcludeEmpty);
Findexer.HostName:=Cfg.GetValue('Indexer/Hostname',Findexer.HostName);
Findexer.Port:=Cfg.GetValue('Indexer/Port',Findexer.Port);
IdleDisconnectTimeOut:=Cfg.GetValue('Indexer/IdleDisconnect',IdleDisconnectTimeOut);
aEnableds:=Cfg.GetValue('Indexer/EnabledSystemTrees','');
S:=GetEnumName(TypeInfo(TMCTransport),Ord(Findexer.Transport));
S:=Cfg.GetValue('Indexer/Transport',S);
I:=GetEnumValue(TypeInfo(TMCTransport),S);
if I<>-1 then
Findexer.Transport:=TMCTransport(I);
S:=GetEnumName(TypeInfo(TMCMySQLClientVersion),Ord(Findexer.MySQLVersion));
S:=Cfg.GetValue('Indexer/MySQLVersion',S);
I:=GetEnumValue(TypeInfo(TMCMySQLClientVersion),S);
if I<>-1 then
Findexer.MySQLVersion:=TMCMySQLClientVersion(I);
Cfg.GetValue('Trees/Names',List);
For I:=SourceTrees.Count-1 downto 0 do
if Not SourceTrees[i].System then
SourceTrees.Delete(I);
For I:=SourceTrees.Count-1 downto 0 do
With SourceTrees[i] do
Enabled:=Pos(';'+Name+';',aEnableds)>0;
for S in SplitString(List,';') do
if S<>'' then
begin
ATree:=SourceTrees.AddTree(S);
Cfg.ReadObject('Trees/list/'+aTree.Name+'/',aTree);
end;
finally
Cfg.Free;
end;
end;
procedure TIDEInstantSearchManager.SaveConfig(const aFileName: string);
var
Cfg: TConfigStorage;
S,ext : String;
I : Integer;
aTree : TSourceTreeDefinition;
begin
S:='';
Cfg:=GetIDEConfigStorage(aFilename,True);
try
Cfg.SetValue('Search/Configured',Configured);
Cfg.SetValue('Search/MaxStartSearchLength',MaxStartSearchLength);
Cfg.SetValue('Indexer/MinSearchLength',MinSearchLength);
Cfg.SetValue('Indexer/Limit',Findexer.Limit);
Cfg.SetValue('Indexer/Transport',GetEnumName(TypeInfo(TMCTransport),Ord(Findexer.Transport)));
Cfg.SetValue('Indexer/IdleDisconnect',IdleDisconnectTimeOut);
S:=GetEnumName(TypeInfo(TMCMySQLClientVersion),Ord(Findexer.MySQLVersion));
Cfg.SetValue('Indexer/MySQLVersion',S);
S:='';
For ext in Findexer.Extensions do
begin
if S<>'' then
S:=S+';';
S:=S+Ext;
end;
Cfg.SetValue('Indexer/Extensions',S);
Cfg.SetValue('Indexer/Hostname',Findexer.HostName);
Cfg.SetValue('Indexer/Port',Findexer.Port);
S:='';
For I:=0 to SourceTrees.Count-1 do
With SourceTrees[i] do
if System and Enabled then
begin
S:=S+';'+SourceTrees[i].Name;
end;
if (S<>'') then
S:=S+';';
Cfg.SetValue('Indexer/EnabledSystemTrees',S);
S:='';
For I:=0 to SourceTrees.Count-1 do
if not SourceTrees[i].System then
begin
if S<>'' then
S:=S+';';
S:=S+SourceTrees[i].Name;
end;
Cfg.SetValue('Trees/Names',S);
Cfg.DeletePath('Trees/List');
For I:=0 to SourceTrees.Count-1 do
begin
aTree:=SourceTrees[i];
if not aTree.System then
Cfg.WriteObject('Trees/list/'+aTree.Name+'/',SourceTrees[I]);
end;
Cfg.WriteToDisk;
finally
Cfg.Free;
end;
end;
function TIDEInstantSearchManager.GetDefaultConfigFileName : String;
begin
Result:=IncludeTrailingPathDelimiter(LazarusIDE.GetPrimaryConfigPath)+'instantsearch.xml';
end;
procedure TIDEInstantSearchManager.CheckRefresh(aExisting : TStrings; aForceRefresh : Boolean);
Var
i : Integer;
Msg,aName : string;
aTrees : TSourceTreeDefinitionList;
begin
aTrees:=TSourceTreeDefinitionList.Create(Self,TSourceTreeDefinition);
try
for I:=0 to FSourceTrees.Count-1 do
begin
aName:=FSourceTrees[i].Name;
if aForceRefresh or (aExisting.IndexOf(aName)=-1) then
begin
if not aForceRefresh then
begin
Msg:=Format('Source tree %s has no records (searched %d trees), refreshing',[aName,aExisting.Count]);
IDEMessagesWindow.AddCustomMessage(mluHint,lrsInstantSearch+': '+Msg,'',0,0,lrsInstantSearch);
end;
aTrees.AddTree(aName).Assign(FSourceTrees[i]);
end;
end;
except
FreeAndNil(aTrees);
raise;
end;
if aTrees.Count>0 then
IndexTrees(aTrees,True)
else
FreeAndNil(aTrees);
end;
procedure TIDEInstantSearchManager.RefreshSystemTrees(Force : Boolean);
Var
L : TStrings;
begin
L:=TStringList.Create;
try
Indexer.ListTrees(L);
CheckRefresh(L,Force);
finally
L.Free;
end;
end;
procedure TIDEInstantSearchManager.DoRefreshTimer(Sender : TObject);
begin
FStartIndexTimer.Enabled:=False;
FreeAndNil(FStartIndexTimer);
RefreshSystemTrees(False);
end;
procedure TIDEInstantSearchManager.SetRefreshTimer;
begin
FStartIndexTimer:=TTimer.Create(Self);
FStartIndexTimer.Enabled:=False;
FStartIndexTimer.Interval:=DefaultOpenDelay;
FStartIndexTimer.OnTimer:=@DoRefreshTimer;
FStartIndexTimer.Enabled:=True;
end;
procedure TIDEInstantSearchManager.Load;
Var
L : TStrings;
begin
LoadConfig(GetDefaultConfigFileName);
L:=TStringList.Create;
try
if TestConnect(L) then
begin
ServerTrees.Assign(L);
if L.IndexOf(Indexer.IndexName)<>-1 then
SetRefreshTimer;
end;
finally
L.Free;
end;
end;
procedure TIDEInstantSearchManager.Save;
begin
SaveConfig(GetDefaultConfigFileName);
end;
function TIDEInstantSearchManager.AssignProjectTreeID(aProject : TLazProject) : String;
var
CurrentProjectFileName : String;
begin
Result:=TGUID.NewGuid.ToString(True);
CurrentProjectFileName:=aProject.ProjectInfoFile;
aProject.CustomSessionData[SInstantSearchID]:=Result;
aProject.CustomSessionData[SInstantSearchProjFileName]:=CurrentProjectFileName;
aProject.Modified:=True;
end;
procedure TIDEInstantSearchManager.GetProjectFiles(aProject: TLazProject; aList : TStrings);
Var
FN : String;
I : Integer;
begin
for I:=0 to aProject.FileCount-1 do
if aProject.Files[i].IsPartOfProject then
begin
FN:=aProject.Files[i].GetFullFilename;
if Indexer.AllowExtension(ExtractFileExt(FN)) then
aList.Add(FN);
end
end;
procedure TIDEInstantSearchManager.IndexProjectFiles(aProject: TLazProject);
Var
ProjName : string;
ProjTree : String;
ProjTreeFileName : String;
ProjectDir,CurrentProjectFileName : String;
lIndexer : TManticoreSearchSources;
Data : TIndexFilesData;
L : TStrings;
begin
ProjTree:=aProject.CustomSessionData[SInstantSearchID];
ProjTreeFileName:=aProject.CustomSessionData[SInstantSearchProjFileName];
CurrentProjectFileName:=aProject.ProjectInfoFile;
ProjectDir:=ExtractFilePath(CurrentProjectFileName);
if (ProjTree='') or (ProjTreeFileName<>CurrentProjectFileName) then
ProjTree:=AssignProjectTreeID(aProject);
L:=TStringList.Create;
try
GetProjectFiles(aProject,L);
ProjName:=aProject.Title;
if ProjName='' then
ProjName:=ChangeFileExt(ExtractFileName(CurrentProjectFileName),'');
Data:=TIndexFilesData.Create(ProjName,projtree,ProjectDir,L);
L:=nil;
lIndexer:=Indexer.Clone(Self);
FIndexThread:=TInstantSearchIndexFilesThread.Create(lIndexer,Data,@DoOnIndexDone);
finally
L.Free;
end;
end;
procedure TIDEInstantSearchManager.RescanFPCDir;
Var
L : TSourceTreeDefinitionList;
aTree : TSourceTreeDefinition;
begin
L:=TSourceTreeDefinitionList.Create(Self,TSourceTreeDefinition);
aTree:=SourceTrees.FindByName(FCLTree);
if assigned(aTree) then
L.AddTree(aTree.Name).Assign(aTree);
aTree:=SourceTrees.FindByName(RTLTree);
if assigned(aTree) then
L.AddTree(aTree.Name).Assign(aTree);
aTree:=SourceTrees.FindByName(CompilerTree);
if assigned(aTree) then
L.AddTree(aTree.Name).Assign(aTree);
IndexTrees(L,True);
end;
procedure TIDEInstantSearchManager.ClearMarkProjectTimer;
begin
FMarkProject:=nil;
if Assigned(FMarkProjectTimer) then
begin
FMarkProjectTimer.Enabled:=False;
FreeAndNil(FMarkProjectTimer);
end;
end;
procedure TIDEInstantSearchManager.StartMarkProjectTimer(aProject : TLazProject);
begin
FMarkProject:=aProject;
FMarkProjectTimer:=TTimer.Create(Self);
FMarkProjectTimer.Enabled:=False;
FMarkProjectTimer.Interval:=IndexProjectDelay*1000;
FMarkProjectTimer.OnTimer:=@DoMarkProjectIndexed;
FMarkProjectTimer.Enabled:=True;
end;
procedure TIDEInstantSearchManager.MarkProjectIndexed(aProject: TLazProject);
Var
FN : String;
begin
FN:=ChangeFileExt(ExtractFileName(aProject.ProjectInfoFile),'');
IDEMessagesWindow.AddCustomMessage(mluVerbose,lrsInstantSearch+Format(lrsMarkingIndexable,[FN]),aProject.ProjectInfoFile,0,0,lrsInstantSearch);
AssignProjectTreeID(aProject);
IndexProjectFiles(aProject);
end;
function TIDEInstantSearchManager.Search(const aTerm: String) : TMCSearchResultArray;
Var
I,aCount : Integer;
aTree : TSourceTreeDefinition;
aTrees : Array of string;
Procedure AddTree(const aName : String);
begin
aTrees[aCount]:=aName;
inc(aCount);
end;
begin
aTrees:=[];
SetLength(aTrees,Sourcetrees.Count+1);
aCount:=0;
if SearchProject and (ProjectTreeName<>'') then
addTree(ProjectTreeName);
for I:=0 to SourceTrees.Count-1 do
begin
aTree:=SourceTrees[i];
if aTree.Enabled then
addTree(aTree.Name);
end;
SetLength(aTrees,aCount);
Result:=Indexer.Search('*'+aTerm+'*',aTrees);
end;
destructor TIDEInstantSearchManager.Destroy;
begin
if Assigned(FIndexThread) then
begin
FIndexThread.Terminate;
While Assigned(FIndexThread) do
begin
Sleep(10);
// Can't use application.processmessages
CheckSynchronize;
end;
end;
FreeAndNil(FIndexer);
FreeAndNil(FSourceTrees);
FreeAndNil(FServerTrees);
FreeAndNil(FStartIndexTimer);
FreeAndNil(FMarkProjectTimer);
inherited Destroy;
end;
function TIDEInstantSearchManager.CanConnect: Boolean;
begin
Result:=(Indexer.IndexName<>'')
end;
function TIDEInstantSearchManager.TestConnect(aIndexList: TStrings): Boolean;
Var
aList : Tstrings;
begin
Result:=False;
aList:=aIndexList;
if aList=Nil then
aList:=TstringList.Create;
try
try
Indexer.Connect;
Indexer.ListIndexes(aList);
Result:=True;
except
On E : Exception do
DoManticoreLog(Self,mlkInfo,Format(lrsCannotConnectToManticore,[E.ClassName,E.Message]));
end;
finally
if aList<>aIndexList then
FreeAndNil(aList);
end;
end;
function TIDEInstantSearchManager.CanSearch: string;
begin
if Indexer.Transport=mctNone then
Exit(lrsNoTransport);
if (Indexer.Transport=mctMysql) and (Indexer.MySQLVersion=mcvNone) then
Exit(lrsNoMySQLVersion);
if SourceTrees.Count=0 then
Exit(lrsNoSearchTrees);
If (ServerTrees.Count=0) then
Exit(lrsNoServerTrees);
end;
procedure TIDEInstantSearchManager.DoStartIndexing;
begin
if Assigned(FOnIndexStart) then
FOnIndexStart(Self);
end;
function TIDEInstantSearchManager.IndexTrees(aList: TSourceTreeDefinitionList;
aFreeList: Boolean): Boolean;
Var
lTrees : TSourceTreeDefinitionList;
lIndexer : TManticoreSearchSources;
begin
Result:=False;
if IsIndexing then
begin
if AFreeList then
aList.Free;
exit;
end;
lTrees:=Nil;
try
if aFreeList then
lTrees:=aList
else
begin
lTrees:=TSourceTreeDefinitionList.Create(Nil,aList.ItemClass);
lTrees.Assign(aList);
end;
lIndexer:=Indexer.Clone(Self);
FIndexThread:=TInstantSearchIndexTreeThread.Create(lIndexer,lTrees,@DoOnIndexDone);
DoStartIndexing;
Result:=True;
except
On E : Exception do
begin
FreeAndNil(lTrees);
DoManticoreLog(Self,mlkInfo,Format(lrsCannotConnectToManticore,[E.ClassName,E.Message]));
end;
end;
end;
function TIDEInstantSearchManager.IndexTree(aTree: TSourceTreeDefinition
): Boolean;
Var
aList : TSourceTreeDefinitionList;
begin
aList:=TSourceTreeDefinitionList.Create(Self,TSourceTreeDefinition);
aList.AddTree(aTree.Name).Assign(aTree);
Result:=IndexTrees(aList,True);
end;
function TIDEInstantSearchManager.IsIndexing: Boolean;
begin
Result:=Assigned(FIndexThread);
end;
{ TSourceTreeDefinitionList }
function TSourceTreeDefinitionList.GetDef(aIndex : Integer
): TSourceTreeDefinition;
begin
Result:=TSourceTreeDefinition(Items[aIndex]);
end;
procedure TSourceTreeDefinitionList.SetDef(aIndex : Integer;
AValue: TSourceTreeDefinition);
begin
Items[aIndex]:=aValue;
end;
procedure TSourceTreeDefinitionList.Update(Item: TCollectionItem);
begin
if Owner is TIDEInstantSearchManager then
(Owner as TIDEInstantSearchManager).SourceTreesChanged;
end;
function TSourceTreeDefinitionList.AddTree(const aName: String
): TSourceTreeDefinition;
begin
Result:=Add as TSourceTreeDefinition;
Result.Name:=aName;
end;
function TSourceTreeDefinitionList.IndexOfName(const aName: String): Integer;
begin
Result:=Count-1;
While (Result>=0) and Not SameText(GetDef(Result).Name,aName) do
Dec(Result);
end;
function TSourceTreeDefinitionList.FindByName(const aName: String
): TSourceTreeDefinition;
Var
Idx : Integer;
begin
Result:=nil;
Idx:=IndexOfName(aName);
if Idx<>-1 then
Result:=GetDef(Idx);
end;
{ TSourceTreeDefinition }
procedure TSourceTreeDefinition.Assign(aSource: TPersistent);
Var
aSTD : TSourceTreeDefinition absolute aSource;
begin
if aSource is TSourceTreeDefinition then
begin
FBaseDir:=aStd.BaseDir;
FName:=aStd.Name;
FRecurse:=aStd.Recurse;
FExtensions:=aStd.Extensions;
FSystem:=aStd.System;
FAllFiles:=aStd.AllFiles;
FEnabled:=aStd.Enabled;
end
else
inherited Assign(aSource);
end;
end.
|