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