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