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

diff --git a/src/insets/InsetFloat.cpp b/src/insets/InsetFloat.cpp
index f8807f974c..89a0fbe620 100644
--- a/src/insets/InsetFloat.cpp
+++ b/src/insets/InsetFloat.cpp
@@ -113,13 +113,27 @@ namespace lyx {
 
 //FIXME: why do we set in stone the type here?
 InsetFloat::InsetFloat(Buffer * buf, string params_str)
-	: InsetCollapsable(buf)
+	: InsetCaptionable(buf)
 {
 	string2params(params_str, params_);
+	setCaptionType(params_.type);
 }
 
 
-docstring InsetFloat::name() const 
+// Enforce equality of float type and caption type.
+void InsetFloat::setCaptionType(std::string const & type)
+{
+	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);
 }
@@ -127,8 +141,8 @@ docstring InsetFloat::name() const
 
 docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const
 {
-	if (InsetCollapsable::toolTip(bv, x, y).empty() || isOpen(bv))
-		return docstring();
+	if (isOpen(bv))
+		return InsetCaptionable::toolTip(bv, x, y);
 
 	OutputParams rp(&buffer().params().encoding());
 	return getCaptionText(rp);
@@ -137,11 +151,12 @@ docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const
 
 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);
+		cur.recordUndoInset(this);
 
 		// placement, wide and sideways are not used for subfloats
 		if (!params_.subfloat) {
@@ -150,10 +165,11 @@ void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
 			params_.sideways  = params.sideways;
 		}
 		setNewLabel();
-		if (params_.type != params.type) {
-			params_.type = params.type;
-			buffer().updateLabels();
-		}
+		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;
 	}
 
@@ -163,7 +179,7 @@ void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
 	}
 
 	default:
-		InsetCollapsable::doDispatch(cur, cmd);
+		InsetCaptionable::doDispatch(cur, cmd);
 		break;
 	}
 }
@@ -172,7 +188,7 @@ 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:
@@ -180,53 +196,38 @@ bool InsetFloat::getStatus(Cursor & cur, FuncRequest const & cmd,
 		return true;
 
 	case LFUN_INSET_SETTINGS:
-		if (InsetCollapsable::getStatus(cur, cmd, flag)) {
+		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, UpdateType utype)
+bool InsetFloat::hasSubCaptions(ParIterator const & it) const
 {
-	Counters & cnts =
-		buffer().masterBuffer()->params().documentClass().counters();
-	if (utype == OutputUpdate) {
-		// counters are local to the float
-		cnts.saveLastCounter();
-	}
-	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);
-
-	// Tell to captions what the current float is
-	cnts.current_float(params().type);
-	cnts.isSubfloat(subflt);
-
-	InsetCollapsable::updateLabels(it, utype);
-
-	//reset afterwards
-	cnts.current_float(saveflt);
-	if (utype == OutputUpdate)
-		cnts.restoreLastCounter();
-	cnts.isSubfloat(savesubflt);
+	return (it.innerInsetOfType(FLOAT_CODE) || it.innerInsetOfType(WRAP_CODE));
 }
 
 
 void InsetFloatParams::write(ostream & os) const
 {
-	os << 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";
@@ -258,19 +259,15 @@ 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);
-	InsetCollapsable::read(lex);
-	// check if the float type exists
-	if (buffer().params().documentClass().floats().typeExist(params_.type))
-		setLabel(_("float: ") + floatName(params_.type));
-	else
-		setLabel(bformat(_("ERROR: Unknown float type: %1$s"), from_utf8(params_.type)));
+	InsetCaptionable::read(lex);
+	setCaptionType(params_.type);
 }
 
 
@@ -287,7 +284,7 @@ void InsetFloat::validate(LaTeXFeatures & features) const
 
 	features.useFloat(params_.type, features.inFloat());
 	features.inFloat(true);
-	InsetCollapsable::validate(features);
+	InsetCaptionable::validate(features);
 	features.inFloat(false);
 }
 
