src/buffer.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *           Copyright 1995 Matthias Ettrich
   7  *
   8  *           This file is Copyleft 1996
   9  *           Lars Gullik Bjønnes
  10  *
  11  * ====================================================== */
  12
  13 #ifndef BUFFER_H
  14 #define BUFFER_H
  15
  16 #ifdef __GNUG__
  17 #pragma interface
  18 #endif
  19
  20 #include "LString.h"
  21 #include "undo.h"
  22 #include "support/limited_stack.h"
  23
  24 #include "lyxvc.h"
  25 #include "bufferparams.h"
  26 #include "texrow.h"
  27 #include "ParagraphList.h"
  28 #include "paragraph.h"
  29
  30 #include <boost/scoped_ptr.hpp>
  31 #include <boost/shared_ptr.hpp>
  32
  33 class BufferView;
  34 class Counters;
  35 class LyXRC;
  36 class TeXErrors;
  37 class LaTeXFeatures;
  38 class Language;
  39 class ParIterator;
  40
  41 #define NO_COMPABILITY 1
  42
  43 ///
  44 struct DEPCLEAN {
  45         ///
  46         bool clean;
  47         ///
  48         string master;
  49         ///
  50         DEPCLEAN * next;
  51 };
  52
  53 /** The buffer object.
  54   This 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.
  57   \author Lars Gullik Bjønnes
  58   */
  59 class Buffer {
  60 public:
  61         /// What type of log will \c getLogName() return?
  62         enum LogType {
  63                 latexlog, ///< LaTeX log
  64                 buildlog  ///< Literate build log
  65         };
  66
  67         /** Constructor
  68             \param file
  69             \param b  optional \c false by default
  70         */
  71         explicit Buffer(string const & file, bool b = false);
  72
  73         /// Destructor
  74         ~Buffer();
  75
  76         /** High-level interface to buffer functionality.
  77             This function parses a command string and executes it
  78         */
  79         bool dispatch(string const & command, bool * result = 0);
  80
  81         /// Maybe we know the function already by number...
  82         bool dispatch(int ac, string const & argument, bool * result = 0);
  83
  84         ///
  85         void resizeInsets(BufferView *);
  86
  87         /// Update window titles of all users.
  88         void updateTitles() const;
  89
  90         /// Reset autosave timers for all users.
  91         void resetAutosaveTimers() const;
  92
  93         /** Adds the BufferView to the users list.
  94             Later this func will insert the \c BufferView into a real list,
  95             not just setting a pointer.
  96         */
  97         void addUser(BufferView * u);
  98
  99         /** Removes the #BufferView# from the users list.
 100             Since we only can have one at the moment, we just reset it.
 101         */
 102         void delUser(BufferView *);
 103
 104         ///
 105         void redraw();
 106
 107         /// Load the autosaved file.
 108         void loadAutoSaveFile();
 109
 110         /** Reads a file.
 111             \param par if != 0 insert the file.
 112             \return \c false if method fails.
 113         */
 114         bool readFile(LyXLex &, Paragraph * par = 0);
 115
 116         /** Reads a file without header.
 117             \param par if != 0 insert the file.
 118             \return \c false if file is not completely read.
 119         */
 120         bool readLyXformat2(LyXLex &, Paragraph * par = 0);
 121
 122         /// This parses a single LyXformat-Token.
 123         bool parseSingleLyXformat2Token(LyXLex &, Paragraph *& par,
 124                                         Paragraph *& return_par,
 125                                         string const & token, int & pos,
 126                                         Paragraph::depth_type & depth,
 127                                         LyXFont &);
 128         ///
 129         void insertStringAsLines(Paragraph *&, lyx::pos_type &,
 130                                  LyXFont const &, string const &) const;
 131 #ifndef NO_COMPABILITY
 132         ///
 133         Inset * isErtInset(Paragraph * par, int pos) const;
 134         ///
 135         void insertErtContents(Paragraph * par, int & pos,
 136                                bool set_inactive = true);
 137 #endif
 138         ///
 139         Paragraph * getParFromID(int id) const;
 140 private:
 141         /// Parse a single inset.
 142         void readInset(LyXLex &, Paragraph *& par, int & pos, LyXFont &);
 143 public:
 144         /** Save file.
 145             Takes care of auto-save files and backup file if requested.
 146             Returns \c true if the save is successful, \c false otherwise.
 147         */
 148         bool save() const;
 149
 150         /// Write file. Returns \c false if unsuccesful.
 151         bool writeFile(string const &) const;
 152
 153         ///
 154         void writeFileAscii(string const & , int);
 155         ///
 156         void writeFileAscii(std::ostream &, int);
 157         ///
 158         string const asciiParagraph(Paragraph const *, unsigned int linelen,
 159                                     bool noparbreak = false) const;
 160         /// Just a wrapper for the method below, first creating the ofstream.
 161         void makeLaTeXFile(string const & filename,
 162                            string const & original_path,
 163                            bool nice,
 164                            bool only_body = false,
 165                            bool only_preamble = false);
 166         ///
 167         void makeLaTeXFile(std::ostream & os,
 168                            string const & original_path,
 169                            bool nice,
 170                            bool only_body = false,
 171                            bool only_preamble = false);
 172         /** LaTeX all paragraphs from par to endpar.
 173             \param \a endpar if == 0 then to the end
 174         */
 175         void latexParagraphs(std::ostream & os, Paragraph * par,
 176                              Paragraph * endpar, TexRow & texrow, bool moving_arg = false) const;
 177         ///
 178         void simpleDocBookOnePar(std::ostream &,
 179                                  Paragraph * par, int & desc_on,
 180                                  Paragraph::depth_type depth) const ;
 181         ///
 182         void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par,
 183                                   Paragraph::depth_type depth);
 184         ///
 185         void makeLinuxDocFile(string const & filename,
 186                               bool nice, bool only_body = false);
 187         ///
 188         void makeDocBookFile(string const & filename,
 189                              bool nice, bool only_body = false);
 190         /// Open SGML/XML tag.
 191         int sgmlOpenTag(std::ostream & os, Paragraph::depth_type depth, bool mixcont,
 192                 string const & latexname) const;
 193         /// Closes SGML/XML tag.
 194         int sgmlCloseTag(std::ostream & os, Paragraph::depth_type depth, bool mixcont,
 195                 string const & latexname) const;
 196         ///
 197         void sgmlError(Paragraph * par, int pos, string const & message) const;
 198
 199         /// returns the main language for the buffer (document)
 200         Language const * getLanguage() const;
 201         ///
 202         int runChktex();
 203         /// return true if the main lyx file does not need saving
 204         bool isClean() const;
 205         ///
 206         bool isBakClean() const;
 207         ///
 208         bool isDepClean(string const & name) const;
 209
 210         /// mark the main lyx file as not needing saving
 211         void markClean() const;
 212
 213         ///
 214         void markBakClean();
 215
 216         ///
 217         void markDepClean(string const & name);
 218
 219         ///
 220         void setUnnamed(bool flag = true);
 221
 222         ///
 223         bool isUnnamed();
 224
 225         /// Mark this buffer as dirty.
 226         void markDirty();
 227
 228         /// Returns the buffer's filename. It is always an absolute path.
 229         string const & fileName() const;
 230
 231         /// Returns the the path where the buffer lives.
 232         /// It is always an absolute path.
 233         string const & filePath() const;
 234
 235         /** A transformed version of the file name, adequate for LaTeX.
 236             \param no_path optional if \c true then the path is stripped.
 237         */
 238         string const getLatexName(bool no_path = true) const;
 239
 240         /// Get the name and type of the log.
 241         std::pair<LogType, string> const getLogName() const;
 242
 243         /// Change name of buffer. Updates "read-only" flag.
 244         void setFileName(string const & newfile);
 245
 246         /// Name of the document's parent
 247         void setParentName(string const &);
 248
 249         /// Is buffer read-only?
 250         bool isReadonly() const;
 251
 252         /// Set buffer read-only flag
 253         void setReadonly(bool flag = true);
 254
 255         /// returns \c true if the buffer contains a LaTeX document
 256         bool isLatex() const;
 257         /// returns \c true if the buffer contains a LinuxDoc document
 258         bool isLinuxDoc() const;
 259         /// returns \c true if the buffer contains a DocBook document
 260         bool isDocBook() const;
 261         /** returns \c true if the buffer contains either a LinuxDoc
 262             or DocBook document */
 263         bool isSGML() const;
 264         /// returns \c true if the buffer contains a Wed document
 265         bool isLiterate() const;
 266
 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
 274             obvious mistakes.
 275         */
 276         void validate(LaTeXFeatures &) const;
 277
 278         ///
 279         string const getIncludeonlyList(char delim = ',');
 280         ///
 281         std::vector<std::pair<string, string> > const getBibkeyList() const;
 282         ///
 283         std::vector<string> const getLabelList() const;
 284
 285         /** This will clearly have to change later. Later we can have more
 286             than one user per buffer. */
 287         BufferView * getUser() const;
 288
 289         ///
 290         void changeLanguage(Language const * from, Language const * to);
 291         ///
 292         bool isMultiLingual();
 293
 294         /// Does this mean that this is buffer local?
 295         limited_stack<boost::shared_ptr<Undo> > undostack;
 296
 297         /// Does this mean that this is buffer local?
 298         limited_stack<boost::shared_ptr<Undo> > redostack;
 299
 300         ///
 301         BufferParams params;
 302
 303         /** The list of paragraphs.
 304             This is a linked list of paragraph, this list holds the
 305             whole contents of the document.
 306          */
 307         ParagraphList paragraphs;
 308
 309         /// LyX version control object.
 310         LyXVC lyxvc;
 311
 312         /// Where to put temporary files.
 313         string tmppath;
 314
 315         /** If we are writing a nice LaTeX file or not.
 316             While writing as LaTeX, tells whether we are
 317             doing a 'nice' LaTeX file */
 318         bool niceFile;
 319
 320         /// Used when typesetting to place errorboxes.
 321         TexRow texrow;
 322         /// Buffer-wide counter array
 323         Counters & counters() const;
 324
 325 private:
 326         /// is save needed
 327         mutable bool lyx_clean;
 328
 329         /// is autosave needed
 330         mutable bool bak_clean;
 331
 332         /// is this a unnamed file (New...)
 333         bool unnamed;
 334
 335         /// is regenerating #.tex# necessary
 336         DEPCLEAN * dep_clean;
 337
 338         /// buffer is r/o
 339         bool read_only;
 340
 341         /// name of the file the buffer is associated with.
 342         string filename_;
 343
 344         /// The path to the document file.
 345         string filepath_;
 346
 347         /// Format number of buffer
 348         int file_format;
 349         /** A list of views using this buffer.
 350             Why not keep a list of the BufferViews that use this buffer?
 351
 352             At least then we don't have to do a lot of magic like:
 353             #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
 354             of the buffers in the list of users to do a #updateLayoutChoice#.
 355         */
 356         BufferView * users;
 357
 358         /// The pointer is const although its contents may not be
 359         boost::scoped_ptr<Counters> const ctrs;
 360
 361 public:
 362         ///
 363         class inset_iterator {
 364         public:
 365                 typedef std::input_iterator_tag iterator_category;
 366                 typedef Inset value_type;
 367                 typedef ptrdiff_t difference_type;
 368                 typedef Inset * pointer;
 369                 typedef Inset & reference;
 370
 371
 372                 ///
 373                 inset_iterator() : par(0) /*, it(0)*/ {}
 374                 //
 375                 inset_iterator(Paragraph * paragraph) : par(paragraph) {
 376                         setParagraph();
 377                 }
 378                 ///
 379                 inset_iterator(Paragraph * paragraph, lyx::pos_type pos);
 380                 ///
 381                 inset_iterator & operator++() { // prefix ++
 382                         if (par) {
 383                                 ++it;
 384                                 if (it == par->insetlist.end()) {
 385                                         par = par->next();
 386                                         setParagraph();
 387                                 }
 388                         }
 389                         return *this;
 390                 }
 391                 ///
 392                 inset_iterator operator++(int) { // postfix ++
 393                         inset_iterator tmp(par, it.getPos());
 394                         if (par) {
 395                                 ++it;
 396                                 if (it == par->insetlist.end()) {
 397                                         par = par->next();
 398                                         setParagraph();
 399                                 }
 400                         }
 401                         return tmp;
 402                 }
 403
 404                 ///
 405                 Inset * operator*() { return it.getInset(); }
 406
 407                 ///
 408                 Paragraph * getPar() { return par; }
 409                 ///
 410                 lyx::pos_type getPos() const { return it.getPos(); }
 411                 ///
 412                 friend
 413                 bool operator==(inset_iterator const & iter1,
 414                                 inset_iterator const & iter2);
 415         private:
 416                 ///
 417                 void setParagraph();
 418                 ///
 419                 Paragraph * par;
 420                 ///
 421                 InsetList::iterator it;
 422         };
 423
 424         ///
 425         inset_iterator inset_iterator_begin() {
 426                 return inset_iterator(&*paragraphs.begin());
 427         }
 428         ///
 429         inset_iterator inset_iterator_end() {
 430                 return inset_iterator();
 431         }
 432         ///
 433         inset_iterator inset_const_iterator_begin() const {
 434                 return inset_iterator(&*paragraphs.begin());
 435         }
 436         ///
 437         inset_iterator inset_const_iterator_end() const {
 438                 return inset_iterator();
 439         }
 440
 441         ///
 442         ParIterator par_iterator_begin();
 443         ///
 444         ParIterator par_iterator_end();
 445
 446         ///
 447         Inset * getInsetFromID(int id_arg) const;
 448 };
 449
 450
 451 inline
 452 void Buffer::addUser(BufferView * u)
 453 {
 454         users = u;
 455 }
 456
 457
 458 inline
 459 void Buffer::delUser(BufferView *)
 460 {
 461         users = 0;
 462 }
 463
 464
 465 inline
 466 Language const * Buffer::getLanguage() const
 467 {
 468         return params.language;
 469 }
 470
 471
 472 inline
 473 bool Buffer::isClean() const
 474 {
 475         return lyx_clean;
 476 }
 477
 478
 479 inline
 480 bool Buffer::isBakClean() const
 481 {
 482         return bak_clean;
 483 }
 484
 485
 486 inline
 487 void Buffer::markClean() const
 488 {
 489         if (!lyx_clean) {
 490                 lyx_clean = true;
 491                 updateTitles();
 492         }
 493         // if the .lyx file has been saved, we don't need an
 494         // autosave
 495         bak_clean = true;
 496 }
 497
 498
 499 inline
 500 void Buffer::markBakClean()
 501 {
 502         bak_clean = true;
 503 }
 504
 505
 506 inline
 507 void Buffer::setUnnamed(bool flag)
 508 {
 509         unnamed = flag;
 510 }
 511
 512
 513 inline
 514 bool Buffer::isUnnamed()
 515 {
 516         return unnamed;
 517 }
 518
 519
 520 inline
 521 void Buffer::markDirty()
 522 {
 523         if (lyx_clean) {
 524                 lyx_clean = false;
 525                 updateTitles();
 526         }
 527         bak_clean = false;
 528         DEPCLEAN * tmp = dep_clean;
 529         while (tmp) {
 530                 tmp->clean = false;
 531                 tmp = tmp->next;
 532         }
 533 }
 534
 535
 536 inline
 537 string const & Buffer::fileName() const
 538 {
 539         return filename_;
 540 }
 541
 542
 543 inline
 544 string const & Buffer::filePath() const
 545 {
 546         return filepath_;
 547 }
 548
 549
 550 inline
 551 bool Buffer::isReadonly() const
 552 {
 553         return read_only;
 554 }
 555
 556
 557 inline
 558 BufferView * Buffer::getUser() const
 559 {
 560         return users;
 561 }
 562
 563
 564 inline
 565 void Buffer::setParentName(string const & name)
 566 {
 567         params.parentname = name;
 568 }
 569
 570
 571 ///
 572 inline
 573 bool operator==(Buffer::inset_iterator const & iter1,
 574                 Buffer::inset_iterator const & iter2)
 575 {
 576         return iter1.par == iter2.par
 577                 && (iter1.par == 0 || iter1.it == iter2.it);
 578 }
 579
 580
 581 ///
 582 inline
 583 bool operator!=(Buffer::inset_iterator const & iter1,
 584                 Buffer::inset_iterator const & iter2)
 585 {
 586         return !(iter1 == iter2);
 587 }
 588
 589 #endif