X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetFloat.cpp;h=0b6ed66fd99e24b3c2a02ffa540e53fb70128ee7;hb=245c2b3c45dce1f5f385665e932ee19c9a904081;hp=61c7411b6e1a83d6509d0af4aa55bd51bae0a27c;hpb=51fbea02a8f7dc1e360a61bdc95d5ac9200cb5f6;p=lyx.git

diff --git a/src/insets/InsetFloat.cpp b/src/insets/InsetFloat.cpp
index 61c7411b6e..0b6ed66fd9 100644
--- a/src/insets/InsetFloat.cpp
+++ b/src/insets/InsetFloat.cpp
@@ -3,8 +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 Vigna
+ * \author Lars Gullik Bjønnes
+ * \author Jürgen Spitzmüller
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -12,40 +13,36 @@
 #include <config.h>
 
 #include "InsetFloat.h"
+#include "InsetCaption.h"
 
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "BufferView.h"
+#include "Counters.h"
 #include "Cursor.h"
-#include "debug.h"
 #include "DispatchResult.h"
 #include "Floating.h"
 #include "FloatList.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
-#include "gettext.h"
 #include "LaTeXFeatures.h"
-#include "Color.h"
 #include "Lexer.h"
-#include "OutputParams.h"
-#include "Paragraph.h"
-#include "TocBackend.h"
+#include "output_xhtml.h"
+#include "ParIterator.h"
+#include "TextClass.h"
 
+#include "support/debug.h"
+#include "support/docstream.h"
+#include "support/gettext.h"
 #include "support/lstrings.h"
-#include "support/convert.h"
 
+#include "frontends/Application.h"
 
