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();
95 /** Inserts a file into a document
96 \param par if != 0 insert the file.
97 \return \c false if method fails.
99 bool readFile(LyXLex &, string const &, ParagraphList::iterator pit);
101 // FIXME: it's very silly to pass a lex in here
103 bool readFile(LyXLex &, string const &);
105 /// read the header, returns number of unknown tokens
106 int readHeader(LyXLex & lex);
108 /** Reads a file without header.
109 \param par if != 0 insert the file.
110 \return \c false if file is not completely read.
112 bool readBody(LyXLex &, ParagraphList::iterator pit);
114 /// This parses a single token
115 int readParagraph(LyXLex &, string const & token,
116 ParagraphList & pars, ParagraphList::iterator & pit,
117 Paragraph::depth_type & depth);
120 void insertStringAsLines(Paragraph *&, lyx::pos_type &,
121 LyXFont const &, string const &);
123 Paragraph * getParFromID(int id) const;
127 Takes care of auto-save files and backup file if requested.
128 Returns \c true if the save is successful, \c false otherwise.
132 /// Write file. Returns \c false if unsuccesful.
133 bool writeFile(string const &) const;
136 void writeFileAscii(string const & , int);
138 void writeFileAscii(std::ostream &, int);
140 string const asciiParagraph(Paragraph const &, unsigned int linelen,
141 bool noparbreak = false) const;
142 /// Just a wrapper for the method below, first creating the ofstream.
143 void makeLaTeXFile(string const & filename,
144 string const & original_path,
146 bool only_body = false,
147 bool only_preamble = false);
149 void makeLaTeXFile(std::ostream & os,
150 string const & original_path,
152 bool only_body = false,
153 bool only_preamble = false);
155 void simpleDocBookOnePar(std::ostream &,
156 Paragraph * par, int & desc_on,
157 Paragraph::depth_type depth) const ;
159 void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par,
160 Paragraph::depth_type depth);
162 void makeLinuxDocFile(string const & filename,
163 bool nice, bool only_body = false);
165 void makeDocBookFile(string const & filename,
166 bool nice, bool only_body = false);
168 void sgmlError(Paragraph * par, int pos, string const & message) const;
170 /// returns the main language for the buffer (document)
171 Language const * getLanguage() const;
174 /// return true if the main lyx file does not need saving
175 bool isClean() const;
177 bool isBakClean() const;
179 bool isDepClean(string const & name) const;
181 /// mark the main lyx file as not needing saving
182 void markClean() const;
188 void markDepClean(string const & name);
191 void setUnnamed(bool flag = true);
196 /// Mark this buffer as dirty.
199 /// Returns the buffer's filename. It is always an absolute path.
200 string const & fileName() const;
202 /// Returns the the path where the buffer lives.
203 /// It is always an absolute path.
204 string const & filePath() const;
206 /** A transformed version of the file name, adequate for LaTeX.
207 \param no_path optional if \c true then the path is stripped.
209 string const getLatexName(bool no_path = true) const;
211 /// Get the name and type of the log.
212 std::pair<LogType, string> const getLogName() const;
214 /// Change name of buffer. Updates "read-only" flag.
215 void setFileName(string const & newfile);
217 /// Name of the document's parent
218 void setParentName(string const &);
220 /// Is buffer read-only?
221 bool isReadonly() const;
223 /// Set buffer read-only flag
224 void setReadonly(bool flag = true);
226 /// returns \c true if the buffer contains a LaTeX document
227 bool isLatex() const;
228 /// returns \c true if the buffer contains a LinuxDoc document
229 bool isLinuxDoc() const;
230 /// returns \c true if the buffer contains a DocBook document
231 bool isDocBook() const;
232 /** returns \c true if the buffer contains either a LinuxDoc
233 or DocBook document */
235 /// returns \c true if the buffer contains a Wed document
236 bool isLiterate() const;
238 /** Validate a buffer for LaTeX.
239 This validates the buffer, and returns a struct for use by
240 #makeLaTeX# and others. Its main use is to figure out what
241 commands and packages need to be included in the LaTeX file.
242 It (should) also check that the needed constructs are there
243 (i.e. that the \refs points to coresponding \labels). It
244 should perhaps inset "error" insets to help the user correct
247 void validate(LaTeXFeatures &) const;
249 /// return all bibkeys from buffer and its childs
250 void fillWithBibKeys(std::vector<std::pair<string, string> > & keys) const;
252 std::vector<string> const getLabelList() const;
254 /** This will clearly have to change later. Later we can have more
255 than one user per buffer. */
256 BufferView * getUser() const;
259 void changeLanguage(Language const * from, Language const * to);
261 bool isMultiLingual();
263 /// Does this mean that this is buffer local?
264 limited_stack<boost::shared_ptr<Undo> > undostack;
266 /// Does this mean that this is buffer local?
267 limited_stack<boost::shared_ptr<Undo> > redostack;
272 /** The list of paragraphs.
273 This is a linked list of paragraph, this list holds the
274 whole contents of the document.
276 ParagraphList paragraphs;
278 /// LyX version control object.
281 /// Where to put temporary files.
284 /** If we are writing a nice LaTeX file or not.
285 While writing as LaTeX, tells whether we are
286 doing a 'nice' LaTeX file */
289 /// Used when typesetting to place errorboxes.
292 /// the author list for the document
293 AuthorList & authors();
296 typedef std::map<string, bool> DepClean;
298 /// need to regenerate .tex ?
302 mutable bool lyx_clean;
304 /// is autosave needed
305 mutable bool bak_clean;
307 /// is this a unnamed file (New...)
313 /// name of the file the buffer is associated with.
316 /// The path to the document file.
319 /// Format number of buffer
321 /** A list of views using this buffer.
322 Why not keep a list of the BufferViews that use this buffer?
324 At least then we don't have to do a lot of magic like:
325 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
326 of the buffers in the list of users to do a #updateLayoutChoice#.
331 class inset_iterator {
333 typedef std::input_iterator_tag iterator_category;
334 typedef Inset value_type;
335 typedef ptrdiff_t difference_type;
336 typedef Inset * pointer;
337 typedef Inset & reference;
338 typedef ParagraphList::iterator base_type;
343 inset_iterator(base_type p, base_type e);
345 inset_iterator(base_type p, lyx::pos_type pos, base_type e);
348 inset_iterator & operator++();
350 inset_iterator operator++(int);
352 reference operator*();
354 pointer operator->();
357 Paragraph * getPar();
359 lyx::pos_type getPos() const;
362 bool operator==(inset_iterator const & iter1,
363 inset_iterator const & iter2);
368 ParagraphList::iterator pit;
370 ParagraphList::iterator pend;
372 InsetList::iterator it;
376 inset_iterator inset_iterator_begin() {
377 return inset_iterator(paragraphs.begin(), paragraphs.end());
381 inset_iterator inset_iterator_end() {
382 return inset_iterator();
386 inset_iterator inset_const_iterator_begin() const {
387 return inset_iterator(paragraphs.begin(), paragraphs.end());
391 inset_iterator inset_const_iterator_end() const {
392 return inset_iterator();
396 ParIterator par_iterator_begin();
398 ParConstIterator par_iterator_begin() const;
400 ParIterator par_iterator_end();
402 ParConstIterator par_iterator_end() const;
405 Inset * getInsetFromID(int id_arg) const;
408 bool operator==(Buffer::inset_iterator const & iter1,
409 Buffer::inset_iterator const & iter2);
411 bool operator!=(Buffer::inset_iterator const & iter1,
412 Buffer::inset_iterator const & iter2);