textbuf_type.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 TEXTBUF_TYPE_H
#define TEXTBUF_TYPE_H
 
#include "string_type.h"
#include "strings_type.h"
#include "string_base.h"
 
enum HandleKeyPressResult
{
  HKPR_EDITING,     
  HKPR_CURSOR,      
  HKPR_CONFIRM,     
  HKPR_CANCEL,      
  HKPR_NOT_HANDLED, 
};
 
struct Textbuf {
  CharSetFilter afilter;    
  char * const buf;         
  uint16_t max_bytes;         
  uint16_t max_chars;         
  uint16_t bytes;             
  uint16_t chars;             
  uint16_t pixels;            
  bool caret;               
  uint16_t caretpos;          
  uint16_t caretxoffs;        
  uint16_t markpos;           
  uint16_t markend;           
  uint16_t markxoffs;         
  uint16_t marklength;        
 
  explicit Textbuf(uint16_t max_bytes, uint16_t max_chars = UINT16_MAX);
  ~Textbuf();
 
  void Assign(StringID string);
  void Assign(const std::string_view text);
 
  void DeleteAll();
  bool InsertClipboard();
 
  bool InsertChar(char32_t key);
  bool InsertString(const char *str, bool marked, const char *caret = nullptr, const char *insert_location = nullptr, const char *replacement_end = nullptr);
 
  bool DeleteChar(uint16_t keycode);
  bool MovePos(uint16_t keycode);
 
  HandleKeyPressResult HandleKeyPress(char32_t key, uint16_t keycode);
 
  bool HandleCaret();
  void UpdateSize();
 
  void DiscardMarkedText(bool update = true);
 
  const char *GetText() const;
 
private:
  std::unique_ptr<StringIterator> char_iter;
 
  bool CanDelChar(bool backspace);
 
  void DeleteText(uint16_t from, uint16_t to, bool update);
 
  void UpdateStringIter();
  void UpdateWidth();
  void UpdateCaretPosition();
  void UpdateMarkedText();
};
 
#endif /* TEXTBUF_TYPE_H */