lyx_mirror/src/LaTeXFeatures.h

// -*- C++ -*-
/* This file is part of
* ======================================================
*
*           LyX, The Document Processor
*
*           Copyright 1995 Matthias Ettrich
*           Copyright 1995-2001 the LyX Team.
*
* ====================================================== */

#ifndef LATEXFEATURES_H
#define LATEXFEATURES_H

#include "support/types.h"

#include "LString.h"

#include <set>
#include <list>
#include <map>

class BufferParams;
struct 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(BufferParams const &);
	/// The packages needed by the document
	string const getPackages() const;
	/// The macros definitions needed by the document
	string const getMacros() const;
	///
	string const getBabelOptions() const;
	/// The definitions needed by the document's textclass
	string const getTClassPreamble() const;
	/// The sgml definitions needed by the document (dobook/linuxdoc)
	string const getLyXSGMLEntities() const;
	/// The SGML Required to include the files added with includeFile();
	string const getIncludedFiles(string const & fname) const;
	/// Include a file for use with the SGML entities
	void includeFile(string const & key, string const & name);
	/// The float definitions.
	void getFloatDefinitions(std::ostream & os) const;
	/// Print requirements to lyxerr
	void showStruct() const;
	///
	void addExternalPreamble(string const &);
	/// Provide a string name-space to the requirements
	void require(string const & name);
	/// Is the package required?
	bool isRequired(string const & name) const;
	///
	void useFloat(string const & name);
	///
	void useLanguage(Language const *);
	///
	bool hasLanguages() const;
	///
	string getLanguages() const;
	///
	std::set<string> getEncodingSet(string const & doc_encoding) const;
	///
	void useLayout(string const & lyt);
	///
	BufferParams const & bufferParams() const;
	/// the return value is dependent upon both LyXRC and LaTeXFeatures.
	bool useBabel() const;

private:
	string externalPreambles;

	std::list<string> usedLayouts;

	/// Static preamble bits from the external material insets


	typedef std::list<string> FeaturesList;
	///
	FeaturesList features;
	///
	typedef std::set<Language const *> LanguageList;
	///
	LanguageList UsedLanguages;
	///
	typedef std::set<string> UsedFloats;
	///
	UsedFloats usedFloats;
	///
	typedef std::map<string , string> FileMap;
	///
	FileMap IncludedFiles;
	///
	///
	BufferParams const & params;
};

#endif