textfile_gui.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 <http://www.gnu.org/licenses/>.
 */
 
#include "stdafx.h"
#include "core/backup_type.hpp"
#include "fileio_func.h"
#include "fontcache.h"
#include "gfx_type.h"
#include "gfx_func.h"
#include "string_func.h"
#include "core/string_builder.hpp"
#include "textfile_gui.h"
#include "dropdown_type.h"
#include "dropdown_func.h"
#include "gfx_layout.h"
#include "debug.h"
#include "openttd.h"
 
#include "widgets/misc_widget.h"
 
#include "table/strings.h"
#include "table/control_codes.h"
 
#if defined(WITH_ZLIB)
#include <zlib.h>
#endif
 
#if defined(WITH_LIBLZMA)
#include <lzma.h>
#endif
 
#include <regex>
 
#include "safeguards.h"
 
static constexpr NWidgetPart _nested_textfile_widgets[] = {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
    NWidget(WWT_PUSHARROWBTN, COLOUR_MAUVE, WID_TF_NAVBACK), SetFill(0, 1), SetMinimalSize(15, 1), SetArrowWidgetTypeTip(AWV_DECREASE, STR_TEXTFILE_NAVBACK_TOOLTIP),
    NWidget(WWT_PUSHARROWBTN, COLOUR_MAUVE, WID_TF_NAVFORWARD), SetFill(0, 1), SetMinimalSize(15, 1), SetArrowWidgetTypeTip(AWV_INCREASE, STR_TEXTFILE_NAVFORWARD_TOOLTIP),
    NWidget(WWT_CAPTION, COLOUR_MAUVE, WID_TF_CAPTION), SetToolTip(STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_TEXTBTN, COLOUR_MAUVE, WID_TF_WRAPTEXT), SetStringTip(STR_TEXTFILE_WRAP_TEXT, STR_TEXTFILE_WRAP_TEXT_TOOLTIP),
    NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
  EndContainer(),
  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_TF_SEL_JUMPLIST),
    NWidget(WWT_PANEL, COLOUR_MAUVE),
      NWidget(NWID_HORIZONTAL), SetPIP(WidgetDimensions::unscaled.frametext.left, 0, WidgetDimensions::unscaled.frametext.right),
        /* As this widget can be toggled, it needs to be a multiplier of FS_MONO. So add a spacer that ensures this. */
        NWidget(NWID_SPACER), SetMinimalSize(1, 0), SetMinimalTextLines(2, 0, FS_MONO),
        NWidget(NWID_VERTICAL),
          NWidget(NWID_SPACER), SetFill(1, 1), SetResize(1, 0),
          NWidget(WWT_DROPDOWN, COLOUR_MAUVE, WID_TF_JUMPLIST), SetStringTip(STR_TEXTFILE_JUMPLIST, STR_TEXTFILE_JUMPLIST_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
          NWidget(NWID_SPACER), SetFill(1, 1), SetResize(1, 0),
        EndContainer(),
      EndContainer(),
    EndContainer(),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, COLOUR_MAUVE, WID_TF_BACKGROUND), SetMinimalSize(200, 125), SetResize(1, 12), SetScrollbar(WID_TF_VSCROLLBAR),
    EndContainer(),
    NWidget(NWID_VERTICAL),
      NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_TF_VSCROLLBAR),
    EndContainer(),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(NWID_HSCROLLBAR, COLOUR_MAUVE, WID_TF_HSCROLLBAR),
    NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
  EndContainer(),
};
static constexpr NWidgetPart _nested_textfile_widgets[] = {…};
 
static WindowDesc _textfile_desc(
  WDP_CENTER, "textfile", 630, 460,
  WC_TEXTFILE, WC_NONE,
  {},
  _nested_textfile_widgets
);
 
TextfileWindow::TextfileWindow(Window *parent, TextfileType file_type) : Window(_textfile_desc), file_type(file_type)
{
  /* Init of nested tree is deferred.
   * TextfileWindow::ConstructWindow must be called by the inheriting window. */
  this->parent = parent;
}
 
void TextfileWindow::ConstructWindow()
{
  this->CreateNestedTree();
  this->vscroll = this->GetScrollbar(WID_TF_VSCROLLBAR);
  this->hscroll = this->GetScrollbar(WID_TF_HSCROLLBAR);
  this->GetWidget<NWidgetCore>(WID_TF_CAPTION)->SetStringTip(STR_TEXTFILE_README_CAPTION + this->file_type, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS);
  this->GetWidget<NWidgetStacked>(WID_TF_SEL_JUMPLIST)->SetDisplayedPlane(SZSP_HORIZONTAL);
  this->FinishInitNested(this->file_type);
 
  this->DisableWidget(WID_TF_NAVBACK);
  this->DisableWidget(WID_TF_NAVFORWARD);
  this->hscroll->SetStepSize(10); // Speed up horizontal scrollbar
}
 
