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 "undostack.h"
24 #include "bufferparams.h"
26 #include "paragraph.h"
35 // When lyx 1.3.x starts we should enable this
36 // btw. we should also test this with 1.2 so that we
37 // do not get any surprises. (Lgb)
38 //#define NO_COMPABILITY 1
50 /** The buffer object.
51 This is the buffer object. It contains all the informations about
52 a document loaded into LyX. I am not sure if the class is complete or
53 minimal, probably not.
54 \author Lars Gullik Bjønnes
58 /// What type of log will \c getLogName() return?
60 latexlog, ///< LaTeX log
61 buildlog ///< Literate build log
66 \param b optional \c false by default
68 explicit Buffer(string const & file, bool b = false);
73 /** High-level interface to buffer functionality.
74 This function parses a command string and executes it
76 bool dispatch(string const & command);
78 /// Maybe we know the function already by number...
79 bool dispatch(int ac, string const & argument);
82 void resizeInsets(BufferView *);
84 /// Update window titles of all users.
85 void updateTitles() const;
87 /// Reset autosave timers for all users.
88 void resetAutosaveTimers() const;
90 /** Adds the BufferView to the users list.
91 Later this func will insert the \c BufferView into a real list,
92 not just setting a pointer.
94 void addUser(BufferView * u);
96 /** Removes the #BufferView# from the users list.
97 Since we only can have one at the moment, we just reset it.
99 void delUser(BufferView *);
104 /// Load the autosaved file.
105 void loadAutoSaveFile();
108 \param par if != 0 insert the file.
109 \return \c false if method fails.
111 bool readFile(LyXLex &, Paragraph * par = 0);
113 /** Reads a file without header.
114 \param par if != 0 insert the file.
115 \return \c false if file is not completely read.
117 bool readLyXformat2(LyXLex &, Paragraph * par = 0);
119 /// This parses a single LyXformat-Token.
120 bool parseSingleLyXformat2Token(LyXLex &, Paragraph *& par,
121 Paragraph *& return_par,
122 string const & token, int & pos,
123 Paragraph::depth_type & depth,
126 void insertStringAsLines(Paragraph *&, Paragraph::size_type &,
127 LyXFont const &, string const &) const;
128 #ifndef NO_COMPABILITY
130 void insertErtContents(Paragraph * par, int & pos,
131 LyXFont const & font,
132 bool set_inactive = true);
135 Paragraph * getParFromID(int id) const;
137 /// Parse a single inset.
138 void readInset(LyXLex &, Paragraph *& par, int & pos, LyXFont &);
141 Takes care of auto-save files and backup file if requested.
142 Returns \c true if the save is successful, \c false otherwise.
146 /// Write file. Returns \c false if unsuccesful.
147 bool writeFile(string const &, bool) const;
150 void writeFileAscii(string const & , int);
152 void writeFileAscii(std::ostream &, int);
154 string const asciiParagraph(Paragraph const *,
155 unsigned int linelen) const;
157 void makeLaTeXFile(string const & filename,
158 string const & original_path,
159 bool nice, bool only_body = false);
160 /** LaTeX all paragraphs from par to endpar.
161 \param \a endpar if == 0 then to the end
163 void latexParagraphs(std::ostream & os, Paragraph * par,
164 Paragraph * endpar, TexRow & texrow) const;
166 void simpleDocBookOnePar(std::ostream &,
167 Paragraph * par, int & desc_on,
168 Paragraph::depth_type depth) const ;
170 void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par,
171 Paragraph::depth_type depth);
173 void makeLinuxDocFile(string const & filename,
174 bool nice, bool only_body = false);
176 void makeDocBookFile(string const & filename,
177 bool nice, bool only_body = false);
178 /// Open SGML/XML tag.
179 void sgmlOpenTag(std::ostream & os, Paragraph::depth_type depth,
180 string const & latexname) const;
181 /// Closes SGML/XML tag.
182 void sgmlCloseTag(std::ostream & os, Paragraph::depth_type depth,
183 string const & latexname) const;
185 void sgmlError(Paragraph * par, int pos, string const & message) const;
187 /// returns the main language for the buffer (document)
188 Language const * getLanguage() const;
192 bool isLyxClean() const;
194 bool isBakClean() const;
196 bool isDepClean(string const & name) const;
199 void markLyxClean() const;
205 void markDepClean(string const & name);
208 void setUnnamed(bool flag = true);
213 /// Mark this buffer as dirty.
216 /// Returns the buffers filename.
217 string const & fileName() const;
219 /** A transformed version of the file name, adequate for LaTeX.
220 \param no_path optional if \c true then the path is stripped.
222 string const getLatexName(bool no_path = true) const;
224 /// Get the name and type of the log.
225 std::pair<LogType, string> const getLogName() const;
227 /// Change name of buffer. Updates "read-only" flag.
228 void setFileName(string const & newfile);
230 /// Name of the document's parent
231 void setParentName(string const &);
233 /// Is buffer read-only?
234 bool isReadonly() const;
236 /// Set buffer read-only flag
237 void setReadonly(bool flag = true);
239 /// returns \c true if the buffer contains a LaTeX document
240 bool isLatex() const;
241 /// returns \c true if the buffer contains a LinuxDoc document
242 bool isLinuxDoc() const;
243 /// returns \c true if the buffer contains a DocBook document
244 bool isDocBook() const;
245 /** returns \c true if the buffer contains either a LinuxDoc
246 or DocBook document */
248 /// returns \c true if the buffer contains a Wed document
249 bool isLiterate() const;
251 /** Validate a buffer for LaTeX.
252 This validates the buffer, and returns a struct for use by
253 #makeLaTeX# and others. Its main use is to figure out what
254 commands and packages need to be included in the LaTeX file.
255 It (should) also check that the needed constructs are there
256 (i.e. that the \refs points to coresponding \labels). It
257 should perhaps inset "error" insets to help the user correct
260 void validate(LaTeXFeatures &) const;
263 string const getIncludeonlyList(char delim = ',');
265 std::vector<std::pair<string, string> > const getBibkeyList();
268 TocItem(Paragraph * p, int d, string const & s)
269 : par(p), depth(d), str(s) {}
278 typedef std::vector<TocItem> SingleList;
280 typedef std::map<string, SingleList> Lists;
282 Lists const getLists() const;
284 std::vector<string> const getLabelList();
286 /** This will clearly have to change later. Later we can have more
287 than one user per buffer. */
288 BufferView * getUser() const;
291 void changeLanguage(Language const * from, Language const * to);
293 bool isMultiLingual();
295 /// Does this mean that this is buffer local?
298 /// Does this mean that this is buffer local?
304 /** The list of paragraphs.
305 This is a linked list of paragraph, this list holds the
306 whole contents of the document.
308 Paragraph * paragraph;
310 /// LyX version control object.
313 /// Where to put temporary files.
316 /// The path to the document file.
319 /** If we are writing a nice LaTeX file or not.
320 While writing as LaTeX, tells whether we are
321 doing a 'nice' LaTeX file */
324 /// Used when typesetting to place errorboxes.
328 mutable bool lyx_clean;
330 /// is autosave needed
331 mutable bool bak_clean;
333 /// is this a unnamed file (New...)
336 /// is regenerating #.tex# necessary
337 DEPCLEAN * dep_clean;
342 /// name of the file the buffer is associated with.
345 /// Format number of buffer
347 /** A list of views using this buffer.
348 Why not keep a list of the BufferViews that use this buffer?
350 At least then we don't have to do a lot of magic like:
351 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
352 of the buffers in the list of users to do a #updateLayoutChoice#.
358 class inset_iterator {
360 typedef std::input_iterator_tag iterator_category;
361 typedef Inset value_type;
362 typedef ptrdiff_t difference_type;
363 typedef Inset * pointer;
364 typedef Inset & reference;
368 inset_iterator() : par(0) /*, it(0)*/ {}
370 inset_iterator(Paragraph * paragraph) : par(paragraph) {
374 inset_iterator(Paragraph * paragraph,
375 Paragraph::size_type pos);
377 inset_iterator & operator++() { // prefix ++
380 if (it == par->inset_iterator_end()) {
388 inset_iterator operator++(int) { // postfix ++
389 inset_iterator tmp(par, it.getPos());
392 if (it == par->inset_iterator_end()) {
400 Inset * operator*() { return *it; }
403 Paragraph * getPar() { return par; }
405 Paragraph::size_type getPos() const { return it.getPos(); }
408 bool operator==(inset_iterator const & iter1,
409 inset_iterator const & iter2);
416 Paragraph::inset_iterator it;
420 inset_iterator inset_iterator_begin() {
421 return inset_iterator(paragraph);
424 inset_iterator inset_iterator_end() {
425 return inset_iterator();
428 inset_iterator inset_const_iterator_begin() const {
429 return inset_iterator(paragraph);
432 inset_iterator inset_const_iterator_end() const {
433 return inset_iterator();
437 ParIterator par_iterator_begin();
439 ParIterator par_iterator_end();
442 Inset * getInsetFromID(int id_arg) const;
447 void Buffer::addUser(BufferView * u)
454 void Buffer::delUser(BufferView *)
461 Language const * Buffer::getLanguage() const
463 return params.language;
468 bool Buffer::isLyxClean() const
475 bool Buffer::isBakClean() const
482 void Buffer::markLyxClean() const
488 // if the .lyx file has been saved, we don't need an
495 void Buffer::markBakClean()
502 void Buffer::setUnnamed(bool flag)
509 bool Buffer::isUnnamed()
516 void Buffer::markDirty()
523 DEPCLEAN * tmp = dep_clean;
532 string const & Buffer::fileName() const
539 bool Buffer::isReadonly() const
546 BufferView * Buffer::getUser() const
553 void Buffer::setParentName(string const & name)
555 params.parentname = name;
561 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b)
563 return a.par == b.par && a.str == b.str;
564 // No need to compare depth.
570 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b)
573 // No need to compare depth.
579 bool operator==(Buffer::inset_iterator const & iter1,
580 Buffer::inset_iterator const & iter2)
582 return iter1.par == iter2.par
583 && (iter1.par == 0 || iter1.it == iter2.it);
589 bool operator!=(Buffer::inset_iterator const & iter1,
590 Buffer::inset_iterator const & iter2)
592 return !(iter1 == iter2);