lyx_mirror/src/Floating.cpp

/**
 * \file Floating.cpp
 * 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
 * \author Angus Leeming
 *
 * Full author contact details are available in file CREDITS.
 */

#include <config.h>
#include <set>

#include "Floating.h"

#include "support/debug.h"
#include "support/lstrings.h"
#include "support/textutils.h"

using namespace std;


namespace lyx {


Floating::Floating(string const & type, string const & placement,
		   string const & ext, string const & within,
		   string const & style, string const & name,
		   string const & listName, std::string const & listCmd,
		   string const & refPrefix, std::string const & allowedplacement,
		   string const & htmlTag, string const & htmlAttrib,
		   docstring const & htmlStyle,
		   string const & docbookAttr, string const & docbookTagType,
           string const & required, bool usesfloat, bool ispredefined,
		   bool allowswide, bool allowssideways)
	: floattype_(type), placement_(placement), ext_(ext), within_(within),
	  style_(style), name_(name), listname_(listName), listcommand_(listCmd),
	  refprefix_(refPrefix), allowedplacement_(allowedplacement), required_(required),
	  usesfloatpkg_(usesfloat), ispredefined_(ispredefined),
	  allowswide_(allowswide), allowssideways_(allowssideways),
	  html_tag_(htmlTag), html_attrib_(htmlAttrib), html_style_(htmlStyle),
	  docbook_attr_(docbookAttr), docbook_tag_type_(docbookTagType)
{}


std::string Floating::docbookFloatType() const
{
	// TODO: configure this in the layouts?
	if (floattype_ == "figure" || floattype_ == "graph" ||
			floattype_ == "chart" || floattype_ == "scheme")  {
		return "figure";
	} else if (floattype_ == "table" || floattype_ == "tableau") {
		return "table";
	} else if (floattype_ == "algorithm") {
		return "algorithm";
	} else if (floattype_ == "video") {
		return "video";
	} else {
		// If nothing matches, return something that will not be valid.
		LYXERR0("Unrecognised float type: " + floattype_);
		return "unknown";
	}
}


string const & Floating::htmlAttrib() const
{
	if (html_attrib_.empty())
		html_attrib_ = "class='" + defaultCSSClass() + "'";
	return html_attrib_;
}


string const & Floating::htmlTag() const
{
	if (html_tag_.empty())
		html_tag_ = "div";
	return html_tag_;
}


string Floating::defaultCSSClass() const
{
	if (!defaultcssclass_.empty())
		return defaultcssclass_;
	string d;
	string n = floattype_;
	string::const_iterator it = n.begin();
	string::const_iterator en = n.end();
	for (; it != en; ++it) {
		if (!isAlphaASCII(*it))
			d += "_";
		else if (isLower(*it))
			d += *it;
		else
			d += support::lowercase(*it);
	}
	// are there other characters we need to remove?
	defaultcssclass_ = "float-" + d;
	return defaultcssclass_;
}


string Floating::docbookAttr() const
{
	std::set<std::string> achemso = { "chart", "graph", "scheme" };
	// For algorithms, a type attribute must be mentioned, if not already present in docbook_attr_.
	if (docbookFloatType() == "algorithm" && docbook_attr_.find("type=") != std::string::npos)
		return docbook_attr_ + " type='algorithm'";
	// Specific floats for achemso.
	else if (docbookFloatType() == "figure" && achemso.find(floattype_) != achemso.end())
		return docbook_attr_ + " type='" + floattype_ + "'";
	else
		return docbook_attr_;
}


string Floating::docbookTag(bool hasTitle) const
{
	// TODO: configure this in the layouts?
	if (docbookFloatType() == "figure" || docbookFloatType() == "algorithm" || docbookFloatType() == "video") {
		return hasTitle ? "figure" : "informalfigure";
	} else if (docbookFloatType() == "table") {
		return hasTitle ? "table" : "informaltable";
	} else {
		// If nothing matches, return something that will not be valid.
		LYXERR0("Unrecognised float type: " + floattype());
		return "float";
	}
}


string const & Floating::docbookTagType() const
{
	if (docbook_tag_type_ != "block" && docbook_tag_type_ != "paragraph" && docbook_tag_type_ != "inline")
		docbook_tag_type_ = "block";
	return docbook_tag_type_;
}


string const & Floating::docbookCaption() const
{
	docbook_caption_ = "";
	if (floattype_ == "figure" || floattype_ == "algorithm")
		docbook_caption_ = "title";
	else if (floattype_ == "table" || floattype_ == "tableau")
		docbook_caption_ = "caption";
	return docbook_caption_;
}


} // namespace lyx