File: frmfilebrowser.pas

package info (click to toggle)
lazarus 4.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 275,760 kB
  • sloc: pascal: 2,341,904; xml: 509,420; makefile: 348,726; cpp: 93,608; sh: 3,387; java: 609; perl: 297; sql: 222; ansic: 137
file content (604 lines) | stat: -rw-r--r-- 15,166 bytes parent folder | download
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
unit frmFileBrowser;

{$mode objfpc}{$H+}

interface

uses
  Classes, SysUtils,
  // LCL
  LCLType, Forms, Controls, Dialogs, FileCtrl, ComCtrls, StdCtrls, ExtCtrls,
  // LazUtils
  FileUtil, LazFileUtils, LazUTF8,
  // Files
  FileBrowserTypes, Masks;

type
  TOpenFileEvent = procedure(Sender: TObject; const AFileName: string) of object;


  { TFileBrowserForm }

  TFileBrowserForm = class(TForm)
    btnConfigure: TButton;
    btnReload: TButton;
    cbHidden: TCheckBox;
    FileListBox: TFileListBox;
    cbFilePanel: TFilterComboBox;
    cbTreeFilter: TFilterComboBox;
    ilTreeview: TImageList;
    Panel1: TPanel;
    pnlFiles: TPanel;
    Splitter1: TSplitter;
    TV: TTreeView;
    procedure btnConfigureClick(Sender: TObject);
    procedure btnReloadClick(Sender: TObject);
    procedure cbHiddenChange(Sender: TObject);
    procedure cbTreeFilterChange(Sender: TObject);
    procedure FileListBoxDblClick(Sender: TObject);
    procedure cbFilePanelChange(Sender: TObject);
    procedure FormClose(Sender: TObject; var CloseAction: TCloseAction);
    procedure FormCreate(Sender: TObject);
    procedure FormShow(Sender: TObject);
    procedure TVDblClick(Sender: TObject);
    procedure TVExpanded(Sender: TObject; Node: TTreeNode);
    procedure TVSelectionChanged(Sender: TObject);
    procedure FormActivate(Sender: TObject);
    procedure cbFilePanelSelect(Sender: TObject);
    procedure FileListBoxKeyPress(Sender: TObject; var Key: char);
  private
    FDirectoriesBeforeFiles: Boolean;
    FFilesInTree: Boolean;
    FOnConfigure: TNotifyEvent;
    FOnOpenFile: TOpenFileEvent;
    FOnSelectDir: TNotifyEvent;
    FRoot : TFileSystemEntry;
    FCurrentDir: string;
    FRootDir: string;
    FShowHidden: Boolean;
    FSelectedMask : TMaskList;
    procedure AddEntries(Node: TTreeNode);
    function AddNode(aSibling: TTreeNode; aEntry: TFileSystemEntry): TTreeNode;
    function AddChildNode(aParent: TTreeNode; aEntry: TFileSystemEntry): TTreeNode;
    procedure ConfigNode(aNode: TTreeNode; aEntry: TFileSystemEntry);
    function FindNode(aNodePath: String): TTreeNode;
    function GetAbsolutePath(Node: TTreeNode): string;
    function GetCurrentFile: string;
    function GetTreeFileMask: String;
    function NodeToEntry(aNode: TTreeNode): TFileSystemEntry;
    procedure SetCurrentFile(AValue: string);
    procedure SetDir(const Value: string);
    procedure SetDirectoriesBeforeFiles(AValue: Boolean);
    procedure SetFilesIntree(AValue: Boolean);
    procedure SetRootDir(const Value: string);
    procedure InitializeTreeview;
    procedure SetTreeFileMask(AValue: String);
    function ShowEntry(aEntry: TFilesystemEntry): boolean;
    {$IFDEF MSWINDOWS}
    procedure AddWindowsDriveLetters;
    {$ENDIF}
  public
    procedure ShowFiles;
    { Show the start directory }
    procedure ShowStartDir;
    { return the selected directory }
    function SelectedDir: string;
    { The selected/opened directory }
    property CurrentFile: string read GetCurrentFile write SetCurrentFile;
    { The selected/opened directory }
    property CurrentDirectory: string read FCurrentDir write SetDir;
    { Directory the treeview starts from }
    property RootDirectory: string read FRootDir write SetRootDir;
    { Must we show hidden directories - not working on unix type systems }
    property ShowHidden: Boolean read FShowHidden write FShowHidden default False;
    { Called when user double-clicks file name }
    property OnOpenFile: TOpenFileEvent read FOnOpenFile write FOnOpenFile;
    { Called when user clicks configure button }
    property OnConfigure: TNotifyEvent read FOnConfigure write FOnConfigure;
    { Called when a new directory is selected }
    property OnSelectDir: TNotifyEvent read FOnSelectDir write FOnSelectDir;
    { Show files in tree }
    property FilesInTree : Boolean Read FFilesInTree Write SetFilesIntree;
    { Show directories before files in tree }
    property DirectoriesBeforeFiles : Boolean Read FDirectoriesBeforeFiles Write SetDirectoriesBeforeFiles;
    { selected tree mask }
    property TreeFileMask : String Read GetTreeFileMask Write SetTreeFileMask;
  end;

