Skip to content

Commit 118be3e

Browse files
adazem009adazem009
committed
Replace question asked/answered handlers with signals
1 parent 9949e33 commit 118be3e

File tree

7 files changed

+28
-86
lines changed

7 files changed

+28
-86
lines changed

‎include/scratchcpp/iengine.h‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -352,17 +352,11 @@ class LIBSCRATCHCPP_EXPORT IEngine
352352
/*! Emits when a monitor is removed. */
353353
virtual sigslot::signal<Monitor *, IMonitorHandler *> &monitorRemoved() = 0;
354354

355-
/*! Returns the function which is called when a question is asked, for example using the 'ask and wait' block. */
356-
virtual const std::function<void(const std::string &)> &questionAsked() const = 0;
355+
/*! Emits when a question is asked, for example using the 'ask and wait' block. */
356+
virtual sigslot::signal<const std::string &> &questionAsked() = 0;
357357

358-
/*! Sets the function which is called when a question is asked, for example using the 'ask and wait' block. */
359-
virtual void setQuestionAsked(const std::function<void(const std::string &)> &f) = 0;
360-
361-
/*! Returns the function which should be called when a question is answered. */
362-
virtual const std::function<void(const std::string &)> &questionAnswered() const = 0;
363-
364-
/*! Sets the function which should be called when a question is answered. */
365-
virtual void setQuestionAnswered(const std::function<void(const std::string &)> &f) = 0;
358+
/*! Emits when a question is answered. */
359+
virtual sigslot::signal<const std::string &> &questionAnswered() = 0;
366360

367361
/*! Returns the list of extension names. */
368362
virtual const std::vector<std::string> &extensions() const = 0;

‎src/blocks/sensingblocks.cpp‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ void SensingBlocks::registerBlocks(IEngine *engine)
8888
engine->addFieldValue(this, "backdrop name", BackdropName);
8989

9090
// Callbacks
91-
engine->setQuestionAnswered(&onAnswer);
91+
engine->questionAnswered().connect(&onAnswer);
9292
}
9393

9494
void SensingBlocks::compileDistanceTo(Compiler *compiler)
@@ -946,18 +946,16 @@ void SensingBlocks::askNextQuestion()
946946

947947
Question *question = m_questionList.front().get();
948948
Target *target = question->vm->target();
949-
auto ask = question->vm->engine()->questionAsked();
949+
IEngine *engine = question->vm->engine();
950950

951951
// If the target is visible, emit a blank question and show
952952
// a bubble unless the target was the stage
953953
if (question->wasVisible && !question->wasStage) {
954954
target->setBubbleType(Target::BubbleType::Say);
955955
target->setBubbleText(question->question);
956956

957-
if (ask)
958-
ask("");
957+
engine->questionAsked()("");
959958
} else {
960-
if (ask)
961-
ask(question->question);
959+
engine->questionAsked()(question->question);
962960
}
963961
}

‎src/engine/internal/engine.cpp‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1239,26 +1239,16 @@ sigslot::signal<Monitor *, IMonitorHandler *> &Engine::monitorRemoved()
12391239
return m_monitorRemoved;
12401240
}
12411241

1242-
const std::function<void(const std::string &)> &Engine::questionAsked() const
1242+
sigslot::signal<const std::string &> &Engine::questionAsked()
12431243
{
12441244
return m_questionAsked;
12451245
}
12461246

1247-
void Engine::setQuestionAsked(const std::function<void(const std::string &)> &f)
1248-
{
1249-
m_questionAsked = f;
1250-
}
1251-
1252-
const std::function<void(const std::string &)> &Engine::questionAnswered() const
1247+
sigslot::signal<const std::string &> &Engine::questionAnswered()
12531248
{
12541249
return m_questionAnswered;
12551250
}
12561251

