]> git.ipfire.org Git - thirdparty/cups.git/blame - cups/pwg-media.c
Clean up installation of private headers.
[thirdparty/cups.git] / cups / pwg-media.c
CommitLineData
54afec33 1/*
7e86f2f6 2 * PWG media name API implementation for CUPS.
54afec33 3 *
45eb1e5e 4 * Copyright 2009-2017 by Apple Inc.
54afec33 5 *
e3101897 6 * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
54afec33
MS
7 */
8
9/*
10 * Include necessary headers...
11 */
12
71e16022 13#include "cups-private.h"
fb863569 14#include "debug-internal.h"
54afec33
MS
15#include <math.h>
16
17
18/*
19 * Local macros...
20 */
21
22#define _PWG_MEDIA_IN(p,l,a,x,y) {p, l, a, (int)(x * 2540), (int)(y * 2540)}
23#define _PWG_MEDIA_MM(p,l,a,x,y) {p, l, a, (int)(x * 100), (int)(y * 100)}
24
25
26/*
27 * Local functions...
28 */
29
6961465f
MS
30static int pwg_compare_legacy(pwg_media_t *a, pwg_media_t *b);
31static int pwg_compare_pwg(pwg_media_t *a, pwg_media_t *b);
32static int pwg_compare_ppd(pwg_media_t *a, pwg_media_t *b);
33static char *pwg_format_inches(char *buf, size_t bufsize, int val);
34static char *pwg_format_millimeters(char *buf, size_t bufsize, int val);
23862bc6 35static int pwg_scan_measurement(const char *buf, char **bufptr, int numer, int denom);
54afec33
MS
36
37
38/*
39 * Local globals...
40 */
41
6961465f 42static pwg_media_t const cups_pwg_media[] =
54afec33
MS
43{ /* Media size lookup table */
44 /* North American Standard Sheet Media Sizes */
7cf5915e 45 _PWG_MEDIA_IN("na_index-3x5_3x5in", NULL, "3x5", 3, 5),
54afec33
MS
46 _PWG_MEDIA_IN("na_personal_3.625x6.5in", NULL, "EnvPersonal", 3.625, 6.5),
47 _PWG_MEDIA_IN("na_monarch_3.875x7.5in", "monarch-envelope", "EnvMonarch", 3.875, 7.5),
48 _PWG_MEDIA_IN("na_number-9_3.875x8.875in", "na-number-9-envelope", "Env9", 3.875, 8.875),
7cf5915e 49 _PWG_MEDIA_IN("na_index-4x6_4x6in", NULL, "4x6", 4, 6),
54afec33 50 _PWG_MEDIA_IN("na_number-10_4.125x9.5in", "na-number-10-envelope", "Env10", 4.125, 9.5),
dcb445bc 51 _PWG_MEDIA_IN("na_a2_4.375x5.75in", NULL, "EnvA2", 4.375, 5.75),
54afec33
MS
52 _PWG_MEDIA_IN("na_number-11_4.5x10.375in", NULL, "Env11", 4.5, 10.375),
53 _PWG_MEDIA_IN("na_number-12_4.75x11in", NULL, "Env12", 4.75, 11),
7cf5915e
MS
54 _PWG_MEDIA_IN("na_5x7_5x7in", NULL, "5x7", 5, 7),
55 _PWG_MEDIA_IN("na_index-5x8_5x8in", NULL, "5x8", 5, 8),
54afec33
MS
56 _PWG_MEDIA_IN("na_number-14_5x11.5in", NULL, "Env14", 5, 11.5),
57 _PWG_MEDIA_IN("na_invoice_5.5x8.5in", "invoice", "Statement", 5.5, 8.5),
23862bc6 58 _PWG_MEDIA_IN("na_index-4x6-ext_6x8in", NULL, "6x8", 6, 8),
7cf5915e
MS
59 _PWG_MEDIA_IN("na_6x9_6x9in", "na-6x9-envelope", "6x9", 6, 9),
60 _PWG_MEDIA_IN("na_c5_6.5x9.5in", NULL, "6.5x9.5", 6.5, 9.5),
54afec33
MS
61 _PWG_MEDIA_IN("na_7x9_7x9in", "na-7x9-envelope", "7x9", 7, 9),
62 _PWG_MEDIA_IN("na_executive_7.25x10.5in", "executive", "Executive", 7.25, 10.5),
63 _PWG_MEDIA_IN("na_govt-letter_8x10in", "na-8x10", "8x10", 8, 10),
7cf5915e 64 _PWG_MEDIA_IN("na_govt-legal_8x13in", NULL, "8x13", 8, 13),
54afec33
MS
65 _PWG_MEDIA_IN("na_quarto_8.5x10.83in", "quarto", "Quarto", 8.5, 10.83),
66 _PWG_MEDIA_IN("na_letter_8.5x11in", "na-letter", "Letter", 8.5, 11),
67 _PWG_MEDIA_IN("na_fanfold-eur_8.5x12in", NULL, "FanFoldGerman", 8.5, 12),
68 _PWG_MEDIA_IN("na_letter-plus_8.5x12.69in", NULL, "LetterPlus", 8.5, 12.69),
69 _PWG_MEDIA_IN("na_foolscap_8.5x13in", NULL, "FanFoldGermanLegal", 8.5, 13),
a469f8a5 70 _PWG_MEDIA_IN("na_oficio_8.5x13.4in", NULL, "Oficio", 8.5, 13.4),
54afec33
MS
71 _PWG_MEDIA_IN("na_legal_8.5x14in", "na-legal", "Legal", 8.5, 14),
72 _PWG_MEDIA_IN("na_super-a_8.94x14in", NULL, "SuperA", 8.94, 14),
73 _PWG_MEDIA_IN("na_9x11_9x11in", "na-9x11-envelope", "9x11", 9, 11),
74 _PWG_MEDIA_IN("na_arch-a_9x12in", "arch-a", "ARCHA", 9, 12),
75 _PWG_MEDIA_IN("na_letter-extra_9.5x12in", NULL, "LetterExtra", 9.5, 12),
76 _PWG_MEDIA_IN("na_legal-extra_9.5x15in", NULL, "LegalExtra", 9.5, 15),
77 _PWG_MEDIA_IN("na_10x11_10x11in", NULL, "10x11", 10, 11),
78 _PWG_MEDIA_IN("na_10x13_10x13in", "na-10x13-envelope", "10x13", 10, 13),
79 _PWG_MEDIA_IN("na_10x14_10x14in", "na-10x14-envelope", "10x14", 10, 14),
7cf5915e
MS
80 _PWG_MEDIA_IN("na_10x15_10x15in", "na-10x15-envelope", "10x15", 10, 15),
81 _PWG_MEDIA_IN("na_11x12_11x12in", NULL, "11x12", 11, 12),
82 _PWG_MEDIA_IN("na_edp_11x14in", NULL, "11x14", 11, 14),
23862bc6 83 _PWG_MEDIA_IN("na_fanfold-us_11x14.875in", NULL, "11x14.875", 11, 14.875),
7cf5915e 84 _PWG_MEDIA_IN("na_11x15_11x15in", NULL, "11x15", 11, 15),
54afec33
MS
85 _PWG_MEDIA_IN("na_ledger_11x17in", "tabloid", "Tabloid", 11, 17),
86 _PWG_MEDIA_IN("na_eur-edp_12x14in", NULL, NULL, 12, 14),
87 _PWG_MEDIA_IN("na_arch-b_12x18in", "arch-b", "ARCHB", 12, 18),
7cf5915e 88 _PWG_MEDIA_IN("na_12x19_12x19in", NULL, "12x19", 12, 19),
a2326b5b
MS
89 _PWG_MEDIA_IN("na_b-plus_12x19.17in", NULL, "SuperB", 12, 19.17),
90 _PWG_MEDIA_IN("na_super-b_13x19in", "super-b", "13x19", 13, 19),
54afec33
MS
91 _PWG_MEDIA_IN("na_c_17x22in", "c", "AnsiC", 17, 22),
92 _PWG_MEDIA_IN("na_arch-c_18x24in", "arch-c", "ARCHC", 18, 24),
93 _PWG_MEDIA_IN("na_d_22x34in", "d", "AnsiD", 22, 34),
94 _PWG_MEDIA_IN("na_arch-d_24x36in", "arch-d", "ARCHD", 24, 36),
23862bc6
MS
95 _PWG_MEDIA_IN("asme_f_28x40in", "f", "28x40", 28, 40),
96 _PWG_MEDIA_IN("na_wide-format_30x42in", NULL, "30x42", 30, 42),
54afec33
MS
97 _PWG_MEDIA_IN("na_e_34x44in", "e", "AnsiE", 34, 44),
98 _PWG_MEDIA_IN("na_arch-e_36x48in", "arch-e", "ARCHE", 36, 48),
7cf5915e 99 _PWG_MEDIA_IN("na_f_44x68in", NULL, "AnsiF", 44, 68),
54afec33 100
54afec33
MS
101 /* ISO Standard Sheet Media Sizes */
102 _PWG_MEDIA_MM("iso_a10_26x37mm", "iso-a10", "A10", 26, 37),
103 _PWG_MEDIA_MM("iso_a9_37x52mm", "iso-a9", "A9", 37, 52),
104 _PWG_MEDIA_MM("iso_a8_52x74mm", "iso-a8", "A8", 52, 74),
105 _PWG_MEDIA_MM("iso_a7_74x105mm", "iso-a7", "A7", 74, 105),
106 _PWG_MEDIA_MM("iso_a6_105x148mm", "iso-a6", "A6", 105, 148),
107 _PWG_MEDIA_MM("iso_a5_148x210mm", "iso-a5", "A5", 148, 210),
108 _PWG_MEDIA_MM("iso_a5-extra_174x235mm", NULL, "A5Extra", 174, 235),
109 _PWG_MEDIA_MM("iso_a4_210x297mm", "iso-a4", "A4", 210, 297),
bb0d23b2 110 _PWG_MEDIA_MM("iso_a4-tab_225x297mm", NULL, "A4Tab", 225, 297),
54afec33
MS
111 _PWG_MEDIA_MM("iso_a4-extra_235.5x322.3mm", NULL, "A4Extra", 235.5, 322.3),
112 _PWG_MEDIA_MM("iso_a3_297x420mm", "iso-a3", "A3", 297, 420),
23862bc6
MS
113 _PWG_MEDIA_MM("iso_a4x3_297x630mm", "iso-a4x3", "A4x3", 297, 630),
114 _PWG_MEDIA_MM("iso_a4x4_297x841mm", "iso-a4x4", "A4x4", 297, 841),
115 _PWG_MEDIA_MM("iso_a4x5_297x1051mm", "iso-a4x5", "A4x5", 297, 1051),
116 _PWG_MEDIA_MM("iso_a4x6_297x1261mm", "iso-a4x6", "A4x6", 297, 1261),
117 _PWG_MEDIA_MM("iso_a4x7_297x1471mm", "iso-a4x7", "A4x7", 297, 1471),
118 _PWG_MEDIA_MM("iso_a4x8_297x1682mm", "iso-a4x8", "A4x8", 297, 1682),
119 _PWG_MEDIA_MM("iso_a4x9_297x1892mm", "iso-a4x9", "A4x9", 297, 1892),
54afec33
MS
120 _PWG_MEDIA_MM("iso_a3-extra_322x445mm", "iso-a3-extra", "A3Extra", 322, 445),
121 _PWG_MEDIA_MM("iso_a2_420x594mm", "iso-a2", "A2", 420, 594),
23862bc6
MS
122 _PWG_MEDIA_MM("iso_a3x3_420x891mm", "iso-a3x3", "A3x3", 420, 891),
123 _PWG_MEDIA_MM("iso_a3x4_420x1189mm", "iso-a3x4", "A3x4", 420, 1189),
124 _PWG_MEDIA_MM("iso_a3x5_420x1486mm", "iso-a3x5", "A3x6", 420, 1486),
125 _PWG_MEDIA_MM("iso_a3x6_420x1783mm", "iso-a3x6", "A3x6", 420, 1783),
126 _PWG_MEDIA_MM("iso_a3x7_420x2080mm", "iso-a3x7", "A3x7", 420, 2080),
54afec33 127 _PWG_MEDIA_MM("iso_a1_594x841mm", "iso-a1", "A1", 594, 841),
23862bc6
MS
128 _PWG_MEDIA_MM("iso_a2x3_594x1261mm", "iso-a2x3", "A2x3", 594, 1261),
129 _PWG_MEDIA_MM("iso_a2x4_594x1682mm", "iso-a2x4", "A2x4", 594, 1682),
130 _PWG_MEDIA_MM("iso_a2x5_594x2102mm", "iso-a2x5", "A2x5", 594, 2102),
54afec33 131 _PWG_MEDIA_MM("iso_a0_841x1189mm", "iso-a0", "A0", 841, 1189),
23862bc6
MS
132 _PWG_MEDIA_MM("iso_a1x3_841x1783mm", "iso-a1x3", "A1x3", 841, 1783),
133 _PWG_MEDIA_MM("iso_a1x4_841x2378mm", "iso-a1x4", "A1x4", 841, 2378),
134 _PWG_MEDIA_MM("iso_2a0_1189x1682mm", NULL, "1189x1682mm", 1189, 1682),
135 _PWG_MEDIA_MM("iso_a0x3_1189x2523mm", NULL, "A0x3", 1189, 2523),
54afec33
MS
136 _PWG_MEDIA_MM("iso_b10_31x44mm", "iso-b10", "ISOB10", 31, 44),
137 _PWG_MEDIA_MM("iso_b9_44x62mm", "iso-b9", "ISOB9", 44, 62),
138 _PWG_MEDIA_MM("iso_b8_62x88mm", "iso-b8", "ISOB8", 62, 88),
139 _PWG_MEDIA_MM("iso_b7_88x125mm", "iso-b7", "ISOB7", 88, 125),
140 _PWG_MEDIA_MM("iso_b6_125x176mm", "iso-b6", "ISOB6", 125, 176),
23862bc6 141 _PWG_MEDIA_MM("iso_b6c4_125x324mm", NULL, "125x324mm", 125, 324),
54afec33
MS
142 _PWG_MEDIA_MM("iso_b5_176x250mm", "iso-b5", "ISOB5", 176, 250),
143 _PWG_MEDIA_MM("iso_b5-extra_201x276mm", NULL, "ISOB5Extra", 201, 276),
144 _PWG_MEDIA_MM("iso_b4_250x353mm", "iso-b4", "ISOB4", 250, 353),
145 _PWG_MEDIA_MM("iso_b3_353x500mm", "iso-b3", "ISOB3", 353, 500),
146 _PWG_MEDIA_MM("iso_b2_500x707mm", "iso-b2", "ISOB2", 500, 707),
147 _PWG_MEDIA_MM("iso_b1_707x1000mm", "iso-b1", "ISOB1", 707, 1000),
148 _PWG_MEDIA_MM("iso_b0_1000x1414mm", "iso-b0", "ISOB0", 1000, 1414),
23862bc6
MS
149 _PWG_MEDIA_MM("iso_c10_28x40mm", "iso-c10", "EnvC10", 28, 40),
150 _PWG_MEDIA_MM("iso_c9_40x57mm", "iso-c9", "EnvC9", 40, 57),
151 _PWG_MEDIA_MM("iso_c8_57x81mm", "iso-c8", "EnvC8", 57, 81),
54afec33 152 _PWG_MEDIA_MM("iso_c7_81x114mm", "iso-c7", "EnvC7", 81, 114),
23862bc6 153 _PWG_MEDIA_MM("iso_c7c6_81x162mm", NULL, "EnvC76", 81, 162),
54afec33
MS
154 _PWG_MEDIA_MM("iso_c6_114x162mm", "iso-c6", "EnvC6", 114, 162),
155 _PWG_MEDIA_MM("iso_c6c5_114x229mm", NULL, "EnvC65", 114, 229),
156 _PWG_MEDIA_MM("iso_c5_162x229mm", "iso-c5", "EnvC5", 162, 229),
157 _PWG_MEDIA_MM("iso_c4_229x324mm", "iso-c4", "EnvC4", 229, 324),
158 _PWG_MEDIA_MM("iso_c3_324x458mm", "iso-c3", "EnvC3", 324, 458),
159 _PWG_MEDIA_MM("iso_c2_458x648mm", "iso-c2", "EnvC2", 458, 648),
160 _PWG_MEDIA_MM("iso_c1_648x917mm", "iso-c1", "EnvC1", 648, 917),
161 _PWG_MEDIA_MM("iso_c0_917x1297mm", "iso-c0", "EnvC0", 917, 1297),
162 _PWG_MEDIA_MM("iso_dl_110x220mm", "iso-designated", "EnvDL", 110, 220),
23862bc6
MS
163 _PWG_MEDIA_MM("iso_ra4_215x305mm", "iso-ra4", "RA4", 215, 305),
164 _PWG_MEDIA_MM("iso_sra4_225x320mm", "iso-sra4", "SRA4", 225, 320),
165 _PWG_MEDIA_MM("iso_ra3_305x430mm", "iso-ra3", "RA3", 305, 430),
166 _PWG_MEDIA_MM("iso_sra3_320x450mm", "iso-sra3", "SRA3", 320, 450),
167 _PWG_MEDIA_MM("iso_ra2_430x610mm", "iso-ra2", "RA2", 430, 610),
168 _PWG_MEDIA_MM("iso_sra2_450x640mm", "iso-sra2", "SRA2", 450, 640),
169 _PWG_MEDIA_MM("iso_ra1_610x860mm", "iso-ra1", "RA1", 610, 860),
170 _PWG_MEDIA_MM("iso_sra1_640x900mm", "iso-sra1", "SRA1", 640, 900),
171 _PWG_MEDIA_MM("iso_ra0_860x1220mm", "iso-ra0", "RA0", 860, 1220),
172 _PWG_MEDIA_MM("iso_sra0_900x1280mm", "iso-sra0", "SRA0", 900, 1280),
54afec33
MS
173
174 /* Japanese Standard Sheet Media Sizes */
175 _PWG_MEDIA_MM("jis_b10_32x45mm", "jis-b10", "B10", 32, 45),
176 _PWG_MEDIA_MM("jis_b9_45x64mm", "jis-b9", "B9", 45, 64),
177 _PWG_MEDIA_MM("jis_b8_64x91mm", "jis-b8", "B8", 64, 91),
178 _PWG_MEDIA_MM("jis_b7_91x128mm", "jis-b7", "B7", 91, 128),
179 _PWG_MEDIA_MM("jis_b6_128x182mm", "jis-b6", "B6", 128, 182),
180 _PWG_MEDIA_MM("jis_b5_182x257mm", "jis-b5", "B5", 182, 257),
181 _PWG_MEDIA_MM("jis_b4_257x364mm", "jis-b4", "B4", 257, 364),
182 _PWG_MEDIA_MM("jis_b3_364x515mm", "jis-b3", "B3", 364, 515),
183 _PWG_MEDIA_MM("jis_b2_515x728mm", "jis-b2", "B2", 515, 728),
184 _PWG_MEDIA_MM("jis_b1_728x1030mm", "jis-b1", "B1", 728, 1030),
185 _PWG_MEDIA_MM("jis_b0_1030x1456mm", "jis-b0", "B0", 1030, 1456),
23862bc6 186 _PWG_MEDIA_MM("jis_exec_216x330mm", NULL, "216x330mm", 216, 330),
5d8b7d26 187 _PWG_MEDIA_MM("jpn_kaku1_270x382mm", NULL, "EnvKaku1", 270, 382),
a469f8a5
MS
188 _PWG_MEDIA_MM("jpn_kaku2_240x332mm", NULL, "EnvKaku2", 240, 332),
189 _PWG_MEDIA_MM("jpn_kaku3_216x277mm", NULL, "EnvKaku3", 216, 277),
190 _PWG_MEDIA_MM("jpn_kaku4_197x267mm", NULL, "EnvKaku4", 197, 267),
191 _PWG_MEDIA_MM("jpn_kaku5_190x240mm", NULL, "EnvKaku5", 190, 240),
192 _PWG_MEDIA_MM("jpn_kaku7_142x205mm", NULL, "EnvKaku7", 142, 205),
193 _PWG_MEDIA_MM("jpn_kaku8_119x197mm", NULL, "EnvKaku8", 119, 197),
54afec33
MS
194 _PWG_MEDIA_MM("jpn_chou4_90x205mm", NULL, "EnvChou4", 90, 205),
195 _PWG_MEDIA_MM("jpn_hagaki_100x148mm", NULL, "Postcard", 100, 148),
196 _PWG_MEDIA_MM("jpn_you4_105x235mm", NULL, "EnvYou4", 105, 235),
f3c17241 197 _PWG_MEDIA_MM("jpn_you6_98x190mm", NULL, "EnvYou6", 98, 190),
54afec33
MS
198 _PWG_MEDIA_MM("jpn_chou2_111.1x146mm", NULL, NULL, 111.1, 146),
199 _PWG_MEDIA_MM("jpn_chou3_120x235mm", NULL, "EnvChou3", 120, 235),
a469f8a5 200 _PWG_MEDIA_MM("jpn_chou40_90x225mm", NULL, "EnvChou40", 90, 225),
54afec33 201 _PWG_MEDIA_MM("jpn_oufuku_148x200mm", NULL, "DoublePostcardRotated", 148, 200),
23862bc6 202 _PWG_MEDIA_MM("jpn_kahu_240x322.1mm", NULL, "240x322mm", 240, 322.1),
54afec33
MS
203
204 /* Chinese Standard Sheet Media Sizes */
205 _PWG_MEDIA_MM("prc_32k_97x151mm", NULL, "PRC32K", 97, 151),
206 _PWG_MEDIA_MM("prc_1_102x165mm", NULL, "EnvPRC1", 102, 165),
207 _PWG_MEDIA_MM("prc_2_102x176mm", NULL, "EnvPRC2", 102, 176),
208 _PWG_MEDIA_MM("prc_4_110x208mm", NULL, "EnvPRC4", 110, 208),
54afec33
MS
209 _PWG_MEDIA_MM("prc_8_120x309mm", NULL, "EnvPRC8", 120, 309),
210 _PWG_MEDIA_MM("prc_6_120x320mm", NULL, NULL, 120, 320),
54afec33
MS
211 _PWG_MEDIA_MM("prc_16k_146x215mm", NULL, "PRC16K", 146, 215),
212 _PWG_MEDIA_MM("prc_7_160x230mm", NULL, "EnvPRC7", 160, 230),
23862bc6
MS
213 _PWG_MEDIA_MM("om_juuro-ku-kai_198x275mm", NULL, "198x275mm", 198, 275),
214 _PWG_MEDIA_MM("om_pa-kai_267x389mm", NULL, "267x389mm", 267, 389),
215 _PWG_MEDIA_MM("om_dai-pa-kai_275x395mm", NULL, "275x395mm", 275, 395),
54afec33 216
a469f8a5
MS
217 /* Chinese Standard Sheet Media Inch Sizes */
218 _PWG_MEDIA_IN("roc_16k_7.75x10.75in", NULL, "roc16k", 7.75, 10.75),
219 _PWG_MEDIA_IN("roc_8k_10.75x15.5in", NULL, "roc8k", 10.75, 15.5),
220
f228370c
MS
221 /* Other English Standard Sheet Media Sizes */
222 _PWG_MEDIA_IN("oe_photo-l_3.5x5in", NULL, "3.5x5", 3.5, 5),
223
54afec33 224 /* Other Metric Standard Sheet Media Sizes */
7fad1ee9 225 _PWG_MEDIA_MM("om_small-photo_100x150mm", NULL, "100x150mm", 100, 150),
54afec33 226 _PWG_MEDIA_MM("om_italian_110x230mm", NULL, "EnvItalian", 110, 230),
7fad1ee9 227 _PWG_MEDIA_MM("om_large-photo_200x300", NULL, "200x300mm", 200, 300),
54afec33 228 _PWG_MEDIA_MM("om_folio_210x330mm", "folio", "Folio", 210, 330),
bb0d23b2 229 _PWG_MEDIA_MM("om_folio-sp_215x315mm", NULL, "FolioSP", 215, 315),
a469f8a5 230 _PWG_MEDIA_MM("om_invite_220x220mm", NULL, "EnvInvite", 220, 220),
7fad1ee9 231 _PWG_MEDIA_MM("om_small-photo_100x200mm", NULL, "100x200mm", 100, 200),
d71488ec
MS
232
233 /* Disc Sizes */
23862bc6 234 _PWG_MEDIA_MM("disc_standard_40x118mm", NULL, "Disc", 118, 118)
54afec33
MS
235};
236
237
a29fd7dd 238/*
6961465f
MS
239 * 'pwgFormatSizeName()' - Generate a PWG self-describing media size name.
240 *
241 * This function generates a PWG self-describing media size name of the form
242 * "prefix_name_WIDTHxLENGTHunits". The prefix is typically "custom" or "roll"
243 * for user-supplied sizes but can also be "disc", "iso", "jis", "jpn", "na",
244 * "oe", "om", "prc", or "roc". A value of @code NULL@ automatically chooses
245 * "oe" or "om" depending on the units.
246 *
247 * The size name may only contain lowercase letters, numbers, "-", and ".". If
248 * @code NULL@ is passed, the size name will contain the formatted dimensions.
249 *
250 * The width and length are specified in hundredths of millimeters, equivalent
251 * to 1/100000th of a meter or 1/2540th of an inch. The width, length, and
252 * units used for the generated size name are calculated automatically if the
253 * units string is @code NULL@, otherwise inches ("in") or millimeters ("mm")
254 * are used.
255 *
8072030b 256 * @since CUPS 1.7/macOS 10.9@
a29fd7dd
MS
257 */
258
6961465f
MS
259int /* O - 1 on success, 0 on failure */
260pwgFormatSizeName(char *keyword, /* I - Keyword buffer */
261 size_t keysize, /* I - Size of keyword buffer */
262 const char *prefix, /* I - Prefix for PWG size or @code NULL@ for automatic */
263 const char *name, /* I - Size name or @code NULL@ */
264 int width, /* I - Width of page in 2540ths */
265 int length, /* I - Length of page in 2540ths */
266 const char *units) /* I - Units - "in", "mm", or @code NULL@ for automatic */
a29fd7dd 267{
6961465f
MS
268 char usize[12 + 1 + 12 + 3], /* Unit size: NNNNNNNNNNNNxNNNNNNNNNNNNuu */
269 *uptr; /* Pointer into unit size */
270 char *(*format)(char *, size_t, int);
271 /* Formatting function */
a29fd7dd
MS
272
273
274 /*
6961465f 275 * Range check input...
a29fd7dd
MS
276 */
277
807315e6 278 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));
a29fd7dd 279
6961465f
MS
280 if (keyword)
281 *keyword = '\0';
a29fd7dd 282
6961465f
MS
283 if (!keyword || keysize < 32 || width < 0 || length < 0 ||
284 (units && strcmp(units, "in") && strcmp(units, "mm")))
285 {
286 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Invalid media name arguments."),
287 1);
288 return (0);
289 }
a29fd7dd 290
6961465f
MS
291 if (name)
292 {
293 /*
294 * Validate name...
295 */
a29fd7dd 296
6961465f 297 const char *nameptr; /* Pointer into name */
a29fd7dd 298
6961465f
MS
299 for (nameptr = name; *nameptr; nameptr ++)
300 if (!(*nameptr >= 'a' && *nameptr <= 'z') &&
301 !(*nameptr >= '0' && *nameptr <= '9') &&
302 *nameptr != '.' && *nameptr != '-')
303 {
304 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
305 _("Invalid media name arguments."), 1);
306 return (0);
307 }
308 }
a29fd7dd 309 else
6961465f 310 name = usize;
a29fd7dd 311
d71488ec
MS
312 if (prefix && !strcmp(prefix, "disc"))
313 width = 4000; /* Disc sizes use hardcoded 40mm inner diameter */
a29fd7dd 314
6961465f
MS
315 if (!units)
316 {
317 if ((width % 635) == 0 && (length % 635) == 0)
318 {
319 /*
320 * Use inches since the size is a multiple of 1/4 inch.
321 */
54afec33 322
6961465f
MS
323 units = "in";
324 }
325 else
326 {
327 /*
328 * Use millimeters since the size is not a multiple of 1/4 inch.
329 */
54afec33 330
6961465f
MS
331 units = "mm";
332 }
333 }
54afec33 334
6961465f 335 if (!strcmp(units, "in"))
54afec33 336 {
6961465f 337 format = pwg_format_inches;
54afec33
MS
338
339 if (!prefix)
340 prefix = "oe";
341 }
342 else
343 {
6961465f 344 format = pwg_format_millimeters;
54afec33
MS
345
346 if (!prefix)
347 prefix = "om";
348 }
349
6961465f
MS
350 /*
351 * Format the size string...
352 */
353
54afec33 354 uptr = usize;
7e86f2f6 355 (*format)(uptr, sizeof(usize) - (size_t)(uptr - usize), width);
54afec33
MS
356 uptr += strlen(uptr);
357 *uptr++ = 'x';
7e86f2f6 358 (*format)(uptr, sizeof(usize) - (size_t)(uptr - usize), length);
54afec33
MS
359 uptr += strlen(uptr);
360
361 /*
362 * Safe because usize can hold up to 12 + 1 + 12 + 4 bytes.
363 */
364
a29fd7dd 365 memcpy(uptr, units, 3);
54afec33 366
54afec33
MS
367 /*
368 * Format the name...
369 */
370
371 snprintf(keyword, keysize, "%s_%s_%s", prefix, name, usize);
6961465f
MS
372
373 return (1);
54afec33
MS
374}
375
376
377/*
6961465f
MS
378 * 'pwgInitSize()' - Initialize a pwg_size_t structure using IPP Job Template
379 * attributes.
380 *
381 * This function initializes a pwg_size_t structure from an IPP "media" or
382 * "media-col" attribute in the specified IPP message. 0 is returned if neither
383 * attribute is found in the message or the values are not valid.
384 *
385 * The "margins_set" variable is initialized to 1 if any "media-xxx-margin"
386 * member attribute was specified in the "media-col" Job Template attribute,
387 * otherwise it is initialized to 0.
388 *
8072030b 389 * @since CUPS 1.7/macOS 10.9@
54afec33
MS
390 */
391
6961465f
MS
392int /* O - 1 if size was initialized, 0 otherwise */
393pwgInitSize(pwg_size_t *size, /* I - Size to initialize */
394 ipp_t *job, /* I - Job template attributes */
395 int *margins_set) /* O - 1 if margins were set, 0 otherwise */
54afec33
MS
396{
397 ipp_attribute_t *media, /* media attribute */
398 *media_bottom_margin, /* media-bottom-margin member attribute */
399 *media_col, /* media-col attribute */
400 *media_left_margin, /* media-left-margin member attribute */
401 *media_right_margin, /* media-right-margin member attribute */
402 *media_size, /* media-size member attribute */
403 *media_top_margin, /* media-top-margin member attribute */
404 *x_dimension, /* x-dimension member attribute */
405 *y_dimension; /* y-dimension member attribute */
6961465f 406 pwg_media_t *pwg; /* PWG media value */
54afec33
MS
407
408
409 /*
410 * Range check input...
411 */
412
413 if (!size || !job || !margins_set)
414 return (0);
415
416 /*
417 * Look for media-col and then media...
418 */
419
6961465f 420 memset(size, 0, sizeof(pwg_size_t));
54afec33
MS
421 *margins_set = 0;
422
423 if ((media_col = ippFindAttribute(job, "media-col",
424 IPP_TAG_BEGIN_COLLECTION)) != NULL)
425 {
426 /*
427 * Got media-col, look for media-size member attribute...
428 */
429
430 if ((media_size = ippFindAttribute(media_col->values[0].collection,
7cf5915e
MS
431 "media-size",
432 IPP_TAG_BEGIN_COLLECTION)) != NULL)
54afec33
MS
433 {
434 /*
435 * Got media-size, look for x-dimension and y-dimension member
436 * attributes...
437 */
438
439 x_dimension = ippFindAttribute(media_size->values[0].collection,
440 "x-dimension", IPP_TAG_INTEGER);
441 y_dimension = ippFindAttribute(media_size->values[0].collection,
442 "y-dimension", IPP_TAG_INTEGER);
443
444 if (x_dimension && y_dimension)
445 {
446 size->width = x_dimension->values[0].integer;
447 size->length = y_dimension->values[0].integer;
448 }
449 else if (!x_dimension)
450 {
cb7f98ee 451 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
54afec33
MS
452 _("Missing x-dimension in media-size."), 1);
453 return (0);
454 }
455 else if (!y_dimension)
456 {
cb7f98ee 457 _cupsSetError(IPP_STATUS_ERROR_INTERNAL,
54afec33
MS
458 _("Missing y-dimension in media-size."), 1);
459 return (0);
460 }
461 }
462 else
463 {
cb7f98ee 464 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Missing media-size in media-col."),
54afec33
MS
465 1);
466 return (0);
467 }
468
469 /* media-*-margin */
470 media_bottom_margin = ippFindAttribute(media_col->values[0].collection,
471 "media-bottom-margin",
472 IPP_TAG_INTEGER);
473 media_left_margin = ippFindAttribute(media_col->values[0].collection,
474 "media-left-margin",
475 IPP_TAG_INTEGER);
476 media_right_margin = ippFindAttribute(media_col->values[0].collection,
477 "media-right-margin",
478 IPP_TAG_INTEGER);
479 media_top_margin = ippFindAttribute(media_col->values[0].collection,
480 "media-top-margin",
481 IPP_TAG_INTEGER);
482 if (media_bottom_margin && media_left_margin && media_right_margin &&
483 media_top_margin)
484 {
485 *margins_set = 1;
486 size->bottom = media_bottom_margin->values[0].integer;
487 size->left = media_left_margin->values[0].integer;
488 size->right = media_right_margin->values[0].integer;
489 size->top = media_top_margin->values[0].integer;
490 }
491 }
492 else
493 {
494 if ((media = ippFindAttribute(job, "media", IPP_TAG_NAME)) == NULL)
7cf5915e
MS
495 if ((media = ippFindAttribute(job, "media", IPP_TAG_KEYWORD)) == NULL)
496 if ((media = ippFindAttribute(job, "PageSize", IPP_TAG_NAME)) == NULL)
497 media = ippFindAttribute(job, "PageRegion", IPP_TAG_NAME);
54afec33 498
5a9febac 499 if (media && media->values[0].string.text)
54afec33 500 {
7cf5915e
MS
501 const char *name = media->values[0].string.text;
502 /* Name string */
503
6961465f 504 if ((pwg = pwgMediaForPWG(name)) == NULL)
7cf5915e
MS
505 {
506 /*
507 * Not a PWG name, try a legacy name...
508 */
509
6961465f 510 if ((pwg = pwgMediaForLegacy(name)) == NULL)
7cf5915e
MS
511 {
512 /*
513 * Not a legacy name, try a PPD name...
514 */
515
516 const char *suffix; /* Suffix on media string */
517
6961465f 518 pwg = pwgMediaForPPD(name);
84315f46 519 if (pwg &&
7cf5915e 520 (suffix = name + strlen(name) - 10 /* .FullBleed */) > name &&
88f9aafc 521 !_cups_strcasecmp(suffix, ".FullBleed"))
7cf5915e
MS
522 {
523 /*
524 * Indicate that margins are set with the default values of 0.
525 */
526
527 *margins_set = 1;
528 }
529 }
530 }
54afec33
MS
531
532 if (pwg)
533 {
534 size->width = pwg->width;
535 size->length = pwg->length;
536 }
537 else
538 {
cb7f98ee 539 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Unsupported media value."), 1);
54afec33
MS
540 return (0);
541 }
542 }
543 else
544 {
cb7f98ee 545 _cupsSetError(IPP_STATUS_ERROR_INTERNAL, _("Missing media or media-col."), 1);
54afec33
MS
546 return (0);
547 }
548 }
549
550 return (1);
551}
552
553
554/*
6961465f
MS
555 * 'pwgMediaForLegacy()' - Find a PWG media size by ISO/IPP legacy name.
556 *
557 * The "name" argument specifies the legacy ISO media size name, for example
558 * "iso-a4" or "na-letter".
559 *
8072030b 560 * @since CUPS 1.7/macOS 10.9@
54afec33
MS
561 */
562
6961465f
MS
563pwg_media_t * /* O - Matching size or NULL */
564pwgMediaForLegacy(const char *legacy) /* I - Legacy size name */
54afec33 565{
6961465f 566 pwg_media_t key; /* Search key */
54afec33
MS
567 _cups_globals_t *cg = _cupsGlobals(); /* Global data */
568
569
570 /*
571 * Range check input...
572 */
573
574 if (!legacy)
575 return (NULL);
576
577 /*
578 * Build the lookup table for PWG names as needed...
579 */
580
581 if (!cg->leg_size_lut)
582 {
583 int i; /* Looping var */
6961465f 584 pwg_media_t *size; /* Current size */
54afec33
MS
585
586 cg->leg_size_lut = cupsArrayNew((cups_array_func_t)pwg_compare_legacy,
587 NULL);
588
589 for (i = (int)(sizeof(cups_pwg_media) / sizeof(cups_pwg_media[0])),
6961465f 590 size = (pwg_media_t *)cups_pwg_media;
54afec33
MS
591 i > 0;
592 i --, size ++)
593 if (size->legacy)
594 cupsArrayAdd(cg->leg_size_lut, size);
595 }
596
597 /*
598 * Lookup the name...
599 */
600
601 key.legacy = legacy;
6961465f 602 return ((pwg_media_t *)cupsArrayFind(cg->leg_size_lut, &key));
54afec33
MS
603}
604
605
606/*
6961465f
MS
607 * 'pwgMediaForPPD()' - Find a PWG media size by Adobe PPD name.
608 *
609 * The "ppd" argument specifies an Adobe page size name as defined in Table B.1
610 * of the Adobe PostScript Printer Description File Format Specification Version
611 * 4.3.
612 *
613 * If the name is non-standard, the returned PWG media size is stored in
614 * thread-local storage and is overwritten by each call to the function in the
615 * thread. Custom names can be of the form "Custom.WIDTHxLENGTH[units]" or
616 * "WIDTHxLENGTH[units]".
617 *
8072030b 618 * @since CUPS 1.7/macOS 10.9@
54afec33
MS
619 */
620
6961465f
MS
621pwg_media_t * /* O - Matching size or NULL */
622pwgMediaForPPD(const char *ppd) /* I - PPD size name */
54afec33 623{
6961465f 624 pwg_media_t key, /* Search key */
7cf5915e 625 *size; /* Matching size */
54afec33
MS
626 _cups_globals_t *cg = _cupsGlobals(); /* Global data */
627
628
629 /*
630 * Range check input...
631 */
632
633 if (!ppd)
634 return (NULL);
635
636 /*
637 * Build the lookup table for PWG names as needed...
638 */
639
640 if (!cg->ppd_size_lut)
641 {
7cf5915e 642 int i; /* Looping var */
54afec33
MS
643
644 cg->ppd_size_lut = cupsArrayNew((cups_array_func_t)pwg_compare_ppd, NULL);
645
646 for (i = (int)(sizeof(cups_pwg_media) / sizeof(cups_pwg_media[0])),
6961465f 647 size = (pwg_media_t *)cups_pwg_media;
54afec33
MS
648 i > 0;
649 i --, size ++)
650 if (size->ppd)
651 cupsArrayAdd(cg->ppd_size_lut, size);
652 }
653
654 /*
655 * Lookup the name...
656 */
657
658 key.ppd = ppd;
6961465f 659 if ((size = (pwg_media_t *)cupsArrayFind(cg->ppd_size_lut, &key)) == NULL)
7cf5915e
MS
660 {
661 /*
662 * See if the name is of the form:
663 *
664 * [Custom.]WIDTHxLENGTH[.FullBleed] - Size in points/inches [borderless]
665 * [Custom.]WIDTHxLENGTHcm[.FullBleed] - Size in centimeters [borderless]
666 * [Custom.]WIDTHxLENGTHft[.FullBleed] - Size in feet [borderless]
667 * [Custom.]WIDTHxLENGTHin[.FullBleed] - Size in inches [borderless]
668 * [Custom.]WIDTHxLENGTHm[.FullBleed] - Size in meters [borderless]
669 * [Custom.]WIDTHxLENGTHmm[.FullBleed] - Size in millimeters [borderless]
670 * [Custom.]WIDTHxLENGTHpt[.FullBleed] - Size in points [borderless]
671 */
672
4fcfa0cf
MS
673 int w, l, /* Width and length of page */
674 numer, /* Unit scaling factor */
675 denom; /* ... */
7cf5915e 676 char *ptr; /* Pointer into name */
4fcfa0cf 677 const char *units; /* Pointer to units */
7cf5915e
MS
678 int custom; /* Custom page size? */
679
4fcfa0cf 680
88f9aafc 681 if (!_cups_strncasecmp(ppd, "Custom.", 7))
7cf5915e
MS
682 {
683 custom = 1;
4fcfa0cf
MS
684 numer = 2540;
685 denom = 72;
7cf5915e
MS
686 ptr = (char *)ppd + 7;
687 }
688 else
689 {
690 custom = 0;
4fcfa0cf
MS
691 numer = 2540;
692 denom = 1;
7cf5915e
MS
693 ptr = (char *)ppd;
694 }
695
4fcfa0cf
MS
696 /*
697 * Find any units in the size...
698 */
7cf5915e 699
4fcfa0cf
MS
700 units = strchr(ptr, '.');
701 while (units && isdigit(units[1] & 255))
702 units = strchr(units + 1, '.');
703
704 if (units)
705 units -= 2;
706 else
707 units = ptr + strlen(ptr) - 2;
708
709 if (units > ptr)
7cf5915e 710 {
4fcfa0cf
MS
711 if (isdigit(*units & 255) || *units == '.')
712 units ++;
713
714 if (!_cups_strncasecmp(units, "cm", 2))
715 {
716 numer = 1000;
717 denom = 1;
718 }
719 else if (!_cups_strncasecmp(units, "ft", 2))
720 {
721 numer = 2540 * 12;
722 denom = 1;
723 }
724 else if (!_cups_strncasecmp(units, "in", 2))
725 {
726 numer = 2540;
727 denom = 1;
728 }
729 else if (!_cups_strncasecmp(units, "mm", 2))
730 {
731 numer = 100;
732 denom = 1;
733 }
734 else if (*units == 'm' || *units == 'M')
7cf5915e 735 {
4fcfa0cf
MS
736 numer = 100000;
737 denom = 1;
738 }
739 else if (!_cups_strncasecmp(units, "pt", 2))
740 {
741 numer = 2540;
742 denom = 72;
743 }
744 }
745
746 w = pwg_scan_measurement(ptr, &ptr, numer, denom);
747
748 if (ptr && ptr > ppd && *ptr == 'x')
749 {
750 l = pwg_scan_measurement(ptr + 1, &ptr, numer, denom);
7cf5915e 751
4fcfa0cf
MS
752 if (ptr)
753 {
7cf5915e
MS
754 /*
755 * Not a standard size; convert it to a PWG custom name of the form:
756 *
757 * [oe|om]_WIDTHxHEIGHTuu_WIDTHxHEIGHTuu
758 */
759
23862bc6
MS
760 char wstr[32], lstr[32]; /* Width and length as strings */
761
4fcfa0cf
MS
762 size = &(cg->pwg_media);
763 size->width = w;
764 size->length = l;
7cf5915e
MS
765 size->pwg = cg->pwg_name;
766
6961465f
MS
767 pwgFormatSizeName(cg->pwg_name, sizeof(cg->pwg_name),
768 custom ? "custom" : NULL, custom ? ppd + 7 : NULL,
769 size->width, size->length, NULL);
23862bc6
MS
770
771 if ((w % 635) == 0 && (l % 635) == 0)
772 snprintf(cg->ppd_name, sizeof(cg->ppd_name), "%sx%s", pwg_format_inches(wstr, sizeof(wstr), w), pwg_format_inches(lstr, sizeof(lstr), l));
773 else
774 snprintf(cg->ppd_name, sizeof(cg->ppd_name), "%sx%smm", pwg_format_millimeters(wstr, sizeof(wstr), w), pwg_format_millimeters(lstr, sizeof(lstr), l));
775 size->ppd = cg->ppd_name;
7cf5915e
MS
776 }
777 }
778 }
779
780 return (size);
54afec33
MS
781}
782
783
784/*
6961465f
MS
785 * 'pwgMediaForPWG()' - Find a PWG media size by 5101.1 self-describing name.
786 *
787 * The "pwg" argument specifies a self-describing media size name of the form
788 * "prefix_name_WIDTHxLENGTHunits" as defined in PWG 5101.1.
789 *
790 * If the name is non-standard, the returned PWG media size is stored in
791 * thread-local storage and is overwritten by each call to the function in the
792 * thread.
793 *
8072030b 794 * @since CUPS 1.7/macOS 10.9@
54afec33
MS
795 */
796
6961465f
MS
797pwg_media_t * /* O - Matching size or NULL */
798pwgMediaForPWG(const char *pwg) /* I - PWG size name */
54afec33 799{
7cf5915e 800 char *ptr; /* Pointer into name */
6961465f 801 pwg_media_t key, /* Search key */
7cf5915e 802 *size; /* Matching size */
54afec33
MS
803 _cups_globals_t *cg = _cupsGlobals(); /* Global data */
804
805
806 /*
807 * Range check input...
808 */
809
810 if (!pwg)
811 return (NULL);
812
813 /*
814 * Build the lookup table for PWG names as needed...
815 */
816
817 if (!cg->pwg_size_lut)
818 {
7cf5915e 819 int i; /* Looping var */
54afec33
MS
820
821 cg->pwg_size_lut = cupsArrayNew((cups_array_func_t)pwg_compare_pwg, NULL);
822
823 for (i = (int)(sizeof(cups_pwg_media) / sizeof(cups_pwg_media[0])),
6961465f 824 size = (pwg_media_t *)cups_pwg_media;
54afec33
MS
825 i > 0;
826 i --, size ++)
827 cupsArrayAdd(cg->pwg_size_lut, size);
828 }
829
830 /*
831 * Lookup the name...
832 */
833
834 key.pwg = pwg;
6961465f 835 if ((size = (pwg_media_t *)cupsArrayFind(cg->pwg_size_lut, &key)) == NULL &&
7cf5915e
MS
836 (ptr = (char *)strchr(pwg, '_')) != NULL &&
837 (ptr = (char *)strchr(ptr + 1, '_')) != NULL)
838 {
839 /*
840 * Try decoding the self-describing name of the form:
841 *
84de5e92
MS
842 * class_name_WWWxHHHin[_something]
843 * class_name_WWWxHHHmm[_something]
7cf5915e
MS
844 */
845
4fcfa0cf
MS
846 int w, l; /* Width and length of page */
847 int numer; /* Scale factor for units */
84de5e92 848 const char *units; /* Units from size */
7cf5915e 849
84de5e92
MS
850 if ((units = strchr(ptr + 1, '_')) != NULL)
851 units -= 2;
852 else
853 units = ptr + strlen(ptr) - 2;
4fcfa0cf 854
84de5e92
MS
855 ptr ++;
856
857 if (units >= ptr && (!strcmp(units, "in") || !strncmp(units, "in_", 3)))
4fcfa0cf
MS
858 numer = 2540;
859 else
860 numer = 100;
861
862 w = pwg_scan_measurement(ptr, &ptr, numer, 1);
7cf5915e
MS
863
864 if (ptr && *ptr == 'x')
865 {
4fcfa0cf 866 l = pwg_scan_measurement(ptr + 1, &ptr, numer, 1);
7cf5915e 867
4fcfa0cf 868 if (ptr)
7cf5915e 869 {
23862bc6
MS
870 char wstr[32], lstr[32]; /* Width and length strings */
871
d71488ec
MS
872 if (!strncmp(pwg, "disc_", 5))
873 w = l; /* Make the media size OUTERxOUTER */
874
4fcfa0cf
MS
875 size = &(cg->pwg_media);
876 size->width = w;
877 size->length = l;
7cf5915e
MS
878
879 strlcpy(cg->pwg_name, pwg, sizeof(cg->pwg_name));
880 size->pwg = cg->pwg_name;
23862bc6
MS
881
882 if (numer == 100)
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));
884 else
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;
7cf5915e
MS
887 }
888 }
889 }
890
891 return (size);
54afec33
MS
892}
893
894
895/*
6961465f
MS
896 * 'pwgMediaForSize()' - Get the PWG media size for the given dimensions.
897 *
898 * The "width" and "length" are in hundredths of millimeters, equivalent to
899 * 1/100000th of a meter or 1/2540th of an inch.
900 *
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
903 * thread.
904 *
8072030b 905 * @since CUPS 1.7/macOS 10.9@
54afec33
MS
906 */
907
6961465f
MS
908pwg_media_t * /* O - PWG media name */
909pwgMediaForSize(int width, /* I - Width in hundredths of millimeters */
910 int length) /* I - Length in hundredths of millimeters */
c3ebc4c6 911{
00339094
MS
912 /*
913 * Adobe uses a size matching algorithm with an epsilon of 5 points, which
914 * is just about 176/2540ths...
915 */
916
917 return (_pwgMediaNearSize(width, length, 176));
c3ebc4c6
MS
918}
919
00339094
MS
920
921/*
922 * '_pwgMediaNearSize()' - Get the PWG media size within the given tolerance.
923 */
924
c3ebc4c6
MS
925pwg_media_t * /* O - PWG media name */
926_pwgMediaNearSize(int width, /* I - Width in hundredths of millimeters */
00339094
MS
927 int length, /* I - Length in hundredths of millimeters */
928 int epsilon) /* I - Match within this tolernace. PWG units */
54afec33
MS
929{
930 int i; /* Looping var */
6961465f 931 pwg_media_t *media, /* Current media */
f3c17241
MS
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 */
935 best_dl = 999;
23862bc6 936 char wstr[32], lstr[32]; /* Width and length as strings */
54afec33
MS
937 _cups_globals_t *cg = _cupsGlobals(); /* Global data */
938
939
940 /*
941 * Range check input...
942 */
943
944 if (width <= 0 || length <= 0)
945 return (NULL);
946
947 /*
948 * Look for a standard size...
949 */
950
951 for (i = (int)(sizeof(cups_pwg_media) / sizeof(cups_pwg_media[0])),
6961465f 952 media = (pwg_media_t *)cups_pwg_media;
54afec33
MS
953 i > 0;
954 i --, media ++)
955 {
54afec33 956
f3c17241
MS
957 dw = abs(media->width - width);
958 dl = abs(media->length - length);
54afec33 959
f3c17241 960 if (!dw && !dl)
54afec33 961 return (media);
c3ebc4c6 962 else if (dw <= epsilon && dl <= epsilon)
f3c17241
MS
963 {
964 if (dw <= best_dw && dl <= best_dl)
965 {
966 best_media = media;
967 best_dw = dw;
968 best_dl = dl;
969 }
970 }
54afec33
MS
971 }
972
f3c17241
MS
973 if (best_media)
974 return (best_media);
975
54afec33
MS
976 /*
977 * Not a standard size; convert it to a PWG custom name of the form:
978 *
979 * custom_WIDTHxHEIGHTuu_WIDTHxHEIGHTuu
980 */
981
6961465f
MS
982 pwgFormatSizeName(cg->pwg_name, sizeof(cg->pwg_name), "custom", NULL, width,
983 length, NULL);
54afec33
MS
984
985 cg->pwg_media.pwg = cg->pwg_name;
986 cg->pwg_media.width = width;
987 cg->pwg_media.length = length;
988
23862bc6
MS
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));
991 else
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;
994
54afec33
MS
995 return (&(cg->pwg_media));
996}
997
998
a552bd55
MS
999/*
1000 * '_pwgMediaTable()' - Return the internal media size table.
1001 */
1002
1003const pwg_media_t * /* O - Pointer to first entry */
1004_pwgMediaTable(size_t *num_media) /* O - Number of entries */
1005{
1006 *num_media = sizeof(cups_pwg_media) / sizeof(cups_pwg_media[0]);
1007
1008 return (cups_pwg_media);
1009}
1010
1011
54afec33
MS
1012/*
1013 * 'pwg_compare_legacy()' - Compare two sizes using the legacy names.
1014 */
1015
1016static int /* O - Result of comparison */
6961465f
MS
1017pwg_compare_legacy(pwg_media_t *a, /* I - First size */
1018 pwg_media_t *b) /* I - Second size */
54afec33
MS
1019{
1020 return (strcmp(a->legacy, b->legacy));
1021}
1022
1023
1024/*
1025 * 'pwg_compare_ppd()' - Compare two sizes using the PPD names.
1026 */
1027
1028static int /* O - Result of comparison */
6961465f
MS
1029pwg_compare_ppd(pwg_media_t *a, /* I - First size */
1030 pwg_media_t *b) /* I - Second size */
54afec33
MS
1031{
1032 return (strcmp(a->ppd, b->ppd));
1033}
1034
1035
1036/*
1037 * 'pwg_compare_pwg()' - Compare two sizes using the PWG names.
1038 */
1039
1040static int /* O - Result of comparison */
6961465f
MS
1041pwg_compare_pwg(pwg_media_t *a, /* I - First size */
1042 pwg_media_t *b) /* I - Second size */
54afec33
MS
1043{
1044 return (strcmp(a->pwg, b->pwg));
1045}
1046
1047
6961465f
MS
1048/*
1049 * 'pwg_format_inches()' - Convert and format PWG units as inches.
1050 */
1051
1052static char * /* O - String */
1053pwg_format_inches(char *buf, /* I - Buffer */
23862bc6
MS
1054 size_t bufsize, /* I - Size of buffer */
1055 int val) /* I - Value in hundredths of millimeters */
6961465f
MS
1056{
1057 int thousandths, /* Thousandths of inches */
1058 integer, /* Integer portion */
1059 fraction; /* Fractional portion */
1060
1061
1062 /*
1063 * Convert hundredths of millimeters to thousandths of inches and round to
1064 * the nearest thousandth.
1065 */
1066
1067 thousandths = (val * 1000 + 1270) / 2540;
1068 integer = thousandths / 1000;
1069 fraction = thousandths % 1000;
1070
1071 /*
1072 * Format as a pair of integers (avoids locale stuff), avoiding trailing
1073 * zeros...
1074 */
1075
1076 if (fraction == 0)
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);
1082 else
1083 snprintf(buf, bufsize, "%d.%01d", integer, fraction / 100);
1084
1085 return (buf);
1086}
1087
1088
1089/*
1090 * 'pwg_format_millimeters()' - Convert and format PWG units as millimeters.
1091 */
1092
1093static char * /* O - String */
1094pwg_format_millimeters(char *buf, /* I - Buffer */
23862bc6
MS
1095 size_t bufsize, /* I - Size of buffer */
1096 int val) /* I - Value in hundredths of millimeters */
6961465f
MS
1097{
1098 int integer, /* Integer portion */
1099 fraction; /* Fractional portion */
1100
1101
1102 /*
1103 * Convert hundredths of millimeters to integer and fractional portions.
1104 */
1105
1106 integer = val / 100;
1107 fraction = val % 100;
1108
1109 /*
1110 * Format as a pair of integers (avoids locale stuff), avoiding trailing
1111 * zeros...
1112 */
1113
1114 if (fraction == 0)
1115 snprintf(buf, bufsize, "%d", integer);
1116 else if (fraction % 10)
1117 snprintf(buf, bufsize, "%d.%02d", integer, fraction);
1118 else
1119 snprintf(buf, bufsize, "%d.%01d", integer, fraction / 10);
1120
1121 return (buf);
1122}
1123
1124
4fcfa0cf
MS
1125/*
1126 * 'pwg_scan_measurement()' - Scan a measurement in inches or millimeters.
1127 *
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).
1131 */
1132
1133static int /* O - Hundredths of millimeters */
1134pwg_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 */
1139{
1140 int value = 0, /* Measurement value */
4ffc4197 1141 fractional = 0, /* Fractional value */
4fcfa0cf
MS
1142 divisor = 1, /* Fractional divisor */
1143 digits = 10 * numer * denom; /* Maximum fractional value to read */
1144
1145
1146 /*
1147 * Scan integer portion...
1148 */
1149
1150 while (*buf >= '0' && *buf <= '9')
1151 value = value * 10 + (*buf++) - '0';
1152
1153 if (*buf == '.')
1154 {
1155 /*
1156 * Scan fractional portion...
1157 */
1158
1159 buf ++;
1160
1161 while (divisor < digits && *buf >= '0' && *buf <= '9')
1162 {
4ffc4197 1163 fractional = fractional * 10 + (*buf++) - '0';
4fcfa0cf
MS
1164 divisor *= 10;
1165 }
1166
1167 /*
1168 * Skip trailing digits that won't contribute...
1169 */
1170
1171 while (*buf >= '0' && *buf <= '9')
1172 buf ++;
1173 }
1174
1175 if (bufptr)
1176 *bufptr = (char *)buf;
1177
4ffc4197 1178 return (value * numer / denom + fractional * numer / denom / divisor);
4fcfa0cf 1179}