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