libtpcsvg.h

Go to the documentation of this file.

 
#ifndef _LIBTPCSVG_H
#define _LIBTPCSVG_H
/*****************************************************************************/
 
/*****************************************************************************/
#include "tpcclibConfig.h"
/*****************************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <math.h>
#include <time.h>
/*****************************************************************************/
 
/*****************************************************************************/
#define SVG_VIEWPORT_WIDTH 10000
#define SVG_VIEWPORT_HEIGHT 10000
#define MAX_TICK_NR 12
#define MAX_TICK_LABEL_LEN 20
#define MAX_SVG_LEGEND_LEN 30
/*****************************************************************************/
 
/*****************************************************************************/
/* axis */
int axis_tick_positions(
  const double begin, const double end, double *ticks, int *tick_nr, 
  double *scale_factor, int *tick_decimals, int verbose
);
void axis_check_range(double *begin, double *end, int verbose);
void strRmExpZeroes(char *str);
/*****************************************************************************/
 
/*****************************************************************************/
typedef enum {RECTANGLE,CIRCLE,UPTRIANGLE,DOWNTRIANGLE,DIAMOND,
              LEFTTRIANGLE,RIGHTTRIANGLE} svgSymbolType;
typedef enum {SYMBOLOPEN,SYMBOLFILLED} svgSymbolFill;
typedef enum {BLACK,RED,BLUE,GREEN,PURPLE,OLIVE,AQUA,FUCHSIA,GRAY,LIME,MAROON,
              NAVY,SILVER,TEAL,YELLOW} svgColor;
/*****************************************************************************/
struct svg_viewport_pos {
  int is;
  int x;
  int y;
  int w;
  int h;
  int chr_size;
};
 
struct svg_coord {
  double min;
  double max;
  double scale;
  double origo;
  int tick_nr;
  double tick[MAX_TICK_NR];
  double tickscale;
  int tick_decimals;
  char tick_label[MAX_TICK_NR][MAX_TICK_LABEL_LEN+1];
  int upper_margin;
  int fixed_min;
  int fixed_max;
};
struct svg_viewports {
  struct svg_viewport_pos main_viewport;
  struct svg_viewport_pos main_title_viewport;
  struct svg_viewport_pos yaxis_title_viewport;
  struct svg_viewport_pos xaxis_title_viewport;
  struct svg_viewport_pos label_area_viewport;
  struct svg_viewport_pos plot_area_viewport;
  struct svg_viewport_pos coordinate_area_viewport;
  struct svg_coord x;
  struct svg_coord y;
};
/*****************************************************************************/
typedef struct svg_legend {
  int plot_type;
  svgSymbolType symbol_type;
  svgSymbolFill symbol_fill;
  svgColor color;
  char text[MAX_SVG_LEGEND_LEN+1];
} SVG_LEGEND;
 
typedef struct svg_legends {
 
  int _init; 
 
  int n;
  SVG_LEGEND *l;
} SVG_LEGENDS;
/*****************************************************************************/
 
/*****************************************************************************/
/* svg_file.c */
extern FILE *svg_initiate(
  const char *filename, const double height, const double width, 
  struct svg_viewports *vp, char *errmsg, int verbose
);
extern int svg_close(
  FILE *fp, char *errmsg, int verbose
);
extern FILE *svg_xhtml_initiate(
  const char *filename, const char *XHTML_title, char *errmsg, int verbose
);
extern int svg_xhtml_close(
  FILE *fp, char *errmsg, int verbose
);
extern int svg_xhtml_svg_open(
  FILE *fp, const double height, const double width, struct svg_viewports *vp,
  char *errmsg, int verbose
);
extern int svg_xhtml_svg_close(
  FILE *fp, char *errmsg, int verbose
);
extern int svg_write(
  FILE *fp, const char *svg_string, char *errmsg, int verbose
);
/*****************************************************************************/
/* svg_vport.c */
extern void svg_init_viewport_pos(struct svg_viewport_pos *p);
extern void svg_init_coord(struct svg_coord *p);
extern void svg_init_viewports(struct svg_viewports *p);
extern int svg_define_viewports(
  const int main_viewport_width, const int main_viewport_height,
  const int is_main_title, const int is_yaxis_title, const int is_xaxis_title, 
  const int is_label_area, struct svg_viewports *vp, int verbose
);
/*****************************************************************************/
/* svg_plot.c */
extern int svg_start_plot_viewport(
  FILE *fp, struct svg_viewports *vp, char *errmsg, int verbose
);
extern int svg_end_plot_viewport(
  FILE *fp, /*struct svg_viewports *vp,*/ char *errmsg, int verbose
);
extern int svg_start_coordinate_viewport(
  FILE *fp, struct svg_viewports *vp, char *errmsg, int verbose
);
extern int svg_end_coordinate_viewport(
  FILE *fp, char *errmsg, int verbose
);
extern int svg_calculate_axes(
  struct svg_viewports *vp, int verbose
);
extern int svg_write_axes(
  FILE *fp, struct svg_viewports *vp, char *errmsg, int verbose
);
extern int svg_write_xticks(
  FILE *fp, struct svg_viewports *vp, char *errmsg, int verbose
);
extern int svg_write_yticks(
  FILE *fp, struct svg_viewports *vp, char *errmsg, int verbose
);
extern int svg_write_tac(
  FILE *fp, struct svg_viewports *vp, const int plot_type, const char *tac_id, 
  const char *tac_title, double *x, double *y, const int data_nr, 
  const char *color, const svgSymbolType symbol_type, const svgSymbolFill symbol_fill,
  char *errmsg, int verbose
);
extern int get_line_intersection(
  const double a1x, const double a1y, const double a2x, const double a2y,
  const double b1x, const double b1y, const double b2x, const double b2y,
  double *ix, double *iy, int verbose
);
extern int check_intersection_with_viewport(
  const double x1, const double y1, const double x2, const double y2,
  struct svg_viewport_pos *cavp,
  double *nx1, double *ny1, double *nx2, double *ny2, int verbose
);
/*****************************************************************************/
/* svg_title.c */
extern int svg_create_main_title(
  FILE *fp, const char *main_title_text, const char *sub_title_text,
  struct svg_viewports *vp, char *errmsg, int verbose
);
extern int svg_create_xaxis_title(
  FILE *fp, const char *title_text, struct svg_viewports *vp,
  char *errmsg, int verbose
);
extern int svg_create_yaxis_title(
  FILE *fp, const char *title_text, struct svg_viewports *vp,
  char *errmsg, int verbose
);
/*****************************************************************************/
/* svg_defs.c */
extern int svg_define_symbols(FILE *fp, char *errmsg, int verbose);
extern char *svgColorName(const svgColor index);
extern char *svgSymbolName(const svgSymbolType index);
/*****************************************************************************/
/* svg_legend.c */
extern void svg_init_legends(
  SVG_LEGENDS *legends
);
extern void svg_legend_empty(
  SVG_LEGENDS *legends
);
extern int svg_legend_add(
  SVG_LEGENDS *legends, const int plot_type, const int symbol_type, const svgSymbolFill symbol_fill, 
  const int color, const char *text
);
extern int svg_create_legends(
  FILE *fp, struct svg_viewports *vp, SVG_LEGENDS *legends,
  char *errmsg, int verbose
);
extern char *svg_str_encode(
  const char *s
);
/*****************************************************************************/
 
/*****************************************************************************/
#endif // _LIBTPCSVG_H