terminal

Store definition

// SPDX-FileCopyrightText: 2020-2023 Jochem Rutgers
//
// SPDX-License-Identifier: CC0-1.0

int64 supercalifragilisticexpialidocious
int32 oh gosh

{
	bool world
} small

Application

// SPDX-FileCopyrightText: 2020-2023 Jochem Rutgers
//
// SPDX-License-Identifier: CC0-1.0

/*!
 * \file
 * \brief A stdin/stdout terminal application to test hand-injected Embedded Debugger messages.
 */

#include "ExampleTerminal.h"

#include <stored>

#ifndef STORED_OS_WINDOWS
// The default implementation emits the response to stdout, with APC / ST
// around it. However, your normal terminal strips this out.  If you pipe the
// stdout to a file, you will see these sequences.
//
// If you enable the following line, this example dumps the response to stderr too.
#	define PRINT_TO_STDERR
#endif

// If defined, do not print escaped messages to the console, but silently drop them.
//#define SUPPRESS_ESCAPE

class CaseInverter : public stored::TerminalLayer {
public:
	typedef stored::TerminalLayer base;
	CaseInverter() is_default
	virtual ~CaseInverter() override is_default

protected:
	void nonDebugDecode(void* buffer, size_t len) final
	{
		for(char* p = (char*)buffer; len > 0; len--, p++) {
			char c = *p;
			if(c >= 'a' && c <= 'z')
				putchar(c - 'a' + 'A');
			else if(c >= 'A' && c <= 'Z')
				putchar(c - 'A' + 'a');
			else
				putchar(c);
		}
	}

#ifdef PRINT_TO_STDERR
	void encode(void const* buffer, size_t len, bool last) final
	{
		base::encode(buffer, len, last);
		fwrite(buffer, len, 1, stderr);
	}
#endif
};

int main()
{
	stored::ExampleTerminal store;

	stored::Debugger debugger;
	debugger.map(store);

	stored::AsciiEscapeLayer escape;
	escape.wrap(debugger);

	CaseInverter ci;
	ci.wrap(escape);

	stored::StdioLayer stdio;
	stdio.wrap(ci);

	printf("Terminal with out-of-band debug messages test\n\n");
	printf("To inject a command, enter `ESC %c <your command> ESC %c`.\n",
	       stored::TerminalLayer::EscStart, stored::TerminalLayer::EscEnd);
	printf("If pressing ESC does not work, try pressing Ctrl+[ instead.\n");
	printf("All other input is considered part of the normal application stream,\n"
	       "which is case-inverted in this example.\n\n");

	setvbuf(stdin, NULL, _IONBF, 0);
	setvbuf(stdout, NULL, _IONBF, 0);

	stored::Poller poller;
	stored::PollableFileLayer pollable(stdio, stored::Pollable::PollIn);
	if((errno = poller.add(pollable))) {
		perror("Cannot add pollable");
		return 1;
	}

	while(stdio.isOpen()) {
		poller.poll();
		stdio.recv();
	}

	return 0;
}

Store reference

template<typename Base_, typename Implementation_> class ExampleTerminalObjects

All ExampleTerminalBase’s objects.

Public Types

typedef Base_ Base

typedef Implementation_ Implementation

Public Members

impl::StoreVariable<Base, Implementation, int32_t, 8u, 4> oh_gosh: oh gosh

impl::StoreVariable<Base, Implementation, bool, 12u, 1> small__world: small/world

impl::StoreVariable<Base, Implementation, int64_t, 0u, 8> supercalifragilisticexpialidocious: supercalifragilisticexpialidocious

template<typename Implementation_> class ExampleTerminalBase : public stored::ExampleTerminalObjects<ExampleTerminalBase<Implementation_>, Implementation_>

Base class with default interface of all ExampleTerminal implementations.

Although there are no virtual functions in the base class, subclasses can override them. The (lowest) subclass must pass the Implementation_ template paramater to its base, such that all calls from the base class can be directed to the proper overridden implementation.

The base class cannot be instantiated. If a default implementation is required, which does not have side effects to functions, instantiate stored::ExampleTerminal. This class contains all data of all variables, so it can be large. So, be aware when instantiating it on the stack. Heap is fine. Static allocations is fine too, as the constructor and destructor are trivial.

To inherit the base class, you can use the following template:

class ExampleTerminal : public stored::store<ExampleTerminal, ExampleTerminalBase>::type {
    STORE_CLASS(ExampleTerminal, ExampleTerminalBase)
public:
    // Your class implementation, such as:
    ExampleTerminal() is_default
    // ...
};

Some compilers or tools may get confused by the inheritance using stored::store or stored::store_t. Alternatively, use STORE_T(...) instead, providing the template parameters of stored::store as macro arguments.

See also

stored::ExampleTerminal

See also

stored::ExampleTerminalData

Subclassed by stored::ExampleTerminalDefaultFunctions< ExampleTerminalBase< ExampleTerminal > >