var
  FileBrowserForm: TFileBrowserForm;


implementation

{$R frmfilebrowser.lfm}

{$IFDEF MSWINDOWS}
uses
  Windows;
{$ENDIF}

const
  cFilter = 'All Files (' + AllFilesMask + ')|' + AllFilesMask +
            '|Source(*.pas;*.pp)|*.pas;*.pp' +
            '|Projectfiles(*.pas;*.pp;*.inc;*.lfm;*.lpr;*.lrs;*.lpi;*.lpk)|' +
            '*.pas;*.pp;*.inc;*.lfm;*.lpr;*.lrs;*.lpi;*.lpk;|';


{ TFileBrowserForm }

procedure TFileBrowserForm.TVExpanded(Sender: TObject; Node: TTreeNode);
begin
  if Node.Count = 0 then
    AddEntries(Node);
end;

procedure TFileBrowserForm.TVSelectionChanged(Sender: TObject);

var
  Entry : TFileSystemEntry;

begin
  Entry:=NodeToEntry(TV.Selected);
  if Entry=Nil then
    Exit;
  if Entry.EntryType=etDirectory then
    begin
    FileListBox.Directory := ChompPathDelim(Entry.AbsolutePath);
    if Assigned(OnSelectDir) then
      OnselectDir(Self);
    end;
end;

procedure TFileBrowserForm.FormActivate(Sender: TObject);
begin
  { for some reason this does not work in FormShow }
  TV.MakeSelectionVisible;
end;

procedure TFileBrowserForm.cbFilePanelSelect(Sender: TObject);
begin
  FileListBox.Mask := cbFilePanel.Mask;
end;

procedure TFileBrowserForm.FileListBoxKeyPress(Sender: TObject; var Key: char);
begin
  if Key = Char(VK_RETURN) then
   FileListBoxDblClick(Sender);
end;

procedure TFileBrowserForm.btnConfigureClick(Sender: TObject);
begin
  if Assigned(FOnConfigure) then
    FOnConfigure(Self);
end;

procedure TFileBrowserForm.btnReloadClick(Sender: TObject);
var
  d: string;
begin
  // save current directory location
  d := ChompPathDelim(SelectedDir);
  InitializeTreeview;
  ShowFiles;
  // restore directory
  CurrentDirectory := d;
end;

procedure TFileBrowserForm.cbHiddenChange(Sender: TObject);
begin
  ShowHidden := cbHidden.Checked;
  if ShowHidden then
    FileListBox.FileType := FileListBox.FileType + [ftHidden]
  else
    FileListBox.FileType := FileListBox.FileType - [ftHidden];
end;

procedure TFileBrowserForm.cbTreeFilterChange(Sender: TObject);
begin
  TreeFileMask:=cbTreeFilter.Mask;
