[Alex/inot-as-namespace] Provide workarounds for typical sketch idioms not working when using inot-as-class model. #47

aentinger · 2021-11-05T09:03:36Z

This fixes #43.

Objective

Encapsulating the .inot file content within a class prohibits a wide range of typical C/C++ constructs (see examples/Breaks_1/2/3/4/5/6). By encapsulating the .inot file within a namespace instead those issues can be prevented.

Implementation

Thread.inot

void myEventHandler() {
  /* Do something. */
}

void setup() {
  attachInterrupt(digitalPinToInterrupt(2), myEventHandler, CHANGE);
}

void loop() {
}

Before #47: inot-as-class-body

class ThreadClass : public Arduino_Threads
{
public:
  ThreadClass() { _tabname = "Thread"; }
private:

void myEventHandler() {
}

void setup() {
  /* This line breaks due to attachInterrupt expecting a free function, but myEventHandler is a class member function. */
  attachInterrupt((2), myEventHandler, CHANGE);
}

void loop() {

}

}; /* class ThreadClass */
ThreadClass Thread;

After #47: inot-within-namespace

namespace ThreadPrivate
{
  void setup();
  void loop();
}
class ThreadClass : public Arduino_Threads
{
public:
  ThreadClass() { _tabname = "Thread"; }
protected:
  virtual void setup() override { ThreadPrivate::setup(); }
  virtual void loop() override { ThreadPrivate::loop(); }
};
namespace ThreadPrivate
{

void myEventHandler() {
}

void setup() {
  /* This line compiles since myEventHandler is in fact a free function. */
  attachInterrupt((2), myEventHandler, CHANGE);
}

void loop() {

}

}; /* namespace ThreadPrivate */
ThreadClass Thread;

Summary

Example	inot as class body	inot within namespace
Breaks_1	❌	✔️
Breaks_2	✔️ 1)	✔️
Breaks_3	❌	✔️
Breaks_4	❌	✔️
Breaks_5	✔️	❌ 2)
Breaks_6	❌ 3)	❌ 3)

Ad 1) Function signature does not meet required signature (member functions contain this pointer as hidden parameter)

No problem for inot-within-namespace.
Can be mitigated for inot-as-class-body via e.g. b298b5c. You may judge for yourself how practical you think this is.

Ad 2) No function prototypes.

No problem for inot-as-class-body.
Can be mitigated for inot-within-namespace by extending arduino-cli in order to generate and insert prototypes during build.

Ad 3) Attempt access to thread-private variable

Does not compile for both inot-as-class-body and inot-within-namespace. This is intended.

inot-within-namespace offers "helpful"[/irony] suggestion to circumvent privacy shield by namespace:

Breaks_6/Breaks_6.ino: In function 'void loop()':
Breaks_6.ino:10:22: error: 'var' was not declared in this scope
   int const my_var = var;
                      ^~~
Breaks_6/Breaks_6.ino:10:22: note: suggested alternative:
Thread.inot:11:5: note:   'ThreadPrivate::var'
 int var = 0;

inot-as-class-body simply provides no way to access inot-private variables as they are private member variables of a class:

Breaks_6.ino: In function 'void loop()':
Breaks_6.ino:10:22: error: 'var' was not declared in this scope
   int const my_var = var;
                      ^~~

github-actions · 2021-11-10T08:53:56Z

Memory usage change @ 6864451

Board	flash	%	RAM for global variables	%
arduino:mbed_nano:nano33ble	🔺 0 - +64	0.0 - +0.01	0 - 0	0.0 - 0.0
arduino:mbed_nano:nanorp2040connect	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:mbed_portenta:envie_m4	🔺 0 - +64	0.0 - +0.01	0 - 0	0.0 - 0.0
arduino:mbed_portenta:envie_m7	🔺 0 - +64	0.0 - +0.01	0 - 0	0.0 - 0.0

Click for full report table

Board	examples/Breaks_1 flash	%	examples/Breaks_1 RAM for global variables	%	examples/Breaks_2 flash	%	examples/Breaks_2 RAM for global variables	%	examples/Breaks_3 flash	%	examples/Breaks_3 RAM for global variables	%	examples/Breaks_4 flash	%	examples/Breaks_4 RAM for global variables	%	examples/Threading_Basics/Source_Sink_Counter flash	%	examples/Threading_Basics/Source_Sink_LED flash	%	examples/Threadsafe_IO/Serial_ProtocolWrapping flash	%
arduino:mbed_nano:nano33ble	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	0	0.0	64	0.01	0	0.0
arduino:mbed_nano:nanorp2040connect	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	0	0.0	0	0.0	0	0.0
arduino:mbed_portenta:envie_m4	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	64	0.01	0	0.0	64	0.01
arduino:mbed_portenta:envie_m7	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	0	0.0	64	0.01	0	0.0

