1 #ifndef _RRD_GRAPH_H
2 #define _RRD_GRAPH_H
4 #define y0 cairo_y0
5 #define y1 cairo_y1
6 #define index cairo_index
8 #include <cairo.h>
9 #include <cairo-pdf.h>
10 #include <cairo-svg.h>
11 #include <cairo-ps.h>
12 #include <pango/pangocairo.h>
14 #include "rrd_tool.h"
15 #include "rrd_rpncalc.h"
18 #define ALTYGRID 0x01 /* use alternative y grid algorithm */
19 #define ALTAUTOSCALE 0x02 /* use alternative algorithm to find lower and upper bounds */
20 #define ALTAUTOSCALE_MIN 0x04 /* use alternative algorithm to find lower bounds */
21 #define ALTAUTOSCALE_MAX 0x08 /* use alternative algorithm to find upper bounds */
22 #define NOLEGEND 0x10 /* use no legend */
23 #define NOMINOR 0x20 /* Turn off minor gridlines */
24 #define ONLY_GRAPH 0x40 /* use only graph */
25 #define FORCE_RULES_LEGEND 0x80 /* force printing of HRULE and VRULE legend */
27 #define FORCE_UNITS 0x100 /* mask for all FORCE_UNITS_* flags */
28 #define FORCE_UNITS_SI 0x100 /* force use of SI units in Y axis (no effect in linear graph, SI instead of E in log graph) */
30 #define FULL_SIZE_MODE 0x200 /* -width and -height indicate the total size of the image */
32 enum tmt_en { TMT_SECOND = 0, TMT_MINUTE, TMT_HOUR, TMT_DAY,
33 TMT_WEEK, TMT_MONTH, TMT_YEAR
34 };
36 enum grc_en { GRC_CANVAS = 0, GRC_BACK, GRC_SHADEA, GRC_SHADEB,
37 GRC_GRID, GRC_MGRID, GRC_FONT, GRC_ARROW, GRC_AXIS, GRC_FRAME, __GRC_END__
38 };
40 #define MGRIDWIDTH 0.6
41 #define GRIDWIDTH 0.4
43 enum gf_en { GF_PRINT = 0, GF_GPRINT, GF_COMMENT, GF_HRULE, GF_VRULE, GF_LINE,
44 GF_AREA, GF_STACK, GF_TICK, GF_TEXTALIGN,
45 GF_DEF, GF_CDEF, GF_VDEF, GF_SHIFT,
46 GF_XPORT
47 };
49 enum txa_en { TXA_LEFT = 0, TXA_RIGHT, TXA_CENTER, TXA_JUSTIFIED };
51 enum vdef_op_en {
52 VDEF_MAXIMUM = 0 /* like the MAX in (G)PRINT */
53 , VDEF_MINIMUM /* like the MIN in (G)PRINT */
54 , VDEF_AVERAGE /* like the AVERAGE in (G)PRINT */
55 , VDEF_STDEV /* the standard deviation */
56 , VDEF_PERCENT /* Nth percentile */
57 , VDEF_TOTAL /* average multiplied by time */
58 , VDEF_FIRST /* first non-unknown value and time */
59 , VDEF_LAST /* last non-unknown value and time */
60 , VDEF_LSLSLOPE /* least squares line slope */
61 , VDEF_LSLINT /* least squares line y_intercept */
62 , VDEF_LSLCORREL /* least squares line correlation coefficient */
63 };
64 enum text_prop_en { TEXT_PROP_DEFAULT = 0, /* default settings */
65 TEXT_PROP_TITLE, /* properties for the title */
66 TEXT_PROP_AXIS, /* for the numbers next to the axis */
67 TEXT_PROP_UNIT, /* for the vertical unit description */
68 TEXT_PROP_LEGEND, /* for the legend below the graph */
69 TEXT_PROP_WATERMARK, /* for the little text to the side of the graph */
70 TEXT_PROP_LAST
71 };
74 enum gfx_if_en { IF_PNG = 0, IF_SVG, IF_EPS, IF_PDF };
75 enum gfx_en { GFX_LINE = 0, GFX_AREA, GFX_TEXT };
76 enum gfx_h_align_en { GFX_H_NULL = 0, GFX_H_LEFT, GFX_H_RIGHT, GFX_H_CENTER };
77 enum gfx_v_align_en { GFX_V_NULL = 0, GFX_V_TOP, GFX_V_BOTTOM, GFX_V_CENTER };
79 /* cairo color components */
80 typedef struct gfx_color_t {
81 double red;
82 double green;
83 double blue;
84 double alpha;
85 } gfx_color_t;
88 typedef struct text_prop_t {
89 double size;
90 char font[1024];
91 PangoFontDescription *font_desc;
92 } text_prop_t;
95 typedef struct vdef_t {
96 enum vdef_op_en op;
97 double param; /* parameter for function, if applicable */
98 double val; /* resulting value */
99 time_t when; /* timestamp, if applicable */
100 } vdef_t;
102 typedef struct xlab_t {
103 long minsec; /* minimum sec per pix */
104 long length; /* number of secs on the image */
105 enum tmt_en gridtm; /* grid interval in what ? */
106 long gridst; /* how many whats per grid */
107 enum tmt_en mgridtm; /* label interval in what ? */
108 long mgridst; /* how many whats per label */
109 enum tmt_en labtm; /* label interval in what ? */
110 long labst; /* how many whats per label */
111 long precis; /* label precision -> label placement */
112 char *stst; /* strftime string */
113 } xlab_t;
115 typedef struct ygrid_scale_t { /* y axis grid scaling info */
116 double gridstep;
117 int labfact;
118 char labfmt[64];
119 } ygrid_scale_t;
121 /* sensible y label intervals ...*/
123 typedef struct ylab_t {
124 double grid; /* grid spacing */
125 int lfac[4]; /* associated label spacing */
126 } ylab_t;
128 /* this structure describes the elements which can make up a graph.
129 because they are quite diverse, not all elements will use all the
130 possible parts of the structure. */
131 #ifdef HAVE_SNPRINTF
132 #define FMT_LEG_LEN 200
133 #else
134 #define FMT_LEG_LEN 2000
135 #endif
137 typedef struct graph_desc_t {
138 enum gf_en gf; /* graphing function */
139 int stack; /* boolean */
140 int debug; /* boolean */
141 char vname[MAX_VNAME_LEN + 1]; /* name of the variable */
142 long vidx; /* gdes reference */
143 char rrd[1024]; /* name of the rrd_file containing data */
144 char ds_nam[DS_NAM_SIZE]; /* data source name */
145 long ds; /* data source number */
146 enum cf_en cf; /* consolidation function */
147 enum cf_en cf_reduce; /* consolidation function for reduce_data() */
148 struct gfx_color_t col; /* graph color */
149 char format[FMT_LEG_LEN + 5]; /* format for PRINT AND GPRINT */
150 char legend[FMT_LEG_LEN + 5]; /* legend */
151 int strftm; /* should the VDEF legend be formated with strftime */
152 double leg_x, leg_y; /* location of legend */
153 double yrule; /* value for y rule line and for VDEF */
154 time_t xrule; /* time for x rule line and for VDEF */
155 vdef_t vf; /* instruction for VDEF function */
156 rpnp_t *rpnp; /* instructions for CDEF function */
158 /* SHIFT implementation */
159 int shidx; /* gdes reference for offset (-1 --> constant) */
160 time_t shval; /* offset if shidx is -1 */
161 time_t shift; /* current shift applied */
163 /* description of data fetched for the graph element */
164 time_t start, end; /* timestaps for first and last data element */
165 time_t start_orig, end_orig; /* timestaps for first and last data element */
166 unsigned long step; /* time between samples */
167 unsigned long step_orig; /* time between samples */
168 unsigned long ds_cnt; /* how many data sources are there in the fetch */
169 long data_first; /* first pointer to this data */
170 char **ds_namv; /* name of datasources in the fetch. */
171 rrd_value_t *data; /* the raw data drawn from the rrd */
172 rrd_value_t *p_data; /* processed data, xsize elments */
173 double linewidth; /* linewideth */
175 /* dashed line stuff */
176 int dash; /* boolean, draw dashed line? */
177 double *p_dashes; /* pointer do dash array which keeps the lengths of dashes */
178 int ndash; /* number of dash segments */
179 double offset; /* dash offset along the line */
181 enum txa_en txtalign; /* change default alignment strategy for text */
182 } graph_desc_t;
184 typedef struct image_desc_t {
186 /* configuration of graph */
188 char graphfile[MAXPATH]; /* filename for graphic */
189 long xsize, ysize; /* graph area size in pixels */
190 struct gfx_color_t graph_col[__GRC_END__]; /* real colors for the graph */
191 text_prop_t text_prop[TEXT_PROP_LAST]; /* text properties */
192 char ylegend[210]; /* legend along the yaxis */
193 char title[210]; /* title for graph */
194 char watermark[110]; /* watermark for graph */
195 int draw_x_grid; /* no x-grid at all */
196 int draw_y_grid; /* no x-grid at all */
197 double grid_dash_on, grid_dash_off;
198 xlab_t xlab_user; /* user defined labeling for xaxis */
199 char xlab_form[210]; /* format for the label on the xaxis */
201 double ygridstep; /* user defined step for y grid */
202 int ylabfact; /* every how many y grid shall a label be written ? */
203 double tabwidth; /* tabwdith */
204 time_t start, end; /* what time does the graph cover */
205 unsigned long step; /* any preference for the default step ? */
206 rrd_value_t minval, maxval; /* extreme values in the data */
207 int rigid; /* do not expand range even with
208 values outside */
209 ygrid_scale_t ygrid_scale; /* calculated y axis grid info */
210 int gridfit; /* adjust y-axis range etc so all
211 grindlines falls in integer pixel values */
212 char *imginfo; /* construct an <IMG ... tag and return
213 as first retval */
214 enum gfx_if_en imgformat; /* image format */
215 int lazy; /* only update the image if there is
216 reasonable probablility that the
217 existing one is out of date */
218 int slopemode; /* connect the dots of the curve directly, not using a stair */
219 int logarithmic; /* scale the yaxis logarithmic */
220 double force_scale_min; /* Force a scale--min */
221 double force_scale_max; /* Force a scale--max */
223 /* status information */
224 int with_markup;
225 long xorigin, yorigin; /* where is (0,0) of the graph */
226 long ximg, yimg; /* total size of the image */
227 size_t rendered_image_size;
228 double zoom;
229 double magfact; /* numerical magnitude */
230 long base; /* 1000 or 1024 depending on what we graph */
231 char symbol; /* magnitude symbol for y-axis */
232 float viewfactor; /* how should the numbers on the y-axis be scaled for viewing ? */
233 int unitsexponent; /* 10*exponent for units on y-asis */
234 int unitslength; /* width of the yaxis labels */
235 int forceleftspace; /* do not kill the space to the left of the y-axis if there is no grid */
237 int extra_flags; /* flags for boolean options */
238 /* data elements */
240 unsigned char *rendered_image;
241 long prt_c; /* number of print elements */
242 long gdes_c; /* number of graphics elements */
243 graph_desc_t *gdes; /* points to an array of graph elements */
244 cairo_surface_t *surface; /* graphics library */
245 cairo_t *cr; /* drawin context */
246 cairo_font_options_t *font_options; /* cairo font options */
247 cairo_antialias_t graph_antialias; /* antialiasing for the graph */
248 PangoLayout *layout; /* the pango layout we use for writing fonts */
249 rrd_info_t *grinfo; /* root pointer to extra graph info */
250 rrd_info_t *grinfo_current; /* pointing to current entry */
251 } image_desc_t;
253 /* Prototypes */
254 int xtr(
255 image_desc_t *,
256 time_t);
257 double ytr(
258 image_desc_t *,
259 double);
260 enum gf_en gf_conv(
261 char *);
262 enum gfx_if_en if_conv(
263 char *);
264 enum tmt_en tmt_conv(
265 char *);
266 enum grc_en grc_conv(
267 char *);
268 enum text_prop_en text_prop_conv(
269 char *);
270 int im_free(
271 image_desc_t *);
272 void auto_scale(
273 image_desc_t *,
274 double *,
275 char **,
276 double *);
277 void si_unit(
278 image_desc_t *);
279 void expand_range(
280 image_desc_t *);
281 void apply_gridfit(
282 image_desc_t *);
283 void reduce_data(
284 enum cf_en,
285 unsigned long,
286 time_t *,
287 time_t *,
288 unsigned long *,
289 unsigned long *,
290 rrd_value_t **);
291 int data_fetch(
292 image_desc_t *);
293 long find_var(
294 image_desc_t *,
295 char *);
296 long find_var_wrapper(
297 void *arg1,
298 char *key);
299 long lcd(
300 long *);
301 int data_calc(
302 image_desc_t *);
303 int data_proc(
304 image_desc_t *);
305 time_t find_first_time(
306 time_t,
307 enum tmt_en,
308 long);
309 time_t find_next_time(
310 time_t,
311 enum tmt_en,
312 long);
313 int print_calc(
314 image_desc_t *);
315 int leg_place(
316 image_desc_t *,
317 int *);
318 int calc_horizontal_grid(
319 image_desc_t *);
320 int draw_horizontal_grid(
321 image_desc_t *);
322 int horizontal_log_grid(
323 image_desc_t *);
324 void vertical_grid(
325 image_desc_t *);
326 void axis_paint(
327 image_desc_t *);
328 void grid_paint(
329 image_desc_t *);
330 int lazy_check(
331 image_desc_t *);
332 int graph_paint(
333 image_desc_t *);
335 int gdes_alloc(
336 image_desc_t *);
337 int scan_for_col(
338 const char *const,
339 int,
340 char *const);
341 void rrd_graph_init(
342 image_desc_t *);
344 void rrd_graph_options(
345 int,
346 char **,
347 image_desc_t *);
348 void rrd_graph_script(
349 int,
350 char **,
351 image_desc_t *,
352 int);
353 int rrd_graph_color(
354 image_desc_t *,
355 char *,
356 char *,
357 int);
358 int bad_format(
359 char *);
360 int vdef_parse(
361 struct graph_desc_t *,
362 const char *const);
363 int vdef_calc(
364 image_desc_t *,
365 int);
366 int vdef_percent_compar(
367 const void *,
368 const void *);
369 int graph_size_location(
370 image_desc_t *,
371 int);
374 /* create a new line */
375 void gfx_line(
376 image_desc_t *im,
377 double X0,
378 double Y0,
379 double X1,
380 double Y1,
381 double width,
382 gfx_color_t color);
384 void gfx_dashed_line(
385 image_desc_t *im,
386 double X0,
387 double Y0,
388 double X1,
389 double Y1,
390 double width,
391 gfx_color_t color,
392 double dash_on,
393 double dash_off);
395 /* create a new area */
396 void gfx_new_area(
397 image_desc_t *im,
398 double X0,
399 double Y0,
400 double X1,
401 double Y1,
402 double X2,
403 double Y2,
404 gfx_color_t color);
406 /* add a point to a line or to an area */
407 void gfx_add_point(
408 image_desc_t *im,
409 double x,
410 double y);
412 /* close current path so it ends at the same point as it started */
413 void gfx_close_path(
414 image_desc_t *im);
417 /* create a text node */
418 void gfx_text(
419 image_desc_t *im,
420 double x,
421 double y,
422 gfx_color_t color,
423 PangoFontDescription *font_desc,
424 double tabwidth,
425 double angle,
426 enum gfx_h_align_en h_align,
427 enum gfx_v_align_en v_align,
428 const char *text);
430 /* measure width of a text string */
431 double gfx_get_text_width(
432 image_desc_t *im,
433 double start,
434 PangoFontDescription *font_desc,
435 double tabwidth,
436 char *text);
439 /* convert color */
440 gfx_color_t gfx_hex_to_col(
441 long unsigned int);
443 void gfx_line_fit(
444 image_desc_t *im,
445 double *x,
446 double *y);
448 void gfx_area_fit(
449 image_desc_t *im,
450 double *x,
451 double *y);
453 #endif
455 void grinfo_push(
456 image_desc_t *im,
457 char *key,
458 rrd_info_type_t type, rrd_infoval_t value);