okular/generators/dvi/dviFile.h

   1 // -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; c-brace-offset: 0; -*-
   2 //
   3 // Class: dviFile
   4 //
   5 // Class that represents a DVI file. Part of KDVI - A DVI previewing
   6 // plugin for kviewshell.
   7 //
   8 // (C) 2004-2005 Stefan Kebekus. Distributed under the GPL.
   9 //
  10
  11 #ifndef _DVIFILE_H
  12 #define _DVIFILE_H
  13
  14 #include "bigEndianByteReader.h"
  15
  16 #include <Q3IntDict>
  17 #include <Q3MemArray>
  18 #include <QIODevice>
  19 #include <QMap>
  20
  21
  22 class fontPool;
  23 class pageSize;
  24 class TeXFontDefinition;
  25
  26
  27 class dvifile : public bigEndianByteReader
  28 {
  29  public:
  30   /** Makes a deep copy of the old DVI file. */
  31   dvifile(const dvifile *old, fontPool *fp );
  32   dvifile(const QString& fname, class fontPool* pool);
  33
  34   ~dvifile();
  35
  36   fontPool     * font_pool;
  37   QString        filename;
  38   QString        generatorString;
  39   quint16       total_pages;
  40   Q3MemArray<quint32> page_offset;
  41
  42   /** Saves the DVI file. Returns true on success. */
  43   bool           saveAs(const QString &filename);
  44
  45   // Returns a pointer to the DVI file's data, or 0 if no data has yet
  46   // been allocated.
  47   quint8      * dvi_Data() {return dviData.data();}
  48
  49   QIODevice::Offset size_of_file;
  50   QString        errorMsg;
  51
  52   /** This field is set to zero when the DVI file is constructed, and
  53       will be modified during the prescan phase (at this time the
  54       prescan code still resides in the dviRenderer class) */
  55   quint16       numberOfExternalPSFiles;
  56
  57   /** This field is set to zero when the DVI file is constructed, and
  58       will be modified during the prescan phase (at this time the
  59       prescan code still resides in the dviRenderer class) */
  60   quint16       numberOfExternalNONPSFiles;
  61
  62   quint32       beginning_of_postamble;
  63
  64   /** This flag is set to "true" during the construction of the
  65       dvifile, and is never changed afterwards by the dvifile
  66       class. It is used in kdvi in conjuction with source-specials:
  67       the first time a page with source specials is rendered, KDVI
  68       shows an info dialog, and the flag is set to false. That way
  69       KDVI ensures that the user is only informed once. */
  70   bool           sourceSpecialMarker;
  71
  72   Q3IntDict<TeXFontDefinition> tn_table;
  73
  74   /** Returns the number of centimeters per DVI unit in this DVI
  75       file. */
  76   double         getCmPerDVIunit() const {return cmPerDVIunit;}
  77
  78   /** Returns the magnification of the DVI file, as described in the
  79       DVI Standard. */
  80   quint32        getMagnification() const {return _magnification;}
  81
  82   /** This member is set to zero on construction and can be used by
  83       other software to count error messages that were printed when
  84       the DVI-file was processed. Suggested application: limit the
  85       number of error messages to, say, 25. */
  86   quint8        errorCounter;
  87
  88   /** Papersize information read from the dvi-File */
  89   pageSize       *suggestedPageSize;
  90
  91   /** Sets new DVI data; all old data is erased. EXPERIMENTAL, use
  92       with care. */
  93   void           setNewData(const Q3MemArray<quint8>& newData) {dviData = newData;}
  94
  95   /** Page numbers that appear in a DVI document need not be
  96       ordered. Worse, page numbers need not be unique. This method
  97       renumbers the pages. */
  98   void           renumber();
  99
 100   /** PDF to PS file conversion
 101
 102   This utility method takes the name of a PDF-file, and attempts to
 103   convert it to a PS file. The dvifile internally keeps a list of
 104   converted files, to do two thigs:
 105
 106   - convert files only once.
 107
 108   - delete all converted files on destruction
 109
 110   @warning The internal buffer can lead to difficulties if filenames
 111     of PDF-files are not unique: if the content of a PDF file is
 112     changed and this method is called a second time with the same file
 113     name, the method will then NOT convert the file, but simply return
 114     the name from the buffer
 115
 116   @returns The name of the PS file, or QString() on failure.
 117   */
 118   QString convertPDFtoPS(const QString &PDFFilename, QString *converrorms=0);
 119
 120  private:
 121   /** process_preamble reads the information in the preamble and
 122       stores it into global variables for later use. */
 123   void           process_preamble();
 124   void           find_postamble();
 125   /** read_postamble reads the information in the postamble, storing
 126       it into global variables. It also takes care of reading in all
 127       of the pixel files for the fonts used in the job. */
 128   void           read_postamble();
 129   void           prepare_pages();
 130
 131
 132   /** Offset in DVI file of last page, set in read_postamble(). */
 133   quint32       last_page_offset;
 134   quint32       _magnification;
 135
 136   double         cmPerDVIunit;
 137
 138   Q3MemArray<quint8>  dviData;
 139
 140   /** Map of filenames for converted PDF files
 141
 142   This map contains names of PDF files that were converted to
 143   PostScript. The key is the name of the PDF file, the data the name
 144   of the associated PS file, or QString(), if the file could not
 145   be converted. The PS files are deleted when the DVI-file is
 146   destructed. */
 147   QMap<QString, QString> convertedFiles;
 148
 149   /** Flag, used so that KDVI complains only once about a missing
 150       "PDF2PS" utility. Set to "false" in the constructor. */
 151   bool           have_complainedAboutMissingPDF2PS;
 152 };
 153
 154 #endif //ifndef _DVIFILE_H