2 * PWG media name API implementation for CUPS.
4 * Copyright 2009-2017 by Apple Inc.
6 * These coded instructions, statements, and computer programs are the
7 * property of Apple Inc. and are protected by Federal copyright
8 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
9 * which should have been included with this file. If this file is
10 * missing or damaged, see the license at "http://www.cups.org/".
12 * This file is subject to the Apple OS-Developed Software exception.
16 * Include necessary headers...
19 #include "cups-private.h"
27 #define _PWG_MEDIA_IN(p,l,a,x,y) {p, l, a, (int)(x * 2540), (int)(y * 2540)}
28 #define _PWG_MEDIA_MM(p,l,a,x,y) {p, l, a, (int)(x * 100), (int)(y * 100)}
35 static int pwg_compare_legacy(pwg_media_t
*a
, pwg_media_t
*b
);
36 static int pwg_compare_pwg(pwg_media_t
*a
, pwg_media_t
*b
);
37 static int pwg_compare_ppd(pwg_media_t
*a
, pwg_media_t
*b
);
38 static char *pwg_format_inches(char *buf
, size_t bufsize
, int val
);
39 static char *pwg_format_millimeters(char *buf
, size_t bufsize
, int val
);
40 static int pwg_scan_measurement(const char *buf
, char **bufptr
, int numer
, int denom
);
47 static pwg_media_t
const cups_pwg_media
[] =
48 { /* Media size lookup table */
49 /* North American Standard Sheet Media Sizes */
50 _PWG_MEDIA_IN("na_index-3x5_3x5in", NULL
, "3x5", 3, 5),
51 _PWG_MEDIA_IN("na_personal_3.625x6.5in", NULL
, "EnvPersonal", 3.625, 6.5),
52 _PWG_MEDIA_IN("na_monarch_3.875x7.5in", "monarch-envelope", "EnvMonarch", 3.875, 7.5),
53 _PWG_MEDIA_IN("na_number-9_3.875x8.875in", "na-number-9-envelope", "Env9", 3.875, 8.875),
54 _PWG_MEDIA_IN("na_index-4x6_4x6in", NULL
, "4x6", 4, 6),
55 _PWG_MEDIA_IN("na_number-10_4.125x9.5in", "na-number-10-envelope", "Env10", 4.125, 9.5),
56 _PWG_MEDIA_IN("na_a2_4.375x5.75in", NULL
, "EnvA2", 4.375, 5.75),
57 _PWG_MEDIA_IN("na_number-11_4.5x10.375in", NULL
, "Env11", 4.5, 10.375),
58 _PWG_MEDIA_IN("na_number-12_4.75x11in", NULL
, "Env12", 4.75, 11),
59 _PWG_MEDIA_IN("na_5x7_5x7in", NULL
, "5x7", 5, 7),
60 _PWG_MEDIA_IN("na_index-5x8_5x8in", NULL
, "5x8", 5, 8),
61 _PWG_MEDIA_IN("na_number-14_5x11.5in", NULL
, "Env14", 5, 11.5),
62 _PWG_MEDIA_IN("na_invoice_5.5x8.5in", "invoice", "Statement", 5.5, 8.5),
63 _PWG_MEDIA_IN("na_index-4x6-ext_6x8in", NULL
, "6x8", 6, 8),
64 _PWG_MEDIA_IN("na_6x9_6x9in", "na-6x9-envelope", "6x9", 6, 9),
65 _PWG_MEDIA_IN("na_c5_6.5x9.5in", NULL
, "6.5x9.5", 6.5, 9.5),
66 _PWG_MEDIA_IN("na_7x9_7x9in", "na-7x9-envelope", "7x9", 7, 9),
67 _PWG_MEDIA_IN("na_executive_7.25x10.5in", "executive", "Executive", 7.25, 10.5),
68 _PWG_MEDIA_IN("na_govt-letter_8x10in", "na-8x10", "8x10", 8, 10),
69 _PWG_MEDIA_IN("na_govt-legal_8x13in", NULL
, "8x13", 8, 13),
70 _PWG_MEDIA_IN("na_quarto_8.5x10.83in", "quarto", "Quarto", 8.5, 10.83),
71 _PWG_MEDIA_IN("na_letter_8.5x11in", "na-letter", "Letter", 8.5, 11),
72 _PWG_MEDIA_IN("na_fanfold-eur_8.5x12in", NULL
, "FanFoldGerman", 8.5, 12),
73 _PWG_MEDIA_IN("na_letter-plus_8.5x12.69in", NULL
, "LetterPlus", 8.5, 12.69),
74 _PWG_MEDIA_IN("na_foolscap_8.5x13in", NULL
, "FanFoldGermanLegal", 8.5, 13),
75 _PWG_MEDIA_IN("na_oficio_8.5x13.4in", NULL
, "Oficio", 8.5, 13.4),
76 _PWG_MEDIA_IN("na_legal_8.5x14in", "na-legal", "Legal", 8.5, 14),
77 _PWG_MEDIA_IN("na_super-a_8.94x14in", NULL
, "SuperA", 8.94, 14),
78 _PWG_MEDIA_IN("na_9x11_9x11in", "na-9x11-envelope", "9x11", 9, 11),
79 _PWG_MEDIA_IN("na_arch-a_9x12in", "arch-a", "ARCHA", 9, 12),
80 _PWG_MEDIA_IN("na_letter-extra_9.5x12in", NULL
, "LetterExtra", 9.5, 12),
81 _PWG_MEDIA_IN("na_legal-extra_9.5x15in", NULL
, "LegalExtra", 9.5, 15),
82 _PWG_MEDIA_IN("na_10x11_10x11in", NULL
, "10x11", 10, 11),
83 _PWG_MEDIA_IN("na_10x13_10x13in", "na-10x13-envelope", "10x13", 10, 13),
84 _PWG_MEDIA_IN("na_10x14_10x14in", "na-10x14-envelope", "10x14", 10, 14),
85 _PWG_MEDIA_IN("na_10x15_10x15in", "na-10x15-envelope", "10x15", 10, 15),
86 _PWG_MEDIA_IN("na_11x12_11x12in", NULL
, "11x12", 11, 12),
87 _PWG_MEDIA_IN("na_edp_11x14in", NULL
, "11x14", 11, 14),
88 _PWG_MEDIA_IN("na_fanfold-us_11x14.875in", NULL
, "11x14.875", 11, 14.875),
89 _PWG_MEDIA_IN("na_11x15_11x15in", NULL
, "11x15", 11, 15),
90 _PWG_MEDIA_IN("na_ledger_11x17in", "tabloid", "Tabloid", 11, 17),
91 _PWG_MEDIA_IN("na_eur-edp_12x14in", NULL
, NULL
, 12, 14),
92 _PWG_MEDIA_IN("na_arch-b_12x18in", "arch-b", "ARCHB", 12, 18),
93 _PWG_MEDIA_IN("na_12x19_12x19in", NULL
, "12x19", 12, 19),
94 _PWG_MEDIA_IN("na_b-plus_12x19.17in", NULL
, "SuperB", 12, 19.17),
95 _PWG_MEDIA_IN("na_super-b_13x19in", "super-b", "13x19", 13, 19),
96 _PWG_MEDIA_IN("na_c_17x22in", "c", "AnsiC", 17, 22),
97 _PWG_MEDIA_IN("na_arch-c_18x24in", "arch-c", "ARCHC", 18, 24),
98 _PWG_MEDIA_IN("na_d_22x34in", "d", "AnsiD", 22, 34),
99 _PWG_MEDIA_IN("na_arch-d_24x36in", "arch-d", "ARCHD", 24, 36),
100 _PWG_MEDIA_IN("asme_f_28x40in", "f", "28x40", 28, 40),
101 _PWG_MEDIA_IN("na_wide-format_30x42in", NULL
, "30x42", 30, 42),
102 _PWG_MEDIA_IN("na_e_34x44in", "e", "AnsiE", 34, 44),
103 _PWG_MEDIA_IN("na_arch-e_36x48in", "arch-e", "ARCHE", 36, 48),
104 _PWG_MEDIA_IN("na_f_44x68in", NULL
, "AnsiF", 44, 68),
106 /* ISO Standard Sheet Media Sizes */
107 _PWG_MEDIA_MM("iso_a10_26x37mm", "iso-a10", "A10", 26, 37),
108 _PWG_MEDIA_MM("iso_a9_37x52mm", "iso-a9", "A9", 37, 52),
109 _PWG_MEDIA_MM("iso_a8_52x74mm", "iso-a8", "A8", 52, 74),
110 _PWG_MEDIA_MM("iso_a7_74x105mm", "iso-a7", "A7", 74, 105),
111 _PWG_MEDIA_MM("iso_a6_105x148mm", "iso-a6", "A6", 105, 148),
112 _PWG_MEDIA_MM("iso_a5_148x210mm", "iso-a5", "A5", 148, 210),
113 _PWG_MEDIA_MM("iso_a5-extra_174x235mm", NULL
, "A5Extra", 174, 235),
114 _PWG_MEDIA_MM("iso_a4_210x297mm", "iso-a4", "A4", 210, 297),
115 _PWG_MEDIA_MM("iso_a4-tab_225x297mm", NULL
, "A4Tab", 225, 297),
116 _PWG_MEDIA_MM("iso_a4-extra_235.5x322.3mm", NULL
, "A4Extra", 235.5, 322.3),
117 _PWG_MEDIA_MM("iso_a3_297x420mm", "iso-a3", "A3", 297, 420),
118 _PWG_MEDIA_MM("iso_a4x3_297x630mm", "iso-a4x3", "A4x3", 297, 630),
119 _PWG_MEDIA_MM("iso_a4x4_297x841mm", "iso-a4x4", "A4x4", 297, 841),
120 _PWG_MEDIA_MM("iso_a4x5_297x1051mm", "iso-a4x5", "A4x5", 297, 1051),
121 _PWG_MEDIA_MM("iso_a4x6_297x1261mm", "iso-a4x6", "A4x6", 297, 1261),
122 _PWG_MEDIA_MM("iso_a4x7_297x1471mm", "iso-a4x7", "A4x7", 297, 1471),
123 _PWG_MEDIA_MM("iso_a4x8_297x1682mm", "iso-a4x8", "A4x8", 297, 1682),
124 _PWG_MEDIA_MM("iso_a4x9_297x1892mm", "iso-a4x9", "A4x9", 297, 1892),
125 _PWG_MEDIA_MM("iso_a3-extra_322x445mm", "iso-a3-extra", "A3Extra", 322, 445),
126 _PWG_MEDIA_MM("iso_a2_420x594mm", "iso-a2", "A2", 420, 594),
127 _PWG_MEDIA_MM("iso_a3x3_420x891mm", "iso-a3x3", "A3x3", 420, 891),
128 _PWG_MEDIA_MM("iso_a3x4_420x1189mm", "iso-a3x4", "A3x4", 420, 1189),
129 _PWG_MEDIA_MM("iso_a3x5_420x1486mm", "iso-a3x5", "A3x6", 420, 1486),
130 _PWG_MEDIA_MM("iso_a3x6_420x1783mm", "iso-a3x6", "A3x6", 420, 1783),
131 _PWG_MEDIA_MM("iso_a3x7_420x2080mm", "iso-a3x7", "A3x7", 420, 2080),
132 _PWG_MEDIA_MM("iso_a1_594x841mm", "iso-a1", "A1", 594, 841),
133 _PWG_MEDIA_MM("iso_a2x3_594x1261mm", "iso-a2x3", "A2x3", 594, 1261),
134 _PWG_MEDIA_MM("iso_a2x4_594x1682mm", "iso-a2x4", "A2x4", 594, 1682),
135 _PWG_MEDIA_MM("iso_a2x5_594x2102mm", "iso-a2x5", "A2x5", 594, 2102),
136 _PWG_MEDIA_MM("iso_a0_841x1189mm", "iso-a0", "A0", 841, 1189),
137 _PWG_MEDIA_MM("iso_a1x3_841x1783mm", "iso-a1x3", "A1x3", 841, 1783),
138 _PWG_MEDIA_MM("iso_a1x4_841x2378mm", "iso-a1x4", "A1x4", 841, 2378),
139 _PWG_MEDIA_MM("iso_2a0_1189x1682mm", NULL
, "1189x1682mm", 1189, 1682),
140 _PWG_MEDIA_MM("iso_a0x3_1189x2523mm", NULL
, "A0x3", 1189, 2523),
141 _PWG_MEDIA_MM("iso_b10_31x44mm", "iso-b10", "ISOB10", 31, 44),
142 _PWG_MEDIA_MM("iso_b9_44x62mm", "iso-b9", "ISOB9", 44, 62),
143 _PWG_MEDIA_MM("iso_b8_62x88mm", "iso-b8", "ISOB8", 62, 88),
144 _PWG_MEDIA_MM("iso_b7_88x125mm", "iso-b7", "ISOB7", 88, 125),
145 _PWG_MEDIA_MM("iso_b6_125x176mm", "iso-b6", "ISOB6", 125, 176),
146 _PWG_MEDIA_MM("iso_b6c4_125x324mm", NULL
, "125x324mm", 125, 324),
147 _PWG_MEDIA_MM("iso_b5_176x250mm", "iso-b5", "ISOB5", 176, 250),
148 _PWG_MEDIA_MM("iso_b5-extra_201x276mm", NULL
, "ISOB5Extra", 201, 276),
149 _PWG_MEDIA_MM("iso_b4_250x353mm", "iso-b4", "ISOB4", 250, 353),
150 _PWG_MEDIA_MM("iso_b3_353x500mm", "iso-b3", "ISOB3", 353, 500),
151 _PWG_MEDIA_MM("iso_b2_500x707mm", "iso-b2", "ISOB2", 500, 707),
152 _PWG_MEDIA_MM("iso_b1_707x1000mm", "iso-b1", "ISOB1", 707, 1000),
153 _PWG_MEDIA_MM("iso_b0_1000x1414mm", "iso-b0", "ISOB0", 1000, 1414),
154 _PWG_MEDIA_MM("iso_c10_28x40mm", "iso-c10", "EnvC10", 28, 40),
155 _PWG_MEDIA_MM("iso_c9_40x57mm", "iso-c9", "EnvC9", 40, 57),
156 _PWG_MEDIA_MM("iso_c8_57x81mm", "iso-c8", "EnvC8", 57, 81),
157 _PWG_MEDIA_MM("iso_c7_81x114mm", "iso-c7", "EnvC7", 81, 114),
158 _PWG_MEDIA_MM("iso_c7c6_81x162mm", NULL
, "EnvC76", 81, 162),
159 _PWG_MEDIA_MM("iso_c6_114x162mm", "iso-c6", "EnvC6", 114, 162),
160 _PWG_MEDIA_MM("iso_c6c5_114x229mm", NULL
, "EnvC65", 114, 229),
161 _PWG_MEDIA_MM("iso_c5_162x229mm", "iso-c5", "EnvC5", 162, 229),
162 _PWG_MEDIA_MM("iso_c4_229x324mm", "iso-c4", "EnvC4", 229, 324),
163 _PWG_MEDIA_MM("iso_c3_324x458mm", "iso-c3", "EnvC3", 324, 458),
164 _PWG_MEDIA_MM("iso_c2_458x648mm", "iso-c2", "EnvC2", 458, 648),
165 _PWG_MEDIA_MM("iso_c1_648x917mm", "iso-c1", "EnvC1", 648, 917),
166 _PWG_MEDIA_MM("iso_c0_917x1297mm", "iso-c0", "EnvC0", 917, 1297),
167 _PWG_MEDIA_MM("iso_dl_110x220mm", "iso-designated", "EnvDL", 110, 220),
168 _PWG_MEDIA_MM("iso_ra4_215x305mm", "iso-ra4", "RA4", 215, 305),
169 _PWG_MEDIA_MM("iso_sra4_225x320mm", "iso-sra4", "SRA4", 225, 320),
170 _PWG_MEDIA_MM("iso_ra3_305x430mm", "iso-ra3", "RA3", 305, 430),
171 _PWG_MEDIA_MM("iso_sra3_320x450mm", "iso-sra3", "SRA3", 320, 450),
172 _PWG_MEDIA_MM("iso_ra2_430x610mm", "iso-ra2", "RA2", 430, 610),
173 _PWG_MEDIA_MM("iso_sra2_450x640mm", "iso-sra2", "SRA2", 450, 640),
174 _PWG_MEDIA_MM("iso_ra1_610x860mm", "iso-ra1", "RA1", 610, 860),
175 _PWG_MEDIA_MM("iso_sra1_640x900mm", "iso-sra1", "SRA1", 640, 900),
176 _PWG_MEDIA_MM("iso_ra0_860x1220mm", "iso-ra0", "RA0", 860, 1220),
177 _PWG_MEDIA_MM("iso_sra0_900x1280mm", "iso-sra0", "SRA0", 900, 1280),
179 /* Japanese Standard Sheet Media Sizes */
180 _PWG_MEDIA_MM("jis_b10_32x45mm", "jis-b10", "B10", 32, 45),
181 _PWG_MEDIA_MM("jis_b9_45x64mm", "jis-b9", "B9", 45, 64),
182 _PWG_MEDIA_MM("jis_b8_64x91mm", "jis-b8", "B8", 64, 91),
183 _PWG_MEDIA_MM("jis_b7_91x128mm", "jis-b7", "B7", 91, 128),
184 _PWG_MEDIA_MM("jis_b6_128x182mm", "jis-b6", "B6", 128, 182),
185 _PWG_MEDIA_MM("jis_b5_182x257mm", "jis-b5", "B5", 182, 257),
186 _PWG_MEDIA_MM("jis_b4_257x364mm", "jis-b4", "B4", 257, 364),
187 _PWG_MEDIA_MM("jis_b3_364x515mm", "jis-b3", "B3", 364, 515),
188 _PWG_MEDIA_MM("jis_b2_515x728mm", "jis-b2", "B2", 515, 728),
189 _PWG_MEDIA_MM("jis_b1_728x1030mm", "jis-b1", "B1", 728, 1030),
190 _PWG_MEDIA_MM("jis_b0_1030x1456mm", "jis-b0", "B0", 1030, 1456),
191 _PWG_MEDIA_MM("jis_exec_216x330mm", NULL
, "216x330mm", 216, 330),
192 _PWG_MEDIA_MM("jpn_kaku2_240x332mm", NULL
, "EnvKaku2", 240, 332),
193 _PWG_MEDIA_MM("jpn_kaku3_216x277mm", NULL
, "EnvKaku3", 216, 277),
194 _PWG_MEDIA_MM("jpn_kaku4_197x267mm", NULL
, "EnvKaku4", 197, 267),
195 _PWG_MEDIA_MM("jpn_kaku5_190x240mm", NULL
, "EnvKaku5", 190, 240),
196 _PWG_MEDIA_MM("jpn_kaku7_142x205mm", NULL
, "EnvKaku7", 142, 205),
197 _PWG_MEDIA_MM("jpn_kaku8_119x197mm", NULL
, "EnvKaku8", 119, 197),
198 _PWG_MEDIA_MM("jpn_chou4_90x205mm", NULL
, "EnvChou4", 90, 205),
199 _PWG_MEDIA_MM("jpn_hagaki_100x148mm", NULL
, "Postcard", 100, 148),
200 _PWG_MEDIA_MM("jpn_you4_105x235mm", NULL
, "EnvYou4", 105, 235),
201 _PWG_MEDIA_MM("jpn_you6_98x190mm", NULL
, "EnvYou6", 98, 190),
202 _PWG_MEDIA_MM("jpn_chou2_111.1x146mm", NULL
, NULL
, 111.1, 146),
203 _PWG_MEDIA_MM("jpn_chou3_120x235mm", NULL
, "EnvChou3", 120, 235),
204 _PWG_MEDIA_MM("jpn_chou40_90x225mm", NULL
, "EnvChou40", 90, 225),
205 _PWG_MEDIA_MM("jpn_oufuku_148x200mm", NULL
, "DoublePostcardRotated", 148, 200),
206 _PWG_MEDIA_MM("jpn_kahu_240x322.1mm", NULL
, "240x322mm", 240, 322.1),
208 /* Chinese Standard Sheet Media Sizes */
209 _PWG_MEDIA_MM("prc_32k_97x151mm", NULL
, "PRC32K", 97, 151),
210 _PWG_MEDIA_MM("prc_1_102x165mm", NULL
, "EnvPRC1", 102, 165),
211 _PWG_MEDIA_MM("prc_2_102x176mm", NULL
, "EnvPRC2", 102, 176),
212 _PWG_MEDIA_MM("prc_4_110x208mm", NULL
, "EnvPRC4", 110, 208),
213 _PWG_MEDIA_MM("prc_8_120x309mm", NULL
, "EnvPRC8", 120, 309),
214 _PWG_MEDIA_MM("prc_6_120x320mm", NULL
, NULL
, 120, 320),
215 _PWG_MEDIA_MM("prc_16k_146x215mm", NULL
, "PRC16K", 146, 215),
216 _PWG_MEDIA_MM("prc_7_160x230mm", NULL
, "EnvPRC7", 160, 230),
217 _PWG_MEDIA_MM("om_juuro-ku-kai_198x275mm", NULL
, "198x275mm", 198, 275),
218 _PWG_MEDIA_MM("om_pa-kai_267x389mm", NULL
, "267x389mm", 267, 389),
219 _PWG_MEDIA_MM("om_dai-pa-kai_275x395mm", NULL
, "275x395mm", 275, 395),
221 /* Chinese Standard Sheet Media Inch Sizes */
222 _PWG_MEDIA_IN("roc_16k_7.75x10.75in", NULL
, "roc16k", 7.75, 10.75),
223 _PWG_MEDIA_IN("roc_8k_10.75x15.5in", NULL
, "roc8k", 10.75, 15.5),
225 /* Other English Standard Sheet Media Sizes */
226 _PWG_MEDIA_IN("oe_photo-l_3.5x5in", NULL
, "3.5x5", 3.5, 5),
228 /* Other Metric Standard Sheet Media Sizes */
229 _PWG_MEDIA_MM("om_small-photo_100x150mm", NULL
, "100x150mm", 100, 150),
230 _PWG_MEDIA_MM("om_italian_110x230mm", NULL
, "EnvItalian", 110, 230),
231 _PWG_MEDIA_MM("om_large-photo_200x300", NULL
, "200x300mm", 200, 300),
232 _PWG_MEDIA_MM("om_folio_210x330mm", "folio", "Folio", 210, 330),
233 _PWG_MEDIA_MM("om_folio-sp_215x315mm", NULL
, "FolioSP", 215, 315),
234 _PWG_MEDIA_MM("om_invite_220x220mm", NULL
, "EnvInvite", 220, 220),
235 _PWG_MEDIA_MM("om_small-photo_100x200mm", NULL
, "100x200mm", 100, 200),
238 _PWG_MEDIA_MM("disc_standard_40x118mm", NULL
, "Disc", 118, 118)
243 * 'pwgFormatSizeName()' - Generate a PWG self-describing media size name.
245 * This function generates a PWG self-describing media size name of the form
246 * "prefix_name_WIDTHxLENGTHunits". The prefix is typically "custom" or "roll"
247 * for user-supplied sizes but can also be "disc", "iso", "jis", "jpn", "na",
248 * "oe", "om", "prc", or "roc". A value of @code NULL@ automatically chooses
249 * "oe" or "om" depending on the units.
251 * The size name may only contain lowercase letters, numbers, "-", and ".". If
252 * @code NULL@ is passed, the size name will contain the formatted dimensions.
254 * The width and length are specified in hundredths of millimeters, equivalent
255 * to 1/100000th of a meter or 1/2540th of an inch. The width, length, and
256 * units used for the generated size name are calculated automatically if the
257 * units string is @code NULL@, otherwise inches ("in") or millimeters ("mm")
260 * @since CUPS 1.7/macOS 10.9@
263 int /* O - 1 on success, 0 on failure */
264 pwgFormatSizeName(char *keyword
, /* I - Keyword buffer */
265 size_t keysize
, /* I - Size of keyword buffer */
266 const char *prefix
, /* I - Prefix for PWG size or @code NULL@ for automatic */
267 const char *name
, /* I - Size name or @code NULL@ */
268 int width
, /* I - Width of page in 2540ths */
269 int length
, /* I - Length of page in 2540ths */
270 const char *units
) /* I - Units - "in", "mm", or @code NULL@ for automatic */
272 char usize
[12 + 1 + 12 + 3], /* Unit size: NNNNNNNNNNNNxNNNNNNNNNNNNuu */
273 *uptr
; /* Pointer into unit size */
274 char *(*format
)(char *, size_t, int);
275 /* Formatting function */
279 * Range check input...
282 DEBUG_printf(("pwgFormatSize(keyword=%p, keysize=" CUPS_LLFMT
", prefix=\"%s\", name=\"%s\", width=%d, length=%d, units=\"%s\")", (void *)keyword
, CUPS_LLCAST keysize
, prefix
, name
, width
, length
, units
));
287 if (!keyword
|| keysize
< 32 || width
< 0 || length
< 0 ||
288 (units
&& strcmp(units
, "in") && strcmp(units
, "mm")))
290 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Invalid media name arguments."),
301 const char *nameptr
; /* Pointer into name */
303 for (nameptr
= name
; *nameptr
; nameptr
++)
304 if (!(*nameptr
>= 'a' && *nameptr
<= 'z') &&
305 !(*nameptr
>= '0' && *nameptr
<= '9') &&
306 *nameptr
!= '.' && *nameptr
!= '-')
308 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
309 _("Invalid media name arguments."), 1);
316 if (prefix
&& !strcmp(prefix
, "disc"))
317 width
= 4000; /* Disc sizes use hardcoded 40mm inner diameter */
321 if ((width
% 635) == 0 && (length
% 635) == 0)
324 * Use inches since the size is a multiple of 1/4 inch.
332 * Use millimeters since the size is not a multiple of 1/4 inch.
339 if (!strcmp(units
, "in"))
341 format
= pwg_format_inches
;
348 format
= pwg_format_millimeters
;
355 * Format the size string...
359 (*format
)(uptr
, sizeof(usize
) - (size_t)(uptr
- usize
), width
);
360 uptr
+= strlen(uptr
);
362 (*format
)(uptr
, sizeof(usize
) - (size_t)(uptr
- usize
), length
);
363 uptr
+= strlen(uptr
);
366 * Safe because usize can hold up to 12 + 1 + 12 + 4 bytes.
369 memcpy(uptr
, units
, 3);
375 snprintf(keyword
, keysize
, "%s_%s_%s", prefix
, name
, usize
);
382 * 'pwgInitSize()' - Initialize a pwg_size_t structure using IPP Job Template
385 * This function initializes a pwg_size_t structure from an IPP "media" or
386 * "media-col" attribute in the specified IPP message. 0 is returned if neither
387 * attribute is found in the message or the values are not valid.
389 * The "margins_set" variable is initialized to 1 if any "media-xxx-margin"
390 * member attribute was specified in the "media-col" Job Template attribute,
391 * otherwise it is initialized to 0.
393 * @since CUPS 1.7/macOS 10.9@
396 int /* O - 1 if size was initialized, 0 otherwise */
397 pwgInitSize(pwg_size_t
*size
, /* I - Size to initialize */
398 ipp_t
*job
, /* I - Job template attributes */
399 int *margins_set
) /* O - 1 if margins were set, 0 otherwise */
401 ipp_attribute_t
*media
, /* media attribute */
402 *media_bottom_margin
, /* media-bottom-margin member attribute */
403 *media_col
, /* media-col attribute */
404 *media_left_margin
, /* media-left-margin member attribute */
405 *media_right_margin
, /* media-right-margin member attribute */
406 *media_size
, /* media-size member attribute */
407 *media_top_margin
, /* media-top-margin member attribute */
408 *x_dimension
, /* x-dimension member attribute */
409 *y_dimension
; /* y-dimension member attribute */
410 pwg_media_t
*pwg
; /* PWG media value */
414 * Range check input...
417 if (!size
|| !job
|| !margins_set
)
421 * Look for media-col and then media...
424 memset(size
, 0, sizeof(pwg_size_t
));
427 if ((media_col
= ippFindAttribute(job
, "media-col",
428 IPP_TAG_BEGIN_COLLECTION
)) != NULL
)
431 * Got media-col, look for media-size member attribute...
434 if ((media_size
= ippFindAttribute(media_col
->values
[0].collection
,
436 IPP_TAG_BEGIN_COLLECTION
)) != NULL
)
439 * Got media-size, look for x-dimension and y-dimension member
443 x_dimension
= ippFindAttribute(media_size
->values
[0].collection
,
444 "x-dimension", IPP_TAG_INTEGER
);
445 y_dimension
= ippFindAttribute(media_size
->values
[0].collection
,
446 "y-dimension", IPP_TAG_INTEGER
);
448 if (x_dimension
&& y_dimension
)
450 size
->width
= x_dimension
->values
[0].integer
;
451 size
->length
= y_dimension
->values
[0].integer
;
453 else if (!x_dimension
)
455 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
456 _("Missing x-dimension in media-size."), 1);
459 else if (!y_dimension
)
461 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
,
462 _("Missing y-dimension in media-size."), 1);
468 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Missing media-size in media-col."),
474 media_bottom_margin
= ippFindAttribute(media_col
->values
[0].collection
,
475 "media-bottom-margin",
477 media_left_margin
= ippFindAttribute(media_col
->values
[0].collection
,
480 media_right_margin
= ippFindAttribute(media_col
->values
[0].collection
,
481 "media-right-margin",
483 media_top_margin
= ippFindAttribute(media_col
->values
[0].collection
,
486 if (media_bottom_margin
&& media_left_margin
&& media_right_margin
&&
490 size
->bottom
= media_bottom_margin
->values
[0].integer
;
491 size
->left
= media_left_margin
->values
[0].integer
;
492 size
->right
= media_right_margin
->values
[0].integer
;
493 size
->top
= media_top_margin
->values
[0].integer
;
498 if ((media
= ippFindAttribute(job
, "media", IPP_TAG_NAME
)) == NULL
)
499 if ((media
= ippFindAttribute(job
, "media", IPP_TAG_KEYWORD
)) == NULL
)
500 if ((media
= ippFindAttribute(job
, "PageSize", IPP_TAG_NAME
)) == NULL
)
501 media
= ippFindAttribute(job
, "PageRegion", IPP_TAG_NAME
);
503 if (media
&& media
->values
[0].string
.text
)
505 const char *name
= media
->values
[0].string
.text
;
508 if ((pwg
= pwgMediaForPWG(name
)) == NULL
)
511 * Not a PWG name, try a legacy name...
514 if ((pwg
= pwgMediaForLegacy(name
)) == NULL
)
517 * Not a legacy name, try a PPD name...
520 const char *suffix
; /* Suffix on media string */
522 pwg
= pwgMediaForPPD(name
);
524 (suffix
= name
+ strlen(name
) - 10 /* .FullBleed */) > name
&&
525 !_cups_strcasecmp(suffix
, ".FullBleed"))
528 * Indicate that margins are set with the default values of 0.
538 size
->width
= pwg
->width
;
539 size
->length
= pwg
->length
;
543 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Unsupported media value."), 1);
549 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, _("Missing media or media-col."), 1);
559 * 'pwgMediaForLegacy()' - Find a PWG media size by ISO/IPP legacy name.
561 * The "name" argument specifies the legacy ISO media size name, for example
562 * "iso-a4" or "na-letter".
564 * @since CUPS 1.7/macOS 10.9@
567 pwg_media_t
* /* O - Matching size or NULL */
568 pwgMediaForLegacy(const char *legacy
) /* I - Legacy size name */
570 pwg_media_t key
; /* Search key */
571 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
575 * Range check input...
582 * Build the lookup table for PWG names as needed...
585 if (!cg
->leg_size_lut
)
587 int i
; /* Looping var */
588 pwg_media_t
*size
; /* Current size */
590 cg
->leg_size_lut
= cupsArrayNew((cups_array_func_t
)pwg_compare_legacy
,
593 for (i
= (int)(sizeof(cups_pwg_media
) / sizeof(cups_pwg_media
[0])),
594 size
= (pwg_media_t
*)cups_pwg_media
;
598 cupsArrayAdd(cg
->leg_size_lut
, size
);
606 return ((pwg_media_t
*)cupsArrayFind(cg
->leg_size_lut
, &key
));
611 * 'pwgMediaForPPD()' - Find a PWG media size by Adobe PPD name.
613 * The "ppd" argument specifies an Adobe page size name as defined in Table B.1
614 * of the Adobe PostScript Printer Description File Format Specification Version
617 * If the name is non-standard, the returned PWG media size is stored in
618 * thread-local storage and is overwritten by each call to the function in the
619 * thread. Custom names can be of the form "Custom.WIDTHxLENGTH[units]" or
620 * "WIDTHxLENGTH[units]".
622 * @since CUPS 1.7/macOS 10.9@
625 pwg_media_t
* /* O - Matching size or NULL */
626 pwgMediaForPPD(const char *ppd
) /* I - PPD size name */
628 pwg_media_t key
, /* Search key */
629 *size
; /* Matching size */
630 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
634 * Range check input...
641 * Build the lookup table for PWG names as needed...
644 if (!cg
->ppd_size_lut
)
646 int i
; /* Looping var */
648 cg
->ppd_size_lut
= cupsArrayNew((cups_array_func_t
)pwg_compare_ppd
, NULL
);
650 for (i
= (int)(sizeof(cups_pwg_media
) / sizeof(cups_pwg_media
[0])),
651 size
= (pwg_media_t
*)cups_pwg_media
;
655 cupsArrayAdd(cg
->ppd_size_lut
, size
);
663 if ((size
= (pwg_media_t
*)cupsArrayFind(cg
->ppd_size_lut
, &key
)) == NULL
)
666 * See if the name is of the form:
668 * [Custom.]WIDTHxLENGTH[.FullBleed] - Size in points/inches [borderless]
669 * [Custom.]WIDTHxLENGTHcm[.FullBleed] - Size in centimeters [borderless]
670 * [Custom.]WIDTHxLENGTHft[.FullBleed] - Size in feet [borderless]
671 * [Custom.]WIDTHxLENGTHin[.FullBleed] - Size in inches [borderless]
672 * [Custom.]WIDTHxLENGTHm[.FullBleed] - Size in meters [borderless]
673 * [Custom.]WIDTHxLENGTHmm[.FullBleed] - Size in millimeters [borderless]
674 * [Custom.]WIDTHxLENGTHpt[.FullBleed] - Size in points [borderless]
677 int w
, l
, /* Width and length of page */
678 numer
, /* Unit scaling factor */
680 char *ptr
; /* Pointer into name */
681 const char *units
; /* Pointer to units */
682 int custom
; /* Custom page size? */
685 if (!_cups_strncasecmp(ppd
, "Custom.", 7))
690 ptr
= (char *)ppd
+ 7;
701 * Find any units in the size...
704 units
= strchr(ptr
, '.');
705 while (units
&& isdigit(units
[1] & 255))
706 units
= strchr(units
+ 1, '.');
711 units
= ptr
+ strlen(ptr
) - 2;
715 if (isdigit(*units
& 255) || *units
== '.')
718 if (!_cups_strncasecmp(units
, "cm", 2))
723 else if (!_cups_strncasecmp(units
, "ft", 2))
728 else if (!_cups_strncasecmp(units
, "in", 2))
733 else if (!_cups_strncasecmp(units
, "mm", 2))
738 else if (*units
== 'm' || *units
== 'M')
743 else if (!_cups_strncasecmp(units
, "pt", 2))
750 w
= pwg_scan_measurement(ptr
, &ptr
, numer
, denom
);
752 if (ptr
&& ptr
> ppd
&& *ptr
== 'x')
754 l
= pwg_scan_measurement(ptr
+ 1, &ptr
, numer
, denom
);
759 * Not a standard size; convert it to a PWG custom name of the form:
761 * [oe|om]_WIDTHxHEIGHTuu_WIDTHxHEIGHTuu
764 char wstr
[32], lstr
[32]; /* Width and length as strings */
766 size
= &(cg
->pwg_media
);
769 size
->pwg
= cg
->pwg_name
;
771 pwgFormatSizeName(cg
->pwg_name
, sizeof(cg
->pwg_name
),
772 custom
? "custom" : NULL
, custom
? ppd
+ 7 : NULL
,
773 size
->width
, size
->length
, NULL
);
775 if ((w
% 635) == 0 && (l
% 635) == 0)
776 snprintf(cg
->ppd_name
, sizeof(cg
->ppd_name
), "%sx%s", pwg_format_inches(wstr
, sizeof(wstr
), w
), pwg_format_inches(lstr
, sizeof(lstr
), l
));
778 snprintf(cg
->ppd_name
, sizeof(cg
->ppd_name
), "%sx%smm", pwg_format_millimeters(wstr
, sizeof(wstr
), w
), pwg_format_millimeters(lstr
, sizeof(lstr
), l
));
779 size
->ppd
= cg
->ppd_name
;
789 * 'pwgMediaForPWG()' - Find a PWG media size by 5101.1 self-describing name.
791 * The "pwg" argument specifies a self-describing media size name of the form
792 * "prefix_name_WIDTHxLENGTHunits" as defined in PWG 5101.1.
794 * If the name is non-standard, the returned PWG media size is stored in
795 * thread-local storage and is overwritten by each call to the function in the
798 * @since CUPS 1.7/macOS 10.9@
801 pwg_media_t
* /* O - Matching size or NULL */
802 pwgMediaForPWG(const char *pwg
) /* I - PWG size name */
804 char *ptr
; /* Pointer into name */
805 pwg_media_t key
, /* Search key */
806 *size
; /* Matching size */
807 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
811 * Range check input...
818 * Build the lookup table for PWG names as needed...
821 if (!cg
->pwg_size_lut
)
823 int i
; /* Looping var */
825 cg
->pwg_size_lut
= cupsArrayNew((cups_array_func_t
)pwg_compare_pwg
, NULL
);
827 for (i
= (int)(sizeof(cups_pwg_media
) / sizeof(cups_pwg_media
[0])),
828 size
= (pwg_media_t
*)cups_pwg_media
;
831 cupsArrayAdd(cg
->pwg_size_lut
, size
);
839 if ((size
= (pwg_media_t
*)cupsArrayFind(cg
->pwg_size_lut
, &key
)) == NULL
&&
840 (ptr
= (char *)strchr(pwg
, '_')) != NULL
&&
841 (ptr
= (char *)strchr(ptr
+ 1, '_')) != NULL
)
844 * Try decoding the self-describing name of the form:
846 * class_name_WWWxHHHin
847 * class_name_WWWxHHHmm
850 int w
, l
; /* Width and length of page */
851 int numer
; /* Scale factor for units */
852 const char *units
= ptr
+ strlen(ptr
) - 2;
853 /* Units from size */
857 if (units
>= ptr
&& !strcmp(units
, "in"))
862 w
= pwg_scan_measurement(ptr
, &ptr
, numer
, 1);
864 if (ptr
&& *ptr
== 'x')
866 l
= pwg_scan_measurement(ptr
+ 1, &ptr
, numer
, 1);
870 char wstr
[32], lstr
[32]; /* Width and length strings */
872 if (!strncmp(pwg
, "disc_", 5))
873 w
= l
; /* Make the media size OUTERxOUTER */
875 size
= &(cg
->pwg_media
);
879 strlcpy(cg
->pwg_name
, pwg
, sizeof(cg
->pwg_name
));
880 size
->pwg
= cg
->pwg_name
;
883 snprintf(cg
->ppd_name
, sizeof(cg
->ppd_name
), "%sx%smm", pwg_format_millimeters(wstr
, sizeof(wstr
), w
), pwg_format_millimeters(lstr
, sizeof(lstr
), l
));
885 snprintf(cg
->ppd_name
, sizeof(cg
->ppd_name
), "%sx%s", pwg_format_inches(wstr
, sizeof(wstr
), w
), pwg_format_inches(lstr
, sizeof(lstr
), l
));
886 size
->ppd
= cg
->ppd_name
;
896 * 'pwgMediaForSize()' - Get the PWG media size for the given dimensions.
898 * The "width" and "length" are in hundredths of millimeters, equivalent to
899 * 1/100000th of a meter or 1/2540th of an inch.
901 * If the dimensions are non-standard, the returned PWG media size is stored in
902 * thread-local storage and is overwritten by each call to the function in the
905 * @since CUPS 1.7/macOS 10.9@
908 pwg_media_t
* /* O - PWG media name */
909 pwgMediaForSize(int width
, /* I - Width in hundredths of millimeters */
910 int length
) /* I - Length in hundredths of millimeters */
913 * Adobe uses a size matching algorithm with an epsilon of 5 points, which
914 * is just about 176/2540ths...
917 return (_pwgMediaNearSize(width
, length
, 176));
922 * '_pwgMediaNearSize()' - Get the PWG media size within the given tolerance.
925 pwg_media_t
* /* O - PWG media name */
926 _pwgMediaNearSize(int width
, /* I - Width in hundredths of millimeters */
927 int length
, /* I - Length in hundredths of millimeters */
928 int epsilon
) /* I - Match within this tolernace. PWG units */
930 int i
; /* Looping var */
931 pwg_media_t
*media
, /* Current media */
932 *best_media
= NULL
; /* Best match */
933 int dw
, dl
, /* Difference in width and length */
934 best_dw
= 999, /* Best difference in width and length */
936 char wstr
[32], lstr
[32]; /* Width and length as strings */
937 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
941 * Range check input...
944 if (width
<= 0 || length
<= 0)
948 * Look for a standard size...
951 for (i
= (int)(sizeof(cups_pwg_media
) / sizeof(cups_pwg_media
[0])),
952 media
= (pwg_media_t
*)cups_pwg_media
;
957 dw
= abs(media
->width
- width
);
958 dl
= abs(media
->length
- length
);
962 else if (dw
<= epsilon
&& dl
<= epsilon
)
964 if (dw
<= best_dw
&& dl
<= best_dl
)
977 * Not a standard size; convert it to a PWG custom name of the form:
979 * custom_WIDTHxHEIGHTuu_WIDTHxHEIGHTuu
982 pwgFormatSizeName(cg
->pwg_name
, sizeof(cg
->pwg_name
), "custom", NULL
, width
,
985 cg
->pwg_media
.pwg
= cg
->pwg_name
;
986 cg
->pwg_media
.width
= width
;
987 cg
->pwg_media
.length
= length
;
989 if ((width
% 635) == 0 && (length
% 635) == 0)
990 snprintf(cg
->ppd_name
, sizeof(cg
->ppd_name
), "%sx%s", pwg_format_inches(wstr
, sizeof(wstr
), width
), pwg_format_inches(lstr
, sizeof(lstr
), length
));
992 snprintf(cg
->ppd_name
, sizeof(cg
->ppd_name
), "%sx%smm", pwg_format_millimeters(wstr
, sizeof(wstr
), width
), pwg_format_millimeters(lstr
, sizeof(lstr
), length
));
993 cg
->pwg_media
.ppd
= cg
->ppd_name
;
995 return (&(cg
->pwg_media
));
1000 * '_pwgMediaTable()' - Return the internal media size table.
1003 const pwg_media_t
* /* O - Pointer to first entry */
1004 _pwgMediaTable(size_t *num_media
) /* O - Number of entries */
1006 *num_media
= sizeof(cups_pwg_media
) / sizeof(cups_pwg_media
[0]);
1008 return (cups_pwg_media
);
1013 * 'pwg_compare_legacy()' - Compare two sizes using the legacy names.
1016 static int /* O - Result of comparison */
1017 pwg_compare_legacy(pwg_media_t
*a
, /* I - First size */
1018 pwg_media_t
*b
) /* I - Second size */
1020 return (strcmp(a
->legacy
, b
->legacy
));
1025 * 'pwg_compare_ppd()' - Compare two sizes using the PPD names.
1028 static int /* O - Result of comparison */
1029 pwg_compare_ppd(pwg_media_t
*a
, /* I - First size */
1030 pwg_media_t
*b
) /* I - Second size */
1032 return (strcmp(a
->ppd
, b
->ppd
));
1037 * 'pwg_compare_pwg()' - Compare two sizes using the PWG names.
1040 static int /* O - Result of comparison */
1041 pwg_compare_pwg(pwg_media_t
*a
, /* I - First size */
1042 pwg_media_t
*b
) /* I - Second size */
1044 return (strcmp(a
->pwg
, b
->pwg
));
1049 * 'pwg_format_inches()' - Convert and format PWG units as inches.
1052 static char * /* O - String */
1053 pwg_format_inches(char *buf
, /* I - Buffer */
1054 size_t bufsize
, /* I - Size of buffer */
1055 int val
) /* I - Value in hundredths of millimeters */
1057 int thousandths
, /* Thousandths of inches */
1058 integer
, /* Integer portion */
1059 fraction
; /* Fractional portion */
1063 * Convert hundredths of millimeters to thousandths of inches and round to
1064 * the nearest thousandth.
1067 thousandths
= (val
* 1000 + 1270) / 2540;
1068 integer
= thousandths
/ 1000;
1069 fraction
= thousandths
% 1000;
1072 * Format as a pair of integers (avoids locale stuff), avoiding trailing
1077 snprintf(buf
, bufsize
, "%d", integer
);
1078 else if (fraction
% 10)
1079 snprintf(buf
, bufsize
, "%d.%03d", integer
, fraction
);
1080 else if (fraction
% 100)
1081 snprintf(buf
, bufsize
, "%d.%02d", integer
, fraction
/ 10);
1083 snprintf(buf
, bufsize
, "%d.%01d", integer
, fraction
/ 100);
1090 * 'pwg_format_millimeters()' - Convert and format PWG units as millimeters.
1093 static char * /* O - String */
1094 pwg_format_millimeters(char *buf
, /* I - Buffer */
1095 size_t bufsize
, /* I - Size of buffer */
1096 int val
) /* I - Value in hundredths of millimeters */
1098 int integer
, /* Integer portion */
1099 fraction
; /* Fractional portion */
1103 * Convert hundredths of millimeters to integer and fractional portions.
1106 integer
= val
/ 100;
1107 fraction
= val
% 100;
1110 * Format as a pair of integers (avoids locale stuff), avoiding trailing
1115 snprintf(buf
, bufsize
, "%d", integer
);
1116 else if (fraction
% 10)
1117 snprintf(buf
, bufsize
, "%d.%02d", integer
, fraction
);
1119 snprintf(buf
, bufsize
, "%d.%01d", integer
, fraction
/ 10);
1126 * 'pwg_scan_measurement()' - Scan a measurement in inches or millimeters.
1128 * The "factor" argument specifies the scale factor for the units to convert to
1129 * hundredths of millimeters. The returned value is NOT rounded but is an
1130 * exact conversion of the fraction value (no floating point is used).
1133 static int /* O - Hundredths of millimeters */
1134 pwg_scan_measurement(
1135 const char *buf
, /* I - Number string */
1136 char **bufptr
, /* O - First byte after the number */
1137 int numer
, /* I - Numerator from units */
1138 int denom
) /* I - Denominator from units */
1140 int value
= 0, /* Measurement value */
1141 fractional
= 0, /* Fractional value */
1142 divisor
= 1, /* Fractional divisor */
1143 digits
= 10 * numer
* denom
; /* Maximum fractional value to read */
1147 * Scan integer portion...
1150 while (*buf
>= '0' && *buf
<= '9')
1151 value
= value
* 10 + (*buf
++) - '0';
1156 * Scan fractional portion...
1161 while (divisor
< digits
&& *buf
>= '0' && *buf
<= '9')
1163 fractional
= fractional
* 10 + (*buf
++) - '0';
1168 * Skip trailing digits that won't contribute...
1171 while (*buf
>= '0' && *buf
<= '9')
1176 *bufptr
= (char *)buf
;
1178 return (value
* numer
/ denom
+ fractional
* numer
/ denom
/ divisor
);