lyx_mirror/src/insets/insetwrap.C

/**
 * \file insetwrap.C
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author Dekel Tsur
 *
 * Full author contact details are available in file CREDITS
 */

#include <config.h>

#include "insetwrap.h"
#include "insettext.h"

#include "buffer.h"
#include "BufferView.h"
#include "debug.h"
#include "funcrequest.h"
#include "FloatList.h"
#include "gettext.h"
#include "LaTeXFeatures.h"
#include "lyxfont.h"
#include "lyxlex.h"
#include "lyxtext.h"

#include "frontends/LyXView.h"
#include "frontends/Dialogs.h"

#include "support/LOstream.h"
#include "support/lstrings.h"

using std::ostream;
using std::endl;

namespace {

// this should not be hardcoded, but be part of the definition
// of the float (JMarc)
string const caplayout("Caption");
string floatname(string const & type, BufferParams const & bp)
{
	FloatList const & floats = bp.getLyXTextClass().floats();
	FloatList::const_iterator it = floats[type];
	if (it == floats.end())
		return type;

	return _(it->second.name());
}

} // namespace anon


InsetWrap::InsetWrap(BufferParams const & bp, string const & type)
	: InsetCollapsable(bp)
{
	string lab(_("wrap: "));
	lab += floatname(type, bp);
	setLabel(lab);
	LyXFont font(LyXFont::ALL_SANE);
	font.decSize();
	font.decSize();
	font.setColor(LColor::collapsable);
	setLabelFont(font);
	params_.type = type;
	params_.width = LyXLength(50, LyXLength::PCW);
	setInsetName(type);
	LyXTextClass const & tclass = bp.getLyXTextClass();
	if (tclass.hasLayout(caplayout))
		inset.paragraph()->layout(tclass[caplayout]);
}


InsetWrap::InsetWrap(InsetWrap const & in, bool same_id)
	: InsetCollapsable(in, same_id), params_(in.params_)
{}


InsetWrap::~InsetWrap()
{
	InsetWrapMailer mailer(*this);
	mailer.hideDialog();
}


dispatch_result InsetWrap::localDispatch(FuncRequest const & cmd)
{
	Inset::RESULT result = UNDISPATCHED;

	switch (cmd.action) {
	case LFUN_INSET_MODIFY: {
		InsetWrapParams params;
		InsetWrapMailer::string2params(cmd.argument, params);

		params_.placement = params.placement;
		params_.width     = params.width;

		cmd.view()->updateInset(this, true);
		result = DISPATCHED;
	}
	break;
	default:
		result = InsetCollapsable::localDispatch(cmd);
	}

	return result;
}


void InsetWrapParams::write(ostream & os) const
{
	os << "Wrap " // getInsetName()
	   << type << '\n';

	if (!placement.empty()) {
		os << "placement " << placement << "\n";
	}
	os << "width \"" << width.asString() << "\"\n";
}


void InsetWrapParams::read(LyXLex & lex)
{
	if (lex.isOK()) {
		lex.next();
		string token = lex.getString();
		if (token == "placement") {
			lex.next();
			placement = lex.getString();
		} else {
			// take countermeasures
			lex.pushToken(token);
		}
	}
	if (lex.isOK()) {
		lex.next();
		string token = lex.getString();
		if (token == "width") {
			lex.next();
			width = LyXLength(lex.getString());
		} else {
			lyxerr << "InsetWrap::Read:: Missing 'width'-tag!"
			       << endl;
			// take countermeasures
			lex.pushToken(token);
		}
	}
}


void InsetWrap::write(Buffer const * buf, ostream & os) const
{
	params_.write(os);
	InsetCollapsable::write(buf, os);
}


void InsetWrap::read(Buffer const * buf, LyXLex & lex)
{
	params_.read(lex);
	InsetCollapsable::read(buf, lex);
}


void InsetWrap::validate(LaTeXFeatures & features) const
{
	features.require("floatflt");
	InsetCollapsable::validate(features);
}


Inset * InsetWrap::clone(Buffer const &, bool same_id) const
{
	return new InsetWrap(*const_cast<InsetWrap *>(this), same_id);
}


string const InsetWrap::editMessage() const
{
	return _("Opened Wrap Inset");
}


