4 * PWG media name API implementation for CUPS.
6 * Copyright 2009-2013 by Apple Inc.
8 * These coded instructions, statements, and computer programs are the
9 * property of Apple Inc. and are protected by Federal copyright
10 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
11 * which should have been included with this file. If this file is
12 * file is missing or damaged, see the license at "http://www.cups.org/".
14 * This file is subject to the Apple OS-Developed Software exception.
18 * pwgFormatSizeName() - Generate a PWG self-describing media size name.
19 * pwgInitSize() - Initialize a pwg_size_t structure using IPP Job
20 * Template attributes.
21 * pwgMediaForLegacy() - Find a PWG media size by ISO/IPP legacy name.
22 * pwgMediaForPPD() - Find a PWG media size by Adobe PPD name.
23 * pwgMediaForPWG() - Find a PWG media size by 5101.1 self-describing
25 * pwgMediaForSize() - Get the PWG media size for the given
27 * _pwgMediaTable() - Return the internal media size table.
28 * pwg_compare_legacy() - Compare two sizes using the legacy names.
29 * pwg_compare_ppd() - Compare two sizes using the PPD names.
30 * pwg_compare_pwg() - Compare two sizes using the PWG names.
31 * pwg_format_inches() - Convert and format PWG units as inches.
32 * pwg_format_millimeters() - Convert and format PWG units as millimeters.
33 * pwg_scan_measurement() - Scan a measurement in inches or millimeters.
37 * Include necessary headers...
40 #include "cups-private.h"
48 #define _PWG_MEDIA_IN(p,l,a,x,y) {p, l, a, (int)(x * 2540), (int)(y * 2540)}
49 #define _PWG_MEDIA_MM(p,l,a,x,y) {p, l, a, (int)(x * 100), (int)(y * 100)}
56 static int pwg_compare_legacy(pwg_media_t
*a
, pwg_media_t
*b
);
57 static int pwg_compare_pwg(pwg_media_t
*a
, pwg_media_t
*b
);
58 static int pwg_compare_ppd(pwg_media_t
*a
, pwg_media_t
*b
);
59 static char *pwg_format_inches(char *buf
, size_t bufsize
, int val
);
60 static char *pwg_format_millimeters(char *buf
, size_t bufsize
, int val
);
61 static int pwg_scan_measurement(const char *buf
, char **bufptr
, int numer
,
69 static pwg_media_t
const cups_pwg_media
[] =
70 { /* Media size lookup table */
71 /* North American Standard Sheet Media Sizes */
72 _PWG_MEDIA_IN("na_index-3x5_3x5in", NULL
, "3x5", 3, 5),
73 _PWG_MEDIA_IN("na_personal_3.625x6.5in", NULL
, "EnvPersonal", 3.625, 6.5),
74 _PWG_MEDIA_IN("na_monarch_3.875x7.5in", "monarch-envelope", "EnvMonarch", 3.875, 7.5),
75 _PWG_MEDIA_IN("na_number-9_3.875x8.875in", "na-number-9-envelope", "Env9", 3.875, 8.875),
76 _PWG_MEDIA_IN("na_index-4x6_4x6in", NULL
, "4x6", 4, 6),
77 _PWG_MEDIA_IN("na_number-10_4.125x9.5in", "na-number-10-envelope", "Env10", 4.125, 9.5),
78 _PWG_MEDIA_IN("na_a2_4.375x5.75in", NULL
, "EnvA2", 4.375, 5.75),
79 _PWG_MEDIA_IN("na_number-11_4.5x10.375in", NULL
, "Env11", 4.5, 10.375),
80 _PWG_MEDIA_IN("na_number-12_4.75x11in", NULL
, "Env12", 4.75, 11),
81 _PWG_MEDIA_IN("na_5x7_5x7in", NULL
, "5x7", 5, 7),
82 _PWG_MEDIA_IN("na_index-5x8_5x8in", NULL
, "5x8", 5, 8),
83 _PWG_MEDIA_IN("na_number-14_5x11.5in", NULL
, "Env14", 5, 11.5),
84 _PWG_MEDIA_IN("na_invoice_5.5x8.5in", "invoice", "Statement", 5.5, 8.5),
85 _PWG_MEDIA_IN("na_index-4x6-ext_6x8in", NULL
, NULL
, 6, 8),
86 _PWG_MEDIA_IN("na_6x9_6x9in", "na-6x9-envelope", "6x9", 6, 9),
87 _PWG_MEDIA_IN("na_c5_6.5x9.5in", NULL
, "6.5x9.5", 6.5, 9.5),
88 _PWG_MEDIA_IN("na_7x9_7x9in", "na-7x9-envelope", "7x9", 7, 9),
89 _PWG_MEDIA_IN("na_executive_7.25x10.5in", "executive", "Executive", 7.25, 10.5),
90 _PWG_MEDIA_IN("na_govt-letter_8x10in", "na-8x10", "8x10", 8, 10),
91 _PWG_MEDIA_IN("na_govt-legal_8x13in", NULL
, "8x13", 8, 13),
92 _PWG_MEDIA_IN("na_quarto_8.5x10.83in", "quarto", "Quarto", 8.5, 10.83),
93 _PWG_MEDIA_IN("na_letter_8.5x11in", "na-letter", "Letter", 8.5, 11),
94 _PWG_MEDIA_IN("na_fanfold-eur_8.5x12in", NULL
, "FanFoldGerman", 8.5, 12),
95 _PWG_MEDIA_IN("na_letter-plus_8.5x12.69in", NULL
, "LetterPlus", 8.5, 12.69),
96 _PWG_MEDIA_IN("na_foolscap_8.5x13in", NULL
, "FanFoldGermanLegal", 8.5, 13),
97 _PWG_MEDIA_IN("na_oficio_8.5x13.4in", NULL
, "Oficio", 8.5, 13.4),
98 _PWG_MEDIA_IN("na_legal_8.5x14in", "na-legal", "Legal", 8.5, 14),
99 _PWG_MEDIA_IN("na_super-a_8.94x14in", NULL
, "SuperA", 8.94, 14),
100 _PWG_MEDIA_IN("na_9x11_9x11in", "na-9x11-envelope", "9x11", 9, 11),
101 _PWG_MEDIA_IN("na_arch-a_9x12in", "arch-a", "ARCHA", 9, 12),
102 _PWG_MEDIA_IN("na_letter-extra_9.5x12in", NULL
, "LetterExtra", 9.5, 12),
103 _PWG_MEDIA_IN("na_legal-extra_9.5x15in", NULL
, "LegalExtra", 9.5, 15),
104 _PWG_MEDIA_IN("na_10x11_10x11in", NULL
, "10x11", 10, 11),
105 _PWG_MEDIA_IN("na_10x13_10x13in", "na-10x13-envelope", "10x13", 10, 13),
106 _PWG_MEDIA_IN("na_10x14_10x14in", "na-10x14-envelope", "10x14", 10, 14),
107 _PWG_MEDIA_IN("na_10x15_10x15in", "na-10x15-envelope", "10x15", 10, 15),
108 _PWG_MEDIA_IN("na_11x12_11x12in", NULL
, "11x12", 11, 12),
109 _PWG_MEDIA_IN("na_edp_11x14in", NULL
, "11x14", 11, 14),
110 _PWG_MEDIA_IN("na_fanfold-us_11x14.875in", NULL
, NULL
, 11, 14.875),
111 _PWG_MEDIA_IN("na_11x15_11x15in", NULL
, "11x15", 11, 15),
112 _PWG_MEDIA_IN("na_ledger_11x17in", "tabloid", "Tabloid", 11, 17),
113 _PWG_MEDIA_IN("na_eur-edp_12x14in", NULL
, NULL
, 12, 14),
114 _PWG_MEDIA_IN("na_arch-b_12x18in", "arch-b", "ARCHB", 12, 18),
115 _PWG_MEDIA_IN("na_12x19_12x19in", NULL
, "12x19", 12, 19),
116 _PWG_MEDIA_IN("na_b-plus_12x19.17in", NULL
, "SuperB", 12, 19.17),
117 _PWG_MEDIA_IN("na_super-b_13x19in", "super-b", "13x19", 13, 19),
118 _PWG_MEDIA_IN("na_c_17x22in", "c", "AnsiC", 17, 22),
119 _PWG_MEDIA_IN("na_arch-c_18x24in", "arch-c", "ARCHC", 18, 24),
120 _PWG_MEDIA_IN("na_d_22x34in", "d", "AnsiD", 22, 34),
121 _PWG_MEDIA_IN("na_arch-d_24x36in", "arch-d", "ARCHD", 24, 36),
122 _PWG_MEDIA_IN("asme_f_28x40in", "f", NULL
, 28, 40),
123 _PWG_MEDIA_IN("na_wide-format_30x42in", NULL
, NULL
, 30, 42),
124 _PWG_MEDIA_IN("na_e_34x44in", "e", "AnsiE", 34, 44),
125 _PWG_MEDIA_IN("na_arch-e_36x48in", "arch-e", "ARCHE", 36, 48),
126 _PWG_MEDIA_IN("na_f_44x68in", NULL
, "AnsiF", 44, 68),
128 /* ISO Standard Sheet Media Sizes */
129 _PWG_MEDIA_MM("iso_a10_26x37mm", "iso-a10", "A10", 26, 37),
130 _PWG_MEDIA_MM("iso_a9_37x52mm", "iso-a9", "A9", 37, 52),
131 _PWG_MEDIA_MM("iso_a8_52x74mm", "iso-a8", "A8", 52, 74),
132 _PWG_MEDIA_MM("iso_a7_74x105mm", "iso-a7", "A7", 74, 105),
133 _PWG_MEDIA_MM("iso_a6_105x148mm", "iso-a6", "A6", 105, 148),
134 _PWG_MEDIA_MM("iso_a5_148x210mm", "iso-a5", "A5", 148, 210),
135 _PWG_MEDIA_MM("iso_a5-extra_174x235mm", NULL
, "A5Extra", 174, 235),
136 _PWG_MEDIA_MM("iso_a4_210x297mm", "iso-a4", "A4", 210, 297),
137 _PWG_MEDIA_MM("iso_a4-tab_225x297mm", NULL
, "A4Tab", 225, 297),
138 _PWG_MEDIA_MM("iso_a4-extra_235.5x322.3mm", NULL
, "A4Extra", 235.5, 322.3),
139 _PWG_MEDIA_MM("iso_a3_297x420mm", "iso-a3", "A3", 297, 420),
140 _PWG_MEDIA_MM("iso_a4x3_297x630mm", "iso-a4x3", NULL
, 297, 630),
141 _PWG_MEDIA_MM("iso_a4x4_297x841mm", "iso-a4x4", NULL
, 297, 841),
142 _PWG_MEDIA_MM("iso_a4x5_297x1051mm", "iso-a4x5", NULL
, 297, 1051),
143 _PWG_MEDIA_MM("iso_a4x6_297x1261mm", "iso-a4x6", NULL
, 297, 1261),
144 _PWG_MEDIA_MM("iso_a4x7_297x1471mm", "iso-a4x7", NULL
, 297, 1471),
145 _PWG_MEDIA_MM("iso_a4x8_297x1682mm", "iso-a4x8", NULL
, 297, 1682),
146 _PWG_MEDIA_MM("iso_a4x9_297x1892mm", "iso-a4x9", NULL
, 297, 1892),
147 _PWG_MEDIA_MM("iso_a3-extra_322x445mm", "iso-a3-extra", "A3Extra", 322, 445),
148 _PWG_MEDIA_MM("iso_a2_420x594mm", "iso-a2", "A2", 420, 594),
149 _PWG_MEDIA_MM("iso_a3x3_420x891mm", "iso-a3x3", NULL
, 420, 891),
150 _PWG_MEDIA_MM("iso_a3x4_420x1189mm", "iso-a3x4", NULL
, 420, 1189),
151 _PWG_MEDIA_MM("iso_a3x5_420x1486mm", "iso-a3x5", NULL
, 420, 1486),
152 _PWG_MEDIA_MM("iso_a3x6_420x1783mm", "iso-a3x6", NULL
, 420, 1783),
153 _PWG_MEDIA_MM("iso_a3x7_420x2080mm", "iso-a3x7", NULL
, 420, 2080),
154 _PWG_MEDIA_MM("iso_a1_594x841mm", "iso-a1", "A1", 594, 841),
155 _PWG_MEDIA_MM("iso_a2x3_594x1261mm", "iso-a2x3", NULL
, 594, 1261),
156 _PWG_MEDIA_MM("iso_a2x4_594x1682mm", "iso-a2x4", NULL
, 594, 1682),
157 _PWG_MEDIA_MM("iso_a2x5_594x2102mm", "iso-a2x5", NULL
, 594, 2102),
158 _PWG_MEDIA_MM("iso_a0_841x1189mm", "iso-a0", "A0", 841, 1189),
159 _PWG_MEDIA_MM("iso_a1x3_841x1783mm", "iso-a1x3", NULL
, 841, 1783),
160 _PWG_MEDIA_MM("iso_a1x4_841x2378mm", "iso-a1x4", NULL
, 841, 2378),
161 _PWG_MEDIA_MM("iso_2a0_1189x1682mm", NULL
, NULL
, 1189, 1682),
162 _PWG_MEDIA_MM("iso_a0x3_1189x2523mm", NULL
, NULL
, 1189, 2523),
163 _PWG_MEDIA_MM("iso_b10_31x44mm", "iso-b10", "ISOB10", 31, 44),
164 _PWG_MEDIA_MM("iso_b9_44x62mm", "iso-b9", "ISOB9", 44, 62),
165 _PWG_MEDIA_MM("iso_b8_62x88mm", "iso-b8", "ISOB8", 62, 88),
166 _PWG_MEDIA_MM("iso_b7_88x125mm", "iso-b7", "ISOB7", 88, 125),
167 _PWG_MEDIA_MM("iso_b6_125x176mm", "iso-b6", "ISOB6", 125, 176),
168 _PWG_MEDIA_MM("iso_b6c4_125x324mm", NULL
, NULL
, 125, 324),
169 _PWG_MEDIA_MM("iso_b5_176x250mm", "iso-b5", "ISOB5", 176, 250),
170 _PWG_MEDIA_MM("iso_b5-extra_201x276mm", NULL
, "ISOB5Extra", 201, 276),
171 _PWG_MEDIA_MM("iso_b4_250x353mm", "iso-b4", "ISOB4", 250, 353),
172 _PWG_MEDIA_MM("iso_b3_353x500mm", "iso-b3", "ISOB3", 353, 500),
173 _PWG_MEDIA_MM("iso_b2_500x707mm", "iso-b2", "ISOB2", 500, 707),
174 _PWG_MEDIA_MM("iso_b1_707x1000mm", "iso-b1", "ISOB1", 707, 1000),
175 _PWG_MEDIA_MM("iso_b0_1000x1414mm", "iso-b0", "ISOB0", 1000, 1414),
176 _PWG_MEDIA_MM("iso_c10_28x40mm", "iso-c10", NULL
, 28, 40),
177 _PWG_MEDIA_MM("iso_c9_40x57mm", "iso-c9", NULL
, 40, 57),
178 _PWG_MEDIA_MM("iso_c8_57x81mm", "iso-c8", NULL
, 57, 81),
179 _PWG_MEDIA_MM("iso_c7_81x114mm", "iso-c7", "EnvC7", 81, 114),
180 _PWG_MEDIA_MM("iso_c7c6_81x162mm", NULL
, NULL
, 81, 162),
181 _PWG_MEDIA_MM("iso_c6_114x162mm", "iso-c6", "EnvC6", 114, 162),
182 _PWG_MEDIA_MM("iso_c6c5_114x229mm", NULL
, "EnvC65", 114, 229),
183 _PWG_MEDIA_MM("iso_c5_162x229mm", "iso-c5", "EnvC5", 162, 229),
184 _PWG_MEDIA_MM("iso_c4_229x324mm", "iso-c4", "EnvC4", 229, 324),
185 _PWG_MEDIA_MM("iso_c3_324x458mm", "iso-c3", "EnvC3", 324, 458),
186 _PWG_MEDIA_MM("iso_c2_458x648mm", "iso-c2", "EnvC2", 458, 648),
187 _PWG_MEDIA_MM("iso_c1_648x917mm", "iso-c1", "EnvC1", 648, 917),
188 _PWG_MEDIA_MM("iso_c0_917x1297mm", "iso-c0", "EnvC0", 917, 1297),
189 _PWG_MEDIA_MM("iso_dl_110x220mm", "iso-designated", "EnvDL", 110, 220),
190 _PWG_MEDIA_MM("iso_ra4_215x305mm", "iso-ra4", NULL
, 215, 305),
191 _PWG_MEDIA_MM("iso_sra4_225x320mm", "iso-sra4", NULL
, 225, 320),
192 _PWG_MEDIA_MM("iso_ra3_305x430mm", "iso-ra3", NULL
, 305, 430),
193 _PWG_MEDIA_MM("iso_sra3_320x450mm", "iso-sra3", NULL
, 320, 450),
194 _PWG_MEDIA_MM("iso_ra2_430x610mm", "iso-ra2", NULL
, 430, 610),
195 _PWG_MEDIA_MM("iso_sra2_450x640mm", "iso-sra2", NULL
, 450, 640),
196 _PWG_MEDIA_MM("iso_ra1_610x860mm", "iso-ra1", NULL
, 610, 860),
197 _PWG_MEDIA_MM("iso_sra1_640x900mm", "iso-sra1", NULL
, 640, 900),
198 _PWG_MEDIA_MM("iso_ra0_860x1220mm", "iso-ra0", NULL
, 860, 1220),
199 _PWG_MEDIA_MM("iso_sra0_900x1280mm", "iso-sra0", NULL
, 900, 1280),
201 /* Japanese Standard Sheet Media Sizes */
202 _PWG_MEDIA_MM("jis_b10_32x45mm", "jis-b10", "B10", 32, 45),
203 _PWG_MEDIA_MM("jis_b9_45x64mm", "jis-b9", "B9", 45, 64),
204 _PWG_MEDIA_MM("jis_b8_64x91mm", "jis-b8", "B8", 64, 91),
205 _PWG_MEDIA_MM("jis_b7_91x128mm", "jis-b7", "B7", 91, 128),
206 _PWG_MEDIA_MM("jis_b6_128x182mm", "jis-b6", "B6", 128, 182),
207 _PWG_MEDIA_MM("jis_b5_182x257mm", "jis-b5", "B5", 182, 257),
208 _PWG_MEDIA_MM("jis_b4_257x364mm", "jis-b4", "B4", 257, 364),
209 _PWG_MEDIA_MM("jis_b3_364x515mm", "jis-b3", "B3", 364, 515),
210 _PWG_MEDIA_MM("jis_b2_515x728mm", "jis-b2", "B2", 515, 728),
211 _PWG_MEDIA_MM("jis_b1_728x1030mm", "jis-b1", "B1", 728, 1030),
212 _PWG_MEDIA_MM("jis_b0_1030x1456mm", "jis-b0", "B0", 1030, 1456),
213 _PWG_MEDIA_MM("jis_exec_216x330mm", NULL
, NULL
, 216, 330),
214 _PWG_MEDIA_MM("jpn_kaku2_240x332mm", NULL
, "EnvKaku2", 240, 332),
215 _PWG_MEDIA_MM("jpn_kaku3_216x277mm", NULL
, "EnvKaku3", 216, 277),
216 _PWG_MEDIA_MM("jpn_kaku4_197x267mm", NULL
, "EnvKaku4", 197, 267),
217 _PWG_MEDIA_MM("jpn_kaku5_190x240mm", NULL
, "EnvKaku5", 190, 240),
218 _PWG_MEDIA_MM("jpn_kaku7_142x205mm", NULL
, "EnvKaku7", 142, 205),
219 _PWG_MEDIA_MM("jpn_kaku8_119x197mm", NULL
, "EnvKaku8", 119, 197),
220 _PWG_MEDIA_MM("jpn_chou4_90x205mm", NULL
, "EnvChou4", 90, 205),
221 _PWG_MEDIA_MM("jpn_hagaki_100x148mm", NULL
, "Postcard", 100, 148),
222 _PWG_MEDIA_MM("jpn_you4_105x235mm", NULL
, "EnvYou4", 105, 235),
223 _PWG_MEDIA_MM("jpn_you6_98x190mm", NULL
, "EnvYou6", 98, 190),
224 _PWG_MEDIA_MM("jpn_chou2_111.1x146mm", NULL
, NULL
, 111.1, 146),
225 _PWG_MEDIA_MM("jpn_chou3_120x235mm", NULL
, "EnvChou3", 120, 235),
226 _PWG_MEDIA_MM("jpn_chou40_90x225mm", NULL
, "EnvChou40", 90, 225),
227 _PWG_MEDIA_MM("jpn_oufuku_148x200mm", NULL
, "DoublePostcardRotated", 148, 200),
228 _PWG_MEDIA_MM("jpn_kahu_240x322.1mm", NULL
, NULL
, 240, 322.1),
230 /* Chinese Standard Sheet Media Sizes */
231 _PWG_MEDIA_MM("prc_32k_97x151mm", NULL
, "PRC32K", 97, 151),
232 _PWG_MEDIA_MM("prc_1_102x165mm", NULL
, "EnvPRC1", 102, 165),
233 _PWG_MEDIA_MM("prc_2_102x176mm", NULL
, "EnvPRC2", 102, 176),
234 _PWG_MEDIA_MM("prc_4_110x208mm", NULL
, "EnvPRC4", 110, 208),
235 _PWG_MEDIA_MM("prc_8_120x309mm", NULL
, "EnvPRC8", 120, 309),
236 _PWG_MEDIA_MM("prc_6_120x320mm", NULL
, NULL
, 120, 320),
237 _PWG_MEDIA_MM("prc_16k_146x215mm", NULL
, "PRC16K", 146, 215),
238 _PWG_MEDIA_MM("prc_7_160x230mm", NULL
, "EnvPRC7", 160, 230),
239 _PWG_MEDIA_MM("om_juuro-ku-kai_198x275mm", NULL
, NULL
, 198, 275),
240 _PWG_MEDIA_MM("om_pa-kai_267x389mm", NULL
, NULL
, 267, 389),
241 _PWG_MEDIA_MM("om_dai-pa-kai_275x395mm", NULL
, NULL
, 275, 395),
243 /* Chinese Standard Sheet Media Inch Sizes */
244 _PWG_MEDIA_IN("roc_16k_7.75x10.75in", NULL
, "roc16k", 7.75, 10.75),
245 _PWG_MEDIA_IN("roc_8k_10.75x15.5in", NULL
, "roc8k", 10.75, 15.5),
247 /* Other English Standard Sheet Media Sizes */
248 _PWG_MEDIA_IN("oe_photo-l_3.5x5in", NULL
, "3.5x5", 3.5, 5),
250 /* Other Metric Standard Sheet Media Sizes */
251 _PWG_MEDIA_MM("om_small-photo_100x150mm", NULL
, "om_small-photo", 100, 150),
252 _PWG_MEDIA_MM("om_italian_110x230mm", NULL
, "EnvItalian", 110, 230),
253 _PWG_MEDIA_MM("om_large-photo_200x300", NULL
, "om_large-photo", 200, 300),
254 _PWG_MEDIA_MM("om_folio_210x330mm", "folio", "Folio", 210, 330),
255 _PWG_MEDIA_MM("om_folio-sp_215x315mm", NULL
, "FolioSP", 215, 315),
256 _PWG_MEDIA_MM("om_invite_220x220mm", NULL
, "EnvInvite", 220, 220),
257 _PWG_MEDIA_MM("om_small-photo_100x200mm", NULL
, "om_wide-photo", 100, 200)
262 * 'pwgFormatSizeName()' - Generate a PWG self-describing media size name.
264 * This function generates a PWG self-describing media size name of the form
265 * "prefix_name_WIDTHxLENGTHunits". The prefix is typically "custom" or "roll"
266 * for user-supplied sizes but can also be "disc", "iso", "jis", "jpn", "na",
267 * "oe", "om", "prc", or "roc". A value of @code NULL@ automatically chooses
268 * "oe" or "om" depending on the units.
270 * The size name may only contain lowercase letters, numbers, "-", and ".". If
271 * @code NULL@ is passed, the size name will contain the formatted dimensions.
273 * The width and length are specified in hundredths of millimeters, equivalent
274 * to 1/100000th of a meter or 1/2540th of an inch. The width, length, and
275 * units used for the generated size name are calculated automatically if the
276 * units string is @code NULL@, otherwise inches ("in") or millimeters ("mm")
279 * @since CUPS 1.7/OS X 10.9@
282 int /* O - 1 on success, 0 on failure */
283 pwgFormatSizeName(char *keyword
, /* I - Keyword buffer */
284 size_t keysize
, /* I - Size of keyword buffer */
285 const char *prefix
, /* I - Prefix for PWG size or @code NULL@ for automatic */
286 const char *name
, /* I - Size name or @code NULL@ */
287 int width
, /* I - Width of page in 2540ths */
288 int length
, /* I - Length of page in 2540ths */
289 const char *units
) /* I - Units - "in", "mm", or @code NULL@ for automatic */
291 char usize
[12 + 1 + 12 + 3], /* Unit size: NNNNNNNNNNNNxNNNNNNNNNNNNuu */
292 *uptr
; /* Pointer into unit size */
293 char *(*format
)(char *, size_t, int);
294 /* Formatting function */
298 * Range check input...
301 DEBUG_printf(("pwgFormatSize(keyword=%p, keysize=" CUPS_LLFMT
302 ", prefix=\"%s\", name=\"%s\", width=%d, length=%d, "
303 "units=\"%s\")", keyword
, CUPS_LLCAST keysize
, prefix
, name
,
304 width
, length
, units
));
309 if (!keyword
|| keysize
< 32 || width
< 0 || length
< 0 ||
310 (units
&& strcmp(units
, "in") && strcmp(units
, "mm")))
312 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Invalid media name arguments."),
323 const char *nameptr
; /* Pointer into name */
325 for (nameptr
= name
; *nameptr
; nameptr
++)
326 if (!(*nameptr
>= 'a' && *nameptr
<= 'z') &&
327 !(*nameptr
>= '0' && *nameptr
<= '9') &&
328 *nameptr
!= '.' && *nameptr
!= '-')
330 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
331 _("Invalid media name arguments."), 1);
341 if ((width
% 635) == 0 && (length
% 635) == 0)
344 * Use inches since the size is a multiple of 1/4 inch.
352 * Use millimeters since the size is not a multiple of 1/4 inch.
359 if (!strcmp(units
, "in"))
361 format
= pwg_format_inches
;
368 format
= pwg_format_millimeters
;
375 * Format the size string...
379 (*format
)(uptr
, sizeof(usize
) - (uptr
- usize
), width
);
380 uptr
+= strlen(uptr
);
382 (*format
)(uptr
, sizeof(usize
) - (uptr
- usize
), length
);
383 uptr
+= strlen(uptr
);
386 * Safe because usize can hold up to 12 + 1 + 12 + 4 bytes.
389 memcpy(uptr
, units
, 3);
395 snprintf(keyword
, keysize
, "%s_%s_%s", prefix
, name
, usize
);
400 /* For OS X 10.8 and earlier... */
401 void _pwgGenerateSize(char *keyword
, size_t keysize
, const char *prefix
,
402 const char *name
, int width
, int length
)
403 { pwgFormatSizeName(keyword
, keysize
, prefix
, name
, width
, length
, NULL
); }
407 * 'pwgInitSize()' - Initialize a pwg_size_t structure using IPP Job Template
410 * This function initializes a pwg_size_t structure from an IPP "media" or
411 * "media-col" attribute in the specified IPP message. 0 is returned if neither
412 * attribute is found in the message or the values are not valid.
414 * The "margins_set" variable is initialized to 1 if any "media-xxx-margin"
415 * member attribute was specified in the "media-col" Job Template attribute,
416 * otherwise it is initialized to 0.
418 * @since CUPS 1.7/OS X 10.9@
421 int /* O - 1 if size was initialized, 0 otherwise */
422 pwgInitSize(pwg_size_t
*size
, /* I - Size to initialize */
423 ipp_t
*job
, /* I - Job template attributes */
424 int *margins_set
) /* O - 1 if margins were set, 0 otherwise */
426 ipp_attribute_t
*media
, /* media attribute */
427 *media_bottom_margin
, /* media-bottom-margin member attribute */
428 *media_col
, /* media-col attribute */
429 *media_left_margin
, /* media-left-margin member attribute */
430 *media_right_margin
, /* media-right-margin member attribute */
431 *media_size
, /* media-size member attribute */
432 *media_top_margin
, /* media-top-margin member attribute */
433 *x_dimension
, /* x-dimension member attribute */
434 *y_dimension
; /* y-dimension member attribute */
435 pwg_media_t
*pwg
; /* PWG media value */
439 * Range check input...
442 if (!size
|| !job
|| !margins_set
)
446 * Look for media-col and then media...
449 memset(size
, 0, sizeof(pwg_size_t
));
452 if ((media_col
= ippFindAttribute(job
, "media-col",
453 IPP_TAG_BEGIN_COLLECTION
)) != NULL
)
456 * Got media-col, look for media-size member attribute...
459 if ((media_size
= ippFindAttribute(media_col
->values
[0].collection
,
461 IPP_TAG_BEGIN_COLLECTION
)) != NULL
)
464 * Got media-size, look for x-dimension and y-dimension member
468 x_dimension
= ippFindAttribute(media_size
->values
[0].collection
,
469 "x-dimension", IPP_TAG_INTEGER
);
470 y_dimension
= ippFindAttribute(media_size
->values
[0].collection
,
471 "y-dimension", IPP_TAG_INTEGER
);
473 if (x_dimension
&& y_dimension
)
475 size
->width
= x_dimension
->values
[0].integer
;
476 size
->length
= y_dimension
->values
[0].integer
;
478 else if (!x_dimension
)
480 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
481 _("Missing x-dimension in media-size."), 1);
484 else if (!y_dimension
)
486 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
487 _("Missing y-dimension in media-size."), 1);
493 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Missing media-size in media-col."),
499 media_bottom_margin
= ippFindAttribute(media_col
->values
[0].collection
,
500 "media-bottom-margin",
502 media_left_margin
= ippFindAttribute(media_col
->values
[0].collection
,
505 media_right_margin
= ippFindAttribute(media_col
->values
[0].collection
,
506 "media-right-margin",
508 media_top_margin
= ippFindAttribute(media_col
->values
[0].collection
,
511 if (media_bottom_margin
&& media_left_margin
&& media_right_margin
&&
515 size
->bottom
= media_bottom_margin
->values
[0].integer
;
516 size
->left
= media_left_margin
->values
[0].integer
;
517 size
->right
= media_right_margin
->values
[0].integer
;
518 size
->top
= media_top_margin
->values
[0].integer
;
523 if ((media
= ippFindAttribute(job
, "media", IPP_TAG_NAME
)) == NULL
)
524 if ((media
= ippFindAttribute(job
, "media", IPP_TAG_KEYWORD
)) == NULL
)
525 if ((media
= ippFindAttribute(job
, "PageSize", IPP_TAG_NAME
)) == NULL
)
526 media
= ippFindAttribute(job
, "PageRegion", IPP_TAG_NAME
);
528 if (media
&& media
->values
[0].string
.text
)
530 const char *name
= media
->values
[0].string
.text
;
533 if ((pwg
= pwgMediaForPWG(name
)) == NULL
)
536 * Not a PWG name, try a legacy name...
539 if ((pwg
= pwgMediaForLegacy(name
)) == NULL
)
542 * Not a legacy name, try a PPD name...
545 const char *suffix
; /* Suffix on media string */
547 pwg
= pwgMediaForPPD(name
);
549 (suffix
= name
+ strlen(name
) - 10 /* .FullBleed */) > name
&&
550 !_cups_strcasecmp(suffix
, ".FullBleed"))
553 * Indicate that margins are set with the default values of 0.
563 size
->width
= pwg
->width
;
564 size
->length
= pwg
->length
;
568 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Unsupported media value."), 1);
574 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Missing media or media-col."), 1);
582 /* For OS X 10.8 and earlier */
583 int _pwgInitSize(pwg_size_t
*size
, ipp_t
*job
, int *margins_set
)
584 { return (pwgInitSize(size
, job
, margins_set
)); }
588 * 'pwgMediaForLegacy()' - Find a PWG media size by ISO/IPP legacy name.
590 * The "name" argument specifies the legacy ISO media size name, for example
591 * "iso-a4" or "na-letter".
593 * @since CUPS 1.7/OS X 10.9@
596 pwg_media_t
* /* O - Matching size or NULL */
597 pwgMediaForLegacy(const char *legacy
) /* I - Legacy size name */
599 pwg_media_t key
; /* Search key */
600 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
604 * Range check input...
611 * Build the lookup table for PWG names as needed...
614 if (!cg
->leg_size_lut
)
616 int i
; /* Looping var */
617 pwg_media_t
*size
; /* Current size */
619 cg
->leg_size_lut
= cupsArrayNew((cups_array_func_t
)pwg_compare_legacy
,
622 for (i
= (int)(sizeof(cups_pwg_media
) / sizeof(cups_pwg_media
[0])),
623 size
= (pwg_media_t
*)cups_pwg_media
;
627 cupsArrayAdd(cg
->leg_size_lut
, size
);
635 return ((pwg_media_t
*)cupsArrayFind(cg
->leg_size_lut
, &key
));
638 /* For OS X 10.8 and earlier */
639 pwg_media_t
*_pwgMediaForLegacy(const char *legacy
)
640 { return (pwgMediaForLegacy(legacy
)); }
644 * 'pwgMediaForPPD()' - Find a PWG media size by Adobe PPD name.
646 * The "ppd" argument specifies an Adobe page size name as defined in Table B.1
647 * of the Adobe PostScript Printer Description File Format Specification Version
650 * If the name is non-standard, the returned PWG media size is stored in
651 * thread-local storage and is overwritten by each call to the function in the
652 * thread. Custom names can be of the form "Custom.WIDTHxLENGTH[units]" or
653 * "WIDTHxLENGTH[units]".
655 * @since CUPS 1.7/OS X 10.9@
658 pwg_media_t
* /* O - Matching size or NULL */
659 pwgMediaForPPD(const char *ppd
) /* I - PPD size name */
661 pwg_media_t key
, /* Search key */
662 *size
; /* Matching size */
663 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
667 * Range check input...
674 * Build the lookup table for PWG names as needed...
677 if (!cg
->ppd_size_lut
)
679 int i
; /* Looping var */
681 cg
->ppd_size_lut
= cupsArrayNew((cups_array_func_t
)pwg_compare_ppd
, NULL
);
683 for (i
= (int)(sizeof(cups_pwg_media
) / sizeof(cups_pwg_media
[0])),
684 size
= (pwg_media_t
*)cups_pwg_media
;
688 cupsArrayAdd(cg
->ppd_size_lut
, size
);
696 if ((size
= (pwg_media_t
*)cupsArrayFind(cg
->ppd_size_lut
, &key
)) == NULL
)
699 * See if the name is of the form:
701 * [Custom.]WIDTHxLENGTH[.FullBleed] - Size in points/inches [borderless]
702 * [Custom.]WIDTHxLENGTHcm[.FullBleed] - Size in centimeters [borderless]
703 * [Custom.]WIDTHxLENGTHft[.FullBleed] - Size in feet [borderless]
704 * [Custom.]WIDTHxLENGTHin[.FullBleed] - Size in inches [borderless]
705 * [Custom.]WIDTHxLENGTHm[.FullBleed] - Size in meters [borderless]
706 * [Custom.]WIDTHxLENGTHmm[.FullBleed] - Size in millimeters [borderless]
707 * [Custom.]WIDTHxLENGTHpt[.FullBleed] - Size in points [borderless]
710 int w
, l
, /* Width and length of page */
711 numer
, /* Unit scaling factor */
713 char *ptr
; /* Pointer into name */
714 const char *units
; /* Pointer to units */
715 int custom
; /* Custom page size? */
718 if (!_cups_strncasecmp(ppd
, "Custom.", 7))
723 ptr
= (char *)ppd
+ 7;
734 * Find any units in the size...
737 units
= strchr(ptr
, '.');
738 while (units
&& isdigit(units
[1] & 255))
739 units
= strchr(units
+ 1, '.');
744 units
= ptr
+ strlen(ptr
) - 2;
748 if (isdigit(*units
& 255) || *units
== '.')
751 if (!_cups_strncasecmp(units
, "cm", 2))
756 else if (!_cups_strncasecmp(units
, "ft", 2))
761 else if (!_cups_strncasecmp(units
, "in", 2))
766 else if (!_cups_strncasecmp(units
, "mm", 2))
771 else if (*units
== 'm' || *units
== 'M')
776 else if (!_cups_strncasecmp(units
, "pt", 2))
783 w
= pwg_scan_measurement(ptr
, &ptr
, numer
, denom
);
785 if (ptr
&& ptr
> ppd
&& *ptr
== 'x')
787 l
= pwg_scan_measurement(ptr
+ 1, &ptr
, numer
, denom
);
792 * Not a standard size; convert it to a PWG custom name of the form:
794 * [oe|om]_WIDTHxHEIGHTuu_WIDTHxHEIGHTuu
797 size
= &(cg
->pwg_media
);
800 size
->pwg
= cg
->pwg_name
;
802 pwgFormatSizeName(cg
->pwg_name
, sizeof(cg
->pwg_name
),
803 custom
? "custom" : NULL
, custom
? ppd
+ 7 : NULL
,
804 size
->width
, size
->length
, NULL
);
812 /* For OS X 10.8 and earlier */
813 pwg_media_t
*_pwgMediaForPPD(const char *ppd
)
814 { return (pwgMediaForPPD(ppd
)); }
818 * 'pwgMediaForPWG()' - Find a PWG media size by 5101.1 self-describing name.
820 * The "pwg" argument specifies a self-describing media size name of the form
821 * "prefix_name_WIDTHxLENGTHunits" as defined in PWG 5101.1.
823 * If the name is non-standard, the returned PWG media size is stored in
824 * thread-local storage and is overwritten by each call to the function in the
827 * @since CUPS 1.7/OS X 10.9@
830 pwg_media_t
* /* O - Matching size or NULL */
831 pwgMediaForPWG(const char *pwg
) /* I - PWG size name */
833 char *ptr
; /* Pointer into name */
834 pwg_media_t key
, /* Search key */
835 *size
; /* Matching size */
836 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
840 * Range check input...
847 * Build the lookup table for PWG names as needed...
850 if (!cg
->pwg_size_lut
)
852 int i
; /* Looping var */
854 cg
->pwg_size_lut
= cupsArrayNew((cups_array_func_t
)pwg_compare_pwg
, NULL
);
856 for (i
= (int)(sizeof(cups_pwg_media
) / sizeof(cups_pwg_media
[0])),
857 size
= (pwg_media_t
*)cups_pwg_media
;
860 cupsArrayAdd(cg
->pwg_size_lut
, size
);
868 if ((size
= (pwg_media_t
*)cupsArrayFind(cg
->pwg_size_lut
, &key
)) == NULL
&&
869 (ptr
= (char *)strchr(pwg
, '_')) != NULL
&&
870 (ptr
= (char *)strchr(ptr
+ 1, '_')) != NULL
)
873 * Try decoding the self-describing name of the form:
875 * class_name_WWWxHHHin
876 * class_name_WWWxHHHmm
879 int w
, l
; /* Width and length of page */
880 int numer
; /* Scale factor for units */
881 const char *units
= ptr
+ strlen(ptr
) - 2;
882 /* Units from size */
886 if (units
>= ptr
&& !strcmp(units
, "in"))
891 w
= pwg_scan_measurement(ptr
, &ptr
, numer
, 1);
893 if (ptr
&& *ptr
== 'x')
895 l
= pwg_scan_measurement(ptr
+ 1, &ptr
, numer
, 1);
899 size
= &(cg
->pwg_media
);
903 strlcpy(cg
->pwg_name
, pwg
, sizeof(cg
->pwg_name
));
904 size
->pwg
= cg
->pwg_name
;
912 /* For OS X 10.8 and earlier */
913 pwg_media_t
*_pwgMediaForPWG(const char *pwg
)
914 { return (pwgMediaForPWG(pwg
)); }
918 * 'pwgMediaForSize()' - Get the PWG media size for the given dimensions.
920 * The "width" and "length" are in hundredths of millimeters, equivalent to
921 * 1/100000th of a meter or 1/2540th of an inch.
923 * If the dimensions are non-standard, the returned PWG media size is stored in
924 * thread-local storage and is overwritten by each call to the function in the
927 * @since CUPS 1.7/OS X 10.9@
930 pwg_media_t
* /* O - PWG media name */
931 pwgMediaForSize(int width
, /* I - Width in hundredths of millimeters */
932 int length
) /* I - Length in hundredths of millimeters */
934 int i
; /* Looping var */
935 pwg_media_t
*media
, /* Current media */
936 *best_media
= NULL
; /* Best match */
937 int dw
, dl
, /* Difference in width and length */
938 best_dw
= 999, /* Best difference in width and length */
940 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
944 * Range check input...
947 if (width
<= 0 || length
<= 0)
951 * Look for a standard size...
954 for (i
= (int)(sizeof(cups_pwg_media
) / sizeof(cups_pwg_media
[0])),
955 media
= (pwg_media_t
*)cups_pwg_media
;
960 * Adobe uses a size matching algorithm with an epsilon of 5 points, which
961 * is just about 176/2540ths...
964 dw
= abs(media
->width
- width
);
965 dl
= abs(media
->length
- length
);
969 else if (dw
< 176 && dl
< 176)
971 if (dw
<= best_dw
&& dl
<= best_dl
)
984 * Not a standard size; convert it to a PWG custom name of the form:
986 * custom_WIDTHxHEIGHTuu_WIDTHxHEIGHTuu
989 pwgFormatSizeName(cg
->pwg_name
, sizeof(cg
->pwg_name
), "custom", NULL
, width
,
992 cg
->pwg_media
.pwg
= cg
->pwg_name
;
993 cg
->pwg_media
.width
= width
;
994 cg
->pwg_media
.length
= length
;
996 return (&(cg
->pwg_media
));
999 /* For OS X 10.8 and earlier */
1000 pwg_media_t
*_pwgMediaForSize(int width
, int length
)
1001 { return (pwgMediaForSize(width
, length
)); }
1005 * '_pwgMediaTable()' - Return the internal media size table.
1008 const pwg_media_t
* /* O - Pointer to first entry */
1009 _pwgMediaTable(size_t *num_media
) /* O - Number of entries */
1011 *num_media
= sizeof(cups_pwg_media
) / sizeof(cups_pwg_media
[0]);
1013 return (cups_pwg_media
);
1018 * 'pwg_compare_legacy()' - Compare two sizes using the legacy names.
1021 static int /* O - Result of comparison */
1022 pwg_compare_legacy(pwg_media_t
*a
, /* I - First size */
1023 pwg_media_t
*b
) /* I - Second size */
1025 return (strcmp(a
->legacy
, b
->legacy
));
1030 * 'pwg_compare_ppd()' - Compare two sizes using the PPD names.
1033 static int /* O - Result of comparison */
1034 pwg_compare_ppd(pwg_media_t
*a
, /* I - First size */
1035 pwg_media_t
*b
) /* I - Second size */
1037 return (strcmp(a
->ppd
, b
->ppd
));
1042 * 'pwg_compare_pwg()' - Compare two sizes using the PWG names.
1045 static int /* O - Result of comparison */
1046 pwg_compare_pwg(pwg_media_t
*a
, /* I - First size */
1047 pwg_media_t
*b
) /* I - Second size */
1049 return (strcmp(a
->pwg
, b
->pwg
));
1054 * 'pwg_format_inches()' - Convert and format PWG units as inches.
1057 static char * /* O - String */
1058 pwg_format_inches(char *buf
, /* I - Buffer */
1059 size_t bufsize
, /* I - Size of buffer */
1060 int val
) /* I - Value in hundredths of millimeters */
1062 int thousandths
, /* Thousandths of inches */
1063 integer
, /* Integer portion */
1064 fraction
; /* Fractional portion */
1068 * Convert hundredths of millimeters to thousandths of inches and round to
1069 * the nearest thousandth.
1072 thousandths
= (val
* 1000 + 1270) / 2540;
1073 integer
= thousandths
/ 1000;
1074 fraction
= thousandths
% 1000;
1077 * Format as a pair of integers (avoids locale stuff), avoiding trailing
1082 snprintf(buf
, bufsize
, "%d", integer
);
1083 else if (fraction
% 10)
1084 snprintf(buf
, bufsize
, "%d.%03d", integer
, fraction
);
1085 else if (fraction
% 100)
1086 snprintf(buf
, bufsize
, "%d.%02d", integer
, fraction
/ 10);
1088 snprintf(buf
, bufsize
, "%d.%01d", integer
, fraction
/ 100);
1095 * 'pwg_format_millimeters()' - Convert and format PWG units as millimeters.
1098 static char * /* O - String */
1099 pwg_format_millimeters(char *buf
, /* I - Buffer */
1100 size_t bufsize
, /* I - Size of buffer */
1101 int val
) /* I - Value in hundredths of millimeters */
1103 int integer
, /* Integer portion */
1104 fraction
; /* Fractional portion */
1108 * Convert hundredths of millimeters to integer and fractional portions.
1111 integer
= val
/ 100;
1112 fraction
= val
% 100;
1115 * Format as a pair of integers (avoids locale stuff), avoiding trailing
1120 snprintf(buf
, bufsize
, "%d", integer
);
1121 else if (fraction
% 10)
1122 snprintf(buf
, bufsize
, "%d.%02d", integer
, fraction
);
1124 snprintf(buf
, bufsize
, "%d.%01d", integer
, fraction
/ 10);
1131 * 'pwg_scan_measurement()' - Scan a measurement in inches or millimeters.
1133 * The "factor" argument specifies the scale factor for the units to convert to
1134 * hundredths of millimeters. The returned value is NOT rounded but is an
1135 * exact conversion of the fraction value (no floating point is used).
1138 static int /* O - Hundredths of millimeters */
1139 pwg_scan_measurement(
1140 const char *buf
, /* I - Number string */
1141 char **bufptr
, /* O - First byte after the number */
1142 int numer
, /* I - Numerator from units */
1143 int denom
) /* I - Denominator from units */
1145 int value
= 0, /* Measurement value */
1146 fractional
= 0, /* Fractional value */
1147 divisor
= 1, /* Fractional divisor */
1148 digits
= 10 * numer
* denom
; /* Maximum fractional value to read */
1152 * Scan integer portion...
1155 while (*buf
>= '0' && *buf
<= '9')
1156 value
= value
* 10 + (*buf
++) - '0';
1161 * Scan fractional portion...
1166 while (divisor
< digits
&& *buf
>= '0' && *buf
<= '9')
1168 fractional
= fractional
* 10 + (*buf
++) - '0';
1173 * Skip trailing digits that won't contribute...
1176 while (*buf
>= '0' && *buf
<= '9')
1181 *bufptr
= (char *)buf
;
1183 return (value
* numer
/ denom
+ fractional
* numer
/ denom
/ divisor
);