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

Definition of class KLFBackend. More...

#include <QString>
#include <QStringList>
#include <QByteArray>
#include <QImage>
#include <QMutex>
#include <QMap>
#include <QVariant>
#include <klfdefs.h>
#include <klfpobj.h>
#include <klfutil.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...
 
class  KLFBackend::TemplateGenerator
 
class  KLFBackend::DefaultTemplateGenerator
 
class  KLFAbstractLatexMetaInfo
 Reading and writing klfbackend meta-info. More...
 
class  KLFImageLatexMetaInfo
 
class  KLFPdfmarksWriteLatexMetaInfo
 Write metainfo to PDF files via pdfmarks for ghostscript. More...
 

Macros

#define KLFERR_NOERROR   0
 No Error.
 
#define KLFERR_TEMPDIR_FAIL   -48
 Failed to create the temporary directory.
 
#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_LATEX_NORUN   -4
 Error while launching the given latex program.
 
#define KLFERR_NOLATEXPROG   KLFERR_LATEX_NORUN
 obsolete, same as KLFERR_LATEX_NORUN
 
#define KLFERR_LATEX_NONORMALEXIT   -5
 latex program did not exit properly (program killed) (see also KLFERR_PROGERR_LATEX)
 
#define KLFERR_LATEXNONORMALEXIT   KLFERR_LATEX_NONORMALEXIT
 obsolete, same as KLFERR_LATEX_NONORMALEXIT
 
#define KLFERR_LATEX_NOOUTPUT   -6
 No .dvi file appeared after runnig latex program.
 
#define KLFERR_NODVIFILE   KLFERR_LATEX_NOOUTPUT
 obsolete, same as KLFERR_LATEX_NOOUTPUT
 
#define KLFERR_LATEX_OUTPUTREADFAIL   -24
 Error while opening .dvi file for reading.
 
#define KLFERR_DVIREADFAIL   KLFERR_LATEX_OUTPUTREADFAIL
 obsolete, same as KLFERR_LATEX_OUTPUTREADFAIL
 
#define KLFERR_DVIPS_NORUN   -7
 Error while launching the given dvips program.
 
#define KLFERR_NODVIPSPROG   KLFERR_DVIPS_NORUN
 obsolete, same as KLFERR_DVIPS_NORUN
 
#define KLFERR_DVIPS_NONORMALEXIT   -8
 dvips program did not exit properly (program killed) (see also KLFERR_PROGERR_DVIPS)
 
#define KLFERR_DVIPSNONORMALEXIT   KLFERR_DVIPS_NONORMALEXIT
 obsolete, same as KLFERR_DVIPS_NONORMALEXIT
 
#define KLFERR_DVIPS_NOOUTPUT   -9
 no .eps file appeared after running dvips program
 
#define KLFERR_NOEPSFILE   KLFERR_DVIPS_NOOUTPUT
 obsolete, same as KLFERR_DVIPS_NOOUTPUT
 
#define KLFERR_DVIPS_OUTPUTREADFAIL   -10
 Error while opening .eps file for reading.
 
#define KLFERR_EPSREADFAIL   KLFERR_DVIPS_OUTPUTREADFAIL
 obsolete, same as KLFERR_DVIPS_OUTPUTREADFAIL
 
#define KLFERR_DVIPS_OUTPUTNOBBOX   -11
 Error while reading/parsing %BoundingBox: in dvips output.
 
#define KLFERR_NOEPSBBOX   KLFERR_DVIPS_OUTPUTNOBBOX
 obsolete, same as KLFERR_DVIPS_OUTPUTNOBBOX
 
#define KLFERR_GSBBOX_NORUN   -25
 Program 'gs' cannot be executed to calculate bounding box.
 
#define KLFERR_GSBBOX_NONORMALEXIT   -26
 Program 'gs' crashed while calculating bbox (see also KLFERR_PROGERR_GSBBOX)
 
#define KLFERR_GSBBOX_NOOUTPUT   -27
 Program 'gs' didn't provide any output.
 
