6 #define index cairo_index
8 /* this may configure __EXTENSIONS__ without which pango will fail to compile
10 #include "../rrd_config.h"
13 #include <cairo-pdf.h>
14 #include <cairo-svg.h>
17 #include <pango/pangocairo.h>
21 #include "rrd_rpncalc.h"
25 # define MAXPATH MAX_PATH
28 #define ALTYGRID 0x01 /* use alternative y grid algorithm */
29 #define ALTAUTOSCALE 0x02 /* use alternative algorithm to find lower and upper bounds */
30 #define ALTAUTOSCALE_MIN 0x04 /* use alternative algorithm to find lower bounds */
31 #define ALTAUTOSCALE_MAX 0x08 /* use alternative algorithm to find upper bounds */
32 #define NOLEGEND 0x10 /* use no legend */
33 #define NOMINOR 0x20 /* Turn off minor gridlines */
34 #define ONLY_GRAPH 0x40 /* use only graph */
35 #define FORCE_RULES_LEGEND 0x80 /* force printing of HRULE and VRULE legend */
37 #define FORCE_UNITS 0x100 /* mask for all FORCE_UNITS_* flags */
38 #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) */
40 #define FULL_SIZE_MODE 0x200 /* -width and -height indicate the total size of the image */
41 #define NO_RRDTOOL_TAG 0x400 /* disable the rrdtool tag */
43 enum tmt_en { TMT_SECOND = 0, TMT_MINUTE, TMT_HOUR, TMT_DAY,
44 TMT_WEEK, TMT_MONTH, TMT_YEAR
47 enum grc_en { GRC_CANVAS = 0, GRC_BACK, GRC_SHADEA, GRC_SHADEB,
48 GRC_GRID, GRC_MGRID, GRC_FONT, GRC_ARROW, GRC_AXIS, GRC_FRAME, __GRC_END__
51 #define MGRIDWIDTH 0.6
54 enum gf_en { GF_PRINT = 0, GF_GPRINT, GF_COMMENT, GF_HRULE, GF_VRULE, GF_LINE,
55 GF_AREA, GF_STACK, GF_TICK, GF_TEXTALIGN,
56 GF_DEF, GF_CDEF, GF_VDEF, GF_SHIFT,
60 enum txa_en { TXA_LEFT = 0, TXA_RIGHT, TXA_CENTER, TXA_JUSTIFIED };
63 VDEF_MAXIMUM = 0 /* like the MAX in (G)PRINT */
64 , VDEF_MINIMUM /* like the MIN in (G)PRINT */
65 , VDEF_AVERAGE /* like the AVERAGE in (G)PRINT */
66 , VDEF_STDEV /* the standard deviation */
67 , VDEF_PERCENT /* Nth percentile */
68 , VDEF_TOTAL /* average multiplied by time */
69 , VDEF_FIRST /* first non-unknown value and time */
70 , VDEF_LAST /* last non-unknown value and time */
71 , VDEF_LSLSLOPE /* least squares line slope */
72 , VDEF_LSLINT /* least squares line y_intercept */
73 , VDEF_LSLCORREL /* least squares line correlation coefficient */
74 , VDEF_PERCENTNAN /* Nth percentile ignoring NAN*/
77 TEXT_PROP_DEFAULT = 0, /* default settings */
78 TEXT_PROP_TITLE, /* properties for the title */
79 TEXT_PROP_AXIS, /* for the numbers next to the axis */
80 TEXT_PROP_UNIT, /* for the vertical unit description */
81 TEXT_PROP_LEGEND, /* for the legend below the graph */
82 TEXT_PROP_WATERMARK, /* for the little text to the side of the graph */
86 enum legend_pos{ NORTH = 0, WEST, SOUTH, EAST };
87 enum legend_direction { TOP_DOWN = 0, BOTTOM_UP };
89 enum gfx_if_en { IF_PNG = 0, IF_SVG, IF_EPS, IF_PDF };
90 enum gfx_en { GFX_LINE = 0, GFX_AREA, GFX_TEXT };
91 enum gfx_h_align_en { GFX_H_NULL = 0, GFX_H_LEFT, GFX_H_RIGHT, GFX_H_CENTER };
92 enum gfx_v_align_en { GFX_V_NULL = 0, GFX_V_TOP, GFX_V_BOTTOM, GFX_V_CENTER };
94 /* cairo color components */
95 typedef struct gfx_color_t {
103 typedef struct text_prop_t {
106 PangoFontDescription *font_desc;
110 typedef struct vdef_t {
112 double param; /* parameter for function, if applicable */
113 double val; /* resulting value */
114 time_t when; /* timestamp, if applicable */
117 typedef struct xlab_t {
118 long minsec; /* minimum sec per pix */
119 long length; /* number of secs on the image */
120 enum tmt_en gridtm; /* grid interval in what ? */
121 long gridst; /* how many whats per grid */
122 enum tmt_en mgridtm; /* label interval in what ? */
123 long mgridst; /* how many whats per label */
124 enum tmt_en labtm; /* label interval in what ? */
125 long labst; /* how many whats per label */
126 long precis; /* label precision -> label placement */
127 char *stst; /* strftime string */
130 typedef struct ygrid_scale_t { /* y axis grid scaling info */
136 /* sensible y label intervals ...*/
138 typedef struct ylab_t {
139 double grid; /* grid spacing */
140 int lfac[4]; /* associated label spacing */
143 /* this structure describes the elements which can make up a graph.
144 because they are quite diverse, not all elements will use all the
145 possible parts of the structure. */
147 #define FMT_LEG_LEN 200
149 #define FMT_LEG_LEN 2000
152 typedef struct graph_desc_t {
153 enum gf_en gf; /* graphing function */
154 int stack; /* boolean */
155 int debug; /* boolean */
156 char vname[MAX_VNAME_LEN + 1]; /* name of the variable */
157 long vidx; /* gdes reference */
158 char rrd[1024]; /* name of the rrd_file containing data */
159 char ds_nam[DS_NAM_SIZE]; /* data source name */
160 long ds; /* data source number */
161 enum cf_en cf; /* consolidation function */
162 enum cf_en cf_reduce; /* consolidation function for reduce_data() */
163 struct gfx_color_t col; /* graph color */
164 char format[FMT_LEG_LEN + 5]; /* format for PRINT AND GPRINT */
165 char legend[FMT_LEG_LEN + 5]; /* legend */
166 int strftm; /* should the VDEF legend be formated with strftime */
167 double leg_x, leg_y; /* location of legend */
168 double yrule; /* value for y rule line and for VDEF */
169 time_t xrule; /* time for x rule line and for VDEF */
170 vdef_t vf; /* instruction for VDEF function */
171 rpnp_t *rpnp; /* instructions for CDEF function */
173 /* SHIFT implementation */
174 int shidx; /* gdes reference for offset (-1 --> constant) */
175 time_t shval; /* offset if shidx is -1 */
176 time_t shift; /* current shift applied */
178 /* description of data fetched for the graph element */
179 time_t start, end; /* timestaps for first and last data element */
180 time_t start_orig, end_orig; /* timestaps for first and last data element */
181 unsigned long step; /* time between samples */
182 unsigned long step_orig; /* time between samples */
183 unsigned long ds_cnt; /* how many data sources are there in the fetch */
184 long data_first; /* first pointer to this data */
185 char **ds_namv; /* name of datasources in the fetch. */
186 rrd_value_t *data; /* the raw data drawn from the rrd */
187 rrd_value_t *p_data; /* processed data, xsize elments */
188 double linewidth; /* linewideth */
190 /* dashed line stuff */
191 int dash; /* boolean, draw dashed line? */
192 double *p_dashes; /* pointer do dash array which keeps the lengths of dashes */
193 int ndash; /* number of dash segments */
194 double offset; /* dash offset along the line */
196 enum txa_en txtalign; /* change default alignment strategy for text */
199 typedef struct image_desc_t {
201 /* configuration of graph */
203 char graphfile[MAXPATH]; /* filename for graphic */
204 long xsize, ysize; /* graph area size in pixels */
205 struct gfx_color_t graph_col[__GRC_END__]; /* real colors for the graph */
206 text_prop_t text_prop[TEXT_PROP_LAST]; /* text properties */
207 char ylegend[210]; /* legend along the yaxis */
208 char title[210]; /* title for graph */
209 char watermark[110]; /* watermark for graph */
210 int draw_x_grid; /* no x-grid at all */
211 int draw_y_grid; /* no y-grid at all */
212 unsigned int draw_3d_border; /* size of border in pixels, 0 for off */
213 double grid_dash_on, grid_dash_off;
214 xlab_t xlab_user; /* user defined labeling for xaxis */
215 char xlab_form[210]; /* format for the label on the xaxis */
216 double second_axis_scale; /* relative to the first axis (0 to disable) */
217 double second_axis_shift; /* how much is it shifted vs the first axis */
218 char second_axis_legend[210]; /* label to put on the seond axis */
219 char second_axis_format[210]; /* format for the numbers on the scond axis */
221 double ygridstep; /* user defined step for y grid */
222 int ylabfact; /* every how many y grid shall a label be written ? */
223 double tabwidth; /* tabwdith */
224 time_t start, end; /* what time does the graph cover */
225 unsigned long step; /* any preference for the default step ? */
226 rrd_value_t minval, maxval; /* extreme values in the data */
227 int rigid; /* do not expand range even with
229 ygrid_scale_t ygrid_scale; /* calculated y axis grid info */
230 int gridfit; /* adjust y-axis range etc so all
231 grindlines falls in integer pixel values */
232 char *imginfo; /* construct an <IMG ... tag and return
234 enum gfx_if_en imgformat; /* image format */
235 char *daemon_addr; /* rrdcached connection string */
236 int lazy; /* only update the image if there is
237 reasonable probablility that the
238 existing one is out of date */
239 int slopemode; /* connect the dots of the curve directly, not using a stair */
240 enum legend_pos legendposition; /* the position of the legend: north, west, south or east */
241 enum legend_direction legenddirection; /* The direction of the legend topdown or bottomup */
242 int logarithmic; /* scale the yaxis logarithmic */
243 double force_scale_min; /* Force a scale--min */
244 double force_scale_max; /* Force a scale--max */
246 /* status information */
248 long xorigin, yorigin; /* where is (0,0) of the graph */
249 long xOriginTitle, yOriginTitle; /* where is the origin of the title */
250 long xOriginLegendY, yOriginLegendY; /* where is the origin of the y legend */
251 long xOriginLegendY2, yOriginLegendY2; /* where is the origin of the second y legend */
252 long xOriginLegend, yOriginLegend; /* where is the origin of the legend */
253 long ximg, yimg; /* total size of the image */
254 long legendwidth, legendheight; /* the calculated height and width of the legend */
255 size_t rendered_image_size;
257 double magfact; /* numerical magnitude */
258 long base; /* 1000 or 1024 depending on what we graph */
259 char symbol; /* magnitude symbol for y-axis */
260 float viewfactor; /* how should the numbers on the y-axis be scaled for viewing ? */
261 int unitsexponent; /* 10*exponent for units on y-asis */
262 int unitslength; /* width of the yaxis labels */
263 int forceleftspace; /* do not kill the space to the left of the y-axis if there is no grid */
265 int extra_flags; /* flags for boolean options */
268 unsigned char *rendered_image;
269 long prt_c; /* number of print elements */
270 long gdes_c; /* number of graphics elements */
271 graph_desc_t *gdes; /* points to an array of graph elements */
272 cairo_surface_t *surface; /* graphics library */
273 cairo_t *cr; /* drawin context */
274 cairo_font_options_t *font_options; /* cairo font options */
275 cairo_antialias_t graph_antialias; /* antialiasing for the graph */
276 PangoLayout *layout; /* the pango layout we use for writing fonts */
277 rrd_info_t *grinfo; /* root pointer to extra graph info */
278 rrd_info_t *grinfo_current; /* pointing to current entry */
290 enum gfx_if_en if_conv(
292 enum tmt_en tmt_conv(
294 enum grc_en grc_conv(
296 enum text_prop_en text_prop_conv(
324 long find_var_wrapper(
333 time_t find_first_time(
337 time_t find_next_time(
346 int calc_horizontal_grid(
348 int draw_horizontal_grid(
350 int horizontal_log_grid(
372 void rrd_graph_options(
376 void rrd_graph_script(
389 struct graph_desc_t *,
394 int vdef_percent_compar(
397 int graph_size_location(
402 /* create a new line */
412 void gfx_dashed_line(
423 /* create a new area */
434 /* add a point to a line or to an area */
440 /* close current path so it ends at the same point as it started */
445 /* create a text node */
451 PangoFontDescription *font_desc,
454 enum gfx_h_align_en h_align,
455 enum gfx_v_align_en v_align,
458 /* measure width of a text string */
459 double gfx_get_text_width(
462 PangoFontDescription *font_desc,
468 gfx_color_t gfx_hex_to_col(
486 rrd_info_type_t type, rrd_infoval_t value);