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.
93 /// Update window titles of all users
94 void updateTitles() const;
96 /// Reset autosave timers for all users
97 void resetAutosaveTimers() const;
99 /** Adds the BufferView to the users list.
100 Later this func will insert the BufferView into a real list,
101 not just setting a pointer.
103 void addUser(BufferView * u) { users = u; }
105 /** Removes the BufferView from the users list.
106 Since we only can have one at the moment, we just reset it.
108 void delUser(BufferView *) { users = 0; }
114 //users->updateScrollbar();
118 void loadAutoSaveFile();
121 Returns false if it fails.
122 If par is given, the file is inserted. */
123 bool readFile(LyXLex &, LyXParagraph * par = 0);
125 /** Reads a file without header.
126 Returns false, if file is not completely read.
127 If par is given, the file is inserted. */
128 bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
130 /* This parses a single LyXformat-Token */
131 bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
132 LyXParagraph *& return_par,
133 string const & token, int & pos,
134 char & depth, LyXFont &,
135 LyXParagraph::footnote_flag &,
136 LyXParagraph::footnote_kind &);
139 Takes care of auto-save files and backup file if requested.
140 Returns true if the save is successful, false otherwise.
144 /// Write file. Returns false if unsuccesful.
145 bool writeFile(string const &, bool) const;
148 void writeFileAscii(string const & , int);
151 void makeLaTeXFile(string const & filename,
152 string const & original_path,
153 bool nice, bool only_body = false);
155 // LaTeX all paragraphs from par to endpar,
156 // if endpar == 0 then to the end
158 void latexParagraphs(std::ostream & os, LyXParagraph *par,
159 LyXParagraph *endpar, TexRow & texrow) const;
174 void makeLinuxDocFile(string const & filename, int column);
176 void makeDocBookFile(string const & filename, int column);
178 /// returns the main language for the buffer (document)
179 string GetLanguage() const {
180 return params.language;
184 bool isLyxClean() const { return lyx_clean; }
187 bool isNwClean() const { return nw_clean; }
190 bool isBakClean() const { return bak_clean; }
193 bool isDepClean(string const & name) const;
196 void markLyxClean() const {
201 // if the .lyx file has been saved, we don't need an
207 void markNwClean() { nw_clean = true; }
210 void markBakClean() { bak_clean = true; }
213 void markDepClean(string const & name);
216 void markNwDirty() { nw_clean = false; }
226 DEPCLEAN * tmp = dep_clean;
234 string const & fileName() const { return filename; }
236 /** A transformed version of the file name, adequate for LaTeX
237 The path is stripped if no_path is true (default) */
238 string getLatexName(bool no_path = true) const;
240 /// Change name of buffer. Updates "read-only" flag.
241 void fileName(string const & newfile);
243 /// Name of the document's parent
244 void setParentName(string const &);
246 /// Is buffer read-only?
247 bool isReadonly() const { return read_only; }
249 /// Set buffer read-only flag
250 void setReadonly(bool flag = true);
252 /// returns true if the buffer contains a LaTeX document
253 bool isLatex() const;
254 /// returns true if the buffer contains a LinuxDoc document
255 bool isLinuxDoc() const;
256 /// returns true if the buffer contains a DocBook document
257 bool isDocBook() const;
258 /** returns true if the buffer contains either a LinuxDoc
259 or DocBook document */
261 /// returns true if the buffer contains a Wed document
262 bool isLiterate() const;
265 void setPaperStuff();
267 /** Validate a buffer for LaTeX.
268 This validates the buffer, and returns a struct for use by
269 makeLaTeX and others. Its main use is to figure out what
270 commands and packages need to be included in the LaTeX file.
271 It (should) also check that the needed constructs are there
272 (i.e. that the \refs points to coresponding \labels). It
273 should perhaps inset "error" insets to help the user correct
276 void validate(LaTeXFeatures &) const;
279 string getIncludeonlyList(char delim = ',');
281 std::vector<std::pair<string,string> > getBibkeyList();
300 std::vector<std::vector<TocItem> > getTocList();
302 std::vector<string> getLabelList();
304 /** This will clearly have to change later. Later we can have more
305 than one user per buffer. */
306 BufferView * getUser() const { return users; }
309 void ChangeLanguage(Language const * from, Language const * to);
311 bool isMultiLingual();
315 /// Does this mean that this is buffer local?
318 /// Does this mean that this is buffer local?
324 /** is a list of paragraphs.
326 LyXParagraph * paragraph;
331 /// where the temporaries go if we want them
337 /** While writing as LaTeX, tells whether we are
338 doing a 'nice' LaTeX file */
341 /// Used when typesetting to place errorboxes.
345 void linuxDocHandleFootnote(std::ostream & os,
346 LyXParagraph * & par, int const depth);
348 void DocBookHandleCaption(std::ostream & os, string & inner_tag,
349 int const depth, int desc_on,
350 LyXParagraph * & par);
352 void DocBookHandleFootnote(std::ostream & os,
353 LyXParagraph * & par, int const depth);
355 void sgmlOpenTag(std::ostream & os, int depth,
356 string const & latexname) const;
358 void sgmlCloseTag(std::ostream & os, int depth,
359 string const & latexname) const;
361 void LinuxDocError(LyXParagraph * par, int pos, char const * message);
363 void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par,
364 int desc_on, int const depth);
366 void SimpleDocBookOnePar(std::ostream &, string & extra,
367 LyXParagraph * par, int & desc_on,
371 void push_tag(std::ostream & os, char const * tag,
372 int & pos, char stack[5][3]);
375 void pop_tag(std::ostream & os, char const * tag,
376 int & pos, char stack[5][3]);
380 void RoffAsciiTable(std::ostream &, LyXParagraph * par);
384 mutable bool lyx_clean;
386 /// is autosave needed
387 mutable bool bak_clean;
389 /// do we need to run weave/tangle
392 /// is regenerating .tex necessary
393 DEPCLEAN * dep_clean;
398 /// name of the file the buffer is associated with.
401 /// Format number of buffer
404 /** A list of views using this buffer.
405 Why not keep a list of the BufferViews that use this buffer?
407 At least then we don't have to do a lot of magic like:
408 buffer->lyx_gui->bufferview->updateLayoutChoice. Just ask each
409 of the buffers in the list of users to do a updateLayoutChoice.
414 class inset_iterator {
416 inset_iterator() : par(0) /*, it(0)*/ {}
417 inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
420 inset_iterator(LyXParagraph * paragraph, LyXParagraph::size_type pos);
421 inset_iterator & operator++() {
424 if (it == par->inset_iterator_end()) {
431 Inset * operator*() {return *it; }
432 LyXParagraph * getPar() { return par; }
433 LyXParagraph::size_type getPos() {return it.getPos(); }
435 bool operator==(inset_iterator const & iter1,
436 inset_iterator const & iter2) {
437 return iter1.par == iter2.par
438 && (iter1.par == 0 || iter1.it == iter2.it);
441 bool operator!=(inset_iterator const & iter1,
442 inset_iterator const & iter2) {
443 return !(iter1 == iter2);
448 LyXParagraph::inset_iterator it;
452 inset_iterator inset_iterator_begin() {
453 return inset_iterator(paragraph);
456 inset_iterator inset_iterator_end() {
457 return inset_iterator();
463 void Buffer::setParentName(string const & name)
465 params.parentname = name;
469 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
470 return a.par == b.par && a.str == b.str;
471 // No need to compare depth.
476 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
478 // No need to compare depth.