TextCell.h

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2004-2015 Andrej Vodopivec <andrej.vodopivec@gmail.com>
//            (C) 2014-2018 Gunter Königsmann <wxMaxima@physikbuch.de>
//            (C) 2020      Kuba Ober <kuba@bertec.com>
//
//  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 TEXTCELL_H
#define TEXTCELL_H
 
#include <wx/regex.h>
#include "Cell.h"
#include "UrlDetection.h"
#include <vector>
 
// 304 bytes <- 744 bytes
// cppcheck-suppress ctuOneDefinitionRuleViolation
class TextCell : public Cell
{
public:
  TextCell(GroupCell *group, Configuration *config, const wxString &text = {}, TextStyle style = TS_FUNCTION);
  TextCell(GroupCell *group, const TextCell &cell);
  ~TextCell() override = default;
  const CellTypeInfo &GetInfo() override;
  std::unique_ptr<Cell> Copy(GroupCell *group) const override;
 
  AFontSize GetScaledTextSize() const;
 
  void SetStyle(TextStyle style) override;
 
  void SetValue(const wxString &text) override;
 
  void Recalculate(const AFontSize fontsize) const override;
 
  using Cell::SetCurrentPoint;
  void SetCurrentPoint(wxPoint point) const override;
  void Draw(wxDC *dc, wxDC *antialiassingDC) override;
  const wxFont &GetFont(AFontSize fontsize) const {
    return m_configuration->GetStyle(GetTextStyle())->GetFont(fontsize);
  }
  //cppcheck-suppress functionConst
  void SetFont(wxDC *dc, AFontSize fontsize) const;
 
  wxCoord GetWidthAtLineBreak() const override;
 
  void DontEscapeOpeningParenthesis() { m_dontEscapeOpeningParenthesis = true; }
 
  wxString ToMatlab() const override;
  wxString ToMathML() const override;
  wxString ToOMML() const override;
  wxString ToRTF() const override;
  wxString ToString() const override;
  const wxString GetDisplayedString() const override {return m_displayedText;}
  wxString ToTeX() const override;
  wxString ToXML() const override;
 
  bool IsOperator() const override;
 
  const wxString &GetValue() const override { return m_text; }
 
  wxString GetGreekStringTeX() const;
 
  wxString GetSymbolTeX() const;
 
  wxString GetGreekStringUnicode() const;
 
  wxString GetSymbolUnicode(bool keepPercent) const;
 
  bool IsShortNum() const override;
 
  void SetType(CellType type) override;
 
  void SetAltCopyText(const wxString &text) override {m_altCopyText = text;}
 
  void SetPromptTooltip(bool use) { m_promptTooltip = use; }
 
  void SetTextContinuation(bool continuation);
  bool IsTextContinuation() const override { return m_textContinuation; }
 
  wxString GetLinkAt(wxPoint point) override;
 
  bool AllowsCharacterSelection() const;
  std::size_t DisplayedLength() const { return m_displayedText.Length(); }
  std::size_t CharacterIndexAt(wxCoord x) const;
  wxCoord CharacterX(std::size_t index) const;
  wxRect CharacterRect(std::size_t from, std::size_t to) const;
  wxString CharactersToString(std::size_t from, std::size_t to) const;
 
protected:
  mutable wxString m_altCopyText;
  wxString GetXMLFlags() const override;
  virtual void UpdateDisplayedText() const;
  std::vector<wxm::UrlSpan> LinkSpans() const;
 
  void UpdateDigitGroupGaps() const;
  wxCoord DigitGroupGapWidth() const;
  wxCoord DrawGroupedDigits(wxDC *dc, const wxString &text, wxCoord x,
                            wxCoord y, bool draw) const;
  mutable std::vector<size_t> m_digitGroupGaps;
  template <typename RunFunc> void WalkTextRuns(wxDC *dc, wxCoord x, RunFunc &&func) const;
  void UpdateToolTip();
  const wxString &GetAltCopyText() const override { return m_altCopyText; }
 
  void FontsChanged() const override
    {
      m_sizeCache.clear();
    }
 
  enum TextIndex : int8_t
  {
    noText,
    cellText,
    userLabelText,
    numberStart,
    ellipsis,
    numberEnd
  };
 
  struct SizeEntry {
    wxSize textSize;
    AFontSize fontSize;
    TextIndex index = cellText;
    SizeEntry(wxSize textSize, AFontSize fontSize, TextIndex index) :
      textSize(textSize), fontSize(fontSize), index(index) {}
    SizeEntry() = default;
  };
 
  wxSize CalculateTextSize(wxDC *dc, const wxString &text, TextCell::TextIndex const index) const;
 
  static wxRegEx m_unescapeRegEx;
  static wxRegEx m_roundingErrorRegEx1;
  static wxRegEx m_roundingErrorRegEx2;
  static wxRegEx m_roundingErrorRegEx3;
  static wxRegEx m_roundingErrorRegEx4;
 
//** Large objects (120 bytes)
//**
  wxString m_text;
  mutable wxString m_displayedText;
  mutable std::vector<SizeEntry> m_sizeCache;
  mutable wxCoord m_widthAtLineBreak = 0;
 
//** Bitfield objects (1 bytes)
//**
  bool m_dontEscapeOpeningParenthesis : 1 = false;
  bool m_promptTooltip : 1 = false;
  mutable bool m_hasLinks : 1 = false;
  bool m_textContinuation : 1 = false;
 
  wxCoord LeftPadding() const;
  wxCoord RightPadding() const;
};
 
#endif // TEXTCELL_H