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,
47 GF_DEF, GF_CDEF, GF_VDEF, GF_SHIFT,
48 GF_XPORT
49 };
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_PERCENT /* Nth percentile */
56 , VDEF_TOTAL /* average multiplied by time */
57 , VDEF_FIRST /* first non-unknown value and time */
58 , VDEF_LAST /* last non-unknown value and time */
59 , VDEF_LSLSLOPE /* least squares line slope */
60 , VDEF_LSLINT /* least squares line y_intercept */
61 , VDEF_LSLCORREL /* least squares line correlation coefficient */
62 };
63 enum text_prop_en { TEXT_PROP_DEFAULT = 0, /* default settings */
64 TEXT_PROP_TITLE, /* properties for the title */
65 TEXT_PROP_AXIS, /* for the numbers next to the axis */
66 TEXT_PROP_UNIT, /* for the vertical unit description */
67 TEXT_PROP_LEGEND, /* fot the legend below the graph */
68 TEXT_PROP_LAST
69 };
72 enum gfx_if_en { IF_PNG = 0, IF_SVG, IF_EPS, IF_PDF };
73 enum gfx_en { GFX_LINE = 0, GFX_AREA, GFX_TEXT };
74 enum gfx_h_align_en { GFX_H_NULL = 0, GFX_H_LEFT, GFX_H_RIGHT, GFX_H_CENTER };
75 enum gfx_v_align_en { GFX_V_NULL = 0, GFX_V_TOP, GFX_V_BOTTOM, GFX_V_CENTER };
77 /* cairo color components */
78 typedef struct gfx_color_t {
79 double red;
80 double green;
81 double blue;
82 double alpha;
83 } gfx_color_t;
86 typedef struct text_prop_t {
87 double size;
88 char font[1024];
89 } text_prop_t;
92 typedef struct vdef_t {
93 enum vdef_op_en op;
94 double param; /* parameter for function, if applicable */
95 double val; /* resulting value */
96 time_t when; /* timestamp, if applicable */
97 } vdef_t;
99 typedef struct xlab_t {
100 long minsec; /* minimum sec per pix */
101 long length; /* number of secs on the image */
102 enum tmt_en gridtm; /* grid interval in what ? */
103 long gridst; /* how many whats per grid */
104 enum tmt_en mgridtm; /* label interval in what ? */
105 long mgridst; /* how many whats per label */
106 enum tmt_en labtm; /* label interval in what ? */
107 long labst; /* how many whats per label */
108 long precis; /* label precision -> label placement */
109 char *stst; /* strftime string */
110 } xlab_t;
112 typedef struct ygrid_scale_t { /* y axis grid scaling info */
113 double gridstep;
114 int labfact;
115 char labfmt[64];
116 } ygrid_scale_t;
118 /* sensible y label intervals ...*/
120 typedef struct ylab_t {
121 double grid; /* grid spacing */
122 int lfac[4]; /* associated label spacing */
123 } ylab_t;
125 /* this structure describes the elements which can make up a graph.
126 because they are quite diverse, not all elements will use all the
127 possible parts of the structure. */
128 #ifdef HAVE_SNPRINTF
129 #define FMT_LEG_LEN 200
130 #else
131 #define FMT_LEG_LEN 2000
132 #endif
134 typedef struct graph_desc_t {
135 enum gf_en gf; /* graphing function */
136 int stack; /* boolean */
137 int debug; /* boolean */
138 char vname[MAX_VNAME_LEN + 1]; /* name of the variable */
139 long vidx; /* gdes reference */
140 char rrd[1024]; /* name of the rrd_file containing data */
141 char ds_nam[DS_NAM_SIZE]; /* data source name */
142 long ds; /* data source number */
143 enum cf_en cf; /* consolidation function */
144 enum cf_en cf_reduce; /* consolidation function for reduce_data() */
145 struct gfx_color_t col; /* graph color */
146 char format[FMT_LEG_LEN + 5]; /* format for PRINT AND GPRINT */
147 char legend[FMT_LEG_LEN + 5]; /* legend */
148 int strftm; /* should the VDEF legend be formated with strftime */
149 double leg_x, leg_y; /* location of legend */
150 double yrule; /* value for y rule line and for VDEF */
151 time_t xrule; /* time for x rule line and for VDEF */
152 vdef_t vf; /* instruction for VDEF function */
153 rpnp_t *rpnp; /* instructions for CDEF function */
155 /* SHIFT implementation */
156 int shidx; /* gdes reference for offset (-1 --> constant) */
157 time_t shval; /* offset if shidx is -1 */
158 time_t shift; /* current shift applied */
160 /* description of data fetched for the graph element */
161 time_t start, end; /* timestaps for first and last data element */
162 time_t start_orig, end_orig; /* timestaps for first and last data element */
163 unsigned long step; /* time between samples */
164 unsigned long step_orig; /* time between samples */
165 unsigned long ds_cnt; /* how many data sources are there in the fetch */
166 long data_first; /* first pointer to this data */
167 char **ds_namv; /* name of datasources in the fetch. */
168 rrd_value_t *data; /* the raw data drawn from the rrd */
169 rrd_value_t *p_data; /* processed data, xsize elments */
170 double linewidth; /* linewideth */
171 } graph_desc_t;
173 typedef struct image_desc_t {
175 /* configuration of graph */
177 char graphfile[MAXPATH]; /* filename for graphic */
178 FILE *graphhandle; /* FILE to use if filename is "-" */
179 long xsize, ysize; /* graph area size in pixels */
180 struct gfx_color_t graph_col[__GRC_END__]; /* real colors for the graph */
181 text_prop_t text_prop[TEXT_PROP_LAST]; /* text properties */
182 char ylegend[210]; /* legend along the yaxis */
183 char title[210]; /* title for graph */
184 char watermark[110]; /* watermark for graph */
185 int draw_x_grid; /* no x-grid at all */
186 int draw_y_grid; /* no x-grid at all */
187 double grid_dash_on, grid_dash_off;
188 xlab_t xlab_user; /* user defined labeling for xaxis */
189 char xlab_form[210]; /* format for the label on the xaxis */
191 double ygridstep; /* user defined step for y grid */
192 int ylabfact; /* every how many y grid shall a label be written ? */
193 double tabwidth; /* tabwdith */
194 time_t start, end; /* what time does the graph cover */
195 unsigned long step; /* any preference for the default step ? */
196 rrd_value_t minval, maxval; /* extreme values in the data */
197 int rigid; /* do not expand range even with
198 values outside */
199 ygrid_scale_t ygrid_scale; /* calculated y axis grid info */
200 int gridfit; /* adjust y-axis range etc so all
201 grindlines falls in integer pixel values */
202 char *imginfo; /* construct an <IMG ... tag and return
203 as first retval */
204 enum gfx_if_en imgformat; /* image format */
205 int lazy; /* only update the image if there is
206 reasonable probablility that the
207 existing one is out of date */
208 int slopemode; /* connect the dots of the curve directly, not using a stair */
209 int logarithmic; /* scale the yaxis logarithmic */
211 /* status information */
213 long xorigin, yorigin; /* where is (0,0) of the graph */
214 long ximg, yimg; /* total size of the image */
215 double zoom;
216 double magfact; /* numerical magnitude */
217 long base; /* 1000 or 1024 depending on what we graph */
218 char symbol; /* magnitude symbol for y-axis */
219 float viewfactor; /* how should the numbers on the y-axis be scaled for viewing ? */
220 int unitsexponent; /* 10*exponent for units on y-asis */
221 int unitslength; /* width of the yaxis labels */
222 int forceleftspace; /* do not kill the space to the left of the y-axis if there is no grid */
224 int extra_flags; /* flags for boolean options */
225 /* data elements */
227 long prt_c; /* number of print elements */
228 long gdes_c; /* number of graphics elements */
229 graph_desc_t *gdes; /* points to an array of graph elements */
230 cairo_surface_t *surface; /* graphics library */
231 cairo_t *cr; /* drawin context */
232 cairo_font_options_t *font_options; /* cairo font options */
233 cairo_antialias_t graph_antialias; /* antialiasing for the graph */
234 } image_desc_t;
236 /* Prototypes */
237 int xtr(
238 image_desc_t *,
239 time_t);
240 double ytr(
241 image_desc_t *,
242 double);
243 enum gf_en gf_conv(
244 char *);
245 enum gfx_if_en if_conv(
246 char *);
247 enum tmt_en tmt_conv(
248 char *);
249 enum grc_en grc_conv(
250 char *);
251 enum text_prop_en text_prop_conv(
252 char *);
253 int im_free(
254 image_desc_t *);
255 void auto_scale(
256 image_desc_t *,
257 double *,
258 char **,
259 double *);
260 void si_unit(
261 image_desc_t *);
262 void expand_range(
263 image_desc_t *);
264 void apply_gridfit(
265 image_desc_t *);
266 void reduce_data(
267 enum cf_en,
268 unsigned long,
269 time_t *,
270 time_t *,
271 unsigned long *,
272 unsigned long *,
273 rrd_value_t **);
274 int data_fetch(
275 image_desc_t *);
276 long find_var(
277 image_desc_t *,
278 char *);
279 long find_var_wrapper(
280 void *arg1,
281 char *key);
282 long lcd(
283 long *);
284 int data_calc(
285 image_desc_t *);
286 int data_proc(
287 image_desc_t *);
288 time_t find_first_time(
289 time_t,
290 enum tmt_en,
291 long);
292 time_t find_next_time(
293 time_t,
294 enum tmt_en,
295 long);
296 int print_calc(
297 image_desc_t *,
298 char ***);
299 int leg_place(
300 image_desc_t *,
301 int *);
302 int calc_horizontal_grid(
303 image_desc_t *);
304 int draw_horizontal_grid(
305 image_desc_t *);
306 int horizontal_log_grid(
307 image_desc_t *);
308 void vertical_grid(
309 image_desc_t *);
310 void axis_paint(
311 image_desc_t *);
312 void grid_paint(
313 image_desc_t *);
314 int lazy_check(
315 image_desc_t *);
316 int graph_paint(
317 image_desc_t *,
318 char ***);
320 int gdes_alloc(
321 image_desc_t *);
322 int scan_for_col(
323 const char *const,
324 int,
325 char *const);
326 int rrd_graph(
327 int,
328 char **,
329 char ***,
330 int *,
331 int *,
332 FILE *,
333 double *,
334 double *);
335 void rrd_graph_init(
336 image_desc_t *);
337 void rrd_graph_options(
338 int,
339 char **,
340 image_desc_t *);
341 void rrd_graph_script(
342 int,
343 char **,
344 image_desc_t *,
345 int);
346 int rrd_graph_color(
347 image_desc_t *,
348 char *,
349 char *,
350 int);
351 int bad_format(
352 char *);
353 int vdef_parse(
354 struct graph_desc_t *,
355 const char *const);
356 int vdef_calc(
357 image_desc_t *,
358 int);
359 int vdef_percent_compar(
360 const void *,
361 const void *);
362 int graph_size_location(
363 image_desc_t *,
364 int
365 );
368 /* create a new line */
369 void gfx_line(
370 image_desc_t *im,
371 double X0,
372 double Y0,
373 double X1,
374 double Y1,
375 double width,
376 gfx_color_t color);
378 void gfx_dashed_line(
379 image_desc_t *im,
380 double X0,
381 double Y0,
382 double X1,
383 double Y1,
384 double width,
385 gfx_color_t color,
386 double dash_on,
387 double dash_off);
389 /* create a new area */
390 void gfx_new_area(
391 image_desc_t *im,
392 double X0,
393 double Y0,
394 double X1,
395 double Y1,
396 double X2,
397 double Y2,
398 gfx_color_t color);
400 /* add a point to a line or to an area */
401 void gfx_add_point(
402 image_desc_t *im,
403 double x,
404 double y);
406 /* close current path so it ends at the same point as it started */
407 void gfx_close_path(
408 image_desc_t *im);
411 /* create a text node */
412 void gfx_text(
413 image_desc_t *im,
414 double x,
415 double y,
416 gfx_color_t color,
417 char *font,
418 double size,
419 double tabwidth,
420 double angle,
421 enum gfx_h_align_en h_align,
422 enum gfx_v_align_en v_align,
423 const char *text);
425 /* measure width of a text string */
426 double gfx_get_text_width(
427 image_desc_t *im,
428 double start,
429 char *font,
430 double size,
431 double tabwidth,
432 char *text);
435 /* convert color */
436 gfx_color_t gfx_hex_to_col(
437 long unsigned int);
439 void gfx_line_fit(
440 image_desc_t *im,
441 double *x,
442 double *y);
444 void gfx_area_fit(
445 image_desc_t *im,
446 double *x,
447 double *y);
449 #endif