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