TextFormat.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2026 Gunter Königsmann <wxMaxima@physikbuch.de>
//
//  This program 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; either version 2 of the License, or
//  (at your option) any later version.
//
//  This program 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 this program; if not, write to the Free Software
//  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
//  SPDX-License-Identifier: GPL-2.0+
 
#ifndef TEXTFORMAT_H
#define TEXTFORMAT_H
 
#include <cstdint>
#include <cstddef>
#include <vector>
#include <wx/string.h>
 
class wxXmlNode;
 
namespace TextFormat {
 
using Format = std::uint8_t;
 
enum : Format {
  None = 0,
  Bold = 1,
  Italic = 2,
  Underline = 4,
  Strikethrough = 8,
  Superscript = 16,
  Subscript = 32
};
 
constexpr Format WidthAffecting = Bold | Italic | Superscript | Subscript;
 
constexpr std::size_t FontVariants = 16;
 
constexpr std::size_t FontIndex(Format format) {
  return static_cast<std::size_t>((format & (Bold | Italic)) |
                                  ((format & (Superscript | Subscript)) >> 2));
}
 
constexpr Format VerticalPosition = Superscript | Subscript;
 
constexpr Format WithFlag(Format format, Format flag) {
  if (flag & VerticalPosition)
    format &= static_cast<Format>(~VerticalPosition);
  return static_cast<Format>(format | flag);
}
 
using Formats = std::vector<Format>;
 
bool IsPlain(const Formats &formats);
 
inline Format At(const Formats &formats, std::size_t pos) {
  return (pos < formats.size()) ? formats[pos] : Format(None);
}
 
Format FormatForInsertionAt(const wxString &text, const Formats &formats,
                            std::size_t pos);
 
Formats Reconcile(const wxString &oldText, const Formats &oldFormats,
                  const wxString &newText, bool hasPending = false,
                  std::size_t pendingPos = 0, Format pendingFormat = None);
 
struct Run {
  std::size_t start;
  std::size_t end;
  Format format;
};
 
std::vector<Run> Runs(const wxString &text, const Formats &formats,
                      std::size_t start, std::size_t end);
 
wxString LineAttributes(const wxString &text, const Formats &formats,
                        std::size_t lineStart, std::size_t lineEnd);
 
void ReadLine(const wxXmlNode *line, wxString &text, Formats &formats,
              wxString *unknownAttributes = nullptr);
 
void ReadHTML(const wxString &html, wxString &text, Formats &formats);
 
std::vector<std::pair<std::size_t, std::size_t>> ParseRanges(const wxString &ranges);
 
std::size_t CodePointsBefore(const wxString &text, std::size_t start, std::size_t index);
 
std::size_t IndexOfCodePoint(const wxString &text, std::size_t start,
                             std::size_t codePoints);
} // namespace TextFormat
 
#endif // TEXTFORMAT_H