gfx_layout_fallback.cpp

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>.
 */

 
#include "stdafx.h"
 
#include "gfx_layout_fallback.h"
#include "string_func.h"
#include "zoom_func.h"
 
#include "table/control_codes.h"
 
#include "safeguards.h"
 
/*** Paragraph layout ***/
class FallbackParagraphLayout : public ParagraphLayouter {
public:
  class FallbackVisualRun : public ParagraphLayouter::VisualRun {
    std::vector<GlyphID> glyphs; 
    std::vector<Position> positions; 
    std::vector<int> glyph_to_char; 
 
    Font *font;       
 
  public:
    FallbackVisualRun(Font *font, const char32_t *chars, int glyph_count, int char_offset, int x);
    const Font *GetFont() const override { return this->font; }
    size_t GetGlyphCount() const override { return this->glyphs.size(); }
    std::span<const GlyphID> GetGlyphs() const override { return this->glyphs; }
    std::span<const Position> GetPositions() const override { return this->positions; }
    int GetLeading() const override { return this->GetFont()->fc->GetHeight(); }
    std::span<const int> GetGlyphToCharMap() const override { return this->glyph_to_char; }
  };

  class FallbackLine : public std::vector<FallbackVisualRun>, public ParagraphLayouter::Line {
  public:
    int GetLeading() const override;
    int GetWidth() const override;
    size_t CountRuns() const override;
    const ParagraphLayouter::VisualRun &GetVisualRun(size_t run) const override;
 
    int GetInternalCharLength(char32_t) const override { return 1; }
  };
 
  const char32_t *buffer_begin; 
  const char32_t *buffer;       
  FontMap &runs;             
 
  FallbackParagraphLayout(char32_t *buffer, int length, FontMap &runs);
  void Reflow() override;
  std::unique_ptr<const Line> NextLine(int max_width) override;
};

/* static */ std::unique_ptr<ParagraphLayouter> FallbackParagraphLayoutFactory::GetParagraphLayout(char32_t *buff, char32_t *buff_end, FontMap &font_mapping)
{
  return std::make_unique<FallbackParagraphLayout>(buff, buff_end - buff, font_mapping);
}

/* static */ size_t FallbackParagraphLayoutFactory::AppendToBuffer(char32_t *buff, [[maybe_unused]] const char32_t *buffer_last, char32_t c)
{
  assert(buff < buffer_last);
  *buff = c;
  return 1;
}

FallbackParagraphLayout::FallbackVisualRun::FallbackVisualRun(Font *font, const char32_t *chars, int char_count, int char_offset, int x) :
    font(font)
{
  const bool isbuiltin = font->fc->IsBuiltInFont();
 
  this->glyphs.reserve(char_count);
  this->glyph_to_char.reserve(char_count);
  this->positions.reserve(char_count);
 
  int advance = x;
  for (int i = 0; i < char_count; i++) {
    const GlyphID &glyph_id = this->glyphs.emplace_back(font->fc->MapCharToGlyph(chars[i]));
    int x_advance = font->fc->GetGlyphWidth(glyph_id);
    if (isbuiltin) {
      this->positions.emplace_back(advance, advance + x_advance - 1, font->fc->GetAscender()); // Apply sprite font's ascender.
    } else if (chars[i] >= SCC_SPRITE_START && chars[i] <= SCC_SPRITE_END) {
      this->positions.emplace_back(advance, advance + x_advance - 1, (font->fc->GetHeight() - ScaleSpriteTrad(FontCache::GetDefaultFontHeight(font->fc->GetSize()))) / 2); // Align sprite font to centre
    } else {
      this->positions.emplace_back(advance, advance + x_advance - 1, 0); // No ascender adjustment.
    }
    advance += x_advance;
    this->glyph_to_char.push_back(char_offset + i);
  }
}
 
int FallbackParagraphLayout::FallbackLine::GetLeading() const
{
  int leading = 0;
  for (const auto &run : *this) {
    leading = std::max(leading, run.GetLeading());
  }
 
  return leading;
}
 
