2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
8 * This file is Copyleft 1996
11 * ====================================================== */
22 #include "support/limited_stack.h"
25 #include "bufferparams.h"
27 #include "paragraph.h"
29 #include <boost/shared_ptr.hpp>
38 // When lyx 1.3.x starts we should enable this
39 // btw. we should also test this with 1.2 so that we
40 // do not get any surprises. (Lgb)
41 #define NO_COMPABILITY 1
53 /** The buffer object.
54 This is the buffer object. It contains all the informations about
55 a document loaded into LyX. I am not sure if the class is complete or
56 minimal, probably not.
57 \author Lars Gullik Bjønnes
61 /// What type of log will \c getLogName() return?
63 latexlog, ///< LaTeX log
64 buildlog ///< Literate build log
69 \param b optional \c false by default
71 explicit Buffer(string const & file, bool b = false);
76 /** High-level interface to buffer functionality.
77 This function parses a command string and executes it
79 bool dispatch(string const & command, bool * result = 0);
81 /// Maybe we know the function already by number...
82 bool dispatch(int ac, string const & argument, bool * result = 0);
85 void resizeInsets(BufferView *);
87 /// Update window titles of all users.
88 void updateTitles() const;
90 /// Reset autosave timers for all users.
91 void resetAutosaveTimers() const;
93 /** Adds the BufferView to the users list.
94 Later this func will insert the \c BufferView into a real list,
95 not just setting a pointer.
97 void addUser(BufferView * u);
99 /** Removes the #BufferView# from the users list.
100 Since we only can have one at the moment, we just reset it.
102 void delUser(BufferView *);
107 /// Load the autosaved file.
108 void loadAutoSaveFile();
111 \param par if != 0 insert the file.
112 \return \c false if method fails.
114 bool readFile(LyXLex &, Paragraph * par = 0);
116 /** Reads a file without header.
117 \param par if != 0 insert the file.
118 \return \c false if file is not completely read.
120 bool readLyXformat2(LyXLex &, Paragraph * par = 0);
122 /// This parses a single LyXformat-Token.
123 bool parseSingleLyXformat2Token(LyXLex &, Paragraph *& par,
124 Paragraph *& return_par,
125 string const & token, int & pos,
126 Paragraph::depth_type & depth,
129 void insertStringAsLines(Paragraph *&, lyx::pos_type &,
130 LyXFont const &, string const &) const;
131 #ifndef NO_COMPABILITY
133 Inset * isErtInset(Paragraph * par, int pos) const;
135 void insertErtContents(Paragraph * par, int & pos,
136 bool set_inactive = true);
139 Paragraph * getParFromID(int id) const;
141 /// Parse a single inset.
142 void readInset(LyXLex &, Paragraph *& par, int & pos, LyXFont &);
145 Takes care of auto-save files and backup file if requested.
146 Returns \c true if the save is successful, \c false otherwise.
150 /// Write file. Returns \c false if unsuccesful.
151 bool writeFile(string const &, bool) const;
154 void writeFileAscii(string const & , int);
156 void writeFileAscii(std::ostream &, int);
158 string const asciiParagraph(Paragraph const *, unsigned int linelen,
159 bool noparbreak = false) const;
161 void makeLaTeXFile(string const & filename,
162 string const & original_path,
163 bool nice, bool only_body = false);
164 /** LaTeX all paragraphs from par to endpar.
165 \param \a endpar if == 0 then to the end
167 void latexParagraphs(std::ostream & os, Paragraph * par,
168 Paragraph * endpar, TexRow & texrow, bool moving_arg = false) const;
170 void simpleDocBookOnePar(std::ostream &,
171 Paragraph * par, int & desc_on,
172 Paragraph::depth_type depth) const ;
174 void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par,
175 Paragraph::depth_type depth);
177 void makeLinuxDocFile(string const & filename,
178 bool nice, bool only_body = false);
180 void makeDocBookFile(string const & filename,
181 bool nice, bool only_body = false);
182 /// Open SGML/XML tag.
183 int sgmlOpenTag(std::ostream & os, Paragraph::depth_type depth, bool mixcont,
184 string const & latexname) const;
185 /// Closes SGML/XML tag.
186 int sgmlCloseTag(std::ostream & os, Paragraph::depth_type depth, bool mixcont,
187 string const & latexname) const;
189 void sgmlError(Paragraph * par, int pos, string const & message) const;
191 /// returns the main language for the buffer (document)
192 Language const * getLanguage() const;
196 bool isLyxClean() const;
198 bool isBakClean() const;
200 bool isDepClean(string const & name) const;
203 void markLyxClean() const;
209 void markDepClean(string const & name);
212 void setUnnamed(bool flag = true);
217 /// Mark this buffer as dirty.
220 /// Returns the buffer's filename. It is always an absolute path.
221 string const & fileName() const;
223 /// Returns the the path where the buffer lives.
224 /// It is always an absolute path.
225 string const & filePath() const;
227 /** A transformed version of the file name, adequate for LaTeX.
228 \param no_path optional if \c true then the path is stripped.
230 string const getLatexName(bool no_path = true) const;
232 /// Get the name and type of the log.
233 std::pair<LogType, string> const getLogName() const;
235 /// Change name of buffer. Updates "read-only" flag.
236 void setFileName(string const & newfile);
238 /// Name of the document's parent
239 void setParentName(string const &);
241 /// Is buffer read-only?
242 bool isReadonly() const;
244 /// Set buffer read-only flag
245 void setReadonly(bool flag = true);
247 /// returns \c true if the buffer contains a LaTeX document
248 bool isLatex() const;
249 /// returns \c true if the buffer contains a LinuxDoc document
250 bool isLinuxDoc() const;
251 /// returns \c true if the buffer contains a DocBook document
252 bool isDocBook() const;
253 /** returns \c true if the buffer contains either a LinuxDoc
254 or DocBook document */
256 /// returns \c true if the buffer contains a Wed document
257 bool isLiterate() const;
259 /** Validate a buffer for LaTeX.
260 This validates the buffer, and returns a struct for use by
261 #makeLaTeX# and others. Its main use is to figure out what
262 commands and packages need to be included in the LaTeX file.
263 It (should) also check that the needed constructs are there
264 (i.e. that the \refs points to coresponding \labels). It
265 should perhaps inset "error" insets to help the user correct
268 void validate(LaTeXFeatures &) const;
271 string const getIncludeonlyList(char delim = ',');
273 std::vector<std::pair<string, string> > const getBibkeyList() const;
276 TocItem(Paragraph * p, int d, string const & s)
277 : par(p), depth(d), str(s) {}
286 typedef std::vector<TocItem> SingleList;
288 typedef std::map<string, SingleList> Lists;
290 Lists const getLists() const;
292 std::vector<string> const getLabelList();
294 /** This will clearly have to change later. Later we can have more
295 than one user per buffer. */
296 BufferView * getUser() const;
299 void changeLanguage(Language const * from, Language const * to);
301 bool isMultiLingual();
303 /// Does this mean that this is buffer local?
304 limited_stack<boost::shared_ptr<Undo> > undostack;
306 /// Does this mean that this is buffer local?
307 limited_stack<boost::shared_ptr<Undo> > redostack;
312 /** The list of paragraphs.
313 This is a linked list of paragraph, this list holds the
314 whole contents of the document.
316 Paragraph * paragraph;
318 /// LyX version control object.
321 /// Where to put temporary files.
324 /** If we are writing a nice LaTeX file or not.
325 While writing as LaTeX, tells whether we are
326 doing a 'nice' LaTeX file */
329 /// Used when typesetting to place errorboxes.
333 mutable bool lyx_clean;
335 /// is autosave needed
336 mutable bool bak_clean;
338 /// is this a unnamed file (New...)
341 /// is regenerating #.tex# necessary
342 DEPCLEAN * dep_clean;
347 /// name of the file the buffer is associated with.
350 /// The path to the document file.
353 /// Format number of buffer
355 /** A list of views using this buffer.
356 Why not keep a list of the BufferViews that use this buffer?
358 At least then we don't have to do a lot of magic like:
359 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
360 of the buffers in the list of users to do a #updateLayoutChoice#.
366 class inset_iterator {
368 typedef std::input_iterator_tag iterator_category;
369 typedef Inset value_type;
370 typedef ptrdiff_t difference_type;
371 typedef Inset * pointer;
372 typedef Inset & reference;
376 inset_iterator() : par(0) /*, it(0)*/ {}
378 inset_iterator(Paragraph * paragraph) : par(paragraph) {
382 inset_iterator(Paragraph * paragraph, lyx::pos_type pos);
384 inset_iterator & operator++() { // prefix ++
387 if (it == par->inset_iterator_end()) {
395 inset_iterator operator++(int) { // postfix ++
396 inset_iterator tmp(par, it.getPos());
399 if (it == par->inset_iterator_end()) {
407 Inset * operator*() { return *it; }
410 Paragraph * getPar() { return par; }
412 lyx::pos_type getPos() const { return it.getPos(); }
415 bool operator==(inset_iterator const & iter1,
416 inset_iterator const & iter2);
423 Paragraph::inset_iterator it;
427 inset_iterator inset_iterator_begin() {
428 return inset_iterator(paragraph);
431 inset_iterator inset_iterator_end() {
432 return inset_iterator();
435 inset_iterator inset_const_iterator_begin() const {
436 return inset_iterator(paragraph);
439 inset_iterator inset_const_iterator_end() const {
440 return inset_iterator();
444 ParIterator par_iterator_begin();
446 ParIterator par_iterator_end();
449 Inset * getInsetFromID(int id_arg) const;
454 void Buffer::addUser(BufferView * u)
461 void Buffer::delUser(BufferView *)
468 Language const * Buffer::getLanguage() const
470 return params.language;
475 bool Buffer::isLyxClean() const
482 bool Buffer::isBakClean() const
489 void Buffer::markLyxClean() const
495 // if the .lyx file has been saved, we don't need an
502 void Buffer::markBakClean()
509 void Buffer::setUnnamed(bool flag)
516 bool Buffer::isUnnamed()
523 void Buffer::markDirty()
530 DEPCLEAN * tmp = dep_clean;
539 string const & Buffer::fileName() const
546 string const & Buffer::filePath() const
553 bool Buffer::isReadonly() const
560 BufferView * Buffer::getUser() const
567 void Buffer::setParentName(string const & name)
569 params.parentname = name;
575 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b)
577 return a.par == b.par && a.str == b.str;
578 // No need to compare depth.
584 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b)
587 // No need to compare depth.
593 bool operator==(Buffer::inset_iterator const & iter1,
594 Buffer::inset_iterator const & iter2)
596 return iter1.par == iter2.par
597 && (iter1.par == 0 || iter1.it == iter2.it);
603 bool operator!=(Buffer::inset_iterator const & iter1,
604 Buffer::inset_iterator const & iter2)
606 return !(iter1 == iter2);