2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
8 * This file is Copyleft 1996
11 * ====================================================== */
15 // 23/03/98 Heinrich Bauer (heinrich.bauer@t-mobil.de)
16 // Spots marked "changed Heinrich Bauer, 23/03/98" modified due to the
17 // following bug: dvi file export did not work after printing (or previewing)
18 // and vice versa as long as the same file was concerned. This happened
19 // every time the LyX-file was left unchanged between the two actions mentioned
31 #include "BufferView.h"
33 #include "bufferparams.h"
40 class auto_mem_buffer;
52 /** The buffer object.
53 The is is the buffer object. It contains all the informations about
54 a document loaded into LyX. I am not sure if the class is complete or
55 minimal, probably not.
60 explicit Buffer(string const & file, bool b = false);
65 /** save the buffer's parameters as user default
66 This function saves a file #user_lyxdir/templates/defaults.lyx#
67 which parameters are those of the current buffer. This file
68 is used as a default template when creating a new
69 file. Returns #true# on success.
71 bool saveParamsAsDefaults();
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);
81 /// and have an xtl buffer to work with.
82 bool Dispatch(int, auto_mem_buffer &);
84 /// should be changed to work for a list.
87 void resizeInsets(BufferView *);
89 /// Update window titles of all users
90 void updateTitles() const;
92 /// Reset autosave timers for all users
93 void resetAutosaveTimers() const;
95 /** Adds the BufferView to the users list.
96 Later this func will insert the #BufferView# into a real list,
97 not just setting a pointer.
99 void addUser(BufferView * u) { users = u; }
101 /** Removes the #BufferView# from the users list.
102 Since we only can have one at the moment, we just reset it.
104 void delUser(BufferView *) { users = 0; }
110 //users->updateScrollbar();
114 void loadAutoSaveFile();
117 @param par if != 0 insert the file.
118 @return #false# if method fails.
120 bool readFile(LyXLex &, LyXParagraph * par = 0);
122 /** Reads a file without header.
123 @param par if != 0 insert the file.
124 @return false if file is not completely read.
126 bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
128 /// This parses a single LyXformat-Token.
129 bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
130 LyXParagraph *& return_par,
131 string const & token, int & pos,
132 char & depth, LyXFont &
134 ,LyXParagraph::footnote_flag &,
135 LyXParagraph::footnote_kind &
139 /// Parse a single inset.
140 void readInset(LyXLex &, LyXParagraph *& par, int & pos, LyXFont &);
143 Takes care of auto-save files and backup file if requested.
144 Returns #true# if the save is successful, #false# otherwise.
148 /// Write file. Returns #false# if unsuccesful.
149 bool writeFile(string const &, bool) const;
152 void writeFileAscii(string const & , int);
155 void makeLaTeXFile(string const & filename,
156 string const & original_path,
157 bool nice, bool only_body = false);
158 /** LaTeX all paragraphs from par to endpar.
159 @param endpar if == 0 then to the end
161 void latexParagraphs(std::ostream & os, LyXParagraph * par,
162 LyXParagraph * endpar, TexRow & texrow) const;
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);
183 /// returns the main language for the buffer (document)
184 string const GetLanguage() const {
185 return params.language;
189 bool isLyxClean() const { return lyx_clean; }
192 bool isNwClean() const { return nw_clean; }
195 bool isBakClean() const { return bak_clean; }
198 bool isDepClean(string const & name) const;
201 void markLyxClean() const {
206 // if the .lyx file has been saved, we don't need an
212 void markNwClean() { nw_clean = true; }
215 void markBakClean() { bak_clean = true; }
218 void markDepClean(string const & name);
221 void markNwDirty() { nw_clean = false; }
224 void setUnnamed(bool flag=true) { unnamed = flag; }
227 bool isUnnamed() { return unnamed; }
237 DEPCLEAN * tmp = dep_clean;
245 string const & fileName() const { return filename; }
247 /** A transformed version of the file name, adequate for LaTeX
248 The path is stripped if no_path is true (default)
250 string const getLatexName(bool no_path = true) const;
252 /// Change name of buffer. Updates "read-only" flag.
253 void fileName(string const & newfile);
255 /// Name of the document's parent
256 void setParentName(string const &);
258 /// Is buffer read-only?
259 bool isReadonly() const { return read_only; }
261 /// Set buffer read-only flag
262 void setReadonly(bool flag = true);
264 /// returns #true# if the buffer contains a LaTeX document
265 bool isLatex() const;
266 /// returns #true# if the buffer contains a LinuxDoc document
267 bool isLinuxDoc() const;
268 /// returns #true# if the buffer contains a DocBook document
269 bool isDocBook() const;
270 /** returns #true# if the buffer contains either a LinuxDoc
271 or DocBook document */
273 /// returns #true# if the buffer contains a Wed document
274 bool isLiterate() const;
277 void setPaperStuff();
279 /** Validate a buffer for LaTeX.
280 This validates the buffer, and returns a struct for use by
281 #makeLaTeX# and others. Its main use is to figure out what
282 commands and packages need to be included in the LaTeX file.
283 It (should) also check that the needed constructs are there
284 (i.e. that the \refs points to coresponding \labels). It
285 should perhaps inset "error" insets to help the user correct
288 void validate(LaTeXFeatures &) const;
291 string const getIncludeonlyList(char delim = ',');
293 std::vector<std::pair<string,string> > const getBibkeyList();
315 std::vector<std::vector<TocItem> > const getTocList();
317 std::vector<string> const getLabelList();
319 /** This will clearly have to change later. Later we can have more
320 than one user per buffer. */
321 BufferView * getUser() const { return users; }
324 void ChangeLanguage(Language const * from, Language const * to);
326 bool isMultiLingual();
328 /// Does this mean that this is buffer local?
331 /// Does this mean that this is buffer local?
337 /** is a list of paragraphs.
339 LyXParagraph * paragraph;
344 /// where the temporaries go if we want them
350 /** While writing as LaTeX, tells whether we are
351 doing a 'nice' LaTeX file */
354 /// Used when typesetting to place errorboxes.
359 void linuxDocHandleFootnote(std::ostream & os,
360 LyXParagraph * & par, int const depth);
363 void DocBookHandleCaption(std::ostream & os, string & inner_tag,
364 int const depth, int desc_on,
365 LyXParagraph * & par);
368 void DocBookHandleFootnote(std::ostream & os,
369 LyXParagraph * & par, int const depth);
372 void sgmlOpenTag(std::ostream & os, int depth,
373 string const & latexname) const;
375 void sgmlCloseTag(std::ostream & os, int depth,
376 string const & latexname) const;
378 void LinuxDocError(LyXParagraph * par, int pos,
379 string const & message);
381 void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par,
382 int desc_on, int const depth);
384 void SimpleDocBookOnePar(std::ostream &, string & extra,
385 LyXParagraph * par, int & desc_on,
389 void push_tag(std::ostream & os, string const & tag,
390 int & pos, char stack[5][3]);
393 void pop_tag(std::ostream & os, string const & tag,
394 int & pos, char stack[5][3]);
397 mutable bool lyx_clean;
399 /// is autosave needed
400 mutable bool bak_clean;
402 /// do we need to run weave/tangle
405 /// is this a unnamed file (New...)
408 /// is regenerating #.tex# necessary
409 DEPCLEAN * dep_clean;
414 /// name of the file the buffer is associated with.
417 /// Format number of buffer
420 /** A list of views using this buffer.
421 Why not keep a list of the BufferViews that use this buffer?
423 At least then we don't have to do a lot of magic like:
424 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
425 of the buffers in the list of users to do a #updateLayoutChoice#.
431 class inset_iterator {
434 inset_iterator() : par(0) /*, it(0)*/ {}
436 inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
440 inset_iterator(LyXParagraph * paragraph,
441 LyXParagraph::size_type pos);
443 inset_iterator & operator++() {
446 if (it == par->inset_iterator_end()) {
454 Inset * operator*() {return *it; }
456 LyXParagraph * getPar() { return par; }
458 LyXParagraph::size_type getPos() {return it.getPos(); }
461 bool operator==(inset_iterator const & iter1,
462 inset_iterator const & iter2);
465 //bool operator!=(inset_iterator const & iter1,
466 // inset_iterator const & iter2);
473 LyXParagraph::inset_iterator it;
477 inset_iterator inset_iterator_begin() {
478 return inset_iterator(paragraph);
481 inset_iterator inset_iterator_end() {
482 return inset_iterator();
488 void Buffer::setParentName(string const & name)
490 params.parentname = name;
495 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
496 return a.par == b.par && a.str == b.str;
497 // No need to compare depth.
503 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
505 // No need to compare depth.
510 bool operator==(Buffer::inset_iterator const & iter1,
511 Buffer::inset_iterator const & iter2) {
512 return iter1.par == iter2.par
513 && (iter1.par == 0 || iter1.it == iter2.it);
518 bool operator!=(Buffer::inset_iterator const & iter1,
519 Buffer::inset_iterator const & iter2) {
520 return !(iter1 == iter2);