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