void TextfileWindow::ReflowContent()
{
  /* Minimum number of lines that will be flowed. */
  if (this->num_lines == 0) this->num_lines = std::size(this->lines);
 
  auto it = this->GetIteratorFromPosition(this->vscroll->GetPosition());
 
  auto adapter = AlternatingView{this->lines, it};
  this->reflow_iter = adapter.begin();
  this->reflow_end = adapter.end();
}
void TextfileWindow::ReflowContent() {…}
 
/* virtual */ void TextfileWindow::UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize)
{
  switch (widget) {
    case WID_TF_BACKGROUND:
      resize.width = GetCharacterHeight(FS_MONO); // Width is not available here as the font may not be loaded yet.
      resize.height = GetCharacterHeight(FS_MONO);
 
      size.height = 4 * resize.height + WidgetDimensions::scaled.frametext.Vertical(); // At least 4 lines are visible.
      size.width = std::max(200u, size.width); // At least 200 pixels wide.
      break;
  }
}
/* virtual */ void TextfileWindow::UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) {…}
 
void TextfileWindow::SetupScrollbars()
{
  this->vscroll->SetCount(this->num_lines);
  this->hscroll->SetCount(this->IsTextWrapped() ? 0 : CeilDiv(this->max_width, this->resize.step_width));
 
  this->SetWidgetDirty(WID_TF_VSCROLLBAR);
  this->SetWidgetDirty(WID_TF_HSCROLLBAR);
  this->SetWidgetDisabledState(WID_TF_HSCROLLBAR, this->IsTextWrapped());
}
void TextfileWindow::SetupScrollbars() {…}
 
 
static const std::regex _markdown_link_regex{"\\[(.+?)\\]\\((.+?)\\)", std::regex_constants::ECMAScript | std::regex_constants::optimize};
 
enum class HyperlinkType : uint8_t {
  Internal, 
  Web,      
  File,     
  Unknown,  
};
enum class HyperlinkType : uint8_t {…};
 
static HyperlinkType ClassifyHyperlink(const std::string &destination, bool trusted)
{
  if (destination.empty()) return HyperlinkType::Unknown;
  if (destination.starts_with("#")) return HyperlinkType::Internal;
 
  /* Only allow external / internal links for sources we trust. */
  if (!trusted) return HyperlinkType::Unknown;
 
  if (destination.starts_with("http://")) return HyperlinkType::Web;
  if (destination.starts_with("https://")) return HyperlinkType::Web;
  if (destination.starts_with("./")) return HyperlinkType::File;
  return HyperlinkType::Unknown;
}
static HyperlinkType ClassifyHyperlink(const std::string &destination, bool trusted) {…}
 
static std::string MakeAnchorSlug(const std::string &line)
{
  std::string r = "#";
  uint state = 0;
  for (char c : line) {
    if (state == 0) {
      /* State 0: Skip leading hashmarks and spaces. */
      if (c == '#') continue;
      if (c == ' ') continue;
      state = 1;
    }
    if (state == 2) {
      /* State 2: Wait for a non-space/dash character.
       * When found, output a dash and that character. */
      if (c == ' ' || c == '-') continue;
      r += '-';
      state = 1;
    }
    if (state == 1) {
      /* State 1: Normal text.
       * Lowercase alphanumerics,
       * spaces and dashes become dashes,
       * everything else is removed. */
      if (isalnum(c)) {
        r += tolower(c);
      } else if (c == ' ' || c == '-') {
        state = 2;
      }
    }
  }
 
  return r;
}
static std::string MakeAnchorSlug(const std::string &line) {…}
 