-namespace lyx {
-
-using support::contains;
+using namespace std;
+using namespace lyx::support;
 
-using std::endl;
-using std::string;
-using std::auto_ptr;
-using std::istringstream;
-using std::ostream;
-using std::ostringstream;
 
+namespace lyx {
 
 // With this inset it will be possible to support the latex package
 // float.sty, and I am sure that with this and some additional support
@@ -53,7 +50,7 @@ using std::ostringstream;
 // (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:
@@ -90,7 +87,7 @@ using std::ostringstream;
 //   \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}
@@ -114,52 +111,58 @@ using std::ostringstream;
 //
 // Lgb
 
-
-InsetFloat::InsetFloat(BufferParams const & bp, string const & type)
-	: InsetCollapsable(bp), name_(from_utf8(type))
+//FIXME: why do we set in stone the type here?
+InsetFloat::InsetFloat(Buffer * buf, string params_str)
+	: InsetCollapsable(buf)
 {
-	setLabel(_("float: ") + floatName(type, bp));
-	LyXFont font(LyXFont::ALL_SANE);
-	font.decSize();
-	font.decSize();
-	font.setColor(Color::collapsable);
-	setLabelFont(font);
-	params_.type = type;
+	string2params(params_str, params_);
 }
 
 
-InsetFloat::~InsetFloat()
+docstring InsetFloat::layoutName() const
+{ 
+	return "Float:" + from_utf8(params_.type);
+}
+
+
+docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const
 {
-	InsetFloatMailer(*this).hideDialog();
+	if (isOpen(bv))
+		return InsetCollapsable::toolTip(bv, x, y);
+
+	OutputParams rp(&buffer().params().encoding());
+	return getCaptionText(rp);
 }
 
 
 void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-	switch (cmd.action) {
+	switch (cmd.action()) {
 
 	case LFUN_INSET_MODIFY: {
 		InsetFloatParams params;
-		InsetFloatMailer::string2params(to_utf8(cmd.argument()), params);
-		params_.placement = params.placement;
-		params_.wide      = params.wide;
-		params_.sideways  = params.sideways;
-		wide(params_.wide, cur.buffer().params());
-		sideways(params_.sideways, cur.buffer().params());
+		string2params(to_utf8(cmd.argument()), params);
+		cur.recordUndoInset(ATOMIC_UNDO, 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) {
+			params_.type = params.type;
+			cur.forceBufferUpdate();
+		}
+		// what we really want here is a TOC update, but that means
+		// a full buffer update
+		cur.forceBufferUpdate();
 		break;
 	}
 
 	case LFUN_INSET_DIALOG_UPDATE: {
-		InsetFloatMailer(*this).updateDialog(&cur.bv());
-		break;
-	}
-
-	case LFUN_MOUSE_RELEASE: {
-		if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
-			InsetFloatMailer(*this).showDialog(&cur.bv());
-			break;
-		}
-		InsetCollapsable::doDispatch(cur, cmd);
+		cur.bv().updateDialog("float", params2string(params()));
 		break;
 	}
 
@@ -173,22 +176,67 @@ 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.enabled(true);
+		flag.setEnabled(true);
 		return true;
 
+	case LFUN_INSET_SETTINGS:
+		if (InsetCollapsable::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);
 	}
 }
 
 
+void InsetFloat::updateBuffer(ParIterator const & it, UpdateType utype)
+{
+	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::updateBuffer(it, utype);
+
+	//reset afterwards
+	cnts.current_float(saveflt);
+	if (utype == OutputUpdate)
+		cnts.restoreLastCounter();
+	cnts.isSubfloat(savesubflt);
+}
+
+
 void InsetFloatParams::write(ostream & os) const
 {
-	os << "Float " << type << '\n';
+	os << type << '\n';
 
 	if (!placement.empty())
 		os << "placement " << placement << "\n";
@@ -207,95 +255,122 @@ void InsetFloatParams::write(ostream & os) const
 
 void InsetFloatParams::read(Lexer & lex)
 {
-	string token;
-	lex >> token;
-	if (token == "placement") {
+	lex.setContext("InsetFloatParams::read");
+	lex >> type;
+	if (lex.checkFor("placement"))
 		lex >> placement;
-	} else {
-		// take countermeasures
-		lex.pushToken(token);
-	}
-	lex >> token;
-	if (token == "wide") {
-		lex >> wide;
-	} else {
-		lyxerr << "InsetFloat::Read:: Missing wide!"
-		<< endl;
-		// take countermeasures
-		lex.pushToken(token);
-	}
-	lex >> token;
-	if (token == "sideways") {
-		lex >> sideways;
-	} else {
-		lyxerr << "InsetFloat::Read:: Missing sideways!"
-		<< endl;
-		// take countermeasures
-		lex.pushToken(token);
-	}
+	lex >> "wide" >> wide;
+	lex >> "sideways" >> sideways;
 }
 
 
-void InsetFloat::write(Buffer const & buf, ostream & os) const
+void InsetFloat::write(ostream & os) const
 {
+	os << "Float ";
 	params_.write(os);
-	InsetCollapsable::write(buf, os);
+	InsetCollapsable::write(os);
 }
 
 
-void InsetFloat::read(Buffer const & buf, Lexer & lex)
+void InsetFloat::read(Lexer & lex)
 {
 	params_.read(lex);
-	wide(params_.wide, buf.params());
-	sideways(params_.sideways, buf.params());
-	InsetCollapsable::read(buf, 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)));
 }
 
 
 void InsetFloat::validate(LaTeXFeatures & features) const
 {
-	if (contains(params_.placement, 'H')) {
+	if (support::contains(params_.placement, 'H'))
 		features.require("float");
-	}
 
 	if (params_.sideways)
-		features.require("rotating");
+		features.require("rotfloat");
 
-	features.useFloat(params_.type);
+	if (features.inFloat())
+		features.require("subfig");
+
+	features.useFloat(params_.type, features.inFloat());
+	features.inFloat(true);
 	InsetCollapsable::validate(features);
+	features.inFloat(false);
 }
 
 
-auto_ptr<InsetBase> InsetFloat::doClone() const
+docstring InsetFloat::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 {
-	return auto_ptr<InsetBase>(new InsetFloat(*this));
+	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;
 }
 
 
