EditorCell.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2006-2015 Andrej Vodopivec <andrej.vodopivec@gmail.com>
//            (C) 2012 Doug Ilijev <doug.ilijev@gmail.com>
//            (C) 2014-2015 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 EDITORCELL_H
#define EDITORCELL_H
 
#include "Cell.h"
#include "FontAttribs.h"
#include "MaximaTokenizer.h"
#include <vector>
#include <list>
 
class EditorCell final : public Cell
{
private:
  #if wxUSE_ACCESSIBILITY
  wxAccStatus GetDescription(int childId, wxString *description) const override;
  wxAccStatus GetFocus (int *childId, Cell **child) const override;
  wxAccStatus GetDefaultAction(int childId, wxString *actionName) const override;
  wxAccStatus GetValue (int childId, wxString *strValue) const override;
  wxAccStatus GetRole (int childId, wxAccRole *role) const override;
  #endif
 
public:
  EditorCell(GroupCell *group, Configuration **config, const wxString &text = {});
  EditorCell(GroupCell *group, const EditorCell &cell);
//  std::unique_ptr<Cell> Copy(GroupCell *group) const override;
  const CellTypeInfo &GetInfo() override;
  std::unique_ptr<Cell> Copy(GroupCell *group) const override;
 
  EditorCell *GetPrevious() const { return dynamic_cast<EditorCell*>(Cell::GetPrevious()); }
  EditorCell *GetNext() const { return dynamic_cast<EditorCell*>(Cell::GetNext()); }
 
  void InsertEscCommand(const wxString &txt) {
    InsertText(InterpretEscapeString(txt));
  }
 
  wxString GetFullCommandUnderCursor();
 
  void AddDrawParameter(wxString param);
 
  void AutoAnswer(bool autoAnswer){m_autoAnswer = autoAnswer;}
 
  void SearchStartedHere(int index) const;
  void SearchStartedHere() const;
  void MouseSelectionStartedHere() const;
  void KeyboardSelectionStartedHere() const;
 
  const auto &GetWordList() const { return m_wordList; }
 
  static wxString TabExpand(const wxString &input, long posInLine);
 
  static wxString EscapeHTMLChars(wxString input);
 
  static wxString PrependNBSP(wxString input);
 
  void Recalculate(AFontSize fontsize) override;
 
  virtual void Draw(wxPoint point) override;
 
  wxString ToHTML() const;
  wxString ToMatlab() const override;
  wxString ToMatlab(bool dontLimitToSelection) const;
  wxString ToRTF() const override;
  wxString ToString() const override;
  wxString ToString(bool dontLimitToSelection) const;
  wxString ToTeX() const override;
  wxString ToXML() const override;
 
  void SetFont();
 
  void SetForeground();
 
  void SetValue(const wxString &text) override;
 
  const wxString &GetValue() const override { return m_text; }
 
  void StyleText();
  void StyleTextCode();
  void StyleTextTexts();
 
  void Reset();
 
  void ProcessEvent(wxKeyEvent &event) override;
 
  void ActivateCursor();
 
  void DeactivateCursor();
 
  size_t BeginningOfLine(long pos) const;
 
  size_t EndOfLine(long pos);
 
  bool AddEnding() override;
 
  void PositionToXY(int position, unsigned int *x, unsigned int *y);
 
  int XYToPosition(int x, int y);
 
  wxPoint PositionToPoint(int pos = -1) override;
 
  void SelectPointText(wxPoint point) override;
 
  void SelectRectText(wxPoint one, wxPoint two) override;
 
  wxString SelectWordUnderCaret(bool selectParens = true, bool toRight = true,
                                bool includeDoubleQuotes = false);
 
  bool IsPointInSelection(wxPoint point);
 
  bool CopyToClipboard() const override;
 
  bool CutToClipboard() override;
 
  void PasteFromClipboard(bool primary = false) override;
 
  int GetSelectionStart() const
  { return m_selectionStart; }
 
  int GetSelectionEnd() const
  { return m_selectionEnd; }
 
  void SelectAll() override
  {
    m_selectionStart = 0;
    m_selectionEnd = m_positionOfCaret = m_text.Length();
  }
 
  bool AllSelected() const
  {
    return (m_selectionStart == 0) && (m_selectionEnd == (long) m_text.Length());
  }
 
  void SelectNone()
  {
    m_selectionStart = m_selectionEnd = 0;
  }
 
