pdf/xpdf/PDFDoc.h

   1 //========================================================================
   2 //
   3 // PDFDoc.h
   4 //
   5 // Copyright 1996-2003 Glyph & Cog, LLC
   6 //
   7 //========================================================================
   8
   9 #ifndef PDFDOC_H
  10 #define PDFDOC_H
  11
  12 #include <aconf.h>
  13
  14 #ifdef USE_GCC_PRAGMAS
  15 #pragma interface
  16 #endif
  17
  18 #include <stdio.h>
  19 #include "XRef.h"
  20 #include "Link.h"
  21 #include "Catalog.h"
  22 #include "Page.h"
  23 #include "Annot.h"
  24
  25 class GString;
  26 class BaseStream;
  27 class OutputDev;
  28 class Links;
  29 class LinkAction;
  30 class LinkDest;
  31 class Outline;
  32
  33 //------------------------------------------------------------------------
  34 // PDFDoc
  35 //------------------------------------------------------------------------
  36
  37 class PDFDoc {
  38 public:
  39
  40   PDFDoc(GString *fileNameA, GString *ownerPassword = NULL,
  41          GString *userPassword = NULL);
  42   PDFDoc(BaseStream *strA, GString *ownerPassword = NULL,
  43          GString *userPassword = NULL);
  44   ~PDFDoc();
  45
  46   // Was PDF document successfully opened?
  47   GBool isOk() { return ok; }
  48
  49   // Get the error code (if isOk() returns false).
  50   int getErrorCode() { return errCode; }
  51
  52   // Get file name.
  53   GString *getFileName() { return fileName; }
  54
  55   // Get the xref table.
  56   XRef *getXRef() { return xref; }
  57
  58   // Get catalog.
  59   Catalog *getCatalog() { return catalog; }
  60
  61   // Get base stream.
  62   BaseStream *getBaseStream() { return str; }
  63
  64   // Get page parameters.
  65   double getPageWidth(int page)
  66     { return catalog->getPage(page)->getWidth(); }
  67   double getPageHeight(int page)
  68     { return catalog->getPage(page)->getHeight(); }
  69   int getPageRotate(int page)
  70     { return catalog->getPage(page)->getRotate(); }
  71
  72   // Get number of pages.
  73   int getNumPages() { return catalog->getNumPages(); }
  74
  75   // Return the contents of the metadata stream, or NULL if there is
  76   // no metadata.
  77   GString *readMetadata() { return catalog->readMetadata(); }
  78
  79   // Return the structure tree root object.
  80   Object *getStructTreeRoot() { return catalog->getStructTreeRoot(); }
  81
  82   // Display a page.
  83   void displayPage(OutputDev *out, int page, double zoom,
  84                    int rotate, GBool doLinks,
  85                    GBool (*abortCheckCbk)(void *data) = NULL,
  86                    void *abortCheckCbkData = NULL,
  87                    GBool (*annotDisplayDecideCbk)(Annot *annot, void *user_data) = NULL,
  88                    void *annotDisplayDecideCbkData = NULL);
  89
  90   // Display a range of pages.
  91   void displayPages(OutputDev *out, int firstPage, int lastPage,
  92                     int zoom, int rotate, GBool doLinks,
  93                     GBool (*abortCheckCbk)(void *data) = NULL,
  94                     void *abortCheckCbkData = NULL,
  95                     GBool (*annotDisplayDecideCbk)(Annot *annot, void *user_data) = NULL,
  96                     void *annotDisplayDecideCbkData = NULL);
  97
  98   // Display part of a page.
  99   void displayPageSlice(OutputDev *out, int page, double zoom,
 100                         int rotate, int sliceX, int sliceY,
 101                         int sliceW, int sliceH,
 102                         GBool (*abortCheckCbk)(void *data) = NULL,
 103                         void *abortCheckCbkData = NULL,
 104                         GBool (*annotDisplayDecideCbk)(Annot *annot, void *user_data) = NULL,
 105                         void *annotDisplayDecideCbkData = NULL);
 106
 107   // Find a page, given its object ID.  Returns page number, or 0 if
 108   // not found.
 109   int findPage(int num, int gen) { return catalog->findPage(num, gen); }
 110
 111   // If point <x>,<y> is in a link, return the associated action;
 112   // else return NULL.
 113   LinkAction *findLink(double x, double y) { return links->find(x, y); }
 114
 115   // Return true if <x>,<y> is in a link.
 116   GBool onLink(double x, double y) { return links->onLink(x, y); }
 117
 118   // Find a named destination.  Returns the link destination, or
 119   // NULL if <name> is not a destination.
 120   LinkDest *findDest(GString *name)
 121     { return catalog->findDest(name); }
 122
 123 #ifndef DISABLE_OUTLINE
 124   // Return the outline object.
 125   Outline *getOutline() { return outline; }
 126 #endif
 127
 128   // Is the file encrypted?
 129   GBool isEncrypted() { return xref->isEncrypted(); }
 130
 131   // Check various permissions.
 132   GBool okToPrint(GBool ignoreOwnerPW = gFalse)
 133     { return xref->okToPrint(ignoreOwnerPW); }
 134   GBool okToChange(GBool ignoreOwnerPW = gFalse)
 135     { return xref->okToChange(ignoreOwnerPW); }
 136   GBool okToCopy(GBool ignoreOwnerPW = gFalse)
 137     { return xref->okToCopy(ignoreOwnerPW); }
 138   GBool okToAddNotes(GBool ignoreOwnerPW = gFalse)
 139     { return xref->okToAddNotes(ignoreOwnerPW); }
 140
 141   // Is this document linearized?
 142   GBool isLinearized();
 143
 144   // Return the document's Info dictionary (if any).
 145   Object *getDocInfo(Object *obj) { return xref->getDocInfo(obj); }
 146   Object *getDocInfoNF(Object *obj) { return xref->getDocInfoNF(obj); }
 147
 148   // Return the PDF version specified by the file.
 149   double getPDFVersion() { return pdfVersion; }
 150
 151   // Save this file with another name.
 152   GBool saveAs(GString *name);
 153
 154 private:
 155
 156   GBool setup(GString *ownerPassword, GString *userPassword);
 157   void checkHeader();
 158   void getLinks(Page *page);
 159
 160   GString *fileName;
 161   FILE *file;
 162   BaseStream *str;
 163   double pdfVersion;
 164   XRef *xref;
 165   Catalog *catalog;
 166   Links *links;
 167 #ifndef DISABLE_OUTLINE
 168   Outline *outline;
 169 #endif
 170
 171   GBool ok;
 172   int errCode;
 173 };
 174
 175 #endif