From 79e1d494ec1a5f1dd6f7a8ea72c293c456c4389a Mon Sep 17 00:00:00 2001 From: msweet Date: Wed, 28 May 2008 23:38:36 +0000 Subject: [PATCH] Merge changes from CUPS 1.4svn-r7617. git-svn-id: svn+ssh://src.apple.com/svn/cups/easysw/current@793 a1ca3aef-8c08-0410-bb20-df032aa958be --- cgi-bin/help-index.c | 2 +- cgi-bin/help-index.h | 2 +- cups/api-array.shtml | 8 +- cups/api-filter.header | 6 +- cups/api-filter.shtml | 189 ++++++++++++++++++-- cups/api-ppd.header | 2 +- cups/api-ppd.shtml | 42 +++-- cups/array.c | 80 +++++++-- cups/backchannel.c | 17 +- cups/cups.h | 1 + cups/sidechannel.h | 6 +- doc/help/api-array.html | 112 +++++++++--- doc/help/api-filter.html | 222 +++++++++++++++++++---- doc/help/api-httpipp.html | 206 ++++++++++++++++------ doc/help/api-ppd.html | 62 +++++-- doc/help/api-raster.html | 349 ++++++++++++++++++++++++++----------- doc/help/cgi.html | 38 ++-- doc/help/options.html | 2 +- filter/raster.c | 16 +- filter/rastertolabel.c | 2 +- scheduler/main.c | 2 +- templates/header.tmpl.in | 3 +- templates/help-header.tmpl | 6 +- 23 files changed, 1048 insertions(+), 327 deletions(-) diff --git a/cgi-bin/help-index.c b/cgi-bin/help-index.c index 64f1380ac..f1d96832f 100644 --- a/cgi-bin/help-index.c +++ b/cgi-bin/help-index.c @@ -1,7 +1,7 @@ /* * "$Id: help-index.c 6649 2007-07-11 21:46:42Z mike $" * - * On-line help index routines for the Common UNIX Printing System (CUPS). + * Online help index routines for the Common UNIX Printing System (CUPS). * * Copyright 2007-2008 by Apple Inc. * Copyright 1997-2007 by Easy Software Products. diff --git a/cgi-bin/help-index.h b/cgi-bin/help-index.h index bbee9ca13..d92abbea2 100644 --- a/cgi-bin/help-index.h +++ b/cgi-bin/help-index.h @@ -1,7 +1,7 @@ /* * "$Id: help-index.h 6649 2007-07-11 21:46:42Z mike $" * - * On-line help index definitions for the Common UNIX Printing System (CUPS). + * Online help index definitions for the Common UNIX Printing System (CUPS). * * Copyright 2007 by Apple Inc. * Copyright 1997-2007 by Easy Software Products. diff --git a/cups/api-array.shtml b/cups/api-array.shtml index 92c540b09..ae2787fec 100644 --- a/cups/api-array.shtml +++ b/cups/api-array.shtml @@ -73,7 +73,7 @@ void *user_data;

The hash function (type -cups_ahash_func_t) returns a +cups_ahash_func_t) should return a number from 0 to (hash_size-1) that (hopefully) uniquely identifies the element and is called whenever you look up an element in the array with cupsArrayFind. The hash size is @@ -86,7 +86,7 @@ only limited by available memory, but generally should not be larger than The first function adds an element to the array, adding the new element after any elements that have the same order, while the second inserts the element before others with the same order. For unsorted arrays, -cupsArrayAdd appends the elemnt to +cupsArrayAdd appends the element to the end of the array while cupsArrayInsert inserts the element at the beginning of the array. For example, the following code @@ -139,11 +139,11 @@ future lookups will start where the last one left off:

cupsArrayFind: Returns the first matching element .; Returns the first matching element.
cupsArrayFirst: Returns the first element in the array.
cupsArrayIndex: Returns the Nth element in the array.; Returns the Nth element in the array, starting at 0.
cupsArrayLast: Returns the last element in the array.
cupsArrayNext
CRIT: message: Sets the printer-state-message attribute and adds the specified @@ -201,7 +210,8 @@ prefix strings:
ERROR: message: Sets the printer-state-message attribute and adds the specified - message to the current error log file using the "error" log level.
INFO: message: Sets the printer-state-message attribute. If the current log level @@ -227,8 +237,10 @@ prefix strings:
STATE: + printer-state-reason [printer-state-reason ...]
STATE: - printer-state-reason [printer-state-reason ...]: Sets, adds, or removes printer-state-reason keywords to the - current queue. Typically this is used to indicate media, ink, and - toner conditions on a printer.
WARNING: message: Sets the printer-state-message attribute and adds the specified @@ -240,6 +252,141 @@ prefix strings:

