mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-09-21 15:18:45 +00:00
b9d1b797c9
* src/LaTeXFeatures.[Ch] (LaTeXFeatures::addExternalPreamble): rename to addPreambleSnippet, since this is not specialized for InsetExternal at all * src/insets/insetexternal.C (InsetExternal::validate): reflect name change above git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@16784 a592a061-630c-0410-9148-cb99ea01b6c8
144 lines
4.0 KiB
C++
144 lines
4.0 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file LaTeXFeatures.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 Jean-Marc Lasgouttes
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef LATEXFEATURES_H
|
|
#define LATEXFEATURES_H
|
|
|
|
|
|
#include "outputparams.h"
|
|
#include "support/docstring.h"
|
|
|
|
#include <set>
|
|
#include <list>
|
|
#include <map>
|
|
#include <string>
|
|
|
|
|
|
namespace lyx {
|
|
|
|
class Buffer;
|
|
class BufferParams;
|
|
class Language;
|
|
|
|
/** The packages and commands that a buffer needs. This class
|
|
* contains a list<string>. Each of the LaTeX packages that a buffer needs
|
|
* should be added with void require(string const & name).
|
|
*
|
|
* i.e require("amssymb")
|
|
*
|
|
* To add support you should only need to require() the package name as
|
|
* packages which don't have special requirements are handled automatically.
|
|
* If your new package does need special consideration you'll need to alter
|
|
* string const getPackages() const;
|
|
* Remember to update the validate function in buffer.C and paragraph.C
|
|
* when you do so.
|
|
*/
|
|
class LaTeXFeatures {
|
|
public:
|
|
///
|
|
LaTeXFeatures(Buffer const &, BufferParams const &,
|
|
OutputParams const &);
|
|
/// The packages needed by the document
|
|
std::string const getPackages() const;
|
|
/// The macros definitions needed by the document
|
|
std::string const getMacros() const;
|
|
///
|
|
std::string const getBabelOptions() const;
|
|
/// The definitions needed by the document's textclass
|
|
docstring const getTClassPreamble() const;
|
|
/// The sgml definitions needed by the document (docbook)
|
|
docstring const getLyXSGMLEntities() const;
|
|
/// The SGML Required to include the files added with includeFile();
|
|
docstring const getIncludedFiles(std::string const & fname) const;
|
|
/// Include a file for use with the SGML entities
|
|
void includeFile(docstring const & key, std::string const & name);
|
|
/// The float definitions.
|
|
void getFloatDefinitions(std::ostream & os) const;
|
|
/// Print requirements to lyxerr
|
|
void showStruct() const;
|
|
///
|
|
void addPreambleSnippet(std::string const &);
|
|
/// Provide a string name-space to the requirements
|
|
void require(std::string const & name);
|
|
/// Which of the required packages are installed?
|
|
static void getAvailable();
|
|
/// Is the package required?
|
|
bool isRequired(std::string const & name) const;
|
|
/// Is the (required) package available?
|
|
bool isAvailable(std::string const & name) const;
|
|
///
|
|
void useFloat(std::string const & name);
|
|
///
|
|
void useLanguage(Language const *);
|
|
///
|
|
bool hasLanguages() const;
|
|
///
|
|
std::string getLanguages() const;
|
|
///
|
|
std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
|
|
///
|
|
void useLayout(std::string const & lyt);
|
|
///
|
|
Buffer const & buffer() const;
|
|
///
|
|
void setBuffer(Buffer const &);
|
|
///
|
|
BufferParams const & bufferParams() const;
|
|
/// the return value is dependent upon both LyXRC and LaTeXFeatures.
|
|
bool useBabel() const;
|
|
/// Runparams that will be used for exporting this file.
|
|
OutputParams const & runparams() const { return runparams_; }
|
|
|
|
private:
|
|
std::list<std::string> usedLayouts_;
|
|
|
|
/// Static preamble bits from the external material insets
|
|
typedef std::list<std::string> FeaturesList;
|
|
///
|
|
FeaturesList features_;
|
|
///
|
|
FeaturesList preamble_snippets_;
|
|
/// The available (required) packages
|
|
typedef std::list<std::string> PackagesList;
|
|
///
|
|
static PackagesList packages_;
|
|
///
|
|
typedef std::set<Language const *> LanguageList;
|
|
///
|
|
LanguageList UsedLanguages_;
|
|
///
|
|
typedef std::set<std::string> UsedFloats;
|
|
///
|
|
UsedFloats usedFloats_;
|
|
///
|
|
typedef std::map<docstring , std::string> FileMap;
|
|
///
|
|
FileMap IncludedFiles_;
|
|
/** Buffer of the file being processed.
|
|
* This may be a child buffer of the to-be-exported file and
|
|
* therefore may not be the buffer that belongs to params_.
|
|
* Only needed by InsetInclude::validate().
|
|
*/
|
|
Buffer const * buffer_;
|
|
///
|
|
BufferParams const & params_;
|
|
/** Some insets need to know details about the to-be-produced file
|
|
* in validate().
|
|
*/
|
|
OutputParams const & runparams_;
|
|
};
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|