History

Gergely Nagy 8ac4d9f5c1 A more efficient way to handle onFocusEvent commands In the past, we were using `Focus.handleHelp()` to see if we're handling a `help` command, and print the commands supported by the handler. We also used `strcmp_P` directly to compare (parts of) our input against command supported by the handler. This approach works, but had multiple major disadvantages: it duplicated strings between `handleHelp` and the `strcmp_P` calls, and it relied on fragile substring pointers to save space. To replace all that, this patch implements a different approach. Help handling is split between a check (`Focus.inputMatchesHelp()`) and a reply (`Focus.printHelp()`), the latter of which takes a list of `PSTR()` strings, rather than one single string. This allows us to reuse the same strings for comparing against the handler's input. The new approach no longer uses the fragile substring pointers, nor does it use `strcmp_P` directly, but goes through a wrapper (`Focus.inputMatchesCommand()`) instead. These changes lead to a more readable pattern. While we do use longer strings as a result, there is less duplication, and the new patterns also require less code, so we end up with saving space, at least on AVR devices. The old methods are still available and usable, but they're deprecated. Signed-off-by: Gergely Nagy <algernon@keyboard.io>		2 years ago
..
src	A more efficient way to handle onFocusEvent commands	2 years ago
README.md	Remove C-style `void` parameter for functions that don't take args	3 years ago
library.properties	More library tweaking to comply with arduino requirements	4 years ago

README.md

HostOS

The HostOS extension is not all that useful in itself, rather, it is a building block other plugins and extensions can use to not repeat the same guesswork and logic.

The goal is to have a single place that remembers the host OS, whether set by the end-user in a Sketch, or via a macro, or some other way. This information can then be reused by other plugins.

See the Unicode extension for an example about how to use HostOS in practice.

Using the extension

The extension provides a HostOS singleton object.

#include <Kaleidoscope.h>
#include <Kaleidoscope-HostOS.h>

void someFunction() {
  if (HostOS.os() == kaleidoscope::hostos::LINUX) {
    // do something linux-y
  }
  if (HostOS.os() == kaleidoscope::hostos::MACOS) {
    // do something macOS-y
  }
}

KALEIDOSCOPE_INIT_PLUGINS(HostOS)

void setup() {
  Kaleidoscope.setup ();
}

Extension methods

The extension provides the following methods on the HostOS singleton:

`.os()`

Returns the stored type of the Host OS.

`.os(type)`

Sets the type of the host OS, overriding any previous value. The type is then stored in EEPROM for persistence.

Host OS Values

The OS type (i.e. the return type of .os() and the arguments to .os(type)) will be one of the following:

kaleidoscope::hostos::LINUX
kaleidoscope::hostos::MACOS
kaleidoscope::hostos::WINDOWS
kaleidoscope::hostos::OTHER

For compability reasons, kaleidoscope::hostos::OSX is an alias to kaleidoscope::hostos::MACOS.

Focus commands

The plugin provides the FocusHostOSCommand object, which, when enabled, provides the hostos.type Focus command.

`hostos.type [type]`

Without argument, returns the current OS type set (a numeric value).

With an argument, it sets the OS type.

This command can be used from the host to reliably set the OS type within the firmware.

Dependencies

Kaleidoscope-EEPROM-Settings