[ANN] Guile-SMC 0.6.1 released

[ANN] Guile-SMC 0.6.1 released

[Artyom V. Poptsov]

[-- Attachment #1: Type: text/plain, Size: 3826 bytes --]

Hello Guilers,

I'm pleased to announce Guile State Machine Compiler (Guile-SMC), version
0.6.1:
  https://github.com/artyom-poptsov/guile-smc/releases/tag/v0.6.1

This release adds support for setting a global event source for a
finite-state machine in PlantUML using "legend" section and context
sub-types for "smc context" command.  Some bugs fixed as well, please
see the list of notable changes below.


* What is Guile-SMC?

Guile-SMC is a state machine compiler that allows to describe finite
state machines (FSMs) in Scheme in terms of transition tables.  It is
capable to generate such transition tables from a PlantUML state
diagrams. [1]

Some of the key features:
- A transition table can be verified and checked for dead-ends and
  infinite loops.
- Guile-SMC FSMs gather statistics when they run (steps/transitions);
  the statistics can be used can be used to compare/analyze FSMs..
- There's an FSM profiler that runs on FSMs trace logs.  The profiler
  output shows how much time the FSM spends in each state.  This can be
  useful for optimization.
- The state machine compiler supports three "targets" for compilation: a
  regular "guile" target where the output FSM depends on Guile-SMC;
  "guile-standalone" target that produce an FSM that does not depend on
  Guile-SMC.
- Guile-SMC allows to run a FSM on-the-fly with a single "smc run"
  command -- see the docs and the examples for more information.
- Common context code for parsers that work with characters or bytes.
  This includes special data structures to provide memory for FSMs
  (although it is not required to use them; FSMs can use custom
  procedures and data structures.)

Guile-SMC comes with a Scheme program called 'smc' -- a state machine
compiler itself.  It produces a Scheme code for an FSM from the PlantUML
format.  This tool is meant to be called on a PlantUML file when a
program with a FSM is being built (for example, from a Makefile.)

I'm hoping that it will ease the burden of writing format parsers and
other useful GNU Guile libraries for the community.


* User-visible changes

--8<---------------cut here---------------start------------->8---
* Version 0.6.1 (2023-07-30)
** Allow to set a global event source in a PlantUML "legend" block
Now PlantUML parser allows to set a global event source for an FSM in a
"legend" block, like follows:
#+BEGIN_EXAMPLE
some_state: event-source: some-event-source
#+END_EXAMPLE
** =smc context=: Allow to set context sub-type
=smc context= now allows to set a context sub-type to minimise the amount of
imported code.  This change is backward-compatible with the old CLI as "oop"
and "functional" types still supported. Please see =smc context --help= for
the full list of supported types and subtypes.
** =fsm-run!= bugfix: Return the updated context at the end
Return the updated context at the end of FSM run.
** =(smc core state)=: Bugfix
Add missing serialization of the state "exit-action".  Also set the state exit
action when the state is de-serialized.
--8<---------------cut here---------------end--------------->8---

* Usage examples

- Guile-INI -- INI[2] format parser:
  https://github.com/artyom-poptsov/guile-ics
- Guile-ICS -- iCalendar (RFC 5545) and vCard (RFC 6350) parser:
  https://github.com/artyom-poptsov/guile-ics
- Guile-PNG -- Pure Scheme Portable Network Graphics (PNG, RFC 2083)
  library:
  https://github.com/artyom-poptsov/guile-png

Happy hacking,

- Artyom

References:
1: https://plantuml.com/state-diagram
2: https://en.wikipedia.org/wiki/INI_file

-- 
Artyom "avp" Poptsov <poptsov.artyom@gmail.com>
Home page: https://memory-heap.org/~avp/
CADR Hackerspace co-founder: https://cadrspace.ru/
GPG: D0C2 EAC1 3310 822D 98DE  B57C E9C5 A2D9 0898 A02F

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 519 bytes --]