#define KLFERR_GSBBOX_NOBBOX   -28
 Program 'gs' calculating bbox didn't provide parsable output.
 
#define KLFERR_GSPOSTPROC_NORUN   -29
 Program 'gs' cannot be executed to post-process EPS file (page size, outline fonts)
 
#define KLFERR_GSPOSTPROC_NONORMALEXIT   -30
 Program 'gs' crashed while post-processing EPS file (see also KLFERR_PROGERR_GSPOSTPROC)
 
#define KLFERR_GSPOSTPROC_NOOUTPUT   -22
 Program 'gs' didn't provide any data after post-processing EPS file.
 
#define KLFERR_GSPOSTPROC_NOOUTLINEFONTS   -49
 'gs' cannot outline fonts: need version <= 9.07 (pswrite -dNOCACHE) or >= 9.15 (ps2write -dNoOutputFonts)
 
#define KLFERR_NOEPSFILE_OF   KLFERR_GSPOSTPROC_NOOUTPUT
 obsolete, same as KLFERR_GSPOSTPROC_NOOUTPUT
 
#define KLFERR_GSPOSTPROC_OUTPUTREADFAIL   -23
 Couldn't read output provided by 'gs' program after post-processing EPS file.
 
#define KLFERR_EPSREADFAIL_OF   KLFERR_GSPOSTPROC_OUTPUTREADFAIL
 obsolete, same as KLFERR_GSPOSTPROC_OUTPUTREADFAIL
 
#define KLFERR_GSPNG_NORUN   -14
 Program 'gs' couldn't be executed to generate PNG.
 
#define KLFERR_NOGSPROG   KLFERR_GSPNG_NORUN
 obsolete, same as KLFERR_GSPNG_NORUN
 
#define KLFERR_GSPNG_NONORMALEXIT   -15
 Program 'gs' didn't exit noramally (crashed) while generating PNG (see also KLFERR_PROGERR_GSPNG)
 
#define KLFERR_GSNONORMALEXIT   KLFERR_GSPNG_NONORMALEXIT
 obsolete, same as KLFERR_GSPNG_NONORMALEXIT
 
#define KLFERR_GSPNG_NOOUTPUT   -16
 No PNG file appeared after running 'gs'.
 
#define KLFERR_NOPNGFILE   KLFERR_GSPNG_NOOUTPUT
 obsolete, same as KLFERR_GSPNG_NOOUTPUT
 
#define KLFERR_GSPNG_OUTPUTREADFAIL   -17
 Failed to read PNG file produced by 'gs'.
 
#define KLFERR_PNGREADFAIL   KLFERR_GSPNG_OUTPUTREADFAIL
 obsolete, same as KLFERR_GSPNG_OUTPUTREADFAIL
 
#define KLFERR_PDFMARKSWRITEFAIL   -47
 Error while opening pdfmarks file for writing.
 
#define KLFERR_GSPDF_NORUN   -31
 Program 'gs' couldn't be executed to generate PDF.
 
#define KLFERR_GSPDF_NONORMALEXIT   -19
 Program 'gs' didn't exit noramally (crashed) while generating PDF (see also KLFERR_PROGERR_GSPDF)
 
#define KLFERR_EPSTOPDFNONORMALEXIT   KLFERR_GSPDF_NONORMALEXIT
 obsolete, same as KLFERR_GSPDF_NONORMALEXIT
 
#define KLFERR_GSPDF_NOOUTPUT   -20
 No PDF file appeared after running 'gs'.
 
#define KLFERR_NOPDFFILE   KLFERR_GSPDF_NOOUTPUT
 obsolete, same as KLFERR_GSPDF_NOOUTPUT
 
#define KLFERR_GSPDF_OUTPUTREADFAIL   -21
 Failed to read PDF file produced by 'gs'.
 
#define KLFERR_PDFREADFAIL   KLFERR_GSPDF_OUTPUTREADFAIL
 obsolete, same as KLFERR_GSPDF_OUTPUTREADFAIL
 
