lyx_mirror/src/BufferList.h
Stephan Witt f2f861f017 Use real path names for buffer lookup by name of temporary external files.
In case of path names for external files containing symbolic links the real path
and the logical path name may be different for the same file or directory.
LyX is using QDir::tempPath() to create the path name of the temporary directory.
The Qt implementation is free to return the logical or the real path name here and
it happens to be different for various platforms and versions.
The most stable and clean solution is to use the real path name consistently.
2020-02-22 12:11:42 +01:00

159 lines
4.1 KiB
C++

// -*- C++ -*-
/**
* \file BufferList.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef BUFFER_LIST_H
#define BUFFER_LIST_H
#include "support/docstring.h"
#include <vector>
namespace lyx {
class Author;
class Buffer;
class OutputParams;
namespace support {
class FileName;
class FileNameList;
} // namespace support
/**
* The class holds all all open buffers, and handles construction
* and deletions of new ones.
*/
class BufferList {
public:
typedef std::vector<Buffer *>::iterator iterator;
typedef std::vector<Buffer *>::const_iterator const_iterator;
public:
BufferList();
~BufferList();
iterator begin();
const_iterator begin() const;
iterator end();
const_iterator end() const;
/// create a new buffer and add it to the buffer list
/// \return 0 if the Buffer creation is not possible for whatever reason.
Buffer * newBuffer(std::string const & s);
/// create an internal buffer and add it to the internal buffer list
/// \return 0 if the Buffer creation is not possible for whatever reason.
Buffer * newInternalBuffer(std::string const & s);
/// Is child a child of some Buffer other than parent?
/// NOTE: child must be a child of parent, and both must be non-null.
/// Otherwise we assert.
bool isOthersChild(Buffer * parent, Buffer * child) const;
/// delete a buffer
void release(Buffer * b);
/// Close all open buffers.
void closeAll();
/// returns a vector with all the buffers filenames
support::FileNameList fileNames() const;
/// return true if no buffers loaded
bool empty() const;
/// return head of buffer list if any
Buffer * first();
/// return back of buffer list if any
Buffer * last();
/// returns true if the buffer exists already
bool exists(support::FileName const &) const;
/// returns true if the buffer is loaded
bool isLoaded(Buffer const * b) const;
/// returns true if the buffer is known as internal buffer
bool isInternal(Buffer const * b) const;
/// \return index of named buffer in buffer list
int bufferNum(support::FileName const & name) const;
/** returns a pointer to the buffer with the given name
*
* \param internal
* If true, the buffer is searched also among internal buffers
*/
Buffer * getBuffer(support::FileName const & name, bool internal = false) const;
/// \return a pointer to the buffer with the given number
Buffer * getBuffer(unsigned int);
/// \return a pointer to the buffer whose temppath matches the given \p path
/// If optional \p realpath is \c true the lookup is done with real path names
Buffer * getBufferFromTmp(std::string const & path, bool realpath = false);
/** returns a pointer to the buffer that follows argument in
* buffer list. The buffer following the last in list is the
* first one.
*/
Buffer * next(Buffer const *) const;
/** returns a pointer to the buffer that precedes argument in
* buffer list. The buffer preceding the first in list is the
* last one.
*/
Buffer * previous(Buffer const *) const;
/// \name Functions that just operate on all buffers
//@{
/// reset current author for all buffers
void recordCurrentAuthor(Author const & author);
/// update previews for all buffers, e.g. for Prefs update
void updatePreviews();
/// Call changed() on all buffers, internal or not
void changed(bool update_metrics) const;
/// emergency save for all buffers
void emergencyWriteAll();
/// FIXME
void updateIncludedTeXfiles(std::string const &, OutputParams const &);
///
void invalidateConverterCache() const;
//@}
private:
/// create a new buffer
/// \return 0 if the Buffer creation is not possible for whatever reason.
Buffer * createNewBuffer(std::string const & s);
/// noncopiable
BufferList(BufferList const &);
void operator=(BufferList const &);
typedef std::vector<Buffer *> BufferStorage;
/// storage of all buffers
BufferStorage bstore;
/// storage of all internal buffers used for cut&paste, etc.
BufferStorage binternal;
};
/// Implementation is in LyX.cpp
extern BufferList & theBufferList();
} // namespace lyx
#endif // BUFFERLIST_H