mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-14 06:57:01 +00:00
6e93e77f22
Design goal: Allow the use of layout "modules", which are to LaTeX packages as layout files are to LaTeX document classes. Thus, one could have a module that defined certain character styles, environments, commands, or what have you, and include it in various documents, each of which uses a different document class, without having to modify the layout files themselves. For example, a theorems.module could be used with article.layout to provide support for theorem-type environments, without having to modify article.layout itself, and the same module could be used with book.layout, etc. This first patch does some reworking of the infrastructrue. We need to distinguish between the TextClass that a particular document is using and the layout of that document, since modules, in particular, can modify the layout. The solution adopted here is to add a TextClass pointer to BufferParams, which will hold the layout. The layout itself is then constructed from the TextClass the document is using. At present, this is completely trivial, but that will change when modules are added. The pointer in question is a boost::shared_ptr. This is needed because CutAndPaste saves a copy of the layout with each cut or copied selection. We cannot assume the selection vanishes when the document is closed, so there are two options: (i) keep a list of all the layouts that have ever been used by any document; (ii) used some kind of smart pointer. The latter seems preferable, as the former would waste memory. More importantly, the use of a smart pointer allows modules to be modified on disk and then reloaded while LyX is running, and it will eventually allow the same for layout files. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19756 a592a061-630c-0410-9148-cb99ea01b6c8
83 lines
1.9 KiB
C++
83 lines
1.9 KiB
C++
// -*- C++ -*-
|
|
/* \file buffer_funcs.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Lars Gullik Bjønnes
|
|
* \author Alfredo Braunstein
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef BUFFER_FUNCS_H
|
|
#define BUFFER_FUNCS_H
|
|
|
|
#include "lyxlayout_ptr_fwd.h"
|
|
#include "support/docstring.h"
|
|
|
|
#include <string>
|
|
|
|
|
|
namespace lyx {
|
|
|
|
namespace support { class FileName; }
|
|
|
|
class Buffer;
|
|
class DocIterator;
|
|
class ErrorList;
|
|
class TeXErrors;
|
|
class ParIterator;
|
|
|
|
|
|
/**
|
|
* Returns true if the file is already loaded into a buffer.
|
|
*/
|
|
bool checkIfLoaded(support::FileName const & fn);
|
|
|
|
/**
|
|
* Loads a LyX file \c filename into \c Buffer
|
|
* and \return success status.
|
|
*/
|
|
bool loadLyXFile(Buffer *, support::FileName const & filename);
|
|
|
|
/**
|
|
* Checks and loads a LyX file \param filename.
|
|
* \retval the newly created \c Buffer pointer if successful or 0.
|
|
* \retval 0 if the \c Buffer could not be created.
|
|
*/
|
|
Buffer * checkAndLoadLyXFile(support::FileName const & filename);
|
|
|
|
/** Make a new file (buffer) with name \c filename based on a template
|
|
* named \c templatename
|
|
*/
|
|
Buffer * newFile(std::string const & filename, std::string const & templatename,
|
|
bool isNamed = false);
|
|
|
|
///return the format of the buffer on a string
|
|
std::string const bufferFormat(Buffer const & buffer);
|
|
|
|
/// Fill in the ErrorList with the TeXErrors
|
|
void bufferErrors(Buffer const &, TeXErrors const &, ErrorList &);
|
|
|
|
/// Count the number of words in the text between these two iterators
|
|
int countWords(DocIterator const & from, DocIterator const & to);
|
|
|
|
/// updates all counters
|
|
void updateLabels(Buffer const &, bool childonly = false);
|
|
|
|
///
|
|
void updateLabels(Buffer const &, ParIterator &);
|
|
|
|
///
|
|
void checkBufferStructure(Buffer &, ParIterator const &);
|
|
|
|
///
|
|
textclass_type defaultTextclass();
|
|
|
|
///
|
|
void loadChildDocuments(Buffer const & buffer);
|
|
|
|
} // namespace lyx
|
|
|
|
#endif // BUFFER_FUNCS_H
|