textfile_gui.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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef TEXTFILE_GUI_H
#define TEXTFILE_GUI_H
 
#include "fileio_type.h"
#include "strings_func.h"
#include "textfile_type.h"
#include "window_gui.h"
 
std::optional<std::string> GetTextfile(TextfileType type, Subdirectory dir, const std::string &filename);
 
struct TextfileWindow : public Window, MissingGlyphSearcher {
  TextfileType file_type;          
  Scrollbar *vscroll;              
  Scrollbar *hscroll;              
 
  void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override;
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override;
  void DrawWidget(const Rect &r, WidgetID widget) const override;
  void OnResize() override;
  void OnInvalidateData(int data = 0, bool gui_scope = true) override;
  void OnDropdownSelect(WidgetID widget, int index) override;
 
  void Reset() override;
  FontSize DefaultSize() override;
  std::optional<std::string_view> NextString() override;
  bool Monospace() override;
  void SetFontNames(FontCacheSettings *settings, const char *font_name, const void *os_data) override;
  void ScrollToLine(size_t line);
 
  virtual void LoadTextfile(const std::string &textfile, Subdirectory dir);
 
protected:
  TextfileWindow(TextfileType file_type);
  void ConstructWindow();
 
  struct Line {
    int top = 0;                  
    int bottom = 0;               
    std::string text{};           
    TextColour colour = TC_WHITE; 
 
    Line(int top, std::string_view text) : top(top), bottom(top + 1), text(text) {}
    Line() {}
  };
 
  struct Hyperlink {
    size_t line;             
    size_t begin;            
    size_t end;              
    std::string destination; 
  };
 
  struct HistoryEntry {
    std::string filepath;    
    int scrollpos;           
  };
 
  std::string filename{};              
  std::string filepath{};              
 
  std::vector<Line> lines;             
  std::vector<size_t> jumplist;        
  std::vector<Hyperlink> links;        
  std::vector<Hyperlink> link_anchors; 
  std::vector<HistoryEntry> history;   
  size_t history_pos = 0;              
  bool trusted = false;                
 
  void LoadText(std::string_view buf);
  void FindHyperlinksInMarkdown(Line &line, size_t line_index);
 
  virtual void OnHyperlinkClick(const Hyperlink &link);
 
  virtual void AfterLoadText();
 
  void NavigateToFile(std::string newfile, size_t line);
  void AppendHistory(const std::string &filepath);
  void UpdateHistoryScrollpos();
  void NavigateHistory(int delta);
 
private:
  uint search_iterator = 0;     
  uint max_length = 0;          
 
  uint ReflowContent();
  uint GetContentHeight();
  void SetupScrollbars(bool force_reflow);
  void CheckHyperlinkClick(Point pt);
 
  void AfterLoadMarkdown();
};
 
#endif /* TEXTFILE_GUI_H */