wxMaxima
Loading...
Searching...
No Matches
EvaluationQueue.h
Go to the documentation of this file.
1// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
2//
3// Copyright (C) 2009 Ziga Lenarcic <zigalenarcic@users.sourceforge.net>
4// (C) 2012 Doug Ilijev <doug.ilijev@gmail.com>
5// (C) 2015-2018 Gunter Königsmann <wxMaxima@physikbuch.de>
6//
7// This program is free software; you can redistribute it and/or modify
8// it under the terms of the GNU General Public License as published by
9// the Free Software Foundation; either version 2 of the License, or
10// (at your option) any later version.
11//
12// This program is distributed in the hope that it will be useful,
13// but WITHOUT ANY WARRANTY; without even the implied warranty of
14// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15// GNU General Public License for more details.
16//
17//
18// You should have received a copy of the GNU General Public License
19// along with this program; if not, write to the Free Software
20// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21//
22// SPDX-License-Identifier: GPL-2.0+
23
32#ifndef EVALUATIONQUEUE_H
33#define EVALUATIONQUEUE_H
34
35#include "precomp.h"
36#include "cells/GroupCell.h"
37#include <wx/arrstr.h>
38#include <vector>
39#include <utility>
40
43{
44private:
45 class Command{
46 public:
47 Command(const wxString &strng, int index) : m_indexStart(index), m_command(strng) {}
48 Command(Command &&o) noexcept : m_indexStart(o.m_indexStart), m_command(std::move(o.m_command)) {}
49 Command(const Command &o) : m_indexStart(o.m_indexStart), m_command(o.m_command) {}
50 Command &operator=(Command &&o) noexcept
51 {
52 m_indexStart = o.m_indexStart;
53 m_command = std::move(o.m_command);
54 return *this;
55 }
56 Command &operator=(const Command &o)
57 {
58 m_indexStart = o.m_indexStart;
59 m_command = o.m_command;
60 return *this;
61 }
62
63 const wxString &GetString() const { return m_command; }
64 void AddEnding() { m_command += ";"; }
65 int GetIndex() const { return m_indexStart; }
66 private:
67 long m_indexStart = -1;
68 wxString m_command;
69 };
70
78 std::vector<EvaluationQueue::Command> m_commands;
79 std::size_t m_size;
81 wxString m_userLabel;
83 std::vector<CellPtr<GroupCell>> m_queue;
84
86 void AddTokens(const GroupCell *cell);
87
88public:
95 wxString GetUserLabel() const
96 { return m_userLabel; }
97
98 int GetIndex() const
99 {
100 if (!m_commands.empty())
101 return m_commands.front().GetIndex();
102 else
103 return -1;
104 }
105
106 bool m_workingGroupChanged = false;
107
109
110 void AddEnding()
111 {
112 if (!m_commands.empty())
113 m_commands.back().AddEnding();
114 }
115
116 virtual ~EvaluationQueue()
117 {};
118
120 bool IsLastInQueue(GroupCell const *gr)
121 {
122 return !m_queue.empty() && (gr == m_queue.front());
123 }
124
126 bool IsInQueue(GroupCell *gr) const;
127
129 void AddToQueue(GroupCell *gr);
130
132 void Remove(GroupCell *gr);
133
135 void AddHiddenTreeToQueue(const GroupCell *gr);
136
138 void RemoveFirst();
139
145
147 bool Empty() const;
148
150 void Clear();
151
153 wxString GetCommand();
154
156 int Size() const { return m_size; }
157
159 int CommandsLeftInCell() const { return m_commands.size(); }
160};
161
162
163#endif /* EVALUATIONQUEUE_H */
This file defines the class GroupCell that bundles input and output in the worksheet.
A simple FIFO queue with manual removal of elements.
Definition: EvaluationQueue.h:43
void Remove(GroupCell *gr)
Remove a GroupCell from the evaluation queue.
Definition: EvaluationQueue.cpp:54
wxString GetUserLabel() const
Query for the label the user has assigned to the current command.
Definition: EvaluationQueue.h:95
bool IsLastInQueue(GroupCell const *gr)
Is GroupCell gr part of the evaluation queue?
Definition: EvaluationQueue.h:120
bool IsInQueue(GroupCell *gr) const
Is GroupCell gr part of the evaluation queue?
Definition: EvaluationQueue.cpp:50
void Clear()
Clear the queue.
Definition: EvaluationQueue.cpp:43
bool Empty() const
Is the queue empty?
Definition: EvaluationQueue.cpp:34
void AddHiddenTreeToQueue(const GroupCell *gr)
Adds all hidden cells attached to the GroupCell gr to the evaluation queue.
Definition: EvaluationQueue.cpp:87
void AddToQueue(GroupCell *gr)
Adds a GroupCell to the evaluation queue.
Definition: EvaluationQueue.cpp:67
wxString GetCommand()
Return the next command that needs to be evaluated.
Definition: EvaluationQueue.cpp:158
void RemoveFirst()
Removes the first command in the queue.
Definition: EvaluationQueue.cpp:97
GroupCell * GetCell()
Gets the cell the next command in the queue belongs to.
Definition: EvaluationQueue.cpp:151
int CommandsLeftInCell() const
Get the size of the queue.
Definition: EvaluationQueue.h:159
int Size() const
Get the size of the queue [in cells].
Definition: EvaluationQueue.h:156
A cell grouping input (and, if there is one, also the output) cell to a foldable item.
Definition: GroupCell.h:74