end;

procedure TFileBrowserForm.FileListBoxDblClick(Sender: TObject);
begin
  if Assigned(FOnOpenFile) then
    FOnOpenFile(Self, FileListBox.FileName);
end;

procedure TFileBrowserForm.cbFilePanelChange(Sender: TObject);
begin
  FileListBox.Mask := cbFilePanel.Text;

end;

procedure TFileBrowserForm.FormClose(Sender: TObject; var CloseAction: TCloseAction);
begin

end;

procedure TFileBrowserForm.FormCreate(Sender: TObject);
begin
  FShowHidden := False;
  InitializeTreeview;
  cbFilePanel.Filter := cFilter;
  cbTreeFilter.Filter := cFilter;
end;

procedure TFileBrowserForm.FormShow(Sender: TObject);
begin
  if TV.Selected <> nil then
    TV.Selected.Expand(False);
end;

procedure TFileBrowserForm.TVDblClick(Sender: TObject);

var
  Entry : TFileSystemEntry;

begin
  Entry:=NodeToEntry(TV.Selected);
  if Entry=nil then
    exit;
  if (Entry.EntryType=etFile) then
    FOnOpenFile(Self, Entry.AbsolutePath);
end;

{ Adds Subdirectories to a passed node if they exist }

function TFileBrowserForm.ShowEntry(aEntry : TFilesystemEntry) : boolean;

begin
  Result:=(aEntry.EntryType=etDirectory);
  if Not Result then
    Result:=(FSelectedMask=Nil) or FSelectedMask.Matches(aEntry.Name);
end;

procedure TFileBrowserForm.AddEntries(Node: TTreeNode);

  procedure ShowTypes(NodeEntry : TFileSystemEntry; aTypes : TEntryTypes);
  var
    Entry : TFileSystemEntry;
    SortList :  TStringList;
    I : Integer;
  begin
    SortList := TStringList.Create;
    try
      For I:=0 to NodeEntry.EntryCount-1 do
        begin
        Entry:=NodeEntry.Entries[I];
        if Entry.EntryType in aTypes then
          SortList.AddObject(Entry.Name,Entry);
        end;
      SortList.Sort;
      For I:=0 to SortList.Count-1 do
        begin
        Entry:=TFileSystemEntry(SortList.Objects[i]);
        if ShowEntry(Entry) then
          AddChildNode(Node,Entry);
        end;
    finally
      SortList.Free;
    end;
  end;

var
  NodeEntry : TFileSystemEntry;
  lTypes : TEntryTypes;
  rOptions : TReadEntryOptions;

begin
  NodeEntry:=NodeToEntry(Node);
  if NodeEntry=Nil then
    exit;
  lTypes:=[etDirectory];
  if FilesInTree then
    Include(lTypes,etFile);
  rOptions:=[];
  if ShowHidden then
    Include(rOptions,reoHidden);
  if NodeEntry.HasEntries(ShowHidden,lTypes) and (NodeEntry.EntryCount=0) then
    NodeEntry.ReadEntries(rOptions);
  if DirectoriesBeforeFiles then
    begin
    ShowTypes(NodeEntry,[etDirectory]);
    ShowTypes(NodeEntry,[etFile,etSymlink]);
    end
  else
    ShowTypes(NodeEntry,[etDirectory,etFile,etSymlink]);
end;

function TFileBrowserForm.GetAbsolutePath(Node: TTreeNode): string;
begin
  Result := '';
  while Node <> nil do
  begin
    if Node.Text = PathDelim then
      Result := Node.Text + Result
    else
      Result := Node.Text + PathDelim + Result;
    Node := Node.Parent;
  end;
end;

function TFileBrowserForm.GetCurrentFile: string;

var
  N : TTreeNode;
  E : TFileSystemEntry;

