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: klfbackend.h 603 2011-02-26 23:14:55Z phfaist $ */

#ifndef KLFBACKEND_H
#define KLFBACKEND_H

#include <klfdefs.h>

#include <qstring.h>
#include <qstringlist.h>
#ifdef KLFBACKEND_QT4
#include <QByteArray>
#else
#include <qmemarray.h>
#endif
#include <qimage.h>
#include <qmutex.h>





#define KLFERR_NOERROR 0

#define KLFERR_MISSINGLATEXFORMULA -1

#define KLFERR_MISSINGMATHMODETHREEDOTS -2

#define KLFERR_TEXWRITEFAIL -3

#define KLFERR_NOLATEXPROG -4

#define KLFERR_LATEXNONORMALEXIT -5

#define KLFERR_NODVIFILE -6

#define KLFERR_NODVIPSPROG -7

#define KLFERR_DVIPSNONORMALEXIT -8

#define KLFERR_NOEPSFILE -9

#define KLFERR_EPSREADFAIL -10

#define KLFERR_NOEPSBBOX -11

#define KLFERR_BADEPSBBOX -12

#define KLFERR_EPSWRITEFAIL -13

#define KLFERR_NOEPSFILE_OF -22

#define KLFERR_EPSREADFAIL_OF -23

#define KLFERR_NOGSPROG -14

#define KLFERR_GSNONORMALEXIT -15

#define KLFERR_NOPNGFILE -16

#define KLFERR_PNGREADFAIL -17

#define KLFERR_NOEPSTOPDFPROG -18

#define KLFERR_EPSTOPDFNONORMALEXIT -19

#define KLFERR_NOPDFFILE -20

#define KLFERR_PDFREADFAIL -21
// last error defined: -23

#define KLFERR_PROGERR_LATEX 1

#define KLFERR_PROGERR_DVIPS 2

#define KLFERR_PROGERR_GS 3

#define KLFERR_PROGERR_GS_OF 5

#define KLFERR_PROGERR_EPSTOPDF 4
// last error defined: 5



class KLF_EXPORT KLFBackend
{
public:


  struct klfSettings {
    klfSettings() : tborderoffset(0), rborderoffset(0), bborderoffset(0), lborderoffset(0),
                    outlineFonts(true), execenv() { }
    QString tempdir;
    QString latexexec;
    QString dvipsexec;
    QString gsexec;
    QString epstopdfexec;

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

    bool outlineFonts;

    QStringList execenv;
  };


  struct klfInput {
    klfInput() : fg_color(0x00), bg_color(0xffffffff), dpi(600), bypassTemplate(false) { }
    QString latex;
    QString mathmode;
    QString preamble;
    unsigned long fg_color;
    unsigned long bg_color;
    int dpi;
    bool bypassTemplate;
  };


  struct klfOutput {
    int status;
    QString errorstr;

    QImage result;

    klfInput input;
    klfSettings settings;

    QByteArray pngdata_raw;
    QByteArray pngdata;
    QByteArray epsdata;
    QByteArray pdfdata;
  };

  static klfOutput getLatexFormula(const klfInput& in, const klfSettings& settings);

  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());


private:
  KLFBackend();

  friend struct cleanup_caller;
  static void cleanup(QString tempfname);

  static QMutex __mutex;
};


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

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

#endif