libgutenprint API Reference: util

libgutenprint API Reference 5.2.11

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

Macros | Functions
util

Utility functions. More...

## Macros
#define | STP_DBG_LUT 0x1
#define | STP_DBG_COLORFUNC 0x2
#define | STP_DBG_INK 0x4
#define | STP_DBG_PS 0x8
#define | STP_DBG_PCL 0x10
#define | STP_DBG_ESCP2 0x20
#define | STP_DBG_CANON 0x40
#define | STP_DBG_LEXMARK 0x80
#define | STP_DBG_WEAVE_PARAMS 0x100
#define | STP_DBG_ROWS 0x200
#define | STP_DBG_MARK_FILE 0x400
#define | STP_DBG_LIST 0x800
#define | STP_DBG_MODULE 0x1000
#define | STP_DBG_PATH 0x2000
#define | STP_DBG_PAPER 0x4000
#define | STP_DBG_PRINTERS 0x8000
#define | STP_DBG_XML 0x10000
#define | STP_DBG_VARS 0x20000
#define | STP_DBG_DYESUB 0x40000
#define | STP_DBG_CURVE 0x80000
#define | STP_DBG_CURVE_ERRORS 0x100000
#define | STP_DBG_PPD 0x200000
#define | STP_DBG_NO_COMPRESSION 0x400000
#define | STP_DBG_ASSERTIONS 0x800000
#define | STP_SAFE_FREE(x)

