svg_file.c File Reference

File io for TPC SVG C library. More...

#include "libtpcsvg.h"

Go to the source code of this file.

Functions
FILE *	svg_initiate (const char *filename, const double height, const double width, struct svg_viewports *vp, char *errmsg, int verbose)
int	svg_close (FILE *fp, char *errmsg, int verbose)
FILE *	svg_xhtml_initiate (const char *filename, const char *XHTML_title, char *errmsg, int verbose)
int	svg_xhtml_close (FILE *fp, char *errmsg, int verbose)
int	svg_xhtml_svg_open (FILE *fp, const double height, const double width, struct svg_viewports *vp, char *errmsg, int verbose)
int	svg_xhtml_svg_close (FILE *fp, char *errmsg, int verbose)
int	svg_write (FILE *fp, const char *svg_string, char *errmsg, int verbose)

Variables
int	SVG_INLINE = 0

Detailed Description

File io for TPC SVG C library.

Author

Vesa Oikonen

Todo

If Inkscape, Gimp and Batik start to support plot data outside of viewport, then decide whether to write that data in SVG again. Embedded SVG in HTML5.

Definition in file svg_file.c.

Function Documentation

svg_close()

int svg_close	(	FILE *	fp,
		char *	errmsg,
		int	verbose )

Close SVG graphics file.

Returns

Returns 0 if successful, <>0 in case of error.

See also

svg_initiate

Parameters

fp	SVG graphics file pointer.
errmsg	Char pointer to string (at least of length 128) where possible error description is copied; set to NULL if not necessary.
verbose	Verbose level; if zero, then nothing is printed to stderr or stdout.

Definition at line 107 of file svg_file.c.

  {
  if(verbose>0) printf("%s(fp, errmsg, %d)\n", __func__, verbose);
 
  if(svg_write(fp, "</svg>\n", errmsg, verbose-5)!=0) {fclose(fp); return(1);}
  fflush(fp); fclose(fp);
  return(0);
}

Referenced by plot_fit_svg(), plot_fitrange_svg(), and plot_svg().

svg_initiate()

FILE * svg_initiate	(	const char *	filename,
		const double	height,
		const double	width,
		struct svg_viewports *	vp,
		char *	errmsg,
		int	verbose )

Initiate a new SVG graphics file.

If file with same name exists, it is overwritten without backup.

Returns

Returns pointer to the file if successful and NULL in case of an error.

See also

svg_close, svg_xhtml_initiate

Parameters

filename	File name for SVG graphics.
height	Plot height in cm; 0, if not predefined.
width	Plot width in cm; 0, if not predefined.
vp	Struct containing the viewport sizes.
errmsg	Char pointer to string (at least of length 128) where possible error description is copied; set to NULL if not necessary.
verbose	Verbose level; if zero, then nothing is printed to stderr or stdout.