begin
  Result:='';
  if FilesInTree then
    begin
    N:=TV.Selected;
    if Assigned(N) then
      E:=NodeToEntry(N);
    if Assigned(E) and (E.EntryType=etFile) then
      Result:=E.AbsolutePath;
    end
  else
    With FileListBox do
      if FileName<>'' then
        Result:=IncludeTrailingPathDelimiter(Directory)+FileName;
end;

function TFileBrowserForm.GetTreeFileMask: String;
begin
  if Assigned(FSelectedMask) then
    Result:=FSelectedMask.Mask
  else
    Result:='';
end;

function TFileBrowserForm.FindNode(aNodePath : String) : TTreeNode;

var
  StartDir: string;
  i, p: integer;
  SubDir: PChar;
  Node : TTreeNode;

begin
  Result:=nil;
  StartDir:=IncludeTrailingPathDelimiter(aNodePath);
  UniqueString(StartDir);
  p := AnsiPos(RootDirectory, StartDir);
  if p = 1 then
    Delete(StartDir, P, Length(RootDirectory));
  for i := 1 to Length(StartDir) do
    if (StartDir[i] = PathDelim) then
      StartDir[i] := #0;
  SubDir := PChar(StartDir);
  if SubDir[0] = #0 then
    SubDir := @SubDir[1];
  Node := TV.Items.GetFirstNode;
  if Node=Nil then
    exit;
  while SubDir[0] <> #0 do
  begin
    Node := Node.GetFirstChild;
    while (Node <> nil) and (AnsiCompareStr(Node.Text, SubDir) <> 0) do
      Node := Node.GetNextSibling;
    if Node = nil then
      break
    else
      Node.Expand(False);
    SubDir := SubDir + StrLen(SubDir) + 1;
  end;
  Result:=Node;
end;

procedure TFileBrowserForm.SetDir(const Value: string);

begin
  FCurrentDir     := Value;
  ShowStartDir;
end;

procedure TFileBrowserForm.ShowStartDir;

var
  StartDir: string;
  Node: TTreeNode;

begin
  StartDir := FCurrentDir;
  if TV.Items.Count = 0 then
    Exit;
  Node:=FindNode(StartDir);
  TV.Selected := Node;
  TV.MakeSelectionVisible;
end;

procedure TFileBrowserForm.SetDirectoriesBeforeFiles(AValue: Boolean);
begin
  if FDirectoriesBeforeFiles=AValue then Exit;
  FDirectoriesBeforeFiles:=AValue;
  InitializeTreeview;
end;

procedure TFileBrowserForm.SetFilesIntree(AValue: Boolean);
begin
  if FFilesInTree=AValue then Exit;
  FFilesInTree:=AValue;
  InitializeTreeview;
end;

procedure TFileBrowserForm.SetRootDir(const Value: string);
var
  DoShowFiles : Boolean;

begin
  if (FRootDir=Value) then exit;
  FRootDir:=Value;
  DoShowFiles:=TV.Items.Count>0;
  InitializeTreeView;
  If DoShowFiles then
    ShowFiles;
end;

procedure TFileBrowserForm.InitializeTreeview;
begin
  TV.Items.Clear;
  pnlFiles.Visible:=not FilesInTree;
  Splitter1.Visible:=Not FilesInTree;
  if FilesInTree then
    TV.Align:=alClient;
end;

procedure TFileBrowserForm.SetTreeFileMask(AValue: String);

begin
  if aValue=GetTreeFileMask then exit;
  FreeAndNil(FSelectedMask);
  if AValue<>'' then
    FselectedMask:=TMaskList.Create(aValue);
  if TV.Items.Count>0 then
    ShowFiles;
end;

procedure TFileBrowserForm.ShowFiles;

Var
  RootNode: TTreeNode;
  lNode: TTreeNode;
  Dir : String;