-docstring const InsetFloat::editMessage() const
+void InsetFloat::latex(otexstream & os, OutputParams const & runparams_in) const
 {
-	return _("Opened Float Inset");
-}
-
+	if (runparams_in.inFloat != OutputParams::NONFLOAT) {
+		if (runparams_in.moving_arg)
+			os << "\\protect";
+		os << "\\subfloat";
+
+		OutputParams rp = runparams_in;
+		rp.moving_arg = true;
+		docstring const caption = getCaption(rp);
+		if (!caption.empty()) {
+			os << caption;
+		}
+		os << '{';
+		// The main argument is the contents of the float. This is not a moving argument.
+		rp.moving_arg = false;
+		rp.inFloat = OutputParams::SUBFLOAT;
+		InsetText::latex(os, rp);
+		os << "}";
 
-int InsetFloat::latex(Buffer const & buf, odocstream & os,
-                      OutputParams const & runparams) const
-{
-	FloatList const & floats = buf.params().getLyXTextClass().floats();
-	string tmptype = (params_.wide ? params_.type + "*" : params_.type);
-	if (params_.sideways) {
-		if (params_.type == "table")
-			tmptype = "sidewaystable";
-		else if (params_.type == "figure")
-			tmptype = "sidewaysfigure";
+		return;
 	}
+	OutputParams runparams(runparams_in);
+	runparams.inFloat = OutputParams::MAINFLOAT;
+
+	FloatList const & floats = buffer().params().documentClass().floats();
+	string tmptype = params_.type;
+	if (params_.sideways)
+		tmptype = "sideways" + params_.type;
+	if (params_.wide && (!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 const buf_placement = buf.params().float_placement;
+	string const buf_placement = buffer().params().float_placement;
 	string const def_placement = floats.defaultPlacement(params_.type);
 	if (!params_.placement.empty()
 	    && params_.placement != def_placement) {
@@ -306,157 +381,154 @@ int InsetFloat::latex(Buffer const & buf, odocstream & os,
 		placement = buf_placement;
 	}
 
-	// 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(buf, 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(Buffer const & buf, odocstream & os,
-                          OutputParams const & runparams) const
+int InsetFloat::plaintext(odocstringstream & os, OutputParams const & runparams, size_t max_length) const
 {
-	os << '[' << _("float") << ' ' << floatName(params_.type, buf.params()) << ":\n";
-	InsetText::plaintext(buf, os, runparams);
+	os << '[' << buffer().B_("float") << ' '
+		<< floatName(params_.type) << ":\n";
+	InsetText::plaintext(os, runparams, max_length);
 	os << "\n]";
 
 	return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 }
 
 
-int InsetFloat::docbook(Buffer const & buf, odocstream & os,
-                        OutputParams const & runparams) const
+int InsetFloat::docbook(odocstream & os, OutputParams const & runparams) const
 {
-        // FIXME UNICODE
-        os << '<' << from_ascii(params_.type) << '>';
-	int const i = InsetText::docbook(buf, os, runparams);
+	// FIXME Implement subfloat!
+	// FIXME UNICODE
+	os << '<' << from_ascii(params_.type) << '>';
+	int const i = InsetText::docbook(os, runparams);
 	os << "</" << from_ascii(params_.type) << '>';
 
 	return i;
 }
 
 
-bool InsetFloat::insetAllowed(InsetBase::Code code) const
+bool InsetFloat::insetAllowed(InsetCode code) const
 {
-	return code != InsetBase::FLOAT_CODE
-	    && code != InsetBase::FOOT_CODE
-	    && code != InsetBase::MARGIN_CODE;
+	// 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 InsetCollapsable::insetAllowed(code);
+	}
 }
 
 
-bool InsetFloat::showInsetDialog(BufferView * bv) const
+void InsetFloat::setWide(bool w, bool update_label)
 {
-	if (!InsetText::showInsetDialog(bv))
-		InsetFloatMailer(const_cast<InsetFloat &>(*this)).showDialog(bv);
-	return true;
+	params_.wide = w;
+	if (update_label)
+		setNewLabel();
 }
 
 
-void InsetFloat::wide(bool w, BufferParams const & bp)
+void InsetFloat::setSideways(bool s, bool update_label)
 {
-	params_.wide = w;
-	docstring lab = _("float: ") + floatName(params_.type, bp);
-	if (params_.wide)
-		lab += '*';
-	setLabel(lab);
+	params_.sideways = s;
+	if (update_label)
+		setNewLabel();
 }
 
 
-void InsetFloat::sideways(bool s, BufferParams const & bp)
+void InsetFloat::setSubfloat(bool s, bool update_label)
 {
-	params_.sideways = s;
-	docstring lab = _("float: ") + floatName(params_.type, bp);
+	params_.subfloat = s;
+	if (update_label)
+		setNewLabel();
+}
+
+
+void InsetFloat::setNewLabel()
+{
+	docstring lab = _("float: ");
+
+	if (params_.subfloat)
+		lab = _("subfloat: ");
+
+	lab += floatName(params_.type);
+
+	if (params_.wide)
+		lab += '*';
+
 	if (params_.sideways)
 		lab += _(" (sideways)");
+
 	setLabel(lab);
 }
 
 
-void InsetFloat::addToToc(TocList & toclist, Buffer const & buf) const
+bool InsetFloat::allowsCaptionVariation(std::string const & newtype) const
 {
-	// Is there a need to provide a list of float insets?
-	return;
-
-	// Abdel (01/02/2006): I'll let this code for reference in case
-	// there's a need to do something similar for another kind of
-	// inset.
-	ParConstIterator pit = par_const_iterator_begin(*this);
-	ParConstIterator end = par_const_iterator_end(*this);
-
-	// Find a caption layout in one of the (child inset's) pars
-	for (; pit != end; ++pit) {
-		if (pit->layout()->labeltype == LABEL_SENSITIVE) {
-			Toc & toc = toclist[params_.type];
-			docstring const str =
-				convert<docstring>(toc.size() + 1)
-				+ ". " + pit->asString(buf, false);
-			toc.push_back(TocItem(pit, 0, str));
-			return;
-		}
-	}
+	return !params_.subfloat && newtype != "LongTableNoNumber";
 }
 
 
-string const InsetFloatMailer::name_("float");
-
-InsetFloatMailer::InsetFloatMailer(InsetFloat & inset)
-	: inset_(inset)
-{}
-
-
-string const InsetFloatMailer::inset2string(Buffer const &) const
+docstring InsetFloat::getCaption(OutputParams const & runparams) const
 {
-	return params2string(inset_.params());
+	if (paragraphs().empty())
+		return docstring();
+
+	InsetCaption const * ins = getCaptionInset();
+	if (ins == 0)
+		return docstring();
+
+	TexRow texrow;
+	odocstringstream ods;
+	otexstream os(ods, texrow);
+	ins->getArgs(os, runparams);
+	ods << '[';
+	odocstringstream odss;
+	otexstream oss(odss, texrow);
+	ins->getArgument(oss, runparams);
+	docstring arg = odss.str();
+	// Protect ']'
+	if (arg.find(']') != docstring::npos)
+		arg = '{' + arg + '}';
+	ods << arg;
+	ods << ']';
+	return ods.str();
 }
 
 
-void InsetFloatMailer::string2params(string const & in,
-				     InsetFloatParams & params)
+void InsetFloat::string2params(string const & in, InsetFloatParams & params)
 {
 	params = InsetFloatParams();
 	if (in.empty())
 		return;
 
 	istringstream data(in);
-	Lexer lex(0,0);
+	Lexer lex;
 	lex.setStream(data);
-
-	string name;
-	lex >> name;
-	if (!lex || name != name_)
-		return print_mailer_error("InsetFloatMailer", in, 1, name_);
-
-	// This is part of the inset proper that is usually swallowed
-	// by LyXText::readInset
-	string id;
-	lex >> id;
-	if (!lex || id != "Float")
-		return print_mailer_error("InsetBoxMailer", in, 2, "Float");
-
-	// We have to read the type here!
-	lex >> params.type;
+	lex.setContext("InsetFloat::string2params");
 	params.read(lex);
 }
 
 
-string const InsetFloatMailer::params2string(InsetFloatParams const & params)
+string InsetFloat::params2string(InsetFloatParams const & params)
 {
 	ostringstream data;
-	data << name_ << ' ';
 	params.write(data);
 	return data.str();
 }