void TextfileWindow::FindHyperlinksInMarkdown(Line &line, size_t line_index)
{
  std::string::const_iterator last_match_end = line.text.cbegin();
  std::string fixed_line;
  StringBuilder builder(fixed_line);
 
  std::sregex_iterator matcher{ line.text.cbegin(), line.text.cend(), _markdown_link_regex};
  while (matcher != std::sregex_iterator()) {
    std::smatch match = *matcher;
 
    Hyperlink &link = this->links.emplace_back(line_index, 0, 0, match[2].str());
 
    HyperlinkType link_type = ClassifyHyperlink(link.destination, this->trusted);
    StringControlCode link_colour;
    switch (link_type) {
      case HyperlinkType::Internal:
        link_colour = SCC_GREEN;
        break;
      case HyperlinkType::Web:
        link_colour = SCC_LTBLUE;
        break;
      case HyperlinkType::File:
        link_colour = SCC_LTBROWN;
        break;
      default:
        /* Don't make other link types fancy as they aren't handled (yet). */
        link_colour = SCC_CONTROL_END;
        break;
    }
 
    if (link_colour != SCC_CONTROL_END) {
      /* Format the link to look like a link. */
      builder += std::string_view(last_match_end, match[0].first);
      link.begin = fixed_line.length();
      builder.PutUtf8(SCC_PUSH_COLOUR);
      builder.PutUtf8(link_colour);
      builder += match[1].str();
      link.end = fixed_line.length();
      builder.PutUtf8(SCC_POP_COLOUR);
      last_match_end = match[0].second;
    }
 
    /* Find next link. */
    ++matcher;
  }
  if (last_match_end == line.text.cbegin()) return; // nothing found
 
  /* Add remaining text on line. */
  fixed_line += std::string(last_match_end, line.text.cend());
 
  /* Overwrite original line text with "fixed" line text. */
  line.text = std::move(fixed_line);
}
void TextfileWindow::FindHyperlinksInMarkdown(Line &line, size_t line_index) {…}
 
const TextfileWindow::Hyperlink *TextfileWindow::GetHyperlink(Point pt) const
{
  if (this->links.empty()) return nullptr;
 
  /* Which line was clicked. */
  const int clicked_row = this->GetRowFromWidget(pt.y, WID_TF_BACKGROUND, WidgetDimensions::scaled.frametext.top, GetCharacterHeight(FS_MONO)) + this->GetScrollbar(WID_TF_VSCROLLBAR)->GetPosition();
 
  int visible_line = 0;
  auto it = std::ranges::find_if(this->lines, [&visible_line, clicked_row](const Line &l) {
    visible_line += l.num_lines;
    return (visible_line - l.num_lines) <= clicked_row && visible_line > clicked_row;
  });
  if (it == this->lines.cend()) return nullptr;
 
  size_t line_index = it - this->lines.cbegin();
  size_t subline = clicked_row - (visible_line - it->num_lines);
  Debug(misc, 4, "TextfileWindow check hyperlink: clicked_row={}, line_index={}, line.top={}, subline={}", clicked_row, line_index, visible_line - it->num_lines, subline);
 
  /* Find hyperlinks in this line. */
  std::vector<const Hyperlink *> found_links;
  for (const auto &link : this->links) {
    if (link.line == line_index) found_links.push_back(&link);
  }
  if (found_links.empty()) return nullptr;
 
  /* Build line layout to figure out character position that was clicked. */
  const Line &line = this->lines[line_index];
  Layouter layout(line.text, line.wrapped_width, FS_MONO);
  assert(subline < layout.size());
  ptrdiff_t char_index = layout.GetCharAtPosition(pt.x - WidgetDimensions::scaled.frametext.left, subline);
  if (char_index < 0) return nullptr;
  Debug(misc, 4, "TextfileWindow check hyperlink click: line={}, subline={}, char_index={}", line_index, subline, char_index);
 
  /* Found character index in line, check if any links are at that position. */
  for (const Hyperlink *link : found_links) {
    Debug(misc, 4, "Checking link from char {} to {}", link->begin, link->end);
    if (static_cast<size_t>(char_index) >= link->begin && static_cast<size_t>(char_index) < link->end) {
      Debug(misc, 4, "Returning link with destination: {}", link->destination);
      return link;
    }
  }
 
  return nullptr;
}
const TextfileWindow::Hyperlink *TextfileWindow::GetHyperlink(Point pt) const {…}
 
void TextfileWindow::AppendHistory(const std::string &filepath)
{
  this->history.erase(this->history.begin() + this->history_pos + 1, this->history.end());
  this->UpdateHistoryScrollpos();
  this->history.emplace_back(filepath, 0);
  this->EnableWidget(WID_TF_NAVBACK);
  this->DisableWidget(WID_TF_NAVFORWARD);
  this->history_pos = this->history.size() - 1;
}
void TextfileWindow::AppendHistory(const std::string &filepath) {…}
 
void TextfileWindow::UpdateHistoryScrollpos()
{
  this->history[this->history_pos].scrollpos = this->GetScrollbar(WID_TF_VSCROLLBAR)->GetPosition();
}
void TextfileWindow::UpdateHistoryScrollpos() {…}
 
