src/Buffer.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Buffer.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef BUFFER_H
  13 #define BUFFER_H
  14
  15 #include "OutputEnums.h"
  16
  17 #include "insets/InsetCode.h"
  18
  19 #include "support/strfwd.h"
  20 #include "support/types.h"
  21
  22 #include <list>
  23 #include <set>
  24 #include <string>
  25 #include <vector>
  26
  27
  28 namespace lyx {
  29
  30 class BiblioInfo;
  31 class BufferParams;
  32 class BufferSet;
  33 class DispatchResult;
  34 class DocIterator;
  35 class docstring_list;
  36 class ErrorList;
  37 class FuncRequest;
  38 class FuncStatus;
  39 class Inset;
  40 class InsetLabel;
  41 class InsetRef;
  42 class Font;
  43 class Format;
  44 class Lexer;
  45 class Text;
  46 class LyXVC;
  47 class LaTeXFeatures;
  48 class Language;
  49 class MacroData;
  50 class MacroNameSet;
  51 class MacroSet;
  52 class OutputParams;
  53 class Paragraph;
  54 class ParConstIterator;
  55 class ParIterator;
  56 class ParagraphList;
  57 class TeXErrors;
  58 class TexRow;
  59 class TocBackend;
  60 class Undo;
  61 class WordLangTuple;
  62
  63 namespace frontend {
  64 class GuiBufferDelegate;
  65 class WorkAreaManager;
  66 }
  67
  68 namespace support {
  69 class FileName;
  70 class FileNameList;
  71 }
  72
  73 /** The buffer object.
  74  * This is the buffer object. It contains all the informations about
  75  * a document loaded into LyX.
  76  * The buffer object owns the Text (wrapped in an InsetText), which
  77  * contains the individual paragraphs of the document.
  78  *
  79  *
  80  * I am not sure if the class is complete or
  81  * minimal, probably not.
  82  * \author Lars Gullik Bjønnes
  83  */
  84 class Buffer {
  85 public:
  86         /// What type of log will \c getLogName() return?
  87         enum LogType {
  88                 latexlog, ///< LaTeX log
  89                 buildlog  ///< Literate build log
  90         };
  91
  92         /// Result of \c readFile()
  93         enum ReadStatus {
  94                 failure, ///< The file could not be read
  95                 success, ///< The file could not be read
  96                 wrongversion ///< The version of the file does not match ours
  97         };
  98
  99
 100         /// Method to check if a file is externally modified, used by
 101         /// isExternallyModified()
 102         /**
 103          * timestamp is fast but inaccurate. For example, the granularity
 104          * of timestamp on a FAT filesystem is 2 second. Also, various operations
 105          * may touch the timestamp of a file even when its content is unchanged.
 106          *
 107          * checksum is accurate but slow, which can be a problem when it is
 108          * frequently used, or used for a large file on a slow (network) file
 109          * system.
 110          *
 111          * FIXME: replace this method with support/FileMonitor.
 112          */
 113         enum CheckMethod {
 114                 checksum_method,  ///< Use file checksum
 115                 timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
 116         };
 117
 118         ///
 119         enum UpdateScope {
 120                 UpdateMaster,
 121                 UpdateChildOnly
 122         };
 123
 124         /// Constructor
 125         explicit Buffer(std::string const & file, bool readonly = false,
 126                 Buffer const * cloned_buffer = 0);
 127
 128         /// Destructor
 129         ~Buffer();
 130
 131         ///
 132         Buffer * clone() const;
 133         ///
 134         bool isClone() const;
 135
 136         /** High-level interface to buffer functionality.
 137             This function parses a command string and executes it.
 138         */
 139         void dispatch(std::string const & command, DispatchResult & result);
 140
 141         /// Maybe we know the function already by number...
 142         void dispatch(FuncRequest const & func, DispatchResult & result);
 143
 144         /// Can this function be exectued?
 145         /// \return true if we made a decision
 146         bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
 147
 148         /// read a new document from a string
 149         bool readString(std::string const &);
 150         /// load a new file
 151         bool readFile(support::FileName const & filename);
 152
 153         /// read the header, returns number of unknown tokens
 154         int readHeader(Lexer & lex);
 155
 156         /** Reads a file without header.
 157             \param par if != 0 insert the file.
 158             \return \c true if file is not completely read.
 159         */
 160         bool readDocument(Lexer &);
 161
 162         ///
 163         DocIterator getParFromID(int id) const;
 164         /// do we have a paragraph with this id?
 165         bool hasParWithID(int id) const;
 166
 167         ///
 168         frontend::WorkAreaManager & workAreaManager() const;
 169
 170         /** Save file.
 171             Takes care of auto-save files and backup file if requested.
 172             Returns \c true if the save is successful, \c false otherwise.
 173         */
 174         bool save() const;
 175
 176         /// Write document to stream. Returns \c false if unsuccesful.
 177         bool write(std::ostream &) const;
 178         /// save emergency file
 179         /// \return a status message towards the user.
 180         docstring emergencyWrite();
 181         /// Write file. Returns \c false if unsuccesful.
 182         bool writeFile(support::FileName const &) const;
 183
 184         /// Loads LyX file \c filename into buffer, *  and return success
 185         bool loadLyXFile(support::FileName const & s);
 186         /// Reloads the LyX file
 187         bool reload();
 188
 189         /// Fill in the ErrorList with the TeXErrors
 190         void bufferErrors(TeXErrors const &, ErrorList &) const;
 191
 192         /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
 193         bool makeLaTeXFile(support::FileName const & filename,
 194                            std::string const & original_path,
 195                            OutputParams const &,
 196                            bool output_preamble = true,
 197                            bool output_body = true) const;
 198         /** Export the buffer to LaTeX.
 199             If \p os is a file stream, and params().inputenc is "auto" or
 200             "default", and the buffer contains text in different languages
 201             with more than one encoding, then this method will change the
 202             encoding associated to \p os. Therefore you must not call this
 203             method with a string stream if the output is supposed to go to a
 204             file. \code
 205             ofdocstream ofs;
 206             ofs.open("test.tex");
 207             writeLaTeXSource(ofs, ...);
 208             ofs.close();
 209             \endcode is NOT equivalent to \code
 210             odocstringstream oss;
 211             writeLaTeXSource(oss, ...);
 212             ofdocstream ofs;
 213             ofs.open("test.tex");
 214             ofs << oss.str();
 215             ofs.close();
 216             \endcode
 217          */
 218         void writeLaTeXSource(odocstream & os,
 219                            std::string const & original_path,
 220                            OutputParams const &,
 221                            bool output_preamble = true,
 222                            bool output_body = true) const;
 223         ///
 224         void makeDocBookFile(support::FileName const & filename,
 225                              OutputParams const & runparams_in,
 226                              bool only_body = false) const;
 227         ///
 228         void writeDocBookSource(odocstream & os, std::string const & filename,
 229                              OutputParams const & runparams_in,
 230                              bool only_body = false) const;
 231         ///
 232         void makeLyXHTMLFile(support::FileName const & filename,
 233                              OutputParams const & runparams_in,
 234                              bool only_body = false) const;
 235         ///
 236         void writeLyXHTMLSource(odocstream & os,
 237                              OutputParams const & runparams_in,
 238                              bool only_body = false) const;
 239         /// returns the main language for the buffer (document)
 240         Language const * language() const;
 241         /// get l10n translated to the buffers language
 242         docstring const B_(std::string const & l10n) const;
 243
 244         ///
 245         int runChktex();
 246         /// return true if the main lyx file does not need saving
 247         bool isClean() const;
 248         ///
 249         bool isDepClean(std::string const & name) const;
 250
 251         /// whether or not disk file has been externally modified
 252         bool isExternallyModified(CheckMethod method) const;
 253
 254         /// save timestamp and checksum of the given file.
 255         void saveCheckSum(support::FileName const & file) const;
 256
 257         /// mark the main lyx file as not needing saving
 258         void markClean() const;
 259
 260         ///
 261         void markDepClean(std::string const & name);
 262
 263         ///
 264         void setUnnamed(bool flag = true);
 265
 266         /// Whether or not a filename has been assigned to this buffer
 267         bool isUnnamed() const;
 268
 269         /// Whether or not this buffer is internal.
 270         ///
 271         /// An internal buffer does not contain a real document, but some auxiliary text segment.
 272         /// It is not associated with a filename, it is never saved, thus it does not need to be
 273         /// automatically saved, nor it needs to trigger any "do you want to save ?" question.
 274         bool isInternal() const;
 275
 276         /// Mark this buffer as dirty.
 277         void markDirty();
 278
 279         /// Returns the buffer's filename. It is always an absolute path.
 280         support::FileName fileName() const;
 281
 282         /// Returns the buffer's filename. It is always an absolute path.
 283         std::string absFileName() const;
 284
 285         /// Returns the the path where the buffer lives.
 286         /// It is always an absolute path.
 287         std::string filePath() const;
 288
 289         /** A transformed version of the file name, adequate for LaTeX.
 290             \param no_path optional if \c true then the path is stripped.
 291         */
 292         std::string latexName(bool no_path = true) const;
 293
 294         /// Get the name and type of the log.
 295         std::string logName(LogType * type = 0) const;
 296
 297         /// Change name of buffer. Updates "read-only" flag.
 298         void setFileName(std::string const & newfile);
 299
 300         /// Set document's parent Buffer.
 301         void setParent(Buffer const *);
 302         Buffer const * parent() const;
 303
 304         // Collect all relative buffer
 305         std::vector<Buffer const *> allRelatives() const;
 306
 307         /** Get the document's master (or \c this if this is not a
 308             child document)
 309          */
 310         Buffer const * masterBuffer() const;
 311
 312         /// \return true if \p child is a child of this \c Buffer.
 313         bool isChild(Buffer * child) const;
 314
 315         /// return a vector with all children (and grandchildren)
 316         std::vector<Buffer *> getChildren(bool grand_children = true) const;
 317
 318         /// Add all children (and grandchildren) to supplied vector
 319         void getChildren(std::vector<Buffer *> & children, bool grand_children = true) const;
 320
 321         /// Is buffer read-only?
 322         bool isReadonly() const;
 323
 324         /// Set buffer read-only flag
 325         void setReadonly(bool flag = true);
 326
 327         /// returns \c true if the buffer contains a LaTeX document
 328         bool isLatex() const;
 329         /// returns \c true if the buffer contains a DocBook document
 330         bool isDocBook() const;
 331         /// returns \c true if the buffer contains a Wed document
 332         bool isLiterate() const;
 333
 334         /** Validate a buffer for LaTeX.
 335             This validates the buffer, and returns a struct for use by
 336             #makeLaTeX# and others. Its main use is to figure out what
 337             commands and packages need to be included in the LaTeX file.
 338             It (should) also check that the needed constructs are there
 339             (i.e. that the \refs points to coresponding \labels). It
 340             should perhaps inset "error" insets to help the user correct
 341             obvious mistakes.
 342         */
 343         void validate(LaTeXFeatures &) const;
 344
 345         /// Information from BibTeX databases is cached in the Buffer, so
 346         /// we do not have to read the file over and over.
 347         /// Calling this method invalidates the cache and so requires a
 348         /// re-read.
 349         void invalidateBibinfoCache();
 350         /// This invalidates the cache of files we need to check.
 351         void invalidateBibfileCache();
 352         /// Updates the cached bibliography information.
 353         /// Note that you MUST call this method to update the cache. It will
 354         /// not happen otherwise. (Currently, it is called at the start of
 355         /// updateBuffer() and from GuiCitation.)
 356         void checkBibInfoCache() const;
 357         /// \return the bibliography information for this buffer's master,
 358         /// or just for it, if it isn't a child.
 359         BiblioInfo const & masterBibInfo() const;
 360         /// \return the bibliography information for this buffer ONLY.
 361         BiblioInfo const & localBibInfo() const;
 362         ///
 363         void getLabelList(std::vector<docstring> &) const;
 364
 365         ///
 366         void changeLanguage(Language const * from, Language const * to);
 367
 368         ///
 369         bool isMultiLingual() const;
 370         ///
 371         std::set<Language const *> getLanguages() const;
 372
 373         ///
 374         BufferParams & params();
 375         BufferParams const & params() const;
 376
 377         /** The list of paragraphs.
 378             This is a linked list of paragraph, this list holds the
 379             whole contents of the document.
 380          */
 381         ParagraphList & paragraphs();
 382         ParagraphList const & paragraphs() const;
 383
 384         /// LyX version control object.
 385         LyXVC & lyxvc();
 386         LyXVC const & lyxvc() const;
 387
 388         /// Where to put temporary files.
 389         std::string const temppath() const;
 390
 391         /// Used when typesetting to place errorboxes.
 392         TexRow const & texrow() const;
 393         TexRow & texrow();
 394
 395         ///
 396         ParIterator par_iterator_begin();
 397         ///
 398         ParConstIterator par_iterator_begin() const;
 399         ///
 400         ParIterator par_iterator_end();
 401         ///
 402         ParConstIterator par_iterator_end() const;
 403
 404         // Position of the child buffer where it appears first in the master.
 405         DocIterator firstChildPosition(Buffer const * child);
 406
 407         /** \returns true only when the file is fully loaded.
 408          *  Used to prevent the premature generation of previews
 409          *  and by the citation inset.
 410          */
 411         bool isFullyLoaded() const;
 412         /// Set by buffer_funcs' newFile.
 413         void setFullyLoaded(bool);
 414
 415         /// Our main text (inside the top InsetText)
 416         Text & text() const;
 417
 418         /// Our top InsetText
 419         Inset & inset() const;
 420
 421         //
 422         // Macro handling
 423         //
 424         /// Collect macro definitions in paragraphs
 425         void updateMacros() const;
 426         /// Iterate through the whole buffer and try to resolve macros
 427         void updateMacroInstances() const;
 428
 429         /// List macro names of this buffer, the parent and the children
 430         void listMacroNames(MacroNameSet & macros) const;
 431         /// Collect macros of the parent and its children in front of this buffer.
 432         void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
 433
 434         /// Return macro defined before pos (or in the master buffer)
 435         MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
 436         /// Return macro defined anywhere in the buffer (or in the master buffer)
 437         MacroData const * getMacro(docstring const & name, bool global = true) const;
 438         /// Return macro defined before the inclusion of the child
 439         MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
 440
 441         /// Collect user macro names at loading time
 442         typedef std::set<docstring> UserMacroSet;
 443         UserMacroSet usermacros;
 444
 445         /// Replace the inset contents for insets which InsetCode is equal
 446         /// to the passed \p inset_code.
 447         void changeRefsIfUnique(docstring const & from, docstring const & to,
 448                 InsetCode code);
 449
 450         /// get source code (latex/docbook) for some paragraphs, or all paragraphs
 451         /// including preamble
 452         void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end,
 453                 bool full_source) const;
 454
 455         /// Access to error list.
 456         /// This method is used only for GUI visualisation of Buffer related
 457         /// errors (like parsing or LateX compilation). This method is const
 458         /// because modifying the returned ErrorList does not touch the document
 459         /// contents.
 460         ErrorList & errorList(std::string const & type) const;
 461
 462         /// The Toc backend.
 463         /// This is useful only for screen visualisation of the Buffer. This
 464         /// method is const because modifying this backend does not touch
 465         /// the document contents.
 466         TocBackend & tocBackend() const;
 467
 468         ///
 469         Undo & undo();
 470
 471         /// This function is called when the buffer is changed.
 472         void changed(bool update_metrics) const;
 473         ///
 474         void setChild(DocIterator const & dit, Buffer * child);
 475         ///
 476         void updateTocItem(std::string const &, DocIterator const &) const;
 477         /// This function is called when the buffer structure is changed.
 478         void structureChanged() const;
 479         /// This function is called when some parsing error shows up.
 480         void errors(std::string const & err, bool from_master = false) const;
 481         /// This function is called when the buffer busy status change.
 482         void setBusy(bool on) const;
 483         /// Update window titles of all users.
 484         void updateTitles() const;
 485         /// Reset autosave timers for all users.
 486         void resetAutosaveTimers() const;
 487         ///
 488         void message(docstring const & msg) const;
 489
 490         ///
 491         void setGuiDelegate(frontend::GuiBufferDelegate * gui);
 492         ///
 493         bool hasGuiDelegate() const;
 494
 495         ///
 496         void autoSave() const;
 497         ///
 498         void removeAutosaveFile() const;
 499         ///
 500         void moveAutosaveFile(support::FileName const & old) const;
 501         ///
 502         support::FileName getAutosaveFileName() const;
 503
 504         /// return the format of the buffer on a string
 505         std::string bufferFormat() const;
 506         /// return the default output format of the current backend
 507         std::string getDefaultOutputFormat() const;
 508
 509         ///
 510         bool doExport(std::string const & format, bool put_in_tempdir,
 511                 bool includeall, std::string & result_file) const;
 512         ///
 513         bool doExport(std::string const & format, bool put_in_tempdir,
 514                       bool includeall = false) const;
 515         ///
 516         bool preview(std::string const & format, bool includeall = false) const;
 517         ///
 518         bool isExportable(std::string const & format) const;
 519         ///
 520         std::vector<Format const *> exportableFormats(bool only_viewable) const;
 521         ///
 522         bool isExportableFormat(std::string const & format) const;
 523         /// mark the buffer as busy exporting something, or not
 524         void setExportStatus(bool e) const;
 525         ///
 526         bool isExporting() const;
 527
 528         ///
 529         typedef std::vector<std::pair<Inset *, ParIterator> > References;
 530         References & references(docstring const & label);
 531         References const & references(docstring const & label) const;
 532         void clearReferenceCache() const;
 533         void setInsetLabel(docstring const & label, InsetLabel const * il);
 534         InsetLabel const * insetLabel(docstring const & label) const;
 535
 536         /// return a list of all used branches (also in children)
 537         void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
 538
 539         /// sets the buffer_ member for every inset in this buffer.
 540         // FIXME This really shouldn't be needed, but at the moment it's not
 541         // clear how to do it just for the individual pieces we need.
 542         void setBuffersForInsets() const;
 543         /// Updates screen labels and some other information associated with
 544         /// insets and paragraphs. Actually, it's more like a general "recurse
 545         /// through the Buffer" routine, that visits all the insets and paragraphs.
 546         void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
 547         /// \param scope: whether to start with the master document or just
 548         /// do this one.
 549         /// \param output: whether we are preparing for output.
 550         void updateBuffer(UpdateScope scope, UpdateType utype) const;
 551         ///
 552         void updateBuffer(ParIterator & parit, UpdateType utype) const;
 553
 554         /// Spellcheck starting from \p from.
 555         /// \p from initial position, will then points to the next misspelled
 556         ///    word.
 557         /// \p to will points to the end of the next misspelled word.
 558         /// \p word_lang will contain the found misspelled word.
 559         /// \return progress if a new word was found.
 560         int spellCheck(DocIterator & from, DocIterator & to,
 561                 WordLangTuple & word_lang, docstring_list & suggestions) const;
 562         ///
 563         void checkChildBuffers();
 564
 565 private:
 566         ///
 567         bool readFileHelper(support::FileName const & s);
 568         ///
 569         std::vector<std::string> backends() const;
 570         /** Inserts a file into a document
 571             \return \c false if method fails.
 572         */
 573         ReadStatus readFile(Lexer &, support::FileName const & filename,
 574                             bool fromString = false);
 575         ///
 576         void getLanguages(std::set<Language const *> &) const;
 577         /// Update the list of all bibfiles in use (including bibfiles
 578         /// of loaded child documents).
 579         void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
 580         /// Return the list with all bibfiles in use (including bibfiles
 581         /// of loaded child documents).
 582         support::FileNameList const &
 583                 getBibfilesCache(UpdateScope scope = UpdateMaster) const;
 584
 585         /// Use the Pimpl idiom to hide the internals.
 586         class Impl;
 587         /// The pointer never changes although *pimpl_'s contents may.
 588         Impl * const d;
 589 };
 590
 591
 592 } // namespace lyx
 593
 594 #endif