2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
8 * This file is Copyleft 1996
11 * ====================================================== */
18 #include "support/limited_stack.h"
21 #include "bufferparams.h"
23 #include "ParagraphList.h"
24 #include "paragraph.h"
26 #include "iterators.h"
28 #include <boost/shared_ptr.hpp>
29 #include <boost/scoped_ptr.hpp>
37 class ParConstIterator;
41 /** The buffer object.
42 This is the buffer object. It contains all the informations about
43 a document loaded into LyX. I am not sure if the class is complete or
44 minimal, probably not.
45 \author Lars Gullik Bjønnes
49 /// What type of log will \c getLogName() return?
51 latexlog, ///< LaTeX log
52 buildlog ///< Literate build log
57 \param b optional \c false by default
59 explicit Buffer(string const & file, bool b = false);
64 /** High-level interface to buffer functionality.
65 This function parses a command string and executes it
67 bool dispatch(string const & command, bool * result = 0);
69 /// Maybe we know the function already by number...
70 bool dispatch(int ac, string const & argument, bool * result = 0);
73 void resizeInsets(BufferView *);
75 /// Update window titles of all users.
76 void updateTitles() const;
78 /// Reset autosave timers for all users.
79 void resetAutosaveTimers() const;
81 /** Adds the BufferView to the users list.
82 Later this func will insert the \c BufferView into a real list,
83 not just setting a pointer.
85 void addUser(BufferView * u);
87 /** Removes the #BufferView# from the users list.
88 Since we only can have one at the moment, we just reset it.
90 void delUser(BufferView *);
95 /// Load the autosaved file.
96 void loadAutoSaveFile();
98 /** Inserts a file into a document
99 \param par if != 0 insert the file.
100 \return \c false if method fails.
102 bool readFile(LyXLex &, string const &, ParagraphList::iterator pit);
104 // FIXME: it's very silly to pass a lex in here
106 bool readFile(LyXLex &, string const &);
108 /// read the header, returns number of unknown tokens
109 int readHeader(LyXLex & lex);
111 /** Reads a file without header.
112 \param par if != 0 insert the file.
113 \return \c false if file is not completely read.
115 bool readBody(LyXLex &, ParagraphList::iterator pit);
117 /// This parses a single token
118 int readParagraph(LyXLex &, string const & token,
119 ParagraphList & pars, ParagraphList::iterator & pit,
120 Paragraph::depth_type & depth);
123 void insertStringAsLines(ParagraphList::iterator &, lyx::pos_type &,
124 LyXFont const &, string const &);
126 ParIterator getParFromID(int id) const;
127 /// do we have a paragraph with this id?
128 bool hasParWithID(int id) const;
132 Takes care of auto-save files and backup file if requested.
133 Returns \c true if the save is successful, \c false otherwise.
137 /// Write file. Returns \c false if unsuccesful.
138 bool writeFile(string const &) const;
141 void writeFileAscii(string const & , int);
143 void writeFileAscii(std::ostream &, int);
145 string const asciiParagraph(Paragraph const &, unsigned int linelen,
146 bool noparbreak = false) const;
147 /// Just a wrapper for the method below, first creating the ofstream.
148 void makeLaTeXFile(string const & filename,
149 string const & original_path,
151 bool only_body = false,
152 bool only_preamble = false);
154 void makeLaTeXFile(std::ostream & os,
155 string const & original_path,
157 bool only_body = false,
158 bool only_preamble = false);
160 void simpleDocBookOnePar(std::ostream &,
161 ParagraphList::iterator par, int & desc_on,
162 Paragraph::depth_type depth) const;
164 void simpleLinuxDocOnePar(std::ostream & os,
165 ParagraphList::iterator par,
166 Paragraph::depth_type depth) const;
168 void makeLinuxDocFile(string const & filename,
169 bool nice, bool only_body = false);
171 void makeDocBookFile(string const & filename,
172 bool nice, bool only_body = false);
174 void sgmlError(ParagraphList::iterator par, int pos, string const & message) const;
176 /// returns the main language for the buffer (document)
177 Language const * getLanguage() const;
178 /// get l10n translated to the buffers language
179 string const B_(string const & l10n) const;
183 /// return true if the main lyx file does not need saving
184 bool isClean() const;
186 bool isBakClean() const;
188 bool isDepClean(string const & name) const;
190 /// mark the main lyx file as not needing saving
191 void markClean() const;
197 void markDepClean(string const & name);
200 void setUnnamed(bool flag = true);
205 /// Mark this buffer as dirty.
208 /// Returns the buffer's filename. It is always an absolute path.
209 string const & fileName() const;
211 /// Returns the the path where the buffer lives.
212 /// It is always an absolute path.
213 string const & filePath() const;
215 /** A transformed version of the file name, adequate for LaTeX.
216 \param no_path optional if \c true then the path is stripped.
218 string const getLatexName(bool no_path = true) const;
220 /// Get the name and type of the log.
221 std::pair<LogType, string> const getLogName() const;
223 /// Change name of buffer. Updates "read-only" flag.
224 void setFileName(string const & newfile);
226 /// Name of the document's parent
227 void setParentName(string const &);
229 /// Is buffer read-only?
230 bool isReadonly() const;
232 /// Set buffer read-only flag
233 void setReadonly(bool flag = true);
235 /// returns \c true if the buffer contains a LaTeX document
236 bool isLatex() const;
237 /// returns \c true if the buffer contains a LinuxDoc document
238 bool isLinuxDoc() const;
239 /// returns \c true if the buffer contains a DocBook document
240 bool isDocBook() const;
241 /** returns \c true if the buffer contains either a LinuxDoc
242 or DocBook document */
244 /// returns \c true if the buffer contains a Wed document
245 bool isLiterate() const;
247 /** Validate a buffer for LaTeX.
248 This validates the buffer, and returns a struct for use by
249 #makeLaTeX# and others. Its main use is to figure out what
250 commands and packages need to be included in the LaTeX file.
251 It (should) also check that the needed constructs are there
252 (i.e. that the \refs points to coresponding \labels). It
253 should perhaps inset "error" insets to help the user correct
256 void validate(LaTeXFeatures &) const;
258 /// return all bibkeys from buffer and its childs
259 void fillWithBibKeys(std::vector<std::pair<string, string> > & keys) const;
261 std::vector<string> const getLabelList() const;
263 /** This will clearly have to change later. Later we can have more
264 than one user per buffer. */
265 BufferView * getUser() const;
268 void changeLanguage(Language const * from, Language const * to);
271 void updateDocLang(Language const * nlang);
274 bool isMultiLingual();
276 /// Does this mean that this is buffer local?
277 limited_stack<boost::shared_ptr<Undo> > undostack;
279 /// Does this mean that this is buffer local?
280 limited_stack<boost::shared_ptr<Undo> > redostack;
285 /** The list of paragraphs.
286 This is a linked list of paragraph, this list holds the
287 whole contents of the document.
289 ParagraphList paragraphs;
291 /// LyX version control object.
294 /// Where to put temporary files.
297 /** If we are writing a nice LaTeX file or not.
298 While writing as LaTeX, tells whether we are
299 doing a 'nice' LaTeX file */
302 /// Used when typesetting to place errorboxes.
305 /// the author list for the document
306 AuthorList & authors();
309 typedef std::map<string, bool> DepClean;
311 /// need to regenerate .tex ?
315 mutable bool lyx_clean;
317 /// is autosave needed
318 mutable bool bak_clean;
320 /// is this a unnamed file (New...)
326 /// name of the file the buffer is associated with.
329 /// The path to the document file.
332 /// Format number of buffer
334 /** A list of views using this buffer.
335 Why not keep a list of the BufferViews that use this buffer?
337 At least then we don't have to do a lot of magic like:
338 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
339 of the buffers in the list of users to do a #updateLayoutChoice#.
343 boost::scoped_ptr<Messages> messages_;
346 class inset_iterator {
348 typedef std::input_iterator_tag iterator_category;
349 typedef Inset value_type;
350 typedef ptrdiff_t difference_type;
351 typedef Inset * pointer;
352 typedef Inset & reference;
353 typedef ParagraphList::iterator base_type;
358 inset_iterator(base_type p, base_type e);
360 inset_iterator(base_type p, lyx::pos_type pos, base_type e);
363 inset_iterator & operator++();
365 inset_iterator operator++(int);
367 reference operator*();
369 pointer operator->();
372 ParagraphList::iterator getPar() const;
374 lyx::pos_type getPos() const;
377 bool operator==(inset_iterator const & iter1,
378 inset_iterator const & iter2);
383 ParagraphList::iterator pit;
385 ParagraphList::iterator pend;
387 InsetList::iterator it;
391 inset_iterator inset_iterator_begin() {
392 return inset_iterator(paragraphs.begin(), paragraphs.end());
396 inset_iterator inset_iterator_end() {
397 return inset_iterator();
401 inset_iterator inset_const_iterator_begin() const {
402 return inset_iterator(paragraphs.begin(), paragraphs.end());
406 inset_iterator inset_const_iterator_end() const {
407 return inset_iterator();
411 ParIterator par_iterator_begin();
413 ParConstIterator par_iterator_begin() const;
415 ParIterator par_iterator_end();
417 ParConstIterator par_iterator_end() const;
420 Inset * getInsetFromID(int id_arg) const;
423 bool operator==(Buffer::inset_iterator const & iter1,
424 Buffer::inset_iterator const & iter2);
426 bool operator!=(Buffer::inset_iterator const & iter1,
427 Buffer::inset_iterator const & iter2);