X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetFloat.cpp;h=89a0fbe620bf00744105d37d453eedb3a1a9dd77;hb=04efc84abceb49e2042e357583a84b07847c1a5a;hp=a595b2e0321f5560530f58b5abef6d6fd352c9b4;hpb=dcc50a24548b3ff46f9060897793ca346befa7e2;p=lyx.git

diff --git a/src/insets/InsetFloat.cpp b/src/insets/InsetFloat.cpp
index a595b2e032..89a0fbe620 100644
--- a/src/insets/InsetFloat.cpp
+++ b/src/insets/InsetFloat.cpp
@@ -3,9 +3,9 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Jürgen Vigna
- * \author Lars Gullik Bjønnes
- * \author Jürgen Spitzmüller
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
+ * \author Jürgen Spitzmüller
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -25,14 +25,12 @@
 #include "FloatList.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
-#include "InsetList.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
-#include "OutputParams.h"
+#include "output_xhtml.h"
 #include "ParIterator.h"
 #include "TextClass.h"
 
-#include "support/convert.h"
 #include "support/debug.h"
 #include "support/docstream.h"
 #include "support/gettext.h"
@@ -41,6 +39,7 @@
 #include "frontends/Application.h"
 
 using namespace std;
+using namespace lyx::support;
 
 
 namespace lyx {
@@ -51,7 +50,7 @@ namespace lyx {
 // (read DocBook).
 // By using float.sty we will have the same handling for all floats, both
 // for those already in existance (table and figure) and all user created
-// ones¹. So suddenly we give the users the possibility of creating new
+// ones¹. So suddenly we give the users the possibility of creating new
 // kinds of floats on the fly. (and with a uniform look)
 //
 // API to float.sty:
@@ -88,7 +87,7 @@ namespace lyx {
 //   \listof{type}{title}
 //     title -
 
-// ¹ the algorithm float is defined using the float.sty package. Like this
+// ¹ the algorithm float is defined using the float.sty package. Like this
 //   \floatstyle{ruled}
 //   \newfloat{algorithm}{htbp}{loa}[<sect>]
 //   \floatname{algorithm}{Algorithm}
@@ -112,52 +111,65 @@ namespace lyx {
 //
 // Lgb
 
-
-InsetFloat::InsetFloat(Buffer const & buf, string const & type)
-	: InsetCollapsable(buf), name_(from_utf8(type))
+//FIXME: why do we set in stone the type here?
+InsetFloat::InsetFloat(Buffer * buf, string params_str)
+	: InsetCaptionable(buf)
 {
-	setLabel(_("float: ") + floatName(type, buf.params()));
-	params_.type = type;
+	string2params(params_str, params_);
+	setCaptionType(params_.type);
 }
 
 
-InsetFloat::~InsetFloat()
+// Enforce equality of float type and caption type.
+void InsetFloat::setCaptionType(std::string const & type)
 {
-	hideDialogs("float", this);
+	InsetCaptionable::setCaptionType(type);	
+	params_.type = captionType();
+	// check if the float type exists
+	if (buffer().params().documentClass().floats().typeExist(params_.type))
+		setNewLabel();
+	else
+		setLabel(bformat(_("ERROR: Unknown float type: %1$s"), from_utf8(params_.type)));
+}
+
+
+docstring InsetFloat::layoutName() const
+{ 
+	return "Float:" + from_utf8(params_.type);
 }
 
 
 docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const
 {
-	if (InsetCollapsable::toolTip(bv, x, y).empty())
-		return docstring();
+	if (isOpen(bv))
+		return InsetCaptionable::toolTip(bv, x, y);
 
-	docstring default_tip;
-	if (isOpen())
-		default_tip = _("Left-click to collapse the inset");
-	else
-		default_tip = _("Left-click to open the inset");
 	OutputParams rp(&buffer().params().encoding());
-	docstring caption_tip = getCaptionText(rp);
-	if (!isOpen() && !caption_tip.empty())
-		return caption_tip + '\n' + default_tip;
-	return default_tip;
+	return getCaptionText(rp);
 }
 
 
 void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-	switch (cmd.action) {
+	switch (cmd.action()) {
 
 	case LFUN_INSET_MODIFY: {
 		InsetFloatParams params;
 		string2params(to_utf8(cmd.argument()), params);
-		params_.placement = params.placement;
-		params_.wide      = params.wide;
-		params_.sideways  = params.sideways;
-		params_.subfloat  = params.subfloat;
-		setWide(params_.wide, cur.buffer().params());
-		setSideways(params_.sideways, cur.buffer().params());
+		cur.recordUndoInset(this);
+
+		// placement, wide and sideways are not used for subfloats
+		if (!params_.subfloat) {
+			params_.placement = params.placement;
+			params_.wide      = params.wide;
+			params_.sideways  = params.sideways;
+		}
+		setNewLabel();
+		if (params_.type != params.type)
+			setCaptionType(params.type);
+		// what we really want here is a TOC update, but that means
+		// a full buffer update
+		cur.forceBufferUpdate();
 		break;
 	}
 
@@ -167,7 +179,7 @@ void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
 	}
 
 	default:
-		InsetCollapsable::doDispatch(cur, cmd);
+		InsetCaptionable::doDispatch(cur, cmd);
 		break;
 	}
 }
@@ -176,47 +188,46 @@ void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
 bool InsetFloat::getStatus(Cursor & cur, FuncRequest const & cmd,
 		FuncStatus & flag) const
 {
-	switch (cmd.action) {
+	switch (cmd.action()) {
 
 	case LFUN_INSET_MODIFY:
 	case LFUN_INSET_DIALOG_UPDATE:
 		flag.setEnabled(true);
 		return true;
 
+	case LFUN_INSET_SETTINGS:
+		if (InsetCaptionable::getStatus(cur, cmd, flag)) {
+			flag.setEnabled(flag.enabled() && !params_.subfloat);
+			return true;
+		} else
+			return false;
+	
+	case LFUN_NEWLINE_INSERT:
+		if (params_.subfloat) {
+			flag.setEnabled(false);
+			return true;
+		}
+
 	default:
-		return InsetCollapsable::getStatus(cur, cmd, flag);
+		return InsetCaptionable::getStatus(cur, cmd, flag);
 	}
 }
 
 
-void InsetFloat::updateLabels(ParIterator const & it)
+bool InsetFloat::hasSubCaptions(ParIterator const & it) const
 {
-	Counters & cnts = buffer().masterBuffer()->params().documentClass().counters();
-	string const saveflt = cnts.current_float();
-	bool const savesubflt = cnts.isSubfloat();
-
-	bool const subflt = (it.innerInsetOfType(FLOAT_CODE)
-			     || it.innerInsetOfType(WRAP_CODE));
-	// floats can only embed subfloats of their own kind
-	if (subflt)
-		params_.type = saveflt;
-	setSubfloat(subflt, buffer().params());
-
-	// Tell to captions what the current float is
-	cnts.current_float(params().type);
-	cnts.isSubfloat(subflt);
-
-	InsetCollapsable::updateLabels(it);
-
-	//reset afterwards
-	cnts.current_float(saveflt);
-	cnts.isSubfloat(savesubflt);
+	return (it.innerInsetOfType(FLOAT_CODE) || it.innerInsetOfType(WRAP_CODE));
 }
 
 
 void InsetFloatParams::write(ostream & os) const
 {
-	os << "Float " << type << '\n';
+	if (type.empty()) {
+		// Better this than creating a parse error. This in fact happens in the
+		// parameters dialog via InsetFloatParams::params2string.
+		os << "senseless" << '\n';
+	} else
+		os << type << '\n';
 
 	if (!placement.empty())
 		os << "placement " << placement << "\n";
@@ -236,6 +247,7 @@ void InsetFloatParams::write(ostream & os) const
 void InsetFloatParams::read(Lexer & lex)
 {
 	lex.setContext("InsetFloatParams::read");
+	lex >> type;
 	if (lex.checkFor("placement"))
 		lex >> placement;
 	lex >> "wide" >> wide;
@@ -245,18 +257,17 @@ void InsetFloatParams::read(Lexer & lex)
 
 void InsetFloat::write(ostream & os) const
 {
+	os << "Float ";
 	params_.write(os);
-	InsetCollapsable::write(os);
+	InsetCaptionable::write(os);
 }
 
 
 void InsetFloat::read(Lexer & lex)
 {
 	params_.read(lex);
-	setWide(params_.wide, buffer().params());
-	setSideways(params_.sideways, buffer().params());
-	setSubfloat(params_.subfloat, buffer().params());
-	InsetCollapsable::read(lex);
+	InsetCaptionable::read(lex);
+	setCaptionType(params_.type);
 }
 
 
@@ -268,90 +279,128 @@ void InsetFloat::validate(LaTeXFeatures & features) const
 	if (params_.sideways)
 		features.require("rotfloat");
 
-	if (params_.subfloat)
+	if (features.inFloat())
 		features.require("subfig");
 
-	features.useFloat(params_.type, params_.subfloat);
-	InsetCollapsable::validate(features);
+	features.useFloat(params_.type, features.inFloat());
+	features.inFloat(true);
+	InsetCaptionable::validate(features);
+	features.inFloat(false);
 }
 
 
-docstring InsetFloat::editMessage() const
+docstring InsetFloat::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 {
-	return _("Opened Float Inset");
+	FloatList const & floats = buffer().params().documentClass().floats();
+	Floating const & ftype = floats.getType(params_.type);
+	string const & htmltype = ftype.htmlTag();
+	string const & attr = ftype.htmlAttrib();
+
+	odocstringstream ods;
+	XHTMLStream newxs(ods);
+	newxs << html::StartTag(htmltype, attr);
+	InsetText::XHTMLOptions const opts = 
+		InsetText::WriteLabel | InsetText::WriteInnerTag;
+	docstring deferred = InsetText::insetAsXHTML(newxs, rp, opts);
+	newxs << html::EndTag(htmltype);
+
+	if (rp.inFloat == OutputParams::NONFLOAT)
+		// In this case, this float needs to be deferred, but we'll put it
+		// before anything the text itself deferred.
+		deferred = ods.str() + '\n' + deferred;
+	else 
+		// In this case, the whole thing is already being deferred, so
+		// we can write to the stream.
+		// Note that things will already have been escaped, so we do not 
+		// want to escape them again.
+		xs << XHTMLStream::ESCAPE_NONE << ods.str();
+	return deferred;
 }
 
 
-int InsetFloat::latex(odocstream & os, OutputParams const & runparams) const
+void InsetFloat::latex(otexstream & os, OutputParams const & runparams_in) const
 {
-	if (params_.subfloat) {
-		if (runparams.moving_arg)
+	if (runparams_in.inFloat != OutputParams::NONFLOAT) {
+		if (runparams_in.moving_arg)
 			os << "\\protect";
 		os << "\\subfloat";
-	
-		OutputParams rp = runparams;
-		docstring const caption = getCaption(rp);
-		if (!caption.empty()) {
-			os << caption;
-		}
+
+		OutputParams rp = runparams_in;
+		rp.moving_arg = true;
+		getCaption(os, rp);
 		os << '{';
-		int const i = InsetText::latex(os, runparams);
+		// The main argument is the contents of the float. This is not a moving argument.
+		if (!paragraphs().empty())
+			os.texrow().forceStart(paragraphs()[0].id(), 0);
+		rp.moving_arg = false;
+		rp.inFloat = OutputParams::SUBFLOAT;
+		InsetText::latex(os, rp);
 		os << "}";
-	
-		return i + 1;
+
+		return;
 	}
+	OutputParams runparams(runparams_in);
+	runparams.inFloat = OutputParams::MAINFLOAT;
 
 	FloatList const & floats = buffer().params().documentClass().floats();
 	string tmptype = params_.type;
-	if (params_.sideways)
+	if (params_.sideways && floats.allowsSideways(params_.type))
 		tmptype = "sideways" + params_.type;
-	if (params_.wide && (!params_.sideways ||
-			     params_.type == "figure" ||
-			     params_.type == "table"))
+	if (params_.wide && floats.allowsWide(params_.type)
+		&& (!params_.sideways ||
+		     params_.type == "figure" ||
+		     params_.type == "table"))
 		tmptype += "*";
 	// Figure out the float placement to use.
 	// From lowest to highest:
 	// - float default placement
 	// - document wide default placement
 	// - specific float placement
-	string placement;
+	string tmpplacement;
 	string const buf_placement = buffer().params().float_placement;
 	string const def_placement = floats.defaultPlacement(params_.type);
 	if (!params_.placement.empty()
 	    && params_.placement != def_placement) {
-		placement = params_.placement;
+		tmpplacement = params_.placement;
 	} else if (params_.placement.empty()
 		   && !buf_placement.empty()
 		   && buf_placement != def_placement) {
-		placement = buf_placement;
+		tmpplacement = buf_placement;
+	}
+
+	// Check if placement is allowed by this float
+	string const allowed_placement =
+		floats.allowedPlacement(params_.type);
+	string placement;
+	string::const_iterator lit = tmpplacement.begin();
+	string::const_iterator end = tmpplacement.end();
+	for (; lit != end; ++lit) {
+		if (contains(allowed_placement, *lit))
+			placement += *lit;
 	}
 
-	// The \n is used to force \begin{<floatname>} to appear in a new line.
-	// The % is needed to prevent two consecutive \n chars in the case
-	// when the current output line is empty.
-	os << "%\n\\begin{" << from_ascii(tmptype) << '}';
+	// Force \begin{<floatname>} to appear in a new line.
+	os << breakln << "\\begin{" << from_ascii(tmptype) << '}';
+	if (runparams.lastid != -1)
+		os.texrow().start(runparams.lastid, runparams.lastpos);
 	// We only output placement if different from the def_placement.
 	// sidewaysfloats always use their own page
-	if (!placement.empty() && !params_.sideways) {
+	if (!placement.empty() && !params_.sideways)
 		os << '[' << from_ascii(placement) << ']';
-	}
 	os << '\n';
 
-	int const i = InsetText::latex(os, runparams);
-
-	// The \n is used to force \end{<floatname>} to appear in a new line.
-	// In this case, we do not case if the current output line is empty.
-	os << "\n\\end{" << from_ascii(tmptype) << "}\n";
+	InsetText::latex(os, runparams);
 
-	return i + 4;
+	// Force \end{<floatname>} to appear in a new line.
+	os << breakln << "\\end{" << from_ascii(tmptype) << "}\n";
 }
 
 
-int InsetFloat::plaintext(odocstream & os, OutputParams const & runparams) const
+int InsetFloat::plaintext(odocstringstream & os, OutputParams const & runparams, size_t max_length) const
 {
 	os << '[' << buffer().B_("float") << ' '
-		<< floatName(params_.type, buffer().params()) << ":\n";
-	InsetText::plaintext(os, runparams);
+		<< floatName(params_.type) << ":\n";
+	InsetText::plaintext(os, runparams, max_length);
 	os << "\n]";
 
 	return PLAINTEXT_NEWLINE + 1; // one char on a separate line
@@ -372,97 +421,109 @@ int InsetFloat::docbook(odocstream & os, OutputParams const & runparams) const
 
 bool InsetFloat::insetAllowed(InsetCode code) const
 {
-	return code != FOOT_CODE
-	    && code != MARGIN_CODE
-	    && (code != FLOAT_CODE || !params_.subfloat);
+	// The case that code == FLOAT_CODE is handled in Text3.cpp, 
+	// because we need to know what type of float is meant.
+	switch(code) {
+	case WRAP_CODE:
+	case FOOT_CODE:
+	case MARGIN_CODE:
+		return false;
+	default:
+		return InsetCaptionable::insetAllowed(code);
+	}
+}
+
+
+void InsetFloat::setWide(bool w, bool update_label)
+{
+	if (!buffer().params().documentClass().floats().allowsWide(params_.type))
+		params_.wide = false;
+	else
+	    params_.wide = w;
+	if (update_label)
+		setNewLabel();
 }
 
 
-bool InsetFloat::showInsetDialog(BufferView * bv) const
+void InsetFloat::setSideways(bool s, bool update_label)
 {
-	if (!InsetText::showInsetDialog(bv))
-		bv->showDialog("float", params2string(params()),
-			const_cast<InsetFloat *>(this));
-	return true;
+	if (!buffer().params().documentClass().floats().allowsSideways(params_.type))
+		params_.sideways = false;
+	else
+		params_.sideways = s;
+	if (update_label)
+		setNewLabel();
 }
 
 
-void InsetFloat::setWide(bool w, BufferParams const & bp)
+void InsetFloat::setSubfloat(bool s, bool update_label)
 {
-	params_.wide = w;
-	docstring lab = _("float: ") + floatName(params_.type, bp);
-	if (params_.wide)
-		lab += '*';
-	setLabel(lab);
+	params_.subfloat = s;
+	if (update_label)
+		setNewLabel();
 }
 
 
-void InsetFloat::setSideways(bool s, BufferParams const & bp)
+void InsetFloat::setNewLabel()
 {
-	params_.sideways = s;
-	docstring lab = _("float: ") + floatName(params_.type, bp);
-	if (params_.sideways)
+	docstring lab = _("float: ");
+
+	if (params_.subfloat)
+		lab = _("subfloat: ");
+
+	lab += floatName(params_.type);
+
+	FloatList const & floats = buffer().params().documentClass().floats();
+
+	if (params_.wide && floats.allowsWide(params_.type))
+		lab += '*';
+
+	if (params_.sideways && floats.allowsSideways(params_.type))
 		lab += _(" (sideways)");
+
 	setLabel(lab);
 }
 
 
-void InsetFloat::setSubfloat(bool s, BufferParams const & bp)
+bool InsetFloat::allowsCaptionVariation(std::string const & newtype) const
 {
-	params_.subfloat = s;
-	docstring lab = _("float: ") + floatName(params_.type, bp);
-	if (s)
-		lab = _("subfloat: ") + floatName(params_.type, bp);
-	setLabel(lab);
+	return !params_.subfloat && newtype != "Unnumbered";
 }
 
 
 docstring InsetFloat::getCaption(OutputParams const & runparams) const
 {
-	if (paragraphs().empty())
-		return docstring();
-
-	ParagraphList::const_iterator pit = paragraphs().begin();
-	for (; pit != paragraphs().end(); ++pit) {
-		InsetList::const_iterator it = pit->insetList().begin();
-		for (; it != pit->insetList().end(); ++it) {
-			Inset & inset = *it->inset;
-			if (inset.lyxCode() == CAPTION_CODE) {
-				odocstringstream ods;
-				InsetCaption * ins =
-					static_cast<InsetCaption *>(it->inset);
-				ins->getOptArg(ods, runparams);
-				ods << '[';
-				ins->getArgument(ods, runparams);
-				ods << ']';
-				return ods.str();
-			}
-		}
-	}
-	return docstring();
+	TexRow texrow(false);
+	odocstringstream ods;
+	otexstream os(ods, texrow);
+	getCaption(os, runparams);
+	return ods.str();
 }
 
 
-docstring InsetFloat::getCaptionText(OutputParams const & runparams) const
+void InsetFloat::getCaption(otexstream & os,
+							OutputParams const & runparams) const
 {
 	if (paragraphs().empty())
-		return docstring();
-
-	ParagraphList::const_iterator pit = paragraphs().begin();
-	for (; pit != paragraphs().end(); ++pit) {
-		InsetList::const_iterator it = pit->insetList().begin();
-		for (; it != pit->insetList().end(); ++it) {
-			Inset & inset = *it->inset;
-			if (inset.lyxCode() == CAPTION_CODE) {
-				odocstringstream ods;
-				InsetCaption * ins =
-					static_cast<InsetCaption *>(it->inset);
-				ins->getCaptionText(ods, runparams);
-				return ods.str();
-			}
-		}
-	}
-	return docstring();
+		return;
+
+	InsetCaption const * ins = getCaptionInset();
+	if (ins == 0)
+		return;
+
+	ins->getArgs(os, runparams);
+
+	os << '[';
+	TexRow texrow;
+	odocstringstream ods;
+	otexstream oss(ods, texrow);
+	ins->getArgument(oss, runparams);
+	docstring arg = ods.str();
+	// Protect ']'
+	if (arg.find(']') != docstring::npos)
+		arg = '{' + arg + '}';
+	os.append(arg, texrow);
+	os << ']';
 }
 
 
@@ -476,8 +537,6 @@ void InsetFloat::string2params(string const & in, InsetFloatParams & params)
 	Lexer lex;
 	lex.setStream(data);
 	lex.setContext("InsetFloat::string2params");
-	lex >> "float" >> "Float";
-	lex >> params.type; // We have to read the type here!
 	params.read(lex);
 }
 
@@ -485,7 +544,6 @@ void InsetFloat::string2params(string const & in, InsetFloatParams & params)
 string InsetFloat::params2string(InsetFloatParams const & params)
 {
 	ostringstream data;
-	data << "float" << ' ';
 	params.write(data);
 	return data.str();
 }