supercell-wx/wxdata/include/scwx/gr/placefile.hpp

#pragma once

#include <istream>
#include <memory>
#include <string>
#include <vector>

#include <boost/gil/typedefs.hpp>
#include <boost/units/quantity.hpp>
#include <boost/units/systems/angle/degrees.hpp>
#include <boost/units/systems/si/length.hpp>

namespace scwx
{
namespace gr
{

/**
 * @brief Place File
 *
 * Implementation based on:
 * Place File Specification
 * Mike Gibson
 * Gibson Ridge Software, LLC.  Used with permission.
 * http://www.grlevelx.com/manuals/gis/files_places.htm
 */
class Placefile
{
public:
   explicit Placefile();
   ~Placefile();

   Placefile(const Placefile&)            = delete;
   Placefile& operator=(const Placefile&) = delete;

   Placefile(Placefile&&) noexcept;
   Placefile& operator=(Placefile&&) noexcept;

   enum class ItemType
   {
      Icon,
      Font,
      Text,
      Line,
      Triangles,
      Image,
      Polygon,
      Unknown
   };

   struct IconFile
   {
      std::size_t fileNumber_ {};
      std::size_t iconWidth_ {};
      std::size_t iconHeight_ {};
      std::size_t hotX_ {};
      std::size_t hotY_ {};
      std::string filename_ {};
   };

   struct Font
   {
      std::size_t  fontNumber_ {};
      std::size_t  pixels_ {};
      std::int32_t flags_ {};
      std::string  face_ {};
   };

   struct DrawItem
   {
      ItemType itemType_ {ItemType::Unknown};
      boost::units::quantity<boost::units::si::length> threshold_ {};
   };

   struct IconDrawItem : DrawItem
   {
      IconDrawItem() { itemType_ = ItemType::Icon; }

      double                                                    latitude_ {};
      double                                                    longitude_ {};
      double                                                    x_ {};
      double                                                    y_ {};
      boost::units::quantity<boost::units::degree::plane_angle> angle_ {};
      std::size_t fileNumber_ {0u};
      std::size_t iconNumber_ {0u};
      std::string hoverText_ {};
   };

   struct TextDrawItem : DrawItem
   {
      TextDrawItem() { itemType_ = ItemType::Text; }

      boost::gil::rgba8_pixel_t color_ {};
      double                    latitude_ {};
      double                    longitude_ {};
      double                    x_ {};
      double                    y_ {};
      std::size_t               fontNumber_ {0u};
      std::string               text_ {};
      std::string               hoverText_ {};
   };

   bool IsValid() const;

   /**
    * @brief Gets the list of draw items defined in the placefile
    *
    * @return vector of draw item pointers
    */
   std::vector<std::shared_ptr<DrawItem>> GetDrawItems();

   std::string                                            name() const;
   std::string                                            title() const;
   std::unordered_map<std::size_t, std::shared_ptr<Font>> fonts();
   std::shared_ptr<Font>                                  font(std::size_t i);

   static std::shared_ptr<Placefile> Load(const std::string& filename);
   static std::shared_ptr<Placefile> Load(const std::string& name,
                                          std::istream&      is);

private:
   class Impl;
   std::unique_ptr<Impl> p;
};

} // namespace gr
} // namespace scwx