xstate-cpp's Introduction

xstate-cpp

I needed xstate in C++. Here we are

Features

Basic stuff (I dunno I'm new here I just wanted a state machine for myself ☃)
Nested state machines just landed in by #5 - see ./example.cpp for an example.
Others coming in real soon. Actually, even sooner, if you wanna contribute:P

Installation

platformio

platformio lib install --save XState-cpp

For everything else, you need to compile all .cpp files - makefile coming soon.

git + submodules

git submodules add https://github.com/sarpik/xstate-cpp.git
# or:  git submodules add [email protected]/sarpik/xstate-cpp.git

git submodules update --init --recursive

g++ -std=c++11 ./xstate-cpp/src/*.cpp ./xstate-cpp/example.cpp -o example.out
./example.out

git clone https://github.com/sarpik/xstate-cpp.git
# or:  git clone [email protected]:sarpik/xstate-cpp.git

g++ -std=c++11 ./xstate-cpp/src/*.cpp ./xstate-cpp/example.cpp -o example.out
./example.out

obviously, you subsitute example.cpp with your own source files & get some spicy state machines. 🌶

Usage

See also ./example.cpp

#include <iostream>
#include "xstate.h"

using namespace std;
using namespace xs;

int main() {
  StateMachine machine = {
    .id = "light",
    .initial = "green",
    .states = {
      {
        "green" ,
        { .on = { { "TIMER", "yellow" } } }
      },
      {
        "yellow",
        { .on = { { "TIMER", "red"    } } }
      },
      {
        "red"   ,
        { .on = { { "TIMER", "green"  } } }
      }
    }
  };

  Interpreter *toggleMachine = interpret(machine)
    ->logInfo()
    ->onStart([]() {
      cout << "let's go!\n";
    })
    ->onTransition([](Interpreter *self) {
      self->logInfo();
    })
    ->onStop([]() {
      cout << "oh no we stopped c:\n";
    })
    ->start();

  toggleMachine->send("TIMER");

  toggleMachine->send("TIMER");

  toggleMachine->send("TIMER");

  toggleMachine->stop();

  delete toggleMachine;

  return 0;
}

compile with:

g++ -std=c++11

for example,

g++ -std=c++11 ./src/*.cpp ./example.cpp -o example.out

& run with

./example.out

I use ./go

License

MIT © Kipras Melnikovas

xstate-cpp's People

Contributors

Stargazers

Watchers

xstate-cpp's Issues

Makefile / other installation / distribution would be great

Tests would be really useful

Will have to find out how peeps write'em in C++. Suggestions welcome:D

Allow state nesting

struct State {
	std::map<const char *, const char *> on;
+	StateMachine states; /** optional for nesting */
};

Parallel state machines

...are on their way.
I've already got'em working,
alongside loads of other changes, thus it's taking a little. brb

xstate-cpp versus other SCXML to C++ code generators? qscxmlc, scxmlcc, uscxml

how is xstate-cpp different from other SCXML to C++ code generators?

https://github.com/shuvalov-mdb/xstate-cpp-generator
https://doc.qt.io/qt-5/qscxmlc.html
https://github.com/jp-embedded/scxmlcc
https://github.com/tklab-tud/uscxml#for-transformations

my use case is code generation for arduino

CI w/ github actions

Prereq: #7

Return self once transitioning your state

struct StateMachine {
	const char *id;
	const char *initial;
	States states;
+	const char *value;

-	const char *transition(const char *currentState, const char *event) {
+	StateMachine *transition(const char *currentState, const char *event) {
		const char *nextState = this->states[currentState].on[event];
+		this->value = nextState;
-		return nextState;
+		return this;
	}
}