X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyx_main.h;h=ab1619f97e7372a30b189ec50a4817141ad1ee43;hb=35204f8f33d7400a5fefeffea533fb4cb4097211;hp=2451f400d0485bf9c16a29d963b32b0b86102c72;hpb=eee532a581a7ffc9cc7b33ee675eef75c2f949e5;p=lyx.git diff --git a/src/lyx_main.h b/src/lyx_main.h index 2451f400d0..ab1619f97e 100644 --- a/src/lyx_main.h +++ b/src/lyx_main.h @@ -1,70 +1,170 @@ // -*- C++ -*- /** * \file lyx_main.h - * Copyright 2002 the LyX Team - * Read the file COPYING + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * \author unknown + * \author Lars Gullik Bjønnes + * \author Jean-Marc Lasgouttes + * \author John Levon + * + * Full author contact details are available in file CREDITS. */ #ifndef LYX_MAIN_H #define LYX_MAIN_H -#include "LString.h" -#include "errorlist.h" - #include #include -#include +#include +#include +namespace lyx { -class LyXRC; -class LastFiles; class Buffer; +class BufferList; +class ErrorItem; +class IconvProcessor; +class InsetBase; +class LyXFunc; +class LyXServer; +class LyXServerSocket; +class LyXView; +class Session; class kb_keymap; +extern bool use_gui; -/// e.g. $HOME/.lyx/ -extern string user_lyxdir; -/// last files loaded -extern boost::scoped_ptr lastfiles; - +namespace frontend { class Application; } /// initial startup class LyX : boost::noncopyable { public: - LyX(int & argc, char * argv[]); + + LyX(); + ~LyX(); + + /** + * Execute LyX. The startup sequence is as follows: + * -# LyX::exec() + * -# LyX::priv_exec() + * -# lyx::createApplication() + * Step 3 is omitted if no gui is wanted. We need lyx::createApplication() + * only to create the QApplication object in the qt frontend. All + * attempts with static and dynamically allocated QApplication + * objects lead either to harmless error messages on exit + * ("Mutex destroy failure") or crashes (OS X). + */ + int exec(int & argc, char * argv[]); + + static LyX & ref(); + static LyX const & cref(); /// in the case of failure - static void emergencyCleanup(); + void emergencyCleanup() const; + + /// Ask the LyX class to exit. + /** + In GUI mode, after this function has been called, application_ leaves + the main event loop and returns from the call to Application::start(). + */ + void quit(); + + /// + BufferList & bufferList(); + BufferList const & bufferList() const; + /// + Session & session(); + Session const & session() const; + /// + LyXFunc & lyxFunc(); + LyXFunc const & lyxFunc() const; + /// + LyXServer & server(); + LyXServer const & server() const; + /// + LyXServerSocket & socket(); + LyXServerSocket const & socket() const; + + /// + frontend::Application & application(); + frontend::Application const & application() const; + + /// + kb_keymap & topLevelKeymap(); + kb_keymap const & topLevelKeymap() const; + + /// + IconvProcessor & iconvProcessor(); + + LyXView * newLyXView(); + + /** redraw \c inset in all the BufferViews in which it is currently + * visible. If successful return a pointer to the owning Buffer. + */ + Buffer const * const updateInset(InsetBase const *) const; private: + /// Do some cleanup in preparation of an exit. + void prepareExit(); + + /// Early exit during the initialisation process. + void earlyExit(int status); + + /// Initialise LyX and execute batch commands if available. + /** + \param files is filled in with the command-line file names. + \return exit code failure if any. + */ + int execBatchCommands(int & argc, char * argv[], + std::vector & files); + + /// Create a View and restore GUI Session. + void restoreGuiSession(std::vector const & files); + + /// Initialize RC font for the GUI. + void initGuiFont(); + /// initial LyX set up - void init(bool); + bool init(); /// set up the default key bindings void defaultKeyBindings(kb_keymap * kbmap); /// set up the default dead key bindings if requested void deadKeyBindings(kb_keymap * kbmap); - /// check, set up and configure the user dir if necessary - void queryUserLyXDir(bool explicit_userdir); + /** 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 - void readRcFile(string const & name); + bool readRcFile(std::string const & name); /// read the given ui (menu/toolbar) file - void readUIFile(string const & name); + bool readUIFile(std::string const & name); /// read the given languages file - void readLanguagesFile(string const & name); + bool readLanguagesFile(std::string const & name); /// read the given encodings file - void readEncodingsFile(string const & name); - /// parsing of non-gui LyX options. Returns true if gui - bool easyParse(int & argc, char * argv[]); + bool readEncodingsFile(std::string const & name); + /// parsing of non-gui LyX options. + void easyParse(int & argc, char * argv[]); /// shows up a parsing error on screen void printError(ErrorItem const &); /// has this user started lyx for the first time? bool first_start; /// the parsed command line batch command if any - string batch_command; + std::string batch_command; + + /// Use the Pimpl idiom to hide the internals. + struct Singletons; + boost::scoped_ptr pimpl_; + + /// + bool geometryOption_; }; +} // namespace lyx + #endif // LYX_MAIN_H