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;
53 /** The buffer object.
54 The is 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.
61 explicit Buffer(string const & file, bool b = false);
66 /** save the buffer's parameters as user default
67 This function saves a file #user_lyxdir/templates/defaults.lyx#
68 which parameters are those of the current buffer. This file
69 is used as a default template when creating a new
70 file. Returns #true# on success.
72 bool saveParamsAsDefaults();
74 /** High-level interface to buffer functionality.
75 This function parses a command string and executes it
77 bool Dispatch(string const & command);
79 /// Maybe we know the function already by number...
80 bool Dispatch(int ac, string const & argument);
82 /// and have an xtl buffer to work with.
83 bool Dispatch(int, auto_mem_buffer &);
85 /// should be changed to work for a list.
88 void resizeInsets(BufferView *);
90 /// Update window titles of all users
91 void updateTitles() const;
93 /// Reset autosave timers for all users
94 void resetAutosaveTimers() const;
96 /** Adds the BufferView to the users list.
97 Later this func will insert the #BufferView# into a real list,
98 not just setting a pointer.
100 void addUser(BufferView * u) { users = u; }
102 /** Removes the #BufferView# from the users list.
103 Since we only can have one at the moment, we just reset it.
105 void delUser(BufferView *) { users = 0; }
110 users->fitCursor(users->text);
111 //users->updateScrollbar();
115 void loadAutoSaveFile();
118 @param par if != 0 insert the file.
119 @return #false# if method fails.
121 bool readFile(LyXLex &, LyXParagraph * par = 0);
123 /** Reads a file without header.
124 @param par if != 0 insert the file.
125 @return false if file is not completely read.
127 bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
129 /// This parses a single LyXformat-Token.
130 bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
131 LyXParagraph *& return_par,
132 string const & token, int & pos,
133 char & depth, LyXFont &
135 ,LyXParagraph::footnote_flag &,
136 LyXParagraph::footnote_kind &
140 /// Parse a single inset.
141 void readInset(LyXLex &, LyXParagraph *& par, int & pos, LyXFont &);
144 Takes care of auto-save files and backup file if requested.
145 Returns #true# if the save is successful, #false# otherwise.
149 /// Write file. Returns #false# if unsuccesful.
150 bool writeFile(string const &, bool) const;
153 void writeFileAscii(string const & , int);
155 void writeFileAscii(std::ostream &, int);
157 string const asciiParagraph(LyXParagraph const *,
158 unsigned int linelen) const;
160 void makeLaTeXFile(string const & filename,
161 string const & original_path,
162 bool nice, bool only_body = false);
163 /** LaTeX all paragraphs from par to endpar.
164 @param endpar if == 0 then to the end
166 void latexParagraphs(std::ostream & os, LyXParagraph * par,
167 LyXParagraph * endpar, TexRow & texrow) const;
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);
179 /// returns the main language for the buffer (document)
180 Language const * GetLanguage() const {
181 return params.language;
185 bool isLyxClean() const { return lyx_clean; }
188 bool isBakClean() const { return bak_clean; }
191 bool isDepClean(string const & name) const;
194 void markLyxClean() const {
199 // if the .lyx file has been saved, we don't need an
205 void markBakClean() { bak_clean = true; }
208 void markDepClean(string const & name);
211 void setUnnamed(bool flag=true) { unnamed = flag; }
214 bool isUnnamed() { return unnamed; }
223 DEPCLEAN * tmp = dep_clean;
231 string const & fileName() const { return filename; }
233 /** A transformed version of the file name, adequate for LaTeX
234 The path is stripped if no_path is true (default)
236 string const getLatexName(bool no_path = true) const;
238 /// Change name of buffer. Updates "read-only" flag.
239 void setFileName(string const & newfile);
241 /// Name of the document's parent
242 void setParentName(string const &);
244 /// Is buffer read-only?
245 bool isReadonly() const { return read_only; }
247 /// Set buffer read-only flag
248 void setReadonly(bool flag = true);
250 /// returns #true# if the buffer contains a LaTeX document
251 bool isLatex() const;
252 /// returns #true# if the buffer contains a LinuxDoc document
253 bool isLinuxDoc() const;
254 /// returns #true# if the buffer contains a DocBook document
255 bool isDocBook() const;
256 /** returns #true# if the buffer contains either a LinuxDoc
257 or DocBook document */
259 /// returns #true# if the buffer contains a Wed document
260 bool isLiterate() const;
263 void setPaperStuff();
265 /** Validate a buffer for LaTeX.
266 This validates the buffer, and returns a struct for use by
267 #makeLaTeX# and others. Its main use is to figure out what
268 commands and packages need to be included in the LaTeX file.
269 It (should) also check that the needed constructs are there
270 (i.e. that the \refs points to coresponding \labels). It
271 should perhaps inset "error" insets to help the user correct
274 void validate(LaTeXFeatures &) const;
277 string const getIncludeonlyList(char delim = ',');
279 std::vector<std::pair<string,string> > const getBibkeyList();
301 std::vector<std::vector<TocItem> > const getTocList();
303 std::vector<string> const getLabelList();
305 /** This will clearly have to change later. Later we can have more
306 than one user per buffer. */
307 BufferView * getUser() const { return users; }
310 void ChangeLanguage(Language const * from, Language const * to);
312 bool isMultiLingual();
314 /// Does this mean that this is buffer local?
317 /// Does this mean that this is buffer local?
323 /** is a list of paragraphs.
325 LyXParagraph * paragraph;
330 /// where the temporaries go if we want them
336 /** While writing as LaTeX, tells whether we are
337 doing a 'nice' LaTeX file */
340 /// Used when typesetting to place errorboxes.
345 void linuxDocHandleFootnote(std::ostream & os,
346 LyXParagraph * & par, int depth);
349 void DocBookHandleCaption(std::ostream & os, string & inner_tag,
350 int depth, int desc_on,
351 LyXParagraph * & par);
354 void DocBookHandleFootnote(std::ostream & os,
355 LyXParagraph * & par, int depth);
358 void sgmlOpenTag(std::ostream & os, int depth,
359 string const & latexname) const;
361 void sgmlCloseTag(std::ostream & os, int depth,
362 string const & latexname) const;
364 void LinuxDocError(LyXParagraph * par, int pos,
365 string const & message);
367 void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par,
368 int desc_on, int depth);
370 void SimpleDocBookOnePar(std::ostream &, string & extra,
371 LyXParagraph * par, int & desc_on,
375 void push_tag(std::ostream & os, string const & tag,
376 int & pos, char stack[5][3]);
379 void pop_tag(std::ostream & os, string const & tag,
380 int & pos, char stack[5][3]);
383 mutable bool lyx_clean;
385 /// is autosave needed
386 mutable bool bak_clean;
388 /// is this a unnamed file (New...)
391 /// is regenerating #.tex# necessary
392 DEPCLEAN * dep_clean;
397 /// name of the file the buffer is associated with.
400 /// Format number of buffer
403 /** A list of views using this buffer.
404 Why not keep a list of the BufferViews that use this buffer?
406 At least then we don't have to do a lot of magic like:
407 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
408 of the buffers in the list of users to do a #updateLayoutChoice#.
414 class inset_iterator {
416 typedef std::input_iterator_tag iterator_category;
417 typedef Inset value_type;
418 typedef ptrdiff_t difference_type;
419 typedef Inset * pointer;
420 typedef Inset & reference;
424 inset_iterator() : par(0) /*, it(0)*/ {}
426 inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
430 inset_iterator(LyXParagraph * paragraph,
431 LyXParagraph::size_type pos);
433 inset_iterator & operator++() { // prefix ++
436 if (it == par->inset_iterator_end()) {
444 inset_iterator operator++(int) { // postfix ++
445 inset_iterator tmp(par, it.getPos());
448 if (it == par->inset_iterator_end()) {
456 Inset * operator*() { return *it; }
459 LyXParagraph * getPar() { return par; }
461 LyXParagraph::size_type getPos() const { return it.getPos(); }
464 bool operator==(inset_iterator const & iter1,
465 inset_iterator const & iter2);
468 //bool operator!=(inset_iterator const & iter1,
469 // inset_iterator const & iter2);
476 LyXParagraph::inset_iterator it;
480 inset_iterator inset_iterator_begin() {
481 return inset_iterator(paragraph);
484 inset_iterator inset_iterator_end() {
485 return inset_iterator();
491 void Buffer::setParentName(string const & name)
493 params.parentname = name;
498 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
499 return a.par == b.par && a.str == b.str;
500 // No need to compare depth.
506 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
508 // No need to compare depth.
513 bool operator==(Buffer::inset_iterator const & iter1,
514 Buffer::inset_iterator const & iter2) {
515 return iter1.par == iter2.par
516 && (iter1.par == 0 || iter1.it == iter2.it);
521 bool operator!=(Buffer::inset_iterator const & iter1,
522 Buffer::inset_iterator const & iter2) {
523 return !(iter1 == iter2);