1257-
void Engine::setQuestionAnswered(const std::function<void(const std::string &)> &f)
1258-
{
1259-
m_questionAnswered = f;
1260-
}
1261-
12621252
const std::vector<std::string> &Engine::extensions() const
12631253
{
12641254
return m_extensions;

‎src/engine/internal/engine.h‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -146,11 +146,8 @@ class Engine : public IEngine
146146
sigslot::signal<Monitor *> &monitorAdded() override;
147147
sigslot::signal<Monitor *, IMonitorHandler *> &monitorRemoved() override;
148148

149-
const std::function<void(const std::string &)> &questionAsked() const override;
150-
void setQuestionAsked(const std::function<void(const std::string &)> &f) override;
151-
152-
const std::function<void(const std::string &)> &questionAnswered() const override;
153-
void setQuestionAnswered(const std::function<void(const std::string &)> &f) override;
149+
sigslot::signal<const std::string &> &questionAsked() override;
150+
sigslot::signal<const std::string &> &questionAnswered() override;
154151

155152
const std::vector<std::string> &extensions() const override;
156153
void setExtensions(const std::vector<std::string> &newExtensions) override;
@@ -274,8 +271,8 @@ class Engine : public IEngine
274271

275272
sigslot::signal<Monitor *> m_monitorAdded;
276273
sigslot::signal<Monitor *, IMonitorHandler *> m_monitorRemoved;
277-
std::function<void(const std::string &)> m_questionAsked = nullptr;
278-
std::function<void(const std::string &)> m_questionAnswered = nullptr;
274+
sigslot::signal<const std::string &> m_questionAsked;
275+
sigslot::signal<const std::string &> m_questionAnswered;
279276
};
280277

281278
} // namespace libscratchcpp

‎test/blocks/sensing_blocks_test.cpp‎

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,6 @@ struct QuestionSpy
102102
MOCK_METHOD(void, asked, (const std::string &), ());
103103
};
104104

105-
template<typename T, typename... U>
106-
size_t getAddress(std::function<T(U...)> f)
107-
{
108-
typedef T(fnType)(U...);
109-
fnType **fnPointer = f.template target<fnType *>();
110-
return (size_t)*fnPointer;
111-
}
112-
113105
TEST_F(SensingBlocksTest, Name)
114106
{
115107
ASSERT_EQ(m_section->name(), "Sensing");
@@ -181,13 +173,13 @@ TEST_F(SensingBlocksTest, RegisterBlocks)
181173
EXPECT_CALL(m_engineMock, addFieldValue(m_section.get(), "backdrop name", SensingBlocks::BackdropName));
182174

183175
// Callbacks
184-
std::function<void(const std::string &)> questionAnsweredRef = &SensingBlocks::onAnswer;
185-
std::function<void(const std::string &)> questionAnswered;
186-
EXPECT_CALL(m_engineMock, setQuestionAnswered(_)).WillOnce(SaveArg<0>(&questionAnswered));
176+
sigslot::signal<const std::string &> questionAnswered;
177+
EXPECT_CALL(m_engineMock, questionAnswered()).WillOnce(ReturnRef(questionAnswered));
187178

188179
m_section->registerBlocks(&m_engineMock);
189-
ASSERT_TRUE(questionAnswered);
190-
ASSERT_EQ(getAddress(questionAnsweredRef), getAddress(questionAnswered));
180+
181+
ASSERT_EQ(questionAnswered.slot_count(), 1);
182+
ASSERT_EQ(questionAnswered.disconnect(&SensingBlocks::onAnswer), 1);
191183
}
192184

193185
TEST_F(SensingBlocksTest, DistanceTo)
@@ -381,14 +373,16 @@ TEST_F(SensingBlocksTest, AskAndWaitAndAnswerImpl)
381373
sprite.setBubbleType(Target::BubbleType::Think);
382374
Stage stage;
383375
QuestionSpy spy;
384-
std::function<void(const std::string &)> asked = std::bind(&QuestionSpy::asked, &spy, std::placeholders::_1);
376+
auto asked = std::bind(&QuestionSpy::asked, &spy, std::placeholders::_1);
377+
sigslot::signal<const std::string &> askedSignal;
378+
askedSignal.connect(asked);
385379

386380
VirtualMachine vm1(&sprite, &m_engineMock, nullptr);
387381
vm1.setFunctions(functions);
388382
vm1.setConstValues(constValues);
389383

390384
// Ask 3 questions (2 where the sprite is visible and 1 where it's invisible)
391-
EXPECT_CALL(m_engineMock, questionAsked()).WillOnce(ReturnRef(asked));
385+
EXPECT_CALL(m_engineMock, questionAsked()).WillOnce(ReturnRef(askedSignal));
392386
EXPECT_CALL(spy, asked(""));
393387
sprite.setVisible(true);
394388
vm1.setBytecode(bytecode1);
@@ -435,7 +429,7 @@ TEST_F(SensingBlocksTest, AskAndWaitAndAnswerImpl)
435429
ASSERT_EQ(sprite.bubbleText(), "test1");
436430

