gfx_layout.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef GFX_LAYOUT_H
#define GFX_LAYOUT_H
 
#include "misc/lrucache.hpp"
#include "fontcache.h"
#include "gfx_func.h"
#include "core/math_func.hpp"
 
#include <string_view>

struct FontState {
  FontSize fontsize; 
  ExtendedTextColour cur_colour; 
  std::vector<ExtendedTextColour> colour_stack; 

  FontState() : fontsize(FontSize::End), cur_colour(TextColour::Invalid) {}
  FontState(ExtendedTextColour colour, FontSize fontsize) : fontsize(fontsize), cur_colour(colour) {}
 
  auto operator<=>(const FontState &) const = default;

  inline void SetColour(ExtendedTextColour c)
  {
    assert((c.colour >= TextColour::Begin && c.colour < TextColour::End) || c.colour == TextColour::Invalid);
    assert(!c.flags.Test(ExtendedTextColourFlag::IsPaletteColour));
    if (!this->cur_colour.flags.Test(ExtendedTextColourFlag::Forced)) this->cur_colour = c;
  }

  inline void PopColour()
  {
    if (colour_stack.empty()) return;
    SetColour(colour_stack.back());
    colour_stack.pop_back();
  }

  inline void PushColour()
  {
    colour_stack.push_back(this->cur_colour);
  }

  inline void SetFontSize(FontSize f)
  {
    this->fontsize = f;
  }
};
 
template <typename T> struct std::hash<std::vector<T>> {
  size_t operator()(const std::vector<T> &vec) const
  {
    /* This is not an optimal hash algorithm but in most cases this is empty and therefore the same anyway. */
    return std::transform_reduce(std::begin(vec), std::end(vec),
      std::hash<size_t>{}(std::size(vec)),
      [](const size_t &a, const size_t &b) -> size_t { return a ^ b; },
      [](const T &x) -> size_t { return std::hash<T>{}(x); });
  }
};

template <> struct std::hash<ExtendedTextColour> {
  std::size_t operator()(const ExtendedTextColour &tc) const noexcept
  {
    size_t h1 = std::hash<TextColour>{}(tc.colour);
    size_t h2 = std::hash<uint8_t>{}(tc.flags.base());
    return h1 ^ (h2 << 1);
  }
};
 
template <> struct std::hash<FontState> {
  std::size_t operator()(const FontState &state) const noexcept
  {
    size_t h1 = std::hash<FontSize>{}(state.fontsize);
    size_t h2 = std::hash<ExtendedTextColour>{}(state.cur_colour);
    size_t h3 = std::hash<std::vector<ExtendedTextColour>>{}(state.colour_stack);
    return h1 ^ (h2 << 1) ^ (h3 << 2);
  }
};

class Font {
public:
  FontCache *fc;     
  ExtendedTextColour colour; 
 
  Font(FontSize size, ExtendedTextColour colour);
};

using FontMap = std::vector<std::pair<int, Font *>>;

class ParagraphLayouter {
public:
  virtual ~ParagraphLayouter() = default;

  class Position {
  public:
    int16_t left; 
    int16_t right; 
    int16_t top; 
 
    constexpr inline Position(int16_t left, int16_t right, int16_t top) : left(left), right(right), top(top) { }

    constexpr inline Position(const Point &pt) : left(pt.x), right(pt.x), top(pt.y) { }
  };

  class VisualRun {
  public:
    virtual ~VisualRun() = default;

    virtual const Font *GetFont() const = 0;

    virtual size_t GetGlyphCount() const = 0;

    virtual std::span<const GlyphID> GetGlyphs() const = 0;

    virtual std::span<const Position> GetPositions() const = 0;

    virtual int GetLeading() const = 0;

    virtual std::span<const int> GetGlyphToCharMap() const = 0;
  };

  class Line {
  public:
    virtual ~Line() = default;

    virtual int GetLeading() const = 0;

    virtual int GetWidth() const = 0;

    virtual size_t CountRuns() const = 0;

    virtual const VisualRun &GetVisualRun(size_t run) const = 0;

    virtual int GetInternalCharLength(char32_t c) const = 0;
  };

  virtual void Reflow() = 0;

  virtual std::unique_ptr<const Line> NextLine(int max_width) = 0;
};

class Layouter : public std::vector<const ParagraphLayouter::Line *> {
  std::string_view string; 

  struct LineCacheKey {
    FontState state_before;  
    std::string str;         
  };
 
  struct LineCacheQuery {
    const FontState &state_before; 
    std::string_view str;    
  };
 
  friend struct std::hash<Layouter::LineCacheQuery>;
  struct LineCacheHash;
 
  struct LineCacheEqualTo {
    using is_transparent = void;
 
    template <typename Tlhs, typename Trhs>
    bool operator()(const Tlhs &lhs, const Trhs &rhs) const
    {
      return lhs.state_before == rhs.state_before && lhs.str == rhs.str;
    }
  };
 
public:
  struct LineCacheItem {
    using Buffer = std::unique_ptr<void, void(*)(void *)>;
    /* Stuff that cannot be freed until the ParagraphLayout is freed */
    Buffer buffer{nullptr, [](void *){}}; 
    FontMap runs;              
 
    FontState state_after;     
    std::unique_ptr<ParagraphLayouter> layout = nullptr; 
 
    std::vector<std::unique_ptr<const ParagraphLayouter::Line>> cached_layout{}; 
    int cached_width = 0; 
  };
private:
  using LineCache = LRUCache<LineCacheKey, LineCacheItem, LineCacheHash, LineCacheEqualTo>;
  static std::unique_ptr<LineCache> linecache;
 
  static LineCacheItem &GetCachedParagraphLayout(std::string_view str, const FontState &state);
 
  using FontColourMap = std::map<ExtendedTextColour, std::unique_ptr<Font>>;
  static EnumIndexArray<FontColourMap, FontSize, FontSize::End> fonts; 
public:
  static Font *GetFont(FontSize size, ExtendedTextColour colour);
 
  Layouter(std::string_view str, int maxw = INT32_MAX, FontSize fontsize = FontSize::Normal);
  Dimension GetBounds();
  ParagraphLayouter::Position GetCharPosition(std::string_view::const_iterator ch) const;
  ptrdiff_t GetCharAtPosition(int x, size_t line_index) const;
 
  static void Initialize();
  static void ResetFontCache(FontSize size);
  static void ResetLineCache();
};
 
ParagraphLayouter::Position GetCharPosInString(std::string_view str, size_t pos, FontSize start_fontsize = FontSize::Normal);
ptrdiff_t GetCharAtPosition(std::string_view str, int x, FontSize start_fontsize = FontSize::Normal);
 
template <> struct std::hash<Layouter::LineCacheQuery> {
  std::size_t operator()(const Layouter::LineCacheQuery &state) const noexcept
  {
    size_t h1 = std::hash<std::string_view>{}(state.str);
    size_t h2 = std::hash<FontState>{}(state.state_before);
    return h1 ^ (h2 << 1);
  }
};
 
struct Layouter::LineCacheHash {
  using is_transparent = void;
 
  std::size_t operator()(const Layouter::LineCacheKey &query) const { return std::hash<Layouter::LineCacheQuery>{}(LineCacheQuery{query.state_before, query.str}); }
  std::size_t operator()(const Layouter::LineCacheQuery &query) const { return std::hash<Layouter::LineCacheQuery>{}(query); }
};
 
#endif /* GFX_LAYOUT_H */