EvaluationQueue.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2009      Ziga Lenarcic <zigalenarcic@users.sourceforge.net>
//            (C) 2012      Doug Ilijev <doug.ilijev@gmail.com>
//            (C) 2015-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 EVALUATIONQUEUE_H
#define EVALUATIONQUEUE_H
 
#include "precomp.h"
#include "cells/GroupCell.h"
#include <wx/arrstr.h>
#include <wx/stopwatch.h>
#include <vector>
#include <utility>
 
class EvaluationQueue
{
private:
  class Command{
  public:
    Command(const wxString &strng, long start, long index)
      : m_start(start), m_indexStart(index), m_command(strng) {}
 
    const wxString &GetString() const { return m_command; }
    void AddEnding()
      {
        wxString trimmed = m_command;
        trimmed.Trim(true);
        if (!trimmed.EndsWith(wxS(";")) && !trimmed.EndsWith(wxS("$")))
          m_command += ";";
      }
    int GetIndex() const { return m_indexStart; }
    long GetStart() const { return m_start; }
  private:
    long m_start = -1;
    long m_indexStart = -1;
    wxString m_command;
  };
 
  std::vector<EvaluationQueue::Command> m_commands;
  wxString m_pendingText;
  Configuration *m_pendingConfig = nullptr;
  long m_cellConsumedChars = 0;
  std::size_t m_size;
  wxString m_userLabel;
 
  wxStopWatch m_commandStopwatch;
  bool m_commandTimerRunning = false;
 
  struct QueuedCell {
    CellPtr<GroupCell> cell;
    wxString textAtEnqueue;
  };
  std::vector<QueuedCell> m_queue;
 
  bool m_integrityFailure = false;
  wxString m_integrityFailureEnqueuedText;
  wxString m_integrityFailureCurrentText;
 
  void AddTokens();
  void ProduceNextCommand();
 
public:
  wxString GetUserLabel() const
    { return m_userLabel; }
 
  int GetIndex() const
    {
      if (!m_commands.empty())
        return  m_commands.front().GetIndex();
      else
        return -1;
    }
 
  static long CommandPositionInCell(const wxString &cellText, long start,
                                    long end, std::size_t offset,
                                    Configuration *configuration);
 
  long GetCommandStart() const
    {
      if (!m_commands.empty())
        return  m_commands.front().GetStart();
      else
        return -1;
    }
 
  bool m_workingGroupChanged = false;
 
  EvaluationQueue();
 
  void AddEnding()
    {
      if (!m_commands.empty())
        m_commands.back().AddEnding();
    }
 
  virtual ~EvaluationQueue()
    {};
 
  bool IsLastInQueue(GroupCell const *gr)
    {
      return !m_queue.empty() && (gr == m_queue.front().cell);
    }
 
  bool IsInQueue(GroupCell *gr) const;
 
  void AddToQueue(GroupCell *gr);
 
  void Remove(GroupCell *gr);
 
  void AddHiddenTreeToQueue(const GroupCell *gr);
 
  void RemoveFirst();
 
  GroupCell *GetCell();
 
  bool Empty() const;
 
  void Clear();
 
  wxString GetCommand();
 
  bool HasIntegrityFailure() const { return m_integrityFailure; }
  const wxString &GetIntegrityFailureEnqueuedText() const
    { return m_integrityFailureEnqueuedText; }
  const wxString &GetIntegrityFailureCurrentText() const
    { return m_integrityFailureCurrentText; }
 
  int Size() const { return m_size; }
 
  int CommandsLeftInCell() const;
 
  void MarkCommandSent()
    {
      m_commandStopwatch.Start();
      m_commandTimerRunning = true;
    }
 
  long GetCommandElapsedMilliseconds() const
    {
      return m_commandTimerRunning ? m_commandStopwatch.Time() : -1;
    }
};
 
 
#endif /* EVALUATIONQUEUE_H */