Introduction

The CUPS PPD API provides...

General Usage

The <cups/ppd.h> header file must be included to use the ppd functions.

Programs using these functions must be linked to the CUPS library: libcups.a, libcups.so.2, libcups.2.dylib, libcups_s.a, or libcups2.lib depending on the platform. The following command compiles myprogram.c using GCC and the CUPS library:

gcc -o myprogram myprogram.c -lcups

Compatibility

Unless otherwise specified, the PPD API functions require CUPS 1.1 or higher.

Contents

• Enumerations
• Functions
• Structures
• Types
• Unions

Enumerations

• ppd_cs_e
• ppd_ext_ui_e  CUPS 1.2 
• ppd_section_e
• ppd_status_e
• ppd_ui_e

ppd_cs_e

Description

Colorspaces

Values

 CUPS 1.2 ppd_ext_ui_e

Description

Extended UI Types

Values

ppd_section_e

Description

Order dependency sections

Values

ppd_status_e

Description

Types and structures...

Values

ppd_ui_e

Description

UI Types

Values

Functions

• ppdClose()
• ppdCollect()
• ppdConflicts()
• ppdEmit()
• ppdEmitFd()
• ppdEmitJCL()
• ppdEmitJCLEnd()  CUPS 1.2 
• ppdErrorString()  CUPS 1.1.19 
• ppdFindAttr()  CUPS 1.1.19 
• ppdFindChoice()
• ppdFindMarkedChoice()
• ppdFindNextAttr()  CUPS 1.1.19 
• ppdFindOption()
• ppdIsMarked()
• ppdLastError()  CUPS 1.1.19 
• ppdMarkDefaults()
• ppdMarkOption()
• ppdOpen()
• ppdOpen2()  CUPS 1.2 
• ppdOpenFd()
• ppdOpenFile()
• ppdPageLength()
• ppdPageSize()
• ppdPageWidth()
• ppdSetConformance()  CUPS 1.1.20 

ppdClose()

Description

Free all memory used by the PPD file.

Syntax

void
ppdClose(
    ppd_file_t * ppd);

Arguments

Returns

Nothing.

ppdCollect()

Description

Collect all marked options that reside in the specified section.

Syntax

int
ppdCollect(
    ppd_file_t * ppd,
    ppd_section_t section,
    ppd_choice_t *** choices);

Arguments

Returns

Number of options marked

ppdConflicts()

Description

Check to see if there are any conflicts.

Syntax

int
ppdConflicts(
    ppd_file_t * ppd);

Arguments

Returns

Number of conflicts found

ppdEmit()

Description

Emit code for marked options to a file.

Syntax

int
ppdEmit(
    ppd_file_t * ppd,
    FILE * fp,
    ppd_section_t section);

Arguments

Returns

0 on success, -1 on failure

ppdEmitFd()

Description

Emit code for marked options to a file.

Syntax

int
ppdEmitFd(
    ppd_file_t * ppd,
    int fd,
    ppd_section_t section);

Arguments

Returns

0 on success, -1 on failure

ppdEmitJCL()

Description

Emit code for JCL options to a file.

Syntax

int
ppdEmitJCL(
    ppd_file_t * ppd,
    FILE * fp,
    int job_id,
    const char * user,
    const char * title);

Arguments

Returns

0 on success, -1 on failure

 CUPS 1.2 ppdEmitJCLEnd()

Description

Emit JCLEnd code to a file.

Syntax

int
ppdEmitJCLEnd(
    ppd_file_t * ppd,
    FILE * fp);

Arguments

Returns

0 on success, -1 on failure

 CUPS 1.1.19 ppdErrorString()

Description

Returns the text assocated with a status.

Syntax

const char *
ppdErrorString(
    ppd_status_t status);

Arguments

Returns

Status string

 CUPS 1.1.19 ppdFindAttr()

Description

Find the first matching attribute...

Syntax

ppd_attr_t *
ppdFindAttr(
    ppd_file_t * ppd,
    const char * name,
    const char * spec);

Arguments

Returns

Attribute or NULL if not found

ppdFindChoice()

Description

Return a pointer to an option choice.

Syntax

ppd_choice_t *
ppdFindChoice(
    ppd_option_t * o,
    const char * choice);

Arguments

Returns

Choice pointer or NULL

ppdFindMarkedChoice()

Description

Return the marked choice for the specified option.

Syntax

ppd_choice_t *
ppdFindMarkedChoice(
    ppd_file_t * ppd,
    const char * option);

Arguments

Returns

Pointer to choice or NULL

 CUPS 1.1.19 ppdFindNextAttr()

Description

Find the next matching attribute...

Syntax

ppd_attr_t *
ppdFindNextAttr(
    ppd_file_t * ppd,
    const char * name,
    const char * spec);

Arguments

Returns

