Skip to content

Commit bd2c59f

Browse files
adazem009adazem009
committed
Move RunningScript functions to header file
1 parent b4e05b1 commit bd2c59f

File tree

5 files changed

+127
-149
lines changed

5 files changed

+127
-149
lines changed

‎src/blocks/controlblocks.cpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// SPDX-License-Identifier: Apache-2.0
22

33
#include "controlblocks.h"
4+
#include "../scratch/runningscript.h"
45

56
namespace libscratchcpp
67
{

‎src/engine/engine.cpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
#include "engine.h"
44
#include "../blocks/standardblocks.h"
55
#include "../scratchconfiguration.h"
6+
#include "../scratch/runningscript.h"
67
#include "iblocksection.h"
78
#include <cassert>
89
#include <iostream>

‎src/engine/engine.h‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
#include "../libscratchcpp_global.h"
66
#include "../scratch/broadcast.h"
7-
#include "../scratch/runningscript.h"
87
#include "../scratch/target.h"
98
#include "global.h"
109
#include <map>

‎src/scratch/runningscript.cpp‎

Lines changed: 0 additions & 138 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
// SPDX-License-Identifier: Apache-2.0
22

33
#include "runningscript.h"
4-
#include "../engine/engine.h"
54
#include <cassert>
6-
#include <iostream>
75

86
using namespace libscratchcpp;
97

@@ -27,139 +25,3 @@ RunningScript::RunningScript(std::shared_ptr<Block> block, std::shared_ptr<Targe
2725
assert(false);
2826
}
2927
}
30-
31-
/*! Returns the current block. */
32-
std::shared_ptr<Block> RunningScript::currentBlock() const
33-
{
34-
return m_currentBlock;
35-
}
36-
37-
/*!
38-
* Continues to the next block, cMouth() or to the first block of a C mouth.
39-
* \note Use moveToSubstack() to move to the substack of e. g. a loop, or
40-
* skipSubstack(), if it doesn't have one.
41-
*/
42-
void RunningScript::moveToNextBlock()
43-
{
44-
if (m_currentBlock) {
45-
if (!m_currentBlock->next() && !m_tree.empty()) {
46-
bool ret = substackEnd();
47-
if (!ret)
48-
return;
49-
moveToNextBlock();
50-
return;
51-
}
52-
m_currentBlock = m_currentBlock->next();
53-
}
54-
}
55-
56-
/*! Returns the C mouth block or nullptr if the block isn't in a C mouth. */
57-
std::shared_ptr<Block> RunningScript::cMouth()
58-
{
59-
if (m_tree.empty())
60-
return nullptr;
61-
return m_tree[m_tree.size() - 1].first;
62-
}
63-
64-
/*!
65-
* Moves to a substack, e. g. in a loop.
66-
* \note Please use the overloaded function with the list of inputs
67-
* and the index of the substack input because it'll automatically
68-
* check if there's a substack defined.
69-
*/
70-
void RunningScript::moveToSubstack(std::shared_ptr<Block> substackBlock)
71-
{
72-
if (!substackBlock) {
73-
std::cout << "warning: moving to null substack block (nothing will happen)" << std::endl;
74-
return;
75-
}
76-
77-
if (!m_currentBlock)
78-
std::cout << "warning: " << substackBlock->id() << ": moving to substack from a null block" << std::endl;
79-
80-
m_tree.push_back({ m_currentBlock, substackBlock });
81-
m_currentBlock = substackBlock;
82-
m_engine->stayOnCurrentBlock();
83-
}
84-
85-
/*!
86-
* Moves to a substack, e. g. in a loop.
87-
* \param[in] args The arguments passed to the block.
88-
* \param[in] inputId The ID of the substack input (registered by the block section).
89-
*/
90-
void RunningScript::moveToSubstack(const BlockArgs &args, int inputId)
91-
{
92-
auto substack = getSubstack(args, inputId);
93-
if (substack)
94-
moveToSubstack(substack);
95-
else
96-
skipSubstack();
97-
}
98-
99-
/*!
100-
* Finds the substack.
101-
* \param[in] args The arguments passed to the block.
102-
* \param[in] inputId The ID of the substack input (registered by the block section).
103-
*/
104-
std::shared_ptr<Block> RunningScript::getSubstack(const BlockArgs &args, int inputId) const
105-
{
106-
auto block = args.block();
107-
auto input = block->findInputById(inputId);
108-
if (input) {
109-
auto ret = input->valueBlock();
110-
if (ret)
111-
return ret;
112-
}
113-
return nullptr;
114-
}
115-
116-
/*! Use this to avoid passing a null block to moveToSubstack(). */
117-
void RunningScript::skipSubstack()
118-
{
119-
m_tree.push_back({ m_currentBlock, nullptr });
120-
m_currentBlock = nullptr;
121-
bool ret = substackEnd();
122-
if (!ret) {
123-
m_tree.pop_back();
124-
m_engine->stayOnCurrentBlock();
125-
}
126-
}
127-
128-
/*! Returns the Target which started the script. */
129-
std::shared_ptr<Target> RunningScript::target() const
130-
{
131-
return m_target;
132-
}
133-
134-
/*!
135-
* Returns true if a block implementation has been
136-
* called to check whether to break from a C mouth.
137-
*/
138-
bool RunningScript::atCMouthEnd() const
139-
{
140-
return m_atCMouthEnd;
141-
}
142-
143-
bool RunningScript::substackEnd()
144-
{
145-
/*
146-
* Call the C mouth block implementation
147-
* to check whether to break from the C
148-
* mouth or to jump to the beginning of it.
149-
*/
150-
auto cMouthBlock = cMouth();
151-
m_atCMouthEnd = true;
152-
bool ret = cMouthBlock->run(this, true).toBool();
153-
m_atCMouthEnd = false;
154-
if (!m_engine->isAtomic())
155-
m_engine->breakFrame();
156-
if (ret) {
157-
m_currentBlock = cMouthBlock;
158-
m_tree.pop_back();
159-
} else {
160-
m_currentBlock = m_tree[m_tree.size() - 1].second;
161-
if (!m_currentBlock)
162-
m_currentBlock = cMouthBlock;
163-
}
164-
return ret;
165-
}

