src/klfbackend/klfbackend.h

Go to the documentation of this file.

/***************************************************************************
 *   file klfbackend.h
 *   This file is part of the KLatexFormula Project.
 *   Copyright (C) 2011 by Philippe Faist
 *   philippe.faist@bluewin.ch
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
/* $Id$ */

#ifndef KLFBACKEND_H
#define KLFBACKEND_H

#include <QString>
#include <QStringList>
#include <QByteArray>
#include <QImage>
#include <QMutex>
#include <QMap>
#include <QVariant>

#include <klfdefs.h>
#include <klfpobj.h>
#include <klfutil.h> // KLFRefPtr



#define KLFERR_NOERROR 0

#define KLFERR_TEMPDIR_FAIL -48

#define KLFERR_MISSINGLATEXFORMULA -1

#define KLFERR_MISSINGMATHMODETHREEDOTS -2

#define KLFERR_TEXWRITEFAIL -3

#define KLFERR_LATEX_NORUN -4

#define KLFERR_NOLATEXPROG KLFERR_LATEX_NORUN

#define KLFERR_LATEX_NONORMALEXIT -5

#define KLFERR_LATEXNONORMALEXIT KLFERR_LATEX_NONORMALEXIT

#define KLFERR_LATEX_NOOUTPUT -6

#define KLFERR_NODVIFILE KLFERR_LATEX_NOOUTPUT

#define KLFERR_LATEX_OUTPUTREADFAIL -24

#define KLFERR_DVIREADFAIL KLFERR_LATEX_OUTPUTREADFAIL

#define KLFERR_DVIPS_NORUN -7

#define KLFERR_NODVIPSPROG KLFERR_DVIPS_NORUN

#define KLFERR_DVIPS_NONORMALEXIT -8

#define KLFERR_DVIPSNONORMALEXIT KLFERR_DVIPS_NONORMALEXIT

#define KLFERR_DVIPS_NOOUTPUT -9

#define KLFERR_NOEPSFILE KLFERR_DVIPS_NOOUTPUT

#define KLFERR_DVIPS_OUTPUTREADFAIL -10

#define KLFERR_EPSREADFAIL KLFERR_DVIPS_OUTPUTREADFAIL

#define KLFERR_DVIPS_OUTPUTNOBBOX -11

#define KLFERR_NOEPSBBOX KLFERR_DVIPS_OUTPUTNOBBOX

#define KLFERR_GSBBOX_NORUN -25

#define KLFERR_GSBBOX_NONORMALEXIT -26

#define KLFERR_GSBBOX_NOOUTPUT -27

#define KLFERR_GSBBOX_NOBBOX -28

#define KLFERR_GSPOSTPROC_NORUN -29

#define KLFERR_GSPOSTPROC_NONORMALEXIT -30

#define KLFERR_GSPOSTPROC_NOOUTPUT -22

#define KLFERR_GSPOSTPROC_NOOUTLINEFONTS -49

#define KLFERR_NOEPSFILE_OF KLFERR_GSPOSTPROC_NOOUTPUT

#define KLFERR_GSPOSTPROC_OUTPUTREADFAIL -23

#define KLFERR_EPSREADFAIL_OF KLFERR_GSPOSTPROC_OUTPUTREADFAIL

#define KLFERR_GSPNG_NORUN -14

#define KLFERR_NOGSPROG KLFERR_GSPNG_NORUN

#define KLFERR_GSPNG_NONORMALEXIT -15

#define KLFERR_GSNONORMALEXIT KLFERR_GSPNG_NONORMALEXIT

#define KLFERR_GSPNG_NOOUTPUT -16

#define KLFERR_NOPNGFILE KLFERR_GSPNG_NOOUTPUT

#define KLFERR_GSPNG_OUTPUTREADFAIL -17

#define KLFERR_PNGREADFAIL KLFERR_GSPNG_OUTPUTREADFAIL

#define KLFERR_PDFMARKSWRITEFAIL -47

#define KLFERR_GSPDF_NORUN -31

#define KLFERR_GSPDF_NONORMALEXIT -19

#define KLFERR_EPSTOPDFNONORMALEXIT KLFERR_GSPDF_NONORMALEXIT

#define KLFERR_GSPDF_NOOUTPUT -20

#define KLFERR_NOPDFFILE KLFERR_GSPDF_NOOUTPUT

#define KLFERR_GSPDF_OUTPUTREADFAIL -21

#define KLFERR_PDFREADFAIL KLFERR_GSPDF_OUTPUTREADFAIL

#define KLFERR_NOGSVERSION -32

#define KLFERR_GSSVG_NOSVG -33

#define KLFERR_GSSVG_NORUN -34

#define KLFERR_GSSVG_NONORMALEXIT -35

#define KLFERR_GSSVG_NOOUTPUT -36

#define KLFERR_GSSVG_OUTPUTREADFAIL -37

#define KLFERR_USERSCRIPT_NORUN -38
#define KLFERR_USERSCRIPT_NONORMALEXIT -39
#define KLFERR_USERSCRIPT_NOSCRIPTINFO -40
#define KLFERR_USERSCRIPT_INVALIDSCRIPTINFO -41
#define KLFERR_USERSCRIPT_NOOUTPUT -42
#define KLFERR_USERSCRIPT_OUTPUTREADFAIL -43
#define KLFERR_USERSCRIPT_BADKLFVERSION -44
#define KLFERR_USERSCRIPT_BADSKIPFORMATS -45
#define KLFERR_USERSCRIPT_BADCATEGORY -46
// last error defined: -49



#define KLFERR_PROGERR_LATEX 1

