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 "support/strfwd.h"
54 extern RunMode run_mode;
55 extern OverwriteFiles force_overwrite;
63 friend class LyXConsoleApp;
69 int exec(int & argc, char * argv[]);
74 void operator=(LyX const &);
76 /// Do some cleanup in preparation of an exit.
79 /// Early exit during the initialisation process.
80 void earlyExit(int status);
82 /// Initialise LyX and fills-in the vector of files to be loaded.
84 \return exit code failure if any.
86 int init(int & argc, char * argv[]);
88 /// Execute commandline commands if no GUI was requested.
89 int execWithoutGui(int & argc, char * argv[]);
91 /// Execute batch commands if available.
94 /// initial LyX set up
96 /** Check for the existence of the user's support directory and,
97 * if not present, create it. Exits the program if the directory
99 * \returns true if the user-side configuration script
100 * (lib/configure) should be re-run in this directory.
102 bool queryUserLyXDir(bool explicit_userdir);
103 /// read lyxrc/preferences
104 /// \param check_format: whether to try to convert the format of
105 /// the file, if there is a mismatch.
106 bool readRcFile(std::string const & name, bool check_format = false);
107 /// read the given languages file
108 bool readLanguagesFile(std::string const & name);
109 /// read the encodings.
110 /// \param enc_name encodings definition file
111 /// \param symbols_name unicode->LaTeX mapping file
112 bool readEncodingsFile(std::string const & enc_name,
113 std::string const & symbols_name);
114 /// parsing of non-gui LyX options.
115 void easyParse(int & argc, char * argv[]);
116 /// shows up a parsing error on screen
117 void printError(ErrorItem const &);
120 Messages & messages(std::string const & language);
122 /// Use the Pimpl idiom to hide the internals.
123 // Mostly used for singletons.
127 /// has this user started lyx for the first time?
130 friend FuncStatus getStatus(FuncRequest const & action);
131 friend DispatchResult const & dispatch(FuncRequest const & action);
132 friend void dispatch(FuncRequest const & action, DispatchResult & dr);
133 friend std::vector<std::string> & theFilesToLoad();
134 friend BufferList & theBufferList();
135 friend Server & theServer();
136 friend ServerSocket & theServerSocket();
137 friend Converters & theConverters();
138 friend Converters & theSystemConverters();
139 friend Messages const & getMessages(std::string const & language);
140 friend Messages const & getGuiMessages();
141 friend KeyMap & theTopLevelKeymap();
142 friend Movers & theMovers();
143 friend Mover const & getMover(std::string const & fmt);
144 friend void setMover(std::string const & fmt, std::string const & command);
145 friend Movers & theSystemMovers();
146 friend frontend::Application * theApp();
147 friend Session & theSession();
148 friend LaTeXFonts & theLaTeXFonts();
149 friend CmdDef & theTopLevelCmdDef();
150 friend SpellChecker * theSpellChecker();
151 friend void setSpellChecker();
152 friend void emergencyCleanup();
153 friend void execBatchCommands();
154 friend void lyx_exit(int exit_code);
158 /// in the case of failure
159 void emergencyCleanup();
160 /// Try to exit LyX properly.
161 /// \p exit_code is 0 by default, if a non zero value is passed,
162 /// emergencyCleanup() will be called before exiting.
163 void lyx_exit(int exit_code);
164 /// Execute batch commands if available.
165 void execBatchCommands();
168 FuncStatus getStatus(FuncRequest const & action);
171 DispatchResult const & dispatch(FuncRequest const & action);
174 void dispatch(FuncRequest const & action, DispatchResult & dr);