module Superconf

Overview

tput's tunables, registered into the shared Superconf registry (a process-wide singleton), so they appear alongside the host application's own options in one combined list.

Tput uses these as defaults for the corresponding constructor args/accessors; explicit Tput.new arguments still override them.

Defined in:

lib/superconf/src/superconf.cr
lib/superconf/src/superconf/option.cr
tput/config.cr

Constant Summary

OPT_keyboard_exclude = register("keyboard.exclude", "", env: nil, cli: nil, group: nil, description: "Enhanced keyboard protocols to never use (comma/space separated: kitty, modify_other_keys, legacy)", parse: nil, validate: nil)

Stored in a constant: infers its type from the generic register return, so no type annotation is needed.

OPT_keyboard_protocol = register("keyboard.protocol", "auto", env: nil, cli: nil, group: nil, description: "Enhanced keyboard protocol to use: auto (best supported), or kitty / modify_other_keys / legacy", parse: nil, validate: nil)

Stored in a constant: infers its type from the generic register return, so no type annotation is needed.

OPT_tput_attr_cache_limit = register("tput.attr_cache_limit", 4096, env: nil, cli: nil, group: nil, description: "Max cached SGR attribute sequences before FIFO eviction; 0 disables the attribute cache", parse: nil, validate: ->(n : Int32) do n >= 0 end)

Stored in a constant: infers its type from the generic register return, so no type annotation is needed.

OPT_tput_probe = register("tput.probe", true, env: nil, cli: nil, group: nil, description: "Auto-probe the terminal for colors/features on Tput.new (when attached to a TTY)", parse: nil, validate: nil)

Stored in a constant: infers its type from the generic register return, so no type annotation is needed.

OPT_tput_read_timeout = register("tput.read_timeout", 400.milliseconds, env: nil, cli: nil, group: nil, description: "Timeout waiting for terminal query replies (probing and key reads)", parse: nil, validate: ->(t : Time::Span) do t > Time::Span.zero end)

Stored in a constant: infers its type from the generic register return, so no type annotation is needed.

OPT_tput_use_buffer = register("tput.use_buffer", true, env: nil, cli: nil, group: nil, description: "Buffer Tput output instead of writing each control sequence immediately", parse: nil, validate: nil)

Stored in a constant: infers its type from the generic register return, so no type annotation is needed.

Class Method Summary

• .keyboard_exclude

  Typed reader.

• .keyboard_exclude=(value)

  Typed writer at Source::Runtime.

• .keyboard_protocol

  Typed reader.

• .keyboard_protocol=(value)

  Typed writer at Source::Runtime.

• .tput_attr_cache_limit

  Typed reader.

• .tput_attr_cache_limit=(value)

  Typed writer at Source::Runtime.

• .tput_probe

  Typed reader.

• .tput_probe=(value)

  Typed writer at Source::Runtime.

• .tput_read_timeout

  Typed reader.

• .tput_read_timeout=(value)

  Typed writer at Source::Runtime.

• .tput_use_buffer

  Typed reader.

• .tput_use_buffer=(value)

  Typed writer at Source::Runtime.

Class Method Detail