Code

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