module Reline::Terminfo - Documentation for Ruby 3.3

# module Reline::Terminfo

### Public Class Methods

curses_dl() click to toggle source

    # File lib/reline/terminfo.rb, line 9
    def self.curses_dl
      false
    end

curses_dl_files() click to toggle source

    # File lib/reline/terminfo.rb, line 22
    def self.curses_dl_files
      case RUBY_PLATFORM
      when /mingw/, /mswin/
        # aren't supported
        []
      when /cygwin/
        %w[cygncursesw-10.dll cygncurses-10.dll]
      when /darwin/
        %w[libncursesw.dylib libcursesw.dylib libncurses.dylib libcurses.dylib]
      else
        %w[libncursesw.so libcursesw.so libncurses.so libcurses.so]
      end
    end

enabled?() click to toggle source

NOTE: This means `Fiddle` and curses are enabled.

    # File lib/reline/terminfo.rb, line 145
    def self.enabled?
      true
    end

setupterm(term, fildes) click to toggle source

    # File lib/reline/terminfo.rb, line 85
    def self.setupterm(term, fildes)
      errret_int = Fiddle::Pointer.malloc(Fiddle::SIZEOF_INT, Fiddle::RUBY_FREE)
      ret = @setupterm.(term, fildes, errret_int)
      case ret
      when 0 # OK
        @term_supported = true
      when -1 # ERR
        @term_supported = false
      end
    end

term_supported?() click to toggle source

    # File lib/reline/terminfo.rb, line 149
    def self.term_supported?
      @term_supported
    end

tigetflag(capname) click to toggle source

    # File lib/reline/terminfo.rb, line 120
    def self.tigetflag(capname)
      raise TerminfoError, "capname is not String: #{capname.inspect}" unless capname.is_a?(String)
      flag = @tigetflag.(capname).to_i
      case flag
      when -1
        raise TerminfoError, "not boolean capability: #{capname}"
      when 0
        raise TerminfoError, "can't find capability: #{capname}"
      end
      flag
    end

tigetnum(capname) click to toggle source

    # File lib/reline/terminfo.rb, line 132
    def self.tigetnum(capname)
      raise TerminfoError, "capname is not String: #{capname.inspect}" unless capname.is_a?(String)
      num = @tigetnum.(capname).to_i
      case num
      when -2
        raise TerminfoError, "not numeric capability: #{capname}"
      when -1
        raise TerminfoError, "can't find capability: #{capname}"
      end
      num
    end

tigetstr(capname) click to toggle source

    # File lib/reline/terminfo.rb, line 102
    def self.tigetstr(capname)
      raise TerminfoError, "capname is not String: #{capname.inspect}" unless capname.is_a?(String)
      capability = @tigetstr.(capname)
      case capability.to_i
      when 0, -1
        raise TerminfoError, "can't find capability: #{capname}"
      end
      StringWithTiparm.new(capability.to_s)
    end

tiparm(str, *args) click to toggle source

    # File lib/reline/terminfo.rb, line 112
    def self.tiparm(str, *args)
      new_args = []
      args.each do |a|
        new_args << Fiddle::TYPE_INT << a
      end
      @tiparm.(str, *new_args).to_s
    end