History

Michael Richters cf5c19dd6c Standardize namespace block closing comments This standardizes namespace closing brackets for namespace blocks. Each one is on its own line, with a comment clearly marking which namespace it closes. Consecutive lines closing namespace blocks have no whitespace between them, but there is one blank line before and after a set of namespace block closing lines. To generate the namespace comments, I used clang-format, with `FixNamespaceComments: true`. But since clang-format can't exactly duplicate our astyle formatting, it made lots of other changes, too. To isolate the namespace comments from the other formatting changes, I first ran clang-format with `FixNamespaceComments: false`, committed those changes, then ran it again to generate the namespace comments. Then I stashed the namespace comments, reset `HEAD` to remove the other changes, applied the stashed namespace comments, and committed the results (after examining them and making a few minor adjustments by hand). Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>		3 years ago
..
src	Standardize namespace block closing comments	3 years ago
README.md	HostOS: Migrate from OSX to macOS	4 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(void) {
  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(void) {
  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