cups/pwgmedia.c

   1 /*
   2  * "$Id$"
   3  *
   4  *   PWG media name API implementation for the Common UNIX Printing System
   5  *   (CUPS).
   6  *
   7  *   Copyright 2009 by Apple Inc.
   8  *
   9  *   These coded instructions, statements, and computer programs are the
  10  *   property of Apple Inc. and are protected by Federal copyright
  11  *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  12  *   which should have been included with this file.  If this file is
  13  *   file is missing or damaged, see the license at "http://www.cups.org/".
  14  *
  15  * Contents:
  16  *
  17  *   _cupsPWGMediaByLegacy() - Find a PWG media size by ISO/IPP legacy name.
  18  *   _cupsPWGMediaByName()   - Find a PWG media size by 5101.1 self-describing
  19  *                             name.
  20  *   _cupsPWGMediaBySize()   - Find a PWG media size by size in points.
  21  *   compare_legacy()        - Compare two sizes using the legacy names.
  22  *   compare_pwg()           - Compare two sizes using the PWG names.
  23  */
  24
  25 /*
  26  * Include necessary headers...
  27  */
  28
  29 #include "pwgmedia.h"
  30 #include "globals.h"
  31 #include "string.h"
  32 #include "debug.h"
  33 #include <math.h>
  34
  35
  36 /*
  37  * Local macros...
  38  */
  39
  40 #define _CUPS_SIZE_IN(p,l,x,y)  {p, l, x * 72.0, y * 72.0}
  41 #define _CUPS_SIZE_MM(p,l,x,y)  {p, l, x / 25.4 * 72.0, y / 25.4 * 72.0}
  42
  43
  44 /*
  45  * Local functions...
  46  */
  47
  48 static int      compare_legacy(_cups_pwg_media_t *a, _cups_pwg_media_t *b);
  49 static int      compare_pwg(_cups_pwg_media_t *a, _cups_pwg_media_t *b);
  50
  51
  52 /*
  53  * Local globals...
  54  */
  55
  56 static _cups_pwg_media_t const cups_pwg_media[] =
  57 {                                       /* Media size lookup table */
  58   /* North American Standard Sheet Media Sizes */
  59   _CUPS_SIZE_IN("na_index-3x5_3x5in", NULL, 3, 5),
  60   _CUPS_SIZE_IN("na_personal_3.625x6.5in", NULL, 3.625, 6.5),
  61   _CUPS_SIZE_IN("na_monarch_3.875x7.5in", "monarch-envelope", 3.875, 7.5),
  62   _CUPS_SIZE_IN("na_number-9_3.875x8.875in", "na-number-9-envelope", 3.875, 8.875),
  63   _CUPS_SIZE_IN("na_index-4x6_4x6in", NULL, 4, 6),
  64   _CUPS_SIZE_IN("na_number-10_4.125x9.5in", "na-number-10-envelope", 4.125, 9.5),
  65   _CUPS_SIZE_IN("na_a2_4.375x5.75in", NULL, 4.375, 5.75),
  66   _CUPS_SIZE_IN("na_number-11_4.5x10.375in", NULL, 4.5, 10.375),
  67   _CUPS_SIZE_IN("na_number-12_4.75x11in", NULL, 4.75, 11),
  68   _CUPS_SIZE_IN("na_5x7_5x7in", NULL, 5, 7),
  69   _CUPS_SIZE_IN("na_index-5x8_5x8in", NULL, 5, 8),
  70   _CUPS_SIZE_IN("na_number-14_5x11.5in", NULL, 5, 11.5),
  71   _CUPS_SIZE_IN("na_invoice_5.5x8.5in", "invoice", 5.5, 8.5),
  72   _CUPS_SIZE_IN("na_index-4x6-ext_6x8in", NULL, 6, 8),
  73   _CUPS_SIZE_IN("na_6x9_6x9in", "na-6x9-envelope", 6, 9),
  74   _CUPS_SIZE_IN("na_c5_6.5x9.5in", NULL, 6.5, 9.5),
  75   _CUPS_SIZE_IN("na_7x9_7x9in", "na-7x9-envelope", 7, 9),
  76   _CUPS_SIZE_IN("na_executive_7.25x10.5in", "executive", 7.25, 10.5),
  77   _CUPS_SIZE_IN("na_govt-letter_8x10in", "na-8x10", 8, 10),
  78   _CUPS_SIZE_IN("na_govt-legal_8x13in", NULL, 8, 13),
  79   _CUPS_SIZE_IN("na_quarto_8.5x10.83in", "quarto", 8.5, 10.83),
  80   _CUPS_SIZE_IN("na_letter_8.5x11in", "na-letter", 8.5, 11),
  81   _CUPS_SIZE_IN("na_fanfold-eur_8.5x12in", NULL, 8.5, 12),
  82   _CUPS_SIZE_IN("na_letter-plus_8.5x12.69in", NULL, 8.5, 12.69),
  83   _CUPS_SIZE_IN("na_foolscap_8.5x13in", NULL, 8.5, 13),
  84   _CUPS_SIZE_IN("na_legal_8.5x14in", "na-legal", 8.5, 14),
  85   _CUPS_SIZE_IN("na_super-a_8.94x14in", NULL, 8.94, 14),
  86   _CUPS_SIZE_IN("na_9x11_9x11in", "na-9x11-envelope", 9, 11),
  87   _CUPS_SIZE_IN("na_arch-a_9x12in", "arch-a", 9, 12),
  88   _CUPS_SIZE_IN("na_letter-extra_9.5x12in", NULL, 9.5, 12),
  89   _CUPS_SIZE_IN("na_legal-extra_9.5x15in", NULL, 9.5, 15),
  90   _CUPS_SIZE_IN("na_10x11_10x11in", NULL, 10, 11),
  91   _CUPS_SIZE_IN("na_10x13_10x13in", "na-10x13-envelope", 10, 13),
  92   _CUPS_SIZE_IN("na_10x14_10x14in", "na-10x14-envelope", 10, 14),
  93   _CUPS_SIZE_IN("na_10x15_10x15in", "na-10x15-envelope", 10, 15),
  94   _CUPS_SIZE_IN("na_11x12_11x12in", NULL, 11, 12),
  95   _CUPS_SIZE_IN("na_edp_11x14in", NULL, 11, 14),
  96   _CUPS_SIZE_IN("na_fanfold-us_11x14.875in", NULL, 11, 14.875),
  97   _CUPS_SIZE_IN("na_11x15_11x15in", NULL, 11, 15),
  98   _CUPS_SIZE_IN("na_ledger_11x17in", "tabloid", 11, 17),
  99   _CUPS_SIZE_IN("na_eur-edp_12x14in", NULL, 12, 14),
 100   _CUPS_SIZE_IN("na_arch-b_12x18in", "arch-b", 12, 18),
 101   _CUPS_SIZE_IN("na_12x19_12x19in", NULL, 12, 19),
 102   _CUPS_SIZE_IN("na_b-plus_12x19.17in", NULL, 12, 19.17),
 103   _CUPS_SIZE_IN("na_super-b_13x19in", NULL, 13, 19),
 104   _CUPS_SIZE_IN("na_c_17x22in", "c", 17, 22),
 105   _CUPS_SIZE_IN("na_arch-c_18x24in", "arch-c", 18, 24),
 106   _CUPS_SIZE_IN("na_d_22x34in", "d", 22, 34),
 107   _CUPS_SIZE_IN("na_arch-d_24x36in", "arch-d", 24, 36),
 108   _CUPS_SIZE_IN("asme_f_28x40in", "f", 28, 40),
 109   _CUPS_SIZE_IN("na_wide-format_30x42in", NULL, 30, 42),
 110   _CUPS_SIZE_IN("na_e_34x44in", "e", 34, 44),
 111   _CUPS_SIZE_IN("na_arch-e_36x48in", "arch-e", 36, 48),
 112   _CUPS_SIZE_IN("na_f_44x68in", NULL, 44, 68),
 113
 114   /* Chinese Standard Sheet Media Inch Sizes */
 115   _CUPS_SIZE_IN("roc_16k_7.75x10.75in", NULL, 7.75, 10.75),
 116   _CUPS_SIZE_IN("roc_8k_10.75x15.5in", NULL, 10.75, 15.5),
 117
 118   /* ISO Standard Sheet Media Sizes */
 119   _CUPS_SIZE_MM("iso_a10_26x37mm", "iso-a10", 26, 37),
 120   _CUPS_SIZE_MM("iso_a9_37x52mm", "iso-a9", 37, 52),
 121   _CUPS_SIZE_MM("iso_a8_52x74mm", "iso-a8", 52, 74),
 122   _CUPS_SIZE_MM("iso_a7_74x105mm", "iso-a7", 74, 105),
 123   _CUPS_SIZE_MM("iso_a6_105x148mm", "iso-a6", 105, 148),
 124   _CUPS_SIZE_MM("iso_a5_148x210mm", "iso-a5", 148, 210),
 125   _CUPS_SIZE_MM("iso_a5-extra_174x235mm", NULL, 174, 235),
 126   _CUPS_SIZE_MM("iso_a4_210x297mm", "iso-a4", 210, 297),
 127   _CUPS_SIZE_MM("iso_a4-tab_225x297mm", NULL, 225, 297),
 128   _CUPS_SIZE_MM("iso_a4-extra_235.5x322.3mm", NULL, 235.5, 322.3),
 129   _CUPS_SIZE_MM("iso_a3_297x420mm", "iso-a3", 297, 420),
 130   _CUPS_SIZE_MM("iso_a4x3_297x630mm", "iso-a4x3", 297, 630),
 131   _CUPS_SIZE_MM("iso_a4x4_297x841mm", "iso-a4x4", 297, 841),
 132   _CUPS_SIZE_MM("iso_a4x5_297x1051mm", "iso-a4x5", 297, 1051),
 133   _CUPS_SIZE_MM("iso_a4x6_297x1261mm", "iso-a4x6", 297, 1261),
 134   _CUPS_SIZE_MM("iso_a4x7_297x1471mm", "iso-a4x7", 297, 1471),
 135   _CUPS_SIZE_MM("iso_a4x8_297x1682mm", "iso-a4x8", 297, 1682),
 136   _CUPS_SIZE_MM("iso_a4x9_297x1892mm", "iso-a4x9", 297, 1892),
 137   _CUPS_SIZE_MM("iso_a3-extra_322x445mm", "iso-a3-extra", 322, 445),
 138   _CUPS_SIZE_MM("iso_a2_420x594mm", "iso-a2", 420, 594),
 139   _CUPS_SIZE_MM("iso_a3x3_420x891mm", "iso-a3x3", 420, 891),
 140   _CUPS_SIZE_MM("iso_a3x4_420x1189mm", "iso-a3x4", 420, 1189),
 141   _CUPS_SIZE_MM("iso_a3x5_420x1486mm", "iso-a3x5", 420, 1486),
 142   _CUPS_SIZE_MM("iso_a3x6_420x1783mm", "iso-a3x6", 420, 1783),
 143   _CUPS_SIZE_MM("iso_a3x7_420x2080mm", "iso-a3x7", 420, 2080),
 144   _CUPS_SIZE_MM("iso_a1_594x841mm", "iso-a1", 594, 841),
 145   _CUPS_SIZE_MM("iso_a2x3_594x1261mm", "iso-a2x3", 594, 1261),
 146   _CUPS_SIZE_MM("iso_a2x4_594x1682mm", "iso-a2x4", 594, 1682),
 147   _CUPS_SIZE_MM("iso_a2x5_594x2102mm", "iso-a2x5", 594, 2102),
 148   _CUPS_SIZE_MM("iso_a0_841x1189mm", "iso-a0", 841, 1189),
 149   _CUPS_SIZE_MM("iso_a1x3_841x1783mm", "iso-a1x3", 841, 1783),
 150   _CUPS_SIZE_MM("iso_a1x4_841x2378mm", "iso-a1x4", 841, 2378),
 151   _CUPS_SIZE_MM("iso_2a0_1189x1682mm", NULL, 1189, 1682),
 152   _CUPS_SIZE_MM("iso_a0x3_1189x2523mm", NULL, 1189, 2523),
 153   _CUPS_SIZE_MM("iso_b10_31x44mm", "iso-b10", 31, 44),
 154   _CUPS_SIZE_MM("iso_b9_44x62mm", "iso-b9", 44, 62),
 155   _CUPS_SIZE_MM("iso_b8_62x88mm", "iso-b8", 62, 88),
 156   _CUPS_SIZE_MM("iso_b7_88x125mm", "iso-b7", 88, 125),
 157   _CUPS_SIZE_MM("iso_b6_125x176mm", "iso-b6", 125, 176),
 158   _CUPS_SIZE_MM("iso_b6c4_125x324mm", NULL, 125, 324),
 159   _CUPS_SIZE_MM("iso_b5_176x250mm", "iso-b5", 176, 250),
 160   _CUPS_SIZE_MM("iso_b5-extra_201x276mm", NULL, 201, 276),
 161   _CUPS_SIZE_MM("iso_b4_250x353mm", "iso-b4", 250, 353),
 162   _CUPS_SIZE_MM("iso_b3_353x500mm", "iso-b3", 353, 500),
 163   _CUPS_SIZE_MM("iso_b2_500x707mm", "iso-b2", 500, 707),
 164   _CUPS_SIZE_MM("iso_b1_707x1000mm", "iso-b1", 707, 1000),
 165   _CUPS_SIZE_MM("iso_b0_1000x1414mm", "iso-b0", 1000, 1414),
 166   _CUPS_SIZE_MM("iso_c10_28x40mm", "iso-c10", 28, 40),
 167   _CUPS_SIZE_MM("iso_c9_40x57mm", "iso-c9", 40, 57),
 168   _CUPS_SIZE_MM("iso_c8_57x81mm", "iso-c8", 57, 81),
 169   _CUPS_SIZE_MM("iso_c7_81x114mm", "iso-c7", 81, 114),
 170   _CUPS_SIZE_MM("iso_c7c6_81x162mm", NULL, 81, 162),
 171   _CUPS_SIZE_MM("iso_c6_114x162mm", "iso-c6", 114, 162),
 172   _CUPS_SIZE_MM("iso_c6c5_114x229mm", NULL, 114, 229),
 173   _CUPS_SIZE_MM("iso_c5_162x229mm", "iso-c5", 162, 229),
 174   _CUPS_SIZE_MM("iso_c4_229x324mm", "iso-c4", 229, 324),
 175   _CUPS_SIZE_MM("iso_c3_324x458mm", "iso-c3", 324, 458),
 176   _CUPS_SIZE_MM("iso_c2_458x648mm", "iso-c2", 458, 648),
 177   _CUPS_SIZE_MM("iso_c1_648x917mm", "iso-c1", 648, 917),
 178   _CUPS_SIZE_MM("iso_c0_917x1297mm", "iso-c0", 917, 1297),
 179   _CUPS_SIZE_MM("iso_dl_110x220mm", "iso-designated", 110, 220),
 180   _CUPS_SIZE_MM("iso_ra2_430x610mm", "iso-ra2", 430, 610),
 181   _CUPS_SIZE_MM("iso_sra2_450x640mm", "iso-sra2", 450, 640),
 182   _CUPS_SIZE_MM("iso_ra1_610x860mm", "iso-ra1", 610, 860),
 183   _CUPS_SIZE_MM("iso_sra1_640x900mm", "iso-sra1", 640, 900),
 184   _CUPS_SIZE_MM("iso_ra0_860x1220mm", "iso-ra0", 860, 1220),
 185   _CUPS_SIZE_MM("iso_sra0_900x1280mm", "iso-sra0", 900, 1280),
 186
 187   /* Japanese Standard Sheet Media Sizes */
 188   _CUPS_SIZE_MM("jis_b10_32x45mm", "jis-b10", 32, 45),
 189   _CUPS_SIZE_MM("jis_b9_45x64mm", "jis-b9", 45, 64),
 190   _CUPS_SIZE_MM("jis_b8_64x91mm", "jis-b8", 64, 91),
 191   _CUPS_SIZE_MM("jis_b7_91x128mm", "jis-b7", 91, 128),
 192   _CUPS_SIZE_MM("jis_b6_128x182mm", "jis-b6", 128, 182),
 193   _CUPS_SIZE_MM("jis_b5_182x257mm", "jis-b5", 182, 257),
 194   _CUPS_SIZE_MM("jis_b4_257x364mm", "jis-b4", 257, 364),
 195   _CUPS_SIZE_MM("jis_b3_364x515mm", "jis-b3", 364, 515),
 196   _CUPS_SIZE_MM("jis_b2_515x728mm", "jis-b2", 515, 728),
 197   _CUPS_SIZE_MM("jis_b1_728x1030mm", "jis-b1", 728, 1030),
 198   _CUPS_SIZE_MM("jis_b0_1030x1456mm", "jis-b0", 1030, 1456),
 199   _CUPS_SIZE_MM("jis_exec_216x330mm", NULL, 216, 330),
 200   _CUPS_SIZE_MM("jpn_chou4_90x205mm", NULL, 90, 205),
 201   _CUPS_SIZE_MM("jpn_hagaki_100x148mm", NULL, 100, 148),
 202   _CUPS_SIZE_MM("jpn_you4_105x235mm", NULL, 105, 235),
 203   _CUPS_SIZE_MM("jpn_chou2_111.1x146mm", NULL, 111.1, 146),
 204   _CUPS_SIZE_MM("jpn_chou3_120x235mm", NULL, 120, 235),
 205   _CUPS_SIZE_MM("jpn_oufuku_148x200mm", NULL, 148, 200),
 206   _CUPS_SIZE_MM("jpn_kahu_240x322.1mm", NULL, 240, 322.1),
 207   _CUPS_SIZE_MM("jpn_kaku2_240x332mm", NULL, 240, 332),
 208
 209   /* Chinese Standard Sheet Media Sizes */
 210   _CUPS_SIZE_MM("prc_32k_97x151mm", NULL, 97, 151),
 211   _CUPS_SIZE_MM("prc_1_102x165mm", NULL, 102, 165),
 212   _CUPS_SIZE_MM("prc_2_102x176mm", NULL, 102, 176),
 213   _CUPS_SIZE_MM("prc_4_110x208mm", NULL, 110, 208),
 214   _CUPS_SIZE_MM("prc_5_110x220mm", NULL, 110, 220),
 215   _CUPS_SIZE_MM("prc_8_120x309mm", NULL, 120, 309),
 216   _CUPS_SIZE_MM("prc_6_120x320mm", NULL, 120, 320),
 217   _CUPS_SIZE_MM("prc_3_125x176mm", NULL, 125, 176),
 218   _CUPS_SIZE_MM("prc_16k_146x215mm", NULL, 146, 215),
 219   _CUPS_SIZE_MM("prc_7_160x230mm", NULL, 160, 230),
 220   _CUPS_SIZE_MM("om_juuro-ku-kai_198x275mm", NULL, 198, 275),
 221   _CUPS_SIZE_MM("om_pa-kai_267x389mm", NULL, 267, 389),
 222   _CUPS_SIZE_MM("om_dai-pa-kai_275x395mm", NULL, 275, 395),
 223   _CUPS_SIZE_MM("prc_10_324x458mm", NULL, 324, 458),
 224
 225   /* Other Metric Standard Sheet Media Sizes */
 226   _CUPS_SIZE_MM("om_small-photo_100x150mm", NULL, 100, 150),
 227   _CUPS_SIZE_MM("om_italian_110x230mm", NULL, 110, 230),
 228   _CUPS_SIZE_MM("om_postfix_114x229mm", NULL, 114, 229),
 229   _CUPS_SIZE_MM("om_large-photo_200x300", NULL, 200, 300),
 230   _CUPS_SIZE_MM("om_folio_210x330mm", "folio", 210, 330),
 231   _CUPS_SIZE_MM("om_folio-sp_215x315mm", NULL, 215, 315),
 232   _CUPS_SIZE_MM("om_invite_220x220mm", NULL, 220, 220)
 233 };
 234
 235
 236 /*
 237  * '_cupsPWGMediaByLegacy()' - Find a PWG media size by ISO/IPP legacy name.
 238  */
 239
 240 _cups_pwg_media_t *                     /* O - Matching size or NULL */
 241 _cupsPWGMediaByLegacy(
 242     const char *legacy)                 /* I - Legacy size name */
 243 {
 244   _cups_pwg_media_t     key;            /* Search key */
 245   _cups_globals_t       *cg = _cupsGlobals();
 246                                         /* Global data */
 247
 248
 249  /*
 250   * Build the lookup table for PWG names as needed...
 251   */
 252
 253   if (!cg->leg_size_lut)
 254   {
 255     int                 i;              /* Looping var */
 256     _cups_pwg_media_t   *size;          /* Current size */
 257
 258     cg->leg_size_lut = cupsArrayNew((cups_array_func_t)compare_legacy, NULL);
 259
 260     for (i = (int)(sizeof(cups_pwg_media) / sizeof(cups_pwg_media[0])),
 261              size = (_cups_pwg_media_t *)cups_pwg_media;
 262          i > 0;
 263          i --, size ++)
 264       if (size->legacy)
 265         cupsArrayAdd(cg->leg_size_lut, size);
 266   }
 267
 268  /*
 269   * Lookup the name...
 270   */
 271
 272   key.legacy = legacy;
 273   return ((_cups_pwg_media_t *)cupsArrayFind(cg->leg_size_lut, &key));
 274 }
 275
 276
 277 /*
 278  * '_cupsPWGMediaByName()' - Find a PWG media size by 5101.1 self-describing
 279  *                           name.
 280  */
 281
 282 _cups_pwg_media_t *                     /* O - Matching size or NULL */
 283 _cupsPWGMediaByName(const char *pwg)    /* I - PWG size name */
 284 {
 285   _cups_pwg_media_t     key;            /* Search key */
 286   _cups_globals_t       *cg = _cupsGlobals();
 287                                         /* Global data */
 288
 289
 290  /*
 291   * Build the lookup table for PWG names as needed...
 292   */
 293
 294   if (!cg->pwg_size_lut)
 295   {
 296     int                 i;              /* Looping var */
 297     _cups_pwg_media_t   *size;          /* Current size */
 298
 299     cg->pwg_size_lut = cupsArrayNew((cups_array_func_t)compare_pwg, NULL);
 300
 301     for (i = (int)(sizeof(cups_pwg_media) / sizeof(cups_pwg_media[0])),
 302              size = (_cups_pwg_media_t *)cups_pwg_media;
 303          i > 0;
 304          i --, size ++)
 305       cupsArrayAdd(cg->pwg_size_lut, size);
 306   }
 307
 308  /*
 309   * Lookup the name...
 310   */
 311
 312   key.pwg = pwg;
 313   return ((_cups_pwg_media_t *)cupsArrayFind(cg->pwg_size_lut, &key));
 314 }
 315
 316
 317 /*
 318  * '_cupsPWGMediaBySize()' - Find a PWG media size by size in points.
 319  */
 320
 321 _cups_pwg_media_t *                     /* O - Matching size or NULL */
 322 _cupsPWGMediaBySize(double width,       /* I - Width in points */
 323                     double length)      /* I - Length in points */
 324 {
 325   int                   i;              /* Looping var */
 326   _cups_pwg_media_t     *size;          /* Current size */
 327   double                dw, dl;         /* Difference in width and length */
 328
 329
 330   for (i = (int)(sizeof(cups_pwg_media) / sizeof(cups_pwg_media[0])),
 331            size = (_cups_pwg_media_t *)cups_pwg_media;
 332        i > 0;
 333        i --, size ++)
 334   {
 335    /*
 336     * Adobe uses a size matching algorithm with an epsilon of 5 points...
 337     */
 338
 339     dw = size->width - width;
 340     dl = size->length - length;
 341
 342     if (dw > -5.0 && dw < 5.0 && dl > -5.0 && dl < 5.0)
 343       return (size);
 344   }
 345
 346   return (NULL);
 347 }
 348
 349
 350 /*
 351  * 'compare_legacy()' - Compare two sizes using the legacy names.
 352  */
 353
 354 static int                              /* O - Result of comparison */
 355 compare_legacy(_cups_pwg_media_t *a,    /* I - First size */
 356                _cups_pwg_media_t *b)    /* I - Second size */
 357 {
 358   return (strcmp(a->legacy, b->legacy));
 359 }
 360
 361
 362 /*
 363  * 'compare_pwg()' - Compare two sizes using the PWG names.
 364  */
 365
 366 static int                              /* O - Result of comparison */
 367 compare_pwg(_cups_pwg_media_t *a,       /* I - First size */
 368             _cups_pwg_media_t *b)       /* I - Second size */
 369 {
 370   return (strcmp(a->pwg, b->pwg));
 371 }
 372
 373
 374 /*
 375  * End of "$Id$".
 376  */