X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetFloat.cpp;h=0b6ed66fd99e24b3c2a02ffa540e53fb70128ee7;hb=245c2b3c45dce1f5f385665e932ee19c9a904081;hp=d201a29194fb240f947202cbe722b37b5cf2cdad;hpb=f9b81e51e943bcaac885d74edbce41a9d74ad3dd;p=lyx.git diff --git a/src/insets/InsetFloat.cpp b/src/insets/InsetFloat.cpp index d201a29194..0b6ed66fd9 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,22 +25,21 @@ #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" #include "support/lstrings.h" -#include "support/docstream.h" #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}[] // \floatname{algorithm}{Algorithm} @@ -112,34 +111,53 @@ 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) + : InsetCollapsable(buf) { - setLabel(_("float: ") + floatName(type, buf.params())); - params_.type = type; + string2params(params_str, params_); +} + + +docstring InsetFloat::layoutName() const +{ + return "Float:" + from_utf8(params_.type); } -InsetFloat::~InsetFloat() +docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const { - hideDialogs("float", this); + 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; 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(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; } @@ -158,46 +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::updateLabels(ParIterator const & it) +void InsetFloat::updateBuffer(ParIterator const & it, UpdateType utype) { - Counters & cnts = buffer().params().documentClass().counters(); + 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); + 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()); + setSubfloat(subflt); // Tell to captions what the current float is cnts.current_float(params().type); cnts.isSubfloat(subflt); - InsetCollapsable::updateLabels(it); + 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"; @@ -216,37 +255,18 @@ 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(ostream & os) const { + os << "Float "; params_.write(os); InsetCollapsable::write(os); } @@ -255,10 +275,12 @@ void InsetFloat::write(ostream & os) const 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); + // 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))); } @@ -270,38 +292,69 @@ 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); + features.useFloat(params_.type, features.inFloat()); + features.inFloat(true); InsetCollapsable::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; + + OutputParams rp = runparams_in; + rp.moving_arg = true; docstring const caption = getCaption(rp); if (!caption.empty()) { os << caption; } os << '{'; - int const i = InsetText::latex(os, runparams); + // 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 << "}"; - - return i + 1; + + return; } + OutputParams runparams(runparams_in); + runparams.inFloat = OutputParams::MAINFLOAT; FloatList const & floats = buffer().params().documentClass().floats(); string tmptype = params_.type; @@ -328,32 +381,28 @@ int InsetFloat::latex(odocstream & os, OutputParams const & runparams) const placement = buf_placement; } - // The \n is used to force \begin{} 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{} 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{} 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{} 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 @@ -374,48 +423,65 @@ 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 InsetCollapsable::insetAllowed(code); + } +} + + +void InsetFloat::setWide(bool w, bool update_label) +{ + 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(this)); - return true; + 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); + 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::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 != "LongTableNoNumber"; } @@ -424,24 +490,25 @@ 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(it->inset); - ins->getOptArg(ods, runparams); - ods << '['; - ins->getArgument(ods, runparams); - ods << ']'; - return ods.str(); - } - } - } - 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(); } @@ -452,27 +519,9 @@ void InsetFloat::string2params(string const & in, InsetFloatParams & params) return; istringstream data(in); - Lexer lex(0,0); + Lexer lex; lex.setStream(data); - - string name; - lex >> name; - if (!lex || name != "float") { - LYXERR0("InsetFloat::string2params(" << in << ")\n" - "Expected arg 1 to be \"float\"\n"); - } - - // This is part of the inset proper that is usually swallowed - // by Text::readInset - string id; - lex >> id; - if (!lex || id != "Float") { - LYXERR0("InsetFloat::string2params(" << in << ")\n" - "Expected arg 1 to be \"Float\"\n"); - } - - // We have to read the type here! - lex >> params.type; + lex.setContext("InsetFloat::string2params"); params.read(lex); } @@ -480,7 +529,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(); }