4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
11 * Full author contact details are available in file CREDITS.
17 #include <boost/scoped_ptr.hpp>
18 #include <boost/utility.hpp>
45 namespace frontend { class Application; }
48 class LyX : boost::noncopyable {
55 int exec(int & argc, char * argv[]);
58 static LyX const & cref();
60 /// in the case of failure
61 void emergencyCleanup() const;
64 BufferList & bufferList();
65 BufferList const & bufferList() const;
68 Session const & session() const;
71 LyXFunc const & lyxFunc() const;
74 Server const & server() const;
76 ServerSocket & socket();
77 ServerSocket const & socket() const;
80 frontend::Application & application();
81 frontend::Application const & application() const;
84 KeyMap & topLevelKeymap();
85 KeyMap const & topLevelKeymap() const;
88 Converters & converters();
89 Converters & systemConverters();
92 Messages & getMessages(std::string const & language);
94 Messages & getGuiMessages();
96 void setGuiLanguage(std::string const & language);
99 LyXView * newLyXView();
101 /** redraw \c inset in all the BufferViews in which it is currently
102 * visible. If successful return a pointer to the owning Buffer.
104 Buffer const * const updateInset(Inset const *) const;
106 void hideDialogs(std::string const & name, Inset * inset) const;
108 /// Execute batch commands if available.
109 void execBatchCommands();
112 void addFileToLoad(support::FileName const &);
115 /// Do some cleanup in preparation of an exit.
118 /// Early exit during the initialisation process.
119 void earlyExit(int status);
121 /// Initialise LyX and fills-in the vector of files to be loaded.
123 \return exit code failure if any.
125 int init(int & argc, char * argv[]);
127 /// Load files passed at command-line.
129 This method is used only in non-GUI mode.
133 /// Create a View, load files and restore GUI Session.
134 void restoreGuiSession();
136 /// Initialize RC font for the GUI.
139 /// initial LyX set up
141 /// set up the default key bindings
142 void defaultKeyBindings(KeyMap * kbmap);
143 /// set up the default dead key bindings if requested
144 void deadKeyBindings(KeyMap * kbmap);
145 /** Check for the existence of the user's support directory and,
146 * if not present, create it. Exits the program if the directory
148 * \returns true if the user-side configuration script
149 * (lib/configure) should be re-run in this directory.
151 bool queryUserLyXDir(bool explicit_userdir);
152 /// read lyxrc/preferences
153 bool readRcFile(std::string const & name);
154 /// read the given ui (menu/toolbar) file
155 bool readUIFile(std::string const & name, bool include = false);
156 /// read the given languages file
157 bool readLanguagesFile(std::string const & name);
158 /// read the encodings.
159 /// \param enc_name encodings definition file
160 /// \param symbols_name unicode->LaTeX mapping file
161 bool readEncodingsFile(std::string const & enc_name,
162 std::string const & symbols_name);
163 /// parsing of non-gui LyX options.
164 void easyParse(int & argc, char * argv[]);
165 /// shows up a parsing error on screen
166 void printError(ErrorItem const &);
168 /// has this user started lyx for the first time?
170 /// the parsed command line batch command if any
171 std::string batch_command;
173 /// Use the Pimpl idiom to hide the internals.
175 boost::scoped_ptr<Singletons> pimpl_;
177 friend Movers & theMovers();
178 friend Mover const & getMover(std::string const & fmt);
179 friend void setMover(std::string const & fmt, std::string const & command);
180 friend Movers & theSystemMovers();
181 friend frontend::Application * theApp();