MiKTeX 23.10-next
A scalable TeX distribution
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
MiKTeX::TeXAndFriends::TeXApp Class Reference
Inheritance diagram for MiKTeX::TeXAndFriends::TeXApp:
Inheritance graph
[legend]
Collaboration diagram for MiKTeX::TeXAndFriends::TeXApp:
Collaboration graph
[legend]

Public Types

enum class  Write18Result { QuotationError = -1 , Disallowed = 0 , Executed = 1 , ExecutedAllowed = 2 }
 
- Public Types inherited from MiKTeX::TeXAndFriends::TeXMFApp
typedef std::unordered_map< std::string, int > UserParams
 

Public Member Functions

 TeXApp (const TeXApp &other)=delete
 
TeXApp & operator= (const TeXApp &other)=delete
 
 TeXApp (TeXApp &&other)=delete
 
TeXApp & operator= (TeXApp &&other)=delete
 
IFormatHandler * GetFormatHandler () const
 
MiKTeX::Core::ShellCommandMode GetWrite18Mode () const
 
Write18Result Write18 (const std::string &command, int &exitCode) const
 
bool EncTeXP () const
 
bool IsNewSource (int sourceFileName, int line) const
 
bool IsSourceSpecialOn (SourceSpecial s) const
 
bool MLTeXP () const
 
bool SourceSpecialsP () const
 
bool Write18P () const
 
int GetSynchronizationOptions () const
 
int MakeSrcSpecial (int sourceFileName, int line) const
 
void Finalize () override
 Frees application resources. More...
 
void OnTeXMFStartJob () override
 
void RememberSourceInfo (int sourceFileName, int line) const
 
void SetFormatHandler (IFormatHandler *formatHandler)
 
MiKTeX::Core::FileType GetInputFileType () const override
 
int GetFormatIdent () const override
 
std::string GetMemoryDumpFileExtension () const override
 
MiKTeX::Core::FileType GetMemoryDumpFileType () const override
 
- Public Member Functions inherited from MiKTeX::TeXAndFriends::TeXMFApp
 TeXMFApp (const TeXMFApp &other)=delete
 
TeXMFApp & operator= (const TeXMFApp &other)=delete
 
 TeXMFApp (TeXMFApp &&other)=delete
 
TeXMFApp & operator= (TeXMFApp &&other)=delete
 
IErrorHandler * GetErrorHandler () const
 
IStringHandler * GetStringHandler () const
 
ITeXMFMemoryHandler * GetTeXMFMemoryHandler () const
 
MiKTeX::Util::PathName GetDefaultMemoryDumpFileName () const
 
MiKTeX::Util::PathName GetTcxFileName () const
 
UserParams & GetUserParams () const
 
bool CStyleErrorMessagesP () const
 
bool Enable8BitCharsP () const
 
bool HaltOnErrorP () const
 
void InitializeCharTables () const
 
bool IsFeatureEnabled (Feature f) const
 
bool IsInitProgram () const
 
bool OpenFontFile (C4P::BufferedFile< unsigned char > *file, const std::string &fontName, MiKTeX::Core::FileType filetype, const char *generator)
 
bool OpenMemoryDumpFile (const MiKTeX::Util::PathName &fileName, FILE **file, void *buf, std::size_t size, bool renew)
 
bool ParseFirstLineP () const
 
int GetInteraction () const
 
int GetTeXStringLength (int stringNumber) const
 
int GetTeXStringStart (int stringNumber) const
 
int MakeTeXString (const char *lpsz) const
 
std::string GetTeXString (int stringStart, int stringLength) const
 
void AddOptions () override
 
void EnableFeature (Feature f)
 
void Finalize () override
 Frees application resources. More...
 
void Init (std::vector< char * > &args) override
 
void InitializeBuffer () const
 
void InvokeEditor (int editFileName, int editFileNameLength, int editLineNumber, int transcriptFileName, int transcriptFileNameLength) const
 
void ProcessCommandLineOptions () override
 
void SetErrorHandler (IErrorHandler *errorHandler)
 
void SetStringHandler (IStringHandler *stringHandler)
 
void SetTcxFileName (const MiKTeX::Util::PathName &tcxFileName)
 
void SetTeXMFMemoryHandler (ITeXMFMemoryHandler *memoryHandler)
 
void TouchJobOutputFile (FILE *file) const override
 
virtual int GetJobName (int fallbackJobName) const
 
virtual void OnTeXMFFinishJob ()
 
virtual void OnTeXMFStartJob ()
 
virtual std::string GetMemoryDumpFileExtension () const
 
virtual MiKTeX::Core::FileType GetMemoryDumpFileType () const
 
void SetNameOfFile (const MiKTeX::Util::PathName &fileName) override
 
virtual void OnTeXMFInitialize () const
 
virtual void AllocateMemory ()
 
