Less expensive OP first as this might be called often.

[lyx.git] / src / Floating.cpp

diff --git a/src/Floating.cpp b/src/Floating.cpp
index a226d51ed35509ba01c11e5863e9b3eafa525cff..df48a2b74d6d8c6930a0fbcde933a4397e1b7fb3 100644 (file)
--- a/src/Floating.cpp
+++ b/src/Floating.cpp
@@ -31,9 +31,10 @@ Floating::Floating(string const & type, string const & placement,
                   string const & listName, std::string const & listCmd,
                   string const & refPrefix, std::string const & allowedplacement,
                   string const & htmlTag, string const & htmlAttrib,
-                  docstring const & htmlStyle,
+                  docstring const & htmlStyle, std::string const & docbookTag,
                   string const & docbookAttr, string const & docbookTagType,
-           string const & required, bool usesfloat, bool ispredefined,
+                  std::string const & docbookFloatType, std::string const & docbookCaption,
+                  string const & required, bool usesfloat, bool ispredefined,
                   bool allowswide, bool allowssideways)
        : floattype_(type), placement_(placement), ext_(ext), within_(within),
          style_(style), name_(name), listname_(listName), listcommand_(listCmd),
@@ -41,24 +42,53 @@ Floating::Floating(string const & type, string const & placement,
          usesfloatpkg_(usesfloat), ispredefined_(ispredefined),
          allowswide_(allowswide), allowssideways_(allowssideways),
          html_tag_(htmlTag), html_attrib_(htmlAttrib), html_style_(htmlStyle),
-         docbook_attr_(docbookAttr), docbook_tag_type_(docbookTagType)
-{}
-
-
-std::string Floating::docbookFloatType() const
+         docbook_caption_(docbookCaption), docbook_tag_(docbookTag),
+         docbook_tag_type_(docbookTagType)
 {
-       // TODO: configure this in the layouts?
-       if (floattype_ == "figure" || floattype_ == "graph" ||
-                       floattype_ == "chart" || floattype_ == "scheme")  {
-               return "figure";
-       } else if (floattype_ == "table" || floattype_ == "tableau") {
-               return "table";
-       } else if (floattype_ == "algorithm") {
-               return "algorithm";
-       } else {
-               // If nothing matches, return something that will not be valid.
-               LYXERR0("Unrecognised float type: " + floattype_);
-               return "unknown";
+       // Implement some edge cases for DocBook. Both docbook_float_type_ and docbook_attr_ must be computed
+       // based on the given value of docbookFloatType; docbook_tag_ can still be guessed without correlation.
+
+       // Determine the value of docbook_float_type_.
+       {
+               // These are the allowed values for docbook_float_type_. Both docbook_attr_ and docbook_tag_type_
+               // depend on this list.
+               static std::set<std::string> allowedFloatTypes{"figure", "table", "algorithm", "video", "example"};
+
+               // If some type is predetermined in the layout, use it.
+               if (!docbookFloatType.empty() && allowedFloatTypes.find(docbookFloatType) != allowedFloatTypes.end())
+                       docbook_float_type_ = docbookFloatType;
+               // Otherwise, try to guess the DocBook type based on the float type.
+               else if (floattype_ == "figure" || floattype_ == "graph" || floattype_ == "chart" || floattype_ == "scheme" ||
+                               floattype_ == "marginfigure") {
+                       docbook_float_type_ = "figure";
+               } else if (floattype_ == "table" || floattype_ == "tableau" || floattype_ == "margintable") {
+                       docbook_float_type_ = "table";
+               } else if (floattype_ == "algorithm") {
+                       docbook_float_type_ = "algorithm";
+               } else if (floattype_ == "video") {
+                       docbook_float_type_ = "video";
+               } else {
+                       // If nothing matches, return something that will not be valid.
+                       LYXERR(Debug::OUTFILE, "Float type '" + floattype_ + "' unknown to DocBook!");
+                       docbook_float_type_ = "unknown";
+               }
+       }
+
+       // Determine the value of docbook_attr_.
+       {
+               std::set<std::string> achemso = {"chart", "graph", "scheme"};
+               bool hasType = docbook_attr_.find("type=") != std::string::npos;
+
+               // For algorithms, a type attribute must be mentioned, if not already present in docbook_attr_.
+               if (docbook_float_type_ == "algorithm" && !hasType)
+                       docbook_attr_ += " type='algorithm'";
+               // Specific floats for achemso.
+               else if (docbook_float_type_ == "figure" && achemso.find(floattype_) != achemso.end())
+                       docbook_attr_ += " type='" + floattype_ + "'";
+
+               // Finally, merge in the attributes given in argument.
+               if (!docbookAttr.empty())
+                       docbook_attr_ += " " + docbookAttr;
        }
 }
 
@@ -101,30 +131,35 @@ string Floating::defaultCSSClass() const
 }
 
 
+std::string Floating::docbookFloatType() const
+{
+       // All the work is done in the constructor.
+       return docbook_float_type_;
+}
+
+
 string Floating::docbookAttr() const
 {
-       std::set<std::string> achemso = { "chart", "graph", "scheme" };
-       // For algorithms, a type attribute must be mentioned, if not already present in docbook_attr_.
-       if (docbookFloatType() == "algorithm" && docbook_attr_.find("type=") != std::string::npos)
-               return docbook_attr_ + " type='algorithm'";
-       // Specific floats for achemso.
-       else if (docbookFloatType() == "figure" && achemso.find(floattype_) != achemso.end())
-               return docbook_attr_ + " type='" + floattype_ + "'";
-       else
-               return docbook_attr_;
+       return docbook_attr_;
 }
 
 
 string Floating::docbookTag(bool hasTitle) const
 {
-       // TODO: configure this in the layouts?
-       if (docbookFloatType() == "figure" || docbookFloatType() == "algorithm") {
+       // If there is a preconfigured tag, use it.
+       if (!docbook_tag_.empty())
+               return docbook_tag_;
+
+       // Otherwise, guess it.
+       if (docbookFloatType() == "figure" || docbookFloatType() == "algorithm" || docbookFloatType() == "video") {
                return hasTitle ? "figure" : "informalfigure";
+       } else if (docbookFloatType() == "example") {
+               return hasTitle ? "example" : "informalexample";
        } else if (docbookFloatType() == "table") {
                return hasTitle ? "table" : "informaltable";
        } else {
                // If nothing matches, return something that will not be valid.
-               LYXERR0("Unrecognised float type: " + floattype());
+               LYXERR(Debug::OUTFILE, "Float type '" + floattype() + "' unknown to DocBook!");
                return "float";
        }
 }
@@ -140,8 +175,11 @@ string const & Floating::docbookTagType() const
 
 string const & Floating::docbookCaption() const
 {
-       docbook_caption_ = "";
-       if (floattype_ == "figure" || floattype_ == "algorithm")
+       if (!docbook_caption_.empty())
+               return docbook_caption_;
+
+       if (docbook_float_type_ == "figure" || docbook_float_type_ == "video" ||
+                       docbook_float_type_ == "algorithm" || docbook_float_type_ == "example")
                docbook_caption_ = "title";
        else if (floattype_ == "table" || floattype_ == "tableau")
                docbook_caption_ = "caption";