int InsetWrap::latex(Buffer const * buf,
		      ostream & os, bool fragile, bool fp) const
{
	os << "\\begin{floating" << params_.type << '}';
	if (!params_.placement.empty()) {
		os << '[' << params_.placement << ']';
	}
	os  << '{' << params_.width.asLatexString() << "}%\n";

	int const i = inset.latex(buf, os, fragile, fp);

	os << "\\end{floating" << params_.type << "}%\n";
	return i + 2;
}


int InsetWrap::docbook(Buffer const * buf, ostream & os, bool mixcont) const
{
	os << '<' << params_.type << '>';
	int const i = inset.docbook(buf, os, mixcont);
	os << "</" << params_.type << '>';

	return i;
}


bool InsetWrap::insetAllowed(Inset::Code code) const
{
	switch(code) {
	case FLOAT_CODE:
	case FOOT_CODE:
	case MARGIN_CODE:
		return false;
	default:
		return InsetCollapsable::insetAllowed(code);
	}
}


int InsetWrap::getMaxWidth(BufferView * bv, UpdatableInset const * inset)
	const
{
	if (owner() &&
	    static_cast<UpdatableInset*>(owner())->getMaxWidth(bv, inset) < 0) {
		return -1;
	}
	if (!params_.width.zero()) {
		int const ww1 = latexTextWidth(bv);
		int const ww2 = InsetCollapsable::getMaxWidth(bv, inset);
		if (ww2 > 0 && ww2 < ww1) {
			return ww2;
		}
		return ww1;
	}
	// this should not happen!
	return InsetCollapsable::getMaxWidth(bv, inset);
}


int InsetWrap::latexTextWidth(BufferView * bv) const
{
	return params_.width.inPixels(InsetCollapsable::latexTextWidth(bv));
}


string const & InsetWrap::type() const
{
	return params_.type;
}


LyXLength const & InsetWrap::pageWidth() const
{
	return params_.width;
}


void InsetWrap::pageWidth(LyXLength const & ll)
{
	if (ll != params_.width) {
		params_.width = ll;
		need_update = FULL;
	}
}


void InsetWrap::placement(string const & p)
{
	params_.placement = p;
}


string const & InsetWrap::placement() const
{
	return params_.placement;
}


bool InsetWrap::showInsetDialog(BufferView * bv) const
{
	if (!inset.showInsetDialog(bv)) {
		InsetWrap * tmp = const_cast<InsetWrap *>(this);
		InsetWrapMailer mailer(*tmp);
		mailer.showDialog();
	}
	return true;
}


void InsetWrap::addToToc(toc::TocList & toclist, Buffer const * buf) const
{
	// Now find the caption in the float...
	// We now tranverse the paragraphs of
	// the inset...
	Paragraph * tmp = inset.paragraph();
	while (tmp) {
		if (tmp->layout()->name() == caplayout) {
			string const name = floatname(type(), buf->params);
			string const str =
				tostr(toclist[name].size() + 1)
				+ ". " + tmp->asString(buf, false);
			toc::TocItem const item(tmp->id(), 0 , str);
			toclist[name].push_back(item);
		}
		tmp = tmp->next();
	}
}


string const InsetWrapMailer::name_("wrap");

InsetWrapMailer::InsetWrapMailer(InsetWrap & inset)
	: inset_(inset)
{}


string const InsetWrapMailer::inset2string() const
{
	return params2string(inset_.params());
}


void InsetWrapMailer::string2params(string const & in,
				    InsetWrapParams & params)
{
	params = InsetWrapParams();

	istringstream data(in);
	LyXLex lex(0,0);
	lex.setStream(data);

	if (lex.isOK()) {
		lex.next();
		string const token = lex.getString();
		if (token != name_)
			return;
	}

	// This is part of the inset proper that is usually swallowed
	// by Buffer::readInset
	if (lex.isOK()) {
		lex.next();
		string const token = lex.getString();
		if (token != "Wrap" || !lex.eatLine())
			return;
	}

	params.read(lex);
}


string const
InsetWrapMailer::params2string(InsetWrapParams const & params)
{
	ostringstream data;
	data << name_ << ' ';
	params.write(data);

	return data.str();
}