Merge pull request #1845 from verilog-to-routing/update_libezgl_external_subtree

Update libezgl external subtree

Author: vaughnbetz

libs/EXTERNAL/libezgl/examples/basic-application/basic_application.cpp

@@ -392,7 +392,7 @@ void draw_line_example(ezgl::renderer *g)
   {
     double offsetY = 50*i;
 
-    g->set_horiz_text_just(ezgl::text_just::left);
+    g->set_horiz_justification(ezgl::justification::left);
 
     if (i == 0) {
       g->set_color(ezgl::BLACK);
@@ -415,7 +415,7 @@ void draw_line_example(ezgl::renderer *g)
       g->draw_text({950, 920+offsetY}, "Butt ends, 67% transparent", 400, DBL_MAX);
     }
 
-    g->set_horiz_text_just(ezgl::text_just::center);
+    g->set_horiz_justification(ezgl::justification::center);
 
     g->draw_text({200, 900+offsetY}, "Thin line (width 1)", 200, DBL_MAX);
     g->set_line_width(1);

libs/EXTERNAL/libezgl/examples/basic-application/main.ui

@@ -31,7 +31,7 @@
             <child>
               <object class="GtkButton" id="UpButton">
                 <property name="visible">True</property>
-                <property name="can_focus">True</property>
+                <property name="can_focus">False</property>
                 <property name="receives_default">True</property>
                 <child>
                   <object class="GtkArrow" id="UpArrow">
@@ -49,7 +49,7 @@
             <child>
               <object class="GtkButton" id="DownButton">
                 <property name="visible">True</property>
-                <property name="can_focus">True</property>
+                <property name="can_focus">False</property>
                 <property name="receives_default">True</property>
                 <child>
                   <object class="GtkArrow" id="DownArrow">
@@ -67,7 +67,7 @@
             <child>
               <object class="GtkButton" id="LeftButton">
                 <property name="visible">True</property>
-                <property name="can_focus">True</property>
+                <property name="can_focus">False</property>
                 <property name="receives_default">True</property>
                 <child>
                   <object class="GtkArrow" id="LeftArrow">
@@ -85,7 +85,7 @@
             <child>
               <object class="GtkButton" id="RightButton">
                 <property name="visible">True</property>
-                <property name="can_focus">True</property>
+                <property name="can_focus">False</property>
                 <property name="receives_default">True</property>
                 <child>
                   <object class="GtkArrow" id="RightArrow">
@@ -103,7 +103,7 @@
               <object class="GtkButton" id="ZoomInButton">
                 <property name="label" translatable="yes">Zoom In</property>
                 <property name="visible">True</property>
-                <property name="can_focus">True</property>
+                <property name="can_focus">False</property>
                 <property name="receives_default">True</property>
               </object>
               <packing>
@@ -116,7 +116,7 @@
               <object class="GtkButton" id="ZoomOutButton">
                 <property name="label" translatable="yes">Zoom Out</property>
                 <property name="visible">True</property>
-                <property name="can_focus">True</property>
+                <property name="can_focus">False</property>
                 <property name="receives_default">True</property>
               </object>
               <packing>
@@ -129,7 +129,7 @@
               <object class="GtkButton" id="ZoomFitButton">
                 <property name="label" translatable="yes">Zoom Fit</property>
                 <property name="visible">True</property>
-                <property name="can_focus">True</property>
+                <property name="can_focus">False</property>
                 <property name="receives_default">True</property>
               </object>
               <packing>
@@ -142,7 +142,7 @@
               <object class="GtkButton" id="ProceedButton">
                 <property name="label" translatable="yes">Proceed</property>
                 <property name="visible">True</property>
-                <property name="can_focus">True</property>
+                <property name="can_focus">False</property>
                 <property name="receives_default">True</property>
               </object>
               <packing>

libs/EXTERNAL/libezgl/include/ezgl/application.hpp

@@ -28,6 +28,7 @@
 #include <map>
 #include <memory>
 #include <string>
+#include <ctime>
 
 #include <gtk/gtk.h>
 
@@ -36,6 +37,13 @@
  */
 namespace ezgl {
 
+// A flag to specify whether the GUI is built from an XML file or an XML resource
+#ifndef ECE297
+const bool build_ui_from_file = false;
+#else
+const bool build_ui_from_file = true;
+#endif
+
 class application;
 
 /**
@@ -81,7 +89,7 @@ class application {
    */
   struct settings {
     /**
-     * The resource path that contains the XML file, which describes the GUI.
+     * The resource/file path that contains the XML file, which describes the GUI.
      */
     std::string main_ui_resource;
 
@@ -121,9 +129,13 @@ class application {
      * Create the settings structure with default values
      */
     settings()
-    : main_ui_resource("/ezgl/main.ui"), window_identifier("MainWindow"), canvas_identifier("MainCanvas"), application_identifier("ezgl.app"),
+    : main_ui_resource(build_ui_from_file ? "main_ui" : "/ezgl/main.ui"), window_identifier("MainWindow"), canvas_identifier("MainCanvas"), application_identifier("ezgl.app"),
       setup_callbacks(nullptr)
     {
+      // Uniquify the application_identifier by appending a time stamp,
+      // so that each instance of the same program has a different application ID.
+      // This allows multiple instance of the program to run independelty.
+      application_identifier += ".t" + std::to_string(std::time(nullptr));
     }
 
     /**
@@ -134,6 +146,10 @@ class application {
     : main_ui_resource(m_resource), window_identifier(w_identifier), canvas_identifier(c_identifier), application_identifier(a_identifier),
       setup_callbacks(s_callbacks)
     {
+      // Uniquify the application_identifier by appending a time stamp,
+      // so that each instance of the same program has a different application ID.
+      // This allows multiple instance of the program to run independelty.
+      application_identifier += ".t" + std::to_string(std::time(nullptr));
     }
   };
 
@@ -403,7 +419,6 @@ class application {
 /**
  * Set the disable_event_loop flag to new_setting
  * Call with new_setting == true to make the event_loop immediately return.
- * Needed only for auto-marking
  *
  * @param new_setting The new state of disable_event_loop flag
  */

libs/EXTERNAL/libezgl/include/ezgl/callback.hpp

@@ -27,6 +27,9 @@
 
 #include <iostream>
 
+// Mouse button used for panning (left button (1) - middle button (2) - right button (3))
+#define PANNING_MOUSE_BUTTON 1
+
 namespace ezgl {
 
 /**** Callback functions for keyboard and mouse input, and for all the ezgl predefined buttons. *****/

libs/EXTERNAL/libezgl/include/ezgl/graphics.hpp

@@ -65,9 +65,9 @@ enum t_coordinate_system {
 };
 
 /**
- * Text justification options
+ * Justification options (used for text and surfaces)
  */
-enum class text_just {
+enum class justification {
   /**
    * Center Justification: used for both vertical and horizontal justification
    */
@@ -279,18 +279,18 @@ class renderer {
   void set_text_rotation(double degrees);
 
   /**
-   * set horizontal text justification.
+   * set horizontal justification (used for text and surfaces).
    *
    * @param horiz_just Options: center, left and right justification.
    */
-  void set_horiz_text_just(text_just horiz_just);
+  void set_horiz_justification(justification horiz_just);
 
   /**
-   * set vertical text justification.
+   * set vertical justification (used for text and surfaces).
    *
    * @param vert_just Options: center, top and bottom justification.
    */
-  void set_vert_text_just(text_just vert_just);
+  void set_vert_justification(justification vert_just);
 
   /**** Functions to draw various graphics primitives ****/
 
@@ -425,9 +425,10 @@ class renderer {
    * Draw a surface
    *
    * @param surface The surface to draw
-   * @param top_left The corner point of the drawn surface.
+   * @param anchor_point The anchor_point point of the drawn surface.
+   * @param scale_factor The scaling factor of the drawn surface (optional)
    */
-  void draw_surface(surface *surface, point2d top_left);
+  void draw_surface(surface *p_surface, point2d anchor_point, double scale_factor = 1);
 
   /**
    * load a png image
@@ -516,11 +517,11 @@ class renderer {
   // the rotation angle variable used in rotating text
   double rotation_angle;
 
-  // Current horizontal text justification
-  text_just horiz_text_just = text_just::center;
+  // Current horizontal justification (used for text and surfaces)
+  justification horiz_justification = justification::center;
 
-  // Current vertical text justification
-  text_just vert_text_just = text_just::center;
+  // Current vertical justification (used for text and surfaces)
+  justification vert_justification = justification::center;
 
   // Current line width
   int current_line_width = 1;

libs/EXTERNAL/libezgl/include/ezgl/point.hpp

@@ -26,6 +26,13 @@ namespace ezgl {
  */
 class point2d {
 public:
+  /**
+   * Default constructor: Create a point at (0, 0).
+   */
+  point2d() : x(0.0), y(0.0)
+  {
+  }
+
   /**
    * Create a point at the given x and y position.
    */

libs/EXTERNAL/libezgl/src/application.cpp

@@ -19,7 +19,9 @@
 #include "ezgl/application.hpp"
 
 namespace ezgl {
+
 // A flag to disable event loop (default is false)
+// This allows basic scripted testing even if the GUI is on (return immediately when the event loop is called)
 bool disable_event_loop = false;
 
 void application::startup(GtkApplication *, gpointer user_data)
@@ -29,10 +31,21 @@ void application::startup(GtkApplication *, gpointer user_data)
 
   char const *main_ui_resource = ezgl_app->m_main_ui.c_str();
 
-  // Build the main user interface from the XML resource.
-  GError *error = nullptr;
-  if(gtk_builder_add_from_resource(ezgl_app->m_builder, main_ui_resource, &error) == 0) {
-    g_error("%s.", error->message);
+  if (!build_ui_from_file) {
+    // Build the main user interface from the XML resource.
+    // The XML resource is built from an XML file using the glib-compile-resources tool.
+    // This adds an extra compilation step, but it embeds the UI description in the executable.
+    GError *error = nullptr;
+    if(gtk_builder_add_from_resource(ezgl_app->m_builder, main_ui_resource, &error) == 0) {
+      g_error("%s.", error->message);
+    }
+  }
+  else {
+    // Build the main user interface from the XML file.
+    GError *error = nullptr;
+    if(gtk_builder_add_from_file(ezgl_app->m_builder, main_ui_resource, &error) == 0) {
+      g_error("%s.", error->message);
+    }
   }
 
   for(auto &c_pair : ezgl_app->m_canvases) {
@@ -307,6 +320,11 @@ void application::create_button(const char *button_text,
   // create the new button with the given label
   GtkWidget *new_button = gtk_button_new_with_label(button_text);
 
+  // set can_focus property to false
+#if GTK_CHECK_VERSION (3, 20, 0)
+  gtk_widget_set_focus_on_click(new_button, false);
+#endif
+
   // connect the buttons clicked event to the callback
   if(button_func != NULL) {
     g_signal_connect(G_OBJECT(new_button), "clicked", G_CALLBACK(button_func), this);
@@ -460,4 +478,4 @@ void set_disable_event_loop(bool new_setting)
 {
   disable_event_loop = new_setting;
 }
-}
+}