Definition at line 22 of file svg_file.c.

  {
  FILE *fp;
  char tmp[1024], *cptr;
 
  if(verbose>0)
    printf("%s(%s, %g, %g, vp, errmsg, %d)\n", __func__, filename, height, width, verbose);
 
  /* Check input */
  if(filename==NULL || vp==NULL) return(NULL);
  if(vp->main_viewport.w<3 || vp->main_viewport.h<3) return(NULL);
 
  /* Open file for write */
  fp=fopen(filename, "w");
  if(fp==NULL) {
    if(errmsg!=NULL) strcpy(errmsg, "cannot open file for write");
    return(fp);
  }
 
  strcpy(tmp, "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n");
  //strcat(tmp, "<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\"\n");
  //strcat(tmp, " \"https://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n");
  strcat(tmp, "<svg version=\"1.1\" baseProfile=\"full\"\n");
  strcat(tmp, "     xmlns=\"https://www.w3.org/2000/svg\"\n");
  strcat(tmp, "     xmlns:xlink=\"https://www.w3.org/1999/xlink\"\n");
  strcat(tmp, "     xmlns:ev=\"https://www.w3.org/2001/xml-events\"");
  if(svg_write(fp, tmp, errmsg, verbose-5)!=0) {
    fclose(fp); remove(filename); return(NULL);}
 
  sprintf(tmp, "\n    viewBox=\"0 0 %d %d\"",
    vp->main_viewport.w, vp->main_viewport.h);
  strcat(tmp,  "\n    preserveAspectRatio=\"xMinYMin meet\"");
  if(svg_write(fp, tmp, errmsg, verbose-5)!=0) {
    fclose(fp); remove(filename); return(NULL);}
 
  if(width>0.0) {
    sprintf(tmp, "\n     width=\"%gcm\"", width);
    if(svg_write(fp, tmp, errmsg, verbose-5)!=0) {
      fclose(fp); remove(filename); return(NULL);}
  }
  if(height>0.0) {
    sprintf(tmp, "\n     height=\"%gcm\"", height);
    if(svg_write(fp, tmp, errmsg, verbose-5)!=0) {
      fclose(fp); remove(filename); return(NULL);}
  }
 
  strcpy(tmp, ">\n");
  if(svg_write(fp, tmp, errmsg, verbose-5)!=0) {
    fclose(fp); remove(filename); return(NULL);}
 
  /* Write file name as title element */
  cptr=strrchr(filename, '/'); if(cptr==NULL) cptr=strrchr(filename, '\\');
  if(cptr!=NULL) cptr++; else cptr=(char*)filename;
  if(cptr!=NULL) {
    sprintf(tmp, "  <title>%s</title>\n", cptr);
    if(svg_write(fp, tmp, errmsg, verbose-5)!=0) {
      fclose(fp); remove(filename); return(NULL);}
  }
 
  /* Create plot symbols for possible later use */
  if(svg_define_symbols(fp, errmsg, verbose)!=0) {
    fclose(fp); remove(filename); return(NULL);}
 
  return(fp);
}

Referenced by plot_fit_svg(), plot_fitrange_svg(), and plot_svg().

svg_write()

int svg_write	(	FILE *	fp,
		const char *	svg_string,
		char *	errmsg,
		int	verbose )

Write given string into open SVG file

Returns

Returns 0 if successful, <>0 in case of an error.

See also

svg_initiate, svg_xhtml_initiate, svg_xhtml_svg_open

Parameters

fp	SVG graphics file pointer.
svg_string	Char pointer to NULL terminated string to be written into file.
errmsg	Char pointer to string (at least of length 128) where possible error description is copied; set to NULL if not necessary.
verbose	Verbose level; if zero, then nothing is printed to stderr or stdout.

Definition at line 304 of file svg_file.c.

  {
  int pnr, len;
 
  if(verbose>0) printf("%s(fp, svg_string, errmsg, %d)\n", __func__, verbose);
  if(verbose>1) printf("svg_string := %s\n", svg_string);
 
  len=strlen(svg_string); if(len<1) return(0);
  if(fp==NULL) {
    if(errmsg!=NULL) sprintf(errmsg, "file was closed too early");
    return(1);
  }
  pnr=fprintf(fp, "%s", svg_string);
  if(pnr<len) {
    if(errmsg!=NULL) sprintf(errmsg, "cannot write into file");
    return(2);
  }
  return(0);
}

Referenced by svg_close(), svg_create_legends(), svg_create_main_title(), svg_create_xaxis_title(), svg_create_yaxis_title(), svg_define_symbols(), svg_end_coordinate_viewport(), svg_end_plot_viewport(), svg_initiate(), svg_start_coordinate_viewport(), svg_start_plot_viewport(), svg_write_axes(), svg_write_tac(), svg_write_xticks(), svg_write_yticks(), svg_xhtml_close(), svg_xhtml_initiate(), svg_xhtml_svg_close(), and svg_xhtml_svg_open().

svg_xhtml_close()

int svg_xhtml_close	(	FILE *	fp,
		char *	errmsg,
		int	verbose )

Close XHTML file containing inline SVG.

Returns

Returns 0 if successful, <>0 in case of error.

See also

svg_xhtml_initiate

Parameters

