cf6cb7e0 |
1 | /****************************************************************************** |
2 | * Draw_Item.c |
3 | * |
4 | * This file contains methods responsible for drawing a generic type of data |
5 | * in a drawable. Doing this generically will permit user defined drawing |
6 | * behavior in a later time. |
7 | * |
b782dd11 |
8 | * This file provides an API which is meant to be reusable for all viewers that |
9 | * need to show information in line, icon, text, background or point form in |
10 | * a drawable area having time for x axis. The y axis, in the control flow |
11 | * viewer case, is corresponding to the different processes, but it can be |
12 | * reused integrally for cpu, and eventually locks, buffers, network |
13 | * interfaces... What will differ between the viewers is the precise |
14 | * information which interests us. We may think that the most useful |
15 | * information for control flow are some specific events, like schedule |
16 | * change, and processes'states. It may differ for a cpu viewer : the |
17 | * interesting information could be more the execution mode of each cpu. |
18 | * This API in meant to make viewer's writers life easier : it will become |
19 | * a simple choice of icons and line types for the precise information |
20 | * the viewer has to provide (agremented with keeping supplementary records |
21 | * and modifying slightly the DrawContext to suit the needs.) |
22 | * |
f0728492 |
23 | * We keep each data type in attributes, keys to specific information |
24 | * being formed from the GQuark corresponding to the information received. |
25 | * (facilities / facility_name / events / eventname.) |
26 | * (cpus/cpu_name, process_states/ps_name, |
27 | * execution_modes/em_name, execution_submodes/es_name). |
cf6cb7e0 |
28 | * The goal is then to provide a generic way to print information on the |
29 | * screen for all this different information. |
30 | * |
31 | * Information can be printed as |
32 | * |
33 | * - text (text + color + size + position (over or under line) |
34 | * - icon (icon filename, corresponding to a loaded icon, accessible through |
35 | * a GQuark. Icons are loaded statically at the guiControlFlow level during |
36 | * module initialization and can be added on the fly if not present in the |
37 | * GQuark.) The habitual place for xpm icons is in |
38 | * ${prefix}/share/LinuxTraceToolkit.) + position (over or under line) |
39 | * - line (color, width, style) |
189a5d08 |
40 | * - Arc (big points) (color, size) |
cf6cb7e0 |
41 | * - background color (color) |
42 | * |
189a5d08 |
43 | * An item is a leaf of the attributes tree. It is, in that case, including |
44 | * all kind of events categories we can have. It then associates each category |
45 | * with one or more actions (drawing something) or nothing. |
46 | * |
7d5ffafa |
47 | * Each item has an array of hooks (hook list). Each hook represents an |
48 | * operation to perform. We seek the array each time we want to |
a2e850ff |
49 | * draw an item. We execute each operation in order. An operation type |
50 | * is associated with each hook to permit user listing and modification |
51 | * of these operations. The operation type is also used to find the |
52 | * corresponding priority for the sorting. Operation type and priorities |
53 | * are enum and a static int table. |
cf6cb7e0 |
54 | * |
55 | * The array has to be sorted by priority each time we add a task in it. |
a2e850ff |
56 | * A priority is associated with each operation type. It permits |
cf6cb7e0 |
57 | * to perform background color selection before line or text drawing. We also |
58 | * draw lines before text, so the text appears over the lines. |
59 | * |
60 | * Executing all the arrays of operations for a specific event (which |
61 | * implies information for state, event, cpu, execution mode and submode) |
62 | * has to be done in a same DrawContext. The goal there is to keep the offset |
63 | * of the text and icons over and under the middle line, so a specific |
64 | * event could be printed as ( R Si 0 for running, scheduled in, cpu 0 ), |
7d5ffafa |
65 | * text being easy to replace with icons. The DrawContext is passed as |
66 | * call_data for the operation hooks. |
cf6cb7e0 |
67 | * |
b782dd11 |
68 | * We use the lttv global attributes to keep track of the loaded icons. |
69 | * If we need an icon, we look for it in the icons / icon name pathname. |
70 | * If found, we use the pointer to it. If not, we load the pixmap in |
71 | * memory and set the pointer to the GdkPixmap in the attributes. |
72 | * |
cf6cb7e0 |
73 | * Author : Mathieu Desnoyers, October 2003 |
74 | */ |
7d5ffafa |
75 | |
76 | #include <glib.h> |
77 | #include <lttv/hook.h> |
f0728492 |
78 | #include <lttv/attribute.h> |
79 | #include <lttv/iattribute.h> |
7d5ffafa |
80 | |
b782dd11 |
81 | #include <lttv/processTrace.h> |
82 | #include <lttv/state.h> |
83 | |
84 | /* The DrawContext keeps information about the current drawing position and |
85 | * the previous one, so we can use both to draw lines. |
86 | * |
87 | * over : position for drawing over the middle line. |
88 | * middle : middle line position. |
89 | * under : position for drawing under the middle line. |
90 | */ |
91 | struct _DrawContext { |
92 | GdkDrawable *drawable; |
93 | GdkGC *gc; |
94 | |
95 | DrawInfo *Current; |
96 | DrawInfo *Previous; |
97 | }; |
98 | |
99 | struct _DrawInfo { |
100 | ItemInfo *over; |
101 | ItemInfo *middle; |
102 | ItemInfo *under; |
103 | }; |
104 | |
105 | /* LttvExecutionState is accessible through the LttvTracefileState. Is has |
106 | * a pointer to the LttvProcessState which points to the top of stack |
107 | * execution state : LttvExecutionState *state. |
108 | * |
109 | * LttvExecutionState contains (useful here): |
110 | * LttvExecutionMode t, |
111 | * LttvExecutionSubmode n, |
112 | * LttvProcessStatus s |
113 | * |
114 | * |
115 | * LttvTraceState will be used in the case we need the string of the |
116 | * different processes, eventtype_names, syscall_names, trap_names, irq_names. |
117 | * |
118 | * LttvTracefileState also gives the cpu_name and, as it herits from |
119 | * LttvTracefileContext, it gives the LttEvent structure, which is needed |
120 | * to get facility name and event name. |
121 | */ |
122 | struct _ItemInfo { |
123 | gint x, y; |
124 | LttvTraceState *ts; |
125 | LttvTracefileState *tfs; |
126 | }; |
127 | |
128 | |
129 | /* |
130 | * The Item element is only used so the DrawOperation is modifiable by users. |
131 | * During drawing, only the Hook is needed. |
132 | */ |
133 | struct _DrawOperation { |
134 | DrawableItems Item; |
135 | LttvHooks *Hook; |
136 | }; |
137 | |
138 | /* |
139 | * We define here each items that can be drawn, together with their |
140 | * associated priority. Many item types can have the same priority, |
141 | * it's only used for quicksorting the operations when we add a new one |
142 | * to the array of operations to perform. Lower priorities are executed |
143 | * first. So, for example, we may want to give background color a value |
144 | * of 10 while a line would have 20, so the background color, which |
145 | * is in fact a rectangle, does not hide the line. |
146 | */ |
147 | |
148 | typedef enum _DrawableItems { |
149 | ITEM_TEXT, ITEM_ICON, ITEM_LINE, ITEM_POINT, ITEM_BACKGROUND |
150 | } DrawableItems; |
151 | |
152 | static gchar * Items_Priorities = { |
153 | 50, /* ITEM_TEXT */ |
154 | 40, /* ITEM_ICON */ |
155 | 20, /* ITEM_LINE */ |
156 | 30, /* ITEM_POINT */ |
157 | 10 /* ITEM_BACKGROUND */ |
158 | }; |
159 | |
160 | typedef enum _RelPos { |
161 | OVER, MIDDLE, UNDER |
162 | } RelPos; |
163 | |
164 | /* |
165 | * Here are the different structures describing each item type that can be |
166 | * drawn. They contain the information necessary to draw the item : not the |
167 | * position (this is provided by the DrawContext), but the text, icon name, |
168 | * line width, color; all the properties of the specific items. |
169 | */ |
170 | |
171 | struct _PropertiesText { |
172 | GdkColor *foreground; |
173 | GdkColor *background; |
174 | gint size; |
175 | gchar *Text; |
176 | RelPos position; |
177 | }; |
178 | |
179 | |
180 | struct _PropertiesIcon { |
181 | gchar *icon_name; |
182 | gint width; |
183 | gint height; |
184 | RelPos position; |
185 | }; |
186 | |
187 | struct _PropertiesLine { |
188 | GdkColor *color; |
189 | gint line_width; |
190 | GdkLineStyle style; |
191 | RelPos position; |
192 | }; |
193 | |
194 | struct _PropertiesArc { |
195 | GdkColor *color; |
196 | gint size; /* We force circle by width = height */ |
197 | gboolean filled; |
198 | RelPos position; |
199 | }; |
200 | |
201 | struct _PropertiesBG { |
202 | GdkColor *color; |
203 | }; |
204 | |
205 | |
206 | |
207 | |
208 | |
209 | /* Drawing hook functions */ |
4c69e0cc |
210 | gboolean draw_text( void *hook_data, void *call_data) |
b782dd11 |
211 | { |
212 | PropertiesText *Properties = (PropertiesText*)hook_data; |
213 | DrawContext *Draw_Context = (DrawContext*)call_data; |
214 | } |
215 | |
4c69e0cc |
216 | gboolean draw_icon( void *hook_data, void *call_data) |
b782dd11 |
217 | { |
218 | PropertiesIcon *Properties = (PropertiesIcon*)hook_data; |
219 | DrawContext *Draw_Context = (DrawContext*)call_data; |
220 | |
221 | } |
222 | |
4c69e0cc |
223 | gboolean draw_line( void *hook_data, void *call_data) |
b782dd11 |
224 | { |
225 | PropertiesLine *Properties = (PropertiesLine*)hook_data; |
226 | DrawContext *Draw_Context = (DrawContext*)call_data; |
227 | |
228 | } |
229 | |
4c69e0cc |
230 | gboolean draw_arc( void *hook_data, void *call_data) |
b782dd11 |
231 | { |
232 | PropertiesArc *Properties = (PropertiesArc*)hook_data; |
233 | DrawContext *Draw_Context = (DrawContext*)call_data; |
234 | |
235 | } |
236 | |
4c69e0cc |
237 | gboolean draw_bg( void *hook_data, void *call_data) |
b782dd11 |
238 | { |
239 | PropertiesBG *Properties = (PropertiesBG*)hook_data; |
240 | DrawContext *Draw_Context = (DrawContext*)call_data; |
241 | |
242 | } |
243 | |
244 | |