void TextfileWindow::NavigateHistory(int delta)
{
  if (delta == 0) return;
  if (delta < 0 && static_cast<int>(this->history_pos) < -delta) return;
  if (delta > 0 && this->history_pos + delta >= this->history.size()) return;
 
  this->UpdateHistoryScrollpos();
  this->history_pos += delta;
 
  if (this->history[this->history_pos].filepath != this->filepath) {
    this->filepath = this->history[this->history_pos].filepath;
    this->filename = this->filepath.substr(this->filepath.find_last_of(PATHSEP) + 1);
    this->LoadTextfile(this->filepath, NO_DIRECTORY);
  }
 
  this->SetWidgetDisabledState(WID_TF_NAVFORWARD, this->history_pos + 1 >= this->history.size());
  this->SetWidgetDisabledState(WID_TF_NAVBACK, this->history_pos == 0);
  this->GetScrollbar(WID_TF_VSCROLLBAR)->SetPosition(this->history[this->history_pos].scrollpos);
  this->GetScrollbar(WID_TF_HSCROLLBAR)->SetPosition(0);
  this->SetDirty();
}
void TextfileWindow::NavigateHistory(int delta) {…}
 
/* virtual */ void TextfileWindow::OnHyperlinkClick(const Hyperlink &link)
{
  switch (ClassifyHyperlink(link.destination, this->trusted)) {
    case HyperlinkType::Internal:
    {
      auto it = std::ranges::find(this->link_anchors, link.destination, &Hyperlink::destination);
      if (it != this->link_anchors.cend()) {
        this->AppendHistory(this->filepath);
        this->ScrollToLine(it->line);
        this->UpdateHistoryScrollpos();
      }
      break;
    }
 
    case HyperlinkType::Web:
      OpenBrowser(link.destination);
      break;
 
    case HyperlinkType::File:
      this->NavigateToFile(link.destination, 0);
      break;
 
    default:
      /* Do nothing */
      break;
  }
}
/* virtual */ void TextfileWindow::OnHyperlinkClick(const Hyperlink &link) {…}
 
void TextfileWindow::NavigateToFile(std::string newfile, size_t line)
{
  /* Double-check that the file link begins with ./ as a relative path. */
  if (!newfile.starts_with("./")) return;
 
  /* Get the path portion of the current file path. */
  std::string newpath = this->filepath;
  size_t pos = newpath.find_last_of(PATHSEPCHAR);
  if (pos == std::string::npos) {
    newpath.clear();
  } else {
    newpath.erase(pos + 1);
  }
 
  /* Check and remove for anchor in link. Do this before we find the filename, as people might have a / after the hash. */
  size_t anchor_pos = newfile.find_first_of('#');
  std::string anchor;
  if (anchor_pos != std::string::npos) {
    anchor = newfile.substr(anchor_pos);
    newfile.erase(anchor_pos);
  }
 
  /* Now the anchor is gone, check if this is a markdown or textfile. */
  if (!StrEndsWithIgnoreCase(newfile, ".md") && !StrEndsWithIgnoreCase(newfile, ".txt")) return;
 
  /* Convert link destination to acceptable local filename (replace forward slashes with correct path separator). */
  newfile = newfile.substr(2);
  if (PATHSEPCHAR != '/') {
    for (char &c : newfile) {
      if (c == '/') c = PATHSEPCHAR;
    }
  }
 
  /* Paste the two together and check file exists. */
  newpath = newpath + newfile;
  if (!FioCheckFileExists(newpath, NO_DIRECTORY)) return;
 
  /* Update history. */
  this->AppendHistory(newpath);
 
  /* Load the new file. */
  this->filepath = newpath;
  this->filename = newpath.substr(newpath.find_last_of(PATHSEP) + 1);
 
  this->LoadTextfile(this->filepath, NO_DIRECTORY);
 
  this->GetScrollbar(WID_TF_HSCROLLBAR)->SetPosition(0);
  this->GetScrollbar(WID_TF_VSCROLLBAR)->SetPosition(0);
 
  if (anchor.empty() || line != 0) {
    this->ScrollToLine(line);
  } else {
    auto anchor_dest = std::ranges::find(this->link_anchors, anchor, &Hyperlink::destination);
    if (anchor_dest != this->link_anchors.cend()) {
      this->ScrollToLine(anchor_dest->line);
      this->UpdateHistoryScrollpos();
    } else {
      this->ScrollToLine(0);
    }
  }
}
void TextfileWindow::NavigateToFile(std::string newfile, size_t line) {…}
 
/* virtual */ void TextfileWindow::AfterLoadText()
{
  this->link_anchors.clear();
 
  if (StrEndsWithIgnoreCase(this->filename, ".md")) this->AfterLoadMarkdown();
 
  if (this->GetWidget<NWidgetStacked>(WID_TF_SEL_JUMPLIST)->SetDisplayedPlane(this->jumplist.empty() ? SZSP_HORIZONTAL : 0)) this->ReInit();
}
/* virtual */ void TextfileWindow::AfterLoadText() {…}
 
