* Full author contact details are available in file CREDITS.
*/
+#include <typeinfo>
+
#include <config.h>
+#include <output_docbook.h>
+#include <xml.h>
-#include "InsetFloat.h"
+#include "InsetBox.h"
#include "InsetCaption.h"
+#include "InsetFloat.h"
+#include "InsetGraphics.h"
+#include "InsetLabel.h"
#include "Buffer.h"
#include "BufferParams.h"
#include "TexRow.h"
#include "texstream.h"
#include "TextClass.h"
+#include "InsetList.h"
#include "support/debug.h"
#include "support/docstream.h"
// 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
+// for those already in existence (table and figure) and all user created
// ones¹. So suddenly we give the users the possibility of creating new
// kinds of floats on the fly. (and with a uniform look)
//
// Lgb
//FIXME: why do we set in stone the type here?
-InsetFloat::InsetFloat(Buffer * buf, string params_str)
+InsetFloat::InsetFloat(Buffer * buf, string const & params_str)
: InsetCaptionable(buf)
{
string2params(params_str, params_);
params_.wide = params.wide;
params_.sideways = params.sideways;
}
+ params_.alignment = params.alignment;
setNewLabel();
if (params_.type != params.type)
setCaptionType(params.type);
}
+string InsetFloat::getAlignment() const
+{
+ string alignment;
+ string const buf_alignment = buffer().params().float_alignment;
+ if (params_.alignment == "document"
+ && !buf_alignment.empty()) {
+ alignment = buf_alignment;
+ } else if (!params_.alignment.empty()
+ && params_.alignment != "class"
+ && params_.alignment != "document") {
+ alignment = params_.alignment;
+ }
+ return alignment;
+}
+
+
+LyXAlignment InsetFloat::contentAlignment() const
+{
+ LyXAlignment align = LYX_ALIGN_NONE;
+ string alignment = getAlignment();
+ if (alignment == "left")
+ align = LYX_ALIGN_LEFT;
+ else if (alignment == "center")
+ align = LYX_ALIGN_CENTER;
+ else if (alignment == "right")
+ align = LYX_ALIGN_RIGHT;
+
+ return align;
+}
+
+
void InsetFloatParams::write(ostream & os) const
{
if (type.empty()) {
if (!placement.empty())
os << "placement " << placement << "\n";
+ if (!alignment.empty())
+ os << "alignment " << alignment << "\n";
if (wide)
os << "wide true\n";
lex >> type;
if (lex.checkFor("placement"))
lex >> placement;
+ if (lex.checkFor("alignment"))
+ lex >> alignment;
lex >> "wide" >> wide;
lex >> "sideways" >> sideways;
}
if (features.inFloat())
features.require("subfig");
+ if (features.inDeletedInset()) {
+ features.require("tikz");
+ features.require("ct-tikz-object-sout");
+ }
+
features.useFloat(params_.type, features.inFloat());
features.inFloat(true);
InsetCaptionable::validate(features);
}
-docstring InsetFloat::xhtml(XHTMLStream & xs, OutputParams const & rp) const
+docstring InsetFloat::xhtml(XMLStream & xs, OutputParams const & rp) const
{
FloatList const & floats = buffer().params().documentClass().floats();
Floating const & ftype = floats.getType(params_.type);
string const & attr = ftype.htmlAttrib();
odocstringstream ods;
- XHTMLStream newxs(ods);
- newxs << html::StartTag(htmltype, attr);
+ XMLStream newxs(ods);
+ newxs << xml::StartTag(htmltype, attr);
InsetText::XHTMLOptions const opts =
InsetText::WriteLabel | InsetText::WriteInnerTag;
docstring deferred = InsetText::insetAsXHTML(newxs, rp, opts);
- newxs << html::EndTag(htmltype);
+ newxs << xml::EndTag(htmltype);
if (rp.inFloat == OutputParams::NONFLOAT) {
// In this case, this float needs to be deferred, but we'll put it
// we can write to the stream.
// Note that things will already have been escaped, so we do not
// want to escape them again.
- xs << XHTMLStream::ESCAPE_NONE << ods.str();
+ xs << XMLStream::ESCAPE_NONE << ods.str();
}
return deferred;
}
string tmpplacement;
string const buf_placement = buffer().params().float_placement;
string const def_placement = floats.defaultPlacement(params_.type);
- if (!params_.placement.empty()
- && params_.placement != def_placement) {
- tmpplacement = params_.placement;
- } else if (params_.placement.empty()
- && !buf_placement.empty()
- && buf_placement != def_placement) {
+ if (params_.placement == "document"
+ && !buf_placement.empty()
+ && buf_placement != def_placement) {
tmpplacement = buf_placement;
+ } else if (!params_.placement.empty()
+ && params_.placement != "document"
+ && params_.placement != def_placement) {
+ tmpplacement = params_.placement;
}
// Check if placement is allowed by this float
// sidewaysfloats always use their own page,
// therefore don't output the p option that is always set
if (!placement.empty()
- && (!params_.sideways || (params_.sideways && from_ascii(placement) != "p")))
+ && (!params_.sideways || from_ascii(placement) != "p"))
os << '[' << from_ascii(placement) << ']';
os << '\n';
+ if (runparams.inDeletedInset) {
+ // This has to be done manually since we need it inside the float
+ OutputParams::CtObject ctobject = runparams.ctObject;
+ runparams.ctObject = OutputParams::CT_DISPLAYOBJECT;
+ Changes::latexMarkChange(os, buffer().params(), Change(Change::UNCHANGED),
+ Change(Change::DELETED), runparams);
+ runparams.ctObject = ctobject;
+ }
+
+ string alignment = getAlignment();
+ if (alignment == "left")
+ os << "\\raggedright" << breakln;
+ else if (alignment == "center")
+ os << "\\centering" << breakln;
+ else if (alignment == "right")
+ os << "\\raggedleft" << breakln;
+
InsetText::latex(os, runparams);
+ if (runparams.inDeletedInset)
+ os << "}";
+
// Force \end{<floatname>} to appear in a new line.
os << breakln << "\\end{" << from_ascii(tmptype) << "}\n";
}
}
-int InsetFloat::docbook(odocstream & os, OutputParams const & runparams) const
+std::vector<const InsetBox *> findSubfiguresInParagraph(const Paragraph &par)
{
- // FIXME Implement subfloat!
- // FIXME UNICODE
- os << '<' << from_ascii(params_.type) << '>';
- int const i = InsetText::docbook(os, runparams);
- os << "</" << from_ascii(params_.type) << '>';
- return i;
+ // Don't make the hypothesis that all subfigures are in the same paragraph.
+ // Similarly, there may be several subfigures in the same paragraph (most likely case, based on the documentation).
+ // Any box is considered as a subfigure, even though the most likely case is \minipage.
+ std::vector<const InsetBox *> subfigures;
+ for (pos_type pos = 0; pos < par.size(); ++pos) {
+ const Inset *inset = par.getInset(pos);
+ if (!inset)
+ continue;
+ if (const auto box = dynamic_cast<const InsetBox *>(inset))
+ subfigures.push_back(box);
+ }
+ return subfigures;
+}
+
+
+const InsetLabel* findLabelInParagraph(const Paragraph &par)
+{
+ for (pos_type pos = 0; pos < par.size(); ++pos) {
+ // If this inset is a subfigure, skip it.
+ const Inset *inset = par.getInset(pos);
+ if (dynamic_cast<const InsetBox *>(inset)) {
+ continue;
+ }
+
+ // Maybe an inset is directly a label, in which case no more work is needed.
+ if (inset && dynamic_cast<const InsetLabel *>(inset))
+ return dynamic_cast<const InsetLabel *>(inset);
+
+ // More likely, the label is hidden in an inset of a paragraph (only if a subtype of InsetText).
+ if (!dynamic_cast<const InsetText *>(inset))
+ continue;
+
+ auto insetAsText = dynamic_cast<const InsetText *>(inset);
+ auto itIn = insetAsText->paragraphs().begin();
+ auto endIn = insetAsText->paragraphs().end();
+ for (; itIn != endIn; ++itIn) {
+ for (pos_type posIn = 0; posIn < itIn->size(); ++posIn) {
+ const Inset *insetIn = itIn->getInset(posIn);
+ if (insetIn && dynamic_cast<const InsetLabel *>(insetIn)) {
+ return dynamic_cast<const InsetLabel *>(insetIn);
+ }
+ }
+ }
+
+ // Obviously, this solution does not scale with more levels of paragraphs-insets, but this should be enough.
+ }
+
+ return nullptr;
+}
+
+
+const InsetCaption* findCaptionInParagraph(const Paragraph &par)
+{
+ // Don't dive too deep, otherwise, this could be a subfigure caption.
+ for (pos_type pos = 0; pos < par.size(); ++pos) {
+ // If this inset is a subfigure, skip it.
+ const Inset *inset = par.getInset(pos);
+ if (dynamic_cast<const InsetBox *>(inset))
+ continue;
+
+ if (inset && dynamic_cast<const InsetCaption *>(inset))
+ return dynamic_cast<const InsetCaption *>(inset);
+ }
+
+ return nullptr;
+}
+
+
+void InsetFloat::docbook(XMLStream & xs, OutputParams const & runparams) const
+{
+ // Determine whether the float has a title or not. For this, iterate through the paragraphs and look
+ // for an InsetCaption. Do the same for labels and subfigures.
+ // The caption and the label for each subfigure is handled by recursive calls.
+ const InsetCaption* caption = nullptr;
+ const InsetLabel* label = nullptr;
+ std::vector<const InsetBox *> subfigures;
+
+ auto end = paragraphs().end();
+ for (auto it = paragraphs().begin(); it != end; ++it) {
+ std::vector<const InsetBox *> foundSubfigures = findSubfiguresInParagraph(*it);
+ if (!foundSubfigures.empty()) {
+ subfigures.reserve(subfigures.size() + foundSubfigures.size());
+ subfigures.insert(subfigures.end(), foundSubfigures.begin(), foundSubfigures.end());
+ }
+
+ if (!caption)
+ caption = findCaptionInParagraph(*it);
+ if (!label)
+ label = findLabelInParagraph(*it);
+ }
+
+ // Gather a few things from global environment that are shared between all following cases.
+ FloatList const &floats = buffer().params().documentClass().floats();
+ Floating const &ftype = floats.getType(params_.type);
+ string const &titleTag = ftype.docbookCaption();
+
+ // Ensure there is no label output, it is supposed to be handled as xml:id.
+ OutputParams rpNoLabel = runparams;
+ if (label)
+ rpNoLabel.docbook_anchors_to_ignore.emplace(label->screenLabel());
+
+ // Ensure the float does not output its caption, as it is handled here (DocBook mandates a specific place for
+ // captions, they cannot appear at the end of the float, albeit LyX is happy with that).
+ OutputParams rpNoTitle = runparams;
+ rpNoTitle.docbook_in_float = true;
+
+ // Deal with subfigures.
+ if (!subfigures.empty()) {
+ // First, open the formal group.
+ docstring attr = docstring();
+ if (label)
+ attr += "xml:id=\"" + xml::cleanID(label->screenLabel()) + "\"";
+
+ xs.startDivision(false);
+ xs << xml::StartTag("formalgroup", attr);
+ xs << xml::CR();
+
+ xs << xml::StartTag("title", attr);
+ if (caption) {
+ caption->getCaptionAsDocBook(xs, rpNoLabel);
+ } else {
+ xs << "No caption";
+ // No caption has been detected, but this tag is required for the document to be valid DocBook.
+ }
+ xs << xml::EndTag("title");
+ xs << xml::CR();
+
+ // Deal with each subfigure individually. This should also deal with their caption and their label.
+ // This should be a recursive call to InsetFloat.
+ for (const InsetBox *subfigure: subfigures) {
+ // If there is no InsetFloat in the paragraphs, output a warning.
+ bool foundInsetFloat = false;
+ for (auto it = subfigure->paragraphs().begin(); it != subfigure->paragraphs().end(); ++it) {
+ for (pos_type posIn = 0; posIn < it->size(); ++posIn) {
+ const Inset *inset = it->getInset(posIn);
+ if (inset && dynamic_cast<const InsetFloat*>(inset)) {
+ foundInsetFloat = true;
+ break;
+ }
+ }
+
+ if (foundInsetFloat)
+ break;
+ }
+
+ if (!foundInsetFloat)
+ xs << XMLStream::ESCAPE_NONE << "Error: no float found in the box. "
+ "To use subfigures in DocBook, elements must be wrapped in a float "
+ "inset and have a title/caption.";
+ // TODO: could also output a table, that would ensure that the document is correct and *displays* correctly (but without the right semantics), instead of just an error.
+
+ // Finally, recurse.
+ subfigure->docbook(xs, runparams);
+ }
+
+ // Every subfigure is done: close the formal group.
+ xs << xml::EndTag("formalgroup");
+ xs << xml::CR();
+ xs.endDivision();
+ }
+
+ // Here, ensured not to have subfigures.
+
+ // Organisation: <float> <title if any/> <contents without title/> </float>
+ docstring attr = docstring();
+ if (label)
+ attr += "xml:id=\"" + xml::cleanID(label->screenLabel()) + "\"";
+ if (!ftype.docbookAttr().empty()) {
+ if (!attr.empty())
+ attr += " ";
+ attr += from_utf8(ftype.docbookAttr());
+ }
+
+ xs << xml::StartTag(ftype.docbookTag(caption != nullptr), attr);
+ xs << xml::CR();
+ if (caption != nullptr) {
+ xs << xml::StartTag(titleTag);
+ caption->getCaptionAsDocBook(xs, rpNoLabel);
+ xs << xml::EndTag(titleTag);
+ xs << xml::CR();
+ }
+ InsetText::docbook(xs, rpNoTitle);
+ xs << xml::EndTag(ftype.docbookTag(caption != nullptr));
+ xs << xml::CR();
}
projects / lyx.git / blobdiff