123456789_123456789_123456789_123456789_123456789_

Module: Reline::Terminfo

Relationships & Source Files
Namespace Children
Classes:
StringWithTiparm
Exceptions:
TerminfoError
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Fiddle::Importer, Fiddle::Importer
Defined in: lib/reline/terminfo.rb,
lib/reline/terminfo.rb,
lib/reline/terminfo.rb

Class Attribute Summary

Class Method Summary

Class Attribute Details

.enabled? ⇒ Boolean (readonly)

See additional method definition at line 165.

[ GitHub ] 

  


# File 'lib/reline/terminfo.rb', line 171



def self.enabled?
  true
end


  







Class Method Details



  

    .curses_dl  
  

  [ GitHub ]


  

  


# File 'lib/reline/terminfo.rb', line 32



def self.curses_dl
  return @curses_dl unless @curses_dl == false
  if RUBY_VERSION >= '3.0.0'
    # Gem module isn't defined in test-all of the Ruby repository, and
    # Fiddle in Ruby 3.0.0 or later supports Fiddle::TYPE_VARIADIC.
    fiddle_supports_variadic = true
  elsif Fiddle.const_defined?(:VERSION,false) and Gem::Version.create(Fiddle::VERSION) >= Gem::Version.create('1.0.1')
    # Fiddle::TYPE_VARIADIC is supported from Fiddle 1.0.1.
    fiddle_supports_variadic = true
  else
    fiddle_supports_variadic = false
  end
  if fiddle_supports_variadic and not Fiddle.const_defined?(:TYPE_VARIADIC)
    # If the libffi version is not 3.0.5 or higher, there isn't TYPE_VARIADIC.
    fiddle_supports_variadic = false
  end
  if fiddle_supports_variadic
    curses_dl_files.each do |curses_name|
      result = Fiddle::Handle.new(curses_name)
    rescue Fiddle::DLError
      next
    else
      @curses_dl = result
      break
    end
  end
  @curses_dl = nil if @curses_dl == false
  @curses_dl
end


  








  

    .curses_dl_files  
  

  [ GitHub ]


  

  


# File 'lib/reline/terminfo.rb', line 17



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


  








  

    .setupterm(term, fildes)  
  

  [ GitHub ]


  

  


# File 'lib/reline/terminfo.rb', line 94



def self.setupterm(term, fildes)
  errret_int = Fiddle::Pointer.malloc(Fiddle::SIZEOF_INT)
  ret = @setupterm.(term, fildes, errret_int)
  errret = errret_int[0, Fiddle::SIZEOF_INT].unpack1('i')
  case ret
  when 0 # OK
    0
  when -1 # ERR
    case errret
    when 1
      raise TerminfoError.new('The terminal is hardcopy, cannot be used for curses applications.')
    when 0
      raise TerminfoError.new('The terminal could not be found, or that it is a generic type, having too little information for curses applications to run.')
    when -1
      raise TerminfoError.new('The terminfo database could not be found.')
    else # unknown
      -1
    end
  else # unknown
    -2
  end
end


  








  

    .tigetflag(capname)  
  



  

    
  





  
Raises:





  [ GitHub ]


  

  


# File 'lib/reline/terminfo.rb', line 141



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)  
  



  

    
  





  
Raises:





  [ GitHub ]


  

  


# File 'lib/reline/terminfo.rb', line 153



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)  
  



  

    
  





  
Raises:





  [ GitHub ]


  

  


# File 'lib/reline/terminfo.rb', line 123



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)  
  

  [ GitHub ]


  

  


# File 'lib/reline/terminfo.rb', line 133



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