virtual void FreeMemory ()
 
std::string GetTeXString (int stringNumber) const
 
void InvokeEditor (const MiKTeX::Util::PathName &editFileName, int editLineNumber, const MiKTeX::Util::PathName &transcriptFileName) const
 
int MakeFullNameString ()
 
template<class T >
bool OpenMemoryDumpFile (T &f, bool renew=false)
 
template<typename FILE_ , typename ELETYPE_ >
void Dump (FILE_ &f, const ELETYPE_ &e, std::size_t n)
 
template<typename FILE_ , typename ELETYPE_ >
void Dump (FILE_ &f, const ELETYPE_ &e)
 
template<typename FILE_ , typename ELETYPE_ >
void Undump (FILE_ &f, ELETYPE_ &e, std::size_t n)
 
template<typename FILE_ , typename ELETYPE_ >
void Undump (FILE_ &f, ELETYPE_ &e)
 
template<typename FILE_ , typename ELETYPE_ >
void Undump (FILE_ &f, ELETYPE_ low, ELETYPE_ high, ELETYPE_ &e, std::size_t n)
 
template<typename FILE_ , typename ELETYPE_ >
void Undump (FILE_ &f, ELETYPE_ high, ELETYPE_ &e, std::size_t n)
 
- Public Member Functions inherited from MiKTeX::TeXAndFriends::WebAppInputLine
 WebAppInputLine (const WebAppInputLine &other)=delete
 
WebAppInputLine & operator= (const WebAppInputLine &other)=delete
 
 WebAppInputLine (WebAppInputLine &&other)=delete
 
WebAppInputLine & operator= (WebAppInputLine &&other)=delete
 
ICharacterConverter * GetCharacterConverter () const
 
IInputOutput * GetInputOutput () const
 
MiKTeX::Util::PathName GetAuxDirectory () const
 
MiKTeX::Util::PathName GetFoundFile () const
 
MiKTeX::Util::PathName GetFoundFileFq () const
 
MiKTeX::Util::PathName GetOutputDirectory () const
 
bool AllowFileName (const MiKTeX::Util::PathName &fileName, bool forInput)
 
bool InputLine (C4P::C4P_text &f, C4P::C4P_boolean bypassEndOfLine) const
 
bool OpenInputFile (C4P::FileRoot &f, const MiKTeX::Util::PathName &fileNameInternalEncoding)
 
bool OpenInputFile (FILE **ppFile, const MiKTeX::Util::PathName &fileNameInternalEncoding)
 
bool OpenOutputFile (C4P::FileRoot &f, const MiKTeX::Util::PathName &fileNameInternalEncoding, bool isTextFile_deprecated, MiKTeX::Util::PathName &outPath)
 
void CloseFile (C4P::FileRoot &f)
 
void Finalize () override
 Frees application resources. More...
 
void Init (std::vector< char * > &args) override
 
void SetAuxDirectory (const MiKTeX::Util::PathName &path)
 
void SetCharacterConverter (ICharacterConverter *characterConverter)
 
void SetInputOutput (IInputOutput *inputOutput)
 
void SetOutputDirectory (const MiKTeX::Util::PathName &path)
 
virtual FILE * OpenFileInternal (const MiKTeX::Util::PathName &path, MiKTeX::Core::FileMode mode, MiKTeX::Core::FileAccess access)
 
virtual FILE * TryOpenFileInternal (const MiKTeX::Util::PathName &path, MiKTeX::Core::FileMode mode, MiKTeX::Core::FileAccess access)
 
virtual MiKTeX::Util::PathName DecodeFileName (const MiKTeX::Util::PathName &fileNameInternalEncoding)
 
virtual size_t InputLineInternal (FILE *f, char *buffer, char *buffer2, size_t bufferSize, size_t bufferPosition, int &lastChar) const
 
virtual void CloseFileInternal (FILE *f)
 
virtual int GetFormatIdent () const
 
MiKTeX::Util::PathName GetNameOfFile () const
 
virtual void SetNameOfFile (const MiKTeX::Util::PathName &fileName)
 
- Public Member Functions inherited from MiKTeX::TeXAndFriends::WebApp
 WebApp (const WebApp &other)=delete
 
WebApp & operator= (const WebApp &other)=delete
 
 WebApp (WebApp &&other)=delete
 
WebApp & operator= (WebApp &&other)=delete
 
C4P::ProgramBase * GetProgram () const
 
IInitFinalize * GetInitFinalize () const
 
bool AmI (const std::string &name) const
 
bool GetVerboseFlag () const
 
void IAm (const std::string &name)
 
std::string GetProgramName () const
 
void Finalize () override
 Frees application resources. More...
 
void Init (std::vector< char * > &args) override
 
void SetInitFinalize (IInitFinalize *initFinalize)
 
