-/* This file is part of
- * ======================================================
+/**
+ * \file insetfloat.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * LyX, The Document Processor
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
*
- * Copyright 1998-2001 The LyX Team.
- *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS
+ */
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "insetfloat.h"
+#include "insettext.h"
+
+#include "buffer.h"
+#include "BufferView.h"
+#include "debug.h"
+#include "Floating.h"
+#include "FloatList.h"
+#include "funcrequest.h"
#include "gettext.h"
+#include "iterators.h"
+#include "LaTeXFeatures.h"
+#include "Lsstream.h"
#include "lyxfont.h"
-#include "BufferView.h"
+#include "lyxlex.h"
#include "lyxtext.h"
-#include "insets/insettext.h"
+#include "Lsstream.h"
+
#include "support/LOstream.h"
#include "support/lstrings.h"
-#include "FloatList.h"
-#include "LaTeXFeatures.h"
-#include "debug.h"
-#include "Floating.h"
-#include "buffer.h"
+#include "support/tostr.h"
+
#include "frontends/LyXView.h"
#include "frontends/Dialogs.h"
-#include "lyxlex.h"
+
+using namespace lyx::support;
using std::ostream;
using std::endl;
+using std::auto_ptr;
+
// 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
InsetFloat::InsetFloat(BufferParams const & bp, string const & type)
- : InsetCollapsable(bp), wide_(false)
+ : InsetCollapsable(bp)
{
string lab(_("float: "));
lab += floatname(type, bp);
font.decSize();
font.setColor(LColor::collapsable);
setLabelFont(font);
- floatType_ = type;
+ params_.type = type;
setInsetName(type);
LyXTextClass const & tclass = bp.getLyXTextClass();
if (tclass.hasLayout(caplayout))
- inset.paragraph()->layout(tclass[caplayout]);
+ inset.paragraphs.begin()->layout(tclass[caplayout]);
}
-InsetFloat::InsetFloat(InsetFloat const & in, bool same_id)
- : InsetCollapsable(in, same_id), floatType_(in.floatType_),
- floatPlacement_(in.floatPlacement_), wide_(in.wide_)
+InsetFloat::InsetFloat(InsetFloat const & in)
+ : InsetCollapsable(in), params_(in.params_)
{}
InsetFloat::~InsetFloat()
{
- hideDialog();
+ InsetFloatMailer mailer(*this);
+ mailer.hideDialog();
}
-void InsetFloat::write(Buffer const * buf, ostream & os) const
+dispatch_result InsetFloat::localDispatch(FuncRequest const & cmd)
+{
+ InsetOld::RESULT result = UNDISPATCHED;
+
+ switch (cmd.action) {
+ case LFUN_INSET_MODIFY: {
+ InsetFloatParams params;
+ InsetFloatMailer::string2params(cmd.argument, params);
+
+ params_.placement = params.placement;
+ params_.wide = params.wide;
+
+ wide(params_.wide, cmd.view()->buffer()->params);
+ cmd.view()->updateInset(this);
+ result = DISPATCHED;
+ }
+ break;
+
+ case LFUN_INSET_DIALOG_UPDATE: {
+ InsetFloatMailer mailer(*this);
+ mailer.updateDialog(cmd.view());
+ }
+ break;
+
+ default:
+ result = InsetCollapsable::localDispatch(cmd);
+ }
+
+ return result;
+}
+
+
+void InsetFloatParams::write(ostream & os) const
{
os << "Float " // getInsetName()
- << floatType_ << '\n';
+ << type << '\n';
- if (!floatPlacement_.empty()) {
- os << "placement " << floatPlacement_ << "\n";
+ if (!placement.empty()) {
+ os << "placement " << placement << "\n";
}
- if (wide_) {
+ if (wide) {
os << "wide true\n";
} else {
os << "wide false\n";
}
-
- InsetCollapsable::write(buf, os);
}
-void InsetFloat::read(Buffer const * buf, LyXLex & lex)
+void InsetFloatParams::read(LyXLex & lex)
{
if (lex.isOK()) {
lex.next();
string token = lex.getString();
if (token == "placement") {
lex.next();
- floatPlacement_ = lex.getString();
+ placement = lex.getString();
} else {
// take countermeasures
lex.pushToken(token);
if (token == "wide") {
lex.next();
string const tmptoken = lex.getString();
- if (tmptoken == "true")
- wide(true, buf->params);
- else
- wide(false, buf->params);
+ wide = (tmptoken == "true");
} else {
lyxerr << "InsetFloat::Read:: Missing wide!"
<< endl;
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)
+{
+ params_.read(lex);
+ wide(params_.wide, 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_);
+ features.useFloat(params_.type);
InsetCollapsable::validate(features);
}
-Inset * InsetFloat::clone(Buffer const &, bool same_id) const
+auto_ptr<InsetBase> InsetFloat::clone() const
{
- return new InsetFloat(*const_cast<InsetFloat *>(this), same_id);
+ return auto_ptr<InsetBase>(new InsetFloat(*this));
}
}
-int InsetFloat::latex(Buffer const * buf,
- ostream & os, bool fragile, bool fp) const
+int InsetFloat::latex(Buffer const * buf, ostream & os,
+ LatexRunParams const & runparams) const
{
FloatList const & floats = buf->params.getLyXTextClass().floats();
- string const tmptype = (wide_ ? floatType_ + "*" : floatType_);
+ string const tmptype = (params_.wide ? params_.type + "*" : params_.type);
// Figure out the float placement to use.
// From lowest to highest:
// - float 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 (!buf_placement.empty()
+ 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;
}
// 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{" << tmptype << '}';
// We only output placement if different from the def_placement.
if (!placement.empty()) {
- os << "[" << placement << "]";
+ os << '[' << placement << ']';
}
- os << "\n";
+ os << '\n';
- int const i = inset.latex(buf, os, fragile, fp);
+ int const i = inset.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.
}
+int InsetFloat::linuxdoc(Buffer const * buf, ostream & os) const
+{
+ FloatList const & floats = buf->params.getLyXTextClass().floats();
+ string const tmptype = params_.type;
+ // Figure out the float placement to use.
+ // From lowest to highest:
+ // - float default placement
+ // - document wide default placement
+ // - specific float placement
+ // This is the same as latex, as linuxdoc is modeled after latex.
+
+ string placement;
+ 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;
+ }
+
+ os << "\n<" << tmptype ;
+ // We only output placement if different from the def_placement.
+ if (!placement.empty()) {
+ os << " loc=\"" << placement << '"';
+ }
+ os << ">";
+
+ int const i = inset.linuxdoc(buf, os);
+ os << "</" << tmptype << ">\n";
+
+ return i;
+}
+
+
int InsetFloat::docbook(Buffer const * buf, ostream & os, bool mixcont) const
{
- os << "<" << floatType_ << ">";
+ os << '<' << params_.type << '>';
int const i = inset.docbook(buf, os, mixcont);
- os << "</" << floatType_ << ">";
+ os << "</" << params_.type << '>';
return i;
}
-bool InsetFloat::insetAllowed(Inset::Code code) const
+bool InsetFloat::insetAllowed(InsetOld::Code code) const
{
- if (code == Inset::FLOAT_CODE)
+ if (code == InsetOld::FLOAT_CODE)
return false;
if (inset.getLockingInset() != const_cast<InsetFloat *>(this))
return inset.insetAllowed(code);
- if ((code == Inset::FOOT_CODE) || (code == Inset::MARGIN_CODE))
+ if ((code == InsetOld::FOOT_CODE) || (code == InsetOld::MARGIN_CODE))
return false;
return true;
}
bool InsetFloat::showInsetDialog(BufferView * bv) const
{
if (!inset.showInsetDialog(bv)) {
- bv->owner()->getDialogs().showFloat(const_cast<InsetFloat *>(this));
+ InsetFloat * tmp = const_cast<InsetFloat *>(this);
+ InsetFloatMailer mailer(*tmp);
+ mailer.showDialog(bv);
}
return true;
}
-string const & InsetFloat::type() const
+void InsetFloat::wide(bool w, BufferParams const & bp)
{
- return floatType_;
+ params_.wide = w;
+
+ string lab(_("float: "));
+ lab += floatname(params_.type, bp);
+
+ if (params_.wide)
+ lab += '*';
+
+ setLabel(lab);
}
-void InsetFloat::placement(string const & p)
+void InsetFloat::addToToc(lyx::toc::TocList & toclist, Buffer const * buf) const
{
- // FIX: Here we should only allow the placement to be set
- // if a valid value.
- floatPlacement_ = p;
+ ParIterator pit(inset.paragraphs.begin(), inset.paragraphs);
+ ParIterator end(inset.paragraphs.end(), inset.paragraphs);
+
+ // Find a caption layout in one of the (child inset's) pars
+ for (; pit != end; ++pit) {
+ if (pit->layout()->name() == caplayout) {
+ string const name = floatname(params_.type, buf->params);
+ string const str =
+ tostr(toclist[name].size() + 1)
+ + ". " + pit->asString(buf, false);
+ lyx::toc::TocItem const item(pit->id(), 0 , str);
+ toclist[name].push_back(item);
+ }
+ }
}
-string const & InsetFloat::placement() const
+string const InsetFloatMailer::name_("float");
+
+InsetFloatMailer::InsetFloatMailer(InsetFloat & inset)
+ : inset_(inset)
+{}
+
+
+string const InsetFloatMailer::inset2string(Buffer const &) const
{
- return floatPlacement_;
+ return params2string(inset_.params());
}
-void InsetFloat::wide(bool w, BufferParams const & bp)
+void InsetFloatMailer::string2params(string const & in,
+ InsetFloatParams & params)
{
- wide_ = w;
+ params = InsetFloatParams();
- string lab(_("float:"));
- lab += floatname(floatType_, bp);
+ if (in.empty())
+ return;
- if (wide_)
- lab += "*";
+ istringstream data(STRCONV(in));
+ LyXLex lex(0,0);
+ lex.setStream(data);
- setLabel(lab);
-}
+ if (lex.isOK()) {
+ lex.next();
+ string const token = lex.getString();
+ if (token != name_)
+ return;
+ }
+ // This is part of the inset proper that is usually swallowed
+ // by Buffer::readInset
+ if (lex.isOK()) {
+ lex.next();
+ string const token = lex.getString();
+ if (token != "Float" || !lex.eatLine())
+ return;
+ }
-bool InsetFloat::wide() const
-{
- return wide_;
+ if (lex.isOK()) {
+ params.read(lex);
+ }
}
-void InsetFloat::addToToc(toc::TocList & toclist, Buffer const * buf) const
+string const InsetFloatMailer::params2string(InsetFloatParams const & params)
{
- // Now find the caption in the float...
- // We now tranverse the paragraphs of
- // the inset...
- Paragraph * tmp = inset.paragraph();
- while (tmp) {
- if (tmp->layout()->name() == caplayout) {
- string const str =
- tostr(toclist[type()].size() + 1)
- + ". " + tmp->asString(buf, false);
- toc::TocItem const item(tmp, 0 , str);
- toclist[type()].push_back(item);
- }
- tmp = tmp->next();
- }
+ ostringstream data;
+ data << name_ << ' ';
+ params.write(data);
+ return STRCONV(data.str());
}