Finalized code, added NoC button

SebastianLievano · SebastianLievano · commit 89ddeaf53333 · 2022-07-20T19:56:02.000-04:00
diff --git a/vpr/main.ui b/vpr/main.ui
@@ -103,6 +103,35 @@
             <property name="position">5</property>
           </packing>
         </child>
+        <child>
+          <object class="GtkLabel" id="NocLabel">
+            <property name="visible">True</property>
+            <property name="can_focus">False</property>
+            <property name="label" translatable="yes">Toggle NoC Display</property>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">True</property>
+            <property name="position">6</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkComboBoxText" id="ToggleNocBox">
+            <property name="visible">True</property>
+            <property name="can_focus">False</property>
+            <property name="active">0</property>
+            <items>
+              <item translatable="yes">None</item>
+              <item translatable="yes">NoC Links</item>
+              <item translatable="yes">NoC Link Usage</item>
+            </items>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">True</property>
+            <property name="position">7</property>
+          </packing>
+        </child>
         <child>
           <object class="GtkCheckButton" id="blockOutline">
             <property name="label" translatable="yes">Block Outline</property>
@@ -116,7 +145,7 @@
           <packing>
             <property name="expand">False</property>
             <property name="fill">True</property>
-            <property name="position">6</property>
+            <property name="position">8</property>
           </packing>
         </child>
         <child>
@@ -132,7 +161,7 @@
           <packing>
             <property name="expand">False</property>
             <property name="fill">True</property>
-            <property name="position">7</property>
+            <property name="position">9</property>
           </packing>
         </child>
       </object>
diff --git a/vpr/src/draw/buttons.cpp b/vpr/src/draw/buttons.cpp
@@ -28,42 +28,6 @@ gint label_left_start_col = 0;
 gint box_left_start_col = 0;
 gint button_row = 2; // 2 is the row num of the window button in main.ui, add buttons starting from this row
 
