lyx_mirror/src/insets/insetfloat.C

448 lines
12 KiB
C++
Raw Normal View History

/**
* \file insetfloat.C
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author J<EFBFBD>rgen Vigna
* \author Lars Gullik Bj<EFBFBD>nnes
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "insetfloat.h"
#include "buffer.h"
#include "bufferparams.h"
#include "BufferView.h"
#include "cursor.h"
#include "debug.h"
#include "dispatchresult.h"
#include "Floating.h"
#include "FloatList.h"
#include "funcrequest.h"
#include "gettext.h"
#include "iterators.h"
#include "LaTeXFeatures.h"
#include "LColor.h"
#include "lyxlex.h"
#include "outputparams.h"
#include "paragraph.h"
#include "support/lstrings.h"
#include "support/tostr.h"
#include "support/std_sstream.h"
using lyx::support::contains;
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
// classes we can support similar functionality in other formats
// (read DocBook).
// By using float.sty we will have the same handling for all floats, both
// for those already in existance (table and figure) and all user created
// ones<65>. So suddenly we give the users the possibility of creating new
// kinds of floats on the fly. (and with a uniform look)
//
// API to float.sty:
// \newfloat{type}{placement}{ext}[within]
// type - The "type" of the new class of floats, like program or
// algorithm. After the appropriate \newfloat, commands
// such as \begin{program} or \end{algorithm*} will be
// available.
// placement - The default placement for the given class of floats.
// They are like in standard LaTeX: t, b, p and h for top,
// bottom, page, and here, respectively. On top of that
// there is a new type, H, which does not really correspond
// to a float, since it means: put it "here" and nowhere else.
// Note, however that the H specifier is special and, because
// of implementation details cannot be used in the second
// argument of \newfloat.
// ext - The file name extension of an auxiliary file for the list
// of figures (or whatever). LaTeX writes the captions to
// this file.
// 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.
// \floatstyle{style}
// style - plain, boxed, ruled
// \floatname{float}{floatname}
// float -
// floatname -
// \floatplacement{float}{placement}
// float -
// placement -
// \restylefloat{float}
// float -
// \listof{type}{title}
// title -
// <20> the algorithm float is defined using the float.sty package. Like this
// \floatstyle{ruled}
// \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
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)
{
string lab(_("float: "));
lab += floatname(type, bp);
setLabel(lab);
LyXFont font(LyXFont::ALL_SANE);
font.decSize();
font.decSize();
font.setColor(LColor::collapsable);
setLabelFont(font);
params_.type = type;
setInsetName(type);
LyXTextClass const & tclass = bp.getLyXTextClass();
if (tclass.hasLayout(caplayout))
inset.paragraphs().begin()->layout(tclass[caplayout]);
}
InsetFloat::~InsetFloat()
{
InsetFloatMailer(*this).hideDialog();
}
DispatchResult
InsetFloat::priv_dispatch(LCursor & cur, FuncRequest const & cmd)
{
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, cur.bv().buffer()->params());
cur.bv().update();
return DispatchResult(true, true);
}
case LFUN_INSET_DIALOG_UPDATE: {
InsetFloatMailer(*this).updateDialog(&cur.bv());
return DispatchResult(true, true);
}
default:
return InsetCollapsable::priv_dispatch(cur, 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 InsetFloatParams::read(LyXLex & lex)
{
if (lex.isOK()) {
lex.next();
string token = lex.getString();
if (token == "placement") {
lex.next();
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 wide!"
<< 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)
{
params_.read(lex);
wide(params_.wide, buf.params());
InsetCollapsable::read(buf, lex);
}
void InsetFloat::validate(LaTeXFeatures & features) const
{
if (contains(params_.placement, 'H')) {
features.require("float");
}
features.useFloat(params_.type);
InsetCollapsable::validate(features);
}
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,
OutputParams 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,
OutputParams const & runparams) 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, runparams);
os << "</" << tmptype << ">\n";
return i;
}
int InsetFloat::docbook(Buffer const & buf, ostream & os,
OutputParams const & runparams) const
{
os << '<' << params_.type << '>';
int const i = inset.docbook(buf, os, runparams);
os << "</" << params_.type << '>';
return i;
}
bool InsetFloat::insetAllowed(InsetOld::Code code) const
{
return code != InsetOld::FLOAT_CODE
&& code != InsetOld::FOOT_CODE
&& code != InsetOld::MARGIN_CODE;
}
bool InsetFloat::showInsetDialog(BufferView * bv) const
{
if (!inset.showInsetDialog(bv))
InsetFloatMailer(const_cast<InsetFloat &>(*this)).showDialog(bv);
return true;
}
void InsetFloat::wide(bool w, BufferParams const & bp)
{
params_.wide = w;
string lab = _("float: ") + floatname(params_.type, bp);
if (params_.wide)
lab += '*';
setLabel(lab);
}
void InsetFloat::addToToc(lyx::toc::TocList & toclist, Buffer const & buf) const
{
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 InsetFloatMailer::name_("float");
InsetFloatMailer::InsetFloatMailer(InsetFloat & inset)
: inset_(inset)
{}
string const InsetFloatMailer::inset2string(Buffer const &) const
{
return params2string(inset_.params());
}
void InsetFloatMailer::string2params(string const & in,
InsetFloatParams & params)
{
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");
params.read(lex);
}
string const InsetFloatMailer::params2string(InsetFloatParams const & params)
{
ostringstream data;
data << name_ << ' ';
params.write(data);
return data.str();
}