  bool SelectionActive() const
  {
    return (m_selectionStart >= 0) && (m_selectionEnd >= 0);
  }
 
  bool CanCopy() const override
  {
    return m_selectionStart != -1;
  }
 
  bool FindMatchingQuotes();
 
  void FindMatchingParens();
 
  int GetLineWidth(unsigned int line, int pos);
 
  bool IsDirty() const override
  {
    return m_isDirty;
  }
 
  void SwitchCaretDisplay() override
  {
    m_displayCaret = !m_displayCaret;
  }
 
  void SetFocus(bool focus) override
  {
    m_hasFocus = focus;
  }
 
  void SetFirstLineOnly(bool show = true)
  {
    if (m_firstLineOnly != show)
    {
      m_width = m_height = -1;
      m_firstLineOnly = show;
    }
    // Style the text anew.
    StyleText();
  }
 
  bool IsActive() const override;
 
  bool CaretAtStart() const
  { return m_positionOfCaret == 0; }
 
  void CaretToStart();
 
  bool CaretAtEnd() const
  { return m_positionOfCaret == (long) m_text.Length(); }
 
  void CaretToEnd();
 
  void CaretToPosition(int pos);
 
  bool CanUndo() const;
 
  void Undo();
 
  bool CanRedo() const;
 
  void Redo();
 
  void SaveValue();
 
  wxString DivideAtCaret();
 
  void CommentSelection();
 
  void ClearUndo();
 
  bool ContainsChanges() const
  { return m_containsChanges; }
 
  void ContainsChanges(bool changes)
  { m_containsChanges = m_containsChangesCheck = changes; }
 
  bool CheckChanges();
 
  int ReplaceAll(wxString oldString, const wxString &newString, bool ignoreCase);
 
  bool FindNext(wxString str, const bool &down, const bool &ignoreCase);
 
  bool IsSelectionChanged() const { return m_selectionChanged; }
 
  void SetSelection(int start, int end);
 
  void GetSelection(int *start, int *end) const
  {
    *start = m_selectionStart;
    *end = m_selectionEnd;
  }
 
  bool ReplaceSelection(const wxString &oldStr, const wxString &newString,
                        bool keepSelected = false, bool ignoreCase = false,
                        bool replaceMaximaString = false);
 
  wxString GetSelectionString() const;
 
  wxString GetWordUnderCaret();
 
  wxString GetCurrentCommand();
  
  void ClearSelection();
 
  void SetErrorIndex(int index){m_errorIndex = index;}
 
  bool ErrorIndexSet() const {return m_errorIndex >= 0;}
 
  void GotoError(){SetCaretPosition(m_errorIndex);ActivateCursor();}
 
  void ProcessNewline(bool keepCursorAtStartOfLine = true);
 
  int GetCaretPosition() const
  { return m_positionOfCaret; }
 
  void ConvertNumToUNicodeChar();
 
  void SetCaretPosition(int pos)
    { m_positionOfCaret = pos;
      if(m_positionOfCaret < -1)
        m_positionOfCaret = -1;
      if(m_positionOfCaret > (signed long)m_text.Length())
        m_positionOfCaret = m_text.Length();
    }
 
  bool FindNextTemplate(bool left = false);
 
  void InsertText(wxString text);
 
  wxString TextInFrontOfSelection() const
  {
    return GetValue().Mid(1, m_selectionStart);
  }
 
  void ReturnToSelectionFromTop()
  {
    SetSelection(m_lastSelectionStart, 0);
  }
 
  void SetType(CellType type) override;
  void SetStyle(TextStyle style) override;
 
  bool NeedsRecalculation(AFontSize fontSize) const override;
 
  void ReturnToSelectionFromBot()
  {
    SetSelection(m_lastSelectionStart, m_text.Length());
  }
 
  const MaximaTokenizer::TokenList &GetTokens() const {return m_tokens;}
 
private:
  bool IsZoomFactorChanged() const;
  double m_lastZoomFactor = -1;
  class StyledText
  {
  private:
    wxString m_text;
    wxString m_indentChar;
    int m_width = -1;
    int m_indentPixels = 0;
    TextStyle m_style = TS_DEFAULT;
    bool m_styleThisText = false;
  public:
    StyledText(TextStyle style, const wxString &text)
        : m_text(text), m_style(style), m_styleThisText(true) {}
 
    explicit StyledText(const wxString &text, int indentPixels = 0,
                        const wxString &indentChar = {})
        : m_text(text), m_indentChar(indentChar), m_indentPixels(indentPixels)  {}
 