void SetProgram (C4P::ProgramBase *program, const std::string &programName, const std::string &version, const std::string &copyright, const std::string &trademarks)
 
virtual std::string TheNameOfTheGame () const
 
virtual void ProcessCommandLineOptions ()
 
virtual unsigned long GetHelpId () const
 
virtual MiKTeX::Core::FileType GetInputFileType () const
 
- Public Member Functions inherited from MiKTeX::App::Application
 Application (const Application &other)=delete
 
Application & operator= (const Application &other)=delete
 
 Application (Application &&other)=delete
 
Application & operator= (Application &&other)=delete
 
virtual std::string ExamineArgs (std::vector< const char * > &args, MiKTeX::Core::Session::InitInfo &initInfo)
 
virtual std::string ExamineArgs (std::vector< char * > &args, MiKTeX::Core::Session::InitInfo &initInfo)
 
virtual void Init (const MiKTeX::Core::Session::InitInfo &initInfo, std::vector< const char * > &args)
 
virtual void Init (const MiKTeX::Core::Session::InitInfo &initInfo, std::vector< char * > &args)
 
virtual void Init (const MiKTeX::Core::Session::InitInfo &initInfo)
 
virtual void Init (std::vector< const char * > &args)
 
virtual void Init (std::vector< char * > &args)
 
virtual void Init (const std::string &programInvocationName)
 
virtual void Init (const std::string &programInvocationName, const std::string &theNameOfTheGame)
 
virtual void Finalize ()
 Frees application resources. More...
 
virtual void Finalize2 (int exitCode)
 
virtual void GetLibraryVersions (std::vector< MiKTeX::Core::LibraryVersion > &versions) const
 
virtual void ShowLibraryVersions () const
 Prints version information of loaded libraries. More...
 
bool InstallPackage (const std::string &packageId, const MiKTeX::Util::PathName &trigger, MiKTeX::Util::PathName &installRoot) override
 Install a package. More...
 
bool TryCreateFile (const MiKTeX::Util::PathName &fileName, MiKTeX::Core::FileType fileType) override
 Creates a file. More...
 
void ReportLine (const std::string &message) override
 Prints an installer message. More...
 
bool OnRetryableError (const std::string &message) override
 Handles an installer error. More...
 
bool OnProgress (MiKTeX::Packages::Notification nf) override
 Handles an installer notification. More...
 
bool Trace (const TraceCallback::TraceMessage &traceMessage) override
 Logs a trace message. More...
 
void EnableInstaller (MiKTeX::Configuration::TriState tri)
 
void FatalError (const std::string &message)
 
void Warning (const std::string &message)
 
void SecurityRisk (const std::string &message)
 
void InvokeEditor (const MiKTeX::Util::PathName &editFileName, int editLineNumber, MiKTeX::Core::FileType editFileType, const MiKTeX::Util::PathName &transcriptFileName) const
 
void Sorry (const std::string &name, const MiKTeX::Core::MiKTeXException &ex)
 
void Sorry (const std::string &name, const std::exception &ex)
 
void Sorry (const std::string &name, const std::string &description, const std::string &remedy, const std::string &url)
 
void Sorry (const std::string &name)
 
bool GetQuietFlag () const
 
void SetQuietFlag (bool b)
 
std::shared_ptr< MiKTeX::Core::Session > GetSession () const
 
MiKTeX::Configuration::TriState GetEnableInstaller () const
 
void LogInfo (const std::string &message) const
 
void LogWarn (const std::string &message) const
 
void LogError (const std::string &message) const
 
void CheckCancel ()
 Throws an exception if the application should be terminated. More...
 
virtual bool InstallPackage (const std::string &packageId, const MiKTeX::Util::PathName &trigger, MiKTeX::Util::PathName &installRoot)=0
 
virtual bool TryCreateFile (const MiKTeX::Util::PathName &fileName, FileType fileType)=0
 
virtual void ReportLine (const std::string &str)=0
 
virtual bool OnRetryableError (const std::string &message)=0
 
virtual bool OnProgress (Notification nf)=0
 
- Public Member Functions inherited from MiKTeX::Trace::TraceCallback
virtual bool Trace (const TraceMessage &traceMessage)=0
 

Static Public Member Functions

static TeXApp * GetTeXApp ()
 