Attribute or NULL if not found

ppdFindOption()

Description

Return a pointer to the specified option.

Syntax

ppd_option_t *
ppdFindOption(
    ppd_file_t * ppd,
    const char * option);

Arguments

Returns

Pointer to option or NULL

ppdIsMarked()

Description

Check to see if an option is marked...

Syntax

int
ppdIsMarked(
    ppd_file_t * ppd,
    const char * option,
    const char * choice);

Arguments

Returns

Non-zero if option is marked

 CUPS 1.1.19 ppdLastError()

Description

Return the status from the last ppdOpen*().

Syntax

ppd_status_t
ppdLastError(
    int * line);

Arguments

Returns

Status code

ppdMarkDefaults()

Description

Mark all default options in the PPD file.

Syntax

void
ppdMarkDefaults(
    ppd_file_t * ppd);

Arguments

Returns

Nothing.

ppdMarkOption()

Description

Mark an option in a PPD file. Notes: -1 is returned if the given option would conflict with any currently selected option.

Syntax

int
ppdMarkOption(
    ppd_file_t * ppd,
    const char * option,
    const char * choice);

Arguments

Returns

Number of conflicts

ppdOpen()

Description

Read a PPD file into memory.

Syntax

ppd_file_t *
ppdOpen(
    FILE * fp);

Arguments

Returns

PPD file record

 CUPS 1.2 ppdOpen2()

Description

Read a PPD file into memory.

Syntax

ppd_file_t *
ppdOpen2(
    cups_file_t * fp);

Arguments

Returns

PPD file record

ppdOpenFd()

Description

Read a PPD file into memory.

Syntax

ppd_file_t *
ppdOpenFd(
    int fd);

Arguments

Returns

PPD file record

ppdOpenFile()

Description

Read a PPD file into memory.

Syntax

ppd_file_t *
ppdOpenFile(
    const char * filename);

Arguments

Returns

PPD file record

ppdPageLength()

Description

Get the page length for the given size.

Syntax

float
ppdPageLength(
    ppd_file_t * ppd,
    const char * name);

Arguments

Returns

Length of page in points or 0.0

ppdPageSize()

Description

Get the page size record for the given size.

Syntax

ppd_size_t *
ppdPageSize(
    ppd_file_t * ppd,
    const char * name);

Arguments

Returns

Size record for page or NULL

ppdPageWidth()

Description

Get the page width for the given size.

Syntax

float
ppdPageWidth(
    ppd_file_t * ppd,
    const char * name);

Arguments

Returns

Width of page in points or 0.0

 CUPS 1.1.20 ppdSetConformance()

Description

Set the conformance level for PPD files.

Syntax

void
ppdSetConformance(
    ppd_conform_t c);

Arguments

Returns

Nothing.

Structures

• ppd_attr_str  CUPS 1.1.19 
• ppd_choice_str
• ppd_emul_str
• ppd_ext_option_str  CUPS 1.2 
• ppd_ext_param_str  CUPS 1.2 
• ppd_file_str
• ppd_group_str
• ppd_option_str
• ppd_profile_str
• ppd_size_str

 CUPS 1.1.19 ppd_attr_str

Description

PPD Attribute Structure

Definition

struct ppd_attr_str
{
  char name[PPD_MAX_NAME];
  char spec[PPD_MAX_NAME];
  char text[PPD_MAX_TEXT];
  char * value;
};

Members

ppd_choice_str

Description

Option choices

Definition

struct ppd_choice_str
{
  char choice[PPD_MAX_NAME];
  char * code;
  char marked;
  ppd_option_t * option;
  char text[PPD_MAX_TEXT];
};

Members

ppd_emul_str

Description

Emulators

Definition

struct ppd_emul_str
{
  char name[PPD_MAX_NAME];
  char * start;
  char * stop;
};

Members

 CUPS 1.2 ppd_ext_option_str

Description

Extended Options

Definition

struct ppd_ext_option_str
{
  char * code;
  char keyword[PPD_MAX_NAME];
  int marked;
  int num_params;
  ppd_option_t * option;
  ppd_ext_param_t ** params;
};

Members

 CUPS 1.2 ppd_ext_param_str

Description

Extended Parameter

Definition

struct ppd_ext_param_str
{
  ppd_ext_value_t * defval;
  char keyword[PPD_MAX_NAME];
  ppd_ext_value_t * maxval;
  ppd_ext_value_t * minval;
  char text[PPD_MAX_TEXT];
  ppd_ext_value_t * value;
};

Members

ppd_file_str

Description

Files

Definition

