class BBS::Theme

A Theme maps the style ROLES (such as :window_border or :button_focused) to ANSI SGR sequences. Widgets fetch styles through Widget#style.

The presets are data, a Hash each in PRESETS:

:synchronet: white and yellow on blue windows over a black screen, after Synchronet
:nortoncommander: cyan and blue panels, after Norton Commander
:dosnavigator: black on light grey with cyan bars, after DOS Navigator
:neumanntronics: teal and amber on black in 256 colours
:mono: no colour, only bold, dim, underline and reverse, for terminals without colour

::fetch builds one; derive a variant with merge:

BBS::Theme.fetch(:synchronet).merge(window_bg: "\e[41m")

Constants

PRESETS: The presets: each a Hash of every style role to its SGR sequence. The first one’s roles are Theme::ROLES, and every preset defines all of them.
ROLES: The style roles every preset defines and a theme may set.

Attributes

name [R]

The style Hash (role Symbol => SGR String) and the theme’s name Symbol.

styles [R]

The style Hash (role Symbol => SGR String) and the theme’s name Symbol.

Public Class Methods

dosnavigator ()

Source

# File lib/bbs/theme.rb, line 51
def self.dosnavigator = fetch(:dosnavigator)

The :dosnavigator preset (see ::fetch).

fetch (name)

Source

# File lib/bbs/theme.rb, line 36
def self.fetch(name)
  return name if name.is_a?(Theme)

  styles = PRESETS.fetch(name.to_s.to_sym) { raise ArgumentError, "unknown theme: #{name.inspect}" }
  new(name.to_sym, styles)
end

Returns the preset called name (a Symbol or String key of PRESETS), or name itself when it is a Theme already. Raises ArgumentError (“unknown theme”) for any other name.

BBS::Theme.fetch(:dosnavigator)   # => the DOS Navigator preset

mono ()

Source

# File lib/bbs/theme.rb, line 55
def self.mono = fetch(:mono)

The :mono preset (see ::fetch).

neumanntronics ()

Source

# File lib/bbs/theme.rb, line 53
def self.neumanntronics = fetch(:neumanntronics)

The :neumanntronics preset (see ::fetch).

new (name, styles)

Source

# File lib/bbs/theme.rb, line 60
def initialize(name, styles)
  unknown = styles.keys - ROLES
  raise ArgumentError, "unknown theme roles: #{unknown.inspect}" unless unknown.empty?

  @name   = name
  @styles = styles.frozen? ? styles : styles.dup.freeze
  freeze
end

Creates a theme called name from styles, a Hash of role Symbols (of ROLES) to SGR Strings. Raises ArgumentError for a role not in ROLES.

nortoncommander ()

Source

# File lib/bbs/theme.rb, line 49
def self.nortoncommander = fetch(:nortoncommander)

The :nortoncommander preset (see ::fetch).

roles ()

Source

# File lib/bbs/theme.rb, line 44
def self.roles = ROLES

The style roles, ROLES.

synchronet ()

Source

# File lib/bbs/theme.rb, line 47
def self.synchronet = fetch(:synchronet)

The :synchronet preset (see ::fetch).

Public Instance Methods

[] (key)

Source

# File lib/bbs/theme.rb, line 71
def [](key) = @styles[key]

Returns the SGR String for the role key, or nil when the theme does not define it.

merge (overrides)

Source

# File lib/bbs/theme.rb, line 79
def merge(overrides) = Theme.new(@name, @styles.merge(overrides))

Returns a new Theme with the same name and the roles in the Hash overrides replacing this theme’s styles. Raises ArgumentError for a role not in ROLES.

style (key)

Source

# File lib/bbs/theme.rb, line 74
def style(key) = @styles[key]

Same as [].