0f9079a15c434d4b40f491ee4d7dab6e1baee2f2
1 #ifndef _RRD_GRAPH_H
2 #define _RRD_GRAPH_H
4 #include "rrd_tool.h"
5 #include "rrd_rpncalc.h"
6 #include "rrd_gfx.h"
8 #define MAX_VNAME_LEN 29
9 #define DEF_NAM_FMT "%29[_A-Za-z0-9]"
11 #define ALTYGRID 0x01 /* use alternative y grid algorithm */
12 #define ALTAUTOSCALE 0x02 /* use alternative algorithm to find lower and upper bounds */
13 #define ALTAUTOSCALE_MAX 0x04 /* use alternative algorithm to find upper bounds */
14 #define NOLEGEND 0x08 /* use no legend */
17 enum tmt_en {TMT_SECOND=0,TMT_MINUTE,TMT_HOUR,TMT_DAY,
18 TMT_WEEK,TMT_MONTH,TMT_YEAR};
20 enum grc_en {GRC_CANVAS=0,GRC_BACK,GRC_SHADEA,GRC_SHADEB,
21 GRC_GRID,GRC_MGRID,GRC_FONT,GRC_FRAME,GRC_ARROW,__GRC_END__};
23 #define MGRIDWIDTH 0.6
24 #define GRIDWIDTH 0.4
26 enum gf_en {GF_PRINT=0,GF_GPRINT,GF_COMMENT,GF_HRULE,GF_VRULE,GF_LINE,
27 GF_AREA,GF_STACK,GF_TICK,
28 GF_DEF, GF_CDEF, GF_VDEF,
29 GF_PART, GF_XPORT};
31 enum vdef_op_en {
32 VDEF_MAXIMUM /* like the MAX in (G)PRINT */
33 ,VDEF_MINIMUM /* like the MIN in (G)PRINT */
34 ,VDEF_AVERAGE /* like the AVERAGE in (G)PRINT */
35 ,VDEF_PERCENT /* Nth percentile */
36 ,VDEF_TOTAL /* average multiplied by time */
37 ,VDEF_FIRST /* first non-unknown value and time */
38 ,VDEF_LAST /* last non-unknown value and time */
39 };
40 enum text_prop_en { TEXT_PROP_DEFAULT=0, /* default settings */
41 TEXT_PROP_TITLE, /* properties for the title */
42 TEXT_PROP_AXIS, /* for the numbers next to the axis */
43 TEXT_PROP_UNIT, /* for the vertical unit description */
44 TEXT_PROP_LEGEND, /* fot the legend below the graph */
45 TEXT_PROP_LAST };
47 typedef struct text_prop_t {
48 double size;
49 char * font;
50 } text_prop_t;
53 typedef struct vdef_t {
54 enum vdef_op_en op;
55 double param; /* parameter for function, if applicable */
56 double val; /* resulting value */
57 time_t when; /* timestamp, if applicable */
58 } vdef_t;
60 typedef struct xlab_t {
61 long minsec; /* minimum sec per pix */
62 enum tmt_en gridtm; /* grid interval in what ?*/
63 long gridst; /* how many whats per grid*/
64 enum tmt_en mgridtm; /* label interval in what ?*/
65 long mgridst; /* how many whats per label*/
66 enum tmt_en labtm; /* label interval in what ?*/
67 long labst; /* how many whats per label*/
68 long precis; /* label precision -> label placement*/
69 char *stst; /* strftime string*/
70 } xlab_t;
72 typedef struct ygrid_scale_t { /* y axis grid scaling info */
73 double gridstep;
74 int labfact;
75 char labfmt[64];
76 } ygrid_scale_t;
78 /* sensible y label intervals ...*/
80 typedef struct ylab_t {
81 double grid; /* grid spacing */
82 int lfac[4]; /* associated label spacing*/
83 } ylab_t;
86 /* this structure describes the elements which can make up a graph.
87 because they are quite diverse, not all elements will use all the
88 possible parts of the structure. */
89 #ifdef HAVE_SNPRINTF
90 #define FMT_LEG_LEN 200
91 #else
92 #define FMT_LEG_LEN 2000
93 #endif
95 typedef struct graph_desc_t {
96 enum gf_en gf; /* graphing function */
97 int stack; /* boolean */
98 int debug; /* boolean */
99 char vname[MAX_VNAME_LEN+1]; /* name of the variable */
100 long vidx; /* gdes reference */
101 char rrd[255]; /* name of the rrd_file containing data */
102 char ds_nam[DS_NAM_SIZE]; /* data source name */
103 long ds; /* data source number */
104 enum cf_en cf; /* consolidation function */
105 gfx_color_t col; /* graph color */
106 char format[FMT_LEG_LEN+5]; /* format for PRINT AND GPRINT */
107 char legend[FMT_LEG_LEN+5]; /* legend*/
108 double leg_x,leg_y; /* location of legend */
109 double yrule; /* value for y rule line and for VDEF */
110 time_t xrule; /* time for x rule line and for VDEF */
111 vdef_t vf; /* instruction for VDEF function */
112 rpnp_t *rpnp; /* instructions for CDEF function */
114 /* description of data fetched for the graph element */
115 time_t start,end; /* timestaps for first and last data element */
116 unsigned long step; /* time between samples */
117 unsigned long ds_cnt; /* how many data sources are there in the fetch */
118 long data_first; /* first pointer to this data */
119 char **ds_namv; /* name of datasources in the fetch. */
120 rrd_value_t *data; /* the raw data drawn from the rrd */
121 rrd_value_t *p_data; /* processed data, xsize elments */
122 double linewidth; /* linewideth */
123 } graph_desc_t;
125 typedef struct image_desc_t {
127 /* configuration of graph */
129 char graphfile[MAXPATH]; /* filename for graphic */
130 long xsize,ysize,piesize; /* graph area size in pixels */
131 gfx_color_t graph_col[__GRC_END__]; /* real colors for the graph */
132 text_prop_t text_prop[TEXT_PROP_LAST]; /* text properties */
133 char ylegend[200]; /* legend along the yaxis */
134 char title[200]; /* title for graph */
135 int draw_x_grid; /* no x-grid at all */
136 int draw_y_grid; /* no x-grid at all */
137 double grid_dash_on, grid_dash_off;
138 xlab_t xlab_user; /* user defined labeling for xaxis */
139 char xlab_form[200]; /* format for the label on the xaxis */
141 double ygridstep; /* user defined step for y grid */
142 int ylabfact; /* every how many y grid shall a label be written ? */
143 double tabwidth; /* tabwdith */
144 time_t start,end; /* what time does the graph cover */
145 unsigned long step; /* any preference for the default step ? */
146 rrd_value_t minval,maxval; /* extreme values in the data */
147 int rigid; /* do not expand range even with
148 values outside */
149 ygrid_scale_t ygrid_scale; /* calculated y axis grid info */
150 int gridfit; /* adjust y-axis range etc so all
151 grindlines falls in integer pixel values */
152 char* imginfo; /* construct an <IMG ... tag and return
153 as first retval */
154 int lazy; /* only update the image if there is
155 reasonable probablility that the
156 existing one is out of date */
157 int logarithmic; /* scale the yaxis logarithmic */
159 /* status information */
161 long xorigin,yorigin;/* where is (0,0) of the graph */
162 long pie_x,pie_y; /* where is the centerpoint */
163 long ximg,yimg; /* total size of the image */
164 double magfact; /* numerical magnitude*/
165 long base; /* 1000 or 1024 depending on what we graph */
166 char symbol; /* magnitude symbol for y-axis */
167 int unitsexponent; /* 10*exponent for units on y-asis */
168 int extra_flags; /* flags for boolean options */
169 /* data elements */
171 long prt_c; /* number of print elements */
172 long gdes_c; /* number of graphics elements */
173 graph_desc_t *gdes; /* points to an array of graph elements */
174 gfx_canvas_t *canvas; /* graphics library */
175 } image_desc_t;
177 /* Prototypes */
178 int xtr(image_desc_t *,time_t);
179 double ytr(image_desc_t *, double);
180 enum gf_en gf_conv(char *);
181 enum gfx_if_en if_conv(char *);
182 enum tmt_en tmt_conv(char *);
183 enum grc_en grc_conv(char *);
184 enum grc_en text_prop_conv(char *);
185 int im_free(image_desc_t *);
186 void auto_scale( image_desc_t *, double *, char **, double *);
187 void si_unit( image_desc_t *);
188 void expand_range(image_desc_t *);
189 void apply_gridfit(image_desc_t *);
190 void reduce_data( enum cf_en, unsigned long, time_t *, time_t *, unsigned long *, unsigned long *, rrd_value_t **);
191 int data_fetch( image_desc_t *);
192 long find_var(image_desc_t *, char *);
193 long find_var_wrapper(void *arg1, char *key);
194 long lcd(long *);
195 int data_calc( image_desc_t *);
196 int data_proc( image_desc_t *);
197 time_t find_first_time( time_t, enum tmt_en, long);
198 time_t find_next_time( time_t, enum tmt_en, long);
199 int print_calc(image_desc_t *, char ***);
200 int leg_place(image_desc_t *);
201 int calc_horizontal_grid(image_desc_t *);
202 int draw_horizontal_grid(image_desc_t *);
203 int horizontal_log_grid(image_desc_t *);
204 void vertical_grid(image_desc_t *);
205 void axis_paint(image_desc_t *);
206 void grid_paint(image_desc_t *);
207 int lazy_check(image_desc_t *);
208 int graph_paint(image_desc_t *, char ***);
209 void pie_part(image_desc_t *, gfx_color_t, double, double, double, double, double);
210 int gdes_alloc(image_desc_t *);
211 int scan_for_col(char *, int, char *);
212 int rrd_graph(int, char **, char ***, int *, int *);
213 void rrd_graph_init(image_desc_t *);
214 void rrd_graph_options(int, char **, image_desc_t *);
215 void rrd_graph_script(int, char **, image_desc_t *);
216 int rrd_graph_check_vname(image_desc_t *, char *, char *);
217 int rrd_graph_color(image_desc_t *, char *, char *, int);
218 int rrd_graph_legend(graph_desc_t *, char *);
219 int bad_format(char *);
220 int vdef_parse(struct graph_desc_t *,char *);
221 int vdef_calc(image_desc_t *, int);
222 int vdef_percent_compar(const void *,const void *);
223 int graph_size_location(image_desc_t *, int, int);
225 #endif