void TextfileWindow::AfterLoadMarkdown()
{
  for (size_t line_index = 0; line_index < this->lines.size(); ++line_index) {
    Line &line = this->lines[line_index];
 
    /* Find and mark all hyperlinks in the line. */
    this->FindHyperlinksInMarkdown(line, line_index);
 
    /* All lines beginning with # are headings. */
    if (!line.text.empty() && line.text[0] == '#') {
      this->jumplist.push_back(line_index);
      this->lines[line_index].colour = TC_GOLD;
      this->link_anchors.emplace_back(line_index, 0, 0, MakeAnchorSlug(line.text));
    }
  }
}
void TextfileWindow::AfterLoadMarkdown() {…}
 
/* virtual */ void TextfileWindow::OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count)
{
  switch (widget) {
    case WID_TF_WRAPTEXT:
      this->ToggleWidgetLoweredState(WID_TF_WRAPTEXT);
      this->InvalidateData();
      break;
 
    case WID_TF_JUMPLIST: {
      DropDownList list;
      for (size_t line : this->jumplist) {
        list.push_back(MakeDropDownListStringItem(GetString(STR_TEXTFILE_JUMPLIST_ITEM, this->lines[line].text), (int)line));
      }
      ShowDropDownList(this, std::move(list), -1, widget);
      break;
    }
 
    case WID_TF_NAVBACK:
      this->NavigateHistory(-1);
      break;
 
    case WID_TF_NAVFORWARD:
      this->NavigateHistory(+1);
      break;
 
    case WID_TF_BACKGROUND: {
      const Hyperlink *link = this->GetHyperlink(pt);
      if (link != nullptr) this->OnHyperlinkClick(*link);
      break;
    }
  }
}
/* virtual */ void TextfileWindow::OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) {…}
 
/* virtual */ bool TextfileWindow::OnTooltip([[maybe_unused]] Point pt, WidgetID widget, TooltipCloseCondition close_cond)
{
  if (widget != WID_TF_BACKGROUND) return false;
 
  const Hyperlink *link = this->GetHyperlink(pt);
  if (link == nullptr) return false;
 
  GuiShowTooltips(this, GetEncodedString(STR_JUST_RAW_STRING, link->destination), close_cond);
 
  return true;
}
/* virtual */ bool TextfileWindow::OnTooltip([[maybe_unused]] Point pt, WidgetID widget, TooltipCloseCondition close_cond) {…}
 
/* virtual */ void TextfileWindow::DrawWidget(const Rect &r, WidgetID widget) const
{
  if (widget == WID_TF_CAPTION && std::size(this->lines) > 0 && this->reflow_iter != this->reflow_end) {
    /* Draw a progress bar in the caption. */
    Rect fr = r.Shrink(WidgetDimensions::scaled.captiontext).WithHeight(WidgetDimensions::scaled.vsep_normal, true);
    size_t remaining = std::distance(this->reflow_iter, this->reflow_end);
    fr = fr.WithWidth(static_cast<int>(remaining * fr.Width() / std::size(this->lines)), _current_text_dir != TD_RTL);
    GfxFillRect(fr, PC_WHITE, FILLRECT_CHECKER);
  }
 
  if (widget != WID_TF_BACKGROUND) return;
 
  Rect fr = r.Shrink(WidgetDimensions::scaled.frametext);
 
  DrawPixelInfo new_dpi;
  if (!FillDrawPixelInfo(&new_dpi, fr)) return;
  AutoRestoreBackup dpi_backup(_cur_dpi, &new_dpi);
 
  /* Draw content (now coordinates given to DrawString* are local to the new clipping region). */
  fr = fr.Translate(-fr.left, -fr.top);
  int line_height = GetCharacterHeight(FS_MONO);
 
  if (!this->IsTextWrapped()) fr = ScrollRect(fr, *this->hscroll, this->resize.step_width);
 
  int pos = this->vscroll->GetPosition();
  int cap = this->vscroll->GetCapacity();
  int cur_line = 0;
  for (auto &line : this->lines) {
    int top = cur_line;
    cur_line += line.num_lines;
    if (cur_line <= pos) continue;
    if (top > pos + cap) break;
 
    int y_offset = (top - pos) * line_height;
    if (line.wrapped_width != 0) {
      Rect tr = fr.WithWidth(line.wrapped_width, _current_text_dir == TD_RTL);
      DrawStringMultiLineWithClipping(tr.left, tr.right, y_offset, y_offset + line.num_lines * line_height, line.text, line.colour, SA_TOP | SA_LEFT, false, FS_MONO);
    } else {
      DrawString(fr.left, fr.right, y_offset, line.text, line.colour, SA_TOP | SA_LEFT, false, FS_MONO);
    }
  }
}
/* virtual */ void TextfileWindow::DrawWidget(const Rect &r, WidgetID widget) const {…}
 
