X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2Finsetfloat.C;h=7c164979a50f4fa3d838fdab20450524cc26a35c;hb=b1fb034c3be30101b06286f74815a708142d52e8;hp=8b01326bad54344caf8a247cddba7887534fcb03;hpb=e952d33e0b702265cdac14de9871ecbfcf34863d;p=lyx.git diff --git a/src/insets/insetfloat.C b/src/insets/insetfloat.C index 8b01326bad..7c164979a5 100644 --- a/src/insets/insetfloat.C +++ b/src/insets/insetfloat.C @@ -1,37 +1,45 @@ -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor - * - * Copyright 1998-2001 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 -#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 "LyXView.h" +#include "support/tostr.h" + +#include "frontends/LyXView.h" #include "frontends/Dialogs.h" using std::ostream; using std::endl; + // 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 // classes we can support similar functionality in other formats @@ -61,7 +69,7 @@ using std::endl; // 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} @@ -99,78 +107,122 @@ using std::endl; // // Lgb -InsetFloat::InsetFloat(string const & type) - : InsetCollapsable(), wide_(false) +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::collapsable); setLabelFont(font); - floatType_ = type; + 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, bool same_id) - : InsetCollapsable(in, same_id), floatType_(in.floatType_), - floatPlacement_(in.floatPlacement_), wide_(in.wide_) + : InsetCollapsable(in, same_id), 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) +{ + Inset::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 " - << floatList.getType(floatType_).placement() << "\n"; - } else { - 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()) { + 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 { - lyxerr << "InsetFloat::Read: Missing placement!" - << endl; // take countermeasures lex.pushToken(token); } lex.next(); - token = lex.GetString(); + token = lex.getString(); if (token == "wide") { lex.next(); - string const tmptoken = lex.GetString(); - if (tmptoken == "true") - wide(true); - else - wide(false); + string const tmptoken = lex.getString(); + wide = (tmptoken == "true"); } else { lyxerr << "InsetFloat::Read:: Missing wide!" << endl; @@ -178,17 +230,31 @@ void InsetFloat::read(Buffer const * buf, LyXLex & lex) 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")) { - features.floats = true; + if (contains(params_.placement, "H")) { + features.require("float"); } - - features.usedFloats.insert(floatType_); + + features.useFloat(params_.type); InsetCollapsable::validate(features); } @@ -208,7 +274,8 @@ string const InsetFloat::editMessage() const int InsetFloat::latex(Buffer const * buf, ostream & os, bool fragile, bool fp) const { - string const tmptype = (wide_ ? floatType_ + "*" : floatType_); + 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 @@ -216,35 +283,41 @@ int InsetFloat::latex(Buffer const * buf, // - specific float placement string placement; string const buf_placement = buf->params.float_placement; - string const def_placement = floatList.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; } - - os << "\\begin{" << tmptype << "}"; + + // 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{" << 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); - os << "\\end{" << tmptype << "}%\n"; - - return i + 2; + + // 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{" << tmptype << "}\n"; + + return i + 4; } -int InsetFloat::docBook(Buffer const * buf, ostream & os) const +int InsetFloat::docbook(Buffer const * buf, ostream & os, bool mixcont) const { - os << "<" << floatType_ << ">"; - int const i = inset.docBook(buf, os); - os << ""; + os << '<' << params_.type << '>'; + int const i = inset.docbook(buf, os, mixcont); + os << "'; return i; } @@ -265,77 +338,98 @@ bool InsetFloat::insetAllowed(Inset::Code code) const bool InsetFloat::showInsetDialog(BufferView * bv) const { if (!inset.showInsetDialog(bv)) { - bv->owner()->getDialogs()->showFloat(const_cast(this)); + InsetFloat * tmp = const_cast(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) { -#if 0 - if (x >= top_x - && 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; - //bv->owner()->getDialogs()->showFloat(this); - } else { - InsetCollapsable::insetButtonRelease(bv, x, y, button); - } -#else - if (button == 3) { - showInsetDialog(bv); - return; - } - InsetCollapsable::insetButtonRelease(bv, x, y, button); -#endif -} + params_.wide = w; + string lab(_("float:")); + lab += floatname(params_.type, bp); -string const & InsetFloat::type() const -{ - return floatType_; + if (params_.wide) + lab += '*'; + + setLabel(lab); } -void InsetFloat::placement(string const & p) +void InsetFloat::addToToc(toc::TocList & toclist, Buffer const * buf) const { - // Here we should only allow the placement to be set - // if a valid value. -#ifdef WITH_WARNINGS -#warning FIX! -#endif - floatPlacement_ = p; + ParIterator pit(inset.paragraphs.begin(), inset.paragraphs); + ParIterator end(inset.paragraphs.end(), inset.paragraphs); + +a // 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); + 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() const { - return floatPlacement_; + return params2string(inset_.params()); } -void InsetFloat::wide(bool w) +void InsetFloatMailer::string2params(string const & in, + InsetFloatParams & params) { - wide_ = w; - if (wide_) { - string lab(_("float:")); - lab += floatType_; - lab += "*"; - setLabel(lab); - } else { - string lab(_("float:")); - lab += floatType_; - setLabel(lab); + 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()); }