437431
// Answer the questions
438-
EXPECT_CALL(m_engineMock, questionAsked()).WillOnce(ReturnRef(asked));
432+
EXPECT_CALL(m_engineMock, questionAsked()).WillOnce(ReturnRef(askedSignal));
439433
EXPECT_CALL(spy, asked(""));
440434
SensingBlocks::onAnswer("hi");
441435
ASSERT_EQ(sprite.bubbleType(), Target::BubbleType::Say);
@@ -447,7 +441,7 @@ TEST_F(SensingBlocksTest, AskAndWaitAndAnswerImpl)
447441
ASSERT_EQ(vm1.registerCount(), 1);
448442
ASSERT_EQ(vm1.getInput(0, 1)->toString(), "hi");
449443

450-
EXPECT_CALL(m_engineMock, questionAsked()).WillOnce(ReturnRef(asked));
444+
EXPECT_CALL(m_engineMock, questionAsked()).WillOnce(ReturnRef(askedSignal));
451445
EXPECT_CALL(spy, asked("test3"));
452446
SensingBlocks::onAnswer("hello");
453447
ASSERT_TRUE(sprite.bubbleText().empty());
@@ -457,7 +451,7 @@ TEST_F(SensingBlocksTest, AskAndWaitAndAnswerImpl)
457451
ASSERT_EQ(vm1.registerCount(), 1);
458452
ASSERT_EQ(vm1.getInput(0, 1)->toString(), "hello");
459453

460-
EXPECT_CALL(m_engineMock, questionAsked()).WillOnce(ReturnRef(asked));
454+
EXPECT_CALL(m_engineMock, questionAsked()).WillOnce(ReturnRef(askedSignal));
461455
EXPECT_CALL(spy, asked("test2"));
462456
SensingBlocks::onAnswer("world");
463457
ASSERT_TRUE(sprite.bubbleText().empty());

‎test/engine/engine_test.cpp‎

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,6 @@ class AddRemoveMonitorMock
5454
MOCK_METHOD(void, monitorRemoved, (Monitor *, IMonitorHandler *));
5555
};
5656

57-
template<typename T, typename... U>
58-
size_t getAddress(std::function<T(U...)> f)
59-
{
60-
typedef T(fnType)(U...);
61-
fnType **fnPointer = f.template target<fnType *>();
62-
return (size_t)*fnPointer;
63-
}
64-
6557
TEST(EngineTest, Clock)
6658
{
6759
Engine engine;
@@ -1715,26 +1707,6 @@ void questionFunction(const std::string &)
17151707
{
17161708
}
17171709

1718-
TEST(EngineTest, QuestionAsked)
1719-
{
1720-
Engine engine;
1721-
ASSERT_EQ(engine.questionAsked(), nullptr);
1722-
1723-
static const std::function<void(const std::string &)> f = &questionFunction;
1724-
engine.setQuestionAsked(&questionFunction);
1725-
ASSERT_EQ(getAddress(engine.questionAsked()), getAddress(f));
1726-
}
1727-
1728-
TEST(EngineTest, QuestionAnswered)
1729-
{
1730-
Engine engine;
1731-
ASSERT_EQ(engine.questionAnswered(), nullptr);
1732-
1733-
static const std::function<void(const std::string &)> f = &questionFunction;
1734-
engine.setQuestionAnswered(f);
1735-
ASSERT_EQ(getAddress(engine.questionAnswered()), getAddress(f));
1736-
}
1737-
17381710
TEST(EngineTest, Clones)
17391711
{
17401712
Project p("clones.sb3");

‎test/mocks/enginemock.h‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,8 @@ class EngineMock : public IEngine
127127
MOCK_METHOD(sigslot::signal<Monitor *> &, monitorAdded, (), (override));
128128
MOCK_METHOD((sigslot::signal<Monitor *, IMonitorHandler *> &), monitorRemoved, (), (override));
129129

130-
MOCK_METHOD(const std::function<void(const std::string &)> &, questionAsked, (), (const, override));
131-
MOCK_METHOD(void, setQuestionAsked, (const std::function<void(const std::string &)> &), (override));
132-
133-
MOCK_METHOD(const std::function<void(const std::string &)> &, questionAnswered, (), (const, override));
134-
MOCK_METHOD(void, setQuestionAnswered, (const std::function<void(const std::string &)> &), (override));
130+
MOCK_METHOD(sigslot::signal<const std::string &> &, questionAsked, (), (override));
131+
MOCK_METHOD(sigslot::signal<const std::string &> &, questionAnswered, (), (override));
135132

136133
MOCK_METHOD(std::vector<std::string> &, extensions, (), (const, override));
137134
MOCK_METHOD(void, setExtensions, (const std::vector<std::string> &), (override));

0 commit comments

Comments
 (0)