Click for full report CSV

Board,examples/Breaks_1<br>flash,%,examples/Breaks_1<br>RAM for global variables,%,examples/Breaks_2<br>flash,%,examples/Breaks_2<br>RAM for global variables,%,examples/Breaks_3<br>flash,%,examples/Breaks_3<br>RAM for global variables,%,examples/Breaks_4<br>flash,%,examples/Breaks_4<br>RAM for global variables,%,examples/Threading_Basics/Shared_Counter<br>flash,%,examples/Threading_Basics/Shared_Counter<br>RAM for global variables,%,examples/Threading_Basics/Source_Sink_Counter<br>flash,%,examples/Threading_Basics/Source_Sink_Counter<br>RAM for global variables,%,examples/Threading_Basics/Source_Sink_LED<br>flash,%,examples/Threading_Basics/Source_Sink_LED<br>RAM for global variables,%,examples/Threadsafe_IO/SPI<br>flash,%,examples/Threadsafe_IO/SPI<br>RAM for global variables,%,examples/Threadsafe_IO/SPI_BusIO<br>flash,%,examples/Threadsafe_IO/SPI_BusIO<br>RAM for global variables,%,examples/Threadsafe_IO/Serial_GlobalPrefixSuffix<br>flash,%,examples/Threadsafe_IO/Serial_GlobalPrefixSuffix<br>RAM for global variables,%,examples/Threadsafe_IO/Serial_ProtocolWrapping<br>flash,%,examples/Threadsafe_IO/Serial_ProtocolWrapping<br>RAM for global variables,%,examples/Threadsafe_IO/Serial_Reader<br>flash,%,examples/Threadsafe_IO/Serial_Reader<br>RAM for global variables,%,examples/Threadsafe_IO/Serial_Writer<br>flash,%,examples/Threadsafe_IO/Serial_Writer<br>RAM for global variables,%,examples/Threadsafe_IO/Wire<br>flash,%,examples/Threadsafe_IO/Wire<br>RAM for global variables,%,examples/Threadsafe_IO/Wire_BusIO<br>flash,%,examples/Threadsafe_IO/Wire_BusIO<br>RAM for global variables,%
arduino:mbed_nano:nano33ble,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,0,0.0,0,0.0,0,0.0,0,0.0,64,0.01,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_nano:nanorp2040connect,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_portenta:envie_m4,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,0,0.0,0,0.0,64,0.01,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,64,0.01,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_portenta:envie_m7,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,0,0.0,0,0.0,0,0.0,0,0.0,64,0.01,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

…erator.

github-actions · 2022-07-22T05:23:13Z

Memory usage change @ ed9e23c

Board	flash	%	RAM for global variables	%
arduino:mbed_nano:nano33ble	❔ -64 - +64	-0.01 - +0.01	0 - 0	0.0 - 0.0
arduino:mbed_nano:nanorp2040connect	🔺 0 - +60	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:mbed_portenta:envie_m4	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:mbed_portenta:envie_m7	🔺 0 - +64	0.0 - +0.01	0 - 0	0.0 - 0.0

Click for full report table

Board	examples/Threading_Basics/Shared_Counter flash	examples/Threading_Basics/Source_Sink_Counter flash	%	examples/Threading_Basics/Source_Sink_LED flash	%	examples/Threadsafe_IO/Serial_GlobalPrefixSuffix flash	%	examples/Threadsafe_IO/Serial_ProtocolWrapping flash	examples/Threadsafe_IO/Serial_Reader flash	%	examples/Threadsafe_IO/Serial_Writer flash
arduino:mbed_nano:nano33ble	0	64	0.01	0	0.0	-64	-0.01	0	64	0.01	0
arduino:mbed_nano:nanorp2040connect	24	60	0.0	54	0.0	8	0.0	16	48	0.0	8
arduino:mbed_portenta:envie_m4	0	0	0.0	0	0.0	0	0.0	0	0	0.0	0
arduino:mbed_portenta:envie_m7	0	0	0.0	64	0.01	0	0.0	0	0	0.0	0

Click for full report CSV