/* virtual */ void TextfileWindow::OnResize()
{
  this->vscroll->SetCapacityFromWidget(this, WID_TF_BACKGROUND, WidgetDimensions::scaled.frametext.Vertical());
  this->hscroll->SetCapacityFromWidget(this, WID_TF_BACKGROUND, WidgetDimensions::scaled.framerect.Horizontal());
 
  this->UpdateVisibleIterators();
  this->ReflowContent();
  this->SetupScrollbars();
}
/* virtual */ void TextfileWindow::OnResize() {…}
 
/* virtual */ void TextfileWindow::OnInit()
{
  /* If font has changed we need to recalculate the maximum width. */
  this->num_lines = 0;
  this->max_width = 0;
  for (auto &line : this->lines) {
    line.max_width = -1;
    line.num_lines = 1;
    line.wrapped_width = 0;
  }
 
  this->ReflowContent();
}
/* virtual */ void TextfileWindow::OnInit() {…}
 
/* virtual */ void TextfileWindow::OnInvalidateData([[maybe_unused]] int data, [[maybe_unused]] bool gui_scope)
{
  if (!gui_scope) return;
 
  this->ReflowContent();
  this->SetupScrollbars();
}
/* virtual */ void TextfileWindow::OnInvalidateData([[maybe_unused]] int data, [[maybe_unused]] bool gui_scope) {…}
 
void TextfileWindow::OnDropdownSelect(WidgetID widget, int index)
{
  if (widget != WID_TF_JUMPLIST) return;
 
  this->ScrollToLine(index);
}
void TextfileWindow::OnDropdownSelect(WidgetID widget, int index) {…}
 
extern bool CanContinueRealtimeTick();
 
TextfileWindow::ReflowState TextfileWindow::ContinueReflow()
{
  if (this->reflow_iter == this->reflow_end) return ReflowState::None;
 
  int window_width = this->GetWidget<NWidgetCore>(WID_TF_BACKGROUND)->current_x - WidgetDimensions::scaled.frametext.Horizontal();
 
  bool wrapped = this->IsTextWrapped();
  bool dirty = false;
  int pos = this->vscroll->GetPosition();
 
  for (/* nothing */; this->reflow_iter != this->reflow_end; ++this->reflow_iter) {
    auto it = this->reflow_iter.Base();
    Line &line = *it;
 
    int old_lines = line.num_lines;
    if (wrapped) {
      if (line.wrapped_width != window_width) {
        line.num_lines = GetStringHeight(line.text, window_width, FS_MONO) / GetCharacterHeight(FS_MONO);
        line.wrapped_width = window_width;
      }
    } else {
      if (line.max_width == -1) {
        line.max_width = GetStringBoundingBox(line.text, FS_MONO).width;
        this->max_width = std::max(this->max_width, line.max_width);
      }
      line.num_lines = 1;
      line.wrapped_width = 0;
    }
 
    /* Adjust the total number of lines. */
    this->num_lines += (line.num_lines - old_lines);
 
    /* Maintain scroll position. */
    if (this->visible_first > it) pos += (line.num_lines - old_lines);
 
    /* Mark dirty if visible range is touched. */
    if (it >= this->visible_first && it <= this->visible_last) dirty = true;
 
    if (!CanContinueRealtimeTick()) break;
  }
 
  if (this->vscroll->SetPosition(pos)) dirty = true;
 
  return dirty ? ReflowState::VisibleReflowed : ReflowState::Reflowed;
}
 
void TextfileWindow::OnRealtimeTick(uint)
{
  auto r = this->ContinueReflow();
  if (r == ReflowState::None) return;
 
  this->SetupScrollbars();
 
  if (r == ReflowState::VisibleReflowed) {
    this->SetWidgetDirty(WID_TF_BACKGROUND);
    this->UpdateVisibleIterators();
  }
 
  /* Caption is always dirty. */
  this->SetWidgetDirty(WID_TF_CAPTION);
}
void TextfileWindow::OnRealtimeTick(uint) {…}
 
void TextfileWindow::UpdateVisibleIterators()
{
  int pos = this->vscroll->GetPosition();
  int cap = this->vscroll->GetCapacity();
  this->visible_first = this->GetIteratorFromPosition(pos);
 
  /* The last visible iterator ignores line wrapping so that it does not need to change when line heights change. */
  this->visible_last = std::ranges::next(this->visible_first, cap + 1, std::end(this->lines));
}
 
void TextfileWindow::OnScrollbarScroll(WidgetID widget)
{
  if (widget != WID_TF_VSCROLLBAR) return;
 
  this->UpdateVisibleIterators();
  this->ReflowContent();
}
void TextfileWindow::OnScrollbarScroll(WidgetID widget) {…}
 