Public Types

enum [anonymous]

Values:

enumerator ObjectCount: Number of objects in the store.

enumerator VariableCount: Number of variables in the store.

enumerator FunctionCount: Number of functions in the store.

enumerator BufferSize: Buffer size.

typedef Implementation_ Implementation: Type of the actual implementation, which is the (lowest) subclass.

typedef uintptr_t Key

Type of a key.

See also

bufferToKey()

typedef Map<String::type, Variant<Implementation>>::type ObjectMap: Map as generated by map().

typedef ExampleTerminalObjects<ExampleTerminalBase, Implementation_> Objects

typedef ExampleTerminalBase root: We are the root, as used by STORE_CLASS.

typedef ExampleTerminalBase self: Define self for stored::store.

Public Functions

inline ~ExampleTerminalBase()

inline Key bufferToKey(void const *buffer) const noexcept

Converts a variable’s buffer to a key.

A key is unique for all variables of the same store, but identical for the same variables across different instances of the same store class. Therefore, the key can be used to synchronize between instances of the same store. A key does not contain meta data, such as type or length. It is up to the synchronization library to make sure that these properties are handled well.

For synchronization, when hookEntryX() or hookEntryRO() is invoked, one can compute the key of the object that is accessed. The key can be used, for example, in a key-to-Variant map. When data arrives from another party, the key can be used to find the proper Variant in the map.

This way, data exchange is type-safe, as the Variant can check if the data format matches the expected type. However, one cannot process data if the key is not set yet in the map.

inline Type::type bufferToType(void const *buffer) noexcept: Return the type of the variable, given its buffer.

inline Variant<Implementation> find(char const *name, size_t len = std::numeric_limits<size_t>::max()) noexcept

Finds an object with the given name.

Returns:: the object, or an invalid stored::Variant if not found.

template<typename T> inline Function<T, Implementation> function(char const *name, size_t len = std::numeric_limits<size_t>::max()) noexcept

Finds a function with the given name.

The function, when it exists, must have the given (fixed) type.

inline Implementation const &implementation() const noexcept: Returns the reference to the implementation.

inline Implementation &implementation() noexcept: Returns the reference to the implementation.

template<typename F> inline void list(F &&f) noexcept

Calls a callback for every object in the longDirectory().

See also

stored::list()

template<typename F> inline void list(F f, void *arg, char const *prefix, String::type *nameBuffer) noexcept

Calls a callback for every object in the longDirectory().

See also

stored::list()

template<typename F> inline void list(F f, void *arg, char const *prefix = nullptr) noexcept

Calls a callback for every object in the longDirectory().

See also

stored::list()

inline uint8_t const *longDirectory() const noexcept

Retuns the long directory.

When not available, the short directory is returned.

inline ObjectMap map(char const *prefix = nullptr)

Create a name to Variant map for the store.

Generating the map may be expensive and the result is not cached.

inline char const *name() const noexcept: Returns the name of store, which can be used as prefix for stored::Debugger.

inline uint8_t const *shortDirectory() const noexcept: Returns the short directory.

template<typename T> inline Variable<T, Implementation> variable(char const *name, size_t len = std::numeric_limits<size_t>::max()) noexcept

Finds a variable with the given name.

The variable, when it exists, must have the given (fixed) type.

Public Members

impl::StoreVariable<Base, Implementation, int32_t, 8u, 4> oh_gosh: oh gosh

impl::StoreVariable<Base, Implementation, bool, 12u, 1> small__world: small/world

impl::StoreVariable<Base, Implementation, int64_t, 0u, 8> supercalifragilisticexpialidocious: supercalifragilisticexpialidocious

Public Static Functions

template<typename T> static inline constexpr FreeFunction<T, Implementation> freeFunction(char const *name, size_t len = std::numeric_limits<size_t>::max()) noexcept

Finds a function with the given name.

The function, when it exists, must have the given (fixed) type. It is returned as a free function; it is not bound yet to a specific store instance. This function is constexpr for C++14.

template<typename T> static inline constexpr FreeVariable<T, Implementation> freeVariable(char const *name, size_t len = std::numeric_limits<size_t>::max()) noexcept

Finds a variable with the given name.

The variable, when it exists, must have the given (fixed) type. It is returned as a free variable; it is not bound yet to a specific store instance. This function is constexpr for C++14.

static inline constexpr char const *hash() noexcept: Returns a unique hash of the store.

Friends

friend class impl::StoreFunction

friend class impl::StoreVariable

friend class impl::StoreVariantF

friend class impl::StoreVariantV

friend class stored::FreeVariable

friend class stored::Variant< void >

class ExampleTerminal : public stored::ExampleTerminalDefaultFunctions<ExampleTerminalBase<ExampleTerminal>>

Default ExampleTerminalBase implementation.

Public Functions

ExampleTerminal() = default: Default constructor.