pdf/xpdf/OutputDev.h

   1 //========================================================================
   2 //
   3 // OutputDev.h
   4 //
   5 // Copyright 1996-2002 Glyph & Cog, LLC
   6 //
   7 //========================================================================
   8
   9 #ifndef OUTPUTDEV_H
  10 #define OUTPUTDEV_H
  11
  12 #ifdef __GNUC__
  13 #pragma interface
  14 #endif
  15
  16 #include "gtypes.h"
  17 #include "CharTypes.h"
  18
  19 class GString;
  20 class Object;
  21 class GfxState;
  22 class GfxColorSpace;
  23 class GfxImageColorMap;
  24 class Stream;
  25 class Link;
  26 class Catalog;
  27
  28 //------------------------------------------------------------------------
  29 // OutputDev
  30 //------------------------------------------------------------------------
  31
  32 class OutputDev {
  33 public:
  34
  35   // Constructor.
  36   OutputDev() {}
  37
  38   // Destructor.
  39   virtual ~OutputDev() {}
  40
  41   //----- get info about output device
  42
  43   // Does this device use upside-down coordinates?
  44   // (Upside-down means (0,0) is the top left corner of the page.)
  45   virtual GBool upsideDown() = 0;
  46
  47   // Does this device use drawChar() or drawString()?
  48   virtual GBool useDrawChar() = 0;
  49
  50   // Does this device use beginType3Char/endType3Char?  Otherwise,
  51   // text in Type 3 fonts will be drawn with drawChar/drawString.
  52   virtual GBool interpretType3Chars() = 0;
  53
  54   // Does this device need non-text content?
  55   virtual GBool needNonText() { return gTrue; }
  56
  57   //----- initialization and control
  58
  59   // Set default transform matrix.
  60   virtual void setDefaultCTM(double *ctm);
  61
  62   // Start a page.
  63   virtual void startPage(int pageNum, GfxState *state) {}
  64
  65   // End a page.
  66   virtual void endPage() {}
  67
  68   // Dump page contents to display.
  69   virtual void dump() {}
  70
  71   //----- coordinate conversion
  72
  73   // Convert between device and user coordinates.
  74   virtual void cvtDevToUser(int dx, int dy, double *ux, double *uy);
  75   virtual void cvtUserToDev(double ux, double uy, int *dx, int *dy);
  76
  77   //----- link borders
  78   virtual void drawLink(Link *link, Catalog *catalog) {}
  79
  80   //----- save/restore graphics state
  81   virtual void saveState(GfxState *state) {}
  82   virtual void restoreState(GfxState *state) {}
  83
  84   //----- update graphics state
  85   virtual void updateAll(GfxState *state);
  86   virtual void updateCTM(GfxState *state, double m11, double m12,
  87                          double m21, double m22, double m31, double m32) {}
  88   virtual void updateLineDash(GfxState *state) {}
  89   virtual void updateFlatness(GfxState *state) {}
  90   virtual void updateLineJoin(GfxState *state) {}
  91   virtual void updateLineCap(GfxState *state) {}
  92   virtual void updateMiterLimit(GfxState *state) {}
  93   virtual void updateLineWidth(GfxState *state) {}
  94   virtual void updateFillColor(GfxState *state) {}
  95   virtual void updateStrokeColor(GfxState *state) {}
  96   virtual void updateFillOpacity(GfxState *state) {}
  97   virtual void updateStrokeOpacity(GfxState *state) {}
  98
  99   //----- update text state
 100   virtual void updateFont(GfxState *state) {}
 101   virtual void updateTextMat(GfxState *state) {}
 102   virtual void updateCharSpace(GfxState *state) {}
 103   virtual void updateRender(GfxState *state) {}
 104   virtual void updateRise(GfxState *state) {}
 105   virtual void updateWordSpace(GfxState *state) {}
 106   virtual void updateHorizScaling(GfxState *state) {}
 107   virtual void updateTextPos(GfxState *state) {}
 108   virtual void updateTextShift(GfxState *state, double shift) {}
 109
 110   //----- path painting
 111   virtual void stroke(GfxState *state) {}
 112   virtual void fill(GfxState *state) {}
 113   virtual void eoFill(GfxState *state) {}
 114
 115   //----- path clipping
 116   virtual void clip(GfxState *state) {}
 117   virtual void eoClip(GfxState *state) {}
 118
 119   //----- text drawing
 120   virtual void beginString(GfxState *state, GString *s) {}
 121   virtual void endString(GfxState *state) {}
 122   virtual void drawChar(GfxState *state, double x, double y,
 123                         double dx, double dy,
 124                         double originX, double originY,
 125                         CharCode code, Unicode *u, int uLen) {}
 126   virtual void drawString(GfxState *state, GString *s) {}
 127   virtual GBool beginType3Char(GfxState *state,
 128                                CharCode code, Unicode *u, int uLen);
 129   virtual void endType3Char(GfxState *state) {}
 130
 131   //----- image drawing
 132   virtual void drawImageMask(GfxState *state, Object *ref, Stream *str,
 133                              int width, int height, GBool invert,
 134                              GBool inlineImg);
 135   virtual void drawImage(GfxState *state, Object *ref, Stream *str,
 136                          int width, int height, GfxImageColorMap *colorMap,
 137                          int *maskColors, GBool inlineImg);
 138
 139 #if OPI_SUPPORT
 140   //----- OPI functions
 141   virtual void opiBegin(GfxState *state, Dict *opiDict);
 142   virtual void opiEnd(GfxState *state, Dict *opiDict);
 143 #endif
 144
 145   //----- Type 3 font operators
 146   virtual void type3D0(GfxState *state, double wx, double wy) {}
 147   virtual void type3D1(GfxState *state, double wx, double wy,
 148                        double llx, double lly, double urx, double ury) {}
 149
 150   //----- PostScript XObjects
 151   virtual void psXObject(Stream *psStream, Stream *level1Stream) {}
 152
 153 private:
 154
 155   double defCTM[6];             // default coordinate transform matrix
 156   double defICTM[6];            // inverse of default CTM
 157 };
 158
 159 #endif