// -*- 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 <boost/scoped_ptr.hpp>
#include <boost/utility.hpp>
-#include <csignal>
+#include <string>
+namespace lyx {
-class LyXRC;
-class LastFiles;
class Buffer;
+class BufferList;
+class Converters;
+class ErrorItem;
+class IconvProcessor;
+class InsetBase;
+class LyXFunc;
+class LyXServer;
+class LyXServerSocket;
+class LyXView;
+class Messages;
+class Mover;
+class Movers;
+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> lastfiles;
-
+namespace frontend { class Application; }
/// initial startup
class LyX : boost::noncopyable {
public:
- LyX(int & argc, char * argv[]);
+
+ LyX();
+ ~LyX();
+
+ /// Execute LyX.
+ int exec(int & argc, char * argv[]);
+
+ static LyX & ref();
+ static LyX const & cref();
/// in the case of failure
- static void emergencyCleanup();
+ void emergencyCleanup() const;
+
+ ///
+ 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;
+
+ ///
+ Converters & converters();
+ Converters & systemConverters();
+
+ ///
+ Messages & getMessages(std::string const & language);
+ ///
+ Messages & getGuiMessages();
+ ///
+ void setGuiLanguage(std::string const & language);
+
+ ///
+ 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;
+
+ /// Execute batch commands if available.
+ void execBatchCommands();
private:
+ /// 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();
+
+ /// Create a View, load files and restore GUI Session.
+ void restoreGuiSession();
+
+ /// 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, bool include = false);
/// 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<Singletons> pimpl_;
+
+ 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();
};
+} // namespace lyx
+
#endif // LYX_MAIN_H
projects / lyx.git / blobdiff