#define KLFERR_NOGSVERSION   -32
 Failed to query gs version.
 
#define KLFERR_GSSVG_NOSVG   -33
 This version of gs cannot produce SVG.
 
#define KLFERR_GSSVG_NORUN   -34
 Program 'gs' couldn't be executed to generate SVG.
 
#define KLFERR_GSSVG_NONORMALEXIT   -35
 Program 'gs' didn't exit noramally (crashed) while generating SVG (see also KLFERR_PROGERR_GSSVG)
 
#define KLFERR_GSSVG_NOOUTPUT   -36
 No SVG file appeared after running 'gs'.
 
#define KLFERR_GSSVG_OUTPUTREADFAIL   -37
 Failed to read SVG file produced by 'gs'.
 
#define KLFERR_USERSCRIPT_NORUN   -38
 Failed to execute user wrapper script.
 
#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
 
#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_GSBBOX   6
 gs exited with non-zero status while calculating bbox of EPS file generated by dvips
 
#define KLFERR_PROGERR_GSPOSTPROC   5
 gs exited with non-zero status while post-processing EPS file (page size, font outlines)
 
#define KLFERR_PROGERR_GS_OF   KLFERR_PROGERR_GSPOSTPROC
 obsolete, same as KLFERR_PROGERR_GSPOSTPROC
 
#define KLFERR_PROGERR_GSPNG   3
 gs exited with a non-zero status while producing PNG
 
#define KLFERR_PROGERR_GS   KLFERR_PROGERR_GSPNG
 obsolete, same as KLFERR_PROGERR_GSPNG
 
#define KLFERR_PROGERR_GSPDF   4
 gs exited with non-zero status while producing PDF
 
#define KLFERR_PROGERR_EPSTOPDF   KLFERR_PROGERR_GSPDF
 obsolete, same as KLFERR_PROGERR_GSPDF
 
#define KLFERR_PROGERR_GSSVG   7
 gs exited with non-zero status while producing SVG
 
#define KLFERR_PROGERR_USERSCRIPT   8
 user wrapper script exited with non-zero status
 

Functions

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)
 detects any additional settings to environment variables
 
KLF_EXPORT QStringList klfSettingsToEnvironmentForUserScript (const KLFBackend::klfSettings &settings)
 
KLF_EXPORT QStringList klfInputToEnvironmentForUserScript (const KLFBackend::klfInput &in)
 

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.

Macro Definition Documentation

◆ KLFERR_DVIPS_NONORMALEXIT

#define KLFERR_DVIPS_NONORMALEXIT   -8

dvips program did not exit properly (program killed) (see also KLFERR_PROGERR_DVIPS)

Definition at line 77 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_DVIPS_NOOUTPUT

#define KLFERR_DVIPS_NOOUTPUT   -9

no .eps file appeared after running dvips program

Definition at line 81 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_DVIPS_NORUN

#define KLFERR_DVIPS_NORUN   -7

Error while launching the given dvips program.

Definition at line 73 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_DVIPS_OUTPUTNOBBOX

#define KLFERR_DVIPS_OUTPUTNOBBOX   -11

Error while reading/parsing %BoundingBox: in dvips output.

Definition at line 89 of file klfbackend.h.

◆ KLFERR_DVIPS_OUTPUTREADFAIL

#define KLFERR_DVIPS_OUTPUTREADFAIL   -10

Error while opening .eps file for reading.

Definition at line 85 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_DVIPSNONORMALEXIT

#define KLFERR_DVIPSNONORMALEXIT   KLFERR_DVIPS_NONORMALEXIT

obsolete, same as KLFERR_DVIPS_NONORMALEXIT

Definition at line 79 of file klfbackend.h.

◆ KLFERR_DVIREADFAIL

#define KLFERR_DVIREADFAIL   KLFERR_LATEX_OUTPUTREADFAIL

obsolete, same as KLFERR_LATEX_OUTPUTREADFAIL

Definition at line 71 of file klfbackend.h.

◆ KLFERR_EPSREADFAIL

