CellPointers.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>
//  Copyright (C) 2014-2018 Gunter Königsmann <wxMaxima@physikbuch.de>
//  Copyright (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 WXMAXIMA_CELLPOINTERS_H
#define WXMAXIMA_CELLPOINTERS_H
 
#include "cells/Cell.h"
#include <wx/string.h>
#include <vector>
 
class wxWindow;
template<class T> class wxScrolled;
typedef wxScrolled<wxWindow> wxScrolledCanvas;
 
class EditorCell;
class TextCell;
 
class CellPointers
{
public:
  void ScrollToCell(Cell *cell) { m_cellToScrollTo = cell; }
  Cell *CellToScrollTo() { return m_cellToScrollTo; }
  explicit CellPointers(wxScrolledCanvas *worksheet);
  GroupCell *GetWorkingGroup(bool resortToLast = false) const;
 
  void SetWorkingGroup(GroupCell *group);
 
  void WXMXResetCounter() { m_wxmxImgCounter = 0; }
 
  wxString WXMXGetNewFileName();
 
  std::size_t WXMXImageCount() const { return m_wxmxImgCounter; }
 
  bool HasCellsSelected() const { return m_selectionStart && m_selectionEnd; }
 
  class ErrorList
  {
  public:
    ErrorList() = default;
    bool Empty() const { return m_errors.empty(); }
    void Remove(GroupCell * cell);
    bool Contains(GroupCell * cell) const;
    void Add(GroupCell * cell);
    GroupCell *FirstError() const;
    GroupCell *LastError() const;
    void Clear() { m_errors.clear(); }
  private:
    std::vector<CellPtr<GroupCell>> m_errors;
  };
 
  ErrorList m_errorList;
  CellPtr<EditorCell> m_cellMouseSelectionStartedIn;
  CellPtr<EditorCell> m_cellKeyboardSelectionStartedIn;
  CellPtr<EditorCell> m_cellSearchStartedIn;
  int m_indexSearchStartedAt = -1;
  CellPtr<EditorCell> m_activeCell;
  CellPtr<GroupCell> m_groupCellUnderPointer;
  CellPtr<EditorCell> m_answerCell;
  CellPtr<GroupCell> m_lastWorkingGroup;
  CellPtr<TextCell> m_currentTextCell;
  CellPtr<GroupCell> m_workingGroup;
  wxString m_selectionString;
 
  void ResetSearchStart()
    {
      m_cellSearchStartedIn = {};
      m_indexSearchStartedAt = -1;
    }
 
  void ResetMouseSelectionStart()
    { m_cellMouseSelectionStartedIn = {}; }
 
  void ResetKeyboardSelectionStart()
    { m_cellKeyboardSelectionStartedIn = {}; }
 
  CellPtr<Cell> m_selectionStart;
  CellPtr<Cell> m_cellUnderPointer;
 
  CellPtr<Cell> m_selectionEnd;
 
  void SetTimerIdForCell(Cell *cell, int timerId);
  int GetTimerIdForCell(Cell *cell) const;
  Cell *GetCellForTimerId(int timerId) const;
  void RemoveTimerIdForCell(const Cell *const cell);
 
  wxScrolledCanvas *GetWorksheet() { return m_worksheet; }
 
private:
  struct CellTimerId {
    Cell *cell = NULL;
    int timerId = -1;
    CellTimerId() = default;
    CellTimerId(Cell *cell, int timerId) : cell(cell), timerId(timerId) {}
  };
  std::vector<CellTimerId> m_timerIds;
  CellPtr<Cell> m_cellToScrollTo;
  wxScrolledCanvas *const m_worksheet;
  std::size_t m_wxmxImgCounter = 0;
public:
  bool m_scrollToCell = false;
};
 
#endif