From d104b2651ef1ea8718c2a2354c1768a45c955cd0 Mon Sep 17 00:00:00 2001
From: Basile Burg <basile.b@gmx.com>
Date: Thu, 13 Jul 2017 12:11:23 +0200
Subject: [PATCH] enhance the profile view, close #160

---
 docs/index.md                  |   1 +
 docs/widgets_profile_viewer.md |  11 +-
 src/ce_profileviewer.lfm       |  42 ++++--
 src/ce_profileviewer.pas       | 257 ++++++++++++++++++++++++++++++++-
 4 files changed, 292 insertions(+), 19 deletions(-)

diff --git a/docs/index.md b/docs/index.md
index 3c91f0a7..68cb9216 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -54,6 +54,7 @@ _Full description of Coedit options. May redirect to a specific widget page._
 * [Editor pages](options_editor_pages)
 * [Messages](widgets_messages)
 * [Mini explorer](widgets_mini_explorer)
+* [Profile viewer](widgets_profile_viewer)
 * [Runnable modules](features_runnables)
 * [Shortcuts editor](options_shortcuts_editor)
 * [Static macros](widgets_editor)
diff --git a/docs/widgets_profile_viewer.md b/docs/widgets_profile_viewer.md
index 05b28b1c..f955411b 100644
--- a/docs/widgets_profile_viewer.md
+++ b/docs/widgets_profile_viewer.md
@@ -23,8 +23,17 @@ The list displays all the results, which can be inspected more accurately after
 
 #### Toolbar
 
-- <img src="{%include icurl%}folder/folder.png" class="tlbric"/>: Propose to open the _trace.log_ from a dialog.
+- <img src="{%include icurl%}other/list.png" class="tlbric"/>: Loads the _trace.log_ file located in the project output path.
+- <img src="{%include icurl%}folder/folder.png" class="tlbric"/>: Proposes to open the _trace.log_ from a dialog.
 - <img src="{%include icurl%}arrow/arrow_update.png" class="tlbric"/>: Reloads the current _trace.log_ or tries to load it from the current directory.
+- <img src="{%include icurl%}cog/wrench.png" class="tlbric"/>: Shows the profile viewer options.
+
+#### Options
+
+- **hideAtributes**: Sets if the functions attributes are displayed.
+- **hideRuntimeCalls**: When checked, all the functions starting with `core.` are excluded.
+- **hideStandardLibraryCalls**: When checked, all the functions starting with `std.` are excluded.
+- **otherExclusion**: Allows to define other sub-strings masks.
 
 {% raw %}
 <script>
diff --git a/src/ce_profileviewer.lfm b/src/ce_profileviewer.lfm
index aeeb80a4..c1bb2c63 100644
--- a/src/ce_profileviewer.lfm
+++ b/src/ce_profileviewer.lfm
@@ -28,32 +28,32 @@ inherited CEProfileViewerWidget: TCEProfileViewerWidget
             AutoSize = True
             MaxWidth = 18
             MinWidth = 18
-            Width = 0
+            Width = 18
           end        
           item
             AutoSize = True
             Caption = 'Num calls'
-            Width = 68
+            Width = 74
           end        
           item
             AutoSize = True
             Caption = 'Tree time'
-            Width = 65
+            Width = 72
           end        
           item
             AutoSize = True
             Caption = 'Func time'
-            Width = 68
+            Width = 75
           end        
           item
             AutoSize = True
             Caption = 'Per call'
-            Width = 53
+            Width = 58
           end        
           item
             AutoSize = True
             Caption = 'function'
-            Width = 60
+            Width = 244
           end>
         HideSelection = False
         ReadOnly = True
@@ -129,7 +129,7 @@ inherited CEProfileViewerWidget: TCEProfileViewerWidget
     inherited toolbar: TCEToolBar
       Width = 543
       object btnRefresh: TCEToolButton[0]
-        Left = 29
+        Left = 57
         Hint = 'reload current trace log file or auto load from the current directory'
         Top = 0
         Caption = 'btnRefresh'
@@ -138,7 +138,7 @@ inherited CEProfileViewerWidget: TCEProfileViewerWidget
         scaledSeparator = False
       end
       object btnOpen: TCEToolButton[1]
-        Left = 1
+        Left = 29
         Hint = 'open a trace log file'
         Top = 0
         Caption = 'btnOpen'
