ffi-ncurses 0.3.3 → 0.4.0

data/examples/hellowide.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby; coding: utf-8 -*-
+#
+# Sean O'Halpin, 2009-02-15
+#
+require 'ffi-ncurses'
+require 'ffi-ncurses/widechars'
+
+def centre(text)
+  col = (COLS() - WideChars.display_width(text.strip))/2
+  y, x = getyx(stdscr)
+  mvaddstr y, col, text
+end
+
+if RUBY_VERSION >= '1.9.0'
+  def fullwidth(txt)
+    txt.encode("UTF-32BE").codepoints.map{ |x|
+      case x
+      when 0x30..0x7F
+        x + 0xFEE0
+      else
+        x
+      end
+    }.pack("U*")
+  end
+else
+  def fullwidth(txt)
+    txt.unpack("U*").map { |x|
+      case x
+      when 0x30..0x7F
+        x + 0xFEE0
+      else
+        x
+      end
+    }.pack("U*")
+  end
+end
+
+include FFI::NCurses
+begin
+  greeting = ARGV.shift || "World"
+  stdscr = initscr
+  raw
+  keypad stdscr, true
+  noecho
+  curs_set 0
+  clear
+  move (LINES() - 3)/3, 0
+  centre "Hello " + greeting + "\n"
+  centre "你好\n"
+  centre "ＨＥＬＬＯ ＷＯＲＬＤ\n"
+  centre fullwidth("[Testing 1234]\n\n")
+  centre "Press any key to continue"
+  refresh
+  ch = getch
+ensure
+  flushinp
+  endwin
+end

data/examples/keys.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+#
+# Sean O'Halpin, 2009-02-15
+#
+require 'ffi-ncurses'
+include FFI::NCurses
+begin
+  initscr
+  raw
+  keypad stdscr, true
+  noecho
+  curs_set 0
+  ch = 0
+  name = "none"
+  # while ch != 27                # Escape
+  while ch != KEY_CTRL_Q
+    clear
+    addstr "Press any key (Ctrl-Q to exit): "
+    #printw "name: %s dec: %d char: [%c]", :string, name, :int, ch, :int, ch
+    addstr sprintf("name: %s dec: %d char: [%s]", name, ch, (1..127).include?(ch) ? ch.chr : " ")
+    refresh
+    ch = getch
+    name = keyname(ch)
+  end
+ensure
+  endwin
+end

data/examples/{example-mouse.rb → mouse.rb}

@@ -4,7 +4,7 @@
 #
 require 'ffi-ncurses'
 require 'ffi-ncurses/mouse'
-require 'ffi-ncurses/ord-shim'  # for 1.8.6 compatibility
+require 'ffi-ncurses/ord_shim'  # for 1.8.6 compatibility
 
 include FFI::NCurses
 
@@ -13,7 +13,7 @@ begin
   clear
   noecho
   cbreak
-  keypad stdscr, FFI::NCurses::TRUE
+  keypad stdscr, true
 
   # Get all the mouse events
   mousemask(ALL_MOUSE_EVENTS | REPORT_MOUSE_POSITION, nil)

