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