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.
59 /**@name Constructors and destructor */
62 explicit Buffer(string const & file, bool b = false);
71 /** save the buffer's parameters as user default
72 This function saves a file user_lyxdir/templates/defaults.lyx
73 which parameters are those of the current buffer. This file
74 is used as a default template when creating a new
75 file. Returns true on success.
77 bool saveParamsAsDefaults();
79 /** high-level interface to buffer functionality
80 This function parses a command string and executes it
82 bool Dispatch(string const & command);
84 /// Maybe we know the function already by number...
85 bool Dispatch(int ac, string const & argument);
87 /// and have an xtl buffer to work with.
88 bool Dispatch(int, auto_mem_buffer &);
90 /// should be changed to work for a list.
92 void resizeInsets(BufferView *);
94 /// Update window titles of all users
95 void updateTitles() const;
97 /// Reset autosave timers for all users
98 void resetAutosaveTimers() const;
100 /** Adds the BufferView to the users list.
101 Later this func will insert the BufferView into a real list,
102 not just setting a pointer.
104 void addUser(BufferView * u) { users = u; }
106 /** Removes the BufferView from the users list.
107 Since we only can have one at the moment, we just reset it.
109 void delUser(BufferView *) { users = 0; }
115 //users->updateScrollbar();
119 void loadAutoSaveFile();
122 Returns false if it fails.
123 If par is given, the file is inserted. */
124 bool readFile(LyXLex &, LyXParagraph * par = 0);
126 /** Reads a file without header.
127 Returns false, if file is not completely read.
128 If par is given, the file is inserted. */
129 bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
131 /* This parses a single LyXformat-Token */
132 bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
133 LyXParagraph *& return_par,
134 string const & token, int & pos,
135 char & depth, LyXFont &
137 ,LyXParagraph::footnote_flag &,
138 LyXParagraph::footnote_kind &
142 // Parse a single inset.
143 void readInset(LyXLex &, LyXParagraph *& par, int & pos, LyXFont &);
146 Takes care of auto-save files and backup file if requested.
147 Returns true if the save is successful, false otherwise.
151 /// Write file. Returns false if unsuccesful.
152 bool writeFile(string const &, bool) const;
155 void writeFileAscii(string const & , int);
158 void makeLaTeXFile(string const & filename,
159 string const & original_path,
160 bool nice, bool only_body = false);
162 // LaTeX all paragraphs from par to endpar,
163 // if endpar == 0 then to the end
165 void latexParagraphs(std::ostream & os, LyXParagraph *par,
166 LyXParagraph *endpar, TexRow & texrow) const;
181 void makeLinuxDocFile(string const & filename,
182 bool nice, bool only_body = false);
184 void makeDocBookFile(string const & filename,
185 bool nice, bool only_body = false);
187 /// returns the main language for the buffer (document)
188 string GetLanguage() const {
189 return params.language;
193 bool isLyxClean() const { return lyx_clean; }
196 bool isNwClean() const { return nw_clean; }
199 bool isBakClean() const { return bak_clean; }
202 bool isDepClean(string const & name) const;
205 void markLyxClean() const {
210 // if the .lyx file has been saved, we don't need an
216 void markNwClean() { nw_clean = true; }
219 void markBakClean() { bak_clean = true; }
222 void markDepClean(string const & name);
225 void markNwDirty() { nw_clean = false; }
235 DEPCLEAN * tmp = dep_clean;
243 string const & fileName() const { return filename; }
245 /** A transformed version of the file name, adequate for LaTeX
246 The path is stripped if no_path is true (default) */
247 string getLatexName(bool no_path = true) const;
249 /// Change name of buffer. Updates "read-only" flag.
250 void fileName(string const & newfile);
252 /// Name of the document's parent
253 void setParentName(string const &);
255 /// Is buffer read-only?
256 bool isReadonly() const { return read_only; }
258 /// Set buffer read-only flag
259 void setReadonly(bool flag = true);
261 /// returns true if the buffer contains a LaTeX document
262 bool isLatex() const;
263 /// returns true if the buffer contains a LinuxDoc document
264 bool isLinuxDoc() const;
265 /// returns true if the buffer contains a DocBook document
266 bool isDocBook() const;
267 /** returns true if the buffer contains either a LinuxDoc
268 or DocBook document */
270 /// returns true if the buffer contains a Wed document
271 bool isLiterate() const;
274 void setPaperStuff();
276 /** Validate a buffer for LaTeX.
277 This validates the buffer, and returns a struct for use by
278 makeLaTeX and others. Its main use is to figure out what
279 commands and packages need to be included in the LaTeX file.
280 It (should) also check that the needed constructs are there
281 (i.e. that the \refs points to coresponding \labels). It
282 should perhaps inset "error" insets to help the user correct
285 void validate(LaTeXFeatures &) const;
288 string getIncludeonlyList(char delim = ',');
290 std::vector<std::pair<string,string> > getBibkeyList();
309 std::vector<std::vector<TocItem> > getTocList();
311 std::vector<string> getLabelList();
313 /** This will clearly have to change later. Later we can have more
314 than one user per buffer. */
315 BufferView * getUser() const { return users; }
318 void ChangeLanguage(Language const * from, Language const * to);
320 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 const depth);
359 void DocBookHandleCaption(std::ostream & os, string & inner_tag,
360 int const depth, int desc_on,
361 LyXParagraph * & par);
364 void DocBookHandleFootnote(std::ostream & os,
365 LyXParagraph * & par, int const 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, char const * message);
376 void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par,
377 int desc_on, int const depth);
379 void SimpleDocBookOnePar(std::ostream &, string & extra,
380 LyXParagraph * par, int & desc_on,
384 void push_tag(std::ostream & os, char const * tag,
385 int & pos, char stack[5][3]);
388 void pop_tag(std::ostream & os, char const * tag,
389 int & pos, char stack[5][3]);
392 mutable bool lyx_clean;
394 /// is autosave needed
395 mutable bool bak_clean;
397 /// do we need to run weave/tangle
400 /// is regenerating .tex necessary
401 DEPCLEAN * dep_clean;
406 /// name of the file the buffer is associated with.
409 /// 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.
422 class inset_iterator {
424 inset_iterator() : par(0) /*, it(0)*/ {}
425 inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
428 inset_iterator(LyXParagraph * paragraph, LyXParagraph::size_type pos);
429 inset_iterator & operator++() {
432 if (it == par->inset_iterator_end()) {
439 Inset * operator*() {return *it; }
440 LyXParagraph * getPar() { return par; }
441 LyXParagraph::size_type getPos() {return it.getPos(); }
443 bool operator==(inset_iterator const & iter1,
444 inset_iterator const & iter2) {
445 return iter1.par == iter2.par
446 && (iter1.par == 0 || iter1.it == iter2.it);
449 bool operator!=(inset_iterator const & iter1,
450 inset_iterator const & iter2) {
451 return !(iter1 == iter2);
456 LyXParagraph::inset_iterator it;
460 inset_iterator inset_iterator_begin() {
461 return inset_iterator(paragraph);
464 inset_iterator inset_iterator_end() {
465 return inset_iterator();
471 void Buffer::setParentName(string const & name)
473 params.parentname = name;
477 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
478 return a.par == b.par && a.str == b.str;
479 // No need to compare depth.
484 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
486 // No need to compare depth.