Messages without one of these prefixes are treated as if they began with the "DEBUG:" prefix string.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1: Standard marker-types Values
marker-type Description
developer Developer unit
fuser Fuser unit
fuserCleaningPad Fuser cleaning pad
fuserOil Fuser oil
ink Ink supply
opc Photo conductor
solidWax Wax supply
staples Staple supply
toner Toner supply
transferUnit Transfer unit
wasteInk Waste ink tank
wasteToner Waste toner tank
wasteWax Waste wax tank
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2: Standard State Keywords
Keyword Description
connecting-to-device Connecting to printer but not printing yet
cover-open A cover is open on the printer
input-tray-missing An input tray is missing from the printer
marker-supply-empty Out of ink
marker-supply-low Low on ink
marker-waste-almost-full Waste tank almost full
marker-waste-full Waste tank full
media-empty Out of media
media-jam Media is jammed in the printer
media-low Low on media
paused Stop the printer
timed-out Unable to connect to printer
toner-empty Out of toner
toner-low Low on toner
+
Communicating with the Backend

Filters can communicate with the backend via the @@ -261,7 +408,11 @@ ssize_t bytes; bytes = cupsBackChannelRead(buffer, sizeof(buffer), 0.0);

Table 1: Standard marker-types Values
marker-type	Description
developer	Developer unit
fuser	Fuser unit
fuserCleaningPad	Fuser cleaning pad
fuserOil	Fuser oil
ink	Ink supply
opc	Photo conductor
solidWax	Wax supply
staples	Staple supply
toner	Toner supply
transferUnit	Transfer unit
wasteInk	Waste ink tank
wasteToner	Waste toner tank
wasteWax	Waste wax tank

Table 2: Standard State Keywords
Keyword	Description
connecting-to-device	Connecting to printer but not printing yet
cover-open	A cover is open on the printer
input-tray-missing	An input tray is missing from the printer
marker-supply-empty	Out of ink
marker-supply-low	Low on ink
marker-waste-almost-full	Waste tank almost full
marker-waste-full	Waste tank full
media-empty	Out of media
media-jam	Media is jammed in the printer
media-low	Low on media
paused	Stop the printer
timed-out	Unable to connect to printer
toner-empty	Out of toner
toner-low	Low on toner

Return Value

Element

Discussion

The current element is undefined until you call cupsArrayFind, +cupsArrayFirst, or cupsArrayIndex, or cupsArrayLast. + +

CUPS 1.2 cupsArrayDelete

Free all memory used by the array.

