Add:Gui/Internal: Allowing visual debugging on boxes and tables (#715)

* Adding visual debugging to internal GUI

* Fixing style to comply to ci_sanity_checks

* Allowing to enable GUI_INTERNAL_VISUAL_DBG from cmake variable

* Disabling GUI_INTERNAL_VISUAL_DBG by default, needs to be enabled using -DGUI_INTERNAL_VISUAL_DBG=TRUE arg on cmake

2 files changed, 74 insertions, 8 deletions

diff --git a/navit/gui/internal/CMakeLists.txt b/navit/gui/internal/CMakeLists.txt
index b758ba7e6..27011bab3 100644
--- a/navit/gui/internal/CMakeLists.txt
+++ b/navit/gui/internal/CMakeLists.txt
@@ -1,3 +1,7 @@
+if (GUI_INTERNAL_VISUAL_DBG)
+	add_definitions ("-DGUI_INTERNAL_VISUAL_DBG")
+endif(GUI_INTERNAL_VISUAL_DBG)
+
 module_add_library(gui_internal gui_internal.c gui_internal_bookmark.c gui_internal_command.c gui_internal_gesture.c
                    gui_internal_html.c gui_internal_menu.c gui_internal_poi.c gui_internal_search.c gui_internal_widget.c
                    gui_internal_keyboard.c)
diff --git a/navit/gui/internal/gui_internal_widget.c b/navit/gui/internal/gui_internal_widget.c
index 0894be5aa..3b979f011 100644
--- a/navit/gui/internal/gui_internal_widget.c
+++ b/navit/gui/internal/gui_internal_widget.c
@@ -358,13 +358,37 @@ gui_internal_box_new(struct gui_priv *this, enum flags flags) {
     return gui_internal_box_new_with_label(this, flags, NULL);
 }
 
-
+/**
+ * @brief Renders a box widget, preparing it for drawing on the display
+ *
+ * @param this The internal GUI instance
+ * @param w The box widget to render
+ */
 static void gui_internal_box_render(struct gui_priv *this, struct widget *w) {
     struct widget *wc;
     GList *l;
 
+    int visual_debug = 0;
+
+#if defined(GUI_INTERNAL_VISUAL_DBG)
+    static struct graphics_gc *debug_gc=NULL;
+    static struct color gui_box_debug_color= {0xffff,0x0400,0x0400,0xffff}; /* Red */
+    visual_debug = (debug_level_get("gui_internal_visual_layout") >= lvl_debug);
+#endif
+
+    if (visual_debug)
+        dbg(lvl_debug, "Internal layout visual debugging is enabled");
+
+#if defined(GUI_INTERNAL_VISUAL_DBG)
+    if (visual_debug && !debug_gc) {
+        debug_gc = graphics_gc_new(this->gra);
+        graphics_gc_set_foreground(debug_gc, &gui_box_debug_color);
+        graphics_gc_set_linewidth(debug_gc, 1);
+    }
+#endif
+
     gui_internal_background_render(this, w);
-    if (w->foreground && w->border) {
+    if ((w->foreground && w->border) || visual_debug) {
         struct point pnt[5];
         pnt[0]=w->p;
         pnt[1].x=pnt[0].x+w->w;
@@ -374,9 +398,15 @@ static void gui_internal_box_render(struct gui_priv *this, struct widget *w) {
         pnt[3].x=pnt[0].x;
         pnt[3].y=pnt[0].y+w->h;
         pnt[4]=pnt[0];
-        graphics_gc_set_linewidth(w->foreground, w->border ? w->border : 1);
-        graphics_draw_lines(this->gra, w->foreground, pnt, 5);
-        graphics_gc_set_linewidth(w->foreground, 1);
+        if (!visual_debug) {
+            graphics_gc_set_linewidth(w->foreground, w->border ? w->border : 1);
+            graphics_draw_lines(this->gra, w->foreground, pnt, 5);
+            graphics_gc_set_linewidth(w->foreground, 1);
+        }
+#if defined(GUI_INTERNAL_VISUAL_DBG)
+        else
+            graphics_draw_lines(this->gra, debug_gc, pnt, 5);	/* Force highlighting box borders in debug more */
+#endif
     }
 
     l=w->children;
@@ -1247,10 +1277,10 @@ void gui_internal_table_hide_rows(struct table_data * table_data) {
 
 
 /**
- * @brief Renders a table widget.
+ * @brief Renders a table widget, preparing it for drawing on the display
  *
- * @param this The graphics context
- * @param w The table widget to render.
+ * @param this The internal GUI instance
+ * @param w The widget to render
  */
 void gui_internal_table_render(struct gui_priv * this, struct widget * w) {
 
@@ -1347,9 +1377,41 @@ void gui_internal_table_render(struct gui_priv * this, struct widget * w) {
                 } else {
                     cur_widget->state &= ~STATE_OFFSCREEN;
                 }
+
+#if defined(GUI_INTERNAL_VISUAL_DBG)
+
+                static struct graphics_gc *debug_gc=NULL;
+                static struct color gui_table_debug_color= {0x0000,0xffff,0x0400,0xffff}; /* Green */
+                int visual_debug = (debug_level_get("gui_internal_visual_layout") >= lvl_debug);
+
+                if (visual_debug)
+                    dbg(lvl_debug, "Internal layout visual debugging is enabled");
+
+                if (visual_debug && !debug_gc) {
+                    debug_gc = graphics_gc_new(this->gra);
+                    graphics_gc_set_foreground(debug_gc, &gui_table_debug_color);
+                    graphics_gc_set_linewidth(debug_gc, 1);
+                }
+#endif
+
                 gui_internal_widget_pack(this,cur_widget);
                 gui_internal_widget_render(this,cur_widget);
 
+#if defined(GUI_INTERNAL_VISUAL_DBG)
+                if (visual_debug) {
+                    struct point pnt[5];
+                    pnt[0]=cur_widget->p;
+                    pnt[1].x=pnt[0].x+cur_widget->w;
+                    pnt[1].y=pnt[0].y;
+                    pnt[2].x=pnt[0].x+cur_widget->w;
+                    pnt[2].y=pnt[0].y+cur_widget->h;
+                    pnt[3].x=pnt[0].x;
+                    pnt[3].y=pnt[0].y+cur_widget->h;
+                    pnt[4]=pnt[0];
+                    graphics_draw_lines(this->gra, debug_gc, pnt, 5);	/* Force highlighting table borders in debug more */
+                }
+#endif
+
                 if(dim->height > max_height) {
                     max_height = dim->height;
                 }