@@ -147,7 +147,7 @@ inherited CEProfileViewerWidget: TCEProfileViewerWidget
         scaledSeparator = False
       end
       object button0: TCEToolButton[2]
-        Left = 57
+        Left = 113
         Height = 28
         Top = 0
         Width = 13
@@ -156,13 +156,13 @@ inherited CEProfileViewerWidget: TCEProfileViewerWidget
         scaledSeparator = False
       end
       object selPieSource: TComboBox[3]
-        Left = 70
-        Height = 23
+        Left = 126
+        Height = 36
         Hint = 'select the pie representation'
         Top = 0
         Width = 154
         BorderSpacing.InnerBorder = 3
-        ItemHeight = 15
+        ItemHeight = 0
         ItemIndex = 0
         Items.Strings = (
           'Number of calls'
@@ -175,6 +175,24 @@ inherited CEProfileViewerWidget: TCEProfileViewerWidget
         TabOrder = 0
         Text = 'Number of calls'
       end
+      object btnOpts: TCEToolButton[4]
+        Left = 85
+        Hint = 'edit profile viewer options'
+        Top = 0
+        Caption = 'btnOpts'
+        OnClick = btnOptsClick
+        resourceName = 'WRENCH'
+        scaledSeparator = False
+      end
+      object btnProj: TCEToolButton[5]
+        Left = 1
+        Hint = 'Try to load using the project output path'
+        Top = 0
+        Caption = 'btnProj'
+        OnClick = btnProjClick
+        resourceName = 'LIST'
+        scaledSeparator = False
+      end
     end
   end
   inherited contextMenu: TPopupMenu
diff --git a/src/ce_profileviewer.pas b/src/ce_profileviewer.pas
index 6a80fca9..38260629 100644
--- a/src/ce_profileviewer.pas
+++ b/src/ce_profileviewer.pas
@@ -8,12 +8,46 @@ uses
   Classes, SysUtils, FileUtil, TASources, TAGraph, TATransformations, TASeries,
   TATools, Forms, Controls, Graphics, Dialogs, ExtCtrls, Menus, ComCtrls,
   StdCtrls, TALegend, math,
-  ce_widget, ce_common, ce_stringrange, ce_dsgncontrols, ce_ddemangle;
+  ce_widget, ce_common, ce_stringrange, ce_dsgncontrols, ce_ddemangle,
+  ce_interfaces, ce_observer, ce_writableComponent;
 
 type
 
-  TCEProfileViewerWidget = class(TCEWidget)
+  TCEProfileViewerOptionsBase = class(TWritableLfmTextComponent)
+  private
+    fHideAttributes: boolean;
+    fHideStandardLibraryCalls: boolean;
+    fHideRunTimeCalls: boolean;
+    fOtherExclusions: TStringList;
+    procedure setOtherExclusions(value: TStringList);
+  public
+    constructor create(aOwner: TComponent); override;
+    destructor destroy; override;
+    procedure assign(value: TPersistent); override;
+  published
+    property hideAttributes: boolean read fHideAttributes write fHideAttributes;
+    property hideStandardLibraryCalls: boolean read fHideStandardLibraryCalls write fHideStandardLibraryCalls;
+    property hideRuntimeCalls: boolean read fHideRunTimeCalls write fHideRunTimeCalls;
+    property otherExclusions: TStringList read fOtherExclusions write setOtherExclusions;
+  end;
+
+  TCEprofileViewerOptions = class(TCEProfileViewerOptionsBase, ICEEditableOptions)
+  private
+    fBackup: TCEProfileViewerOptionsBase;
+    function optionedWantCategory(): string;
+    function optionedWantEditorKind: TOptionEditorKind;
+    function optionedWantContainer: TPersistent;
+    procedure optionedEvent(event: TOptionEditorEvent);
+    function optionedOptionsModified: boolean;
+  public
+    constructor create(aOwner: TComponent); override;
+    destructor destroy; override;
+  end;
+
+  TCEProfileViewerWidget = class(TCEWidget, ICEProjectObserver)
     btnOpen: TCEToolButton;
+    btnOpts: TCEToolButton;
+    btnProj: TCEToolButton;
     btnRefresh: TCEToolButton;
     button0: TCEToolButton;
     ChartToolset1: TChartToolset;
@@ -30,36 +64,175 @@ type
     pieSeries: TPieSeries;
     Splitter1: TSplitter;
     procedure btnOpenClick(Sender: TObject);
+    procedure btnProjClick(Sender: TObject);
     procedure btnRefreshClick(Sender: TObject);
+    procedure btnOptsClick(Sender: TObject);
     procedure selPieSourceSelect(Sender: TObject);
     procedure selPieSourceSelectionChange(Sender: TObject; User: boolean);
-    procedure Splitter1CanResize(Sender: TObject; var NewSize: Integer;
-      var Accept: Boolean);
+    procedure Splitter1CanResize(Sender: TObject; var NewSize: Integer; var Accept: Boolean);
     procedure Splitter1Moved(Sender: TObject);
   private
+    fOptions: TCEprofileViewerOptions;
     logFname: string;
+    fProj: ICECommonProject;
     procedure updateIcons;
     procedure clearViewer;
     procedure updateFromFile(const fname: string);
     procedure updatePie;
     procedure listCompare(Sender: TObject; item1, item2: TListItem; Data: Integer; var Compare: Integer);
+    procedure projNew(project: ICECommonProject);
+    procedure projChanged(project: ICECommonProject);
+    procedure projClosing(project: ICECommonProject);
+    procedure projFocused(project: ICECommonProject);
+    procedure projCompiling(project: ICECommonProject);
+    procedure projCompiled(project: ICECommonProject; success: boolean);
   public
     constructor create(aOwner: TComponent); override;
+    destructor destroy; override;
+    procedure reloadCurrent;
   end;
 
+  const optFname = 'profileviewer.txt';
+
 implementation
 {$R *.lfm}
 
+constructor TCEProfileViewerOptionsBase.create(aOwner: TComponent);
+begin
+  inherited create(aOwner);
+  fOtherExclusions := TStringList.Create;
+end;
+
+destructor TCEProfileViewerOptionsBase.destroy;
+begin
+  fOtherExclusions.free;
+  inherited;
+end;
+
+procedure TCEProfileViewerOptionsBase.assign(value: TPersistent);
+var
+  s: TCEProfileViewerOptionsBase;
+begin
+  if value is TCEProfileViewerOptionsBase then
+  begin
+    s := TCEProfileViewerOptionsBase(value);
+    fOtherExclusions.Assign(s.fOtherExclusions);
+    fHideRunTimeCalls:=s.fHideRunTimeCalls;
+    fHideStandardLibraryCalls:=fHideStandardLibraryCalls;
+  end
+  else inherited;
+end;
+
+procedure TCEProfileViewerOptionsBase.setOtherExclusions(value: TStringList);
+begin
+  fOtherExclusions.assign(value);
+end;
+
+constructor TCEprofileViewerOptions.create(aOwner: TComponent);
+var
+  s: string;
+begin
+  inherited create(aOwner);
+  fBackup := TCEProfileViewerOptionsBase.create(nil);
+  EntitiesConnector.addObserver(self);
+  s := getCoeditDocPath + optFname;
+  if s.fileExists then
+    loadFromFile(s);
+end;
+
+destructor TCEprofileViewerOptions.destroy;
+begin
+  saveTofile(getCoeditDocPath + optFname);
+  EntitiesConnector.removeObserver(self);
+  fBackup.free;
+  inherited;
+end;
+
+function TCEprofileViewerOptions.optionedWantCategory(): string;
+begin
+  result := 'Profile viewer';
+end;
+
+function TCEprofileViewerOptions.optionedWantEditorKind: TOptionEditorKind;
+begin
+  result := oekGeneric;
+end;
+
+function TCEprofileViewerOptions.optionedWantContainer: TPersistent;
+begin
+  result := self;
+end;
+
+procedure TCEprofileViewerOptions.optionedEvent(event: TOptionEditorEvent);
+begin
+  case event of
+    oeeAccept:
+      begin
+        fBackup.assign(self);
+        TCEProfileViewerWidget(owner).reloadCurrent;
+      end;
+    oeeCancel:
+      begin
+        self.assign(fBackup);
+        TCEProfileViewerWidget(owner).reloadCurrent;
+      end;
+    oeeSelectCat:
+      fBackup.assign(self);
+    oeeChange:
+      TCEProfileViewerWidget(owner).reloadCurrent;
+  end;
+end;
+
+function TCEprofileViewerOptions.optionedOptionsModified: boolean;
+begin
+  result := false;
+end;
+
 constructor TCEProfileViewerWidget.create(aOwner: TComponent);
 begin
   inherited;
+  EntitiesConnector.addObserver(self);
+  fOptions:= TCEprofileViewerOptions.create(self);
   clearViewer;
   updatePie;
   list.OnCompare:=@listCompare;
   selPieSourceSelect(nil);
 end;
 
-procedure TCEProfileViewerWidget.btnRefreshClick(Sender: TObject);
+destructor TCEProfileViewerWidget.destroy;
+begin
+  EntitiesConnector.removeObserver(self);
+  inherited;
+end;
+
+procedure TCEProfileViewerWidget.projNew(project: ICECommonProject);
+begin
+end;
+
+procedure TCEProfileViewerWidget.projChanged(project: ICECommonProject);
+begin
+end;
+
+procedure TCEProfileViewerWidget.projClosing(project: ICECommonProject);
+begin
+  if project = fProj then
+    fProj := nil;
+end;
+
+procedure TCEProfileViewerWidget.projFocused(project: ICECommonProject);
+begin
+  fProj := project;
+end;
+
+procedure TCEProfileViewerWidget.projCompiling(project: ICECommonProject);
+begin
+end;
+
+procedure TCEProfileViewerWidget.projCompiled(project: ICECommonProject; success: boolean);
+begin
+end;
+
+procedure TCEProfileViewerWidget.reloadCurrent;
 var
   fname: string;
 begin
@@ -76,6 +249,16 @@ begin
   end;
 end;
 
+procedure TCEProfileViewerWidget.btnRefreshClick(Sender: TObject);
+begin
+  reloadCurrent;
+end;
+
+procedure TCEProfileViewerWidget.btnOptsClick(Sender: TObject);
+begin
+  getOptionsEditor.showOptionEditor(fOptions as ICEEditableOptions);
+end;
+
 procedure TCEProfileViewerWidget.selPieSourceSelect(Sender: TObject);
 begin
   case selPieSource.ItemIndex of
@@ -103,6 +286,21 @@ begin
   end;
 end;
 
+procedure TCEProfileViewerWidget.btnProjClick(Sender: TObject);
+var
+  fname: string;
+begin
+  if assigned(fProj) then
+  begin
+    fname := fProj.outputFilename.extractFileDir + DirectorySeparator + 'trace.log';
+    if fileExists(fname) then
+    begin
+      updateFromFile(fname);
+      logFname:=fname;
+    end;
+  end;
+end;
+
 procedure TCEProfileViewerWidget.updatePie;
 begin
   pieSeries.FixedRadius:= max(1, pie.Height div 2 - 10);
@@ -176,6 +374,7 @@ var
   fft: qword;
   ftt: qword;
   fpc: qword;
+  exc: string;
 
   procedure fillRow();
   var
@@ -196,6 +395,47 @@ var
     datPerCall.Add(0, fpc, idt, c);
   end;
 
+  function canShow: boolean;
+  begin
+    result := true;
+    if fOptions.hideRuntimeCalls and (Pos(' core.', idt) > 0) then
+      exit(false);
+    if fOptions.hideStandardLibraryCalls and (Pos(' std.', idt) > 0) then
+      exit(false);
+    if fOptions.otherExclusions.Count > 0 then
+      for exc in fOptions.otherExclusions do
+        if Pos(exc, idt) > 0 then
+          exit(false);
+  end;
+
+  procedure filterAttributes;
+  const
+    a: array[0..12] of string = ('const','pure','nothrow','@safe','@nogc',
+      '@trusted', '@system', 'immutable', 'inout', 'return', '@property',
+      'shared', 'scope');
+  var
+    i: integer = 0;
+    j: integer;
+    p: integer;
+    s: string;
+  begin
+    if not fOptions.hideAttributes then
+      exit;
+    p := pos('(', idt);
+    if p = 0 then
+      p := integer.MaxValue;
+    for s in a do
+    begin
+      j := pos(s, idt);
+      if (j > 0) then
+        j += s.length + 1;
+      if (j < p) and (j >= i) then
+        i := j;
+    end;
+    if i > 0 then
+      idt := idt[i..idt.length];
+  end;
+
 begin
   clearViewer;
 
@@ -272,7 +512,12 @@ begin
     rng.popWhile(' ')^.empty;
     idt := demangle(rng.takeUntil(#10).yield);
 
-    fillRow;
+    // apply options and add item
+    if canShow then
+    begin
+      filterAttributes;
+      fillRow;
+    end;
 
     if not rng.empty then
       rng.popFront