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
9 * Full author contact details are available in file CREDITS.
15 #include "InsetList.h"
17 #include "dociterator.h"
18 #include "ParagraphList_fwd.h"
20 #include "support/limited_stack.h"
21 #include "support/types.h"
23 #include <boost/scoped_ptr.hpp>
24 #include <boost/signal.hpp>
46 class ParConstIterator;
51 class StableDocIterator;
54 /** The buffer object.
55 * This is the buffer object. It contains all the informations about
56 * a document loaded into LyX.
57 * The buffer object owns the LyXText (wrapped in an InsetText), which
58 * contains the individual paragraphs of the document.
61 * I am not sure if the class is complete or
62 * minimal, probably not.
63 * \author Lars Gullik Bjønnes
67 /// What type of log will \c getLogName() return?
69 latexlog, ///< LaTeX log
70 buildlog ///< Literate build log
75 \param b optional \c false by default
77 explicit Buffer(std::string const & file, bool b = false);
82 /** High-level interface to buffer functionality.
83 This function parses a command string and executes it
85 bool dispatch(std::string const & command, bool * result = 0);
87 /// Maybe we know the function already by number...
88 bool dispatch(FuncRequest const & func, bool * result = 0);
90 /// Load the autosaved file.
91 void loadAutoSaveFile();
94 bool readFile(std::string const & filename);
96 /// read the header, returns number of unknown tokens
97 int readHeader(LyXLex & lex);
99 /** Reads a file without header.
100 \param par if != 0 insert the file.
101 \return \c false if file is not completely read.
103 bool readDocument(LyXLex &);
106 void insertStringAsLines(ParagraphList & plist,
107 lyx::pit_type &, lyx::pos_type &,
108 LyXFont const &, std::string const &, bool);
110 ParIterator getParFromID(int id) const;
111 /// do we have a paragraph with this id?
112 bool hasParWithID(int id) const;
114 /// This signal is emitted when a parsing error shows up.
115 boost::signal<void(ErrorItem)> error;
116 /// This signal is emitted when some message shows up.
117 boost::signal<void(std::string)> message;
118 /// This signal is emitted when the buffer busy status change.
119 boost::signal<void(bool)> busy;
120 /// This signal is emitted when the buffer readonly status change.
121 boost::signal<void(bool)> readonly;
122 /// Update window titles of all users.
123 boost::signal<void()> updateTitles;
124 /// Reset autosave timers for all users.
125 boost::signal<void()> resetAutosaveTimers;
126 /// This signal is emitting if the buffer is being closed.
127 boost::signal<void()> closing;
131 Takes care of auto-save files and backup file if requested.
132 Returns \c true if the save is successful, \c false otherwise.
136 /// Write file. Returns \c false if unsuccesful.
137 bool writeFile(std::string const &) const;
140 void writeFileAscii(std::string const &, OutputParams const &);
142 void writeFileAscii(std::ostream &, OutputParams const &);
143 /// Just a wrapper for the method below, first creating the ofstream.
144 void makeLaTeXFile(std::string const & filename,
145 std::string const & original_path,
146 OutputParams const &,
147 bool output_preamble = true,
148 bool output_body = true);
150 void makeLaTeXFile(std::ostream & os,
151 std::string const & original_path,
152 OutputParams const &,
153 bool output_preamble = true,
154 bool output_body = true);
156 void makeLinuxDocFile(std::string const & filename,
157 OutputParams const & runparams_in,
158 bool only_body = false);
160 void makeDocBookFile(std::string const & filename,
161 OutputParams const & runparams_in,
162 bool only_body = false);
163 /// returns the main language for the buffer (document)
164 Language const * getLanguage() const;
165 /// get l10n translated to the buffers language
166 std::string const B_(std::string const & l10n) const;
170 /// return true if the main lyx file does not need saving
171 bool isClean() const;
173 bool isBakClean() const;
175 bool isDepClean(std::string const & name) const;
177 /// mark the main lyx file as not needing saving
178 void markClean() const;
184 void markDepClean(std::string const & name);
187 void setUnnamed(bool flag = true);
190 bool isUnnamed() const;
192 /// Mark this buffer as dirty.
195 /// Returns the buffer's filename. It is always an absolute path.
196 std::string const & fileName() const;
198 /// Returns the the path where the buffer lives.
199 /// It is always an absolute path.
200 std::string const & filePath() const;
202 /** A transformed version of the file name, adequate for LaTeX.
203 \param no_path optional if \c true then the path is stripped.
205 std::string const getLatexName(bool no_path = true) const;
207 /// Get the name and type of the log.
208 std::pair<LogType, std::string> const getLogName() const;
210 /// Change name of buffer. Updates "read-only" flag.
211 void setFileName(std::string const & newfile);
213 /// Name of the document's parent
214 void setParentName(std::string const &);
216 /** Get the document's master (or \c this if this is not a
219 Buffer const * getMasterBuffer() const;
221 /// Is buffer read-only?
222 bool isReadonly() const;
224 /// Set buffer read-only flag
225 void setReadonly(bool flag = true);
227 /// returns \c true if the buffer contains a LaTeX document
228 bool isLatex() const;
229 /// returns \c true if the buffer contains a LinuxDoc document
230 bool isLinuxDoc() const;
231 /// returns \c true if the buffer contains a DocBook document
232 bool isDocBook() const;
233 /** returns \c true if the buffer contains either a LinuxDoc
234 or DocBook document */
236 /// returns \c true if the buffer contains a Wed document
237 bool isLiterate() const;
239 /** Validate a buffer for LaTeX.
240 This validates the buffer, and returns a struct for use by
241 #makeLaTeX# and others. Its main use is to figure out what
242 commands and packages need to be included in the LaTeX file.
243 It (should) also check that the needed constructs are there
244 (i.e. that the \refs points to coresponding \labels). It
245 should perhaps inset "error" insets to help the user correct
248 void validate(LaTeXFeatures &) const;
250 /// return all bibkeys from buffer and its childs
251 void fillWithBibKeys(std::vector<std::pair<std::string, std::string> > & keys) const;
253 void getLabelList(std::vector<std::string> &) const;
256 void changeLanguage(Language const * from, Language const * to);
259 void updateDocLang(Language const * nlang);
262 bool isMultiLingual() const;
264 /// Does this mean that this is buffer local?
265 limited_stack<Undo> & undostack();
266 limited_stack<Undo> const & undostack() const;
268 /// Does this mean that this is buffer local?
269 limited_stack<Undo> & redostack();
270 limited_stack<Undo> const & redostack() const;
273 BufferParams & params();
274 BufferParams const & params() const;
276 /** The list of paragraphs.
277 This is a linked list of paragraph, this list holds the
278 whole contents of the document.
280 ParagraphList & paragraphs();
281 ParagraphList const & paragraphs() const;
283 /// LyX version control object.
285 LyXVC const & lyxvc() const;
287 /// Where to put temporary files.
288 std::string const & temppath() const;
290 /// Used when typesetting to place errorboxes.
292 TexRow const & texrow() const;
295 ParIterator par_iterator_begin();
297 ParConstIterator par_iterator_begin() const;
299 ParIterator par_iterator_end();
301 ParConstIterator par_iterator_end() const;
303 /** \returns true only when the file is fully loaded.
304 * Used to prevent the premature generation of previews
305 * and by the citation inset.
307 bool fully_loaded() const;
308 /// Set by buffer_funcs' newFile.
309 void fully_loaded(bool);
311 /// Our main text (inside the top InsetText)
312 LyXText & text() const;
314 /// Our top InsetText!
315 InsetBase & inset() const;
323 bool hasMacro(std::string const & name) const;
325 MacroData const & getMacro(std::string const & name) const;
327 void insertMacro(std::string const & name, MacroData const & data);
329 void saveCursor(StableDocIterator cursor, StableDocIterator anchor);
331 StableDocIterator getCursor() const { return cursor_; }
333 StableDocIterator getAnchor() const { return anchor_; }
335 void changeRefsIfUnique(std::string const & from, std::string const & to);
336 /// get source code (latex/docbook/linuxdoc) for some paragraphs
337 void getSourceCode(std::ostream & os, lyx::pit_type par_begin, lyx::pit_type par_end);
340 /** Inserts a file into a document
341 \return \c false if method fails.
343 bool readFile(LyXLex &, std::string const & filename);
345 bool do_writeFile(std::ostream & ofs) const;
347 /// Use the Pimpl idiom to hide the internals.
349 /// The pointer never changes although *pimpl_'s contents may.
350 boost::scoped_ptr<Impl> const pimpl_;
352 /// Save the cursor Position on Buffer switch
353 /// this would not be needed if every Buffer would have
354 /// it's BufferView, this should be FIXED in future.
355 StableDocIterator cursor_;
356 StableDocIterator anchor_;