fp	SVG graphics file pointer.
errmsg	Char pointer to string (at least of length 128) where possible error description is copied; set to NULL if not necessary.
verbose	Verbose level; if zero, then nothing is printed to stderr or stdout.

Definition at line 206 of file svg_file.c.

  {
  if(verbose>0) printf("%s(fp, errmsg, %d)\n", __func__, verbose);
 
  if(svg_write(fp, "</body>\n</html>\n", errmsg, verbose-5)!=0) {fclose(fp); return(1);}
  fflush(fp); fclose(fp);
 
  SVG_INLINE = 0;
 
  return(0);
}

svg_xhtml_initiate()

FILE * svg_xhtml_initiate	(	const char *	filename,
		const char *	XHTML_title,
		char *	errmsg,
		int	verbose )

Initiate a new XHTML file for one or more inline SVG graphics files.

If file with same name exists, it is overwritten without backup.

Returns

Returns pointer to the file if successful and NULL in case of an error.

See also

svg_initiate, svg_xhtml_close, svg_xhtml_svg_open

Parameters

filename	File name for SVG graphics.
XHTML_title	XHTML title; if NULL, then file name is used.
errmsg	Char pointer to string (at least of length 128) where possible error description is copied; set to NULL if not necessary.
verbose	Verbose level; if zero, then nothing is printed to stderr or stdout.

Definition at line 131 of file svg_file.c.

  {
  FILE *fp;
  char tmp[2048], line[256];
 
  if(verbose>0)
    printf("%s(%s, %s, errmsg, %d)\n", __func__, filename, XHTML_title, verbose);
 
  SVG_INLINE = 1;
 
  /* Check input */
  if(filename==NULL) return(NULL);
  if(XHTML_title==NULL) XHTML_title=filename;
 
  /* Open file for write */
  fp=fopen(filename, "w");
  if(fp==NULL) {
    if(errmsg!=NULL) strcpy(errmsg, "cannot open file for write");
    return(fp);
  }
 
  strcpy(tmp, "<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n");
  if(svg_write(fp, tmp, errmsg, verbose-5)!=0) {
    fclose(fp); remove(filename); return(NULL);}
 
  strcpy(tmp, "<!DOCTYPE html PUBLIC\n");
  strcat(tmp, "     \"-//W3C//DTD XHTML 1.0 Strict//EN\"\n");
  strcat(tmp, "     \"https://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n");
  if(svg_write(fp, tmp, errmsg, verbose-5)!=0) {
    fclose(fp); remove(filename); return(NULL);}
 
  strcpy(tmp, "<html xmlns=\"https://www.w3.org/1999/xhtml\"\n");
  strcat(tmp, "     xmlns:svg=\"https://www.w3.org/2000/svg\"\n");
  strcat(tmp, "     xmlns:xlink=\"https://www.w3.org/1999/xlink\"\n");
  strcat(tmp, "     xmlns:ev=\"https://www.w3.org/2001/xml-events\"\n");
  strcat(tmp, "     xml:lang=\"en\" lang=\"en\">\n");
  if(svg_write(fp, tmp, errmsg, verbose-5)!=0) {
    fclose(fp); remove(filename); return(NULL);}
 
  strcpy(tmp,   "<head>\n");
  sprintf(line, "  <title>%s</title>\n", XHTML_title); strcat(tmp, line);
  sprintf(line, "  <meta http-equiv=\"content-type\" content=\"text/html; charset=iso-8859-1\" />\n"); strcat(tmp, line);
  sprintf(line, "  <meta http-equiv=\"content-language\" content=\"en-gb\" />\n"); strcat(tmp, line);
  strcat(tmp,   "  <object id=\"AdobeSVG\" classid=\"clsid:78156a80-c6a1-4bbf-8e6a-3cd390eeb4e2\"> </object>\n");
  strcat(tmp,   "  <?import namespace=\"svg\" urn=\"https://www.w3.org/2000/svg\" implementation=\"#AdobeSVG\"?>\n");
  strcat(tmp,   "</head>\n\n");
  if(svg_write(fp, tmp, errmsg, verbose-5)!=0) {
    fclose(fp); remove(filename); return(NULL);}
 
  strcpy(tmp, "<body>\n\n");
  if(svg_write(fp, tmp, errmsg, verbose-5)!=0) {
    fclose(fp); remove(filename); return(NULL);}
 
  /* Create plot symbols for possible later use */
  if(svg_define_symbols(fp, errmsg, verbose)!=0) {
    fclose(fp); remove(filename); return(NULL);}
 
  return(fp);
}

