]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetfloat.C
* src/LyXAction.C: mark goto-clear-bookmark as working without buffer
[lyx.git] / src / insets / insetfloat.C
index b43540ccdc1ea5d4f3240f2c4dcdecd54529de1f..523602e99361a87d2c99d5aaa6e250bb88961eca 100644 (file)
@@ -6,31 +6,46 @@
  * \author Jürgen Vigna
  * \author Lars Gullik Bjønnes
  *
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  */
-#include <config.h>
 
+#include <config.h>
 
 #include "insetfloat.h"
-#include "gettext.h"
-#include "lyxfont.h"
+
+#include "buffer.h"
+#include "bufferparams.h"
 #include "BufferView.h"
-#include "lyxtext.h"
-#include "insets/insettext.h"
-#include "support/LOstream.h"
-#include "support/lstrings.h"
-#include "FloatList.h"
-#include "LaTeXFeatures.h"
+#include "cursor.h"
 #include "debug.h"
+#include "dispatchresult.h"
 #include "Floating.h"
-#include "buffer.h"
-#include "frontends/LyXView.h"
-#include "frontends/Dialogs.h"
+#include "FloatList.h"
+#include "funcrequest.h"
+#include "FuncStatus.h"
+#include "gettext.h"
+#include "LaTeXFeatures.h"
+#include "LColor.h"
 #include "lyxlex.h"
-#include "iterators.h"
+#include "outputparams.h"
+#include "paragraph.h"
+#include "TocBackend.h"
+
+#include "support/lstrings.h"
+#include "support/convert.h"
+
+
+namespace lyx {
+
+using support::contains;
 
-using std::ostream;
 using std::endl;
+using std::string;
+using std::auto_ptr;
+using std::istringstream;
+using std::ostream;
+using std::ostringstream;
+
 
 // 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
@@ -99,146 +114,194 @@ using std::endl;
 //
 // Lgb
 
-namespace {
-
-// this should not be hardcoded, but be part of the definition
-// of the float (JMarc)
-string const caplayout("Caption");
-
-string floatname(string const & type, BufferParams const & bp)
-{
-       FloatList const & floats = bp.getLyXTextClass().floats();
-       FloatList::const_iterator it = floats[type];
-       if (it == floats.end())
-               return type;
-
-       return _(it->second.name());
-}
-
-} // namespace anon
-
 
 InsetFloat::InsetFloat(BufferParams const & bp, string const & type)
-       : InsetCollapsable(bp), wide_(false)
+       : InsetCollapsable(bp)
 {
-       string lab(_("float: "));
-       lab += floatname(type, bp);
-       setLabel(lab);
+       setLabel(_("float: ") + floatName(type, bp));
        LyXFont font(LyXFont::ALL_SANE);
        font.decSize();
        font.decSize();
        font.setColor(LColor::collapsable);
        setLabelFont(font);
-       floatType_ = type;
-       setInsetName(type);
-       LyXTextClass const & tclass = bp.getLyXTextClass();
-       if (tclass.hasLayout(caplayout))
-               inset.paragraph()->layout(tclass[caplayout]);
+       params_.type = type;
+       setInsetName(from_utf8(type));
 }
 
 
-InsetFloat::InsetFloat(InsetFloat const & in, bool same_id)
-       : InsetCollapsable(in, same_id), floatType_(in.floatType_),
-         floatPlacement_(in.floatPlacement_), wide_(in.wide_)
-{}
+InsetFloat::~InsetFloat()
+{
+       InsetFloatMailer(*this).hideDialog();
+}
 
 
-InsetFloat::~InsetFloat()
+void InsetFloat::doDispatch(LCursor & cur, FuncRequest & cmd)
 {
-       hideDialog();
+       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());
+               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);
+               break;
+       }
+
+       default:
+               InsetCollapsable::doDispatch(cur, cmd);
+               break;
+       }
 }
 
 