#define KLFERR_EPSREADFAIL   KLFERR_DVIPS_OUTPUTREADFAIL

obsolete, same as KLFERR_DVIPS_OUTPUTREADFAIL

Definition at line 87 of file klfbackend.h.

◆ KLFERR_EPSREADFAIL_OF

#define KLFERR_EPSREADFAIL_OF   KLFERR_GSPOSTPROC_OUTPUTREADFAIL

obsolete, same as KLFERR_GSPOSTPROC_OUTPUTREADFAIL

Definition at line 113 of file klfbackend.h.

◆ KLFERR_EPSTOPDFNONORMALEXIT

#define KLFERR_EPSTOPDFNONORMALEXIT   KLFERR_GSPDF_NONORMALEXIT

obsolete, same as KLFERR_GSPDF_NONORMALEXIT

Definition at line 137 of file klfbackend.h.

◆ KLFERR_GSBBOX_NOBBOX

#define KLFERR_GSBBOX_NOBBOX   -28

Program 'gs' calculating bbox didn't provide parsable output.

Definition at line 99 of file klfbackend.h.

◆ KLFERR_GSBBOX_NONORMALEXIT

#define KLFERR_GSBBOX_NONORMALEXIT   -26

Program 'gs' crashed while calculating bbox (see also KLFERR_PROGERR_GSBBOX)

Definition at line 95 of file klfbackend.h.

◆ KLFERR_GSBBOX_NOOUTPUT

#define KLFERR_GSBBOX_NOOUTPUT   -27

Program 'gs' didn't provide any output.

Definition at line 97 of file klfbackend.h.

◆ KLFERR_GSBBOX_NORUN

#define KLFERR_GSBBOX_NORUN   -25

Program 'gs' cannot be executed to calculate bounding box.

Definition at line 93 of file klfbackend.h.

◆ KLFERR_GSNONORMALEXIT

#define KLFERR_GSNONORMALEXIT   KLFERR_GSPNG_NONORMALEXIT

obsolete, same as KLFERR_GSPNG_NONORMALEXIT

Definition at line 121 of file klfbackend.h.

◆ KLFERR_GSPDF_NONORMALEXIT

#define KLFERR_GSPDF_NONORMALEXIT   -19

Program 'gs' didn't exit noramally (crashed) while generating PDF (see also KLFERR_PROGERR_GSPDF)

Definition at line 135 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSPDF_NOOUTPUT

#define KLFERR_GSPDF_NOOUTPUT   -20

No PDF file appeared after running 'gs'.

Definition at line 139 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSPDF_NORUN

#define KLFERR_GSPDF_NORUN   -31

Program 'gs' couldn't be executed to generate PDF.

Definition at line 133 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSPDF_OUTPUTREADFAIL

#define KLFERR_GSPDF_OUTPUTREADFAIL   -21

Failed to read PDF file produced by 'gs'.

Definition at line 143 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSPNG_NONORMALEXIT

#define KLFERR_GSPNG_NONORMALEXIT   -15

Program 'gs' didn't exit noramally (crashed) while generating PNG (see also KLFERR_PROGERR_GSPNG)

Definition at line 119 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSPNG_NOOUTPUT

#define KLFERR_GSPNG_NOOUTPUT   -16

No PNG file appeared after running 'gs'.

Definition at line 123 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSPNG_NORUN

#define KLFERR_GSPNG_NORUN   -14

Program 'gs' couldn't be executed to generate PNG.

Definition at line 115 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSPNG_OUTPUTREADFAIL

#define KLFERR_GSPNG_OUTPUTREADFAIL   -17

Failed to read PNG file produced by 'gs'.

Definition at line 127 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSPOSTPROC_NONORMALEXIT

#define KLFERR_GSPOSTPROC_NONORMALEXIT   -30

Program 'gs' crashed while post-processing EPS file (see also KLFERR_PROGERR_GSPOSTPROC)

Definition at line 103 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSPOSTPROC_NOOUTLINEFONTS

#define KLFERR_GSPOSTPROC_NOOUTLINEFONTS   -49