-void button_for_displaying_noc() {
-    GObject* main_window = application.get_object(application.get_main_window_id().c_str());
-    GObject* main_window_grid = application.get_object("InnerGrid");
-    t_draw_state* draw_state = get_draw_state_vars();
-
-    // if the user did not turn on the "noc" option then we don't give the option to display the noc to the user
-    if (!draw_state->show_noc_button) {
-        return;
-    }
-
-    // if we are here then the user turned the "noc" option on, so create a button to allow the user to display the noc
-
-    //combo box for toggle_noc_display
-    GtkWidget* toggle_noc_display_widget = gtk_combo_box_text_new();
-    GtkWidget* toggle_noc_display_label = gtk_label_new("Toggle NoC Display:");
-    gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(toggle_noc_display_widget), "None");
-    gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(toggle_noc_display_widget), "NoC Links");
-    gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(toggle_noc_display_widget), "NoC Link Usage");
-
-    gtk_combo_box_set_active((GtkComboBox*)toggle_noc_display_widget, 0); // default set to None which has an index 0
-    gtk_widget_set_name(toggle_noc_display_widget, "toggle_noc_display");
-
-    //attach to the grid
-    gtk_grid_attach((GtkGrid*)main_window_grid, toggle_noc_display_label, label_left_start_col, button_row++, box_width, box_height);
-    gtk_grid_attach((GtkGrid*)main_window_grid, toggle_noc_display_widget, box_left_start_col, button_row++, box_width, box_height);
-
-    // show the newy added check box
-    gtk_widget_show_all((GtkWidget*)main_window);
-
-    //connect signals
-    g_signal_connect_swapped(GTK_COMBO_BOX_TEXT(toggle_noc_display_widget),
-                             "changed",
-                             G_CALLBACK(toggle_noc_display),
-                             toggle_noc_display_widget);
-}
-
 void delete_button(const char* button_name) {
     GObject* main_window_grid = application.get_object("InnerGrid");
     GList* list_of_widgets = gtk_container_get_children(GTK_CONTAINER(main_window_grid));
diff --git a/vpr/src/draw/buttons.h b/vpr/src/draw/buttons.h
@@ -9,8 +9,6 @@
 #    include "ezgl/application.hpp"
 #    include "ezgl/graphics.hpp"
 
-void button_for_displaying_noc();
-
 void delete_button(const char* button_name);
 GtkWidget* find_button(const char* button_name);
 #endif /* NO_GRAPHICS */
diff --git a/vpr/src/draw/draw.cpp b/vpr/src/draw/draw.cpp
@@ -302,7 +302,6 @@ static void initial_setup_NO_PICTURE_to_PLACEMENT(ezgl::application* app,
     //Hiding unused functionality
     hide_widget("RoutingMenuButton", app);
     hide_crit_path_button(app);
-    button_for_displaying_noc();
 }
 
 /* function below intializes the interface window with a set of buttons and links 
@@ -357,7 +356,6 @@ static void initial_setup_NO_PICTURE_to_ROUTING(ezgl::application* app,
     default_setup(app);
     routing_button_setup(app);
     hide_crit_path_button(app);
-    button_for_displaying_noc();
 }
 
 /* function below intializes the interface window with a set of buttons and links 
@@ -680,8 +678,8 @@ void act_on_key_press(ezgl::application* app, GdkEventKey* /*event*/, char* key_
     //VTR_LOG("Key press %c (%d)\n", key_pressed, keysym);
     std::string key(key_name);
     std::cout << "Pressed key" << std::endl;
-    if(gtk_widget_is_focus(GTK_WIDGET(app->get_object("TextInput")))){
-        if(key == "Return"){
+    if (gtk_widget_is_focus(GTK_WIDGET(app->get_object("TextInput")))) {
+        if (key == "Return") {
             enable_autocomplete(app);
         }
     }
@@ -691,8 +689,8 @@ void act_on_key_press(ezgl::application* app, GdkEventKey* /*event*/, char* key_
     std::cout << "Pressed key" << std::endl;
     std::string key(key_name);
     GtkWidget* searchBar = GTK_WIDGET(app->get_object("TextInput"));
-    if(gtk_widget_is_focus(searchBar)){
-        if(key == "Return"){
+    if (gtk_widget_is_focus(searchBar)) {
+        if (key == "Return") {
             std::string oldText(gtk_entry_get_text(GTK_ENTRY(searchBar)));
             enable_autocomplete(app);
             gtk_editable_set_position(GTK_EDITABLE(searchBar), oldText.length());
diff --git a/vpr/src/draw/draw_toggle_functions.cpp b/vpr/src/draw/draw_toggle_functions.cpp
@@ -406,15 +406,19 @@ void toggle_expansion_cost_cbk(GtkComboBoxText* self, ezgl::application* app) {
     app->refresh_drawing();
 }
 
-void toggle_noc_display(GtkWidget* /*widget*/, gint /*response_id*/, gpointer /*data*/) {
+/**
+ * @brief cbk fn to toggle Network-On-Chip (Noc) visibility
+ * alters draw_state->draw_noc to reflect new state
+ * 
+ * @param self ptr to combo box
+ * @param app ezgl application
+ */
+void toggle_noc_cbk(GtkComboBoxText* self, ezgl::application* app) {
     /* this is the callback function for runtime created toggle_noc_display button
      * which is written in button.cpp                                         */
     t_draw_state* draw_state = get_draw_state_vars();
-    std::string button_name = "toggle_noc_display";
-    auto toggle_crit_path = find_button(button_name.c_str());
 
-    gchar* combo_box_content = gtk_combo_box_text_get_active_text(
-        GTK_COMBO_BOX_TEXT(toggle_crit_path));
+    gchar* combo_box_content = gtk_combo_box_text_get_active_text(self);
     if (strcmp(combo_box_content, "None") == 0) {
         draw_state->draw_noc = DRAW_NO_NOC;
     } else if (strcmp(combo_box_content, "NoC Links") == 0)
@@ -423,7 +427,7 @@ void toggle_noc_display(GtkWidget* /*widget*/, gint /*response_id*/, gpointer /*
         draw_state->draw_noc = DRAW_NOC_LINK_USAGE;
 
     g_free(combo_box_content);
-    application.refresh_drawing();
+    app->refresh_drawing();
 }
 
 /**
diff --git a/vpr/src/draw/draw_toggle_functions.h b/vpr/src/draw/draw_toggle_functions.h
@@ -107,11 +107,10 @@ void toggle_crit_path_cbk(GtkComboBoxText* self, ezgl::application* app);
  * Draws different router expansion costs based on user input. Changes value of draw_state->show_router_expansion_cost. */
 void toggle_expansion_cost_cbk(GtkComboBoxText* self, ezgl::application* app);
 
-/* Callback function for runtime created toggle_noc_display 
- * in button.cpp.
+/* Callback function for main.ui created ToggleNocBox in ui_setup.cpp
  * Controls if the NoC on chip should be visualized and whether the link usage
  * in the NoC should be visualized. Changes value of draw_state->draw_noc */
-void toggle_noc_display(GtkWidget* widget, gint /*response_id*/, gpointer /*data*/);
+void toggle_noc_cbk(GtkComboBoxText* self, ezgl::application* app);
 
 /* Callback function for main.ui created netMaxFanout widget in button.cpp.
  * Sets draw_state->draw_net_max_fanout to its corresponding value in the UI. */
diff --git a/vpr/src/draw/search_bar.cpp b/vpr/src/draw/search_bar.cpp
@@ -1,3 +1,18 @@
+/**
+ * @file search_bar.cpp
+ * @author Sebastian Lievano
+ * @brief Contains search/auto-complete related functions
+ * @version 0.1
+ * @date 2022-07-20
+ * 
+ * This file essentially follows the whole search process, from searching, finding the match,
+ * and finally highlighting the searched for item. Additionally, auto-complete related stuff is found
+ * here.
+ * 
+ * @copyright Copyright (c) 2022
+ * 
+ */
+
 #ifndef NO_GRAPHICS
 #    include <cstdio>
 #    include <sstream>
@@ -94,20 +109,25 @@ void search_and_highlight(GtkWidget* /*widget*/, ezgl::application* app) {
     }
 
     else if (search_type == "Block Name") {
+        /* If the block exists in atom netlist, proceeding with highlighting process. 
+         * if highlight atom block fn returns false, that means that the block can't be highlighted
+         * We've already confirmed the block exists in the netlist, so that means that at this zoom lvl,
+         * the subblock is not shown. Therefore highlight the clb mapping.
+         * 
+         * If the block does not exist in the atom netlist, we will check the CLB netlist to see if
+         * they searched for a cluster block*/
         std::string block_name = "";
         ss >> block_name;
 
-        AtomBlockId atom_blk_id = AtomBlockId::INVALID();
-        atom_blk_id = atom_ctx.nlist.find_block(block_name);
-        //If block is found, the CLB containing it is highlighted
+        AtomBlockId atom_blk_id = atom_ctx.nlist.find_block(block_name);
         if (atom_blk_id != AtomBlockId::INVALID()) {
             ClusterBlockId block_id = atom_ctx.lookup.atom_clb(atom_blk_id);
-            //Highlighting atom block. IF function returns false, highlighting clb that contains
             if (!highlight_atom_block(atom_blk_id, block_id, app)) {
                 highlight_cluster_block(block_id);
             }
             return;
         }
+
         //Continues if atom block not found (Checking if user searched a clb)
         ClusterBlockId block_id = ClusterBlockId::INVALID();
         block_id = cluster_ctx.clb_nlist.find_block(block_name);
@@ -134,10 +154,11 @@ void search_and_highlight(GtkWidget* /*widget*/, ezgl::application* app) {
     }
 
     else if (search_type == "Net Name") {
+        //in this case, all nets (clb and non-clb) are contained in the atom netlist
+        //So we only need to search this one
         std::string net_name = "";
         ss >> net_name;
-        AtomNetId atom_net_id = AtomNetId::INVALID();
-        atom_net_id = atom_ctx.nlist.find_net(net_name);
+        AtomNetId atom_net_id = atom_ctx.nlist.find_net(net_name);
 
         if (atom_net_id == AtomNetId::INVALID()) {
             warning_dialog_box("Invalid Net Name");
@@ -314,7 +335,7 @@ bool highlight_atom_block(AtomBlockId atom_blk, ClusterBlockId cl_blk, ezgl::app
  * 
  * @param name name of block being searched for
  * @param pb current node to be examined
- * @return t_pb* t_pb ptr of block w. name "name"
+ * @return t_pb* t_pb ptr of block w. name "name". Returns nullptr if nothing found
  */
 t_pb* find_atom_block_in_pb(std::string name, t_pb* pb) {
     //Checking if block is one being searched for
@@ -350,6 +371,7 @@ void highlight_nets(ClusterNetId net_id) {
 
     t_draw_state* draw_state = get_draw_state_vars();
 
+    //If routing does not exist return
     if (int(route_ctx.trace.size()) == 0) return;
 
     for (tptr = route_ctx.trace[net_id].head; tptr != nullptr; tptr = tptr->next) {
@@ -422,8 +444,8 @@ void search_type_changed(GtkComboBox* self, ezgl::application* app) {
 }
 
 /**
- * @brief A new matching function used for the wildcard search options
- * Will be slower
+ * @brief A non-default matching function. As opposed to simply searching for a prefix(default),
+ * searches string for presence of a substring. Ignores cases.
  * 
  * @param completer the GtkEntryCompletion being used
  * @param key a normalized and case-folded key representing the text
@@ -448,46 +470,76 @@ gboolean customMatchingFunction(
     return (cppText.find(key, 0) != std::string::npos);
 }
 
-void enable_autocomplete(ezgl::application* app){
+/**
+ * @brief Creates a GdkEvent that simulates user pressing key "key"
+ * 
+ * @param key character value
+ * @param window GdkWindow
+ * @return GdkEvent Keypress event
+ */
+GdkEvent simulate_keypress(char key, GdkWindow* window) {
+    int charVal = (int)key;
+    //Creating event and adding properties
+    GdkEvent new_event;
+    new_event.key.type = GDK_KEY_PRESS;
+    new_event.key.window = window;
+    new_event.key.send_event = TRUE;
+    new_event.key.time = GDK_CURRENT_TIME;
+    new_event.key.keyval = gdk_unicode_to_keyval(charVal);
+    new_event.key.state = GDK_KEY_PRESS_MASK;
+    new_event.key.length = 0;
+    new_event.key.string = 0;
+    new_event.key.hardware_keycode = 0;
+    new_event.key.group = 0;
+    return new_event;
+}
+
+/**
+ * @brief Turns on autocomplete
+ * 
+ * This function enables the auto-complete fuctionality for the search bar. 
+ * Normally, this is pretty simple, but the idea is to have auto-complete appear as soon
+ * as the user hits the "Enter" key. To accomplish this, a fake Gdk event is created
+ * to simulate the user hitting a key.
+ * 
+ * @param app ezgl app
+ */
+void enable_autocomplete(ezgl::application* app) {
     std::cout << "enabling autocomplete" << std::endl;
     GtkEntryCompletion* completion = GTK_ENTRY_COMPLETION(app->get_object("Completion"));
     GtkEntry* searchBar = GTK_ENTRY(app->get_object("TextInput"));
+
     std::string searchType = get_search_type(app);
-    if(gtk_entry_completion_get_model(completion) == NULL){
+    //Checking to make sure that we are on a mode that uses auto-complete
+    if (gtk_entry_completion_get_model(completion) == NULL) {
         std::cout << "NO MODEL SELECTED" << std::endl;
         return;
     }
+
+    //Getting input text
     std::string oldText(gtk_entry_get_text(searchBar));
+
+    //Turning on completion
     gtk_entry_set_completion(searchBar, completion);
-    gtk_entry_completion_set_minimum_key_length(completion, std::max(0, (int)(oldText.length()-1)));
     gtk_entry_completion_complete(completion);
 
-    if(oldText.length() == 0) return;
+    //Setting min key length to either 0 or 1 less than key length (max option)
+    gtk_entry_completion_set_minimum_key_length(completion, std::max(0, (int)(oldText.length() - 1)));
 
+    //If string len is 0, reutrning
+    if (oldText.length() == 0) return;
 
-    std::cout << "Added text" << std::endl;
     gtk_widget_grab_focus(GTK_WIDGET(searchBar));
-    std::string newText = (oldText.length() > 1)? oldText.substr(0, oldText.length()-1) : "";
+    std::string newText = (oldText.length() > 1) ? oldText.substr(0, oldText.length() - 1) : "";
     gtk_entry_set_text(searchBar, newText.c_str());
-    // for(int i = 0; i < oldText.length(); ++i){
-
-        GdkEvent new_event;
-        new_event.key.type = GDK_KEY_PRESS;
-        new_event.key.window = gtk_widget_get_parent_window(GTK_WIDGET(searchBar));
-        new_event.key.send_event = TRUE;
-        new_event.key.time = GDK_CURRENT_TIME;
-        new_event.key.keyval = gdk_unicode_to_keyval((int)oldText[oldText.length()-1]);
-        new_event.key.state = GDK_KEY_PRESS_MASK;
-        new_event.key.length = 0;
-        new_event.key.string = 0;
-        new_event.key.hardware_keycode = 0;
-        new_event.key.group = 0;
-        gdk_event_put(&new_event);
-    //}
-}
 
+    //Creating a false event to insert the last character into the string
+    auto window = gtk_widget_get_parent_window(GTK_WIDGET(searchBar));
+    GdkEvent new_event = simulate_keypress(oldText.back(), window);
+    gdk_event_put(&new_event);
+}
 
-std::string get_search_type(ezgl::application* app){
+std::string get_search_type(ezgl::application* app) {
     GObject* combo_box = (GObject*)app->get_object("SearchType");
     gchar* type = gtk_combo_box_text_get_active_text(GTK_COMBO_BOX_TEXT(combo_box));
     //Checking that a type is selected
