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 "support/unique_ptr.h"
  18 #include "support/strfwd.h"
  19 #include "support/types.h"
  20 #include "support/FileNameList.h"
  21
  22 #include <map>
  23 #include <list>
  24 #include <set>
  25 #include <string>
  26 #include <vector>
  27
  28
  29 namespace lyx {
  30
  31 class BiblioInfo;
  32 class BibTeXInfo;
  33 class BufferParams;
  34 class DispatchResult;
  35 class DocIterator;
  36 class docstring_list;
  37 class ErrorList;
  38 class FuncRequest;
  39 class FuncStatus;
  40 class Inset;
  41 class InsetLabel;
  42 class InsetRef;
  43 class Font;
  44 class Format;
  45 class Lexer;
  46 class Text;
  47 class LyXVC;
  48 class LaTeXFeatures;
  49 class Language;
  50 class MacroData;
  51 class MacroNameSet;
  52 class MacroSet;
  53 class OutputParams;
  54 class otexstream;
  55 class Paragraph;
  56 class ParConstIterator;
  57 class ParIterator;
  58 class ParagraphList;
  59 class TeXErrors;
  60 class TexRow;
  61 class TocBackend;
  62 class Undo;
  63 class WordLangTuple;
  64
  65 namespace frontend {
  66 class GuiBufferDelegate;
  67 class WorkAreaManager;
  68 } // namespace frontend
  69
  70 namespace support {
  71 class DocFileName;
  72 class FileName;
  73 class FileNamePairList;
  74 } // namespace support
  75
  76 namespace graphics {
  77 class PreviewLoader;
  78 class Cache;
  79 } // namespace graphics
  80
  81
  82 class Buffer;
  83 typedef std::list<Buffer *> ListOfBuffers;
  84 /// a list of Buffers we cloned
  85 typedef std::set<Buffer *> CloneList;
  86
  87
  88 /** The buffer object.
  89  * This is the buffer object. It contains all the information about
  90  * a document loaded into LyX.
  91  * The buffer object owns the Text (wrapped in an InsetText), which
  92  * contains the individual paragraphs of the document.
  93  *
  94  *
  95  * I am not sure if the class is complete or
  96  * minimal, probably not.
  97  * \author Lars Gullik Bjønnes
  98  */
  99
 100 class MarkAsExporting;
 101
 102 class Buffer {
 103 public:
 104         /// What type of log will \c getLogName() return?
 105         enum LogType {
 106                 latexlog, ///< LaTeX log
 107                 buildlog  ///< Literate build log
 108         };
 109
 110         /// Result of \c readFile()
 111         enum ReadStatus {
 112                 ReadSuccess,
 113                 ReadCancel,
 114                 // failures
 115                 ReadFailure,
 116                 ReadWrongVersion,
 117                 ReadFileNotFound,
 118                 ReadVCError,
 119                 ReadAutosaveFailure,
 120                 ReadEmergencyFailure,
 121                 ReadNoLyXFormat,
 122                 ReadDocumentFailure,
 123                 // lyx2lyx
 124                 LyX2LyXNoTempFile,
 125                 LyX2LyXNotFound,
 126                 LyX2LyXOlderFormat,
 127                 LyX2LyXNewerFormat,
 128                 // other
 129                 ReadOriginal
 130         };
 131
 132         enum ExportStatus {
 133                 // export
 134                 ExportSuccess,
 135                 ExportCancel,
 136                 ExportError,
 137                 ExportNoPathToFormat,
 138                 ExportTexPathHasSpaces,
 139                 ExportConverterError,
 140                 // preview
 141                 // Implies ExportSuccess.
 142                 PreviewSuccess,
 143                 // The exported file exists but there was an error when opening
 144                 // it in a viewer.
 145                 PreviewError
 146         };
 147
 148         ///
 149         enum UpdateScope {
 150                 UpdateMaster,
 151                 UpdateChildOnly
 152         };
 153
 154         /// Constructor
 155         explicit Buffer(std::string const & file, bool readonly = false,
 156                 Buffer const * cloned_buffer = 0);
 157
 158         /// Destructor
 159         ~Buffer();
 160
 161         /// Clones the entire structure of which this Buffer is part, starting
 162         /// with the master and cloning all the children, too.
 163         Buffer * cloneFromMaster() const;
 164         /// Just clones this single Buffer. For autosave.
 165         Buffer * cloneBufferOnly() const;
 166         ///
 167         bool isClone() const;
 168
 169         /** High-level interface to buffer functionality.
 170             This function parses a command string and executes it.
 171         */
 172         void dispatch(std::string const & command, DispatchResult & result);
 173
 174         /// Maybe we know the function already by number...
 175         void dispatch(FuncRequest const & func, DispatchResult & result);
 176
 177         /// Can this function be exectued?
 178         /// \return true if we made a decision
 179         bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
 180
 181         ///
 182         DocIterator getParFromID(int id) const;
 183         /// do we have a paragraph with this id?
 184         bool hasParWithID(int id) const;
 185
 186         ///
 187         frontend::WorkAreaManager & workAreaManager() const;
 188
 189         /** Save file.
 190             Takes care of auto-save files and backup file if requested.
 191             Returns \c true if the save is successful, \c false otherwise.
 192         */
 193         bool save() const;
 194         /// Renames and saves the buffer
 195         bool saveAs(support::FileName const & fn);
 196
 197         /// Write document to stream. Returns \c false if unsuccessful.
 198         bool write(std::ostream &) const;
 199         /// Write file. Returns \c false if unsuccessful.
 200         bool writeFile(support::FileName const &) const;
 201
 202         /// \name Functions involved in reading files/strings.
 203         //@{
 204         /// Loads the LyX file into the buffer. This function
 205         /// tries to extract the file from version control if it
 206         /// cannot be found. If it can be found, it will try to
 207         /// read an emergency save file or an autosave file.
 208         /// \sa loadThisLyXFile
 209         ReadStatus loadLyXFile();
 210         /// Loads the LyX file \c fn into the buffer. If you want
 211         /// to check for files in a version control container,
 212         /// emergency or autosave files, one should use \c loadLyXFile.
 213         /// /sa loadLyXFile
 214         ReadStatus loadThisLyXFile(support::FileName const & fn);
 215         /// import a new document from a string
 216         bool importString(std::string const &, docstring const &, ErrorList &);
 217         /// import a new file
 218         bool importFile(std::string const &, support::FileName const &, ErrorList &);
 219         /// read a new document from a string
 220         bool readString(std::string const &);
 221         /// Reloads the LyX file
 222         ReadStatus reload();
 223 //FIXME: The following function should be private
 224 //private:
 225         /// read the header, returns number of unknown tokens
 226         int readHeader(Lexer & lex);
 227
 228         double fontScalingFactor() const;
 229
 230 private:
 231         ///
 232         typedef std::map<Buffer const *, Buffer *> BufferMap;
 233         ///
 234         void cloneWithChildren(BufferMap &, CloneList *) const;
 235         /// save checksum of the given file.
 236         void saveCheckSum() const;
 237         /// read a new file
 238         ReadStatus readFile(support::FileName const & fn);
 239         /// Reads a file without header.
 240         /// \param par if != 0 insert the file.
 241         /// \return \c true if file is not completely read.
 242         bool readDocument(Lexer &);
 243         /// Try to extract the file from a version control container
 244         /// before reading if the file cannot be found.
 245         /// \sa LyXVC::file_not_found_hook
 246         ReadStatus extractFromVC();
 247         /// Reads the first tag of a LyX File and
 248         /// returns the file format number.
 249         ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn,
 250                 int & file_format) const;
 251         /// Convert the LyX file to the LYX_FORMAT using
 252         /// the lyx2lyx script and returns the filename
 253         /// of the temporary file to be read
 254         ReadStatus convertLyXFormat(support::FileName const & fn,
 255                 support::FileName & tmpfile, int from_format);
 256         /// get appropriate name for backing up files from older versions
 257         support::FileName getBackupName() const;
 258         //@}
 259
 260 public:
 261         /// \name Functions involved in autosave and emergency files.
 262         //@{
 263         /// Save an autosave file to #filename.lyx#
 264         bool autoSave() const;
 265         /// save emergency file
 266         /// \return a status message towards the user.
 267         docstring emergencyWrite();
 268
 269 //FIXME:The following function should be private
 270 //private:
 271         ///
 272         void removeAutosaveFile() const;
 273
 274 private:
 275         /// Try to load an autosave file associated to \c fn.
 276         ReadStatus loadAutosave();
 277         /// Try to load an emergency file associated to \c fn.
 278         ReadStatus loadEmergency();
 279         /// Get the filename of the emergency file associated with the Buffer
 280         support::FileName getEmergencyFileName() const;
 281         /// Get the filename of the autosave file associated with the Buffer
 282         support::FileName getAutosaveFileName() const;
 283         ///
 284         void moveAutosaveFile(support::FileName const & old) const;
 285         //@}
 286
 287 public:
 288         /// Fill in the ErrorList with the TeXErrors
 289         void bufferErrors(TeXErrors const &, ErrorList &) const;
 290
 291         enum OutputWhat {
 292                 FullSource,
 293                 OnlyBody,
 294                 IncludedFile,
 295                 OnlyPreamble,
 296                 CurrentParagraph
 297         };
 298
 299         /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
 300         bool makeLaTeXFile(support::FileName const & filename,
 301                            std::string const & original_path,
 302                            OutputParams const &,
 303                            OutputWhat output = FullSource) const;
 304         /** Export the buffer to LaTeX.
 305             If \p os is a file stream, and params().inputenc is "auto" or
 306             "default", and the buffer contains text in different languages
 307             with more than one encoding, then this method will change the
 308             encoding associated to \p os. Therefore you must not call this
 309             method with a string stream if the output is supposed to go to a
 310             file. \code
 311             ofdocstream ofs;
 312             otexstream os(ofs);
 313             ofs.open("test.tex");
 314             writeLaTeXSource(os, ...);
 315             ofs.close();
 316             \endcode is NOT equivalent to \code
 317             odocstringstream oss;
 318             otexstream os(oss);
 319             writeLaTeXSource(os, ...);
 320             ofdocstream ofs;
 321             ofs.open("test.tex");
 322             ofs << oss.str();
 323             ofs.close();
 324             \endcode
 325          */
 326         void writeLaTeXSource(otexstream & os,
 327                            std::string const & original_path,
 328                            OutputParams const &,
 329                            OutputWhat output = FullSource) const;
 330         ///
 331         void makeDocBookFile(support::FileName const & filename,
 332                              OutputParams const & runparams_in,
 333                              OutputWhat output = FullSource) const;
 334         ///
 335         void writeDocBookSource(odocstream & os, std::string const & filename,
 336                              OutputParams const & runparams_in,
 337                              OutputWhat output = FullSource) const;
 338         ///
 339         void makeLyXHTMLFile(support::FileName const & filename,
 340                              OutputParams const & runparams_in) const;
 341         ///
 342         void writeLyXHTMLSource(odocstream & os,
 343                              OutputParams const & runparams_in,
 344                              OutputWhat output = FullSource) const;
 345         /// returns the main language for the buffer (document)
 346         Language const * language() const;
 347         /// get l10n translated to the buffers language
 348         docstring const B_(std::string const & l10n) const;
 349
 350         ///
 351         int runChktex();
 352         /// return true if the main lyx file does not need saving
 353         bool isClean() const;
 354         ///
 355         bool isDepClean(std::string const & name) const;
 356
 357         /// Whether or not disk file has been externally modified. Uses a checksum
 358         /// which is accurate but slow, which can be a problem when it is frequently
 359         /// used, or used for a large file on a slow (network) file system.
 360         bool isChecksumModified() const;
 361
 362         /// Flag set by the FileSystemWatcher.
 363         /// Fast but (not so) inaccurate, can be cleared by the user.
 364         bool notifiesExternalModification() const;
 365         void clearExternalModification() const;
 366
 367         /// mark the main lyx file as not needing saving
 368         void markClean() const;
 369
 370         ///
 371         void markDepClean(std::string const & name);
 372
 373         ///
 374         void setUnnamed(bool flag = true);
 375
 376         /// Whether or not a filename has been assigned to this buffer
 377         bool isUnnamed() const;
 378
 379         /// Whether or not this buffer is internal.
 380         ///
 381         /// An internal buffer does not contain a real document, but some auxiliary text segment.
 382         /// It is not associated with a filename, it is never saved, thus it does not need to be
 383         /// automatically saved, nor it needs to trigger any "do you want to save ?" question.
 384         bool isInternal() const;
 385
 386         void setInternal(bool flag);
 387
 388         /// Mark this buffer as dirty.
 389         void markDirty();
 390
 391         /// Returns the buffer's filename. It is always an absolute path.
 392         support::FileName fileName() const;
 393
 394         /// Returns the buffer's filename. It is always an absolute path.
 395         std::string absFileName() const;
 396
 397         /// Returns the path where the buffer lives.
 398         /// It is always an absolute path.
 399         std::string filePath() const;
 400
 401         /** Contructs a file name of a referenced file (child doc, included graphics etc).
 402          *  Absolute names are returned as is. If the name is relative, it is
 403          *  interpreted relative to filePath() if the file exists, otherwise
 404          *  relative to the original path where the document was last saved.
 405          *  The original path may be different from filePath() if the document was
 406          *  later manually moved to a different location.
 407          */
 408         support::DocFileName getReferencedFileName(std::string const & fn) const;
 409
 410         /// Format a file name for LaTeX output (absolute or relative or filename only,
 411         /// depending on file and context)
 412         std::string const prepareFileNameForLaTeX(std::string const &,
 413                                         std::string const &, bool nice) const;
 414
 415         /** Returns a vector of bibliography (*.bib) file paths suitable for the
 416          *  output in the respective BibTeX/Biblatex macro
 417          */
 418         std::vector<docstring> const prepareBibFilePaths(OutputParams const &,
 419                                     support::FileNamePairList const bibfilelist,
 420                                     bool const extension = true) const;
 421
 422         /** Returns the path where a local layout file lives.
 423          *  An empty string is returned for standard system and user layouts.
 424          *  If possible, it is always relative to the buffer path.
 425          */
 426         std::string layoutPos() const;
 427
 428         /** Set the path to a local layout file.
 429          *  This must be an absolute path but, if possible, it is always
 430          *  stored as relative to the buffer path.
 431          */
 432         void setLayoutPos(std::string const & path);
 433
 434         /** A transformed version of the file name, adequate for LaTeX.
 435             \param no_path optional if \c true then the path is stripped.
 436         */
 437         std::string latexName(bool no_path = true) const;
 438
 439         /// Get the name and type of the log.
 440         std::string logName(LogType * type = 0) const;
 441
 442         /// Set document's parent Buffer.
 443         void setParent(Buffer const *);
 444         Buffer const * parent() const;
 445
 446         /** Get the document's master (or \c this if this is not a
 447             child document)
 448          */
 449         Buffer const * masterBuffer() const;
 450
 451         /// \return true if \p child is a child of this \c Buffer.
 452         bool isChild(Buffer * child) const;
 453
 454         /// \return true if this \c Buffer has children
 455         bool hasChildren() const;
 456
 457         /// \return a list of the direct children of this Buffer.
 458         /// this list has no duplicates and is in the order in which
 459         /// the children appear.
 460         ListOfBuffers getChildren() const;
 461
 462         /// \return a list of all descendents of this Buffer (children,
 463         /// grandchildren, etc). this list has no duplicates and is in
 464         /// the order in which the children appear.
 465         ListOfBuffers getDescendents() const;
 466
 467         /// Collect all relative buffers, in the order in which they appear.
 468         /// I.e., the "root" Buffer is first, then its first child, then any
 469         /// of its children, etc. However, there are no duplicates in this
 470         /// list.
 471         /// This is "stable", too, in the sense that it returns the same
 472         /// thing from whichever Buffer it is called.
 473         ListOfBuffers allRelatives() const;
 474
 475         /// Is buffer read-only? True if it has either the read-only flag or the
 476         /// externally modified flag.
 477         bool isReadonly() const;
 478
 479         /// Does the buffer have the read-only flag?
 480         bool hasReadonlyFlag() const;
 481
 482         /// Set buffer read-only flag
 483         void setReadonly(bool flag = true);
 484
 485         /** Validate a buffer for LaTeX.
 486             This validates the buffer, and returns a struct for use by
 487             #makeLaTeX# and others. Its main use is to figure out what
 488             commands and packages need to be included in the LaTeX file.
 489             It (should) also check that the needed constructs are there
 490             (i.e. that the \refs points to coresponding \labels). It
 491             should perhaps inset "error" insets to help the user correct
 492             obvious mistakes.
 493         */
 494         void validate(LaTeXFeatures &) const;
 495
 496         /// Bibliography information is cached in the Buffer, so we do not
 497         /// have to check or read things over and over.
 498         /// The cache exists only in the master buffer. When it is updated,
 499         /// the children add their information to the master's cache.
 500         /// Calling this method invalidates the cache and so requires a
 501         /// re-read.
 502         void invalidateBibinfoCache() const;
 503         /// Updates the cached bibliography information, checking first to see
 504         /// whether the cache is valid. If so, we do nothing. If not, then we
 505         /// reload all the BibTeX info.
 506         /// Note that this operates on the master document.
 507         void reloadBibInfoCache() const;
 508         /// \return the bibliography information for this buffer's master,
 509         /// or just for it, if it isn't a child.
 510         BiblioInfo const & masterBibInfo() const;
 511         /// collect bibliography info from the various insets in this buffer.
 512         void collectBibKeys(support::FileNameList &) const;
 513         /// add some BiblioInfo to our cache
 514         void addBiblioInfo(BiblioInfo const & bi) const;
 515         /// add a single piece of bibliography info to our cache
 516         void addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const;
 517         ///
 518         void makeCitationLabels() const;
 519         ///
 520         bool citeLabelsValid() const;
 521         ///
 522         void getLabelList(std::vector<docstring> &) const;
 523
 524         /// This removes the .aux and .bbl files from the temp dir.
 525         void removeBiblioTempFiles() const;
 526
 527         ///
 528         void changeLanguage(Language const * from, Language const * to);
 529
 530         ///
 531         bool isMultiLingual() const;
 532         ///
 533         std::set<Language const *> getLanguages() const;
 534
 535         ///
 536         BufferParams & params();
 537         BufferParams const & params() const;
 538         ///
 539         BufferParams const & masterParams() const;
 540
 541         /** The list of paragraphs.
 542             This is a linked list of paragraph, this list holds the
 543             whole contents of the document.
 544          */
 545         ParagraphList & paragraphs();
 546         ParagraphList const & paragraphs() const;
 547
 548         /// LyX version control object.
 549         LyXVC & lyxvc();
 550         LyXVC const & lyxvc() const;
 551
 552         /// Where to put temporary files.
 553         std::string const temppath() const;
 554
 555         /// Used when typesetting to place errorboxes.
 556         TexRow const & texrow() const;
 557         TexRow & texrow();
 558
 559         ///
 560         ParIterator par_iterator_begin();
 561         ///
 562         ParConstIterator par_iterator_begin() const;
 563         ///
 564         ParIterator par_iterator_end();
 565         ///
 566         ParConstIterator par_iterator_end() const;
 567
 568         // Position of the child buffer where it appears first in the master.
 569         DocIterator firstChildPosition(Buffer const * child);
 570
 571         /** \returns true only when the file is fully loaded.
 572          *  Used to prevent the premature generation of previews
 573          *  and by the citation inset.
 574          */
 575         bool isFullyLoaded() const;
 576         /// Set by buffer_funcs' newFile.
 577         void setFullyLoaded(bool);
 578
 579         /// FIXME: Needed by RenderPreview.
 580         graphics::PreviewLoader * loader() const;
 581         /// Update the LaTeX preview snippets associated with this buffer
 582         void updatePreviews() const;
 583         /// Remove any previewed LaTeX snippets associated with this buffer
 584         void removePreviews() const;
 585         ///
 586         graphics::Cache & graphicsCache() const;
 587
 588         /// Our main text (inside the top InsetText)
 589         Text & text() const;
 590
 591         /// Our top InsetText
 592         Inset & inset() const;
 593
 594         //
 595         // Macro handling
 596         //
 597         /// Collect macro definitions in paragraphs
 598         void updateMacros() const;
 599         /// Iterate through the whole buffer and try to resolve macros
 600         void updateMacroInstances(UpdateType) const;
 601
 602         /// List macro names of this buffer, the parent and the children
 603         void listMacroNames(MacroNameSet & macros) const;
 604         /// Collect macros of the parent and its children in front of this buffer.
 605         void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
 606
 607         /// Return macro defined before pos (or in the master buffer)
 608         MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
 609         /// Return macro defined anywhere in the buffer (or in the master buffer)
 610         MacroData const * getMacro(docstring const & name, bool global = true) const;
 611         /// Return macro defined before the inclusion of the child
 612         MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
 613
 614         /// Collect user macro names at loading time
 615         typedef std::set<docstring> UserMacroSet;
 616         mutable UserMacroSet usermacros;
 617
 618         /// Replace the inset contents for insets which InsetCode is equal
 619         /// to the passed \p inset_code.
 620         void changeRefsIfUnique(docstring const & from, docstring const & to);
 621
 622         /// get source code (latex/docbook) for some paragraphs, or all paragraphs
 623         /// including preamble
 624         /// returns nullptr if Id to Row conversion is unsupported
 625         unique_ptr<TexRow> getSourceCode(odocstream & os,
 626                         std::string const & format, pit_type par_begin,
 627                         pit_type par_end, OutputWhat output, bool master) const;
 628
 629         /// Access to error list.
 630         /// This method is used only for GUI visualisation of Buffer related
 631         /// errors (like parsing or LateX compilation). This method is const
 632         /// because modifying the returned ErrorList does not touch the document
 633         /// contents.
 634         ErrorList & errorList(std::string const & type) const;
 635
 636         /// The Toc backend.
 637         /// This is useful only for screen visualisation of the Buffer. This
 638         /// method is const because modifying this backend does not touch
 639         /// the document contents.
 640         TocBackend & tocBackend() const;
 641
 642         ///
 643         Undo & undo();
 644
 645         /// This function is called when the buffer is changed.
 646         void changed(bool update_metrics) const;
 647         ///
 648         void setChild(DocIterator const & dit, Buffer * child);
 649         ///
 650         void updateTocItem(std::string const &, DocIterator const &) const;
 651         /// This function is called when the buffer structure is changed.
 652         void structureChanged() const;
 653         /// This function is called when some parsing error shows up.
 654         void errors(std::string const & err, bool from_master = false) const;
 655         /// This function is called when the buffer busy status change.
 656         void setBusy(bool on) const;
 657         /// Update window titles of all users.
 658         void updateTitles() const;
 659         /// Reset autosave timers for all users.
 660         void resetAutosaveTimers() const;
 661         ///
 662         void message(docstring const & msg) const;
 663
 664         ///
 665         void setGuiDelegate(frontend::GuiBufferDelegate * gui);
 666         ///
 667         bool hasGuiDelegate() const;
 668
 669         ///
 670         ExportStatus doExport(std::string const & target, bool put_in_tempdir) const;
 671         /// Export buffer to format \p format and open the result in a suitable viewer.
 672         /// Note: This has nothing to do with preview of graphics or math formulas.
 673         ExportStatus preview(std::string const & format) const;
 674         /// true if there was a previous preview this session of this buffer and
 675         /// there was an error on the previous preview of this buffer.
 676         bool lastPreviewError() const;
 677
 678 private:
 679         ///
 680         ExportStatus doExport(std::string const & target, bool put_in_tempdir,
 681                 std::string & result_file) const;
 682         /// target is a format name optionally followed by a space
 683         /// and a destination file-name
 684         ExportStatus doExport(std::string const & target, bool put_in_tempdir,
 685                 bool includeall, std::string & result_file) const;
 686         ///
 687         ExportStatus preview(std::string const & format, bool includeall) const;
 688         ///
 689         void setMathFlavor(OutputParams & op) const;
 690
 691 public:
 692         ///
 693         bool isExporting() const;
 694
 695         ///
 696         typedef std::vector<std::pair<Inset *, ParIterator> > References;
 697         ///
 698         References const & references(docstring const & label) const;
 699         ///
 700         void addReference(docstring const & label, Inset * inset, ParIterator it);
 701         ///
 702         void clearReferenceCache() const;
 703         ///
 704         void setInsetLabel(docstring const & label, InsetLabel const * il);
 705         ///
 706         InsetLabel const * insetLabel(docstring const & label) const;
 707
 708         /// return a list of all used branches (also in children)
 709         void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
 710
 711         /// Updates screen labels and some other information associated with
 712         /// insets and paragraphs. Actually, it's more like a general "recurse
 713         /// through the Buffer" routine, that visits all the insets and paragraphs.
 714         void updateBuffer() const { updateBuffer(UpdateMaster, InternalUpdate); }
 715         /// \param scope: whether to start with the master document or just
 716         /// do this one.
 717         /// \param output: whether we are preparing for output.
 718         void updateBuffer(UpdateScope scope, UpdateType utype) const;
 719         ///
 720         void updateBuffer(ParIterator & parit, UpdateType utype) const;
 721
 722         /// Spellcheck starting from \p from.
 723         /// \p from initial position, will then points to the next misspelled
 724         ///    word.
 725         /// \p to will points to the end of the next misspelled word.
 726         /// \p word_lang will contain the found misspelled word.
 727         /// \return progress if a new word was found.
 728         int spellCheck(DocIterator & from, DocIterator & to,
 729                 WordLangTuple & word_lang, docstring_list & suggestions) const;
 730         ///
 731         void checkChildBuffers();
 732         ///
 733         void checkMasterBuffer();
 734
 735         /// If the document is being saved to a new location and the named file
 736         /// exists at the old location, return its updated path relative to the
 737         /// new buffer path if possible, otherwise return its absolute path.
 738         /// In all other cases, this is a no-op and name is returned unchanged.
 739         /// If a non-empty ext is given, the existence of name.ext is checked
 740         /// but the returned path will not contain this extension.
 741         /// Similarly, when loading a document that was moved from the location
 742         /// where it was saved, return the correct path relative to the new
 743         /// location.
 744         std::string includedFilePath(std::string const & name,
 745                                 std::string const & ext = empty_string()) const;
 746
 747         /// compute statistics between \p from and \p to
 748         /// \p from initial position
 749         /// \p to points to the end position
 750         /// \p skipNoOutput if notes etc. should be ignored
 751         void updateStatistics(DocIterator & from, DocIterator & to,
 752                                                   bool skipNoOutput = true) const;
 753         /// statistics accessor functions
 754         int wordCount() const;
 755         int charCount(bool with_blanks) const;
 756
 757         // this is const because it does not modify the buffer's real contents,
 758         // only the mutable flag.
 759         void setChangesPresent(bool) const;
 760         bool areChangesPresent() const;
 761         void updateChangesPresent() const;
 762         ///
 763         void registerBibfiles(support::FileNamePairList const & bf) const;
 764
 765 private:
 766         friend class MarkAsExporting;
 767         /// mark the buffer as busy exporting something, or not
 768         void setExportStatus(bool e) const;
 769
 770         ///
 771         References & getReferenceCache(docstring const & label);
 772         /// Change name of buffer. Updates "read-only" flag.
 773         void setFileName(support::FileName const & fname);
 774         ///
 775         void getLanguages(std::set<Language const *> &) const;
 776         /// Checks whether any of the referenced bibfiles have changed since the
 777         /// last time we loaded the cache. Note that this does NOT update the
 778         /// cached information.
 779         void checkIfBibInfoCacheIsValid() const;
 780         /// Return the list with all bibfiles in use (including bibfiles
 781         /// of loaded child documents).
 782         support::FileNamePairList const &
 783                 getBibfiles(UpdateScope scope = UpdateMaster) const;
 784         ///
 785         void collectChildren(ListOfBuffers & children, bool grand_children) const;
 786
 787         /// noncopyable
 788         Buffer(Buffer const &);
 789         void operator=(Buffer const &);
 790
 791         /// Use the Pimpl idiom to hide the internals.
 792         class Impl;
 793         /// The pointer never changes although *pimpl_'s contents may.
 794         Impl * const d;
 795 };
 796
 797
 798 /// Helper class, to guarantee that the export status
 799 /// gets reset properly. To use, simply create a local variable:
 800 ///    MarkAsExporting mex(bufptr);
 801 /// and leave the rest to us.
 802 class MarkAsExporting {
 803 public:
 804         MarkAsExporting(Buffer const * buf) : buf_(buf)
 805         {
 806                 buf_->setExportStatus(true);
 807         }
 808         ~MarkAsExporting()
 809         {
 810                 buf_->setExportStatus(false);
 811         }
 812 private:
 813         Buffer const * const buf_;
 814 };
 815
 816
 817 } // namespace lyx
 818
 819 #endif