@@ -570,6 +581,11 @@ void cupsArrayDelete (

Array

Discussion

The caller is responsible for freeing the memory used by the +elements themselves. + +

CUPS 1.2 cupsArrayDup

Duplicate the array.

@@ -611,7 +627,7 @@ void *cupsArrayFirst (

Array

Return Value

First element or NULL

First element or NULL if the array is empty

CUPS 1.3 cupsArrayGetIndex

Get the index of the current element.

@@ -624,7 +640,12 @@ int cupsArrayGetIndex (

Array

Return Value

Index of the current element

Index of the current element, starting at 0

Discussion

The current element is undefined until you call cupsArrayFind, +cupsArrayFirst, or cupsArrayIndex, or cupsArrayLast. + +

CUPS 1.3 cupsArrayGetInsert

Get the index of the last inserted element.

@@ -637,7 +658,7 @@ int cupsArrayGetInsert (

Array

Return Value

Index of the last inserted element

Index of the last inserted element, starting at 0

CUPS 1.2 cupsArrayIndex

Get the N-th element in the array.

@@ -672,8 +693,8 @@ int cupsArrayInsert (

0 on failure, 1 on success

Discussion

When inserting an element in a sorted array, non-unique elements are -inserted at the beginning of the run. For unsorted arrays, the element -is inserted at the beginning of the array. +inserted at the beginning of the run of identical elements. For unsorted +arrays, the element is inserted at the beginning of the array.

CUPS 1.2 cupsArrayLast

@@ -688,7 +709,7 @@ void *cupsArrayLast (

Array

Return Value

Last element or NULL

Last element or NULL if the array is empty

CUPS 1.2 cupsArrayNew

Create a new array.

@@ -699,12 +720,19 @@ void *cupsArrayLast (

Parameters

f: Comparison function; Comparison function or NULL for an unsorted array
d: User data; User data pointer or NULL

Return Value

Array

Discussion

The comparison function ("f") is used to create a sorted array. The function +receives pointers to two elements and the user data pointer ("d") - the user +data pointer argument can safely be omitted when not required so functions +like strcmp can be used for sorted string arrays. + +

CUPS 1.3 cupsArrayNew2

Create a new array with hash.

@@ -717,16 +745,26 @@ void *cupsArrayLast (

Parameters

f: Comparison function; Comparison function or NULL for an unsorted array
d: User data; User data or NULL
h: Hash function; Hash function or NULL for unhashed lookups
hsize: Hash size; Hash size (>= 0)

Return Value

Array

Discussion

CUPS 1.2 cupsArrayNext

Get the next element in the array.

@@ -740,6 +778,14 @@ void *cupsArrayNext (

Return Value

Next element or NULL

Discussion

This function is equivalent to "cupsArrayIndex(a, cupsArrayGetIndex(a) + 1)".
+
+The next element is undefined until you call cupsArrayFind, +cupsArrayFirst, or cupsArrayIndex, or cupsArrayLast +to set the current element. + +

CUPS 1.2 cupsArrayPrev

Get the previous element in the array.

@@ -753,6 +799,14 @@ void *cupsArrayPrev (

Return Value

Previous element or NULL

Discussion

This function is equivalent to "cupsArrayIndex(a, cupsArrayGetIndex(a) - 1)".
+
+The previous element is undefined until you call cupsArrayFind, +cupsArrayFirst, or cupsArrayIndex, or cupsArrayLast +to set the current element. + +

CUPS 1.2 cupsArrayRemove

Remove an element from the array.

@@ -769,8 +823,16 @@ int cupsArrayRemove (

Return Value

1 on success, 0 on failure

Discussion

If more than one element matches "e", only the first matching element is +removed.
+
+The caller is responsible for freeing the memory used by the +removed element. + +

CUPS 1.2 cupsArrayRestore

Reset the current element to the last cupsArraySave.

Reset the current element to the last cupsArraySave.

void *cupsArrayRestore (
cups_array_t *a
@@ -783,7 +845,7 @@ void *cupsArrayRestore (

Return Value

New current element

CUPS 1.2 cupsArraySave

Mark the current element for a later cupsArrayRestore.

Mark the current element for a later cupsArrayRestore.

int cupsArraySave (
cups_array_t *a
@@ -796,7 +858,11 @@ int cupsArraySave (

Return Value

1 on success, 0 on failure

Discussion

The save/restore stack is guaranteed to be at least 32 elements deep. +

The current element is undefined until you call cupsArrayFind, +cupsArrayFirst, or cupsArrayIndex, or cupsArrayLast +to set the current element.
+
+The save/restore stack is guaranteed to be at least 32 elements deep.

CUPS 1.2 cupsArrayUserData

diff --git a/doc/help/api-filter.html b/doc/help/api-filter.html index 279d18014..b645ec353 100644 --- a/doc/help/api-filter.html +++ b/doc/help/api-filter.html @@ -253,7 +253,7 @@ div.contents ul.subcontents li {

Discussion

CUPS 1.2 cupsArrayClear

Discussion

CUPS 1.2 cupsArrayCount

Return Value

Discussion

CUPS 1.2 cupsArrayDelete

Discussion

CUPS 1.2 cupsArrayDup

Return Value

CUPS 1.3 cupsArrayGetIndex

Return Value

Discussion

CUPS 1.3 cupsArrayGetInsert

Return Value

CUPS 1.2 cupsArrayIndex

Discussion

CUPS 1.2 cupsArrayLast

Return Value

CUPS 1.2 cupsArrayNew

Parameters

Return Value

Discussion

CUPS 1.3 cupsArrayNew2

Parameters

Return Value

Discussion

CUPS 1.2 cupsArrayNext

Return Value

Discussion

CUPS 1.2 cupsArrayPrev

Return Value

Discussion

CUPS 1.2 cupsArrayRemove

Return Value

Discussion

CUPS 1.2 cupsArrayRestore

Return Value

CUPS 1.2 cupsArraySave

Return Value

Discussion

CUPS 1.2 cupsArrayUserData