std::vector<TextfileWindow::Line>::iterator TextfileWindow::GetIteratorFromPosition(int pos)
{
  for (auto it = std::begin(this->lines); it != std::end(this->lines); ++it) {
    pos -= it->num_lines;
    if (pos <= 0) return it;
  }
  return std::end(this->lines);
}
 
void TextfileWindow::ScrollToLine(size_t line)
{
  Scrollbar *sb = this->GetScrollbar(WID_TF_VSCROLLBAR);
  int newpos = 0;
  for (auto it = std::begin(this->lines); it != std::end(this->lines) && line > 0; --line, ++it) {
    newpos += it->num_lines;
  }
  sb->SetPosition(std::min(newpos, sb->GetCount() - sb->GetCapacity()));
  this->UpdateVisibleIterators();
  this->ReflowContent();
  this->SetDirty();
}
 
bool TextfileWindow::IsTextWrapped() const
{
  return this->IsWidgetLowered(WID_TF_WRAPTEXT);
}
 
/* virtual */ void TextfileWindow::Reset()
{
  this->search_iterator = 0;
}
/* virtual */ void TextfileWindow::Reset() {…}
 
/* virtual */ FontSize TextfileWindow::DefaultSize()
{
  return FS_MONO;
}
/* virtual */ FontSize TextfileWindow::DefaultSize() {…}
 
/* virtual */ std::optional<std::string_view> TextfileWindow::NextString()
{
  if (this->search_iterator >= this->lines.size()) return std::nullopt;
 
  return this->lines[this->search_iterator++].text;
}
/* virtual */ std::optional<std::string_view> TextfileWindow::NextString() {…}
 
/* virtual */ bool TextfileWindow::Monospace()
{
  return true;
}
/* virtual */ bool TextfileWindow::Monospace() {…}
 
/* virtual */ void TextfileWindow::SetFontNames([[maybe_unused]] FontCacheSettings *settings, [[maybe_unused]] std::string_view font_name, [[maybe_unused]] const void *os_data)
{
#if defined(WITH_FREETYPE) || defined(_WIN32) || defined(WITH_COCOA)
  settings->mono.font = font_name;
  settings->mono.os_handle = os_data;
#endif
}
/* virtual */ void TextfileWindow::SetFontNames([[maybe_unused]] FontCacheSettings *settings, [[maybe_unused]] std::string_view font_name, [[maybe_unused]] const void *os_data) {…}
 
#if defined(WITH_ZLIB)
 
static std::vector<char> Gunzip(std::span<char> input)
{
  static const int BLOCKSIZE = 8192;
  std::vector<char> output;
 
  z_stream z{};
  z.next_in = reinterpret_cast<Bytef *>(input.data());
  z.avail_in = static_cast<uInt>(input.size());
 
  /* window size = 15, add 32 to enable gzip or zlib header processing */
  int res = inflateInit2(&z, 15 + 32);
  /* Z_BUF_ERROR just means we need more space */
  while (res == Z_OK || (res == Z_BUF_ERROR && z.avail_out == 0)) {
    /* When we get here, we're either just starting, or
     * inflate is out of output space - allocate more */
    z.avail_out += BLOCKSIZE;
    output.resize(output.size() + BLOCKSIZE);
    z.next_out = reinterpret_cast<Bytef *>(output.data() + output.size() - z.avail_out);
    res = inflate(&z, Z_FINISH);
  }
 
  inflateEnd(&z);
  if (res != Z_STREAM_END) return {};
 
  output.resize(output.size() - z.avail_out);
  return output;
}
static std::vector<char> Gunzip(std::span<char> input) {…}
#endif
 
#if defined(WITH_LIBLZMA)
 