Board,examples/Threading_Basics/Shared_Counter<br>flash,%,examples/Threading_Basics/Shared_Counter<br>RAM for global variables,%,examples/Threading_Basics/Source_Sink_Counter<br>flash,%,examples/Threading_Basics/Source_Sink_Counter<br>RAM for global variables,%,examples/Threading_Basics/Source_Sink_LED<br>flash,%,examples/Threading_Basics/Source_Sink_LED<br>RAM for global variables,%,examples/Threadsafe_IO/SPI<br>flash,%,examples/Threadsafe_IO/SPI<br>RAM for global variables,%,examples/Threadsafe_IO/SPI_BusIO<br>flash,%,examples/Threadsafe_IO/SPI_BusIO<br>RAM for global variables,%,examples/Threadsafe_IO/Serial_GlobalPrefixSuffix<br>flash,%,examples/Threadsafe_IO/Serial_GlobalPrefixSuffix<br>RAM for global variables,%,examples/Threadsafe_IO/Serial_ProtocolWrapping<br>flash,%,examples/Threadsafe_IO/Serial_ProtocolWrapping<br>RAM for global variables,%,examples/Threadsafe_IO/Serial_Reader<br>flash,%,examples/Threadsafe_IO/Serial_Reader<br>RAM for global variables,%,examples/Threadsafe_IO/Serial_Writer<br>flash,%,examples/Threadsafe_IO/Serial_Writer<br>RAM for global variables,%,examples/Threadsafe_IO/Wire<br>flash,%,examples/Threadsafe_IO/Wire<br>RAM for global variables,%,examples/Threadsafe_IO/Wire_BusIO<br>flash,%,examples/Threadsafe_IO/Wire_BusIO<br>RAM for global variables,%
arduino:mbed_nano:nano33ble,0,0.0,0,0.0,64,0.01,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,-64,-0.01,0,0.0,0,0.0,0,0.0,64,0.01,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_nano:nanorp2040connect,24,0.0,0,0.0,60,0.0,0,0.0,54,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,8,0.0,0,0.0,16,0.0,0,0.0,48,0.0,0,0.0,8,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_portenta:envie_m4,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_portenta:envie_m7,0,0.0,0,0.0,0,0.0,0,0.0,64,0.01,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

github-actions · 2022-07-26T05:54:02Z

Memory usage change @ 067458e

Board	flash	%	RAM for global variables	%
arduino:mbed_nano:nano33ble	❔ -64 - +64	-0.01 - +0.01	0 - 0	0.0 - 0.0
arduino:mbed_nano:nanorp2040connect	🔺 0 - +60	0.0 - 0.0	💚 -8 - 0	-0.0 - 0.0
arduino:mbed_portenta:envie_m4	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:mbed_portenta:envie_m7	❔ -64 - +64	-0.01 - +0.01	0 - 0	0.0 - 0.0

Click for full report table

Board	examples/Threading_Basics/Shared_Counter flash	examples/Threading_Basics/Source_Sink_Counter flash	%	examples/Threading_Basics/Source_Sink_LED flash	%	examples/Threading_Basics/Thermostat flash	%	examples/Threading_Basics/Thermostat RAM for global variables	%	examples/Threadsafe_IO/Serial_GlobalPrefixSuffix flash	%	examples/Threadsafe_IO/Serial_ProtocolWrapping flash	examples/Threadsafe_IO/Serial_Reader flash	%	examples/Threadsafe_IO/Serial_Writer flash
arduino:mbed_nano:nano33ble	0	64	0.01	0	0.0	0	0.0	0	0.0	-64	-0.01	0	64	0.01	0
arduino:mbed_nano:nanorp2040connect	24	60	0.0	54	0.0	44	0.0	-8	-0.0	8	0.0	16	48	0.0	8
arduino:mbed_portenta:envie_m4	0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0	0.0	0
arduino:mbed_portenta:envie_m7	0	0	0.0	64	0.01	-64	-0.01	0	0.0	0	0.0	0	0	0.0	0

Click for full report CSV

Board,examples/Threading_Basics/Shared_Counter<br>flash,%,examples/Threading_Basics/Shared_Counter<br>RAM for global variables,%,examples/Threading_Basics/Source_Sink_Counter<br>flash,%,examples/Threading_Basics/Source_Sink_Counter<br>RAM for global variables,%,examples/Threading_Basics/Source_Sink_LED<br>flash,%,examples/Threading_Basics/Source_Sink_LED<br>RAM for global variables,%,examples/Threading_Basics/Thermostat<br>flash,%,examples/Threading_Basics/Thermostat<br>RAM for global variables,%,examples/Threadsafe_IO/SPI<br>flash,%,examples/Threadsafe_IO/SPI<br>RAM for global variables,%,examples/Threadsafe_IO/SPI_BusIO<br>flash,%,examples/Threadsafe_IO/SPI_BusIO<br>RAM for global variables,%,examples/Threadsafe_IO/Serial_GlobalPrefixSuffix<br>flash,%,examples/Threadsafe_IO/Serial_GlobalPrefixSuffix<br>RAM for global variables,%,examples/Threadsafe_IO/Serial_ProtocolWrapping<br>flash,%,examples/Threadsafe_IO/Serial_ProtocolWrapping<br>RAM for global variables,%,examples/Threadsafe_IO/Serial_Reader<br>flash,%,examples/Threadsafe_IO/Serial_Reader<br>RAM for global variables,%,examples/Threadsafe_IO/Serial_Writer<br>flash,%,examples/Threadsafe_IO/Serial_Writer<br>RAM for global variables,%,examples/Threadsafe_IO/Wire<br>flash,%,examples/Threadsafe_IO/Wire<br>RAM for global variables,%,examples/Threadsafe_IO/Wire_BusIO<br>flash,%,examples/Threadsafe_IO/Wire_BusIO<br>RAM for global variables,%
arduino:mbed_nano:nano33ble,0,0.0,0,0.0,64,0.01,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,-64,-0.01,0,0.0,0,0.0,0,0.0,64,0.01,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_nano:nanorp2040connect,24,0.0,0,0.0,60,0.0,0,0.0,54,0.0,0,0.0,44,0.0,-8,-0.0,0,0.0,0,0.0,0,0.0,0,0.0,8,0.0,0,0.0,16,0.0,0,0.0,48,0.0,0,0.0,8,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_portenta:envie_m4,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_portenta:envie_m7,0,0.0,0,0.0,0,0.0,0,0.0,64,0.01,0,0.0,-64,-0.01,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