begin
  TV.Items.Clear;
  {$IFDEF MSWINDOWS}
  { Add Windows drive letters }
  AddWindowsDriveLetters;
  {$ENDIF}
  Dir:=RootDirectory;
  if Dir='' then
    Dir:=PathDelim;
  if Assigned(FRoot) then
    FreeAndNil(FRoot);
  FRoot:=TDirectoryEntry.Create(Nil,ExcludeTrailingPathDelimiter(Dir));
  { Remove the path delimiter unless this is root. }
  if (Dir<>PathDelim) and (Dir[length(Dir)] = PathDelim) then
    SetLength(Dir, length(Dir)-1);
  { Find or Create the root node and add it to the Tree View. }
  RootNode := TV.Items.FindTopLvlNode(Dir + PathDelim);
  if RootNode = nil then
    RootNode := AddNode(Nil,FRoot);

  { Add the Subdirectories to Root nodes }
  lNode := TV.Items.GetFirstNode;
  while lNode <> nil do
  begin
    AddEntries(lNode);
    lNode := lNode.GetNextSibling;
  end;

  { Set the original root node as the selected node. }
  TV.Selected := RootNode;
  RootNode.Expand(False);
end;

procedure TFileBrowserForm.ConfigNode(aNode : TTreeNode; aEntry : TFileSystemEntry);

var
  Idx : Integer;

begin
  aNode.Data:=aEntry;
  Case aEntry.EntryType of
    etDirectory : Idx:=0;
    etFile : Idx:=1;
    etSymlink : Idx:=2;
  end;
  aNode.ImageIndex:=Idx;
  aNode.SelectedIndex:=Idx;
  aNode.HasChildren:=aEntry.HasEntries(ShowHidden);
end;

function TFileBrowserForm.AddNode(aSibling : TTreeNode; aEntry : TFileSystemEntry) : TTreeNode;

begin
  Result:=TV.Items.Add(nil, aEntry.Name);
  ConfigNode(Result,aEntry);
end;

function TFileBrowserForm.AddChildNode(aParent: TTreeNode; aEntry: TFileSystemEntry): TTreeNode;
begin
  Result:=TV.Items.AddChild(aParent, aEntry.Name);
  ConfigNode(Result,aEntry);
end;

{$IFDEF MSWINDOWS}
procedure TFileBrowserForm.AddWindowsDriveLetters;
const
  MAX_DRIVES = 25;
var
  n: integer;
  drvs: string;
  DriveEntry : TDirectoryEntry;

begin
  // making drive list, skipping drives A: and B: and Removable Devices without media
  n := 2;
  while n <= MAX_DRIVES do
  begin
    drvs := chr(n + Ord('A')) + ':\';
    if (Windows.GetDriveType(PChar(drvs)) <> 1) and
    (GetDiskFreeSpaceEx(PChar(drvs), nil, nil, nil)) then
      begin
      DriveEntry:=TDirectoryEntry.Create(Nil,drvs);
      AddNode(Nil,DriveEntry);
      end;
    Inc(n);
  end;
end;
{$ENDIF}

function TFileBrowserForm.NodeToEntry(aNode : TTreeNode) : TFileSystemEntry;

begin
  Result:=Nil;
  if Assigned(aNode) then
    Result:=TFileSystemEntry(aNode.Data);
end;

procedure TFileBrowserForm.SetCurrentFile(AValue: string);

var
  Dir : String;
  Node : TTreeNode;

begin
  if FilesInTree then
    begin
    Node:=FindNode(aValue);
    if Assigned(Node) then
      TV.Selected:=Node;
    end
  else
    begin
    Dir:=ExtractFilePath(aValue);
    CurrentDirectory:=Dir;
    FileListBox.Directory:=Dir;
    FileListBox.FileName:=ExtractFileName(aValue);
    end
end;

function TFileBrowserForm.SelectedDir: string;

var
  Entry : TFileSystemEntry;

begin
  Result := '';
  Entry:=NodeToEntry(TV.Selected);
  if Not Assigned(Entry) then
    exit;
  if Entry.EntryType<>etDirectory then
    Entry:=Entry.Parent;
  if Not Assigned(Entry) then
    exit;
  Result := Entry.AbsolutePath;
end;

end.