static std::vector<char> Xunzip(std::span<char> input)
{
  static const int BLOCKSIZE = 8192;
  std::vector<char> output;
 
  lzma_stream z = LZMA_STREAM_INIT;
  z.next_in = reinterpret_cast<uint8_t *>(input.data());
  z.avail_in = input.size();
 
  int res = lzma_auto_decoder(&z, UINT64_MAX, LZMA_CONCATENATED);
  /* Z_BUF_ERROR just means we need more space */
  while (res == LZMA_OK || (res == LZMA_BUF_ERROR && z.avail_out == 0)) {
    /* When we get here, we're either just starting, or
     * inflate is out of output space - allocate more */
    z.avail_out += BLOCKSIZE;
    output.resize(output.size() + BLOCKSIZE);
    z.next_out = reinterpret_cast<uint8_t *>(output.data() + output.size() - z.avail_out);
    res = lzma_code(&z, LZMA_FINISH);
  }
 
  lzma_end(&z);
  if (res != LZMA_STREAM_END) return {};
 
  output.resize(output.size() - z.avail_out);
  return output;
}
static std::vector<char> Xunzip(std::span<char> input) {…}
#endif
 
 
/* virtual */ void TextfileWindow::LoadTextfile(const std::string &textfile, Subdirectory dir)
{
  this->lines.clear();
  this->jumplist.clear();
 
  if (this->GetWidget<NWidgetStacked>(WID_TF_SEL_JUMPLIST)->SetDisplayedPlane(SZSP_HORIZONTAL)) this->ReInit();
 
  if (textfile.empty()) return;
 
  /* Get text from file */
  size_t filesize;
  auto handle = FioFOpenFile(textfile, "rb", dir, &filesize);
  if (!handle.has_value()) return;
  /* Early return on empty files. */
  if (filesize == 0) return;
 
  std::vector<char> buf;
  buf.resize(filesize);
  size_t read = fread(buf.data(), 1, buf.size(), *handle);
 
  if (read != buf.size()) return;
 
#if defined(WITH_ZLIB)
  /* In-place gunzip */
  if (textfile.ends_with(".gz")) buf = Gunzip(buf);
#endif
 
#if defined(WITH_LIBLZMA)
  /* In-place xunzip */
  if (textfile.ends_with(".xz")) buf = Xunzip(buf);
#endif
 
  if (buf.empty()) return;
 
  std::string_view sv_buf(buf.data(), buf.size());
 
  /* Check for the byte-order-mark, and skip it if needed. */
  if (sv_buf.starts_with("\ufeff")) sv_buf.remove_prefix(3);
 
  /* Update the filename. */
  this->filepath = textfile;
  this->filename = this->filepath.substr(this->filepath.find_last_of(PATHSEP) + 1);
  /* If it's the first file being loaded, add to history. */
  if (this->history.empty()) this->history.emplace_back(this->filepath, 0);
 
  /* Process the loaded text into lines, and do any further parsing needed. */
  this->LoadText(sv_buf);
}
/* virtual */ void TextfileWindow::LoadTextfile(const std::string &textfile, Subdirectory dir) {…}
 
void TextfileWindow::LoadText(std::string_view buf)
{
  std::string text = StrMakeValid(buf, {StringValidationSetting::ReplaceWithQuestionMark, StringValidationSetting::AllowNewline, StringValidationSetting::ReplaceTabCrNlWithSpace});
  this->lines.clear();
 
  /* Split the string on newlines. */
  std::string_view p(text);
  auto next = p.find_first_of('\n');
  while (next != std::string_view::npos) {
    this->lines.emplace_back(p.substr(0, next));
    p.remove_prefix(next + 1);
 
    next = p.find_first_of('\n');
  }
  this->lines.emplace_back(p);
 
  this->AfterLoadText();
  this->ReflowContent();
 
  CheckForMissingGlyphs(true, this);
 
  /* The font may have changed when searching for glyphs, so ensure widget sizes are updated just in case. */
  this->ReInit();
}
void TextfileWindow::LoadText(std::string_view buf) {…}
 
std::optional<std::string> GetTextfile(TextfileType type, Subdirectory dir, std::string_view filename)
{
  static const std::string_view prefixes[] = {
    "readme",
    "changelog",
    "license",
  };
  static_assert(lengthof(prefixes) == TFT_CONTENT_END);
 
  /* Only the generic text file types allowed for this function */
  if (type >= TFT_CONTENT_END) return std::nullopt;
 
  std::string_view prefix = prefixes[type];
 
  if (filename.empty()) return std::nullopt;
 
  auto slash = filename.find_last_of(PATHSEPCHAR);
  if (slash == std::string::npos) return std::nullopt;
 
  std::string_view base_path = filename.substr(0, slash + 1);
 
  static const std::initializer_list<const std::string_view> extensions{
    "txt",
    "md",
#if defined(WITH_ZLIB)
    "txt.gz",
    "md.gz",
#endif
#if defined(WITH_LIBLZMA)
    "txt.xz",
    "md.xz",
#endif
  };
 
  for (auto &extension : extensions) {
    std::string file_path = fmt::format("{}{}_{}.{}", base_path, prefix, GetCurrentLanguageIsoCode(), extension);
    if (FioCheckFileExists(file_path, dir)) return file_path;
 
    file_path = fmt::format("{}{}_{:.2s}.{}", base_path, prefix, GetCurrentLanguageIsoCode(), extension);
    if (FioCheckFileExists(file_path, dir)) return file_path;
 
    file_path = fmt::format("{}{}.{}", base_path, prefix, extension);
    if (FioCheckFileExists(file_path, dir)) return file_path;
  }
  return std::nullopt;
}
std::optional<std::string> GetTextfile(TextfileType type, Subdirectory dir, std::string_view filename) {…}