aentinger self-assigned this Nov 5, 2021

aentinger force-pushed the experiment-threading branch 4 times, most recently from 2c32f30 to 54085dc Compare November 10, 2021 05:41

aentinger marked this pull request as ready for review November 11, 2021 05:10

arduino-libraries deleted a comment from github-actions bot Nov 11, 2021

aentinger requested review from pnndra and facchinm and removed request for pnndra November 11, 2021 05:25

aentinger force-pushed the experiment-threading branch from 80e5a8a to 1f23f0a Compare November 11, 2021 09:31

aentinger force-pushed the experiment-threading branch from 1f23f0a to f82e5d3 Compare November 24, 2021 05:08

aentinger marked this pull request as draft November 26, 2021 09:06

aentinger changed the title ~~Experiment with different sketches to test compatibility with existing code and fix bugs ...~~ Increase backwards compatibility Nov 26, 2021

aentinger force-pushed the experiment-threading branch from f82e5d3 to 5e67613 Compare December 6, 2021 14:19

aentinger added 3 commits March 28, 2022 07:32

experiment ...

5f4a0c0

Fix compilation error and access source/sinks via scope-resolution op…

19fbfe9

…erator.

Hiding clunky implementation details within neat CONNECT API.

c7251b8

aentinger force-pushed the experiment-threading branch from 5e67613 to c7251b8 Compare March 28, 2022 05:32

aentinger added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Mar 28, 2022

aentinger added 2 commits June 8, 2022 12:12

Merge branch 'main' into experiment-threading

cb6cb1a

Merge branch 'main' into experiment-threading

ed9e23c

aentinger changed the title ~~Increase backwards compatibility~~ [Alex/inot-as-namespace] Provide workarounds for typical sketch idioms not working when using inot-as-class model. Jul 22, 2022

aentinger mentioned this pull request Jul 22, 2022

Bugs: Typical sketches that do not compile with arduino-cli (MT) #43

Closed

aentinger force-pushed the experiment-threading branch from 346ba38 to ed9e23c Compare July 26, 2022 05:27

aentinger marked this pull request as ready for review July 26, 2022 05:27

aentinger added 2 commits July 26, 2022 07:30

Merge branch 'main' into experiment-threading

4a3feab

Utilize CONNECT macro.

067458e

aentinger merged commit f2ce390 into main Jul 26, 2022

aentinger deleted the experiment-threading branch July 26, 2022 05:44

aentinger mentioned this pull request Jul 26, 2022

Document possible work-arounds for shortcomings of inot-as-a-class. #85

Closed

per1234 added topic: documentation Related to documentation for the project and removed topic: code Related to content of the project itself labels Jul 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Alex/inot-as-namespace] Provide workarounds for typical sketch idioms not working when using inot-as-class model. #47

[Alex/inot-as-namespace] Provide workarounds for typical sketch idioms not working when using inot-as-class model. #47

aentinger commented Nov 5, 2021 •

edited

Loading

github-actions bot commented Nov 10, 2021

github-actions bot commented Jul 22, 2022

github-actions bot commented Jul 26, 2022

[Alex/inot-as-namespace] Provide workarounds for typical sketch idioms not working when using inot-as-class model. #47

[Alex/inot-as-namespace] Provide workarounds for typical sketch idioms not working when using inot-as-class model. #47

Conversation

aentinger commented Nov 5, 2021 • edited Loading

Objective

Implementation

Summary

github-actions bot commented Nov 10, 2021

github-actions bot commented Jul 22, 2022

github-actions bot commented Jul 26, 2022

aentinger commented Nov 5, 2021 •

edited

Loading