Code

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