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"
27 #include <boost/shared_ptr.hpp>
35 class ParConstIterator;
38 /** The buffer object.
39 This is the buffer object. It contains all the informations about
40 a document loaded into LyX. I am not sure if the class is complete or
41 minimal, probably not.
42 \author Lars Gullik Bjønnes
46 /// What type of log will \c getLogName() return?
48 latexlog, ///< LaTeX log
49 buildlog ///< Literate build log
54 \param b optional \c false by default
56 explicit Buffer(string const & file, bool b = false);
61 /** High-level interface to buffer functionality.
62 This function parses a command string and executes it
64 bool dispatch(string const & command, bool * result = 0);
66 /// Maybe we know the function already by number...
67 bool dispatch(int ac, string const & argument, bool * result = 0);
70 void resizeInsets(BufferView *);
72 /// Update window titles of all users.
73 void updateTitles() const;
75 /// Reset autosave timers for all users.
76 void resetAutosaveTimers() const;
78 /** Adds the BufferView to the users list.
79 Later this func will insert the \c BufferView into a real list,
80 not just setting a pointer.
82 void addUser(BufferView * u);
84 /** Removes the #BufferView# from the users list.
85 Since we only can have one at the moment, we just reset it.
87 void delUser(BufferView *);
92 /// Load the autosaved file.
93 void loadAutoSaveFile();
96 \param par if != 0 insert the file.
97 \return \c false if method fails.
99 bool readFile(LyXLex &, string const &, Paragraph * par = 0);
101 /** Reads a file without header.
102 \param par if != 0 insert the file.
103 \return \c false if file is not completely read.
105 bool readLyXformat2(LyXLex &, Paragraph * par = 0);
107 /// This parses a single LyXformat-Token.
108 bool parseSingleLyXformat2Token(LyXLex &, Paragraph *& par,
109 Paragraph *& return_par,
110 string const & token, int & pos,
111 Paragraph::depth_type & depth,
114 void insertStringAsLines(Paragraph *&, lyx::pos_type &,
115 LyXFont const &, string const &);
117 Paragraph * getParFromID(int id) const;
119 /// Parse a single inset.
120 void readInset(LyXLex &, Paragraph *& par, int & pos, LyXFont &);
123 Takes care of auto-save files and backup file if requested.
124 Returns \c true if the save is successful, \c false otherwise.
128 /// Write file. Returns \c false if unsuccesful.
129 bool writeFile(string const &) const;
132 void writeFileAscii(string const & , int);
134 void writeFileAscii(std::ostream &, int);
136 string const asciiParagraph(Paragraph const &, unsigned int linelen,
137 bool noparbreak = false) const;
138 /// Just a wrapper for the method below, first creating the ofstream.
139 void makeLaTeXFile(string const & filename,
140 string const & original_path,
142 bool only_body = false,
143 bool only_preamble = false);
145 void makeLaTeXFile(std::ostream & os,
146 string const & original_path,
148 bool only_body = false,
149 bool only_preamble = false);
151 /** LaTeX all paragraphs from par to endpar.
152 \param \a endpar if == 0 then to the end
154 void latexParagraphs(std::ostream & os,
155 ParagraphList::iterator par,
156 ParagraphList::iterator endpar,
157 TexRow & texrow, bool moving_arg = false) const;
160 void simpleDocBookOnePar(std::ostream &,
161 Paragraph * par, int & desc_on,
162 Paragraph::depth_type depth) const ;
164 void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par,
165 Paragraph::depth_type depth);
167 void makeLinuxDocFile(string const & filename,
168 bool nice, bool only_body = false);
170 void makeDocBookFile(string const & filename,
171 bool nice, bool only_body = false);
173 void sgmlError(Paragraph * par, int pos, string const & message) const;
175 /// returns the main language for the buffer (document)
176 Language const * getLanguage() const;
179 /// return true if the main lyx file does not need saving
180 bool isClean() const;
182 bool isBakClean() const;
184 bool isDepClean(string const & name) const;
186 /// mark the main lyx file as not needing saving
187 void markClean() const;
193 void markDepClean(string const & name);
196 void setUnnamed(bool flag = true);
201 /// Mark this buffer as dirty.
204 /// Returns the buffer's filename. It is always an absolute path.
205 string const & fileName() const;
207 /// Returns the the path where the buffer lives.
208 /// It is always an absolute path.
209 string const & filePath() const;
211 /** A transformed version of the file name, adequate for LaTeX.
212 \param no_path optional if \c true then the path is stripped.
214 string const getLatexName(bool no_path = true) const;
216 /// Get the name and type of the log.
217 std::pair<LogType, string> const getLogName() const;
219 /// Change name of buffer. Updates "read-only" flag.
220 void setFileName(string const & newfile);
222 /// Name of the document's parent
223 void setParentName(string const &);
225 /// Is buffer read-only?
226 bool isReadonly() const;
228 /// Set buffer read-only flag
229 void setReadonly(bool flag = true);
231 /// returns \c true if the buffer contains a LaTeX document
232 bool isLatex() const;
233 /// returns \c true if the buffer contains a LinuxDoc document
234 bool isLinuxDoc() const;
235 /// returns \c true if the buffer contains a DocBook document
236 bool isDocBook() const;
237 /** returns \c true if the buffer contains either a LinuxDoc
238 or DocBook document */
240 /// returns \c true if the buffer contains a Wed document
241 bool isLiterate() const;
243 /** Validate a buffer for LaTeX.
244 This validates the buffer, and returns a struct for use by
245 #makeLaTeX# and others. Its main use is to figure out what
246 commands and packages need to be included in the LaTeX file.
247 It (should) also check that the needed constructs are there
248 (i.e. that the \refs points to coresponding \labels). It
249 should perhaps inset "error" insets to help the user correct
252 void validate(LaTeXFeatures &) const;
254 /// return all bibkeys from buffer and its childs
255 void fillWithBibKeys(std::vector<std::pair<string, string> > & keys) const;
257 std::vector<string> const getLabelList() const;
259 /** This will clearly have to change later. Later we can have more
260 than one user per buffer. */
261 BufferView * getUser() const;
264 void changeLanguage(Language const * from, Language const * to);
266 bool isMultiLingual();
268 /// Does this mean that this is buffer local?
269 limited_stack<boost::shared_ptr<Undo> > undostack;
271 /// Does this mean that this is buffer local?
272 limited_stack<boost::shared_ptr<Undo> > redostack;
277 /** The list of paragraphs.
278 This is a linked list of paragraph, this list holds the
279 whole contents of the document.
281 ParagraphList paragraphs;
283 /// LyX version control object.
286 /// Where to put temporary files.
289 /** If we are writing a nice LaTeX file or not.
290 While writing as LaTeX, tells whether we are
291 doing a 'nice' LaTeX file */
294 /// Used when typesetting to place errorboxes.
297 /// the author list for the document
298 AuthorList & authors();
301 typedef std::map<string, bool> DepClean;
303 /// need to regenerate .tex ?
307 AuthorList authorlist;
310 mutable bool lyx_clean;
312 /// is autosave needed
313 mutable bool bak_clean;
315 /// is this a unnamed file (New...)
321 /// name of the file the buffer is associated with.
324 /// The path to the document file.
327 /// Format number of buffer
329 /** A list of views using this buffer.
330 Why not keep a list of the BufferViews that use this buffer?
332 At least then we don't have to do a lot of magic like:
333 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
334 of the buffers in the list of users to do a #updateLayoutChoice#.
339 class inset_iterator {
341 typedef std::input_iterator_tag iterator_category;
342 typedef Inset value_type;
343 typedef ptrdiff_t difference_type;
344 typedef Inset * pointer;
345 typedef Inset & reference;
346 typedef ParagraphList::iterator base_type;
351 inset_iterator(base_type p, base_type e);
353 inset_iterator(base_type p, lyx::pos_type pos, base_type e);
356 inset_iterator & operator++();
358 inset_iterator operator++(int);
360 reference operator*();
362 pointer operator->();
365 Paragraph * getPar();
367 lyx::pos_type getPos() const;
370 bool operator==(inset_iterator const & iter1,
371 inset_iterator const & iter2);
376 ParagraphList::iterator pit;
378 ParagraphList::iterator pend;
380 InsetList::iterator it;
384 inset_iterator inset_iterator_begin() {
385 return inset_iterator(paragraphs.begin(), paragraphs.end());
389 inset_iterator inset_iterator_end() {
390 return inset_iterator();
394 inset_iterator inset_const_iterator_begin() const {
395 return inset_iterator(paragraphs.begin(), paragraphs.end());
399 inset_iterator inset_const_iterator_end() const {
400 return inset_iterator();
404 ParIterator par_iterator_begin();
406 ParConstIterator par_iterator_begin() const;
408 ParIterator par_iterator_end();
410 ParConstIterator par_iterator_end() const;
413 Inset * getInsetFromID(int id_arg) const;
416 bool operator==(Buffer::inset_iterator const & iter1,
417 Buffer::inset_iterator const & iter2);
419 bool operator!=(Buffer::inset_iterator const & iter1,
420 Buffer::inset_iterator const & iter2);