Support for attributes in illustration name

Parsing of the illustration metadata item name now supports attributes
too.

Also, an illustration metadata item name is now considered invalid if it
doesn't match the string generated from the result of the parsing (which
can be, for example, due to leading zeros in width and/or height values,
leading and/or trailing zeros in the scale value, wrong order of
attributes, etc).

Author: veloman-yunkan

include/zim/illustration.h

@@ -38,6 +38,8 @@ class LIBZIM_API Attributes : public std::map<std::string, std::string>
   Attributes(const std::initializer_list<ImplType::value_type>& x)
     : ImplType(x)
   {}
+
+  static Attributes parse(const std::string& s);
 };
 
 /**
@@ -49,8 +51,6 @@ struct LIBZIM_API IllustrationInfo
   uint32_t height; // in CSS pixels
   float    scale;  // devicePixelRatio value of the targeted display media
   Attributes extraAttributes; // additional attributes of the illustration
-                              // (not used yet but introduced beforehand in
-                              // order to avoid an ABI change later)
 
   std::string asMetadataItemName() const;
   static IllustrationInfo fromMetadataItemName(const std::string& s);

src/tools.cpp

@@ -128,24 +128,45 @@ std::string zim::IllustrationInfo::asMetadataItemName() const
   return oss.str();
 }
 
+zim::Attributes zim::Attributes::parse(const std::string& s)
+{
+  zim::Attributes a;
+  for (const std::string& nameAndValue : split(s, ";") ) {
+    const auto i = nameAndValue.find('=');
+    const std::string name = nameAndValue.substr(0, i);
+    const std::string value = i == std::string::npos
+                            ? ""
+                            : nameAndValue.substr(i+1);
+    a[name] = value;
+  }
+  return a;
+}
+
 zim::IllustrationInfo zim::IllustrationInfo::fromMetadataItemName(const std::string& s)
 {
   int nw(0), nh(0), ns(0), nEnd(0);
   long int w(-1), h(-1);
   float scale(0);
 
-  const char fmt[] = "Illustration_%n%ldx%n%ld@%n%f%n";
-  if ( sscanf(s.c_str(), fmt, &nw, &w, &nh, &h, &ns, &scale, &nEnd) == 3
-     && (size_t)nEnd == s.size()
-     && !isspace(s[nw])
-     && !isspace(s[nh])
-     && !isspace(s[ns])
-     && w >= 0
-     && h >= 0
-     && scale >= 0 ) {
-    return IllustrationInfo{uint32_t(w), uint32_t(h), scale, {}};
+  const char fmt[] = "Illustration_%n%ldx%n%ld@%n%f%n;";
+  if ( sscanf(s.c_str(), fmt, &nw, &w, &nh, &h, &ns, &scale, &nEnd) != 3
+     || isspace(s[nw])
+     || isspace(s[nh])
+     || isspace(s[ns])
+     || w < 0
+     || h < 0
+     || scale < 0
+     || (size_t(nEnd) != s.size() && s[nEnd] != ';') ) {
+    throw std::runtime_error("Invalid name of illustration metadata item");
   }
-  throw std::runtime_error("");
+
+  const auto attrStart = std::min(s.size(), size_t(nEnd) + 1);
+  const auto attributes = Attributes::parse(s.substr(attrStart));
+  const auto ii = IllustrationInfo{uint32_t(w), uint32_t(h), scale, attributes};
+  if ( ii.asMetadataItemName() != s ) {
+    throw std::runtime_error("Invalid name of illustration metadata item");
+  }
+  return ii;
 }
 
 uint32_t zim::randomNumber(uint32_t max)

test/illustrations.cpp

@@ -33,10 +33,11 @@ TEST(Illustrations, parsingOfValidInput)
 
   CHECK("Illustration_0x0@1",   ({  0,  0, 1.0, {} }) );
   CHECK("Illustration_1x1@1",   ({  1,  1, 1.0, {} }) );
-  CHECK("Illustration_01x01@1", ({  1,  1, 1.0, {} }) );
   CHECK("Illustration_64x64@1", ({ 64, 64, 1.0, {} }) );
   CHECK("Illustration_64x64@2", ({ 64, 64, 2.0, {} }) );
   CHECK("Illustration_64x48@2", ({ 64, 48, 2.0, {} }) );
+  CHECK("Illustration_64x64@1;ui=dark", ({ 64, 64, 1.0, {{"ui", "dark"}} }));
+  CHECK("Illustration_48x64@1.5;lang=fr;ui=dark", ({ 48, 64, 1.5, {{"lang", "fr"}, {"ui", "dark"}} }));
 #undef CHECK
 }
 
@@ -46,17 +47,20 @@ TEST(Illustrations, parsingOfInvalidInput)
   ASSERT_THROW(zim::IllustrationInfo::fromMetadataItemName(str), \
                std::runtime_error)
 
+  CHECK_PARSING_OF_INVALID_INPUT("Illustration_01x01@1");
+  CHECK_PARSING_OF_INVALID_INPUT("Illustration_48x48@1;");
   CHECK_PARSING_OF_INVALID_INPUT("Illstration_64x64@1");
   CHECK_PARSING_OF_INVALID_INPUT("Illstration_");
   CHECK_PARSING_OF_INVALID_INPUT("Illustration_64x@1");
-  CHECK_PARSING_OF_INVALID_INPUT("Illustration_64x64@1;scheme=light");
   CHECK_PARSING_OF_INVALID_INPUT("Illustration_64x");
   CHECK_PARSING_OF_INVALID_INPUT("Illustration_64x64");
   CHECK_PARSING_OF_INVALID_INPUT("Illustration_-32x-32@1");
   CHECK_PARSING_OF_INVALID_INPUT("Illustration_ 64x64@1");
   CHECK_PARSING_OF_INVALID_INPUT("Illustration_64x 64@1");
   CHECK_PARSING_OF_INVALID_INPUT("Illustration_ 64x 64@1");
   CHECK_PARSING_OF_INVALID_INPUT("Illustration_1 28x1 28@1");
+  CHECK_PARSING_OF_INVALID_INPUT("Illustration_48x64@1.5000");
+  CHECK_PARSING_OF_INVALID_INPUT("Illustration_48x64@1.5;ui=dark;lang=fr");
 
 #undef CHECK_PARSING_OF_INVALID_INPUT
 }