dlls/wineps.drv/psdrv.h

   1 /*
   2  *      PostScript driver definitions
   3  *
   4  *      Copyright 1998  Huw D M Davies
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #ifndef __WINE_PSDRV_H
  22 #define __WINE_PSDRV_H
  23
  24 #include <stdarg.h>
  25
  26 #include "windef.h"
  27 #include "winbase.h"
  28 #include "wingdi.h"
  29 #include "winspool.h"
  30
  31 #include "wine/list.h"
  32
  33 typedef struct {
  34     INT             index;
  35     LPCSTR          sz;
  36 } GLYPHNAME;
  37
  38 typedef struct {
  39     LONG            UV;
  40     const GLYPHNAME *name;
  41 } UNICODEGLYPH;
  42
  43 typedef struct {
  44     float       llx, lly, urx, ury;
  45 } AFMBBOX;
  46
  47 typedef struct _tagAFMLIGS {
  48     char                *successor;
  49     char                *ligature;
  50     struct _tagAFMLIGS  *next;
  51 } AFMLIGS;
  52
  53 typedef struct {
  54     int                 C;              /* character */
  55     LONG                UV;
  56     float               WX;
  57     const GLYPHNAME     *N;             /* name */
  58     AFMBBOX             B;
  59     const AFMLIGS       *L;             /* Ligatures */
  60 } OLD_AFMMETRICS;
  61
  62 typedef struct {
  63     INT                 C;                      /* AFM encoding (or -1) */
  64     LONG                UV;                     /* Unicode value */
  65     FLOAT               WX;                     /* Advance width */
  66     const GLYPHNAME     *N;                     /* Glyph name */
  67 } AFMMETRICS;
  68
  69 typedef struct {
  70     USHORT              usUnitsPerEm;           /* head:unitsPerEm */
  71     SHORT               sAscender;              /* hhea:Ascender */
  72     SHORT               sDescender;             /* hhea:Descender */
  73     SHORT               sLineGap;               /* hhea:LineGap */
  74     SHORT               sAvgCharWidth;          /* OS/2:xAvgCharWidth */
  75     SHORT               sTypoAscender;          /* OS/2:sTypoAscender */
  76     SHORT               sTypoDescender;         /* OS/2:sTypoDescender */
  77     SHORT               sTypoLineGap;           /* OS/2:sTypeLineGap */
  78     USHORT              usWinAscent;            /* OS/2:usWinAscent */
  79     USHORT              usWinDescent;           /* OS/2:usWinDescent */
  80 } WINMETRICS;
  81
  82 typedef struct _tagAFM {
  83     LPCSTR              FontName;
  84     LPCSTR              FullName;
  85     LPCSTR              FamilyName;
  86     LPCSTR              EncodingScheme;
  87     LONG                Weight;                 /* FW_NORMAL etc. */
  88     float               ItalicAngle;
  89     BOOL                IsFixedPitch;
  90     float               UnderlinePosition;
  91     float               UnderlineThickness;
  92     AFMBBOX             FontBBox;
  93     float               Ascender;
  94     float               Descender;
  95     WINMETRICS          WinMetrics;
  96     int                 NumofMetrics;
  97     const AFMMETRICS    *Metrics;
  98 } AFM;
  99
 100 /* Note no 'next' in AFM. Use AFMLISTENTRY as a container. This allow more than
 101    one list to exist without having to reallocate the entire AFM structure. We
 102    keep a global list of all afms (PSDRV_AFMFontList) plus a list of available
 103    fonts for each DC (dc->physDev->Fonts) */
 104
 105 typedef struct _tagAFMLISTENTRY {
 106     const AFM                   *afm;
 107     struct _tagAFMLISTENTRY     *next;
 108 } AFMLISTENTRY;
 109
 110 typedef struct _tagFONTFAMILY {
 111     char                        *FamilyName; /* family name */
 112     AFMLISTENTRY                *afmlist;    /* list of afms for this family */
 113     struct _tagFONTFAMILY       *next;       /* next family */
 114 } FONTFAMILY;
 115
 116 extern FONTFAMILY   *PSDRV_AFMFontList;
 117 extern const AFM    *const PSDRV_BuiltinAFMs[];     /* last element is NULL */
 118
 119 typedef struct _tagFONTNAME {
 120     char                *Name;
 121     struct _tagFONTNAME *next;
 122 } FONTNAME;
 123
 124 typedef struct {
 125     float       llx, lly, urx, ury;
 126 } IMAGEABLEAREA;
 127
 128 typedef struct {
 129     float       x, y;
 130 } PAPERDIMENSION;
 131
 132 /* Solaris kludge */
 133 #undef PAGESIZE
 134 typedef struct _tagPAGESIZE {
 135     struct list         entry;
 136     char                *Name;
 137     char                *FullName;
 138     char                *InvocationString;
 139     IMAGEABLEAREA       *ImageableArea;
 140     PAPERDIMENSION      *PaperDimension;
 141     WORD                WinPage; /*eg DMPAPER_A4. Doesn't really belong here */
 142 } PAGESIZE;
 143
 144
 145 /* For BANDINFO Escape */
 146 typedef struct _BANDINFOSTRUCT
 147 {
 148     BOOL GraphicsFlag;
 149     BOOL TextFlag;
 150     RECT GraphicsRect;
 151 } BANDINFOSTRUCT, *PBANDINFOSTRUCT;
 152
 153 typedef struct _tagOPTIONENTRY {
 154     char                        *Name;          /* eg "True" */
 155     char                        *FullName;      /* eg "Installed" */
 156     char                        *InvocationString; /* Often NULL */
 157     struct _tagOPTIONENTRY      *next;
 158 } OPTIONENTRY;
 159
 160 typedef struct _tagOPTION { /* Treat bool as a special case of pickone */
 161     char                        *OptionName;    /* eg "*Option1" */
 162     char                        *FullName;      /* eg "Envelope Feeder" */
 163     char                        *DefaultOption; /* eg "False" */
 164     OPTIONENTRY                 *Options;
 165     struct _tagOPTION           *next;
 166 } OPTION;
 167
 168 typedef struct _tagCONSTRAINT {
 169     char                        *Feature1;
 170     char                        *Value1;
 171     char                        *Feature2;
 172     char                        *Value2;
 173     struct _tagCONSTRAINT       *next;
 174 } CONSTRAINT;
 175
 176 typedef struct _tagINPUTSLOT {
 177     const char                  *Name;
 178     const char                  *FullName;
 179     char                        *InvocationString;
 180     WORD                        WinBin; /* eg DMBIN_LOWER */
 181     struct _tagINPUTSLOT        *next;
 182 } INPUTSLOT;
 183
 184 typedef enum _RASTERIZEROPTION
 185   {RO_None, RO_Accept68K, RO_Type42, RO_TrueImage} RASTERIZEROPTION;
 186
 187 typedef struct _tagDUPLEX {
 188     char                        *Name;
 189     char                        *FullName;
 190     char                        *InvocationString;
 191     WORD                        WinDuplex; /* eg DMDUP_SIMPLEX */
 192     struct _tagDUPLEX           *next;
 193 } DUPLEX;
 194
 195 /* Many Mac OS X based ppd files don't include a *ColorDevice line, so
 196    we use a tristate here rather than a boolean.  Code that
 197    cares is expected to treat these as if they were colour. */
 198 typedef enum {
 199     CD_NotSpecified,
 200     CD_False,
 201     CD_True
 202 } COLORDEVICE;
 203
 204 typedef struct {
 205     char                *NickName;
 206     int                 LanguageLevel;
 207     COLORDEVICE         ColorDevice;
 208     int                 DefaultResolution;
 209     signed int          LandscapeOrientation;
 210     char                *JCLBegin;
 211     char                *JCLToPSInterpreter;
 212     char                *JCLEnd;
 213     char                *DefaultFont;
 214     FONTNAME            *InstalledFonts; /* ptr to a list of FontNames */
 215     struct list         PageSizes;
 216     PAGESIZE            *DefaultPageSize;
 217     OPTION              *InstalledOptions;
 218     CONSTRAINT          *Constraints;
 219     INPUTSLOT           *InputSlots;
 220     RASTERIZEROPTION    TTRasterizer;
 221     DUPLEX              *Duplexes;
 222     DUPLEX              *DefaultDuplex;
 223 } PPD;
 224
 225 typedef struct {
 226     DEVMODEA                    dmPublic;
 227     struct _tagdocprivate {
 228       int dummy;
 229     }                           dmDocPrivate;
 230     struct _tagdrvprivate {
 231       UINT      numInstalledOptions; /* Options at end of struct */
 232     }                           dmDrvPrivate;
 233
 234 /* Now comes:
 235
 236 numInstalledOptions of OPTIONs
 237
 238 */
 239
 240 } PSDRV_DEVMODEA;
 241
 242 typedef struct _tagPI {
 243     char                    *FriendlyName;
 244     PPD                     *ppd;
 245     PSDRV_DEVMODEA          *Devmode;
 246     FONTFAMILY              *Fonts;
 247     PPRINTER_ENUM_VALUESA   FontSubTable;
 248     DWORD                   FontSubTableSize;
 249     struct _tagPI           *next;
 250 } PRINTERINFO;
 251
 252 typedef struct {
 253     float               r, g, b;
 254 } PSRGB;
 255
 256 typedef struct {
 257     float               i;
 258 } PSGRAY;
 259
 260
 261 /* def's for PSCOLOR.type */
 262 #define PSCOLOR_GRAY    0
 263 #define PSCOLOR_RGB     1
 264
 265 typedef struct {
 266     int                 type;
 267     union {
 268         PSRGB  rgb;
 269         PSGRAY gray;
 270     }                   value;
 271 } PSCOLOR;
 272
 273 typedef struct {
 274     const AFM           *afm;
 275     float               scale;
 276     TEXTMETRICW         tm;
 277 } BUILTIN;
 278
 279 typedef struct tagTYPE42 TYPE42;
 280
 281 typedef struct tagTYPE1 TYPE1;
 282
 283 enum downloadtype {
 284   Type1, Type42
 285 };
 286
 287 typedef struct _tagDOWNLOAD {
 288   enum downloadtype type;
 289   union {
 290     TYPE1  *Type1;
 291     TYPE42 *Type42;
 292   } typeinfo;
 293   char *ps_name;
 294   struct _tagDOWNLOAD *next;
 295 } DOWNLOAD;
 296
 297 enum fontloc {
 298   Builtin, Download
 299 };
 300
 301 typedef struct
 302 {
 303     INT xx, xy, yx, yy;
 304 } matrix;
 305
 306 typedef struct {
 307     enum fontloc        fontloc;
 308     union {
 309         BUILTIN  Builtin;
 310         DOWNLOAD *Download;
 311     }                   fontinfo;
 312
 313     matrix              size;
 314     PSCOLOR             color;
 315     BOOL                set;            /* Have we done a setfont yet */
 316
 317   /* These are needed by PSDRV_ExtTextOut */
 318     int                 escapement;
 319     int                 underlineThickness;
 320     int                 underlinePosition;
 321     int                 strikeoutThickness;
 322     int                 strikeoutPosition;
 323
 324 } PSFONT;
 325
 326 typedef struct {
 327     PSCOLOR             color;
 328     BOOL                set;
 329 } PSBRUSH;
 330
 331 typedef struct {
 332     INT                 style;
 333     INT                 width;
 334     BYTE                join;
 335     BYTE                endcap;
 336     const char*         dash;
 337     PSCOLOR             color;
 338     BOOL                set;
 339 } PSPEN;
 340
 341 typedef struct {
 342     DWORD               id;             /* Job id */
 343     HANDLE              hprinter;       /* Printer handle */
 344     LPSTR               output;         /* Output file/port */
 345     LPSTR               DocName;        /* Document Name */
 346     BOOL                banding;        /* Have we received a NEXTBAND */
 347     BOOL                OutOfPage;      /* Page header not sent yet */
 348     INT                 PageNo;
 349     BOOL                quiet;          /* Don't actually output anything */
 350     BOOL                in_passthrough; /* In PASSTHROUGH mode */
 351     BOOL                had_passthrough_rect; /* See the comment in PSDRV_Rectangle */
 352 } JOB;
 353
 354 typedef struct {
 355     HDC                 hdc;
 356     PSFONT              font;           /* Current PS font */
 357     DOWNLOAD            *downloaded_fonts;
 358     PSPEN               pen;
 359     PSBRUSH             brush;
 360     PSCOLOR             bkColor;
 361     PSCOLOR             inkColor;       /* Last colour set */
 362     JOB                 job;
 363     PSDRV_DEVMODEA      *Devmode;
 364     PRINTERINFO         *pi;
 365     SIZE                PageSize;      /* Physical page size in device units */
 366     RECT                ImageableArea; /* Imageable area in device units */
 367                                        /* NB both PageSize and ImageableArea
 368                                           are not rotated in landscape mode,
 369                                           so PageSize.cx is generally
 370                                           < PageSize.cy */
 371     int                 horzRes;       /* device caps */
 372     int                 vertRes;
 373     int                 horzSize;
 374     int                 vertSize;
 375     int                 logPixelsX;
 376     int                 logPixelsY;
 377
 378     int                 pathdepth;
 379 } PSDRV_PDEVICE;
 380
 381 typedef struct {
 382     PRINTERINFO *pi;
 383     PSDRV_DEVMODEA *dlgdm;
 384 } PSDRV_DLGINFO;
 385
 386
 387 /*
 388  *  Every glyph name in the Adobe Glyph List and the 35 core PostScript fonts
 389  */
 390
 391 extern const INT    PSDRV_AGLGlyphNamesSize;
 392 extern GLYPHNAME    PSDRV_AGLGlyphNames[];
 393
 394
 395 /*
 396  *  The AGL encoding vector
 397  */
 398
 399 extern const INT            PSDRV_AGLbyNameSize;    /* sorted by name -     */
 400 extern const UNICODEGLYPH   PSDRV_AGLbyName[];      /*  duplicates omitted  */
 401
 402 extern const INT            PSDRV_AGLbyUVSize;      /* sorted by UV -       */
 403 extern const UNICODEGLYPH   PSDRV_AGLbyUV[];        /*  duplicates included */
 404
 405 extern HINSTANCE PSDRV_hInstance;
 406 extern HANDLE PSDRV_Heap;
 407 extern char *PSDRV_ANSIVector[256];
 408
 409 extern void PSDRV_MergeDevmodes(PSDRV_DEVMODEA *dm1, PSDRV_DEVMODEA *dm2,
 410                          PRINTERINFO *pi);
 411 extern BOOL PSDRV_GetFontMetrics(void);
 412 extern PPD *PSDRV_ParsePPD(char *fname);
 413 extern PRINTERINFO *PSDRV_FindPrinterInfo(LPCSTR name);
 414 extern const AFM *PSDRV_FindAFMinList(FONTFAMILY *head, LPCSTR name);
 415 extern BOOL PSDRV_AddAFMtoList(FONTFAMILY **head, const AFM *afm,
 416         BOOL *p_added);
 417 extern void PSDRV_FreeAFMList( FONTFAMILY *head );
 418
 419 extern INT PSDRV_XWStoDS( PSDRV_PDEVICE *physDev, INT width );
 420 extern INT PSDRV_YWStoDS( PSDRV_PDEVICE *physDev, INT height );
 421
 422 extern BOOL PSDRV_Brush(PSDRV_PDEVICE *physDev, BOOL EO);
 423 extern BOOL PSDRV_SetFont( PSDRV_PDEVICE *physDev );
 424 extern BOOL PSDRV_SetPen( PSDRV_PDEVICE *physDev );
 425
 426 extern void PSDRV_SetClip(PSDRV_PDEVICE* phyDev);
 427 extern void PSDRV_ResetClip(PSDRV_PDEVICE* phyDev);
 428
 429 extern BOOL PSDRV_CopyColor(PSCOLOR *col1, PSCOLOR *col2);
 430 extern void PSDRV_CreateColor( PSDRV_PDEVICE *physDev, PSCOLOR *pscolor,
 431                      COLORREF wincolor );
 432 extern char PSDRV_UnicodeToANSI(int u);
 433
 434 extern INT PSDRV_WriteHeader( PSDRV_PDEVICE *physDev, LPCSTR title );
 435 extern INT PSDRV_WriteFooter( PSDRV_PDEVICE *physDev );
 436 extern INT PSDRV_WriteNewPage( PSDRV_PDEVICE *physDev );
 437 extern INT PSDRV_WriteEndPage( PSDRV_PDEVICE *physDev );
 438 extern BOOL PSDRV_WriteMoveTo(PSDRV_PDEVICE *physDev, INT x, INT y);
 439 extern BOOL PSDRV_WriteLineTo(PSDRV_PDEVICE *physDev, INT x, INT y);
 440 extern BOOL PSDRV_WriteStroke(PSDRV_PDEVICE *physDev);
 441 extern BOOL PSDRV_WriteRectangle(PSDRV_PDEVICE *physDev, INT x, INT y, INT width,
 442                         INT height);
 443 extern BOOL PSDRV_WriteRRectangle(PSDRV_PDEVICE *physDev, INT x, INT y, INT width,
 444                         INT height);
 445 extern BOOL PSDRV_WriteSetFont(PSDRV_PDEVICE *physDev, const char *name, matrix size,
 446                                INT escapement);
 447 extern BOOL PSDRV_WriteGlyphShow(PSDRV_PDEVICE *physDev, LPCSTR g_name);
 448 extern BOOL PSDRV_WriteSetPen(PSDRV_PDEVICE *physDev);
 449 extern BOOL PSDRV_WriteArc(PSDRV_PDEVICE *physDev, INT x, INT y, INT w, INT h,
 450                              double ang1, double ang2);
 451 extern BOOL PSDRV_WriteSetColor(PSDRV_PDEVICE *physDev, PSCOLOR *color);
 452 extern BOOL PSDRV_WriteSetBrush(PSDRV_PDEVICE *physDev);
 453 extern BOOL PSDRV_WriteFill(PSDRV_PDEVICE *physDev);
 454 extern BOOL PSDRV_WriteEOFill(PSDRV_PDEVICE *physDev);
 455 extern BOOL PSDRV_WriteGSave(PSDRV_PDEVICE *physDev);
 456 extern BOOL PSDRV_WriteGRestore(PSDRV_PDEVICE *physDev);
 457 extern BOOL PSDRV_WriteNewPath(PSDRV_PDEVICE *physDev);
 458 extern BOOL PSDRV_WriteClosePath(PSDRV_PDEVICE *physDev);
 459 extern BOOL PSDRV_WriteClip(PSDRV_PDEVICE *physDev);
 460 extern BOOL PSDRV_WriteRectClip(PSDRV_PDEVICE *physDev, INT x, INT y, INT w, INT h);
 461 extern BOOL PSDRV_WriteRectClip2(PSDRV_PDEVICE *physDev, CHAR *pszArrayName);
 462 extern BOOL PSDRV_WriteEOClip(PSDRV_PDEVICE *physDev);
 463 extern BOOL PSDRV_WriteHatch(PSDRV_PDEVICE *physDev);
 464 extern BOOL PSDRV_WriteRotate(PSDRV_PDEVICE *physDev, float ang);
 465 extern BOOL PSDRV_WriteIndexColorSpaceBegin(PSDRV_PDEVICE *physDev, int size);
 466 extern BOOL PSDRV_WriteIndexColorSpaceEnd(PSDRV_PDEVICE *physDev);
 467 extern BOOL PSDRV_WriteRGB(PSDRV_PDEVICE *physDev, COLORREF *map, int number);
 468 extern BOOL PSDRV_WriteImage(PSDRV_PDEVICE *physDev, WORD depth, INT xDst, INT yDst,
 469                              INT widthDst, INT heightDst, INT widthSrc,
 470                              INT heightSrc, BOOL mask);
 471 extern BOOL PSDRV_WriteBytes(PSDRV_PDEVICE *physDev, const BYTE *bytes, DWORD number);
 472 extern BOOL PSDRV_WriteData(PSDRV_PDEVICE *physDev, const BYTE *byte, DWORD number);
 473 extern DWORD PSDRV_WriteSpool(PSDRV_PDEVICE *physDev, LPCSTR lpData, DWORD cch);
 474 extern BOOL PSDRV_WritePatternDict(PSDRV_PDEVICE *physDev, BITMAP *bm, BYTE *bits);
 475 extern BOOL PSDRV_WriteDIBPatternDict(PSDRV_PDEVICE *physDev, BITMAPINFO *bmi, UINT usage);
 476 extern BOOL PSDRV_WriteArrayPut(PSDRV_PDEVICE *physDev, CHAR *pszArrayName, INT nIndex, LONG lCoord);
 477 extern BOOL PSDRV_WriteArrayDef(PSDRV_PDEVICE *physDev, CHAR *pszArrayName, INT nSize);
 478
 479 extern INT CDECL PSDRV_StartPage( PSDRV_PDEVICE *physDev );
 480
 481 INT PSDRV_GlyphListInit(void);
 482 const GLYPHNAME *PSDRV_GlyphName(LPCSTR szName);
 483 VOID PSDRV_IndexGlyphList(void);
 484 BOOL PSDRV_GetTrueTypeMetrics(void);
 485 BOOL PSDRV_GetType1Metrics(void);
 486 const AFMMETRICS *PSDRV_UVMetrics(LONG UV, const AFM *afm);
 487 SHORT PSDRV_CalcAvgCharWidth(const AFM *afm);
 488
 489 extern BOOL PSDRV_SelectBuiltinFont(PSDRV_PDEVICE *physDev, HFONT hfont,
 490                                     LOGFONTW *plf, LPSTR FaceName);
 491 extern BOOL PSDRV_WriteSetBuiltinFont(PSDRV_PDEVICE *physDev);
 492 extern BOOL PSDRV_WriteBuiltinGlyphShow(PSDRV_PDEVICE *physDev, LPCWSTR str, INT count);
 493
 494 extern BOOL PSDRV_SelectDownloadFont(PSDRV_PDEVICE *physDev);
 495 extern BOOL PSDRV_WriteSetDownloadFont(PSDRV_PDEVICE *physDev);
 496 extern BOOL PSDRV_WriteDownloadGlyphShow(PSDRV_PDEVICE *physDev, WORD *glpyhs,
 497                                          UINT count);
 498 extern BOOL PSDRV_EmptyDownloadList(PSDRV_PDEVICE *physDev, BOOL write_undef);
 499
 500 extern DWORD write_spool( PSDRV_PDEVICE *physDev, const void *data, DWORD num );
 501
 502 #define MAX_G_NAME 31 /* max length of PS glyph name */
 503 extern void get_glyph_name(HDC hdc, WORD index, char *name);
 504
 505 extern TYPE1 *T1_download_header(PSDRV_PDEVICE *physDev, char *ps_name,
 506                                  RECT *bbox, UINT emsize);
 507 extern BOOL T1_download_glyph(PSDRV_PDEVICE *physDev, DOWNLOAD *pdl,
 508                               DWORD index, char *glyph_name);
 509 extern void T1_free(TYPE1 *t1);
 510
 511 extern TYPE42 *T42_download_header(PSDRV_PDEVICE *physDev, char *ps_name,
 512                                    RECT *bbox, UINT emsize);
 513 extern BOOL T42_download_glyph(PSDRV_PDEVICE *physDev, DOWNLOAD *pdl,
 514                                DWORD index, char *glyph_name);
 515 extern void T42_free(TYPE42 *t42);
 516
 517 extern DWORD RLE_encode(BYTE *in_buf, DWORD len, BYTE *out_buf);
 518 extern DWORD ASCII85_encode(BYTE *in_buf, DWORD len, BYTE *out_buf);
 519
 520 #define push_lc_numeric(x) do {                                 \
 521         const char *tmplocale = setlocale(LC_NUMERIC,NULL);     \
 522         setlocale(LC_NUMERIC,x);
 523
 524 #define pop_lc_numeric()                                        \
 525         setlocale(LC_NUMERIC,tmplocale);                        \
 526 } while (0)
 527
 528
 529 #endif