SumCell.h

Go to the documentation of this file.

// -*- 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>
//
//  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 SUMCELL_H
#define SUMCELL_H
 
#include "precomp.h"
#include "Cell.h"
#include "ParenCell.h"
 
class TextCell;
 
//cppcheck-suppress ctuOneDefinitionRuleViolation
class SumCell : public Cell
{
public:
  SumCell(GroupCell *group, Configuration *config,
          std::unique_ptr<Cell> &&under, std::unique_ptr<Cell> &&over,
          std::unique_ptr<Cell> &&base);
  SumCell(GroupCell *group, const SumCell &cell);
  std::unique_ptr<Cell> Copy(GroupCell *group) const override;
  const CellTypeInfo &GetInfo() override;
 
  size_t GetInnerCellCount() const override { return 10; }
  Cell *GetInnerCell(size_t index) const override {
    switch (index) {
    case 0:
      return m_open.get();
    case 1:
      return m_paren.get();
    case 2:
      return m_comma1.get();
    case 3:
      return m_var.get();
    case 4:
      return m_comma2.get();
    case 5:
      return m_start.get();
    case 6:
      return m_comma3.get();
    case 7:
      return m_close.get();
    case 8:
      return m_over.get();
    case 9:
      return m_under.get();
    default:
      return nullptr;
    }
  }
 
  void Recalculate(const AFontSize fontsize) const override;
 
  using Cell::SetCurrentPoint;
  void SetCurrentPoint(wxPoint point) const override;
  void Draw(wxDC *dc, wxDC *antialiassingDC) override;
 
  wxString ToMathML() const override;
  wxString ToMatlab() const override;
  wxString ToOMML() const override;
  wxString ToString() const override;
  wxString ToTeX() const override;
  wxString ToXML() const override;
 
  void SetAltCopyText(const wxString &text) override { m_altCopyText = text; }
 
  void NeedsParen(bool needsParen) {
    m_baseNeedsParen = needsParen;
    m_displayParen = needsParen;
  }
  const wxString &GetAltCopyText() const override { return m_altCopyText; }
 
  bool BreakUp() const override;
 
  size_t GetBrokenCellCount() const override {
    return m_over->ToString().IsEmpty() ? 7 : 9;
  }
  Cell *GetBrokenCell(size_t index) const override {
    const bool hasOver = !m_over->ToString().IsEmpty();
    switch (index) {
    case 0:
      return m_open.get();
    case 1:
      return Base();
    case 2:
      return m_comma1.get();
    case 3:
      return m_var.get();
    case 4:
      return m_comma2.get();
    case 5:
      return m_start.get();
    case 6:
      return hasOver ? m_comma3.get() : m_close.get();
    case 7:
      return hasOver ? m_over.get() : nullptr;
    case 8:
      return hasOver ? m_close.get() : nullptr;
    default:
      return nullptr;
    }
  }
 
  void Unbreak() const override final;
 
protected:
  void RefreshBreakUpCommandName() const;
  virtual const wxString GetMaximaCommandName() const;
  virtual const wxString GetMatlabCommandName() const;
  virtual const wxString GetLaTeXCommandName() const;
  virtual const wxString GetUnicodeSymbol() const;
  virtual const wxString GetSvgSymbolData() const;
  virtual const wxString GetXMLType() const;
  virtual const wxSize GetSymbolSize() const;
  Cell *Base() const;
  Cell *Over() const {return m_over.get();}
  Cell *Under() const {return m_under.get();}
 
private:
  std::unique_ptr<Cell> MakeStart(Cell *under) const;
  void MakeBreakUpCells();
  const static wxString m_svgSumSign;
 
  ParenCell *Paren() const;
  Cell *DisplayedBase() const;
 
  wxString m_altCopyText;
  // The pointers below point to inner cells and must be kept contiguous.
  // ** This is the partial draw list order. All pointers must be the same:
  // ** either Cell * or std::unique_ptr<Cell>. NO OTHER TYPES are allowed.
  std::unique_ptr<Cell> m_open;
  std::unique_ptr<Cell> m_paren;
  std::unique_ptr<Cell> m_comma1;
  std::unique_ptr<Cell> m_var;
  std::unique_ptr<Cell> m_comma2;
  std::unique_ptr<Cell> m_start;
  std::unique_ptr<Cell> m_comma3;
  std::unique_ptr<Cell> m_close;
  std::unique_ptr<Cell> m_over;
  std::unique_ptr<Cell> m_under;
  // The pointers above point to inner cells and must be kept contiguous.
 
  mutable wxSize m_signSize;
 
//** Bitfield objects (1 bytes)
//**
  mutable bool m_displayParen : 1 = true;
  bool m_baseNeedsParen : 1 = true;
};
 
#endif // SUMCELL_H