pcb-printf.h

Go to the documentation of this file.

#ifndef PCB_PCB_PRINTF_H
#define PCB_PCB_PRINTF_H

enum e_allow {
  NO_PRINT = 0,         /* suffixes we can read but not print (i.e., "inch") */
  ALLOW_NM = 1,
  ALLOW_UM = 2,
  ALLOW_MM = 4,
  ALLOW_CM = 8,
  ALLOW_M  = 16,
  ALLOW_KM = 32,

  ALLOW_CMIL = 1024,
  ALLOW_DMIL = 2048,
  ALLOW_MIL  = 4096,
  ALLOW_IN   = 8192,

  ALLOW_METRIC   = ALLOW_NM | ALLOW_UM | ALLOW_MM |
                   ALLOW_CM | ALLOW_M  | ALLOW_KM,
  ALLOW_IMPERIAL = ALLOW_CMIL | ALLOW_DMIL | ALLOW_MIL | ALLOW_IN,
  /* This is all units allowed in parse_l.l */
#if 0
  ALLOW_READABLE = ALLOW_NM | ALLOW_UM | ALLOW_MM |
                   ALLOW_M  | ALLOW_KM | ALLOW_CMIL |
                   ALLOW_MIL | ALLOW_IN,
#else
  ALLOW_READABLE = ALLOW_MIL | ALLOW_MM,
#endif

  ALLOW_ALL = ~ALLOW_DMIL
};

enum e_family { METRIC, IMPERIAL };
enum e_suffix {
  NO_SUFFIX,                    
  SUFFIX,                       
  FILE_MODE_NO_SUFFIX,          
  FILE_MODE                     
};

struct unit {
  int index;                    
  const char *suffix;
  const char *in_suffix;        
  char printf_code;
  double scale_factor;
  enum e_family family;
  enum e_allow  allow;
  int default_prec;
  /* used for gui spinboxes */
  double step_tiny;
  double step_small;
  double step_medium;
  double step_large;
  double step_huge;
  /* aliases -- right now we only need 1 ("inch"->"in"), add as needed */
  const char *alias[1];
};

struct increments {
  const char *suffix;
  /* key g and <shift>g value  */
  Coord grid;
  Coord grid_min;
  Coord grid_max;
  /* key s and <shift>s value  */
  Coord size;
  Coord size_min;
  Coord size_max;
  /* key l and <shift>l value  */
  Coord line;
  Coord line_min;
  Coord line_max;
  /* key k and <shift>k value  */
  Coord clear;
  Coord clear_min;
  Coord clear_max;
};

void initialize_units();

const Unit *get_unit_struct (const char *suffix);
const Unit *get_unit_list (void);
int get_n_units (void);
double coord_to_unit (const Unit *, Coord);
Coord  unit_to_coord (const Unit *, double);
Increments *get_increments_struct (enum e_family family);
void copy_nonzero_increments (Increments *dst, const Increments *src);
enum e_allow set_allow_readable(enum e_allow new_mask);

int pcb_fprintf(FILE *f, const char *fmt, ...);
int pcb_snprintf(char *string, size_t size, const char *fmt, ...);
int pcb_printf(const char *fmt, ...);
char *pcb_g_strdup_printf(const char *fmt, ...);
gchar *pcb_vprintf(const char *fmt, va_list args);

#ifdef PCB_UNIT_TEST
void pcb_printf_register_tests ();
void pcb_printf_test_unit ();
void pcb_printf_test_printf ();
#endif

#endif