some progress with wave reload, incomplete

Author: pieter3d

src/panel.h

@@ -46,6 +46,8 @@ class Panel : public TextReceiver {
   virtual bool Modal() const { return false; }
   // Returns the current error message and clears it.
   std::string Error() const;
+  virtual void PrepareForWaveDataReload() {}
+  virtual void HandleReloadedWaves() {}
 
  protected:
   virtual int NumLines() const = 0;

src/ui.cc

@@ -63,7 +63,9 @@ void UI::UpdateTooltips() {
   tooltips_.clear();
   // Add the tooltips that are always present.
   tooltips_.push_back({"C-q", "quit"});
-  if (layout_.has_waves) {
+  if (layout_.has_waves && (panels_[focused_panel_idx_] == waves_panel_.get() ||
+                            panels_[focused_panel_idx_] == wave_tree_panel_.get() ||
+                            panels_[focused_panel_idx_] == wave_signals_panel_.get())) {
     tooltips_.push_back(
         {.hotkeys = "C-p",
          .description =
@@ -250,14 +252,18 @@ void UI::EventLoop() {
           break;
           break;
         case 0x10: // ctrl-P
-          layout_.show_wave_picker = !layout_.show_wave_picker;
-          // If one of those panels was selected, move focus to the wave panel.
-          if (focused_panel == wave_tree_panel_.get() || wave_signals_panel_.get()) {
-            focused_panel->SetFocus(false);
-            waves_panel_->SetFocus(true);
-            focused_panel_idx_ = panels_.size() - 1;
+          if (layout_.has_waves && (panels_[focused_panel_idx_] == waves_panel_.get() ||
+                                    panels_[focused_panel_idx_] == wave_tree_panel_.get() ||
+                                    panels_[focused_panel_idx_] == wave_signals_panel_.get())) {
+            layout_.show_wave_picker = !layout_.show_wave_picker;
+            // If one of those panels was selected, move focus to the wave panel.
+            if (focused_panel == wave_tree_panel_.get() || wave_signals_panel_.get()) {
+              focused_panel->SetFocus(false);
+              waves_panel_->SetFocus(true);
+              focused_panel_idx_ = panels_.size() - 1;
+            }
+            LayoutPanels();
           }
-          LayoutPanels();
           break;
         case 0x9:     // tab
         case 0x161: { // shift-tab

src/wavedata_tree_panel.cc

@@ -4,7 +4,7 @@
 
 namespace sv {
 
-WaveDataTreePanel::WaveDataTreePanel() {
+void WaveDataTreePanel::BuildInitialTree() {
   if (Workspace::Get().Waves() == nullptr) return;
   for (const auto &scope : Workspace::Get().Waves()->Roots()) {
     roots_.push_back(std::make_unique<WaveDataTreeItem>(scope));
@@ -15,31 +15,36 @@ WaveDataTreePanel::WaveDataTreePanel() {
   if (data_.ListSize() == 2) {
     data_.ToggleExpand(1);
   }
+  line_idx_ = 0;
+}
+
+WaveDataTreePanel::WaveDataTreePanel() { BuildInitialTree(); }
+
+void WaveDataTreePanel::HandleReloadedWaves() {
+  BuildInitialTree();
+  scope_for_signals_ = dynamic_cast<WaveDataTreeItem *>(data_[line_idx_])->SignalScope();
 }
 
 void WaveDataTreePanel::UIChar(int ch) {
   int initial_line = line_idx_;
   switch (ch) {
   case 'S':
     Workspace::Get().SetMatchedSignalScope(
-        dynamic_cast<const WaveDataTreeItem *>(data_[line_idx_])
-            ->SignalScope());
+        dynamic_cast<const WaveDataTreeItem *>(data_[line_idx_])->SignalScope());
     break;
   default: TreePanel::UIChar(ch);
   }
   // If the selection moved, update the signals panel
   if (line_idx_ != initial_line) {
-    scope_for_signals_ =
-        dynamic_cast<WaveDataTreeItem *>(data_[line_idx_])->SignalScope();
+    scope_for_signals_ = dynamic_cast<WaveDataTreeItem *>(data_[line_idx_])->SignalScope();
   }
 }
 
 std::vector<Tooltip> WaveDataTreePanel::Tooltips() const {
   return std::vector<Tooltip>{{"S", "set scope for source"}};
 }
 
-std::optional<const WaveData::SignalScope *>
-WaveDataTreePanel::ScopeForSignals() {
+std::optional<const WaveData::SignalScope *> WaveDataTreePanel::ScopeForSignals() {
   if (scope_for_signals_ == nullptr) return std::nullopt;
   auto ptr = scope_for_signals_;
   scope_for_signals_ = nullptr;

src/wavedata_tree_panel.h

@@ -16,8 +16,10 @@ class WaveDataTreePanel : public TreePanel {
   std::vector<Tooltip> Tooltips() const final;
   bool Searchable() const final { return true; }
   std::optional<const WaveData::SignalScope *> ScopeForSignals();
+  void HandleReloadedWaves() final;
 
  private:
+  void BuildInitialTree();
   const WaveData::SignalScope *scope_for_signals_ = nullptr;
   std::vector<std::unique_ptr<WaveDataTreeItem>> roots_;
 };

src/waves_panel.cc

@@ -1220,19 +1220,19 @@ bool WavesPanel::Search(bool search_down) {
   }
 }
 
-void WavesPanel::ReloadWaves() {
+void WavesPanel::PrepareForWaveDataReload() {
   // After the wave file is reloaded, the signal pointers are no longer valid.
   // Save the signal hierarchical paths so they can be re-discovered.
-  absl::flat_hash_map<int, std::string> signal_paths;
   for (int i = 0; i < items_.size(); ++i) {
     if (items_[i].signal != nullptr) {
-      signal_paths[i] = WaveData::SignalToPath(items_[i].signal);
+      reload_waves_[i] = WaveData::SignalToPath(items_[i].signal);
     }
   }
-  // Do the actual reload...
-  Workspace::Get().Waves()->Reload();
+}
+
+void WavesPanel::HandleReloadedWaves() {
   // Redo all the pointers.
-  for (auto &[idx, path] : signal_paths) {
+  for (auto &[idx, path] : reload_waves_) {
     auto &item = items_[idx];
     if (auto signal = wave_data_->PathToSignal(path)) {
       item.signal = *signal;

src/waves_panel.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include "absl/container/flat_hash_map.h"
 #include "panel.h"
 #include "radix.h"
 #include "text_input.h"
@@ -26,6 +27,8 @@ class WavesPanel : public Panel {
   bool Searchable() const final { return true; }
   bool Search(bool search_down) final;
   std::optional<const WaveData::Signal *> SignalForSource();
+  void PrepareForWaveDataReload() final;
+  void HandleReloadedWaves() final;
 
  private:
   struct ListItem {
@@ -58,7 +61,6 @@ class WavesPanel : public Panel {
   void AddGroup();
   void UpdateValues();
   void UpdateWaves();
-  void ReloadWaves();
   void UpdateValue(ListItem *item);
   void UpdateWave(ListItem *item);
   void SnapToValue();
@@ -104,6 +106,10 @@ class WavesPanel : public Panel {
   int name_value_size_ = 30;
   // Convenience to avoid repeated workspace Get() calls.
   const WaveData *wave_data_;
+
+  // When waves are reloaded, the current wave paths are stored here as strings, so they can be
+  // re-looked up afterwards.
+  absl::flat_hash_map<int, std::string> reload_waves_;
 };
 
 } // namespace sv

src/workspace.cc

@@ -84,6 +84,9 @@ bool Workspace::ParseDesign(int argc, char *argv[]) {
 void Workspace::TryMatchDesignWithWaves() {
   // Don't do anything unless there are both waves and design.
   if (wave_data_ == nullptr || design_root_ == nullptr) return;
+  // Reset initial to unmatched, to avoid stale pointers after wave-reload.
+  matched_design_scope_ = nullptr;
+  matched_signal_scope_ = nullptr;
   // Look for a scope with stuff in it, go 3 levels in.
   std::vector<const WaveData::SignalScope *> signal_scopes;
   for (const WaveData::SignalScope &root_scope : wave_data_->Roots()) {