'gs' cannot outline fonts: need version <= 9.07 (pswrite -dNOCACHE) or >= 9.15 (ps2write -dNoOutputFonts)

Definition at line 107 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSPOSTPROC_NOOUTPUT

#define KLFERR_GSPOSTPROC_NOOUTPUT   -22

Program 'gs' didn't provide any data after post-processing EPS file.

Definition at line 105 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSPOSTPROC_NORUN

#define KLFERR_GSPOSTPROC_NORUN   -29

Program 'gs' cannot be executed to post-process EPS file (page size, outline fonts)

Definition at line 101 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSPOSTPROC_OUTPUTREADFAIL

#define KLFERR_GSPOSTPROC_OUTPUTREADFAIL   -23

Couldn't read output provided by 'gs' program after post-processing EPS file.

Definition at line 111 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSSVG_NONORMALEXIT

#define KLFERR_GSSVG_NONORMALEXIT   -35

Program 'gs' didn't exit noramally (crashed) while generating SVG (see also KLFERR_PROGERR_GSSVG)

Definition at line 153 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSSVG_NOOUTPUT

#define KLFERR_GSSVG_NOOUTPUT   -36

No SVG file appeared after running 'gs'.

Definition at line 155 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSSVG_NORUN

#define KLFERR_GSSVG_NORUN   -34

Program 'gs' couldn't be executed to generate SVG.

Definition at line 151 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSSVG_NOSVG

#define KLFERR_GSSVG_NOSVG   -33

This version of gs cannot produce SVG.

Definition at line 149 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_GSSVG_OUTPUTREADFAIL

#define KLFERR_GSSVG_OUTPUTREADFAIL   -37

Failed to read SVG file produced by 'gs'.

Definition at line 157 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_LATEX_NONORMALEXIT

#define KLFERR_LATEX_NONORMALEXIT   -5

latex program did not exit properly (program killed) (see also KLFERR_PROGERR_LATEX)

Definition at line 61 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_LATEX_NOOUTPUT

#define KLFERR_LATEX_NOOUTPUT   -6

No .dvi file appeared after runnig latex program.

Definition at line 65 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_LATEX_NORUN

#define KLFERR_LATEX_NORUN   -4

Error while launching the given latex program.

Definition at line 57 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_LATEX_OUTPUTREADFAIL

#define KLFERR_LATEX_OUTPUTREADFAIL   -24

Error while opening .dvi file for reading.

Definition at line 69 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_LATEXNONORMALEXIT

#define KLFERR_LATEXNONORMALEXIT   KLFERR_LATEX_NONORMALEXIT

obsolete, same as KLFERR_LATEX_NONORMALEXIT

Definition at line 63 of file klfbackend.h.

◆ KLFERR_MISSINGLATEXFORMULA

#define KLFERR_MISSINGLATEXFORMULA   -1

No LaTeX formula is specified (empty string)

Definition at line 51 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_MISSINGMATHMODETHREEDOTS

#define KLFERR_MISSINGMATHMODETHREEDOTS   -2

The "..." is missing in math mode string.

Definition at line 53 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_NODVIFILE

#define KLFERR_NODVIFILE   KLFERR_LATEX_NOOUTPUT

obsolete, same as KLFERR_LATEX_NOOUTPUT

Definition at line 67 of file klfbackend.h.

◆ KLFERR_NODVIPSPROG

#define KLFERR_NODVIPSPROG   KLFERR_DVIPS_NORUN

obsolete, same as KLFERR_DVIPS_NORUN

Definition at line 75 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_NOEPSBBOX

#define KLFERR_NOEPSBBOX   KLFERR_DVIPS_OUTPUTNOBBOX

obsolete, same as KLFERR_DVIPS_OUTPUTNOBBOX

Definition at line 91 of file klfbackend.h.

◆ KLFERR_NOEPSFILE

#define KLFERR_NOEPSFILE   KLFERR_DVIPS_NOOUTPUT

obsolete, same as KLFERR_DVIPS_NOOUTPUT

