lyx_mirror/src/LyX.h

172 lines
3.8 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \file LyX.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bj<EFBFBD>nnes
* \author Jean-Marc Lasgouttes
* \author John Levon
*
* Full author contact details are available in file CREDITS.
*/
#ifndef LYX_H
#define LYX_H
#include "support/strfwd.h"
namespace lyx {
class BufferList;
class CmdDef;
class Converters;
class ErrorItem;
class KeyMap;
class LyXFunc;
class Messages;
class Mover;
class Movers;
class Server;
class ServerSocket;
class Session;
extern bool use_gui;
namespace frontend {
class Application;
class LyXView;
}
/// initial startup
class LyX {
public:
LyX();
~LyX();
/// Execute LyX.
int exec(int & argc, char * argv[]);
/// Try to exit LyX properly.
/// \p exit_code is 0 by default, if a non zero value is passed,
/// emergencyCleanup() will be called before exiting.
void exit(int exit_code = 0) const;
static LyX & ref();
static LyX const & cref();
/// in the case of failure
void emergencyCleanup() const;
///
BufferList & bufferList();
BufferList const & bufferList() const;
///
Session & session();
Session const & session() const;
///
LyXFunc & lyxFunc();
LyXFunc const & lyxFunc() const;
///
Server & server();
Server const & server() const;
///
ServerSocket & socket();
ServerSocket const & socket() const;
///
frontend::Application & application();
frontend::Application const & application() const;
///
CmdDef & topLevelCmdDef();
///
Converters & converters();
Converters & systemConverters();
///
Messages & getMessages(std::string const & language);
///
Messages & getGuiMessages();
///
void setGuiLanguage(std::string const & language);
///
frontend::LyXView * newLyXView();
/// Execute batch commands if available.
void execBatchCommands();
///
void addFileToLoad(std::string const &);
private:
/// noncopyable
LyX(LyX const &);
void operator=(LyX const &);
/// Do some cleanup in preparation of an exit.
void prepareExit();
/// Early exit during the initialisation process.
void earlyExit(int status);
/// Initialise LyX and fills-in the vector of files to be loaded.
/**
\return exit code failure if any.
*/
int init(int & argc, char * argv[]);
/// Load files passed at command-line.
/**
This method is used only in non-GUI mode.
*/
void loadFiles();
/// initial LyX set up
bool init();
/** Check for the existence of the user's support directory and,
* if not present, create it. Exits the program if the directory
* cannot be created.
* \returns true if the user-side configuration script
* (lib/configure) should be re-run in this directory.
*/
bool queryUserLyXDir(bool explicit_userdir);
/// read lyxrc/preferences
bool readRcFile(std::string const & name);
/// read the given ui (menu/toolbar) file
bool readUIFile(std::string const & name, bool include = false);
/// read the given languages file
bool readLanguagesFile(std::string const & name);
2007-01-28 21:27:45 +00:00
/// read the encodings.
/// \param enc_name encodings definition file
/// \param symbols_name unicode->LaTeX mapping file
bool readEncodingsFile(std::string const & enc_name,
std::string const & symbols_name);
/// parsing of non-gui LyX options.
void easyParse(int & argc, char * argv[]);
/// shows up a parsing error on screen
void printError(ErrorItem const &);
/// Use the Pimpl idiom to hide the internals.
// Mostly used for singletons.
struct Impl;
Impl * pimpl_;
/// has this user started lyx for the first time?
bool first_start;
friend Movers & theMovers();
friend Mover const & getMover(std::string const & fmt);
friend void setMover(std::string const & fmt, std::string const & command);
friend Movers & theSystemMovers();
friend frontend::Application * theApp();
friend KeyMap & theTopLevelKeymap();
};
} // namespace lyx
#endif // LYX_H