lttv/modules/gui/histogram/histodrawitem.c

   1 /* This file is part of the Linux Trace Toolkit viewer
   2  * Copyright (C) 2003-2004 Mathieu Desnoyers
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License Version 2 as
   6  * published by the Free Software Foundation;
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  16  * MA 02111-1307, USA.
  17  */
  18
  19
  20
  21 /******************************************************************************
  22  * drawitem.c
  23  *
  24  * This file contains methods responsible for drawing a generic type of data
  25  * in a drawable. Doing this generically will permit user defined drawing
  26  * behavior in a later time.
  27  *
  28  * This file provides an API which is meant to be reusable for all viewers that
  29  * need to show information in line, icon, text, background or point form in
  30  * a drawable area having time for x axis. The y axis, in the control flow
  31  * viewer case, is corresponding to the different processes, but it can be
  32  * reused integrally for cpu, and eventually locks, buffers, network
  33  * interfaces... What will differ between the viewers is the precise
  34  * information which interests us. We may think that the most useful
  35  * information for control flow are some specific events, like schedule
  36  * change, and processes'states. It may differ for a cpu viewer : the
  37  * interesting information could be more the execution mode of each cpu.
  38  * This API in meant to make viewer's writers life easier : it will become
  39  * a simple choice of icons and line types for the precise information
  40  * the viewer has to provide (agremented with keeping supplementary records
  41  * and modifying slightly the DrawContext to suit the needs.)
  42  *
  43  * We keep each data type in attributes, keys to specific information
  44  * being formed from the GQuark corresponding to the information received.
  45  * (facilities / facility_name / events / eventname.)
  46  * (cpus/cpu_name, process_states/ps_name,
  47  * execution_modes/em_name, execution_submodes/es_name).
  48  * The goal is then to provide a generic way to print information on the
  49  * screen for all this different information.
  50  *
  51  * Information can be printed as
  52  *
  53  * - text (text + color + size + position (over or under line)
  54  * - icon (icon filename, corresponding to a loaded icon, accessible through
  55  *   a GQuark. Icons are loaded statically at the guiControlFlow level during
  56  *   module initialization and can be added on the fly if not present in the
  57  *   GQuark.) The habitual place for xpm icons is in
  58  *   ${prefix}/share/LinuxTraceToolkit.) + position (over or under line)
  59  * - line (color, width, style)
  60  * - Arc (big points) (color, size)
  61  * - background color (color)
  62  *
  63  * An item is a leaf of the attributes tree. It is, in that case, including
  64  * all kind of events categories we can have. It then associates each category
  65  * with one or more actions (drawing something) or nothing.
  66  *
  67  * Each item has an array of hooks (hook list). Each hook represents an
  68  * operation to perform. We seek the array each time we want to
  69  * draw an item. We execute each operation in order. An operation type
  70  * is associated with each hook to permit user listing and modification
  71  * of these operations. The operation type is also used to find the
  72  * corresponding priority for the sorting. Operation type and priorities
  73  * are enum and a static int table.
  74  *
  75  * The array has to be sorted by priority each time we add a task in it.
  76  * A priority is associated with each operation type. It permits
  77  * to perform background color selection before line or text drawing. We also
  78  * draw lines before text, so the text appears over the lines.
  79  *
  80  * Executing all the arrays of operations for a specific event (which
  81  * implies information for state, event, cpu, execution mode and submode)
  82  * has to be done in a same DrawContext. The goal there is to keep the offset
  83  * of the text and icons over and under the middle line, so a specific
  84  * event could be printed as (  R Si 0 for running, scheduled in, cpu 0  ),
  85  * text being easy to replace with icons. The DrawContext is passed as
  86  * call_data for the operation hooks.
  87  *
  88  * We use the lttv global attributes to keep track of the loaded icons.
  89  * If we need an icon, we look for it in the icons / icon name pathname.
  90  * If found, we use the pointer to it. If not, we load the pixmap in
  91  * memory and set the pointer to the GdkPixmap in the attributes. The
  92  * structure pointed to contains the pixmap and the mask bitmap.
  93  *
  94  * Author : Mathieu Desnoyers, October 2003
  95  */
  96
  97 #ifdef HAVE_CONFIG_H
  98 #include <config.h>
  99 #endif
 100
 101 #include <glib.h>
 102 #include <gtk/gtk.h>
 103 #include <gdk/gdk.h>
 104 #include <lttv/hook.h>
 105 #include <lttv/attribute.h>
 106 #include <lttv/iattribute.h>
 107 #include <string.h>
 108
 109 #include <lttv/state.h>
 110 #include <lttv/lttv.h>
 111
 112 #include "histodrawitem.h"
 113 #include "histodrawing.h"
 114
 115
 116 #define MAX_PATH_LEN 256
 117
 118 /* drawing hook functions */
 119 gboolean histo_draw_text( void *hook_data, void *call_data)
 120 {
 121   histo_PropertiesText *properties = (histo_PropertiesText*)hook_data;
 122   histo_DrawContext *draw_context = (histo_DrawContext*)call_data;
 123
 124   PangoContext *context;
 125   PangoLayout *layout;
 126   PangoFontDescription *font_desc;// = pango_font_description_new();
 127   PangoRectangle ink_rect;
 128
 129   layout = draw_context->pango_layout;
 130
 131   context = pango_layout_get_context(layout);
 132   font_desc = pango_context_get_font_description(context);
 133
 134   pango_font_description_set_size(font_desc, properties->size*PANGO_SCALE);
 135   pango_layout_context_changed(layout);
 136
 137   pango_layout_set_text(layout, properties->text, -1);
 138   pango_layout_get_pixel_extents(layout, &ink_rect, NULL);
 139
 140   gint x=0, y=0;
 141   gint *offset=NULL;
 142   gboolean enough_space = FALSE;
 143   gint width = ink_rect.width;
 144
 145   switch(properties->histo_position.x) {
 146     case POS_START:
 147       x = draw_context->histo_drawinfo.start.x;
 148       switch(properties->histo_position.y) {
 149         case OVER:
 150           offset = &draw_context->histo_drawinfo.start.offset.over;
 151           x += draw_context->histo_drawinfo.start.offset.over;
 152           y = draw_context->histo_drawinfo.y.over;
 153           break;
 154         case MIDDLE:
 155           offset = &draw_context->histo_drawinfo.start.offset.middle;
 156           x += draw_context->histo_drawinfo.start.offset.middle;
 157           y = draw_context->histo_drawinfo.y.middle;
 158           break;
 159         case UNDER:
 160           offset = &draw_context->histo_drawinfo.start.offset.under;
 161           x += draw_context->histo_drawinfo.start.offset.under;
 162           y = draw_context->histo_drawinfo.y.under;
 163           break;
 164       }
 165       /* verify if there is enough space to draw */
 166       if(unlikely(x + width <= draw_context->histo_drawinfo.end.x)) {
 167         enough_space = TRUE;
 168         *offset += width;
 169       }
 170       break;
 171     case POS_END:
 172       x = draw_context->histo_drawinfo.end.x;
 173       switch(properties->histo_position.y) {
 174         case OVER:
 175           offset = &draw_context->histo_drawinfo.end.offset.over;
 176           x += draw_context->histo_drawinfo.end.offset.over;
 177           y = draw_context->histo_drawinfo.y.over;
 178           break;
 179         case MIDDLE:
 180           offset = &draw_context->histo_drawinfo.end.offset.middle;
 181           x += draw_context->histo_drawinfo.end.offset.middle;
 182           y = draw_context->histo_drawinfo.y.middle;
 183           break;
 184         case UNDER:
 185           offset = &draw_context->histo_drawinfo.end.offset.under;
 186           x += draw_context->histo_drawinfo.end.offset.under;
 187           y = draw_context->histo_drawinfo.y.under;
 188           break;
 189       }
 190       /* verify if there is enough space to draw */
 191       if(unlikely(x - width >= draw_context->histo_drawinfo.start.x)) {
 192         enough_space = TRUE;
 193         *offset -= width;
 194       }
 195       break;
 196   }
 197
 198   if(unlikely(enough_space))
 199     gdk_draw_layout_with_colors(draw_context->drawable,
 200               draw_context->gc,
 201               x,
 202               y,
 203               layout, properties->foreground, properties->background);
 204
 205   return 0;
 206 }
 207
 208
 209 /* To speed up the process, search in already loaded icons list first. Only
 210  * load it if not present.
 211  */
 212 gboolean histo_draw_icon( void *hook_data, void *call_data)
 213 {
 214   histo_PropertiesIcon *properties = (histo_PropertiesIcon*)hook_data;
 215   histo_DrawContext *draw_context = (histo_DrawContext*)call_data;
 216   gboolean retval;
 217
 218   LttvIAttribute *attributes = LTTV_IATTRIBUTE(lttv_global_attributes());
 219   LttvAttributeValue value;
 220   gchar icon_name[MAX_PATH_LEN] = "icons/";
 221   histo_IconStruct *icon_info;
 222
 223   strcat(icon_name, properties->icon_name);
 224
 225   retval= lttv_iattribute_find_by_path(attributes, icon_name,
 226       LTTV_POINTER, &value);
 227   g_assert(retval);
 228   if(unlikely(*(value.v_pointer) == NULL))
 229   {
 230     *(value.v_pointer) = icon_info = g_new(histo_IconStruct,1);
 231
 232     icon_info->pixmap = gdk_pixmap_create_from_xpm(draw_context->drawable,
 233                           &icon_info->mask, NULL, properties->icon_name);
 234   }
 235   else
 236   {
 237     icon_info = *(value.v_pointer);
 238   }
 239
 240   gint x=0, y=0;
 241   gint *offset=NULL;
 242   gboolean enough_space = FALSE;
 243   gint width = properties->width;
 244
 245   switch(properties->histo_position.x) {
 246     case POS_START:
 247       x = draw_context->histo_drawinfo.start.x;
 248       switch(properties->histo_position.y) {
 249         case OVER:
 250           offset = &draw_context->histo_drawinfo.start.offset.over;
 251           x += draw_context->histo_drawinfo.start.offset.over;
 252           y = draw_context->histo_drawinfo.y.over;
 253           break;
 254         case MIDDLE:
 255           offset = &draw_context->histo_drawinfo.start.offset.middle;
 256           x += draw_context->histo_drawinfo.start.offset.middle;
 257           y = draw_context->histo_drawinfo.y.middle;
 258           break;
 259         case UNDER:
 260           offset = &draw_context->histo_drawinfo.start.offset.under;
 261           x += draw_context->histo_drawinfo.start.offset.under;
 262           y = draw_context->histo_drawinfo.y.under;
 263           break;
 264       }
 265       /* verify if there is enough space to draw */
 266       if(unlikely(x + width <= draw_context->histo_drawinfo.end.x)) {
 267         enough_space = TRUE;
 268         *offset += width;
 269       }
 270       break;
 271     case POS_END:
 272       x = draw_context->histo_drawinfo.end.x;
 273       switch(properties->histo_position.y) {
 274         case OVER:
 275           offset = &draw_context->histo_drawinfo.end.offset.over;
 276           x += draw_context->histo_drawinfo.end.offset.over;
 277           y = draw_context->histo_drawinfo.y.over;
 278           break;
 279         case MIDDLE:
 280           offset = &draw_context->histo_drawinfo.end.offset.middle;
 281           x += draw_context->histo_drawinfo.end.offset.middle;
 282           y = draw_context->histo_drawinfo.y.middle;
 283           break;
 284         case UNDER:
 285           offset = &draw_context->histo_drawinfo.end.offset.under;
 286           x += draw_context->histo_drawinfo.end.offset.under;
 287           y = draw_context->histo_drawinfo.y.under;
 288           break;
 289       }
 290       /* verify if there is enough space to draw */
 291       if(unlikely(x - width >= draw_context->histo_drawinfo.start.x)) {
 292         enough_space = TRUE;
 293         *offset -= width;
 294       }
 295       break;
 296   }
 297
 298   if(unlikely(enough_space)) {
 299     gdk_gc_set_clip_mask(draw_context->gc, icon_info->mask);
 300
 301     gdk_gc_set_clip_origin(
 302         draw_context->gc,
 303         x,
 304         y);
 305     gdk_draw_drawable(draw_context->drawable,
 306         draw_context->gc,
 307         icon_info->pixmap,
 308         0, 0,
 309         x,
 310         y,
 311         properties->width, properties->height);
 312
 313     gdk_gc_set_clip_origin(draw_context->gc, 0, 0);
 314     gdk_gc_set_clip_mask(draw_context->gc, NULL);
 315   }
 316   return 0;
 317 }
 318
 319 gboolean histo_draw_line( void *hook_data, void *call_data)
 320 {
 321   histo_PropertiesLine *properties = (histo_PropertiesLine*)hook_data;
 322   histo_DrawContext *draw_context = (histo_DrawContext*)call_data;
 323
 324   gdk_gc_set_foreground(draw_context->gc, &properties->color);
 325   //gdk_gc_set_rgb_fg_color(draw_context->gc, &properties->color);
 326   gdk_gc_set_line_attributes( draw_context->gc,
 327                               properties->line_width,
 328                               properties->style,
 329                               GDK_CAP_BUTT,
 330                               GDK_JOIN_MITER);
 331   //g_critical("DRAWING LINE : x1: %i, y1: %i, x2:%i, y2:%i",
 332   //    draw_context->previous->middle->x,
 333   //    draw_context->previous->middle->y,
 334   //    draw_context->drawinfo.middle.x,
 335   //    draw_context->drawinfo.middle.y);
 336
 337   gint x_begin=0, x_end=0, y=0;
 338
 339   x_begin = draw_context->histo_drawinfo.start.x;
 340   x_end = draw_context->histo_drawinfo.end.x;
 341
 342   switch(properties->y) {
 343     case OVER:
 344       y = draw_context->histo_drawinfo.y.over;
 345       break;
 346     case MIDDLE:
 347       y = draw_context->histo_drawinfo.y.middle;
 348       break;
 349     case UNDER:
 350       y = draw_context->histo_drawinfo.y.under;
 351       break;
 352   }
 353
 354   histo_drawing_draw_line(
 355     NULL, draw_context->drawable,
 356     x_begin,
 357     y,
 358     x_end,
 359     y,
 360     draw_context->gc);
 361
 362   return 0;
 363 }
 364
 365 gboolean histo_draw_arc( void *hook_data, void *call_data)
 366 {
 367   histo_PropertiesArc *properties = (histo_PropertiesArc*)hook_data;
 368   histo_DrawContext *draw_context = (histo_DrawContext*)call_data;
 369
 370   gdk_gc_set_foreground(draw_context->gc, properties->color);
 371   //gdk_gc_set_rgb_fg_color(draw_context->gc, properties->color);
 372
 373   gint x=0, y=0;
 374   gint *offset=NULL;
 375   gboolean enough_space = FALSE;
 376   gint width = properties->size;
 377
 378   switch(properties->histo_position.x) {
 379     case POS_START:
 380       x = draw_context->histo_drawinfo.start.x;
 381       switch(properties->histo_position.y) {
 382         case OVER:
 383           offset = &draw_context->histo_drawinfo.start.offset.over;
 384           x += draw_context->histo_drawinfo.start.offset.over;
 385           y = draw_context->histo_drawinfo.y.over;
 386           break;
 387         case MIDDLE:
 388           offset = &draw_context->histo_drawinfo.start.offset.middle;
 389           x += draw_context->histo_drawinfo.start.offset.middle;
 390           y = draw_context->histo_drawinfo.y.middle;
 391           break;
 392         case UNDER:
 393           offset = &draw_context->histo_drawinfo.start.offset.under;
 394           x += draw_context->histo_drawinfo.start.offset.under;
 395           y = draw_context->histo_drawinfo.y.under;
 396           break;
 397       }
 398       /* verify if there is enough space to draw */
 399       if(unlikely(x + width <= draw_context->histo_drawinfo.end.x)) {
 400         enough_space = TRUE;
 401         *offset += width;
 402       }
 403       break;
 404     case POS_END:
 405       x = draw_context->histo_drawinfo.end.x;
 406       switch(properties->histo_position.y) {
 407         case OVER:
 408           offset = &draw_context->histo_drawinfo.end.offset.over;
 409           x += draw_context->histo_drawinfo.end.offset.over;
 410           y = draw_context->histo_drawinfo.y.over;
 411           break;
 412         case MIDDLE:
 413           offset = &draw_context->histo_drawinfo.end.offset.middle;
 414           x += draw_context->histo_drawinfo.end.offset.middle;
 415           y = draw_context->histo_drawinfo.y.middle;
 416           break;
 417         case UNDER:
 418           offset = &draw_context->histo_drawinfo.end.offset.under;
 419           x += draw_context->histo_drawinfo.end.offset.under;
 420           y = draw_context->histo_drawinfo.y.under;
 421           break;
 422       }
 423       /* verify if there is enough space to draw */
 424       if(unlikely(x - width >= draw_context->histo_drawinfo.start.x)) {
 425         enough_space = TRUE;
 426         *offset -= width;
 427       }
 428       break;
 429   }
 430
 431   if(unlikely(enough_space))
 432     gdk_draw_arc(draw_context->drawable, draw_context->gc,
 433           properties->filled,
 434           x,
 435           y,
 436           properties->size, properties->size, 0, 360*64);
 437
 438   return 0;
 439 }
 440
 441 gboolean histo_draw_bg( void *hook_data, void *call_data)
 442 {
 443   histo_PropertiesBG *properties = (histo_PropertiesBG*)hook_data;
 444   histo_DrawContext *draw_context = (histo_DrawContext*)call_data;
 445
 446   gdk_gc_set_foreground(draw_context->gc, properties->color);
 447   //gdk_gc_set_rgb_fg_color(draw_context->gc, properties->color);
 448
 449   //g_critical("DRAWING RECT : x: %i, y: %i, w:%i, h:%i, val1 :%i, val2:%i ",
 450   //    draw_context->previous->over->x,
 451   //    draw_context->previous->over->y,
 452   //    draw_context->drawinfo.over.x - draw_context->previous->over->x,
 453   //    draw_context->previous->under->y-draw_context->previous->over->y,
 454   //    draw_context->drawinfo.over.x,
 455   //    draw_context->previous->over->x);
 456   gdk_draw_rectangle(draw_context->drawable, draw_context->gc,
 457           TRUE,
 458           draw_context->histo_drawinfo.start.x,
 459           draw_context->histo_drawinfo.y.over,
 460           draw_context->histo_drawinfo.end.x - draw_context->histo_drawinfo.start.x,
 461           draw_context->histo_drawinfo.y.under - draw_context->histo_drawinfo.y.over);
 462
 463   return 0;
 464 }
 465
 466