Definition at line 83 of file klfbackend.h.

◆ KLFERR_NOEPSFILE_OF

#define KLFERR_NOEPSFILE_OF   KLFERR_GSPOSTPROC_NOOUTPUT

obsolete, same as KLFERR_GSPOSTPROC_NOOUTPUT

Definition at line 109 of file klfbackend.h.

◆ KLFERR_NOERROR

#define KLFERR_NOERROR   0

No Error.

Definition at line 46 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula(), and KLFUserScriptInfo::KLFUserScriptInfo().

◆ KLFERR_NOGSPROG

#define KLFERR_NOGSPROG   KLFERR_GSPNG_NORUN

obsolete, same as KLFERR_GSPNG_NORUN

Definition at line 117 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_NOGSVERSION

#define KLFERR_NOGSVERSION   -32

Failed to query gs version.

Definition at line 147 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_NOLATEXPROG

#define KLFERR_NOLATEXPROG   KLFERR_LATEX_NORUN

obsolete, same as KLFERR_LATEX_NORUN

Definition at line 59 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_NOPDFFILE

#define KLFERR_NOPDFFILE   KLFERR_GSPDF_NOOUTPUT

obsolete, same as KLFERR_GSPDF_NOOUTPUT

Definition at line 141 of file klfbackend.h.

◆ KLFERR_NOPNGFILE

#define KLFERR_NOPNGFILE   KLFERR_GSPNG_NOOUTPUT

obsolete, same as KLFERR_GSPNG_NOOUTPUT

Definition at line 125 of file klfbackend.h.

◆ KLFERR_PDFMARKSWRITEFAIL

#define KLFERR_PDFMARKSWRITEFAIL   -47

Error while opening pdfmarks file for writing.

Definition at line 131 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_PDFREADFAIL

#define KLFERR_PDFREADFAIL   KLFERR_GSPDF_OUTPUTREADFAIL

obsolete, same as KLFERR_GSPDF_OUTPUTREADFAIL

Definition at line 145 of file klfbackend.h.

◆ KLFERR_PNGREADFAIL

#define KLFERR_PNGREADFAIL   KLFERR_GSPNG_OUTPUTREADFAIL

obsolete, same as KLFERR_GSPNG_OUTPUTREADFAIL

Definition at line 129 of file klfbackend.h.

◆ KLFERR_PROGERR_DVIPS

#define KLFERR_PROGERR_DVIPS   2

dvips exited with a non-zero status

Definition at line 175 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_PROGERR_EPSTOPDF

#define KLFERR_PROGERR_EPSTOPDF   KLFERR_PROGERR_GSPDF

obsolete, same as KLFERR_PROGERR_GSPDF

Definition at line 189 of file klfbackend.h.

◆ KLFERR_PROGERR_GS

#define KLFERR_PROGERR_GS   KLFERR_PROGERR_GSPNG

obsolete, same as KLFERR_PROGERR_GSPNG

Definition at line 185 of file klfbackend.h.

◆ KLFERR_PROGERR_GS_OF

#define KLFERR_PROGERR_GS_OF   KLFERR_PROGERR_GSPOSTPROC

obsolete, same as KLFERR_PROGERR_GSPOSTPROC

Definition at line 181 of file klfbackend.h.

◆ KLFERR_PROGERR_GSBBOX

#define KLFERR_PROGERR_GSBBOX   6

gs exited with non-zero status while calculating bbox of EPS file generated by dvips

Definition at line 177 of file klfbackend.h.

◆ KLFERR_PROGERR_GSPDF

#define KLFERR_PROGERR_GSPDF   4

gs exited with non-zero status while producing PDF

Definition at line 187 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_PROGERR_GSPNG

#define KLFERR_PROGERR_GSPNG   3

gs exited with a non-zero status while producing PNG

Definition at line 183 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_PROGERR_GSPOSTPROC

#define KLFERR_PROGERR_GSPOSTPROC   5

gs exited with non-zero status while post-processing EPS file (page size, font outlines)