svg_xhtml_svg_close()

int svg_xhtml_svg_close	(	FILE *	fp,
		char *	errmsg,
		int	verbose )

Close SVG graphics inline in XHTML file. Leaves the file open.

Returns

Returns 0 if successful, <>0 in case of error.

See also

svg_xhtml_svg_open, svg_write

Parameters

fp	SVG graphics file pointer.
errmsg	Char pointer to string (at least of length 128) where possible error description is copied; set to NULL if not necessary.
verbose	Verbose level; if zero, then nothing is printed to stderr or stdout.

Definition at line 283 of file svg_file.c.

  {
  if(verbose>0) printf("%s(fp, errmsg, %d)\n", __func__, verbose);
 
  if(svg_write(fp, "</svg:svg>\n", errmsg, verbose-5)!=0) return(1);
  return(0);
}

svg_xhtml_svg_open()

int svg_xhtml_svg_open	(	FILE *	fp,
		const double	height,
		const double	width,
		struct svg_viewports *	vp,
		char *	errmsg,
		int	verbose )

Open a new SVG inline XHTML file.

Returns

Returns 0 if successful, <>0 in case of error.

See also

svg_xhtml_svg_close, svg_xhtml_initiate

Parameters

fp	SVG graphics file pointer.
height	Plot height in cm; 0, if not predefined.
width	Plot width in cm; 0, if not predefined.
vp	Struct containing the viewport sizes.
errmsg	Char pointer to string (at least of length 128) where possible error description is copied; set to NULL if not necessary.
verbose	Verbose level; if zero, then nothing is printed to stderr or stdout.

Definition at line 231 of file svg_file.c.

  {
  char tmp[1024];
 
  if(verbose>0)
    printf("%s(fp, %g, %g, vp, errmsg, %d)\n", __func__, height, width, verbose);
 
  /* Check input */
  if(fp==NULL || vp==NULL) return(1);
  if(vp->main_viewport.w<3 || vp->main_viewport.h<3) return(1);
 
  strcpy(tmp, "<svg:svg version=\"1.1\" baseProfile=\"full\"");
  if(svg_write(fp, tmp, errmsg, verbose-5)!=0) return(2);
 
  sprintf(tmp, "\n    viewBox=\"0 0 %d %d\"", vp->main_viewport.w, vp->main_viewport.h);
  strcat(tmp,  "\n    preserveAspectRatio=\"xMinYMin meet\"");
  if(svg_write(fp, tmp, errmsg, verbose-5)!=0) return(3);
 
  if(width>0.0) {
    sprintf(tmp, "\n     width=\"%gcm\"", width);
    if(svg_write(fp, tmp, errmsg, verbose-5)!=0) return(4);
  }
  if(height>0.0) {
    sprintf(tmp, "\n     height=\"%gcm\"", height);
    if(svg_write(fp, tmp, errmsg, verbose-5)!=0) return(5);
  }
 
  strcpy(tmp, ">\n");
  if(svg_write(fp, tmp, errmsg, verbose-5)!=0) return(6);
 
  return(0);
}

Variable Documentation

SVG_INLINE

int SVG_INLINE = 0

Write inline SVG (1) or separate SVG file (0)

Definition at line 12 of file svg_file.c.

Referenced by svg_create_legends(), svg_create_main_title(), svg_create_xaxis_title(), svg_create_yaxis_title(), svg_define_symbols(), svg_end_coordinate_viewport(), svg_end_plot_viewport(), svg_start_coordinate_viewport(), svg_start_plot_viewport(), svg_write_axes(), svg_write_tac(), svg_write_xticks(), svg_write_yticks(), svg_xhtml_close(), and svg_xhtml_initiate().