data/examples/multiterm.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/env ruby
+require 'ffi-ncurses'
+
+# newterm2 - how to use more than one terminal at a time
+#
+# Note: ncurses knows nothing about your window manager so cannot
+# switch window focus for you.
+#
+# This is how programmers used to do multi-screen - with more than one
+# physical terminal. Typically, one would be used for input, the other
+# for output.
+#
+# It might be useful for outputting debug info during a program for
+# instance.
+
+def log(*a)
+  File.open("ncurses.log", "a") do |file|
+    file.puts(a.inspect)
+  end
+end
+
+module CLib
+  extend FFI::Library
+  ffi_lib FFI::Library::LIBC
+  # FILE* open and close
+  typedef :pointer, :FILEP
+  attach_function :fdopen, [:int, :string], :FILEP
+  attach_function :fopen, [:string, :string], :FILEP
+  attach_function :fclose, [:FILEP], :int
+  attach_function :feof, [:FILEP], :int
+
+  module FileExt
+    def closed?
+      CLib.feof(self) ? true : false
+    end
+
+    def close
+      if closed?
+        raise IOError, "closed stream"
+      else
+        CLib.fclose(self)
+      end
+    end
+  end
+end
+
+
+def usage
+  abort "usage: #{$0} term1 term2\ne.g. #{$0} /dev/pts/0 /dev/pts/1"
+end
+
+if ARGV.size != 2
+  usage
+end
+term1 = ARGV[0]
+term2 = ARGV[1]
+
+if File.exist?(term1)
+  term1_file = File.open(term1, "rb+")
+  if !term1_file.tty?
+    term1_file.close
+    usage
+  end
+end
+
+if File.exist?(term1)
+  term2_file = File.open(term2, "rb+")
+  if !term2_file.tty?
+    term2_file.close
+    term1_file.close
+    usage
+  end
+end
+
+begin
+  tty1 = CLib.fdopen(term1_file.fileno, "rb+")
+  tty1.extend(CLib::FileExt)
+  tty2 = CLib.fdopen(term2_file.fileno, "rb+")
+  tty2.extend(CLib::FileExt)
+  screen1 = FFI::NCurses.newterm(nil, tty1, tty1)
+  screen2 = FFI::NCurses.newterm(nil, tty2, tty2)
+  FFI::NCurses.noecho
+  [[screen1, "Hello"], [screen2, "World"]].each do |screen, text|
+    old_screen = FFI::NCurses.set_term(screen)
+    FFI::NCurses.curs_set(0)
+    FFI::NCurses.border(*([0]*8))
+    FFI::NCurses.move(4, 4)
+    FFI::NCurses.addstr(text)
+    FFI::NCurses.refresh
+    FFI::NCurses.flushinp
+  end
+  FFI::NCurses.set_term(screen1)
+  FFI::NCurses.curs_set(1)
+  FFI::NCurses.getch
+rescue => e
+  log :e1, e
+ensure
+  begin
+    # Watch the ordering of these calls, i.e. do not call delscreen
+    # before endwin
+    FFI::NCurses.flushinp
+    FFI::NCurses.echo
+
+    # close each terminal
+    [screen2, screen1].each do |screen|
+      FFI::NCurses.set_term(screen)
+      FFI::NCurses.endwin
+      FFI::NCurses.delscreen(screen)
+    end
+  rescue => e
+    log :e2, e
+  ensure
+    # [tty2, tty1] do |fd|
+    #   CLib.fclose(fd)
+    # end
+    [tty2, tty1, term2_file, term1_file].each do |fd|
+      fd.close if !fd.closed? # handle case where tty1 == tty2
+    end
+  end
+end

data/examples/ncurses/LICENSES_for_examples

@@ -0,0 +1,26 @@
+$Id: LICENSES_for_examples,v 1.6 2004/05/13 21:55:17 t-peters Exp $
+
+Ideally, an example program on how to use a library should be in the public
+domain.
+
+Some of the example programs contained in this dircectory have not been put in
+the public domain, however.
+
+The reason is because I did not write all programs completely myself -- I've
+adapted the following example programs from ncurses programs in other
+programming languages, or I have included example programs contributed by
+other authors, and I have to respect their original licenses:
+- rain.rb is adapted from rain.c from the ncurses library distribution.
+- example.rb is adapted from an example program for the python ncurses binding.
+- tclock.rb is adapted from tclock.c from the ncurses library distribution.
+- form.rb anf form2.rb have been written by Simon Kaczor, who has adapted them
+  from sample code from the NCurses Programming HOWTO.
+
+See the comments in the source files for restrictions imposed on copying and
+modifying these.
+
+That said, I suppose you may still look at their source code and learn how
+ncurses programs generally work, as long as you dont start your own programs
+by loading the example program into your editor and modify it to your needs.
+
+Tobias Peters <t-peters@users.berlios.de>

data/examples/{ncurses-example.rb → ncurses/example.rb}

@@ -6,8 +6,8 @@
 # Copyright (C) 2002 Tobias Peters <t-peters@users.berlios.de>
 #
 # The following license applys only to this file. It is less restrictive
-# than the license for the rest of the ncurses-ruby distribution.
-# I've adapted this file from someone else, see below.
+# than the license for the rest of the ncurses-ruby distribution. 
+# I've adapted this file from someone else, see below. 
 #
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this file
@@ -16,10 +16,10 @@
 # publish, distribute, sublicense, and/or sell copies of the Software,
 # and to permit persons to whom the Software is furnished to do so,
 # subject to the following conditions:
-#
+# 
 # The above copyright notice and this permission notice shall be
 # included in all copies or substantial portions of the Software.
-#
+# 
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
@@ -36,7 +36,7 @@
 # statement:
 
 # Copyright (c) 2000 by Harry Henry Gebel
-#
+# 
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this software and associated documentation files
 # (the "Software"), to deal in the Software without restriction,
@@ -44,10 +44,10 @@
 # publish, distribute, sublicense, and/or sell copies of the Software,
 # and to permit persons to whom the Software is furnished to do so,
 # subject to the following conditions:
-#
+# 
 # The above copyright notice and this permission notice shall be
 # included in all copies or substantial portions of the Software.
-#
+# 
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
@@ -57,73 +57,9 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require "ffi-ncurses"
-require 'ffi-ncurses/ord-shim'  # for 1.8.6 compatibility
 
