reworked stage change ui setup functions and enabled show routing option only in routing stage

SamuelHo10 · SamuelHo10 · commit 054884c217ec · 2025-08-21T12:43:35.000-04:00
diff --git a/vpr/src/draw/draw.cpp b/vpr/src/draw/draw.cpp
@@ -78,21 +78,13 @@ static float get_router_expansion_cost(const t_rr_node_route_inf& node_inf,
 static void draw_router_expansion_costs(ezgl::renderer* g);
 
 static void draw_main_canvas(ezgl::renderer* g);
-static void default_setup(ezgl::application* app);
-static void initial_setup_NO_PICTURE_to_PLACEMENT(ezgl::application* app,
-                                                  bool is_new_window);
-static void initial_setup_NO_PICTURE_to_PLACEMENT_with_crit_path(
-    ezgl::application* app,
-    bool is_new_window);
-static void initial_setup_PLACEMENT_to_ROUTING(ezgl::application* app,
-                                               bool is_new_window);
-static void initial_setup_ROUTING_to_PLACEMENT(ezgl::application* app,
-                                               bool is_new_window);
-static void initial_setup_NO_PICTURE_to_ROUTING(ezgl::application* app,
-                                                bool is_new_window);
-static void initial_setup_NO_PICTURE_to_ROUTING_with_crit_path(
-    ezgl::application* app,
-    bool is_new_window);
+
+/**
+ * @brief Generalized callback function to setup the UI when the stage changes.
+ */
+static void on_stage_change_setup(ezgl::application* app, bool is_new_window);
+
+
 static void setup_default_ezgl_callbacks(ezgl::application* app);
 static void set_force_pause(GtkWidget* /*widget*/, gint /*response_id*/, gpointer /*data*/);
 static void set_block_outline(GtkWidget* widget, gint /*response_id*/, gpointer /*data*/);
@@ -254,108 +246,40 @@ static void draw_main_canvas(ezgl::renderer* g) {
     }
 }
 
-/**
- * @brief Default setup function, connects signals/sets up ui created in main.ui file
- *
- * To minimize code repetition, this function sets up all buttons that ALWAYS get set up.
- * If you want to add to the initial setup functions, and your new setup function will always be called,
- * please put it here instead of writing it 5 independent times. Thanks!
- * @param app ezgl application
- */
-static void default_setup(ezgl::application* app) {
-    basic_button_setup(app);
-    net_button_setup(app);
-    block_button_setup(app);
-    search_setup(app);
-    view_button_setup(app);
-}
 