- Static Public Member Functions inherited from MiKTeX::TeXAndFriends::TeXMFApp
static static MIKTEXMFCEEAPI(MiKTeX::Core::Argv) ParseFirstLine(const MiKTeX MIKTEXMFCEEAPI (void) OnKeybordInterrupt(int)
 
static TeXMFApp * GetTeXMFApp ()
 
- Static Public Member Functions inherited from MiKTeX::TeXAndFriends::WebAppInputLine
static WebAppInputLine * GetWebAppInputLine ()
 
- Static Public Member Functions inherited from MiKTeX::TeXAndFriends::WebApp
static WebApp * GetWebApp ()
 
- Static Public Member Functions inherited from MiKTeX::App::Application
static Application * GetApplication ()
 

Protected Member Functions

bool ProcessOption (int c, const std::string &optArg) override
 
void AddOptions () override
 
void Init (std::vector< char * > &args) override
 
- Protected Member Functions inherited from MiKTeX::TeXAndFriends::TeXMFApp
void Enable8BitChars (bool enable8BitChars)
 
bool ProcessOption (int opt, const std::string &optArg) override
 
std::string GetUsage () const override
 
virtual MiKTeX::Util::PathName GetMemoryDumpFileName () const
 
virtual std::string GetInitProgramName () const
 
virtual std::string GetVirginProgramName () const
 
void CheckPoolPointer (int poolptr, std::size_t len) const
 
bool IsVirgin () const
 
- Protected Member Functions inherited from MiKTeX::TeXAndFriends::WebAppInputLine
MiKTeX::Core::ShellCommandMode GetShellCommandMode () const
 
MiKTeX::Util::PathName GetLastInputFileName () const
 
bool ProcessOption (int opt, const std::string &optArg) override
 
void AddOptions () override
 
void EnableShellCommands (MiKTeX::Core::ShellCommandMode mode)
 
virtual void TouchJobOutputFile (FILE *) const
 
- Protected Member Functions inherited from MiKTeX::TeXAndFriends::WebApp
std::string Translate (const char *msgId)
 
std::vector< poptOption > GetOptions () const
 
void AddOption (const std::string &aliasName, const std::string &name)
 
void AddOption (const std::string &name, const std::string &help, int opt, int argInfo=POPT_ARG_NONE, const std::string &argDescription="", void *arg=nullptr, char shortName=0)
 
void AddOptionShortcut (const std::string &longName, const std::vector< std::string > &args)
 
void BadUsage ()
 
void ShowHelp (bool usageOnly=false) const
 
void ShowProgramVersion () const
 
virtual bool ProcessOption (int opt, const std::string &optArg)
 
virtual void AddOptions ()
 
void AddOption (const std::string &name, int opt, int argInfo=POPT_ARG_NONE, const std::string &argDescription="", void *arg=nullptr, char shortName=0)
 
virtual std::string GetUsage () const
 

Additional Inherited Members

- Protected Types inherited from MiKTeX::TeXAndFriends::WebApp
enum  { OPT_UNSUPPORTED = INT_MAX - 100 , OPT_NOOP }
 
- Static Protected Member Functions inherited from MiKTeX::App::Application
static bool Cancelled ()
 

Member Function Documentation

◆ AddOptions()

void MiKTeX::TeXAndFriends::TeXApp::AddOptions ( )
overrideprotectedvirtual

Reimplemented from MiKTeX::TeXAndFriends::WebApp.

◆ Finalize()

void MiKTeX::TeXAndFriends::TeXApp::Finalize ( )
overridevirtual

Frees application resources.

Reimplemented from MiKTeX::App::Application.

◆ GetFormatIdent()

int MiKTeX::TeXAndFriends::TeXApp::GetFormatIdent ( ) const
inlineoverridevirtual

Reimplemented from MiKTeX::TeXAndFriends::WebAppInputLine.

◆ GetInputFileType()

MiKTeX::Core::FileType MiKTeX::TeXAndFriends::TeXApp::GetInputFileType ( ) const
inlineoverridevirtual

Reimplemented from MiKTeX::TeXAndFriends::WebApp.

◆ GetMemoryDumpFileExtension()

std::string MiKTeX::TeXAndFriends::TeXApp::GetMemoryDumpFileExtension ( ) const
inlineoverridevirtual

Reimplemented from MiKTeX::TeXAndFriends::TeXMFApp.

◆ GetMemoryDumpFileType()

MiKTeX::Core::FileType MiKTeX::TeXAndFriends::TeXApp::GetMemoryDumpFileType ( ) const
inlineoverridevirtual

Reimplemented from MiKTeX::TeXAndFriends::TeXMFApp.

◆ Init()

void MiKTeX::TeXAndFriends::TeXApp::Init ( std::vector< char * > &  args)
overrideprotectedvirtual

Initializes the application.

Parameters
[in,out]argsThe command-line arguments to examine and modify.

Reimplemented from MiKTeX::App::Application.

◆ OnTeXMFStartJob()

void MiKTeX::TeXAndFriends::TeXApp::OnTeXMFStartJob ( )
overridevirtual

Reimplemented from MiKTeX::TeXAndFriends::TeXMFApp.

◆ ProcessOption()

bool MiKTeX::TeXAndFriends::TeXApp::ProcessOption ( int  c,
const std::string &  optArg 
)
overrideprotectedvirtual

Reimplemented from MiKTeX::TeXAndFriends::WebApp.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.5