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         /// Update the list of all bibfiles in use (including bibfiles
 346         /// of loaded child documents).
 347         void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
 348         /// Return the list with all bibfiles in use (including bibfiles
 349         /// of loaded child documents).
 350         support::FileNameList const &
 351                 getBibfilesCache(UpdateScope scope = UpdateMaster) const;
 352         /// Information from BibTeX databases is cached in the Buffer, so
 353         /// we do not have to read the file over and over.
 354         /// Calling this method invalidates the cache and so requires a
 355         /// re-read.
 356         void invalidateBibinfoCache();
 357         /// Updates the cached bibliography information.
 358         /// Note that you MUST call this method to update the cache. It will
 359         /// not happen otherwise. (Currently, it is called at the start of
 360         /// updateBuffer() and from GuiCitation.)
 361         void checkBibInfoCache() const;
 362         /// \return the bibliography information for this buffer's master,
 363         /// or just for it, if it isn't a child.
 364         BiblioInfo const & masterBibInfo() const;
 365         /// \return the bibliography information for this buffer ONLY.
 366         BiblioInfo const & localBibInfo() const;
 367         ///
 368         void getLabelList(std::vector<docstring> &) const;
 369
 370         ///
 371         void changeLanguage(Language const * from, Language const * to);
 372
 373         ///
 374         bool isMultiLingual() const;
 375         ///
 376         std::set<Language const *> getLanguages() const;
 377
 378         ///
 379         BufferParams & params();
 380         BufferParams const & params() const;
 381
 382         /** The list of paragraphs.
 383             This is a linked list of paragraph, this list holds the
 384             whole contents of the document.
 385          */
 386         ParagraphList & paragraphs();
 387         ParagraphList const & paragraphs() const;
 388
 389         /// LyX version control object.
 390         LyXVC & lyxvc();
 391         LyXVC const & lyxvc() const;
 392
 393         /// Where to put temporary files.
 394         std::string const temppath() const;
 395
 396         /// Used when typesetting to place errorboxes.
 397         TexRow const & texrow() const;
 398         TexRow & texrow();
 399
 400         ///
 401         ParIterator par_iterator_begin();
 402         ///
 403         ParConstIterator par_iterator_begin() const;
 404         ///
 405         ParIterator par_iterator_end();
 406         ///
 407         ParConstIterator par_iterator_end() const;
 408
 409         // Position of the child buffer where it appears first in the master.
 410         DocIterator firstChildPosition(Buffer const * child);
 411
 412         /** \returns true only when the file is fully loaded.
 413          *  Used to prevent the premature generation of previews
 414          *  and by the citation inset.
 415          */
 416         bool isFullyLoaded() const;
 417         /// Set by buffer_funcs' newFile.
 418         void setFullyLoaded(bool);
 419
 420         /// Our main text (inside the top InsetText)
 421         Text & text() const;
 422
 423         /// Our top InsetText
 424         Inset & inset() const;
 425
 426         //
 427         // Macro handling
 428         //
 429         /// Collect macro definitions in paragraphs
 430         void updateMacros() const;
 431         /// Iterate through the whole buffer and try to resolve macros
 432         void updateMacroInstances() const;
 433
 434         /// List macro names of this buffer, the parent and the children
 435         void listMacroNames(MacroNameSet & macros) const;
 436         /// Collect macros of the parent and its children in front of this buffer.
 437         void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
 438
 439         /// Return macro defined before pos (or in the master buffer)
 440         MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
 441         /// Return macro defined anywhere in the buffer (or in the master buffer)
 442         MacroData const * getMacro(docstring const & name, bool global = true) const;
 443         /// Return macro defined before the inclusion of the child
 444         MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
 445
 446         /// Collect user macro names at loading time
 447         typedef std::set<docstring> UserMacroSet;
 448         UserMacroSet usermacros;
 449
 450         /// Replace the inset contents for insets which InsetCode is equal
 451         /// to the passed \p inset_code.
 452         void changeRefsIfUnique(docstring const & from, docstring const & to,
 453                 InsetCode code);
 454
 455         /// get source code (latex/docbook) for some paragraphs, or all paragraphs
 456         /// including preamble
 457         void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end,
 458                 bool full_source) const;
 459
 460         /// Access to error list.
 461         /// This method is used only for GUI visualisation of Buffer related
 462         /// errors (like parsing or LateX compilation). This method is const
 463         /// because modifying the returned ErrorList does not touch the document
 464         /// contents.
 465         ErrorList & errorList(std::string const & type) const;
 466
 467         /// The Toc backend.
 468         /// This is useful only for screen visualisation of the Buffer. This
 469         /// method is const because modifying this backend does not touch
 470         /// the document contents.
 471         TocBackend & tocBackend() const;
 472
 473         ///
 474         Undo & undo();
 475
 476         /// This function is called when the buffer is changed.
 477         void changed(bool update_metrics) const;
 478         ///
 479         void setChild(DocIterator const & dit, Buffer * child);
 480         ///
 481         void updateTocItem(std::string const &, DocIterator const &) const;
 482         /// This function is called when the buffer structure is changed.
 483         void structureChanged() const;
 484         /// This function is called when some parsing error shows up.
 485         void errors(std::string const & err, bool from_master = false) const;
 486         /// This function is called when the buffer busy status change.
 487         void setBusy(bool on) const;
 488         /// Update window titles of all users.
 489         void updateTitles() const;
 490         /// Reset autosave timers for all users.
 491         void resetAutosaveTimers() const;
 492         ///
 493         void message(docstring const & msg) const;
 494
 495         ///
 496         void setGuiDelegate(frontend::GuiBufferDelegate * gui);
 497         ///
 498         bool hasGuiDelegate() const;
 499
 500         ///
 501         void autoSave() const;
 502         ///
 503         void removeAutosaveFile() const;
 504         ///
 505         void moveAutosaveFile(support::FileName const & old) const;
 506         ///
 507         support::FileName getAutosaveFileName() const;
 508
 509         /// return the format of the buffer on a string
 510         std::string bufferFormat() const;
 511         /// return the default output format of the current backend
 512         std::string getDefaultOutputFormat() const;
 513
 514         ///
 515         bool doExport(std::string const & format, bool put_in_tempdir,
 516                 bool includeall, std::string & result_file) const;
 517         ///
 518         bool doExport(std::string const & format, bool put_in_tempdir,
 519                       bool includeall = false) const;
 520         ///
 521         bool preview(std::string const & format, bool includeall = false) const;
 522         ///
 523         bool isExportable(std::string const & format) const;
 524         ///
 525         std::vector<Format const *> exportableFormats(bool only_viewable) const;
 526         ///
 527         bool isExportableFormat(std::string const & format) const;
 528         /// mark the buffer as busy exporting something, or not
 529         void setExportStatus(bool e) const;
 530         ///
 531         bool isExporting() const;
 532
 533         ///
 534         typedef std::vector<std::pair<Inset *, ParIterator> > References;
 535         References & references(docstring const & label);
 536         References const & references(docstring const & label) const;
 537         void clearReferenceCache() const;
 538         void setInsetLabel(docstring const & label, InsetLabel const * il);
 539         InsetLabel const * insetLabel(docstring const & label) const;
 540
 541         /// return a list of all used branches (also in children)
 542         void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
 543
 544         /// sets the buffer_ member for every inset in this buffer.
 545         // FIXME This really shouldn't be needed, but at the moment it's not
 546         // clear how to do it just for the individual pieces we need.
 547         void setBuffersForInsets() const;
 548         /// Updates screen labels and some other information associated with
 549         /// insets and paragraphs. Actually, it's more like a general "recurse
 550         /// through the Buffer" routine, that visits all the insets and paragraphs.
 551         void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
 552         /// \param scope: whether to start with the master document or just
 553         /// do this one.
 554         /// \param output: whether we are preparing for output.
 555         void updateBuffer(UpdateScope scope, UpdateType utype) const;
 556         ///
 557         void updateBuffer(ParIterator & parit, UpdateType utype) const;
 558
 559         /// Spellcheck starting from \p from.
 560         /// \p from initial position, will then points to the next misspelled
 561         ///    word.
 562         /// \p to will points to the end of the next misspelled word.
 563         /// \p word_lang will contain the found misspelled word.
 564         /// \return progress if a new word was found.
 565         int spellCheck(DocIterator & from, DocIterator & to,
 566                 WordLangTuple & word_lang, docstring_list & suggestions) const;
 567         ///
 568         void checkChildBuffers();
 569
 570 private:
 571         ///
 572         bool readFileHelper(support::FileName const & s);
 573         ///
 574         std::vector<std::string> backends() const;
 575         /** Inserts a file into a document
 576             \return \c false if method fails.
 577         */
 578         ReadStatus readFile(Lexer &, support::FileName const & filename,
 579                             bool fromString = false);
 580         ///
 581         void getLanguages(std::set<Language const *> &) const;
 582
 583         /// Use the Pimpl idiom to hide the internals.
 584         class Impl;
 585         /// The pointer never changes although *pimpl_'s contents may.
 586         Impl * const d;
 587 };
 588
 589
 590 } // namespace lyx
 591
 592 #endif