Draw_Item .h and .c design complete. Now, needs to be implemented.
[lttv.git] / ltt / branches / poly / lttv / modules / guiControlFlow / Draw_Item.c
index fd6f0cf0eedc929b33720e8106113b065c6e7c39..4ccd30e8760ab74f7fd4d27047d647c97b81e7b6 100644 (file)
@@ -5,6 +5,21 @@
  * in a drawable. Doing this generically will permit user defined drawing
  * behavior in a later time.
  *
+ * This file provides an API which is meant to be reusable for all viewers that
+ * need to show information in line, icon, text, background or point form in
+ * a drawable area having time for x axis. The y axis, in the control flow
+ * viewer case, is corresponding to the different processes, but it can be
+ * reused integrally for cpu, and eventually locks, buffers, network
+ * interfaces... What will differ between the viewers is the precise
+ * information which interests us. We may think that the most useful
+ * information for control flow are some specific events, like schedule
+ * change, and processes'states. It may differ for a cpu viewer : the
+ * interesting information could be more the execution mode of each cpu.
+ * This API in meant to make viewer's writers life easier : it will become
+ * a simple choice of icons and line types for the precise information
+ * the viewer has to provide (agremented with keeping supplementary records
+ * and modifying slightly the DrawContext to suit the needs.)
+ *
  * We keep each data type in attributes, keys to specific information
  * being formed from the GQuark corresponding to the information received.
  * (facilities / facility_name / events / eventname.)
@@ -22,7 +37,7 @@
  *   GQuark.) The habitual place for xpm icons is in
  *   ${prefix}/share/LinuxTraceToolkit.) + position (over or under line)
  * - line (color, width, style)
- * - point (color, size)
+ * - Arc (can be seen as points) (color, size)
  * - background color (color)
  *
  * Each item has an array of hooks (hook list). Each hook represents an
  * text being easy to replace with icons. The DrawContext is passed as
  * call_data for the operation hooks.
  *
+ * We use the lttv global attributes to keep track of the loaded icons.
+ * If we need an icon, we look for it in the icons / icon name pathname.
+ * If found, we use the pointer to it. If not, we load the pixmap in
+ * memory and set the pointer to the GdkPixmap in the attributes.
+ * 
  * Author : Mathieu Desnoyers, October 2003
  */
 
 #include <lttv/attribute.h>
 #include <lttv/iattribute.h>
 
+#include <lttv/processTrace.h>
+#include <lttv/state.h>
+
+/* The DrawContext keeps information about the current drawing position and
+ * the previous one, so we can use both to draw lines.
+ *
+ * over : position for drawing over the middle line.
+ * middle : middle line position.
+ * under : position for drawing under the middle line.
+ */
+struct _DrawContext {
+       GdkDrawable     *drawable;
+       GdkGC           *gc;
+
+       DrawInfo        *Current;
+       DrawInfo        *Previous;
+};
+
+struct _DrawInfo {
+       ItemInfo        *over;
+       ItemInfo        *middle;
+       ItemInfo        *under;
+};
+
+/* LttvExecutionState is accessible through the LttvTracefileState. Is has
+ * a pointer to the LttvProcessState which points to the top of stack
+ * execution state : LttvExecutionState *state.
+ *
+ * LttvExecutionState contains (useful here):
+ * LttvExecutionMode t,
+ * LttvExecutionSubmode n,
+ * LttvProcessStatus s
+ * 
+ *
+ * LttvTraceState will be used in the case we need the string of the
+ * different processes, eventtype_names, syscall_names, trap_names, irq_names.
+ *
+ * LttvTracefileState also gives the cpu_name and, as it herits from
+ * LttvTracefileContext, it gives the LttEvent structure, which is needed
+ * to get facility name and event name.
+ */
+struct _ItemInfo {
+       gint    x, y;
+       LttvTraceState          *ts;
+       LttvTracefileState      *tfs;
+};
+
+
+/*
+ * The Item element is only used so the DrawOperation is modifiable by users.
+ * During drawing, only the Hook is needed.
+ */
+struct _DrawOperation {
+       DrawableItems   Item;
+       LttvHooks       *Hook;
+};
+
+/*
+ * We define here each items that can be drawn, together with their
+ * associated priority. Many item types can have the same priority,
+ * it's only used for quicksorting the operations when we add a new one
+ * to the array of operations to perform. Lower priorities are executed
+ * first. So, for example, we may want to give background color a value
+ * of 10 while a line would have 20, so the background color, which
+ * is in fact a rectangle, does not hide the line.
+ */
+
+typedef enum _DrawableItems {
+       ITEM_TEXT, ITEM_ICON, ITEM_LINE, ITEM_POINT, ITEM_BACKGROUND
+} DrawableItems;
+
+static gchar * Items_Priorities = {
+       50,     /* ITEM_TEXT */
+       40,     /* ITEM_ICON */
+       20,     /* ITEM_LINE */
+       30,     /* ITEM_POINT */
+       10      /* ITEM_BACKGROUND */
+};
+
+typedef enum _RelPos {
+       OVER, MIDDLE, UNDER
+} RelPos;
+
+/*
+ * Here are the different structures describing each item type that can be
+ * drawn. They contain the information necessary to draw the item : not the
+ * position (this is provided by the DrawContext), but the text, icon name,
+ * line width, color; all the properties of the specific items.
+ */
+
+struct _PropertiesText {
+       GdkColor        *foreground;
+       GdkColor        *background;
+       gint            size;
+       gchar           *Text;
+       RelPos          position;
+};
+
+
+struct _PropertiesIcon {
+       gchar           *icon_name;
+       gint            width;
+       gint            height;
+       RelPos          position;
+};
+
+struct _PropertiesLine {
+       GdkColor        *color;
+       gint            line_width;
+       GdkLineStyle    style;
+       RelPos          position;
+};
+
+struct _PropertiesArc {
+       GdkColor        *color;
+       gint            size;   /* We force circle by width = height */
+       gboolean        filled;
+       RelPos          position;
+};
+
+struct _PropertiesBG {
+       GdkColor        *color;
+};
+
+
+
+
+
+/* Drawing hook functions */
+gboolean DrawText( void *hook_data, void *call_data)
+{
+       PropertiesText *Properties = (PropertiesText*)hook_data;
+       DrawContext *Draw_Context = (DrawContext*)call_data;
+}
+
+gboolean DrawIcon( void *hook_data, void *call_data)
+{
+       PropertiesIcon *Properties = (PropertiesIcon*)hook_data;
+       DrawContext *Draw_Context = (DrawContext*)call_data;
+
+}
+
+gboolean DrawLine( void *hook_data, void *call_data)
+{
+       PropertiesLine *Properties = (PropertiesLine*)hook_data;
+       DrawContext *Draw_Context = (DrawContext*)call_data;
+
+}
+
+gboolean DrawArc( void *hook_data, void *call_data)
+{
+       PropertiesArc *Properties = (PropertiesArc*)hook_data;
+       DrawContext *Draw_Context = (DrawContext*)call_data;
+
+}
+
+gboolean DrawBG( void *hook_data, void *call_data)
+{
+       PropertiesBG *Properties = (PropertiesBG*)hook_data;
+       DrawContext *Draw_Context = (DrawContext*)call_data;
+
+}
+
+
This page took 0.028883 seconds and 4 git commands to generate.