ppcurses 0.0.25 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2f9ab141072907b3d6bc679c399c9e745e67222
-  data.tar.gz: 9eda65b014ddc47fecacc8c75bc5211484532489
+  metadata.gz: 24ac08644952676975408eb133016f10f3a39825
+  data.tar.gz: 0f7536cf358e3e4fce9db59d7eb912a59891d23f
 SHA512:
-  metadata.gz: a55ebcc9d419770924382099751371cacdb0b9fa9cd8a2d8e7fc6cc35d2d432eb2d29087ce907aafea22e00bc78b16c9024b9cc7b42ddcece2fda5390aba0083
-  data.tar.gz: e0d8d21cdcb68e7699d2031e4ff3203c99275df40bbc7e745bf2e04b5e8a36edf7bc785e5ea414bb3efba8ace35021ecad1f17a5756eaf4159779ab0b4d3ed3d
+  metadata.gz: 206b4615b6471629bc3cd087f7bfa5c32e57a42c55db96df5ac6675fd803e3136dc77f087683dadb985fa674cac9bd76c8c006187d07c077cea540fb916ec307
+  data.tar.gz: f62bf00745e11818ab02a52283a81e5251c35e01aaac07d8ded82ac643133cb0c87fbd798987ac1e359dddd4ee4abd6e3fcf9fb5f08ba5724b16dd87421f5700

data/README.rdoc

@@ -1,23 +1,62 @@
-= PPCurses 
+= PPCurses
 
 Some convenience code to initialize curses and some rudimentary GUI classes.  See the **test** directory for example programs.
 
 == Install
-  [sudo] gem install 'ppcurses'
+  gem install 'ppcurses'
+
+  To use ppcurses with a ruby > 2.1.5 you must install the curses gem.
+
+  gem install 'curses'
 
 == Usage
   require 'rubygems'
   require 'ppcurses'
 
-  def displayMenu()
-    mainMenu = PPCurses::Menu.new( [ "Press", "<ESCAPE>", "to Quit" ], nil )
-    mainMenu.show()
-    mainMenu.getMenuSelection() 
-    mainMenu.close()
+  def displayMenu
+    mainMenu = PPCurses::Menu.new( [ "Press", "<ESCAPE>", "to Quit" ])
+    mainMenu.show
+    mainMenu.menu_selection
+    mainMenu.close
   end
   
-  screen = PPCurses::Screen.new()
-  screen.run { displayMenu() }
+  screen = PPCurses::Screen.new
+  screen.run { displayMenu }
+
+== Curses and Ruby
+
+There are several curses implementations for Ruby.
+
+[1. curses]
+
+ This is the implementation that PPCurses uses.  It was originally part of the Ruby
+ standard library and later got pushed out of the standard libary into a gem.
+
+ * http://www.ruby-doc.org/stdlib-1.9.3/libdoc/curses/rdoc/Curses.html
+ * http://www.ruby-doc.org/stdlib-2.0.0/libdoc/curses/rdoc/Curses.html
+ * http://www.ruby-doc.org/stdlib-2.1.0/libdoc/curses/rdoc/Curses.html
+ * https://rubygems.org/gems/curses
+ * https://github.com/ruby/curses
+
+[2. ncurses-ruby]
+
+ The heir to ncurses gem.  It is under active development.
+
+ * https://rubygems.org/gems/ncurses-ruby
+ * https://github.com/eclubb/ncurses-ruby
+
+[3. ncurses]
+
+ Created by Earle Clubb this gem has been frozen at version 0.9.1 since 2004. You
+ probably don't want this gem, you probably want ncurses-ruby.
+
+ * https://rubygems.org/gems/ncurses
+
+[4. ffi-curses]
+
+ A gem that makes curses available through FFI (foreign function interface), by
+ Sean O'Halpin. The latest version is from 2011 (0.4.0).
+
+* https://github.com/seanohalpin/ffi-ncurses
+* https://github.com/ffi/ffi
 
-== References
-http://www.ruby-doc.org/stdlib-1.9.3/libdoc/curses/rdoc/Curses.html

data/lib/ppcurses/Screen.rb