## Functions
int | stp_init (void)
| Initialise libgimpprint. More...
const char * | stp_set_output_codeset (const char *codeset)
| Set the output encoding. More...
stp_curve_t * | stp_read_and_compose_curves (const char *s1, const char *s2, stp_curve_compose_t comp, size_t piecewise_point_count)
void | stp_abort (void)
void | stp_prune_inactive_options (stp_vars_t *v)
void | stp_zprintf (const stp_vars_t *v, const char *format,...) __attribute__((format(__printf__
void void | stp_zfwrite (const char *buf, size_t bytes, size_t nitems, const stp_vars_t *v)
void | stp_write_raw (const stp_raw_t *raw, const stp_vars_t *v)
void | stp_putc (int ch, const stp_vars_t *v)
void | stp_put16_le (unsigned short sh, const stp_vars_t *v)
void | stp_put16_be (unsigned short sh, const stp_vars_t *v)
void | stp_put32_le (unsigned int sh, const stp_vars_t *v)
void | stp_put32_be (unsigned int sh, const stp_vars_t *v)
void | stp_puts (const char *s, const stp_vars_t *v)
void | stp_putraw (const stp_raw_t *r, const stp_vars_t *v)
void | stp_send_command (const stp_vars_t *v, const char *command, const char *format,...)
void | stp_erputc (int ch)
void | stp_eprintf (const stp_vars_t *v, const char *format,...) __attribute__((format(__printf__
void void | stp_erprintf (const char *format,...) __attribute__((format(__printf__
void void void | stp_asprintf (char **strp, const char *format,...) __attribute__((format(__printf__
void void void void | stp_catprintf (char **strp, const char *format,...) __attribute__((format(__printf__
unsigned long | stp_get_debug_level (void)
void | stp_dprintf (unsigned long level, const stp_vars_t *v, const char *format,...) __attribute__((format(__printf__
void void | stp_deprintf (unsigned long level, const char *format,...) __attribute__((format(__printf__
void void void | stp_init_debug_messages (stp_vars_t *v)
void | stp_flush_debug_messages (stp_vars_t *v)
void * | stp_malloc (size_t)
void * | stp_zalloc (size_t)
void * | stp_realloc (void *ptr, size_t)
void | stp_free (void *ptr)
size_t | stp_strlen (const char *s)
char * | stp_strndup (const char *s, int n)
char * | stp_strdup (const char *s)
const char * | stp_get_version (void)
| Get the library version string (x.y.z) More...
const char * | stp_get_release_version (void)
| Get the library release version string (x.y) More...

## Detailed Description

Utility functions.

## Macro Definition Documentation

#define STP_DBG_ASSERTIONS 0x800000

#define STP_DBG_CANON 0x40

#define STP_DBG_COLORFUNC 0x2

#define STP_DBG_CURVE 0x80000

#define STP_DBG_CURVE_ERRORS 0x100000

#define STP_DBG_DYESUB 0x40000

#define STP_DBG_ESCP2 0x20

#define STP_DBG_INK 0x4

#define STP_DBG_LEXMARK 0x80

#define STP_DBG_LIST 0x800

#define STP_DBG_LUT 0x1

#define STP_DBG_MARK_FILE 0x400

#define STP_DBG_MODULE 0x1000

#define STP_DBG_NO_COMPRESSION 0x400000

#define STP_DBG_PAPER 0x4000

#define STP_DBG_PATH 0x2000

#define STP_DBG_PCL 0x10

#define STP_DBG_PPD 0x200000

#define STP_DBG_PRINTERS 0x8000

#define STP_DBG_PS 0x8

#define STP_DBG_ROWS 0x200

#define STP_DBG_VARS 0x20000

#define STP_DBG_WEAVE_PARAMS 0x100

#define STP_DBG_XML 0x10000

#define STP_SAFE_FREE | ( |  | x | ) |

Value:
do \
{ \
if ((x)) \
stp_free((char *)(x)); \
((x)) = NULL; \
} while (0)

## Function Documentation

void stp_abort | ( | void |  | ) |

void void void stp_asprintf | ( | char ** | strp,
|  | const char * | format,
|  |  | ...
| ) |  |

void void void void stp_catprintf | ( | char ** | strp,
|  | const char * | format,
|  |  | ...
| ) |  |

void void stp_deprintf | ( | unsigned long | level,
|  | const char * | format,
|  |  | ...
| ) |  |

void stp_dprintf | ( | unsigned long | level,
|  | const stp_vars_t * | v,
|  | const char * | format,
|  |  | ...
| ) |  |

void stp_eprintf | ( | const stp_vars_t * | v,
|  | const char * | format,
|  |  | ...
| ) |  |

void void stp_erprintf | ( | const char * | format,
|  |  | ...
| ) |  |

void stp_erputc | ( | int | ch | ) |

void stp_flush_debug_messages | ( | stp_vars_t * | v | ) |

void stp_free | ( | void * | ptr | ) |

unsigned long stp_get_debug_level | ( | void |  | ) |

const char* stp_get_release_version | ( | void |  | ) |

Get the library release version string (x.y)

Returns
  a pointer to the release name of the package, which must not be modified or freed.

const char* stp_get_version | ( | void |  | ) |

Get the library version string (x.y.z)

Returns
  a pointer to the version name of the package, which must not be modified or freed.

int stp_init | ( | void |  | ) |

Initialise libgimpprint.

This function must be called prior to any other use of the library. It is responsible for loading modules and XML data and initialising internal data structures.

Returns
  0 on success, 1 on failure.

void void void stp_init_debug_messages | ( | stp_vars_t * | v | ) |

void* stp_malloc | ( | size_t |  | ) |

void stp_prune_inactive_options | ( | stp_vars_t * | v | ) |

void stp_put16_be | ( | unsigned short | sh,
|  | const stp_vars_t * | v
| ) |  |

void stp_put16_le | ( | unsigned short | sh,
|  | const stp_vars_t * | v
| ) |  |

void stp_put32_be | ( | unsigned int | sh,
|  | const stp_vars_t * | v
| ) |  |

void stp_put32_le | ( | unsigned int | sh,
|  | const stp_vars_t * | v
| ) |  |

void stp_putc | ( | int | ch,
|  | const stp_vars_t * | v
| ) |  |

void stp_putraw | ( | const stp_raw_t * | r,
|  | const stp_vars_t * | v
| ) |  |

void stp_puts | ( | const char * | s,
|  | const stp_vars_t * | v
| ) |  |

stp_curve_t* stp_read_and_compose_curves | ( | const char * | s1,
|  | const char * | s2,
|  | stp_curve_compose_t | comp,
|  | size_t | piecewise_point_count
| ) |  |

void* stp_realloc | ( | void * | ptr,
|  | size_t |
| ) |  |

void stp_send_command | ( | const stp_vars_t * | v,
|  | const char * | command,
|  | const char * | format,
|  |  | ...
| ) |  |

const char* stp_set_output_codeset | ( | const char * | codeset | ) |

Set the output encoding.

This function sets the encoding that all strings translated by gettext are output in. It is a wrapper around the gettext bind_textdomain_codeset() function.

Parameters

  codeset | the standard name of the encoding, which must be usable with iconv_open(). For example, "US-ASCII" or "UTF-8". If NULL, the currently-selected codeset will be returned (or NULL if no codeset has been selected yet).

Returns
  a string containing the selected codeset, or NULL on failure (errno is set accordingly).

char* stp_strdup | ( | const char * | s | ) |

size_t stp_strlen | ( | const char * | s | ) |

char* stp_strndup | ( | const char * | s,
|  | int | n
| ) |  |

void stp_write_raw | ( | const stp_raw_t * | raw,
|  | const stp_vars_t * | v
| ) |  |

void* stp_zalloc | ( | size_t |  | ) |

void void stp_zfwrite | ( | const char * | buf,
|  | size_t | bytes,
|  | size_t | nitems,
|  | const stp_vars_t * | v
| ) |  |

void stp_zprintf | ( | const stp_vars_t * | v,
|  | const char * | format,
|  |  | ...
| ) |  |