struct ppd_file_str
{
  int accurate_screens;
  ppd_attr_t ** attrs;
  int color_device;
  ppd_cs_t colorspace;
  ppd_const_t * consts;
  int contone_only;
  int cur_attr;
  float custom_margins[4];
  float custom_max[2];
  float custom_min[2];
  ppd_emul_t * emulations;
  ppd_ext_option_t ** extended;
  char ** filters;
  int flip_duplex;
  char ** fonts;
  ppd_group_t * groups;
  char * jcl_begin;
  char * jcl_end;
  char * jcl_ps;
  int landscape;
  char * lang_encoding;
  char * lang_version;
  int language_level;
  int manual_copies;
  char * manufacturer;
  int model_number;
  char * modelname;
  char * nickname;
  int num_attrs;
  int num_consts;
  int num_emulations;
  int num_extended;
  int num_filters;
  int num_fonts;
  int num_groups;
  int num_profiles;
  int num_sizes;
  char * patches;
  char * pcfilename;
  char * product;
  ppd_profile_t * profiles;
  char * protocols;
  char * shortnickname;
  ppd_size_t * sizes;
  int throughput;
  char * ttrasterizer;
  int variable_sizes;
};

Members

ppd_group_str

Description

Groups

Definition

struct ppd_group_str
{
  char text[PPD_MAX_TEXT - PPD_MAX_NAME];
  char name[PPD_MAX_NAME];
  int num_options;
  int num_subgroups;
  ppd_option_t * options;
  struct ppd_group_str * subgroups;
};

Members

ppd_option_str

Description

Options

Definition

struct ppd_option_str
{
  ppd_choice_t * choices;
  char conflicted;
  char defchoice[PPD_MAX_NAME];
  char keyword[PPD_MAX_NAME];
  int num_choices;
  float order;
  ppd_section_t section;
  char text[PPD_MAX_TEXT];
  ppd_ui_t ui;
};

Members

ppd_profile_str

Description

sRGB Color Profiles

Definition

struct ppd_profile_str
{
  float density;
  float gamma;
  float matrix[3][3];
  char media_type[PPD_MAX_NAME];
  char resolution[PPD_MAX_NAME];
};

Members

ppd_size_str

Description

Page Sizes

Definition

struct ppd_size_str
{
  float bottom;
  float left;
  float length;
  int marked;
  char name[PPD_MAX_NAME];
  float right;
  float top;
  float width;
};

Members

Types

• ppd_attr_t  CUPS 1.1.19 
• ppd_choice_t
• ppd_const_t
• ppd_emul_t
• ppd_ext_option_t  CUPS 1.2 
• ppd_ext_param_t  CUPS 1.2 
• ppd_ext_ui_t  CUPS 1.2 
• ppd_ext_value_t  CUPS 1.2 
• ppd_file_t
• ppd_group_t
• ppd_option_t
• ppd_profile_t
• ppd_section_t
• ppd_size_t
• ppd_ui_t

 CUPS 1.1.19 ppd_attr_t

Description

PPD Attribute Structure

Definition

typedef struct ppd_attr_str ppd_attr_t;

ppd_choice_t

Description

Option choices

Definition

typedef struct ppd_choice_str ppd_choice_t;

ppd_const_t

Description

Constraints

Definition

typedef struct ppd_const_t;

ppd_emul_t

Description

Emulators

Definition

typedef struct ppd_emul_str ppd_emul_t;

 CUPS 1.2 ppd_ext_option_t

Description

Extended Options

Definition

typedef struct ppd_ext_option_str ppd_ext_option_t;

 CUPS 1.2 ppd_ext_param_t

Description

Extended Parameter

Definition

typedef struct ppd_ext_param_str ppd_ext_param_t;

 CUPS 1.2 ppd_ext_ui_t

Description

Extended UI Types

Definition

typedef enum ppd_ext_ui_e ppd_ext_ui_t;

 CUPS 1.2 ppd_ext_value_t

Description

Extended Values

Definition

typedef union ppd_ext_value_u ppd_ext_value_t;

ppd_file_t

Description

Files

Definition

typedef struct ppd_file_str ppd_file_t;

ppd_group_t

Description

Groups

Definition

typedef struct ppd_group_str ppd_group_t;

ppd_option_t

Description

Options

Definition

typedef struct ppd_option_str ppd_option_t;

ppd_profile_t

Description

sRGB Color Profiles

Definition

typedef struct ppd_profile_str ppd_profile_t;

ppd_section_t

Description

Order dependency sections

Definition

typedef enum ppd_section_e ppd_section_t;

ppd_size_t

Description

Page Sizes

Definition

typedef struct ppd_size_str ppd_size_t;

ppd_ui_t

Description

UI Types

Definition

typedef enum ppd_ui_e ppd_ui_t;

Unions

• ppd_ext_value_u  CUPS 1.2 

 CUPS 1.2 ppd_ext_value_u

Description

Extended Values

Definition

union ppd_ext_value_u
{
  float gamma;
  int integer;
  float real;
  char * text;
};

Members