-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1998 The LyX Team.
+/**
+ * \file insetfloat.C
+ * 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
+ *
+ * Full author contact details are available in file CREDITS.
+ */
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "insetfloat.h"
-#include "gettext.h"
-#include "lyxfont.h"
+
+#include "buffer.h"
#include "BufferView.h"
-#include "lyxtext.h"
-#include "insets/insettext.h"
-#include "support/LOstream.h"
-#include "FloatList.h"
-#include "LaTeXFeatures.h"
#include "debug.h"
#include "Floating.h"
+#include "FloatList.h"
+#include "funcrequest.h"
+#include "gettext.h"
+#include "iterators.h"
+#include "LaTeXFeatures.h"
+#include "lyxlex.h"
+#include "paragraph.h"
+
+#include "support/lstrings.h"
+#include "support/tostr.h"
+
+#include "support/std_sstream.h"
+
+using namespace lyx::support;
-using std::ostream;
using std::endl;
+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
// within - This (optional) argument determines whether floats of this
// class will be numbered within some sectional unit of the
// document. For example, if within is equal to chapter, the
-// floats will be numbered within chapters.
+// floats will be numbered within chapters.
// \floatstyle{style}
// style - plain, boxed, ruled
// \floatname{float}{floatname}
// \newfloat{algorithm}{htbp}{loa}[<sect>]
// \floatname{algorithm}{Algorithm}
//
+// The intention is that floats should be definable from two places:
+// - layout files
+// - the "gui" (i.e. by the user)
+//
+// From layout files.
+// This should only be done for floats defined in a documentclass and that
+// does not need any additional packages. The two most known floats in this
+// category is "table" and "figure". Floats defined in layout files are only
+// stored in lyx files if the user modifies them.
+//
+// By the user.
+// There should be a gui dialog (and also a collection of lyxfuncs) where
+// the user can modify existing floats and/or create new ones.
+//
+// The individual floats will also have some settable
+// variables: wide and placement.
+//
// Lgb
-InsetFloat::InsetFloat(string const & type)
- : InsetCollapsable()
+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)
{
- string lab(_("float:"));
- lab += type;
+ 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)
+{
+ string lab(_("float: "));
+ lab += floatname(type, bp);
setLabel(lab);
LyXFont font(LyXFont::ALL_SANE);
font.decSize();
font.decSize();
- font.setColor(LColor::footnote);
+ font.setColor(LColor::collapsable);
setLabelFont(font);
- setAutoCollapse(false);
- setInsetName("Float");
- floatType = type;
- setInsetName(type.c_str());
- //floatPlacement = "H";
+ params_.type = type;
+ setInsetName(type);
+ LyXTextClass const & tclass = bp.getLyXTextClass();
+ if (tclass.hasLayout(caplayout))
+ inset.paragraphs.begin()->layout(tclass[caplayout]);
+}
+
+
+InsetFloat::InsetFloat(InsetFloat const & in)
+ : InsetCollapsable(in), params_(in.params_)
+{}
+
+
+InsetFloat::~InsetFloat()
+{
+ InsetFloatMailer mailer(*this);
+ mailer.hideDialog();
}
-void InsetFloat::Write(Buffer const * buf, ostream & os) const
+dispatch_result InsetFloat::localDispatch(FuncRequest const & cmd)
{
- os << getInsetName()
- << " " << floatType << '\n';
+ switch (cmd.action) {
+
+ case LFUN_INSET_MODIFY: {
+ InsetFloatParams params;
+ InsetFloatMailer::string2params(cmd.argument, params);
+
+ params_.placement = params.placement;
+ params_.wide = params.wide;
- if (floatPlacement.empty()) {
- os << "placement "
- << floatList.getType(floatType).placement << "\n";
- } else {
- os << "placement " << floatPlacement << "\n";
+ wide(params_.wide, cmd.view()->buffer()->params());
+ cmd.view()->updateInset(this);
+ return DISPATCHED;
}
-
- InsetCollapsable::Write(buf, os);
+
+ case LFUN_INSET_DIALOG_UPDATE: {
+ InsetFloatMailer(*this).updateDialog(cmd.view());
+ return DISPATCHED;
+ }
+
+ default:
+ return InsetCollapsable::localDispatch(cmd);
+ }
+}
+
+
+void InsetFloatParams::write(ostream & os) const
+{
+ os << "Float " // getInsetName()
+ << type << '\n';
+
+ if (!placement.empty())
+ os << "placement " << placement << "\n";
+
+ if (wide)
+ os << "wide true\n";
+ else
+ os << "wide false\n";
}
-void InsetFloat::Read(Buffer const * buf, LyXLex & lex)
+void InsetFloatParams::read(LyXLex & lex)
{
- if (lex.IsOK()) {
+ if (lex.isOK()) {
lex.next();
- string token = lex.GetString();
+ string token = lex.getString();
if (token == "placement") {
lex.next();
- floatPlacement = lex.GetString();
+ placement = lex.getString();
+ } else {
+ // take countermeasures
+ lex.pushToken(token);
+ }
+ lex.next();
+ token = lex.getString();
+ if (token == "wide") {
+ lex.next();
+ string const tmptoken = lex.getString();
+ wide = (tmptoken == "true");
} else {
- lyxerr << "InsetFloat::Read: Missing placement!"
+ lyxerr << "InsetFloat::Read:: Missing wide!"
<< endl;
+ // take countermeasures
+ lex.pushToken(token);
}
}
- InsetCollapsable::Read(buf, lex);
}
-void InsetFloat::Validate(LaTeXFeatures & features) const
+void InsetFloat::write(Buffer const & buf, ostream & os) const
{
- features.usedFloats.insert(floatType);
+ params_.write(os);
+ InsetCollapsable::write(buf, os);
}
-Inset * InsetFloat::Clone() const
+void InsetFloat::read(Buffer const & buf, LyXLex & lex)
{
- InsetFloat * result = new InsetFloat(floatType);
- result->inset->init(inset);
+ params_.read(lex);
+ wide(params_.wide, buf.params());
+ InsetCollapsable::read(buf, lex);
+}
+
- result->collapsed = collapsed;
- return result;
+void InsetFloat::validate(LaTeXFeatures & features) const
+{
+ if (contains(params_.placement, "H")) {
+ features.require("float");
+ }
+
+ features.useFloat(params_.type);
+ InsetCollapsable::validate(features);
}
-char const * InsetFloat::EditMessage() const
+auto_ptr<InsetBase> InsetFloat::clone() const
+{
+ return auto_ptr<InsetBase>(new InsetFloat(*this));
+}
+
+
+string 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, ostream & os,
+ LatexRunParams const & runparams) const
+{
+ FloatList const & floats = buf.params().getLyXTextClass().floats();
+ string const tmptype = (params_.wide ? params_.type + "*" : params_.type);
+ // 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(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 << '}';
+ // We only output placement if different from the def_placement.
+ if (!placement.empty()) {
+ os << '[' << placement << ']';
+ }
+ os << '\n';
+
+ 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.
+ os << "\n\\end{" << tmptype << "}\n";
+
+ return i + 4;
+}
+
+
+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 << "\\begin{" << floatType << "}";
- if (!floatPlacement.empty()
- && floatPlacement != floatList.defaultPlacement(floatType))
- os << "[" << floatPlacement << "]";
- os << "%\n";
-
- int i = inset->Latex(buf, os, fragile, fp);
- os << "\\end{" << floatType << "}%\n";
-
- return i + 2;
+ os << '<' << params_.type << '>';
+ int const i = inset.docbook(buf, os, mixcont);
+ os << "</" << params_.type << '>';
+
+ return i;
}
-bool InsetFloat::InsertInsetAllowed(Inset * in) const
+bool InsetFloat::insetAllowed(InsetOld::Code code) const
{
- if ((in->LyxCode() == Inset::FOOT_CODE) ||
- (in->LyxCode() == Inset::MARGIN_CODE)) {
+ if (code == InsetOld::FLOAT_CODE)
return false;
+ if (inset.getLockingInset() != const_cast<InsetFloat *>(this))
+ return inset.insetAllowed(code);
+ if ((code == InsetOld::FOOT_CODE) || (code == InsetOld::MARGIN_CODE))
+ return false;
+ return true;
+}
+
+
+bool InsetFloat::showInsetDialog(BufferView * bv) const
+{
+ if (!inset.showInsetDialog(bv)) {
+ InsetFloat * tmp = const_cast<InsetFloat *>(this);
+ InsetFloatMailer mailer(*tmp);
+ mailer.showDialog(bv);
}
return true;
}
-void InsetFloat::InsetButtonRelease(BufferView * bv, int x, int y, int button)
+void InsetFloat::wide(bool w, BufferParams const & bp)
+{
+ params_.wide = w;
+
+ string lab(_("float: "));
+ lab += floatname(params_.type, bp);
+
+ if (params_.wide)
+ lab += '*';
+
+ setLabel(lab);
+}
+
+
+void InsetFloat::addToToc(lyx::toc::TocList & toclist, Buffer const & buf) const
{
- if (x >= 0
- && x < button_length
- && y >= button_top_y
- && y < button_bottom_y
- && button == 3) {
- // This obviously need to change.
- lyxerr << "InsetFloat: Let's edit this floats parameters!"
- << endl;
- } else {
- InsetCollapsable::InsetButtonRelease(bv, x, y, button);
+ 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);
+ }
}
}
-void InsetFloat::wide(bool w)
+string const InsetFloatMailer::name_("float");
+
+InsetFloatMailer::InsetFloatMailer(InsetFloat & inset)
+ : inset_(inset)
+{}
+
+
+string const InsetFloatMailer::inset2string(Buffer const &) const
{
- wide_ = w;
- if (wide_) {
- string lab(_("float:"));
- lab += floatType;
- lab += "*";
- setLabel(lab);
- } else {
- string lab(_("float:"));
- lab += floatType;
- setLabel(lab);
+ return params2string(inset_.params());
+}
+
+
+void InsetFloatMailer::string2params(string const & in,
+ InsetFloatParams & params)
+{
+ params = InsetFloatParams();
+
+ if (in.empty())
+ return;
+
+ istringstream data(STRCONV(in));
+ LyXLex lex(0,0);
+ lex.setStream(data);
+
+ 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;
+ }
+
+ if (lex.isOK()) {
+ params.read(lex);
}
}
-bool InsetFloat::wide() const
+string const InsetFloatMailer::params2string(InsetFloatParams const & params)
{
- return wide_;
+ ostringstream data;
+ data << name_ << ' ';
+ params.write(data);
+ return STRCONV(data.str());
}
projects / lyx.git / blobdiff