@@ -1,17 +1,136 @@
-# Curses reference:
-# http://www.ruby-doc.org/stdlib-1.9.3/libdoc/curses/rdoc/Curses.html
+module OS
+  def OS.windows?
+    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.mac?
+    (/darwin/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.unix?
+    !OS.windows?
+  end
+
+  def OS.linux?
+    OS.unix? and not OS.mac?
+  end
+end
+
+
+
+module Curses
+
+  #
+  #  Add some methods that allow accessing a window by PPPoint.
+  #
+  class Window
+
+    def cur_point
+      PPCurses::Point.new(curx, cury)
+    end
+
+    def set_pos_by_point( p )
+      setpos(p.y, p.x)
+    end
+
+    def move_to_point( p )
+      move(p.y, p.x)
+    end
+
+  end
+
+end
+
 
-require 'curses'
-include Curses
 
 module PPCurses
 
+
+
   # Screen initializes the Curses screen 
   # Pass a code block to the run method to start things
   #
   # noinspection RubyResolve
   class Screen
 
+
+    def setup_curses
+      Curses.init_screen
+      Curses.raw
+
+      # Can't implement regardless as this can cause an unsupportedOperationException on some configurations
+      #  like cygwin.
+      if OS.unix?
+        Curses.ESCDELAY=0
+      end
+
+
+      #  Otherwise arrow keys, etc can't be read from the main screen and cause the
+      #  program to stop.
+      Curses.stdscr.keypad(true)
+
+      Curses.clear
+      Curses.curs_set(INVISIBLE)
+      Curses.noecho
+      Curses.cbreak
+      Curses.start_color
+    end
+
+    def print_with_attribute( toPrint, attribute )
+      Curses.stdscr.attron( attribute )
+      Curses.stdscr.addstr( toPrint )
+      Curses.stdscr.attroff( attribute )
+    end
+
+    def get_ch
+      Curses.stdscr.getch
+    end
+
+    def width
+      Curses.cols
+    end
+
+    def height
+      Curses.lines
+    end
+
+    def set_pos_by_point( p )
+      setpos(p.y, p.x)
+    end
+
+    def setpos(y, x)
+      Curses.stdscr.setpos(y, x)
+    end
+
+    def attron(attributes)
+      Curses.stdscr.attron(attributes)
+    end
+
+    def attroff(attributes)
+      Curses.stdscr.attroff(attributes)
+    end
+
+    def addstr(string)
+      Curses.stdscr.addstr(string)
+    end
+
+    def getch
+      Curses.stdscr.getch
+    end
+
+    def cur_point
+      PPCurses::Point.new(Curses.stdscr.curx, Curses.stdscr.cury)
+    end
+
+    def curs_set(value)
+      Curses.curs_set(value)
+    end
+
+
+    def shutdown_curses
+      Curses.close_screen
+    end
+
     # Creates a curses session
     #
     # Example:
@@ -19,23 +138,17 @@ module PPCurses
     #
     def run
       begin
-        init_screen
-        Curses.raw
-        clear
-        curs_set(0) # Makes cursor invisible
-        noecho
-        cbreak
-        start_color
-      
-        yield 
+        setup_curses
+
+        return yield
         
       rescue SystemExit, Interrupt
         # Empty Catch block so ruby doesn't puke out
         # a stack trace when CTRL-C is used
       ensure
-        close_screen
+         shutdown_curses
       end
-    end 
+    end
 
   end
 end

data/lib/ppcurses/actions/BaseAction.rb

@@ -1,5 +1,3 @@
-require 'curses'
-
 #noinspection RubyResolve
 module PPCurses
   class BaseAction
@@ -16,6 +14,7 @@ module PPCurses
        2
     end
 
+    # TODO -- need abstraction layer.
     def win_width
       Curses.cols - win_padding
     end

data/lib/ppcurses/actions/GetBooleanAction.rb

@@ -25,17 +25,17 @@ module PPCurses
       # Enables reading arrow keys in getch 
       @win.keypad(true)
       while 1
-        noecho
+        Curses.noecho
         c = @win.getch
 
-        if c == KEY_LEFT then @state = false end
-        if c == KEY_RIGHT then @state = true end
-        if c == 10 then break end
+        if c == Curses::KEY_LEFT then @state = false end
+        if c == Curses::KEY_RIGHT then @state = true end
+        if c == ESCAPE then break end
 
-        echo
+        Curses.echo
         print_prompt
       end
-      echo
+      Curses.echo
     end
 
     def data

data/lib/ppcurses/actions/GetDataAction.rb

@@ -46,7 +46,7 @@ class GetDataAction < BaseAction
 
   def execute
     create_window
-    echo
+    Curses.echo
 
     @win.setpos(@win.cury, x_padding )
 
@@ -58,7 +58,7 @@ class GetDataAction < BaseAction
 
     self.after_actions
 
-    noecho
+    Curses.noecho
     @win.clear 
     @win.refresh
     @win.close
@@ -71,14 +71,14 @@ class GetDataAction < BaseAction
   end
 
   def print_success_line(string)
-    init_pair(1, COLOR_GREEN, COLOR_BLACK)
+    Curses.init_pair(1, COLOR_GREEN, COLOR_BLACK)
     @win.attron(color_pair(1))
     self.print_line(string)
     @win.attroff(color_pair(1))
   end
 
   def print_error_line(string)
-    init_pair(1, COLOR_RED, COLOR_BLACK)
+    Curses.init_pair(1, COLOR_RED, COLOR_BLACK)
     @win.attron(color_pair(1))
     self.print_line(string)
     @win.attroff(color_pair(1))

data/lib/ppcurses/actions/GetEnumeratedStringAction.rb

@@ -37,20 +37,20 @@ module PPCurses
       # Enables reading arrow keys in getch 
       @win.keypad(true)
       while 1
-        noecho
+        Curses.noecho
         c = @win.getch
 
-        if c == KEY_LEFT then @current_option = @current_option-1 end
-        if c == KEY_RIGHT then @current_option = @current_option+1 end
-        if c == 10 then break end
+        if c == Curses::KEY_LEFT then @current_option = @current_option-1 end
+        if c == Curses::KEY_RIGHT then @current_option = @current_option+1 end
+        if c == ESCAPE then break end
 
         if @current_option < 0 then @current_option = @options.length-1 end
         if @current_option > @options.length-1 then @current_option = 0 end
 
-        echo
+        Curses.echo
         print_prompt
       end
-      echo
+      Curses.echo
       # Go to next line so that further actions to overwrite
       # the choice
       @win.setpos(@win.cury + 1, x_padding)

data/lib/ppcurses/actions/GetIntegerAction.rb

@@ -13,9 +13,9 @@ module PPCurses
        @win.clrtoeol
        @win.box('|', '-')
        @win.addstr(@prompt)
-       echo
+       Curses.echo
        @data = @win.getstr
-       noecho
+       Curses.noecho
      end until @data =~ /^\d+$/
     end
 

data/lib/ppcurses/actions/GetStringAction.rb

@@ -1,6 +1,8 @@
 require_relative 'PromptAction.rb'
 
 module PPCurses
+
+  # Deprecated:  Use a form with an input_element.
   class GetStringAction < PromptAction
   end
 end

data/lib/ppcurses/actions/PromptAction.rb

@@ -27,9 +27,9 @@ module PPCurses
 
     def execute
       print_prompt
-      echo
+      Curses.echo
       @data = @win.getstr
-      noecho
+      Curses.noecho
     end
 
     def data

data/lib/ppcurses/application.rb

@@ -0,0 +1,219 @@
+module PPCurses
+
+  # Based on the Cocoa NSResponder
+  #
+  # Current link, which probably won't be valid in the future ...
+  #
+  # https://developer.apple.com/library/mac/documentation/Cocoa/Reference/ApplicationKit/Classes/NSResponder_Class/index.html#//apple_ref/occ/instp/NSResponder/menu
+  #
+  class Responder
+
+    attr_accessor :next_responder
+
+    #
+    # Whether the responder accepts first responder status.
+    #
+    # As first responder, the receiver is the first object in the responder chain to be sent key events
+    # and action messages. By default, this property is NO. Subclasses set this property to YES if the
+    # receiver accepts first responder status.
+    #
+    def accepts_first_responder
+      NO
+    end
+
+    #
+    # Notifies the receiver that it’s about to become first responder
+    #
+    # The default implementation returns YES, accepting first responder status. Subclasses can override
+    # this method to update state or perform some action such as highlighting the selection, or to
+    # return NO, refusing first responder status.
+    #
+    def become_first_responder
+      YES
+    end
+
+    #
+    # Notifies the receiver that it’s been asked to relinquish its status as first responder in its window.
+    #
+    # The default implementation returns YES, resigning first responder status. Subclasses can override
+    # this method to update state or perform some action such as unhighlighting the selection, or to
+    # return NO, refusing to relinquish first responder status.
+    #
+    def resign_first_responder
+      YES
+    end
+
+    #
+    # Informs the receiver that the user has pressed a key.
+    #
+    # The default implementation simply passes this message to the next responder.
+    #
+    def key_down( key )
+      @next_responder.key_down(key) unless @next_responder.nil?
+    end
+
+    def Responder.isa( obj )
+      PPCurses.implements_protocol( obj, %w(accepts_first_responder become_first_responder resign_first_responder key_down))
+    end
+
+  end
+
+#=======================================================================================================================
+  #
+  # Derived from methods defined in Cocoa NSWindow
+  #
+  # Current link, which probably won't be valid in the future ...
+  #
+  # https://developer.apple.com/library/mac/documentation/Cocoa/Reference/ApplicationKit/Classes/NSWindow_Class/index.html#//apple_ref/occ/instm/NSWindow
+  #
+  class ResponderManager < Responder
+
+    # The first responder is the first object in a responder chain to receive an event or action message.
+    attr_accessor :first_responder
+
+    def accepts_first_responder
+      YES
+    end
+
+    #
+    # Attempts to make a given responder the first responder
+    #
+    #
+    # If responder isn’t already the first responder, this method first sends a resign_first_responder message
+    # to the object that is the first responder. If that object refuses to resign, it remains the first responder,
+    # and this method immediately returns NO. If the current first responder resigns, this method sends a
+    # become_first_responder message to responder.
+    #
+    # If responder does not accept first responder status, the ResponderManager becomes first responder; in
+    # this case, the method returns YES even if the responder refused first responder status.
+    #
+    # If responder is nil, this method still sends resign_first_responder to the current first responder.
+    #
+    def make_first_responder( responder )
+
+      Responder.isa(responder) unless responder.nil?
+
+      if responder != @first_responder
+        will_resign = responder.resign_first_responder
+        unless will_resign
+          return NO
+        end
+      end
+
+      @first_responder = nil
+
+      accepted = NO
+      will_accept = responder.accepts_first_responder
+
+      if will_accept
+        accepted = responder.become_first_responder
+      end
+
+      unless accepted
+        @first_responder = self
+        return YES
+      end
+
+      @first_responder = responder
+
+      YES
+    end
+
+
+  end
+
+#=======================================================================================================================
+
+  # noinspection RubyClassVariableUsageInspection
+  class Application < ResponderManager
+
+    @@shared_app
+
+    attr_accessor :main_menu
+
+    # Any object of type PPCurses:View
+    attr_accessor :content_view
+
+    def initialize
+      @screen = PPCurses::Screen.new
+
+      @main_menu = create_default_menubar
+      @next_responder = @main_menu
+
+      @@shared_app = self
+      @terminated = false
+    end
+
+
+    def content_view=(value)
+      @content_view=value
+      @main_menu.next_responder=@content_view
+    end
+
+    def create_default_menubar
+      menubar = PPCurses::MenuBar.new
+
+      quit_item = PPCurses::MenuBarItem.new('q', 'Quit')
+      quit_item.action = method(:terminate)
+      menubar.add_menu_item(quit_item)
+
+      menubar
+    end
+
+
+    # Informal protocol
+    # A delegate receives notifications if and only if a method is defined
+    #
+    # applicationDidFinishLaunching
+    # applicationShouldTerminate
+    #
+    def set_delegate (delegate)
+      @delegate = delegate
+    end
+
+
+    def launch
+      @screen.setup_curses
+      if @delegate.respond_to?(:applicationDidFinishLaunching)
+        @delegate.applicationDidFinishLaunching(self)
+      end
+
+      until @terminated
+        # TODO - switch show to display?
+        @main_menu.show(@screen) unless @main_menu.nil?
+
+        # TODO -- pass a subview of the screen.
+        @content_view.display(@screen) unless @content_view.nil?
+
+        c = @screen.get_ch
+        key_down(c)
+      end
+
+      @screen.shutdown_curses
+
+    end
+
+    def terminate
+
+      # Cocoa returns an NSApplicationTerminateReply which can
+      # be a cancel, now or later response.  Simply support a boolean
+      # for now.
+      if @delegate.respond_to?(:applicationShouldTerminate)
+        should_terminate = @delegate.applicationShouldTerminate(self)
+        unless should_terminate
+          return
+        end
+      end
+
+      @terminated = true
+    end
+
+    def Application.sharedApplication
+      @@shared_app
+    end
+
+
+
+  end
+
+end