6 #define index cairo_index
8 /* this may configure __EXTENSIONS__ without which pango will fail to compile
10 #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__CYGWIN32__)
11 #include "../win32/config.h"
14 #include "../rrd_config.h"
19 #include <cairo-pdf.h>
20 #include <cairo-svg.h>
23 #include <pango/pangocairo.h>
27 #include "rrd_rpncalc.h"
31 # define MAXPATH MAX_PATH
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
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__
57 #define MGRIDWIDTH 0.6
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, GF_XAXIS, GF_YAXIS
66 enum txa_en { TXA_LEFT = 0, TXA_RIGHT, TXA_CENTER, TXA_JUSTIFIED };
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*/
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 */
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 IF_XMLENUM=133, IF_JSONTIME=134
99 enum gfx_en { GFX_LINE = 0, GFX_AREA, GFX_TEXT };
100 enum gfx_h_align_en { GFX_H_NULL = 0, GFX_H_LEFT, GFX_H_RIGHT, GFX_H_CENTER };
101 enum gfx_v_align_en { GFX_V_NULL = 0, GFX_V_TOP, GFX_V_BOTTOM, GFX_V_CENTER };
103 enum gfx_type_en {GTYPE_TIME=0,GTYPE_XY=1};
105 /* cairo color components */
106 typedef struct gfx_color_t {
113 typedef struct keyvalue_t {
120 typedef struct keyint_t {
125 typedef struct parsedargs_t {
126 char *arg; /* copy of the parsed string - rewritten*/
127 const char *arg_orig; /* original argument */
128 int kv_cnt; /* number of key/value arguments */
129 keyvalue_t *kv_args; /* key value arguments */
131 void initParsedArguments(parsedargs_t*);
132 void freeParsedArguments(parsedargs_t*);
133 int addToArguments(parsedargs_t*, char*, char*, int);
134 int parseArguments(const char*, parsedargs_t*);
135 void dumpKeyValue(char* ,keyvalue_t*);
136 void dumpArguments(parsedargs_t*);
137 char* getKeyValueArgument(const char*, int, parsedargs_t*);
138 int getMappedKeyValueArgument(const char*,int, parsedargs_t*,
140 int getLong(const char*,long *,char**,int);
141 int getDouble(const char*,double *,char**);
142 keyvalue_t* getFirstUnusedArgument(int, parsedargs_t*);
143 char* checkUnusedValues(parsedargs_t*);
145 typedef struct text_prop_t {
148 PangoFontDescription *font_desc;
152 typedef struct vdef_t {
154 double param; /* parameter for function, if applicable */
155 double val; /* resulting value */
156 time_t when; /* timestamp, if applicable */
157 int never; /* boolean, indicate that when value mean never */
160 typedef struct xlab_t {
161 long minsec; /* minimum sec per pix */
162 long length; /* number of secs on the image */
163 enum tmt_en gridtm; /* grid interval in what ? */
164 long gridst; /* how many whats per grid */
165 enum tmt_en mgridtm; /* label interval in what ? */
166 long mgridst; /* how many whats per label */
167 enum tmt_en labtm; /* label interval in what ? */
168 long labst; /* how many whats per label */
169 long precis; /* label precision -> label placement */
170 char *stst; /* strftime string */
173 typedef struct ygrid_scale_t { /* y axis grid scaling info */
179 /* sensible y label intervals ...*/
181 typedef struct ylab_t {
182 double grid; /* grid spacing */
183 int lfac[4]; /* associated label spacing */
186 /* this structure describes the elements which can make up a graph.
187 because they are quite diverse, not all elements will use all the
188 possible parts of the structure. */
190 #define FMT_LEG_LEN 200
192 #define FMT_LEG_LEN 2000
197 typedef struct graph_desc_t {
198 enum gf_en gf; /* graphing function */
199 int stack; /* boolean */
200 int debug; /* boolean */
201 char vname[MAX_VNAME_LEN + 1]; /* name of the variable */
202 long vidx; /* gdes reference */
203 char rrd[1024]; /* name of the rrd_file containing data */
204 char ds_nam[DS_NAM_SIZE]; /* data source name */
205 long ds; /* data source number */
207 enum cf_en cf; /* consolidation function */
208 enum cf_en cf_reduce; /* consolidation function for reduce_data() */
209 struct gfx_color_t col, col2; /* graph color */
211 char format[FMT_LEG_LEN + 5]; /* format for PRINT AND GPRINT */
212 char legend[FMT_LEG_LEN + 5]; /* legend */
213 int strftm; /* should the VDEF legend be formated with strftime */
214 double leg_x, leg_y; /* location of legend */
215 double yrule; /* value for y rule line and for VDEF */
216 time_t xrule; /* time for x rule line and for VDEF */
217 vdef_t vf; /* instruction for VDEF function */
218 rpnp_t *rpnp; /* instructions for CDEF function */
219 char *rpn; /* string representation of rpn */
221 /* SHIFT implementation */
222 int shidx; /* gdes reference for offset (-1 --> constant) */
223 time_t shval; /* offset if shidx is -1 */
224 time_t shift; /* current shift applied */
226 /* description of data fetched for the graph element */
227 time_t start, end; /* timestaps for first and last data element */
228 time_t start_orig, end_orig; /* timestaps for first and last data element */
229 unsigned long step; /* time between samples */
230 unsigned long step_orig; /* time between samples */
231 unsigned long ds_cnt; /* how many data sources are there in the fetch */
232 long data_first; /* first pointer to this data */
233 char **ds_namv; /* name of datasources in the fetch. */
234 rrd_value_t *data; /* the raw data drawn from the rrd */
235 rrd_value_t *p_data; /* processed data, xsize elments */
236 double linewidth; /* linewideth */
238 /* dashed line stuff */
239 int dash; /* boolean, draw dashed line? */
240 double *p_dashes; /* pointer do dash array which keeps the lengths of dashes */
241 int ndash; /* number of dash segments */
242 double offset; /* dash offset along the line */
244 enum txa_en txtalign; /* change default alignment strategy for text */
246 /* the axis to use for this graph in x and y*/
251 typedef struct image_desc_t {
253 /* configuration of graph */
254 char graphfile[MAXPATH]; /* filename for graphic */
255 enum gfx_type_en graph_type; /* type of the graph */
256 long xsize, ysize; /* graph area size in pixels */
257 struct gfx_color_t graph_col[__GRC_END__]; /* real colors for the graph */
258 text_prop_t text_prop[TEXT_PROP_LAST]; /* text properties */
259 char ylegend[210]; /* legend along the yaxis */
260 char title[210]; /* title for graph */
261 char watermark[110]; /* watermark for graph */
262 int draw_x_grid; /* no x-grid at all */
263 int draw_y_grid; /* no y-grid at all */
264 unsigned int draw_3d_border; /* size of border in pixels, 0 for off */
265 unsigned int dynamic_labels; /* pick the label shape according to the line drawn */
266 double grid_dash_on, grid_dash_off;
267 xlab_t xlab_user; /* user defined labeling for xaxis */
268 char xlab_form[210]; /* format for the label on the xaxis */
269 double second_axis_scale; /* relative to the first axis (0 to disable) */
270 double second_axis_shift; /* how much is it shifted vs the first axis */
271 char second_axis_legend[210]; /* label to put on the seond axis */
272 char second_axis_format[210]; /* format for the numbers on the scond axis */
274 double ygridstep; /* user defined step for y grid */
275 int ylabfact; /* every how many y grid shall a label be written ? */
276 double tabwidth; /* tabwdith */
277 time_t start, end; /* what time does the graph cover */
278 unsigned long step; /* any preference for the default step ? */
279 rrd_value_t minval, maxval; /* extreme values in the data */
280 int rigid; /* do not expand range even with
282 ygrid_scale_t ygrid_scale; /* calculated y axis grid info */
283 int gridfit; /* adjust y-axis range etc so all
284 grindlines falls in integer pixel values */
285 char *imginfo; /* construct an <IMG ... tag and return
287 enum gfx_if_en imgformat; /* image format */
288 char *daemon_addr; /* rrdcached connection string */
289 int lazy; /* only update the image if there is
290 reasonable probablility that the
291 existing one is out of date */
292 int slopemode; /* connect the dots of the curve directly, not using a stair */
293 enum legend_pos legendposition; /* the position of the legend: north, west, south or east */
294 enum legend_direction legenddirection; /* The direction of the legend topdown or bottomup */
295 int logarithmic; /* scale the yaxis logarithmic */
296 double force_scale_min; /* Force a scale--min */
297 double force_scale_max; /* Force a scale--max */
299 /* status information */
301 long xorigin, yorigin; /* where is (0,0) of the graph */
302 long xOriginTitle, yOriginTitle; /* where is the origin of the title */
303 long xOriginLegendY, yOriginLegendY; /* where is the origin of the y legend */
304 long xOriginLegendY2, yOriginLegendY2; /* where is the origin of the second y legend */
305 long xOriginLegend, yOriginLegend; /* where is the origin of the legend */
306 long ximg, yimg; /* total size of the image */
307 long legendwidth, legendheight; /* the calculated height and width of the legend */
308 size_t rendered_image_size;
310 double magfact; /* numerical magnitude */
311 long base; /* 1000 or 1024 depending on what we graph */
312 char symbol; /* magnitude symbol for y-axis */
313 float viewfactor; /* how should the numbers on the y-axis be scaled for viewing ? */
314 int unitsexponent; /* 10*exponent for units on y-asis */
315 int unitslength; /* width of the yaxis labels */
316 int forceleftspace; /* do not kill the space to the left of the y-axis if there is no grid */
318 int extra_flags; /* flags for boolean options */
321 unsigned char *rendered_image;
322 long prt_c; /* number of print elements */
323 long gdes_c; /* number of graphics elements */
324 graph_desc_t *gdes; /* points to an array of graph elements */
325 cairo_surface_t *surface; /* graphics library */
326 cairo_t *cr; /* drawin context */
327 cairo_font_options_t *font_options; /* cairo font options */
328 cairo_antialias_t graph_antialias; /* antialiasing for the graph */
329 PangoLayout *layout; /* the pango layout we use for writing fonts */
330 rrd_info_t *grinfo; /* root pointer to extra graph info */
331 rrd_info_t *grinfo_current; /* pointing to current entry */
343 enum gfx_if_en if_conv(
345 enum gfx_type_en type_conv(
347 enum tmt_en tmt_conv(
349 enum grc_en grc_conv(
351 enum text_prop_en text_prop_conv(
379 long find_var_wrapper(
388 time_t find_first_time(
392 time_t find_next_time(
401 int calc_horizontal_grid(
403 int draw_horizontal_grid(
405 int horizontal_log_grid(
417 int graph_paint_timestring(
418 image_desc_t *,int,int);
420 image_desc_t *,int,int);
424 int graph_cairo_setup(
426 int graph_cairo_finish(
442 void rrd_graph_options(
446 void rrd_graph_script(
459 struct graph_desc_t *,
464 int vdef_percent_compar(
467 int graph_size_location(
472 /* create a new line */
482 void gfx_dashed_line(
493 /* create a new area */
504 /* add a point to a line or to an area */
510 /* create a rect that has a gradient from color1 to color2 in height pixels
512 * gradient starts at top and goes down a fixed number of pixels (fire style)
514 * gradient starts at bottom and goes up a fixed number of pixels (constant style)
516 * gradient is stretched between two points
518 void gfx_add_rect_fadey(
529 /* close current path so it ends at the same point as it started */
534 /* create a text node */
540 PangoFontDescription *font_desc,
543 enum gfx_h_align_en h_align,
544 enum gfx_v_align_en v_align,
547 /* measure width of a text string */
548 double gfx_get_text_width(
551 PangoFontDescription *font_desc,
557 gfx_color_t gfx_hex_to_col(
575 rrd_info_type_t type, rrd_infoval_t value);