Small improvements and fixes

Author: eelstork

Doc.meta

@@ -0,0 +1,13 @@
+## Why Debug Chan?
+
+For complex projects “just logging to the console” is helpful but also a time waster; logging to the console either means a "free for all" approach (much junk to the console) or a zero trace policy (very little information to frame incoming issues).
+
+Debug Chan is meant to support a principled approach, where developers write (relatively) humanly readable and much less transient traces to document program execution.
+
+As such, debug chan implements three essential features:
+
+**Channeled logging** - select a game object or component to view matching traces.
+
+**Frame logging** - frame based processes often exhibit "stable" frame ranges. When an object look 'stuck', more likely than not they are cycling through the same trace over and over.
+
+**Channeled histories** - view an object's recent (or not so recent) history, aggregated via frame ranges.

Doc/Motivation.md

@@ -2,25 +2,26 @@
 using System.Linq; using System.IO; using System.Text;
 using S = System.String;
 using UnityEditor; using static UnityEditor.EditorPrefs;
-using static Activ.Prolog.ConfigKeys;
+using static Activ.Loggr.ConfigKeys;
 
-namespace Activ.Prolog{
+namespace Activ.Loggr{
 public class Config : AssetPostprocessor{
 
     public const int LogLineLength = 32;
     public const int MaxLines = 1000;
 
-    static List<string> elements = File.Exists(ConfigKeys.Path) ?
-        (from s in File.ReadAllText(ConfigKeys.Path).Split('\n')
-         select s.Trim()).ToList() : null;
+    // -------------------------------------------------------------
 
-    public static bool logToFile => elements?.Contains(FileFlag) ?? false;
+    public static bool allFrames
+    { set => SetBool(AllFrames, value); get => GetBool(AllFrames, true); }
 
     public static bool enableInjection{
         set{
             if(value == enableInjection) return;
             SetBool(EnableLogging, value);
-            Recompile.Apply();
+            // TODO dep? enableInjection should be prolog config
+            // not here
+            Activ.Prolog.Recompile.Apply();
         }get{
             try{
                 return GetBool(EnableLogging);
@@ -31,32 +32,42 @@ public static bool enableInjection{
         }
     }
 
-    public static bool allFrames
-    { set => SetBool(AllFrames, value); get => GetBool(AllFrames); }
+    public static float handleSize
+    { set => SetFloat(HandleSize, value); get => GetFloat(HandleSize); }
 
     public static bool logToConsole
-    { set => SetBool(LogToConsole, value); get => GetBool(LogToConsole); }
-
-    public static bool useSelection
-    { set => SetBool(UseSelection, value); get => GetBool(UseSelection); }
+    { set => SetBool(LogToConsole, value); get => GetBool(LogToConsole, false); }
 
-    public static float trailOffset
-    { set => SetFloat(TrailOffset, value); get => GetFloat(TrailOffset); }
+    public static bool logToFile => elements?.Contains(FileFlag) ?? false;
 
-    public static float handleSize
-    { set => SetFloat(HandleSize, value); get => GetFloat(HandleSize); }
+    public static int maxMessages
+    { set => SetInt(MaxMessages, value); get => GetInt(MaxMessages, 25000); }
 
     public static int rtypeIndex
     { set => SetInt(RTypeIndex, value); get => GetInt(RTypeIndex); }
 
     public static bool step
     { set => SetBool(Step, value); get => GetBool(Step); }
 
+    public static float trailOffset
+    { set => SetFloat(TrailOffset, value); get => GetFloat(TrailOffset); }
+
+    public static bool useSelection
+    { set => SetBool(UseSelection, value); get => GetBool(UseSelection, true); }
+
+    // -------------------------------------------------------------
+
     public static bool Exclude(string arg) => elements?.Contains(arg) ?? false;
 
+    // Static properties -------------------------------------------
+
+    static List<string> elements = File.Exists(ConfigKeys.Path) ?
+        (from s in File.ReadAllText(ConfigKeys.Path).Split('\n')
+         select s.Trim()).ToList() : null;
+
     static void OnPostprocessAllAssets (S[] i, S[] d, S[] m, S[] mf){
         if(!i.Contains(ConfigKeys.Path)) return;
-        print("Config changed - recompile"); Recompile.Apply();
+        print("Config changed - recompile"); Activ.Prolog.Recompile.Apply();
     }
 
     static void print(string x) => UnityEngine.Debug.Log(x);

Doc/Motivation.md.meta

@@ -0,0 +1,18 @@
+namespace Activ.Loggr{
+public static class ConfigKeys{
+
+    public const string UseSelection   = "Activ.Loggr.UseSel",
+                        AllFrames      = "Activ.Loggr.AllFrames",
+                        Step           = "Activ.Loggr.Step",
+                        RTypeIndex     = "Prolog.RType",
+                        MaxMessages    = "Activ.Loggr.MaxMessages",
+                        EnableLogging  = "Prolog.enable",
+                        LogToConsole   = "Activ.Loggr.LogToConsole",
+                        FileFlag       = "--file",
+                        LogPath        = "Assets/log.txt",
+                        Name           = "prolog.config",
+                        Path           = "Assets/prolog.config",
+                        TrailOffset    = "Activ.Loggr.TrailOffset",
+                        HandleSize     = "Activ.Loggr.HandleSize";
+
+}}

Editor/Core.meta

@@ -3,12 +3,20 @@
 using System.Linq;
 using static UnityEditor.EditorGUILayout;
 using static Activ.Prolog.LogWindowModel;
-using static Activ.Prolog.Config;
+//using static Activ.Prolog.PCfg;
 using Ed = UnityEditor.EditorApplication;
 using GL = UnityEngine.GUILayout;
 using EGL = UnityEditor.EditorGUILayout;
+//
+using PrologLogger = Activ.Prolog.Logger;
+using PrologConfigManager = Activ.Prolog.PrologConfigManager;
+using PrologFrame = Activ.Prolog.Frame;
+using PrologMessage = Activ.Prolog.Message;
+using PrologWindowModel = Activ.Prolog.LogWindowModel;
+using PrologHistoryGUI = Activ.Prolog.HistoryGUI;
+using PCfg = Activ.Prolog.PrologConfig;
 
-namespace Activ.Prolog{
+namespace Activ.Loggr.UI{
 public class LogWindow : EditorWindow{
 
     const int FontSize = 13;
@@ -17,34 +25,37 @@ public class LogWindow : EditorWindow{
     //
     static Font normalButtonFont;
     static Font     _font;
-    LogWindowModel model = LogWindowModel.instance;
-    Frame          selectedFrame;   // Last selected frame object
-    Vector2        scroll;
-    string         currentLog;
-    int            frame = -1;      // Last frame while playing (store this?)
+    PrologWindowModel model = PrologWindowModel.instance;
+    PrologFrame   selectedFrame;   // Last selected frame object
+    Vector2 scroll;
+    string  currentLog;
+    int     frame = -1;      // Last frame while playing (store this?)
+    // approx msg count (helps tracking memory overheads)
+    public static int cumulatedMessageCount;
 
     LogWindow(){
         Ed.pauseStateChanged +=
             (PauseState s) => { if(s == PauseState.Paused) Repaint(); };
-        Activ.Loggr.Logger<string, object>.messageReceived += OnMessage;
+        Activ.Loggr.Logger<string, object>.messageReceived += OnGenericMessage;
     }
 
     // From DebugChan
-    public void OnMessage(string message, object sender){
+    public void OnGenericMessage(string message, object sender, int messageCount){
+        cumulatedMessageCount = messageCount;
         if(isPlaying && instance){
             instance.DoUpdate(null);
         }
     }
 
     // From Prolog
-    public static void OnMessage(object sender, Message message){
+    public static void OnMessage(object sender, PrologMessage message){
         if(isPlaying && instance){
             instance.model.current = Selection.activeGameObject;
             instance.DoUpdate(message);
         }
     }
 
-    void DoUpdate(Message msg)
+    void DoUpdate(PrologMessage msg)
     { if(frame != Time.frameCount){ frame = Time.frameCount; Repaint(); }}
 
     void OnFocus(){
@@ -54,7 +65,7 @@ void OnFocus(){
 
     void OnGUI(){
         if(PrologConfigManager.current == null){
-            if(GL.Button("Create Prolog config")){
+            if(GL.Button("Create Debug-Chan config")){
                 PrologConfigManager.Create();
             }
             return;
@@ -70,7 +81,7 @@ void OnGUI_Content(){
         DrawScrubber();
         if(Config.enableInjection) DrawDebuggerTextView();
         DrawLoggerTextView();
-        DrawToggles();
+        DrawFooter();
         //DrawTrailsConfig();
     }
 
@@ -80,7 +91,7 @@ void DrawLoggerTextView(){
             DrawTextView("Not running");
             return;
         }
-        if(!useSelection || model.selection == null){
+        if(!Config.useSelection || model.selection == null){
             DrawTextView("No selection");
             return;
         }
@@ -122,7 +133,7 @@ void ConfigTextAreaStyle(){
         style.focused.textColor = Color.white;
     }
 
-    void DrawToggles(){
+    void DrawFooter(){
         BeginHorizontal();
         Config.useSelection = ToggleLeft("Use Selection", Config.useSelection,
                                 GL.MaxWidth(100f));
@@ -132,7 +143,8 @@ void DrawToggles(){
             = ToggleLeft("Log to console",  Config.logToConsole,
                                 GL.MaxWidth(120));
         //
-        GL.FlexibleSpace();
+        EndHorizontal();
+        BeginHorizontal();
         //
         GL.Label("Trails - offset: ", GL.MaxWidth(88f));
         Config.trailOffset = FloatField(Config.trailOffset,
@@ -144,8 +156,19 @@ void DrawToggles(){
         // TODO for Prolog update
         //if(model.selection){
         //    GL.Label("→", GL.MaxWidth(25f));
-        //    Config.rtypeIndex = Popup(Config.rtypeIndex, rtypeOptions);
+        //    PCfg.rtypeIndex = Popup(PCfg.rtypeIndex, rtypeOptions);
         //}
+        //EndHorizontal();
+        //BeginHorizontal();
+        GL.FlexibleSpace();
+        if(isPlaying){
+            EGL.LabelField($"#{cumulatedMessageCount:0,000,000}", GL.MaxWidth(92f));
+        }else{
+            EditorGUIUtility.labelWidth = 60;
+            Config.maxMessages = EGL.IntField("Max msgs", Config.maxMessages);
+            EditorGUIUtility.labelWidth = 0;
+            //if(ScrubberButton($"Clear")) Clear();
+        }
         EndHorizontal();
         if(!Config.useSelection) model.current = null;
     }
@@ -165,9 +188,13 @@ void DrawScrubber(){
         if(ScrubberButton(">")) SelectNext();
         style.font = normalButtonFont;
         GL.FlexibleSpace();
-        if(!isPlaying && ScrubberButton($"Clear")) Clear();
+        if(isPlaying){
+            //EGL.LabelField($"N#{cumulatedMessageCount:0,000,000}", GL.MaxWidth(92f));
+        }else{
+            if(ScrubberButton($"Clear")) Clear();
+        }
         // TODO reenable
-        //Config.step = ToggleLeft("Step", Config.step, GL.MaxWidth(48f));
+        //PCfg.step = ToggleLeft("Step", PCfg.step, GL.MaxWidth(48f));
         EndHorizontal();
     }
 
@@ -176,25 +203,25 @@ bool ScrubberButton(string arg)
 
     // TODO re-enable but move elsewhere
     //void DrawPauseModeConfig(){
-    //    Config.enableInjection = ToggleLeft(
+    //    PCfg.enableInjection = ToggleLeft(
     //        $"Instrument ({Logger.injectionTimeMs}ms)",
-    //        Config.enableInjection, GL.ExpandWidth(true));
+    //        PCfg.enableInjection, GL.ExpandWidth(true));
     //}
 
     void ToggleAdvanced(){}
 
     void DrawConfigManager(){
         var selected = EGL.ObjectField(
             PrologConfigManager.current,
-            typeof(PrologConfig),
+            typeof(PCfg),
             allowSceneObjects: false);
-        PrologConfigManager.current = selected as PrologConfig;
+        PrologConfigManager.current = (PCfg)selected;
     }
 
     // Ref https://tinyurl.com/yyo8c35g which also demonstrates starting a 2D
     // GUI at handles location
     void OnSceneGUI(SceneView sceneView){
-        var sel = HistoryGUI.Draw(model.filtered, selectedFrame);
+        var sel = PrologHistoryGUI.Draw(model.filtered, selectedFrame);
         if(Ed.isPaused || !isPlaying){
             selectedFrame = sel ?? selectedFrame;
             Repaint();
@@ -207,7 +234,7 @@ void OnSelectionChange()
     { if(Ed.isPaused || !isPlaying) Repaint(); }
 
     void Clear(){
-        Logger.Clear();
+        PrologLogger.Clear();
         model.Clear();
         selectedFrame = null;
         SceneView.RepaintAll();
@@ -226,10 +253,10 @@ void SelectNext(){
         SceneView.RepaintAll();
     }
 
-    [MenuItem("Window/Activ/Prolog")]
+    [MenuItem("Window/Activ/Debug-Chan")]
     static void Init(){
         instance = (LogWindow)EditorWindow
-                   .GetWindow<LogWindow>(title: "Prolog");
+                   .GetWindow<LogWindow>(title: "Debug-Chan");
         instance.Show();
     }