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;
170 void SimpleDocBookOnePar(std::ostream &, string & extra,
171 LyXParagraph * par, int & desc_on,
178 void makeLinuxDocFile(string const & filename,
179 bool nice, bool only_body = false);
181 void makeDocBookFile(string const & filename,
182 bool nice, bool only_body = false);
184 /// returns the main language for the buffer (document)
185 Language const * GetLanguage() const {
186 return params.language;
190 bool isLyxClean() const { return lyx_clean; }
193 bool isBakClean() const { return bak_clean; }
196 bool isDepClean(string const & name) const;
199 void markLyxClean() const {
204 // if the .lyx file has been saved, we don't need an
210 void markBakClean() { bak_clean = true; }
213 void markDepClean(string const & name);
216 void setUnnamed(bool flag=true) { unnamed = flag; }
219 bool isUnnamed() { return unnamed; }
228 DEPCLEAN * tmp = dep_clean;
236 string const & fileName() const { return filename; }
238 /** A transformed version of the file name, adequate for LaTeX
239 The path is stripped if no_path is true (default)
241 string const getLatexName(bool no_path = true) const;
244 * get the name of the LaTeX log
246 string const getLatexLogName(void) const;
248 /// Change name of buffer. Updates "read-only" flag.
249 void setFileName(string const & newfile);
251 /// Name of the document's parent
252 void setParentName(string const &);
254 /// Is buffer read-only?
255 bool isReadonly() const { return read_only; }
257 /// Set buffer read-only flag
258 void setReadonly(bool flag = true);
260 /// returns #true# if the buffer contains a LaTeX document
261 bool isLatex() const;
262 /// returns #true# if the buffer contains a LinuxDoc document
263 bool isLinuxDoc() const;
264 /// returns #true# if the buffer contains a DocBook document
265 bool isDocBook() const;
266 /** returns #true# if the buffer contains either a LinuxDoc
267 or DocBook document */
269 /// returns #true# if the buffer contains a Wed document
270 bool isLiterate() const;
273 void setPaperStuff();
275 /** Validate a buffer for LaTeX.
276 This validates the buffer, and returns a struct for use by
277 #makeLaTeX# and others. Its main use is to figure out what
278 commands and packages need to be included in the LaTeX file.
279 It (should) also check that the needed constructs are there
280 (i.e. that the \refs points to coresponding \labels). It
281 should perhaps inset "error" insets to help the user correct
284 void validate(LaTeXFeatures &) const;
287 string const getIncludeonlyList(char delim = ',');
289 std::vector<std::pair<string,string> > const getBibkeyList();
311 std::vector<std::vector<TocItem> > const getTocList() const;
313 std::vector<string> const getLabelList();
315 /** This will clearly have to change later. Later we can have more
316 than one user per buffer. */
317 BufferView * getUser() const { return users; }
320 void ChangeLanguage(Language const * from, Language const * to);
322 bool isMultiLingual();
324 /// Does this mean that this is buffer local?
327 /// Does this mean that this is buffer local?
333 /** is a list of paragraphs.
335 LyXParagraph * paragraph;
340 /// where the temporaries go if we want them
346 /** While writing as LaTeX, tells whether we are
347 doing a 'nice' LaTeX file */
350 /// Used when typesetting to place errorboxes.
355 void linuxDocHandleFootnote(std::ostream & os,
356 LyXParagraph * & par, int depth);
359 void DocBookHandleCaption(std::ostream & os, string & inner_tag,
360 int depth, int desc_on,
361 LyXParagraph * & par);
364 void DocBookHandleFootnote(std::ostream & os,
365 LyXParagraph * & par, int depth);
368 void sgmlOpenTag(std::ostream & os, int depth,
369 string const & latexname) const;
371 void sgmlCloseTag(std::ostream & os, int depth,
372 string const & latexname) const;
374 void LinuxDocError(LyXParagraph * par, int pos,
375 string const & message);
377 void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par,
378 int desc_on, int depth);
381 void push_tag(std::ostream & os, string const & tag,
382 int & pos, char stack[5][3]);
385 void pop_tag(std::ostream & os, string const & tag,
386 int & pos, char stack[5][3]);
389 mutable bool lyx_clean;
391 /// is autosave needed
392 mutable bool bak_clean;
394 /// is this a unnamed file (New...)
397 /// is regenerating #.tex# necessary
398 DEPCLEAN * dep_clean;
403 /// name of the file the buffer is associated with.
406 /// Format number of buffer
412 /** A list of views using this buffer.
413 Why not keep a list of the BufferViews that use this buffer?
415 At least then we don't have to do a lot of magic like:
416 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
417 of the buffers in the list of users to do a #updateLayoutChoice#.
423 class inset_iterator {
425 typedef std::input_iterator_tag iterator_category;
426 typedef Inset value_type;
427 typedef ptrdiff_t difference_type;
428 typedef Inset * pointer;
429 typedef Inset & reference;
433 inset_iterator() : par(0) /*, it(0)*/ {}
435 inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
439 inset_iterator(LyXParagraph * paragraph,
440 LyXParagraph::size_type pos);
442 inset_iterator & operator++() { // prefix ++
445 if (it == par->inset_iterator_end()) {
453 inset_iterator operator++(int) { // postfix ++
454 inset_iterator tmp(par, it.getPos());
457 if (it == par->inset_iterator_end()) {
465 Inset * operator*() { return *it; }
468 LyXParagraph * getPar() { return par; }
470 LyXParagraph::size_type getPos() const { return it.getPos(); }
473 bool operator==(inset_iterator const & iter1,
474 inset_iterator const & iter2);
477 //bool operator!=(inset_iterator const & iter1,
478 // inset_iterator const & iter2);
485 LyXParagraph::inset_iterator it;
489 inset_iterator inset_iterator_begin() {
490 return inset_iterator(paragraph);
493 inset_iterator inset_iterator_end() {
494 return inset_iterator();
500 void Buffer::setParentName(string const & name)
502 params.parentname = name;
507 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
508 return a.par == b.par && a.str == b.str;
509 // No need to compare depth.
515 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
517 // No need to compare depth.
522 bool operator==(Buffer::inset_iterator const & iter1,
523 Buffer::inset_iterator const & iter2) {
524 return iter1.par == iter2.par
525 && (iter1.par == 0 || iter1.it == iter2.it);
530 bool operator!=(Buffer::inset_iterator const & iter1,
531 Buffer::inset_iterator const & iter2) {
532 return !(iter1 == iter2);