-// Initial Setup functions run default setup if they are a new window. Then, they will run
-// the specific hiding/showing functions that separate them from the other init. setup functions
+static void on_stage_change_setup(ezgl::application* app, bool is_new_window) {
+    
+    // default setup for new window
+    if(is_new_window) {
+        basic_button_setup(app);
+        net_button_setup(app);
+        block_button_setup(app);
+        search_setup(app);
+        routing_button_setup(app);
+        view_button_setup(app);
+        crit_path_button_setup(app);
+    }
 
-/* function below initializes the interface window with a set of buttons and links
- * signals to corresponding functions for situation where the window is opened from
- * NO_PICTURE_to_PLACEMENT */
-static void initial_setup_NO_PICTURE_to_PLACEMENT(ezgl::application* app,
-                                                  bool is_new_window) {
-    if (is_new_window)
-        default_setup(app);
+    t_draw_state* draw_state = get_draw_state_vars();
 
-    //Hiding unused functionality
-    hide_widget("RoutingMenuButton", app);
-}
+    if (draw_state->pic_on_screen == PLACEMENT) {
+        hide_widget("RoutingMenuButton", app);
 
-/* function below initializes the interface window with a set of buttons and links
- * signals to corresponding functions for situation where the window is opened from
- * NO_PICTURE_to_PLACEMENT_with_crit_path */
-static void initial_setup_NO_PICTURE_to_PLACEMENT_with_crit_path(
-    ezgl::application* app,
-    bool is_new_window) {
-    if (is_new_window)
-        default_setup(app);
-
-    //Showing given functionality
-    crit_path_button_setup(app);
-    /* Routing hasn't been done yet, so hide the display options that show routing
-     * as they don't make sense and would crash if clicked on */
-    hide_crit_path_routing(app, true);
-    //Hiding unused routing menu
-    hide_widget("RoutingMenuButton", app);
-}
+        draw_state->save_graphics_file_base = "vpr_placement";
 
-/* function below initializes the interface window with a set of buttons and links
- * signals to corresponding functions for situation where the window is opened from
- * PLACEMENT_to_ROUTING */
-static void initial_setup_PLACEMENT_to_ROUTING(ezgl::application* app,
-                                               bool is_new_window) {
-    if (is_new_window)
-        default_setup(app);
-
-    routing_button_setup(app);
-    crit_path_button_setup(app);
-    hide_crit_path_routing(app, false);
-}
+    } else if (draw_state->pic_on_screen == ROUTING) {
+        show_widget("RoutingMenuButton", app);
 
-/* function below initializes the interface window with a set of buttons and links
- * signals to corresponding functions for situation where the window is opened from
- * ROUTING_to_PLACEMENT */
-static void initial_setup_ROUTING_to_PLACEMENT(ezgl::application* app,
-                                               bool is_new_window) {
-    if (is_new_window)
-        default_setup(app);
-
-    //Hiding unused functionality
-    hide_widget("RoutingMenuButton", app);
-    crit_path_button_setup(app);
-    hide_crit_path_routing(app, false);
-}
+        draw_state->save_graphics_file_base = "vpr_routing";
 
-/* function below initializes the interface window with a set of buttons and links
- * signals to corresponding functions for situation where the window is opened from
- * NO_PICTURE_to_ROUTING */
-static void initial_setup_NO_PICTURE_to_ROUTING(ezgl::application* app,
-                                                bool is_new_window) {
-    if (is_new_window)
-        default_setup(app);
-
-    routing_button_setup(app);
-    crit_path_button_setup(app);
-    hide_crit_path_routing(app, false);
-}
+    }
+    
+    // show/hide critical path routing UI elements
+    hide_crit_path_routing(app);
 
-/* function below initializes the interface window with a set of buttons and links
- * signals to corresponding functions for situation where the window is opened from
- * NO_PICTURE_to_ROUTING_with_crit_path */
-static void initial_setup_NO_PICTURE_to_ROUTING_with_crit_path(
-    ezgl::application* app,
-    bool is_new_window) {
-    if (is_new_window)
-        default_setup(app);
-
-    routing_button_setup(app);
-    crit_path_button_setup(app);
-    hide_crit_path_routing(app, false);
+    hide_draw_routing(app);
 }
+
 #endif //NO_GRAPHICS
 
 void update_screen(ScreenUpdatePriority priority, const char* msg, enum pic_type pic_on_screen_val, std::shared_ptr<const SetupTimingInfo> setup_timing_info) {
@@ -378,49 +302,14 @@ void update_screen(ScreenUpdatePriority priority, const char* msg, enum pic_type
     if (draw_state->pic_on_screen != pic_on_screen_val) { //State changed
 
         if (draw_state->pic_on_screen == NO_PICTURE) {
-            //Only add the canvas the first time we open graphics
+            // Only add the canvas the first time we open graphics
             application.add_canvas("MainCanvas", draw_main_canvas,
                                    initial_world);
         }
 
         draw_state->setup_timing_info = setup_timing_info;
-
-        if (pic_on_screen_val == PLACEMENT
-            && draw_state->pic_on_screen == NO_PICTURE) {
-            if (setup_timing_info) {
-                init_setup = initial_setup_NO_PICTURE_to_PLACEMENT_with_crit_path;
-            } else {
-                init_setup = initial_setup_NO_PICTURE_to_PLACEMENT;
-            }
-            draw_state->save_graphics_file_base = "vpr_placement";
-
-        } else if (pic_on_screen_val == ROUTING
-                   && draw_state->pic_on_screen == PLACEMENT) {
-            //Routing, opening after placement
-            init_setup = initial_setup_PLACEMENT_to_ROUTING;
-            draw_state->save_graphics_file_base = "vpr_routing";
-
-        } else if (pic_on_screen_val == PLACEMENT
-                   && draw_state->pic_on_screen == ROUTING) {
-            init_setup = initial_setup_ROUTING_to_PLACEMENT;
-            draw_state->save_graphics_file_base = "vpr_placement";
-
-        } else if (pic_on_screen_val == ROUTING
-                   && draw_state->pic_on_screen == NO_PICTURE) {
-            //Routing opening first
-            if (setup_timing_info) {
-                init_setup = initial_setup_NO_PICTURE_to_ROUTING_with_crit_path;
-            } else {
-                init_setup = initial_setup_NO_PICTURE_to_ROUTING;
-            }
-            draw_state->save_graphics_file_base = "vpr_routing";
-        }
-
         draw_state->pic_on_screen = pic_on_screen_val;
-
-    } else {
-        //No change (e.g. paused)
-        init_setup = nullptr;
+        init_setup = on_stage_change_setup;
     }
 
     bool state_change = (init_setup != nullptr);
diff --git a/vpr/src/draw/draw_basic.cpp b/vpr/src/draw/draw_basic.cpp
@@ -1241,6 +1241,7 @@ void draw_routed_timing_edge_connection(tatum::NodeId src_tnode,
 
             for (RRNodeId inode : routed_rr_nodes) {
                 draw_state->draw_rr_node[inode].color = color;
+                draw_state->draw_rr_node[inode].node_highlighted = true;
             }
 
             //draw_partial_route() takes care of layer visibility and cross-layer settings
diff --git a/vpr/src/draw/ui_setup.cpp b/vpr/src/draw/ui_setup.cpp
@@ -18,6 +18,7 @@
 #include "save_graphics.h"
 #include "search_bar.h"
 #include "ui_setup.h"
+#include "gtkcomboboxhelper.h"
 
 #include "ezgl/application.hpp"
 
@@ -65,7 +66,7 @@ void net_button_setup(ezgl::application* app) {
     GtkSwitch* toggle_nets_switch = GTK_SWITCH(app->get_object("ToggleNets"));
     g_signal_connect(toggle_nets_switch, "state-set", G_CALLBACK(toggle_show_nets_cbk), app);
 
-    //Toggle net signal connection
+    // Manages net type
     GtkComboBoxText* toggle_nets = GTK_COMBO_BOX_TEXT(app->get_object("ToggleNetType"));
     g_signal_connect(toggle_nets, "changed", G_CALLBACK(toggle_draw_nets_cbk), app);
 
@@ -261,16 +262,43 @@ void crit_path_button_setup(ezgl::application* app) {
  *
  * @param app ezgl app
  */
-void hide_crit_path_routing(ezgl::application* app, bool hide) {
+void hide_crit_path_routing(ezgl::application* app) {
     GtkComboBoxText* toggle_crit_path = GTK_COMBO_BOX_TEXT(app->get_object("ToggleCritPath"));
-    if (hide) {
-        gtk_combo_box_text_remove(toggle_crit_path, 4);
-        gtk_combo_box_text_remove(toggle_crit_path, 3);
+    t_draw_state* draw_state = get_draw_state_vars();
+
+    int crit_path_item_index = get_item_index_by_text(toggle_crit_path, "Crit Path Routing");
+
+    // Enable the option to show critical path only when timing info is available
+    if (!draw_state->setup_timing_info || draw_state->pic_on_screen != ROUTING) {
+        if(crit_path_item_index != -1) {
+            gtk_combo_box_text_remove(toggle_crit_path, crit_path_item_index);
+            gtk_combo_box_text_remove(toggle_crit_path, crit_path_item_index + 1);
+        }
     } else {
-        gtk_combo_box_text_insert_text(toggle_crit_path, 3, "Crit Path Routing");
-        gtk_combo_box_text_insert_text(toggle_crit_path, 4, "Crit Path Routing Delays");
+        if(crit_path_item_index == -1){
+            gtk_combo_box_text_insert_text(toggle_crit_path, 3, "Crit Path Routing");
+            gtk_combo_box_text_insert_text(toggle_crit_path, 4, "Crit Path Routing Delays");
+        }        
     }
 }
+
+void hide_draw_routing(ezgl::application* app) {
+    t_draw_state* draw_state = get_draw_state_vars();
+    GtkComboBoxText* toggle_nets = GTK_COMBO_BOX_TEXT(app->get_object("ToggleNetType"));
+    
+    // Enable the option to draw routing only during the routing stage
+    int route_item_index = get_item_index_by_text(toggle_nets, "Routing");
+    if(draw_state->pic_on_screen == PLACEMENT){
+        if (route_item_index != -1) {
+            gtk_combo_box_text_remove(toggle_nets, route_item_index);
+        }
+    } else {
+        if(route_item_index == -1){
+            gtk_combo_box_text_append(toggle_nets, "2", "Routing");
+        }
+    }
+}
+
 /*
  * @brief Hides the widget with the given name
  *
diff --git a/vpr/src/draw/ui_setup.h b/vpr/src/draw/ui_setup.h
@@ -73,7 +73,12 @@ void crit_path_button_setup(ezgl::application* app);
  * @brief Hides or displays Critical Path routing / routing delay UI elements,
  * Use to ensure we don't show inactive buttons etc. when routing data doesn't exist
  */
-void hide_crit_path_routing(ezgl::application* app, bool hide);
+void hide_crit_path_routing(ezgl::application* app);
+
+/**
+ * @brief Hides the option to draw routing when in placement stage, and shows it in routing stage.
+ */
+void hide_draw_routing(ezgl::application* app);
 
 /**
  * @brief Loads block names into Gtk Structures to enable autocomplete

Original file line number	Diff line number	Diff line change
`@@ -1241,6 +1241,7 @@ void draw_routed_timing_edge_connection(tatum::NodeId src_tnode,`
`1241`	`1241`
`1242`	`1242`	`for (RRNodeId inode : routed_rr_nodes) {`
`1243`	`1243`	`draw_state->draw_rr_node[inode].color = color;`
	`1244`	`+ draw_state->draw_rr_node[inode].node_highlighted = true;`
`1244`	`1245`	`}`
`1245`	`1246`
`1246`	`1247`	`//draw_partial_route() takes care of layer visibility and cross-layer settings`