string.hpp

Go to the documentation of this file.

#ifndef FTXUI_SCREEN_STRING_HPP
#define FTXUI_SCREEN_STRING_HPP
 
#include <stddef.h>  // for size_t
#include <string>    // for string, wstring, to_string
#include <vector>    // for vector
 
namespace ftxui {
std::string to_string(const std::wstring& s);
std::wstring to_wstring(const std::string& s);
 
template <typename T>
std::wstring to_wstring(T s) {
  return to_wstring(std::to_string(s));
}
 
int string_width(const std::string&);
// Split the string into a its glyphs. An empty one is inserted ater fullwidth
// ones.
std::vector<std::string> Utf8ToGlyphs(const std::string& input);
// If |input| was an array of glyphs, this returns the number of char to eat
// before reaching the glyph at index |glyph_index|.
int GlyphPosition(const std::string& input,
                  size_t glyph_index,
                  size_t start = 0);
// Returns the number of glyphs in |input|.
int GlyphCount(const std::string& input);
 
// Properties from:
// https://www.unicode.org/Public/UCD/latest/ucd/auxiliary/WordBreakProperty.txt
enum class WordBreakProperty {
  ALetter,
  CR,
  Double_Quote,
  Extend,
  ExtendNumLet,
  Format,
  Hebrew_Letter,
  Katakana,
  LF,
  MidLetter,
  MidNum,
  MidNumLet,
  Newline,
  Numeric,
  Regional_Indicator,
  Single_Quote,
  WSegSpace,
  ZWJ,
};
std::vector<WordBreakProperty> Utf8ToWordBreakProperty(
    const std::string& input);
 
bool IsWordBreakingCharacter(const std::string& input, size_t glyph_index);
 
// Map every cells drawn by |input| to their corresponding Glyphs. Half-size
// Glyphs takes one cell, full-size Glyphs take two cells.
std::vector<int> CellToGlyphIndex(const std::string& input);
 
}  // namespace ftxui
 
#include "ftxui/screen/deprecated.hpp"
 
#endif /* end of include guard: FTXUI_SCREEN_STRING_HPP */
 
// Copyright 2020 Arthur Sonzogni. All rights reserved.
// Use of this source code is governed by the MIT license that can be found in
// the LICENSE file.