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