‎src/scratch/runningscript.h‎

Lines changed: 125 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
#pragma once
44

5+
#include "../engine/engine.h"
56
#include "../scratch/target.h"
67
#include "block.h"
78
#include <map>
9+
#include <iostream>
810

911
namespace libscratchcpp
1012
{
@@ -15,21 +17,134 @@ class LIBSCRATCHCPP_EXPORT RunningScript
1517
public:
1618
RunningScript(std::shared_ptr<Block> block, std::shared_ptr<Target> target, Engine *engine);
1719

18-
std::shared_ptr<Block> currentBlock() const;
19-
void moveToNextBlock();
20+
/*! Returns the current block. */
21+
std::shared_ptr<Block> currentBlock() const { return m_currentBlock; }
2022

21-
std::shared_ptr<Block> cMouth();
22-
void moveToSubstack(std::shared_ptr<Block> substackBlock);
23-
void moveToSubstack(const BlockArgs &args, int inputId);
24-
std::shared_ptr<Block> getSubstack(const BlockArgs &args, int inputId) const;
25-
void skipSubstack();
23+
/*!
24+
* Continues to the next block, cMouth() or to the first block of a C mouth.
25+
* \note Use moveToSubstack() to move to the substack of e. g. a loop, or
26+
* skipSubstack(), if it doesn't have one.
27+
*/
28+
void moveToNextBlock()
29+
{
30+
if (m_currentBlock) {
31+
if (!m_currentBlock->next() && !m_tree.empty()) {
32+
bool ret = substackEnd();
33+
if (!ret)
34+
return;
35+
moveToNextBlock();
36+
return;
37+
}
38+
m_currentBlock = m_currentBlock->next();
39+
}
40+
}
2641

27-
std::shared_ptr<Target> target() const;
42+
/*! Returns the C mouth block or nullptr if the block isn't in a C mouth. */
43+
std::shared_ptr<Block> cMouth()
44+
{
45+
if (m_tree.empty())
46+
return nullptr;
47+
return m_tree[m_tree.size() - 1].first;
48+
}
2849

29-
bool atCMouthEnd() const;
50+
/*!
51+
* Moves to a substack, e. g. in a loop.
52+
* \note Please use the overloaded function with the list of inputs
53+
* and the index of the substack input because it'll automatically
54+
* check if there's a substack defined.
55+
*/
56+
void moveToSubstack(std::shared_ptr<Block> substackBlock)
57+
{
58+
if (!substackBlock) {
59+
std::cout << "warning: moving to null substack block (nothing will happen)" << std::endl;
60+
return;
61+
}
62+
63+
if (!m_currentBlock)
64+
std::cout << "warning: " << substackBlock->id() << ": moving to substack from a null block" << std::endl;
65+
66+
m_tree.push_back({ m_currentBlock, substackBlock });
67+
m_currentBlock = substackBlock;
68+
m_engine->stayOnCurrentBlock();
69+
}
70+
71+
/*!
72+
* Moves to a substack, e. g. in a loop.
73+
* \param[in] args The arguments passed to the block.
74+
* \param[in] inputId The ID of the substack input (registered by the block section).
75+
*/
76+
void moveToSubstack(const BlockArgs &args, int inputId)
77+
{
78+
auto substack = getSubstack(args, inputId);
79+
if (substack)
80+
moveToSubstack(substack);
81+
else
82+
skipSubstack();
83+
}
84+
85+
/*!
86+
* Finds the substack.
87+
* \param[in] args The arguments passed to the block.
88+
* \param[in] inputId The ID of the substack input (registered by the block section).
89+
*/
90+
std::shared_ptr<Block> getSubstack(const BlockArgs &args, int inputId) const
91+
{
92+
auto block = args.block();
93+
auto input = block->findInputById(inputId);
94+
if (input) {
95+
auto ret = input->valueBlock();
96+
if (ret)
97+
return ret;
98+
}
99+
return nullptr;
100+
}
101+
102+
/*! Use this to avoid passing a null block to moveToSubstack(). */
103+
void skipSubstack()
104+
{
105+
m_tree.push_back({ m_currentBlock, nullptr });
106+
m_currentBlock = nullptr;
107+
bool ret = substackEnd();
108+
if (!ret) {
109+
m_tree.pop_back();
110+
m_engine->stayOnCurrentBlock();
111+
}
112+
}
113+
114+
/*! Returns the Target which started the script. */
115+
std::shared_ptr<Target> target() const { return m_target; }
116+
117+
/*!
118+
* Returns true if a block implementation has been
119+
* called to check whether to break from a C mouth.
120+
*/
121+
bool atCMouthEnd() const { return m_atCMouthEnd; }
30122

31123
private:
32-
bool substackEnd();
124+
bool substackEnd()
125+
{
126+
/*
127+
* Call the C mouth block implementation
128+
* to check whether to break from the C
129+
* mouth or to jump to the beginning of it.
130+
*/
131+
auto cMouthBlock = cMouth();
132+
m_atCMouthEnd = true;
133+
bool ret = cMouthBlock->run(this, true).toBool();
134+
m_atCMouthEnd = false;
135+
if (!m_engine->isAtomic())
136+
m_engine->breakFrame();
137+
if (ret) {
138+
m_currentBlock = cMouthBlock;
139+
m_tree.pop_back();
140+
} else {
141+
m_currentBlock = m_tree[m_tree.size() - 1].second;
142+
if (!m_currentBlock)
143+
m_currentBlock = cMouthBlock;
144+
}
145+
return ret;
146+
}
147+
33148
std::shared_ptr<Block> m_currentBlock;
34149
// pair<C mouth block, first block of the substack>
35150
std::vector<std::pair<std::shared_ptr<Block>, std::shared_ptr<Block>>> m_tree;

0 commit comments

Comments
 (0)