    void SetWidth(int width){m_width = width;}
    void ResetSize(){SetWidth(-1);}
    int GetWidth() const {return m_width;}
    bool SizeKnown() const {return GetWidth() >= 0;}
    const wxString &GetText() const { return m_text; }
    void SetText(const wxString &text) { m_text = text; }
    void SetIndentation(int indentPixels, const wxString &indentString = {})
    {
      m_indentPixels = indentPixels;
      m_indentChar = indentString;
    }
    int GetIndentPixels() const { return m_indentPixels; }
    const wxString &GetIndentChar() const { return m_indentChar; }
    TextStyle GetStyle() const { return m_style; }
    // Has an individual text style been set for this text portion?
    bool IsStyleSet() const { return m_styleThisText; }
  };
 
#if defined __WXOSX__
  bool HandleCtrlCommand(wxKeyEvent &ev);
#endif
  bool HandleSpecialKey(wxKeyEvent &event);
  bool HandleOrdinaryKey(wxKeyEvent &event);
 
  void FontsChanged() override
  {
    ResetSize();
    ResetData();
    m_widths.clear();
  }
 
  void HandleSoftLineBreaks_Code(StyledText *&lastSpace, int &lineWidth, const wxString &token, unsigned int charInCell,
                                 wxString &text, const size_t &lastSpacePos, int &indentationPixels);
 
  int GetIndentDepth(wxString text, int positionOfCaret);
 
  wxString InterpretEscapeString(const wxString &txt) const;
 
  void MarkSelection(long start, long end, TextStyle style);
 
  wxSize GetTextSize(const wxString &text);
 
  struct HistoryEntry // 64 bytes
  {
    wxString text;
    int caretPosition = -1;
    int selStart = -1;
    int selEnd = -1;
    HistoryEntry() = default;
    HistoryEntry(const wxString &text, int caretPosition, int selStart, int selEnd) :
      text(text), caretPosition(caretPosition), selStart(selStart), selEnd(selEnd) {}
  };
  void SetState(const HistoryEntry &state);
  void AppendStateToHistory();
 
//** Large fields
//**
  WX_DECLARE_STRING_HASH_MAP(wxSize, StringHash);
  StringHash m_widths;
 
  std::vector<wxString> m_wordList;
 
  MaximaTokenizer::TokenList m_tokens;
 
  wxString m_text;
  std::vector<StyledText> m_styledText;
 
  std::vector<HistoryEntry> m_history;
 
//** 8/4 bytes
//**
  AFontName m_fontName;
  CellPointers *const m_cellPointers = GetCellPointers();
 
//** 4 bytes
//**
  int m_errorIndex = 1;
  unsigned int m_numberOfLines = 1;
  int m_historyPosition = -1;
 
  long m_selectionStart = -1;
  long m_selectionEnd = -1;
  long m_oldSelectionStart = -1;
  long m_oldSelectionEnd = -1;
  long m_lastSelectionStart = -1;
 
  int m_charHeight = 12;
  int m_paren1 = -1, m_paren2 = -1;
 
  int m_positionOfCaret = 0;
  int m_caretColumn = -1;
 
//** 2 bytes
//**
  AFontStyle m_fontStyle;
  AFontWeight m_fontWeight;
 
//** Bitfield objects (2 bytes)
//**
  void InitBitFields()
  { // Keep the initialization order below same as the order
    // of bit fields in this class!
    m_autoAnswer = false;
    m_containsChanges = false;
    m_containsChangesCheck = false;
    m_displayCaret = false;
    m_firstLineOnly = false;
    m_hasFocus = false;
    m_isDirty = false;
    m_saveValue = false;
    m_selectionChanged = false;
    m_underlined = false;
  }
 
  bool m_autoAnswer : 1 /* InitBitFields */;
  bool m_containsChanges : 1 /* InitBitFields */;
  bool m_containsChangesCheck : 1 /* InitBitFields */;
  bool m_displayCaret : 1 /* InitBitFields */;
  bool m_firstLineOnly : 1 /* InitBitFields */;
  bool m_hasFocus : 1 /* InitBitFields */;
  bool m_isDirty : 1 /* InitBitFields */;
  bool m_saveValue :1 /* InitBitFields */;
  bool m_selectionChanged : 1 /* InitBitFields */;
  bool m_underlined : 1 /* InitBitFields */;
};
 
#endif // EDITORCELL_H