-void InsetFloat::write(Buffer const * buf, ostream & os) const
+bool InsetFloat::getStatus(LCursor & cur, FuncRequest const & cmd,
+               FuncStatus & flag) const
 {
-       os << "Float " // getInsetName()
-          << floatType_ << '\n';
+       switch (cmd.action) {
 
-       if (!floatPlacement_.empty()) {
-               os << "placement " << floatPlacement_ << "\n";
+       case LFUN_INSET_MODIFY:
+       case LFUN_INSET_DIALOG_UPDATE:
+               flag.enabled(true);
+               return true;
+
+       default:
+               return InsetCollapsable::getStatus(cur, cmd, flag);
        }
-       if (wide_) {
+}
+
+
+void InsetFloatParams::write(ostream & os) const
+{
+       os << "Float " << type << '\n';
+
+       if (!placement.empty())
+               os << "placement " << placement << "\n";
+
+       if (wide)
                os << "wide true\n";
-       } else {
+       else
                os << "wide false\n";
+
+       if (sideways)
+               os << "sideways true\n";
+       else
+               os << "sideways false\n";
+}
+
+
+void InsetFloatParams::read(LyXLex & lex)
+{
+       string token;
+       lex >> token;
+       if (token == "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);
+       }
+}
+
 
+void InsetFloat::write(Buffer const & buf, ostream & os) const
+{
+       params_.write(os);
        InsetCollapsable::write(buf, os);
 }
 
 
-void InsetFloat::read(Buffer const * buf, LyXLex & lex)
+void InsetFloat::read(Buffer const & buf, LyXLex & lex)
 {
-       if (lex.isOK()) {
-               lex.next();
-               string token = lex.getString();
-               if (token == "placement") {
-                       lex.next();
-                       floatPlacement_ = lex.getString();
-               } else {
-                       // take countermeasures
-                       lex.pushToken(token);
-               }
-               lex.next();
-               token = lex.getString();
-               if (token == "wide") {
-                       lex.next();
-                       string const tmptoken = lex.getString();
-                       if (tmptoken == "true")
-                               wide(true, buf->params);
-                       else
-                               wide(false, buf->params);
-               } else {
-                       lyxerr << "InsetFloat::Read:: Missing wide!"
-                              << endl;
-                       // take countermeasures
-                       lex.pushToken(token);
-               }
-       }
+       params_.read(lex);
+       wide(params_.wide, buf.params());
+       sideways(params_.sideways, buf.params());
        InsetCollapsable::read(buf, lex);
 }
 
 
 void InsetFloat::validate(LaTeXFeatures & features) const
 {
-       if (contains(placement(), "H")) {
+       if (contains(params_.placement, 'H')) {
                features.require("float");
        }
 
-       features.useFloat(floatType_);
+       if (params_.sideways)
+               features.require("rotating");
+
+       features.useFloat(params_.type);
        InsetCollapsable::validate(features);
 }
 
 
-Inset * InsetFloat::clone(Buffer const &, bool same_id) const
+auto_ptr<InsetBase> InsetFloat::doClone() const
 {
-       return new InsetFloat(*const_cast<InsetFloat *>(this), same_id);
+       return auto_ptr<InsetBase>(new InsetFloat(*this));
 }
 
 
-string const InsetFloat::editMessage() const
+docstring const InsetFloat::editMessage() const
 {
        return _("Opened Float Inset");
 }
 
 
-int InsetFloat::latex(Buffer const * buf,
-                     ostream & os, bool fragile, bool fp) const
+int InsetFloat::latex(Buffer const & buf, odocstream & os,
+                     OutputParams const & runparams) const
 {
-       FloatList const & floats = buf->params.getLyXTextClass().floats();
-       string const tmptype = (wide_ ? floatType_ + "*" : floatType_);
+       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";
+       }
        // 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 def_placement = floats.defaultPlacement(floatType_);
-       if (!floatPlacement_.empty()
-           && floatPlacement_ != def_placement) {
-               placement = floatPlacement_;
-       } else if (floatPlacement_.empty()
+       string const buf_placement = buf.params().float_placement;
+       string const def_placement = floats.defaultPlacement(params_.type);
+       if (!params_.placement.empty()
+           && params_.placement != def_placement) {
+               placement = params_.placement;
+       } else if (params_.placement.empty()
                   && !buf_placement.empty()
                   && buf_placement != def_placement) {
                placement = buf_placement;
@@ -247,110 +310,140 @@ int InsetFloat::latex(Buffer const * buf,
        // 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{" << tmptype << '}';
+       os << "%\n\\begin{" << from_ascii(tmptype) << '}';
        // We only output placement if different from the def_placement.
-       if (!placement.empty()) {
-               os << '[' << placement << ']';
+       // sidewaysfloats always use their own page
+       if (!placement.empty() && !params_.sideways) {
+               os << '[' << from_ascii(placement) << ']';
        }
        os << '\n';
 
-       int const i = inset.latex(buf, os, fragile, fp);
+       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{" << tmptype << "}\n";
+       os << "\n\\end{" << from_ascii(tmptype) << "}\n";
 
        return i + 4;
 }
 
 
-int InsetFloat::docbook(Buffer const * buf, ostream & os, bool mixcont) const
+int InsetFloat::docbook(Buffer const & buf, odocstream & os,
+                       OutputParams const & runparams) const
 {
-       os << '<' << floatType_ << '>';
-       int const i = inset.docbook(buf, os, mixcont);
-       os << "</" << floatType_ << '>';
+        // FIXME UNICODE
+        os << '<' << from_ascii(params_.type) << '>';
+       int const i = InsetText::docbook(buf, os, runparams);
+       os << "</" << from_ascii(params_.type) << '>';
 
        return i;
 }
 
 
-bool InsetFloat::insetAllowed(Inset::Code code) const
+bool InsetFloat::insetAllowed(InsetBase::Code code) const
 {
-       if (code == Inset::FLOAT_CODE)
-               return false;
-       if (inset.getLockingInset() != const_cast<InsetFloat *>(this))
-               return inset.insetAllowed(code);
-       if ((code == Inset::FOOT_CODE) || (code == Inset::MARGIN_CODE))
-               return false;
-       return true;
+       return code != InsetBase::FLOAT_CODE
+           && code != InsetBase::FOOT_CODE
+           && code != InsetBase::MARGIN_CODE;
 }
 
 
 bool InsetFloat::showInsetDialog(BufferView * bv) const
 {
-       if (!inset.showInsetDialog(bv)) {
-               bv->owner()->getDialogs().showFloat(const_cast<InsetFloat *>(this));
-       }
+       if (!InsetText::showInsetDialog(bv))
+               InsetFloatMailer(const_cast<InsetFloat &>(*this)).showDialog(bv);
        return true;
 }
 
 
-string const & InsetFloat::type() const
+void InsetFloat::wide(bool w, BufferParams const & bp)
 {
-       return floatType_;
+       params_.wide = w;
+       docstring lab = _("float: ") + floatName(params_.type, bp);
+       if (params_.wide)
+               lab += '*';
+       setLabel(lab);
 }
 
 
-void InsetFloat::placement(string const & p)
+void InsetFloat::sideways(bool s, BufferParams const & bp)
 {
-       // FIX: Here we should only allow the placement to be set
-       // if a valid value.
-       floatPlacement_ = p;
+       params_.sideways = s;
+       docstring lab = _("float: ") + floatName(params_.type, bp);
+       if (params_.sideways)
+               lab += _(" (sideways)");
+       setLabel(lab);
 }
 
 
-string const & InsetFloat::placement() const
+void InsetFloat::addToToc(TocList & toclist, Buffer const & buf) const
 {
-       return floatPlacement_;
+       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;
+               }
+       }
 }
 
 
-void InsetFloat::wide(bool w, BufferParams const & bp)
-{
-       wide_ = w;
+string const InsetFloatMailer::name_("float");
 
-       string lab(_("float:"));
-       lab += floatname(floatType_, bp);
+InsetFloatMailer::InsetFloatMailer(InsetFloat & inset)
+       : inset_(inset)
+{}
 
-       if (wide_)
-               lab += '*';
 
-       setLabel(lab);
+string const InsetFloatMailer::inset2string(Buffer const &) const
+{
+       return params2string(inset_.params());
 }
 
 
-bool InsetFloat::wide() const
+void InsetFloatMailer::string2params(string const & in,
+                                    InsetFloatParams & params)
 {
-       return wide_;
+       params = InsetFloatParams();
+       if (in.empty())
+               return;
+
+       istringstream data(in);
+       LyXLex lex(0,0);
+       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;
+       params.read(lex);
 }
 
 
-void InsetFloat::addToToc(toc::TocList & toclist, Buffer const * buf) const
+string const InsetFloatMailer::params2string(InsetFloatParams const & params)
 {
-       ParIterator pit(inset.paragraph());
-       ParIterator end;
-
-       // Find a caption layout in one of the (child inset's) pars
-       for (; pit != end; ++pit) {
-               Paragraph * tmp = *pit;
-
-               if (tmp->layout()->name() == caplayout) {
-                       string const name = floatname(type(), buf->params);
-                       string const str =
-                               tostr(toclist[name].size() + 1)
-                               + ". " + tmp->asString(buf, false);
-                       toc::TocItem const item(tmp, 0 , str);
-                       toclist[name].push_back(item);
-               }
-       }
+       ostringstream data;
+       data << name_ << ' ';
+       params.write(data);
+       return data.str();
 }
+
+
+} // namespace lyx