Definition at line 179 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_PROGERR_GSSVG

#define KLFERR_PROGERR_GSSVG   7

gs exited with non-zero status while producing SVG

Definition at line 191 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_PROGERR_LATEX

#define KLFERR_PROGERR_LATEX   1

latex exited with a non-zero status

Definition at line 173 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_PROGERR_USERSCRIPT

#define KLFERR_PROGERR_USERSCRIPT   8

user wrapper script exited with non-zero status

Definition at line 193 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_TEMPDIR_FAIL

#define KLFERR_TEMPDIR_FAIL   -48

Failed to create the temporary directory.

Definition at line 49 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_TEXWRITEFAIL

#define KLFERR_TEXWRITEFAIL   -3

Error while opening .tex file for writing.

Definition at line 55 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_USERSCRIPT_BADCATEGORY

#define KLFERR_USERSCRIPT_BADCATEGORY   -46

Definition at line 167 of file klfbackend.h.

◆ KLFERR_USERSCRIPT_BADKLFVERSION

#define KLFERR_USERSCRIPT_BADKLFVERSION   -44

Definition at line 165 of file klfbackend.h.

◆ KLFERR_USERSCRIPT_BADSKIPFORMATS

#define KLFERR_USERSCRIPT_BADSKIPFORMATS   -45

Definition at line 166 of file klfbackend.h.

◆ KLFERR_USERSCRIPT_INVALIDSCRIPTINFO

#define KLFERR_USERSCRIPT_INVALIDSCRIPTINFO   -41

Definition at line 162 of file klfbackend.h.

◆ KLFERR_USERSCRIPT_NONORMALEXIT

#define KLFERR_USERSCRIPT_NONORMALEXIT   -39

Definition at line 160 of file klfbackend.h.

◆ KLFERR_USERSCRIPT_NOOUTPUT

#define KLFERR_USERSCRIPT_NOOUTPUT   -42

Definition at line 163 of file klfbackend.h.

◆ KLFERR_USERSCRIPT_NORUN

#define KLFERR_USERSCRIPT_NORUN   -38

Failed to execute user wrapper script.

Definition at line 159 of file klfbackend.h.

Referenced by KLFBackend::getLatexFormula().

◆ KLFERR_USERSCRIPT_NOSCRIPTINFO

#define KLFERR_USERSCRIPT_NOSCRIPTINFO   -40

Definition at line 161 of file klfbackend.h.

◆ KLFERR_USERSCRIPT_OUTPUTREADFAIL

#define KLFERR_USERSCRIPT_OUTPUTREADFAIL   -43

Definition at line 164 of file klfbackend.h.

Function Documentation

◆ klf_detect_execenv()

KLF_EXPORT bool klf_detect_execenv ( KLFBackend::klfSettings * settings)

detects any additional settings to environment variables

Deprecated
Please use KLFBackend::detectOptionSettings instead (starting from KLF 3.3).

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 1870 of file klfbackend.cpp.

References KLFBackend::klfSettings::execenv, KLFBackend::klfSettings::gsexec, KLF_DEBUG_TIME_BLOCK, KLF_EXPORT, KLF_PATH_SEP, klfDbg, klfSetEnvironmentVariable(), and QDir::toNativeSeparators().

Referenced by KLFBackend::detectOptionSettings().

◆ klfInputToEnvironmentForUserScript()

KLF_EXPORT QStringList klfInputToEnvironmentForUserScript ( const KLFBackend::klfInput & in)

Definition at line 2013 of file klfbackend.cpp.

◆ klfSettingsToEnvironmentForUserScript()

KLF_EXPORT QStringList klfSettingsToEnvironmentForUserScript ( const KLFBackend::klfSettings & settings)

Definition at line 2000 of file klfbackend.cpp.

◆ operator==() [1/2]

Compare two inputs for equality

Definition at line 1608 of file klfbackend.cpp.

References KLF_EXPORT.

◆ operator==() [2/2]

Definition at line 1622 of file klfbackend.cpp.


Generated by doxygen 1.10.0