#define KLFERR_PROGERR_DVIPS 2

#define KLFERR_PROGERR_GSBBOX 6

#define KLFERR_PROGERR_GSPOSTPROC 5

#define KLFERR_PROGERR_GS_OF KLFERR_PROGERR_GSPOSTPROC

#define KLFERR_PROGERR_GSPNG 3

#define KLFERR_PROGERR_GS KLFERR_PROGERR_GSPNG

#define KLFERR_PROGERR_GSPDF 4

#define KLFERR_PROGERR_EPSTOPDF KLFERR_PROGERR_GSPDF

#define KLFERR_PROGERR_GSSVG 7

#define KLFERR_PROGERR_USERSCRIPT 8
// last error defined: 8



class KLF_EXPORT KLFBackend
{
public:

  class TemplateGenerator;


  struct klfSettings
  {
    klfSettings() : tborderoffset(0), rborderoffset(0), bborderoffset(0), lborderoffset(0),
                    calcEpsBoundingBox(true), outlineFonts(true),
                    wantRaw(false), wantPDF(true), wantSVG(true), execenv(),
                    templateGenerator(NULL) { }

    QString tempdir;
    QString latexexec;
    QString dvipsexec;
    QString gsexec;
    QString epstopdfexec;

    double tborderoffset;
    double rborderoffset;
    double bborderoffset;
    double lborderoffset;

    bool calcEpsBoundingBox;

    bool outlineFonts;

    bool wantRaw;

    bool wantPDF;

    bool wantSVG;

    QStringList execenv;

    TemplateGenerator *templateGenerator;

    QMap<QString,QString> userScriptInterpreters;
  };


  struct klfInput
  {
    klfInput() : fontsize(-1), fg_color(0x00), bg_color(0xffffffff), dpi(600), vectorscale(1.0),
                 bypassTemplate(false) { }
    QString latex;
    QString mathmode;
    QString preamble;
    double fontsize;

    unsigned long fg_color;
    unsigned long bg_color;
    int dpi;

    double vectorscale;

    bool bypassTemplate;

    QString userScript;

    QMap<QString,QString> userScriptParam;
  };


  struct klfOutput
  {
    int status;

    QString errorstr;

    QImage result;

    klfInput input;
    klfSettings settings;

    QByteArray dvidata;
    QByteArray pngdata_raw;
    QByteArray pngdata;
    QByteArray epsdata_raw;
    QByteArray epsdata_bbox;
    QByteArray epsdata;
    QByteArray pdfdata;
    QByteArray svgdata;
    double width_pt;
    double height_pt;
  };

  static klfOutput getLatexFormula(const klfInput& in, const klfSettings& settings,
                                   bool isMainThread = true);

  static QStringList availableSaveFormats(const klfOutput * output = NULL) ;

  static QStringList availableSaveFormats(const klfOutput& output) ;

  static bool saveOutputToFile(const klfOutput& output, const QString& fileName,
                               const QString& format = QString(), QString* errorString = NULL);

  static bool saveOutputToDevice(const klfOutput& output, QIODevice *device,
                                 const QString& format = QString("PNG"), QString* errorString = NULL);

  static bool detectSettings(klfSettings *settings, const QString& extraPath = QString(),
                             bool isMainThread = true);

  static bool detectOptionSettings(klfSettings *settings, bool isMainThread = true);

  static QStringList userScriptSettingsToEnvironment(const QMap<QString,QString>& userScriptSettings);


  class TemplateGenerator {
  public:
    TemplateGenerator();
    virtual ~TemplateGenerator();

    virtual QString generateTemplate(const klfInput& input, const klfSettings& settings) = 0;
  };

  class DefaultTemplateGenerator : public TemplateGenerator {
  public:
    DefaultTemplateGenerator();
    virtual ~DefaultTemplateGenerator();

    virtual QString generateTemplate(const klfInput& input, const klfSettings& settings);
  };



private:
  KLFBackend();
};



KLF_EXPORT bool operator==(const KLFBackend::klfInput& a, const KLFBackend::klfInput& b);
KLF_EXPORT bool operator==(const KLFBackend::klfSettings& a, const KLFBackend::klfSettings& b);

KLF_EXPORT bool klf_detect_execenv(KLFBackend::klfSettings *settings);





KLF_EXPORT QStringList klfSettingsToEnvironmentForUserScript(const KLFBackend::klfSettings& settings);
KLF_EXPORT QStringList klfInputToEnvironmentForUserScript(const KLFBackend::klfInput& in);



class KLF_EXPORT KLFAbstractLatexMetaInfo
{
public:
  KLFAbstractLatexMetaInfo();
  virtual ~KLFAbstractLatexMetaInfo();

  virtual QString loadField(const QString& key) = 0;
  virtual void saveField(const QString& key, const QString& value) = 0;

  virtual void saveMetaInfo(const KLFBackend::klfInput& in, const KLFBackend::klfSettings& settings) ;
};

class KLF_EXPORT KLFImageLatexMetaInfo : public KLFAbstractLatexMetaInfo
{
public:
  KLFImageLatexMetaInfo(QImage *img);

  QString loadField(const QString &k);
  void saveField(const QString& k, const QString& v);

private:
  QImage *_w;
};


class KLFPdfmarksWriteLatexMetaInfo : public KLFAbstractLatexMetaInfo
{
public:
  KLFPdfmarksWriteLatexMetaInfo(QByteArray * string);

  void saveField(const QString& k, const QString& v);
  void finish();

  void savePDFField(const QString& k, const QString& v);

  QString loadField(const QString& );

private:
  QByteArray * _s;
};





#endif