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