int FallbackParagraphLayout::FallbackLine::GetWidth() const
{
  if (this->empty()) return 0;
 
  /*
   * The last X position of a run contains is the end of that run.
   * Since there is no left-to-right support, taking this value of
   * the last run gives us the end of the line and thus the width.
   */
  const auto &run = this->GetVisualRun(this->CountRuns() - 1);
  const auto &positions = run.GetPositions();
  if (positions.empty()) return 0;
  return positions.back().right + 1;
}
 
size_t FallbackParagraphLayout::FallbackLine::CountRuns() const
{
  return this->size();
}
 
const ParagraphLayouter::VisualRun &FallbackParagraphLayout::FallbackLine::GetVisualRun(size_t run) const
{
  return this->at(run);
}

FallbackParagraphLayout::FallbackParagraphLayout(char32_t *buffer, [[maybe_unused]] int length, FontMap &runs) : buffer_begin(buffer), buffer(buffer), runs(runs)
{
  assert(runs.rbegin()->first == length);
}
 
void FallbackParagraphLayout::Reflow()
{
  this->buffer = this->buffer_begin;
}
 
std::unique_ptr<const ParagraphLayouter::Line> FallbackParagraphLayout::NextLine(int max_width)
{
  /* Simple idea:
   *  - split a line at a newline character, or at a space where we can break a line.
   *  - split for a visual run whenever a new line happens, or the font changes.
   */
  if (this->buffer == nullptr) return nullptr;
 
  std::unique_ptr<FallbackLine> l = std::make_unique<FallbackLine>();
 
  if (*this->buffer == '\0') {
    /* Only a newline. */
    this->buffer = nullptr;
    l->emplace_back(this->runs.begin()->second, this->buffer, 0, 0, 0);
    return l;
  }
 
  int offset = this->buffer - this->buffer_begin;
  FontMap::iterator iter = this->runs.begin();
  while (iter->first <= offset) {
    ++iter;
    assert(iter != this->runs.end());
  }
 
  const FontCache *fc = iter->second->fc;
  const char32_t *next_run = this->buffer_begin + iter->first;
 
  const char32_t *begin = this->buffer;
  const char32_t *last_space = nullptr;
  const char32_t *last_char;
  int width = 0;
  for (;;) {
    char32_t c = *this->buffer;
    last_char = this->buffer;
 
    if (c == '\0') {
      this->buffer = nullptr;
      break;
    }
 
    if (this->buffer == next_run) {
      int w = l->GetWidth();
      l->emplace_back(iter->second, begin, this->buffer - begin, begin - this->buffer_begin, w);
      ++iter;
      assert(iter != this->runs.end());
 
      next_run = this->buffer_begin + iter->first;
      begin = this->buffer;
      /* Since a next run is started, there is already some text that
       * will be shown for this line. However, we do not want to break
       * this line at the previous space, so pretend we passed a space
       * just before this next run. */
      last_space = begin - 1;
    }
 
    if (IsWhitespace(c)) last_space = this->buffer;
 
    if (IsPrintable(c) && !IsTextDirectionChar(c)) {
      int char_width = GetCharacterWidth(fc->GetSize(), c);
      width += char_width;
      if (width > max_width) {
        /* The string is longer than maximum width so we need to decide
         * what to do with it. */
        if (width == char_width) {
          /* The character is wider than allowed width; don't know
           * what to do with this case... bail out! */
          this->buffer = nullptr;
          return l;
        }
 
        if (last_space == nullptr) {
          /* No space has been found. Just terminate at our current
           * location. This usually happens for languages that do not
           * require spaces in strings, like Chinese, Japanese and
           * Korean. For other languages terminating mid-word might
           * not be the best, but terminating the whole string instead
           * of continuing the word at the next line is worse. */
          last_char = this->buffer;
        } else {
          /* A space is found; perfect place to terminate */
          this->buffer = last_space + 1;
          last_char = last_space;
        }
        break;
      }
    }
 
    this->buffer++;
  }
 
  if (l->empty() || last_char - begin > 0) {
    int w = l->GetWidth();
    l->emplace_back(iter->second, begin, last_char - begin, begin - this->buffer_begin, w);
  }
  return l;
}