]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetFloat.cpp
Whitespace
[lyx.git] / src / insets / InsetFloat.cpp
index 194e4f769a7beeb5e6e039ba9df6d6aff2fb4f2e..0b6ed66fd99e24b3c2a02ffa540e53fb70128ee7 100644 (file)
@@ -27,7 +27,7 @@
 #include "FuncStatus.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
-#include "OutputParams.h"
+#include "output_xhtml.h"
 #include "ParIterator.h"
 #include "TextClass.h"
 
@@ -39,6 +39,7 @@
 #include "frontends/Application.h"
 
 using namespace std;
+using namespace lyx::support;
 
 
 namespace lyx {
@@ -110,31 +111,24 @@ namespace lyx {
 //
 // Lgb
 
-
-InsetFloat::InsetFloat(Buffer const & buf, string const & type)
-       : InsetCollapsable(buf), name_(from_utf8(type))
-{
-       setLabel(_("float: ") + floatName(type, buf.params()));
-       params_.type = type;
-}
-
-
-InsetFloat::~InsetFloat()
+//FIXME: why do we set in stone the type here?
+InsetFloat::InsetFloat(Buffer * buf, string params_str)
+       : InsetCollapsable(buf)
 {
-       hideDialogs("float", this);
+       string2params(params_str, params_);
 }
 
 
-docstring InsetFloat::name() const 
+docstring InsetFloat::layoutName() const
 { 
-       return "Float:" + name_; 
+       return "Float:" + from_utf8(params_.type);
 }
 
 
 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 InsetCollapsable::toolTip(bv, x, y);
 
        OutputParams rp(&buffer().params().encoding());
        return getCaptionText(rp);
@@ -143,22 +137,27 @@ 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(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;
-                       setWide(params_.wide, cur.buffer()->params(), false);
-                       setSideways(params_.sideways, cur.buffer()->params(), false);
                }
-
-               setNewLabel(cur.buffer()->params());
+               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;
        }
 
@@ -177,23 +176,40 @@ 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 (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().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();
 
@@ -202,23 +218,25 @@ void InsetFloat::updateLabels(ParIterator const & it)
        // 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";
@@ -238,6 +256,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;
@@ -247,6 +266,7 @@ void InsetFloatParams::read(Lexer & lex)
 
 void InsetFloat::write(ostream & os) const
 {
+       os << "Float ";
        params_.write(os);
        InsetCollapsable::write(os);
 }
@@ -256,6 +276,11 @@ 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)));
 }
 
 
@@ -277,64 +302,56 @@ void InsetFloat::validate(LaTeXFeatures & features) const
 }
 
 
-docstring InsetFloat::editMessage() const
-{
-       return _("Opened Float Inset");
-}
-
-
-docstring InsetFloat::xhtml(odocstream & os, OutputParams const & rp) const
+docstring InsetFloat::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 {
        FloatList const & floats = buffer().params().documentClass().floats();
        Floating const & ftype = floats.getType(params_.type);
-       string const htmltype = ftype.htmlType().empty() ? 
-                       "div" : ftype.htmlType();
-       string const htmlclass = ftype.htmlClass().empty() ?
-                       "float-" + params_.type : ftype.htmlClass();
-       docstring const otag = 
-                       from_ascii("<" + htmltype + " class='float " + htmlclass + "'>\n");
-       docstring const ctag = from_ascii("</" + htmltype + ">\n");
-
-       odocstringstream out;
-
-       docstring caption = getCaptionHTML(rp);
-       out << otag;
-       if (!caption.empty())
-               out << "<div class='float-caption'>" << caption << "</div>\n";
+       string const & htmltype = ftype.htmlTag();
+       string const & attr = ftype.htmlAttrib();
 
-       docstring def = InsetText::xhtml(out, rp);
-       out << ctag;
+       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.
-               def = out.str() + '\n' + def;
+               deferred = ods.str() + '\n' + deferred;
        else 
                // In this case, the whole thing is already being deferred, so
                // we can write to the stream.
-               os << out.str();
-       return def;
+               // 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_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;
+               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;
-               int const i = InsetText::latex(os, rp);
+               InsetText::latex(os, rp);
                os << "}";
-       
-               return i + 1;
+
+               return;
        }
        OutputParams runparams(runparams_in);
        runparams.inFloat = OutputParams::MAINFLOAT;
@@ -364,32 +381,28 @@ int InsetFloat::latex(odocstream & os, OutputParams const & runparams_in) const
                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(os, runparams);
+       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";
-
-       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
@@ -410,53 +423,51 @@ 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);
-}
-
-
-bool InsetFloat::showInsetDialog(BufferView * bv) const
-{
-       if (!InsetText::showInsetDialog(bv))
-               bv->showDialog("float", params2string(params()),
-                       const_cast<InsetFloat *>(this));
-       return true;
+       // 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, BufferParams const & bp, bool update_label)
+void InsetFloat::setWide(bool w, bool update_label)
 {
        params_.wide = w;
        if (update_label)
-               setNewLabel(bp);
+               setNewLabel();
 }
 
 
-void InsetFloat::setSideways(bool s, BufferParams const & bp, bool update_label)
+void InsetFloat::setSideways(bool s, bool update_label)
 {
        params_.sideways = s;
        if (update_label)
-               setNewLabel(bp);
+               setNewLabel();
 }
 
 
-void InsetFloat::setSubfloat(bool s, BufferParams const & bp, bool update_label)
+void InsetFloat::setSubfloat(bool s, bool update_label)
 {
        params_.subfloat = s;
        if (update_label)
-               setNewLabel(bp);
+               setNewLabel();
 }
 
 
-void InsetFloat::setNewLabel(BufferParams const & bp)
+void InsetFloat::setNewLabel()
 {
        docstring lab = _("float: ");
 
        if (params_.subfloat)
                lab = _("subfloat: ");
 
-       lab += floatName(params_.type, bp);
+       lab += floatName(params_.type);
 
        if (params_.wide)
                lab += '*';
@@ -468,6 +479,12 @@ void InsetFloat::setNewLabel(BufferParams const & bp)
 }
 
 
+bool InsetFloat::allowsCaptionVariation(std::string const & newtype) const
+{
+       return !params_.subfloat && newtype != "LongTableNoNumber";
+}
+
+
 docstring InsetFloat::getCaption(OutputParams const & runparams) const
 {
        if (paragraphs().empty())
@@ -477,10 +494,19 @@ docstring InsetFloat::getCaption(OutputParams const & runparams) const
        if (ins == 0)
                return docstring();
 
+       TexRow texrow;
        odocstringstream ods;
-       ins->getOptArg(ods, runparams);
+       otexstream os(ods, texrow);
+       ins->getArgs(os, runparams);
        ods << '[';
-       ins->getArgument(ods, runparams);
+       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();
 }
@@ -496,8 +522,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);
 }
 
@@ -505,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();
 }