-module NcursesExtension
-  def method_missing(method, *args, &block)
-    FFI::NCurses.send(method, self.win, *args, &block)
-  end
-end
 
-module Ncurses
-  FALSE = 0
-  TRUE = 1
-  module NCX
-    def COLS
-      FFI::NCurses.getmaxx(FFI::NCurses.stdscr)
-    end
-  end
-  include NCX
-  extend NCX
-  class WINDOW
-    attr_accessor :win
-    def initialize(*args, &block)
-      if block_given?
-        @win = args.first
-      else
-        @win = FFI::NCurses.newwin(*args)
-      end
-    end
-    def method_missing(name, *args)
-      name = name.to_s
-      if (name[0,2] == "mv")
-        test_name = name.dup
-        test_name[2,0] = "w" # insert "w" after"mv"
-        if (FFI::NCurses.respond_to?(test_name))
-          return FFI::NCurses.send(test_name, @win, *args)
-        end
-      end
-      test_name = "w" + name
-      if (FFI::NCurses.respond_to?(test_name))
-        return FFI::NCurses.send(test_name, @win, *args)
-      end
-      FFI::NCurses.send(name, @win, *args)
-    end
-    def respond_to?(name)
-      name = name.to_s
-      if (name[0,2] == "mv" && FFI::NCurses.respond_to?("mvw" + name[2..-1]))
-        return true
-      end
-      FFI::NCurses.respond_to?("w" + name) || FFI::NCurses.respond_to?(name)
-    end
-    def del
-      FFI::NCurses.delwin(@win)
-    end
-    alias delete del
-  end
-  def self.initscr
-    @stdscr = Ncurses::WINDOW.new(FFI::NCurses.initscr) { }
-  end
-  def self.stdscr
-    @stdscr
-  end
-  class << self
-    def method_missing(method, *args, &block)
-      FFI::NCurses.send(method, *args, &block)
-    end
-  end
-end
+require "ncurses"
 
 def moving(scr)
   scr.clear() # clear screen
@@ -175,14 +111,11 @@ begin
   Ncurses.cbreak           # provide unbuffered input
   Ncurses.noecho           # turn off input echoing
   Ncurses.nonl             # turn off newline translation
-#   Ncurses.stdscr.intrflush(false) # turn off flush-on-interrupt
-#   Ncurses.stdscr.keypad(true)     # turn on keypad mode
-#   Ncurses.stdscr.addstr("Press a key to continue") # output string
-#   Ncurses.stdscr.getch                             # get a charachter
-  Ncurses.stdscr.intrflush(Ncurses::FALSE) # turn off flush-on-interrupt
-  Ncurses.stdscr.keypad(Ncurses::TRUE)     # turn on keypad mode
-  Ncurses.addstr("Press a key to continue") # output string
-  Ncurses.getch()                             # get a charachter
+  Ncurses.stdscr.intrflush(false) # turn off flush-on-interrupt
+  Ncurses.stdscr.keypad(true)     # turn on keypad mode
+
+  Ncurses.stdscr.addstr("Press a key to continue") # output string
+  Ncurses.stdscr.getch                             # get a charachter
 
   moving(Ncurses.stdscr) # demo of moving cursor
   border(Ncurses.stdscr) # demo of borders

data/examples/ncurses/hello_ncurses.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+# $Id: hello_ncurses.rb,v 1.3 2002/02/28 13:50:03 t-peters Exp $
+
+# this ncurses-ruby program follows an ancient tradition of example
+# computer programs: When invoked, it prints a friendly greeting on the
+# screen and exits.
+#
+# Copyright (C) 2002 Tobias Peters <t-peters@users.berlios.de>
+#
+# You may use, modify, and redistribute this file without restriction.
+
+
+
+# First, we have to tell Ruby to use the Ncurses extension module:
+
+require "ncurses"
+
+
+
+# Second, every program using ncurses must initialize the ncurses library
+# before the first call to any ncurses function:
+
+Ncurses.initscr
+
+
+
+# Now the program can use ncurses facilities for screen output. It will print
+# a greeting to the 5th line on the screen, starting at column 20
+
+Ncurses.mvaddstr(4, 19, "Hello, world!");
+
+# Note that ncurses counts lines and columns starting from 0, and that it
+# expects the line number first and the column number second every time it
+# expects a coordinate pair.
+
+
+
+# The previous function call did not alter the screen at all. Ncurses makes
+# all changes first to an internal buffer. The contents of this buffer is
+# copied to the screen with the following function call:
+
+Ncurses.refresh
+
+
+# Now pause for a short while, enough time for the program user to read the
+# greeting and greet back.
+
+sleep(2.5)
+
+
+# The program has almost finished its task. It only needs to put the screen
+# back to its normal state:
+
+Ncurses.endwin
+
+