[KLF Application][KLF Tools][KLF Backend][KLF Home]
KLatexFormula Project
Classes | Macros | Functions
klfbackend.h File Reference

Definition of class KLFBackend. More...

#include <klfdefs.h>
#include <qstring.h>
#include <qstringlist.h>
#include <QByteArray>
#include <qimage.h>
#include <qmutex.h>
Include dependency graph for klfbackend.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  KLFBackend
 The main engine for KLatexFormula. More...
 
struct  KLFBackend::klfSettings
 General settings for KLFBackend::getLatexFormula() More...
 
struct  KLFBackend::klfInput
 Specific input to KLFBackend::getLatexFormula() More...
 
struct  KLFBackend::klfOutput
 KLFBackend::getLatexFormula() result. More...
 

Macros

#define KLFERR_NOERROR   0
 No Error.
 
#define KLFERR_MISSINGLATEXFORMULA   -1
 No LaTeX formula is specified (empty string)
 
#define KLFERR_MISSINGMATHMODETHREEDOTS   -2
 The "..." is missing in math mode string.
 
#define KLFERR_TEXWRITEFAIL   -3
 Error while opening .tex file for writing.
 
#define KLFERR_NOLATEXPROG   -4
 Error while launching the given latex program.
 
#define KLFERR_LATEXNONORMALEXIT   -5
 latex program did not exit properly (program killed) (see also KLFERR_PROGERR_LATEX)
 
#define KLFERR_NODVIFILE   -6
 No .dvi file appeared after runnig latex program.
 
#define KLFERR_NODVIPSPROG   -7
 Error while launching the given dvips program.
 
#define KLFERR_DVIPSNONORMALEXIT   -8
 dvips program did not exit properly (program killed) (see also KLFERR_PROGERR_DVIPS)
 
#define KLFERR_NOEPSFILE   -9
 no .eps file appeared after running dvips program
 
#define KLFERR_EPSREADFAIL   -10
 Error while opening .eps file for reading.
 
#define KLFERR_NOEPSBBOX   -11
 Error while searching file for %BoundingBox instruction in EPS.
 
#define KLFERR_BADEPSBBOX   -12
 Error while parsing value for %BoundingBox instruction in EPS.
 
#define KLFERR_EPSWRITEFAIL   -13
 Error while opening ...-good.eps file for writing.
 
#define KLFERR_NOEPSFILE_OF   -22
 No -outlfonts.eps file appeared after calling gs for outlining fonts.
 
#define KLFERR_EPSREADFAIL_OF   -23
 Error while opening -outlfonts.eps after outlining fonts with gs.
 
#define KLFERR_NOGSPROG   -14
 Error while launching the given gs program.
 
#define KLFERR_GSNONORMALEXIT   -15
 gs program did not exit properly (program killed) (see also KLFERR_PROGERR_GS)
 
#define KLFERR_NOPNGFILE   -16
 No .png file appeared after running gs program.
 
#define KLFERR_PNGREADFAIL   -17
 Error while opening .png file for reading.
 
#define KLFERR_NOEPSTOPDFPROG   -18
 Error while launching the given epstopdf program (if given)
 
#define KLFERR_EPSTOPDFNONORMALEXIT   -19
 epstopdf program did not exit properly (program killed) (see also KLFERR_PROGERR_EPSTOPDF)
 
#define KLFERR_NOPDFFILE   -20
 No .pdf file appeared after running epstopdf program.
 
#define KLFERR_PDFREADFAIL   -21
 Error while opening .pdf file for reading.
 
#define KLFERR_PROGERR_LATEX   1
 latex exited with a non-zero status
 
#define KLFERR_PROGERR_DVIPS   2
 dvips exited with a non-zero status
 
#define KLFERR_PROGERR_GS   3
 gs exited with a non-zero status
 
#define KLFERR_PROGERR_GS_OF   5
 gs (while outlining fonts) exited with non-zero status
 
#define KLFERR_PROGERR_EPSTOPDF   4
 epstopdf exited with non-zero status (if epstopdf is to be used)
 

Functions

bool KLF_EXPORT operator== (const KLFBackend::klfInput &a, const KLFBackend::klfInput &b)
 
bool KLF_EXPORT klf_detect_execenv (KLFBackend::klfSettings *settings)
 detects any additional settings to environment variables More...
 

Detailed Description

Definition of class KLFBackend.

This file defines the KLFBackend class, which is the base engine providing our core functionality of transforming LaTeX code into graphics.

Definition in file klfbackend.h.

Function Documentation

bool KLF_EXPORT klf_detect_execenv ( KLFBackend::klfSettings settings)

detects any additional settings to environment variables

Detects whether the given values of latex, dvips, gs and epstopdf in the given (initialized) settings settings need extra environment set, and sets the execenv member of settings accordingly.

Note that the environment settings already existing in settings->execenv are kept; only those variables for which new values are detected are updated, or if new declarations are needed they are appended.

Note
KLFBackend::detectSettings() already calls this function, you don't have to call this function manually in that case.
Returns
TRUE (success) or FALSE (failure). Currently there is no reason for failure, and returns always TRUE (as of 3.2.1).

Definition at line 1209 of file klfbackend.cpp.

References KLFBackend::klfSettings::epstopdfexec, KLFBackend::klfSettings::execenv, QFileInfo::fileName(), KLFBackend::klfSettings::gsexec, QString::isEmpty(), and klfDbg.

Referenced by KLFBackend::detectSettings().

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

Generated by doxygen 1.8.8