@@ -316,84 +313,94 @@ docstring InsetFloat::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 		// 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::NextRaw() << ods.str();
+		xs << XHTMLStream::ESCAPE_NONE << ods.str();
 	return deferred;
 }
 
 
-int InsetFloat::latex(odocstream & os, OutputParams const & runparams_in) const
+void InsetFloat::latex(otexstream & os, OutputParams const & runparams_in) const
 {
 	if (runparams_in.inFloat != OutputParams::NONFLOAT) {
 		if (runparams_in.moving_arg)
 			os << "\\protect";
 		os << "\\subfloat";
-	
+
 		OutputParams rp = runparams_in;
-		docstring const caption = getCaption(rp);
-		if (!caption.empty()) {
-			os << caption;
-		}
+		rp.moving_arg = true;
+		getCaption(os, rp);
 		os << '{';
+		// 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;
-		int const i = InsetText::latex(os, rp);
+		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) << ":\n";
-	InsetText::plaintext(os, runparams);
+	InsetText::plaintext(os, runparams, max_length);
 	os << "\n]";
 
 	return PLAINTEXT_NEWLINE + 1; // one char on a separate line
@@ -422,22 +429,17 @@ bool InsetFloat::insetAllowed(InsetCode code) const
 	case MARGIN_CODE:
 		return false;
 	default:
-		return InsetCollapsable::insetAllowed(code);
+		return InsetCaptionable::insetAllowed(code);
 	}
 }
 
 
-bool InsetFloat::showInsetDialog(BufferView * bv) const
-{
-	if (!InsetText::showInsetDialog(bv))
-		bv->showDialog("float");
-	return true;
-}
-
-
 void InsetFloat::setWide(bool w, bool update_label)
 {
-	params_.wide = w;
+	if (!buffer().params().documentClass().floats().allowsWide(params_.type))
+		params_.wide = false;
+	else
+	    params_.wide = w;
 	if (update_label)
 		setNewLabel();
 }
@@ -445,7 +447,10 @@ void InsetFloat::setWide(bool w, bool update_label)
 
 void InsetFloat::setSideways(bool s, bool update_label)
 {
-	params_.sideways = s;
+	if (!buffer().params().documentClass().floats().allowsSideways(params_.type))
+		params_.sideways = false;
+	else
+		params_.sideways = s;
 	if (update_label)
 		setNewLabel();
 }
@@ -468,31 +473,57 @@ void InsetFloat::setNewLabel()
 
 	lab += floatName(params_.type);
 
-	if (params_.wide)
+	FloatList const & floats = buffer().params().documentClass().floats();
+
+	if (params_.wide && floats.allowsWide(params_.type))
 		lab += '*';
 
-	if (params_.sideways)
+	if (params_.sideways && floats.allowsSideways(params_.type))
 		lab += _(" (sideways)");
 
 	setLabel(lab);
 }
 
 
+bool InsetFloat::allowsCaptionVariation(std::string const & newtype) const
+{
+	return !params_.subfloat && newtype != "Unnumbered";
+}
+
+
 docstring InsetFloat::getCaption(OutputParams const & runparams) const
+{
+	TexRow texrow(false);
+	odocstringstream ods;
+	otexstream os(ods, texrow);
+	getCaption(os, runparams);
+	return ods.str();
+}
+
+
+void InsetFloat::getCaption(otexstream & os,
+							OutputParams const & runparams) const
 {
 	if (paragraphs().empty())
-		return docstring();
+		return;
 
 	InsetCaption const * ins = getCaptionInset();
 	if (ins == 0)
-		return docstring();
+		return;
+
+	ins->getArgs(os, runparams);
 
+	os << '[';
+	TexRow texrow;
 	odocstringstream ods;
-	ins->getOptArg(ods, runparams);
-	ods << '[';
-	ins->getArgument(ods, runparams);
-	ods << ']';
-	return ods.str();
+	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 << ']';
 }