source/libs/poppler/poppler-src/poppler/GlobalParams.h

   1 //========================================================================
   2 //
   3 // GlobalParams.h
   4 //
   5 // Copyright 2001-2003 Glyph & Cog, LLC
   6 //
   7 //========================================================================
   8
   9 //========================================================================
  10 //
  11 // Modified under the Poppler project - http://poppler.freedesktop.org
  12 //
  13 // All changes made under the Poppler project to this file are licensed
  14 // under GPL version 2 or later
  15 //
  16 // Copyright (C) 2005, 2007-2010, 2012, 2015 Albert Astals Cid <aacid@kde.org>
  17 // Copyright (C) 2005 Jonathan Blandford <jrb@redhat.com>
  18 // Copyright (C) 2006 Takashi Iwai <tiwai@suse.de>
  19 // Copyright (C) 2006 Kristian Høgsberg <krh@redhat.com>
  20 // Copyright (C) 2007 Krzysztof Kowalczyk <kkowalczyk@gmail.com>
  21 // Copyright (C) 2009 Jonathan Kew <jonathan_kew@sil.org>
  22 // Copyright (C) 2009 Petr Gajdos <pgajdos@novell.com>
  23 // Copyright (C) 2009, 2011, 2012, 2014, 2015 William Bader <williambader@hotmail.com>
  24 // Copyright (C) 2010 Hib Eris <hib@hiberis.nl>
  25 // Copyright (C) 2011 Pino Toscano <pino@kde.org>
  26 // Copyright (C) 2012 Adrian Johnson <ajohnson@redneon.com>
  27 // Copyright (C) 2012 Thomas Freitag <Thomas.Freitag@alfa.de>
  28 // Copyright (C) 2013 Jason Crain <jason@aquaticape.us>
  29 //
  30 // To see a description of the changes please see the Changelog file that
  31 // came with your tarball or type make ChangeLog if you are building from git
  32 //
  33 //========================================================================
  34
  35 #ifndef GLOBALPARAMS_H
  36 #define GLOBALPARAMS_H
  37
  38 #ifdef USE_GCC_PRAGMAS
  39 #pragma interface
  40 #endif
  41
  42 #include <assert.h>
  43 #include "poppler-config.h"
  44 #include <stdio.h>
  45 #include "goo/gtypes.h"
  46 #include "CharTypes.h"
  47
  48 #if MULTITHREADED
  49 #include "goo/GooMutex.h"
  50 #endif
  51
  52 class GooString;
  53 class GooList;
  54 class GooHash;
  55 class NameToCharCode;
  56 class CharCodeToUnicode;
  57 class CharCodeToUnicodeCache;
  58 class UnicodeMap;
  59 class UnicodeMapCache;
  60 class CMap;
  61 class CMapCache;
  62 struct XpdfSecurityHandler;
  63 class GlobalParams;
  64 class GfxFont;
  65 class Stream;
  66 class SysFontList;
  67
  68 //------------------------------------------------------------------------
  69
  70 // The global parameters object.
  71 extern GlobalParams *globalParams;
  72
  73 //------------------------------------------------------------------------
  74
  75 enum SysFontType {
  76   sysFontPFA,
  77   sysFontPFB,
  78   sysFontTTF,
  79   sysFontTTC
  80 };
  81
  82 //------------------------------------------------------------------------
  83
  84 class PSFontParam16 {
  85 public:
  86
  87   GooString *name;              // PDF font name for psResidentFont16;
  88                                 //   char collection name for psResidentFontCC
  89   int wMode;                    // writing mode (0=horiz, 1=vert)
  90   GooString *psFontName;                // PostScript font name
  91   GooString *encoding;          // encoding
  92
  93   PSFontParam16(GooString *nameA, int wModeA,
  94                 GooString *psFontNameA, GooString *encodingA);
  95   ~PSFontParam16();
  96 };
  97
  98 //------------------------------------------------------------------------
  99
 100 enum PSLevel {
 101   psLevel1,
 102   psLevel1Sep,
 103   psLevel2,
 104   psLevel2Sep,
 105   psLevel3,
 106   psLevel3Sep
 107 };
 108
 109 //------------------------------------------------------------------------
 110
 111 enum EndOfLineKind {
 112   eolUnix,                      // LF
 113   eolDOS,                       // CR+LF
 114   eolMac                        // CR
 115 };
 116
 117 //------------------------------------------------------------------------
 118
 119 enum ScreenType {
 120   screenUnset,
 121   screenDispersed,
 122   screenClustered,
 123   screenStochasticClustered
 124 };
 125
 126 //------------------------------------------------------------------------
 127
 128 class GlobalParams {
 129 public:
 130
 131   // Initialize the global parameters by attempting to read a config
 132   // file.
 133   GlobalParams(const char *customPopplerDataDir = NULL);
 134
 135   ~GlobalParams();
 136
 137   void setupBaseFonts(char *dir);
 138
 139   //----- accessors
 140
 141   CharCode getMacRomanCharCode(char *charName);
 142
 143   // Return Unicode values for character names.  Used for general text
 144   // extraction.
 145   Unicode mapNameToUnicodeText(const char *charName);
 146
 147   // Return Unicode values for character names.  Used for glyph
 148   // lookups or text extraction with ZapfDingbats fonts.
 149   Unicode mapNameToUnicodeAll(const char *charName);
 150
 151   UnicodeMap *getResidentUnicodeMap(GooString *encodingName);
 152   FILE *getUnicodeMapFile(GooString *encodingName);
 153   FILE *findCMapFile(GooString *collection, GooString *cMapName);
 154   FILE *findToUnicodeFile(GooString *name);
 155   GooString *findFontFile(GooString *fontName);
 156   GooString *findBase14FontFile(GooString *base14Name, GfxFont *font);
 157   GooString *findSystemFontFile(GfxFont *font, SysFontType *type,
 158                               int *fontNum, GooString *substituteFontName = NULL,
 159                               GooString *base14Name = NULL);
 160   GooString *findCCFontFile(GooString *collection);
 161   GBool getPSExpandSmaller();
 162   GBool getPSShrinkLarger();
 163   GBool getPSCenter();
 164   PSLevel getPSLevel();
 165   GooString *getPSResidentFont(GooString *fontName);
 166   GooList *getPSResidentFonts();
 167   PSFontParam16 *getPSResidentFont16(GooString *fontName, int wMode);
 168   PSFontParam16 *getPSResidentFontCC(GooString *collection, int wMode);
 169   GooString *getTextEncodingName();
 170   EndOfLineKind getTextEOL();
 171   GBool getTextPageBreaks();
 172   GBool getTextKeepTinyChars();
 173   GBool getEnableFreeType();
 174   GBool getStrokeAdjust();
 175   ScreenType getScreenType();
 176   int getScreenSize();
 177   int getScreenDotRadius();
 178   double getScreenGamma();
 179   double getScreenBlackThreshold();
 180   double getScreenWhiteThreshold();
 181   double getMinLineWidth();
 182   GBool getOverprintPreview() { return overprintPreview; }
 183   GBool getMapNumericCharNames();
 184   GBool getMapUnknownCharNames();
 185   GBool getPrintCommands();
 186   GBool getProfileCommands();
 187   GBool getErrQuiet();
 188
 189   CharCodeToUnicode *getCIDToUnicode(GooString *collection);
 190   CharCodeToUnicode *getUnicodeToUnicode(GooString *fontName);
 191   UnicodeMap *getUnicodeMap(GooString *encodingName);
 192   CMap *getCMap(GooString *collection, GooString *cMapName, Stream *stream = NULL);
 193   UnicodeMap *getTextEncoding();
 194 #ifdef ENABLE_PLUGINS
 195   GBool loadPlugin(char *type, char *name);
 196 #endif
 197
 198   GooList *getEncodingNames();
 199
 200   //----- functions to set parameters
 201   void addFontFile(GooString *fontName, GooString *path);
 202   void setPSFile(char *file);
 203   void setPSExpandSmaller(GBool expand);
 204   void setPSShrinkLarger(GBool shrink);
 205   void setPSCenter(GBool center);
 206   void setPSLevel(PSLevel level);
 207   void setTextEncoding(char *encodingName);
 208   GBool setTextEOL(char *s);
 209   void setTextPageBreaks(GBool pageBreaks);
 210   void setTextKeepTinyChars(GBool keep);
 211   GBool setEnableFreeType(char *s);
 212   GBool setDisableFreeTypeHinting(char *s);
 213   void setStrokeAdjust(GBool strokeAdjust);
 214   void setScreenType(ScreenType st);
 215   void setScreenSize(int size);
 216   void setScreenDotRadius(int radius);
 217   void setScreenGamma(double gamma);
 218   void setScreenBlackThreshold(double blackThreshold);
 219   void setScreenWhiteThreshold(double whiteThreshold);
 220   void setMinLineWidth(double minLineWidth);
 221   void setOverprintPreview(GBool overprintPreviewA);
 222   void setMapNumericCharNames(GBool map);
 223   void setMapUnknownCharNames(GBool map);
 224   void setPrintCommands(GBool printCommandsA);
 225   void setProfileCommands(GBool profileCommandsA);
 226   void setErrQuiet(GBool errQuietA);
 227
 228   static GBool parseYesNo2(const char *token, GBool *flag);
 229
 230   //----- security handlers
 231
 232   void addSecurityHandler(XpdfSecurityHandler *handler);
 233   XpdfSecurityHandler *getSecurityHandler(char *name);
 234
 235 private:
 236
 237   void parseNameToUnicode(GooString *name);
 238   UnicodeMap *getUnicodeMap2(GooString *encodingName);
 239
 240   void scanEncodingDirs();
 241   void addCIDToUnicode(GooString *collection, GooString *fileName);
 242   void addUnicodeMap(GooString *encodingName, GooString *fileName);
 243   void addCMapDir(GooString *collection, GooString *dir);
 244
 245   //----- static tables
 246
 247   NameToCharCode *              // mapping from char name to
 248     macRomanReverseMap;         //   MacRomanEncoding index
 249
 250   //----- user-modifiable settings
 251
 252   NameToCharCode *              // mapping from char name to Unicode for ZapfDingbats
 253     nameToUnicodeZapfDingbats;
 254   NameToCharCode *              // mapping from char name to Unicode for text
 255     nameToUnicodeText;          // extraction
 256   GooHash *cidToUnicodes;               // files for mappings from char collections
 257                                 //   to Unicode, indexed by collection name
 258                                 //   [GooString]
 259   GooHash *unicodeToUnicodes;   // files for Unicode-to-Unicode mappings,
 260                                 //   indexed by font name pattern [GooString]
 261   GooHash *residentUnicodeMaps; // mappings from Unicode to char codes,
 262                                 //   indexed by encoding name [UnicodeMap]
 263   GooHash *unicodeMaps;         // files for mappings from Unicode to char
 264                                 //   codes, indexed by encoding name [GooString]
 265   GooHash *cMapDirs;            // list of CMap dirs, indexed by collection
 266                                 //   name [GooList[GooString]]
 267   GooList *toUnicodeDirs;               // list of ToUnicode CMap dirs [GooString]
 268   GBool baseFontsInitialized;
 269 #ifdef _WIN32
 270   GooHash *substFiles;  // windows font substitutes (for CID fonts)
 271 #endif
 272   GooHash *fontFiles;           // font files: font name mapped to path
 273                                 //   [GString]
 274   GooList *fontDirs;            // list of font dirs [GString]
 275   GooHash *ccFontFiles; // character collection font files:
 276                                 //   collection name  mapped to path [GString]
 277   SysFontList *sysFonts;        // system fonts
 278   GooString *psFile;            // PostScript file or command (for xpdf)
 279   GBool psExpandSmaller;        // expand smaller pages to fill paper
 280   GBool psShrinkLarger;         // shrink larger pages to fit paper
 281   GBool psCenter;               // center pages on the paper
 282   PSLevel psLevel;              // PostScript level to generate
 283   GooHash *psResidentFonts;     // 8-bit fonts resident in printer:
 284                                 //   PDF font name mapped to PS font name
 285                                 //   [GString]
 286   GooList *psResidentFonts16;   // 16-bit fonts resident in printer:
 287                                 //   PDF font name mapped to font info
 288                                 //   [PSFontParam16]
 289   GooList *psResidentFontsCC;   // 16-bit character collection fonts
 290                                 //   resident in printer: collection name
 291                                 //   mapped to font info [PSFontParam16]
 292   GooString *textEncoding;      // encoding (unicodeMap) to use for text
 293                                 //   output
 294   EndOfLineKind textEOL;        // type of EOL marker to use for text
 295                                 //   output
 296   GBool textPageBreaks;         // insert end-of-page markers?
 297   GBool textKeepTinyChars;      // keep all characters in text output
 298   GBool enableFreeType;         // FreeType enable flag
 299   GBool disableFreeTypeHinting; // FreeType disable hinting flag
 300   GBool strokeAdjust;           // stroke adjustment enable flag
 301   ScreenType screenType;        // halftone screen type
 302   int screenSize;               // screen matrix size
 303   int screenDotRadius;          // screen dot radius
 304   double screenGamma;           // screen gamma correction
 305   double screenBlackThreshold;  // screen black clamping threshold
 306   double screenWhiteThreshold;  // screen white clamping threshold
 307   double minLineWidth;          // minimum line width
 308   GBool overprintPreview;       // enable overprint preview
 309   GBool mapNumericCharNames;    // map numeric char names (from font subsets)?
 310   GBool mapUnknownCharNames;    // map unknown char names?
 311   GBool printCommands;          // print the drawing commands
 312   GBool profileCommands;        // profile the drawing commands
 313   GBool errQuiet;               // suppress error messages?
 314   double splashResolution;      // resolution when rasterizing images
 315
 316   CharCodeToUnicodeCache *cidToUnicodeCache;
 317   CharCodeToUnicodeCache *unicodeToUnicodeCache;
 318   UnicodeMapCache *unicodeMapCache;
 319   CMapCache *cMapCache;
 320
 321 #ifdef ENABLE_PLUGINS
 322   GooList *plugins;             // list of plugins [Plugin]
 323   GooList *securityHandlers;    // list of loaded security handlers
 324                                 //   [XpdfSecurityHandler]
 325 #endif
 326
 327 #if MULTITHREADED
 328   GooMutex mutex;
 329   GooMutex unicodeMapCacheMutex;
 330   GooMutex cMapCacheMutex;
 331 #endif
 332
 333   const char *popplerDataDir;
 334 };
 335
 336 #endif