ffi-ncurses 0.3.0

data/lib/ffi-ncurses/darwin.rb

@@ -0,0 +1,215 @@
+module FFI
+  module NCurses
+    module Darwin
+      NCURSES_SIZE_T = :short
+      NCURSES_ATTR_T = :int
+      NCURSES_COLOR_T = :short
+      NCURSES_CH_T = :short
+
+      CHTYPE = :ulong
+      CCHARW_MAX = 5
+
+      BOOLEAN = :uchar              # sizeof(bool) == 1
+
+      WCHAR_T = :ushort
+      
+      #   class CCharT < FFI::Struct
+      #     layout \
+      #     :attr, NCURSES_ATTR_T,
+      #     :chars, [WCHAR_T, CCHARW_MAX]
+      #   end
+
+      class PDat < FFI::Struct
+        layout \
+        :_pad_y, NCURSES_SIZE_T,
+        :_pad_x, NCURSES_SIZE_T,
+        :_pad_top, NCURSES_SIZE_T,
+        :_pad_left, NCURSES_SIZE_T,
+        :_pad_bottom, NCURSES_SIZE_T,
+        :_pad_right, NCURSES_SIZE_T
+      end
+
+      class WinSt < FFI::Struct
+        layout \
+        :_cury, NCURSES_SIZE_T,
+        :_curx, NCURSES_SIZE_T,
+        :_maxy, NCURSES_SIZE_T,
+        :_maxx, NCURSES_SIZE_T,
+        :_begy, NCURSES_SIZE_T,
+        :_begx, NCURSES_SIZE_T,
+        :_flags, :short,
+        :_attrs, NCURSES_ATTR_T,
+        :_bkgd, CHTYPE,
+        :_notimeout, BOOLEAN,
+        :_clear, BOOLEAN,
+        :_leaveok, BOOLEAN,
+        :_scroll, BOOLEAN,
+        :_idlok, BOOLEAN,
+        :_idcok, BOOLEAN,
+        :_immed, BOOLEAN,
+        :_sync, BOOLEAN,
+        :_use_keypad, BOOLEAN,
+        :_delay, :int,
+
+        # struct ldat *_line
+        :_line, :pointer,
+
+        :_regtop, NCURSES_SIZE_T,
+        :_regbottom, NCURSES_SIZE_T,
+
+        # why x,y when everything else is y,x?
+        :_parx, :int,
+        :_pary, :int,
+        :_parent, :pointer          # WINDOW
+
+        # don't know how to include nested Struct yet
+        #     :_pad, PDat,
+        
+        #     :_yoffset, NCURSES_SIZE_T
+        #     :_bkgrnd, CCharT
+      end
+
+      # translated from Mac OSX 10.4 ('Tiger') /usr/include/ncurses.h
+      def getattrs(win)
+        win_st = WinSt.new(win)
+        win ? win_st[:_attrs] : A_NORMAL
+      end
+      def getcurx(win)
+        win_st = WinSt.new(win)
+        win ? win_st[:_curx] : ERR
+      end
+      def getcury(win)
+        win_st = WinSt.new(win)
+        win ? win_st[:_cury] : ERR
+      end
+      def getbegx(win)
+        win_st = WinSt.new(win)
+        win ? win_st[:_begx] : ERR
+      end
+      def getbegy(win)
+        win_st = WinSt.new(win)
+        win ? win_st[:_begy] : ERR
+      end
+      def getmaxx(win)
+        win_st = WinSt.new(win)
+        win ? win_st[:_maxx] + 1 : ERR
+      end
+      def getmaxy(win)
+        win_st = WinSt.new(win)
+        win ? win_st[:_maxy] + 1 : ERR
+      end
+      def getparx(win)
+        win_st = WinSt.new(win)
+        win ? win_st[:_parx] : ERR
+      end
+      def getpary(win)
+        win_st = WinSt.new(win)
+        win ? win_st[:_pary] : ERR
+      end
+
+      def _win(win, member)
+        win && WinSt.new(win)[member]
+      end
+      private :_win
+      
+      # extensions - not in X/Open
+      def is_cleared(win)
+        _win(win, :_clear)
+      end
+      def is_idcok(win)
+        _win(win, :_idcok)
+      end
+      def is_idlok(win)
+        _win(:win, :_idlok)
+      end
+      def is_immedok(win)
+        _win(win, :_immed)
+      end
+      def is_keypad(win)
+        _win(win, :_use_keypad)
+      end
+      def is_leaveok(win)
+        _win(win, :_leaveok) || ERR
+      end
+      def is_nodelay(win)
+        _win(win, :_delay) == 0 ? FFI::NCurses::TRUE : FFI::NCurses::FALSE
+      end
+      def is_notimeout(win)
+        _win(win, :_notimeout)
+      end
+      def is_scrollok(win)
+        _win(win, :_scroll)
+      end
+      def is_syncok(win)
+        _win(win, :_sync)
+      end
+      def wgetparent(win)
+        _win(win, :_parent)
+      end
+      def wgetscrreg(win, t, b)
+        # ((win) ? (*(t) = (win)->_regtop, *(b) = (win)->_regbottom, OK) : ERR)
+        # not entirely satisfactory - no error return
+        # should I raise an exception?
+        if win
+          win_st = WinSt.new(win)
+          [win_st[:_regtop], win_st[:_regbottom]]
+        else
+          #raise ArgumentError, "win is nil"
+          nil
+        end
+      end
+    end
+
+    # struct _win_st
+    # {
+    # 	NCURSES_SIZE_T _cury, _curx; /* current cursor position */
+
+    # 	/* window location and size */
+    # 	NCURSES_SIZE_T _maxy, _maxx; /* maximums of x and y, NOT window size */
+    # 	NCURSES_SIZE_T _begy, _begx; /* screen coords of upper-left-hand corner */
+
+    # 	short   _flags;		/* window state flags */
+
+    # 	/* attribute tracking */
+    # 	attr_t  _attrs;		/* current attribute for non-space character */
+    # 	chtype  _bkgd;		/* current background char/attribute pair */
+
+    # 	/* option values set by user */
+    # 	bool	_notimeout;	/* no time out on function-key entry? */
+    # 	bool	_clear;		/* consider all data in the window invalid? */
+    # 	bool	_leaveok;	/* OK to not reset cursor on exit? */
+    # 	bool	_scroll;	/* OK to scroll this window? */
+    # 	bool	_idlok;		/* OK to use insert/delete line? */
+    # 	bool	_idcok;		/* OK to use insert/delete char? */
+    # 	bool	_immed;		/* window in immed mode? (not yet used) */
+    # 	bool	_sync;		/* window in sync mode? */
+    # 	bool	_use_keypad;	/* process function keys into KEY_ symbols? */
+    # 	int	_delay;		/* 0 = nodelay, <0 = blocking, >0 = delay */
+
+    # 	struct ldat *_line;	/* the actual line data */
+
+    # 	/* global screen state */
+    # 	NCURSES_SIZE_T _regtop;	/* top line of scrolling region */
+    # 	NCURSES_SIZE_T _regbottom; /* bottom line of scrolling region */
+
+    # 	/* these are used only if this is a sub-window */
+    # 	int	_parx;		/* x coordinate of this window in parent */
+    # 	int	_pary;		/* y coordinate of this window in parent */
+    # 	WINDOW	*_parent;	/* pointer to parent if a sub-window */
+
+    # 	/* these are used only if this is a pad */
+    # 	struct pdat
+    # 	{
+    # 	    NCURSES_SIZE_T _pad_y,      _pad_x;
+    # 	    NCURSES_SIZE_T _pad_top,    _pad_left;
+    # 	    NCURSES_SIZE_T _pad_bottom, _pad_right;
+    # 	} _pad;
+
+    # 	NCURSES_SIZE_T _yoffset; /* real begy is _begy + _yoffset */
+
+    # #ifdef _XOPEN_SOURCE_EXTENDED
+    # 	cchar_t  _bkgrnd;	/* current background char/attribute pair */
+    # #endif
+    # };
+  end
+end

data/lib/ffi-ncurses/keydefs.rb

@@ -0,0 +1,106 @@
+module NCurses
+  KEY_CODE_YES  = 0400 # A wchar_t contains a key code 
+  KEY_MIN       = 0401 # Minimum curses key 
+  KEY_BREAK     = 0401 # Break key (unreliable) 
+  KEY_SRESET    = 0530 # Soft (partial) reset (unreliable) 
+  KEY_RESET     = 0531 # Reset or hard reset (unreliable) 
+
+  KEY_DOWN      = 0402 # down-arrow key 
+  KEY_UP        = 0403 # up-arrow key 
+  KEY_LEFT      = 0404 # left-arrow key 
+  KEY_RIGHT     = 0405 # right-arrow key 
+  KEY_HOME      = 0406 # home key 
+  KEY_BACKSPACE = 0407 # backspace key 
+  KEY_F0        = 0410 # Function keys.  Space for 64 
+  
+  # Value of function key n 
+  def KEY_F(n)
+    (KEY_F0+(n))
+  end
+
+  KEY_DL        = 0510 # delete-line key 
+  KEY_IL        = 0511 # insert-line key 
+  KEY_DC        = 0512 # delete-character key 
+  KEY_IC        = 0513 # insert-character key 
+  KEY_EIC       = 0514 # sent by rmir or smir in insert mode 
+  KEY_CLEAR     = 0515 # clear-screen or erase key 
+  KEY_EOS       = 0516 # clear-to-end-of-screen key 
+  KEY_EOL       = 0517 # clear-to-end-of-line key 
+  KEY_SF        = 0520 # scroll-forward key 
+  KEY_SR        = 0521 # scroll-backward key 
+  KEY_NPAGE     = 0522 # next-page key 
+  KEY_PPAGE     = 0523 # previous-page key 
+  KEY_STAB      = 0524 # set-tab key 
+  KEY_CTAB      = 0525 # clear-tab key 
+  KEY_CATAB     = 0526 # clear-all-tabs key 
+  KEY_ENTER     = 0527 # enter/send key 
+  KEY_PRINT     = 0532 # print key 
+  KEY_LL        = 0533 # lower-left key (home down) 
+  KEY_A1        = 0534 # upper left of keypad 
+  KEY_A3        = 0535 # upper right of keypad 
+  KEY_B2        = 0536 # center of keypad 
+  KEY_C1        = 0537 # lower left of keypad 
+  KEY_C3        = 0540 # lower right of keypad 
+  KEY_BTAB      = 0541 # back-tab key 
+  KEY_BEG       = 0542 # begin key 
+  KEY_CANCEL    = 0543 # cancel key 
+  KEY_CLOSE     = 0544 # close key 
+  KEY_COMMAND   = 0545 # command key 
+  KEY_COPY      = 0546 # copy key 
+  KEY_CREATE    = 0547 # create key 
+  KEY_END       = 0550 # end key 
+  KEY_EXIT      = 0551 # exit key 
+  KEY_FIND      = 0552 # find key 
+  KEY_HELP      = 0553 # help key 
+  KEY_MARK      = 0554 # mark key 
+  KEY_MESSAGE   = 0555 # message key 
+  KEY_MOVE      = 0556 # move key 
+  KEY_NEXT      = 0557 # next key 
+  KEY_OPEN      = 0560 # open key 
+  KEY_OPTIONS   = 0561 # options key 
+  KEY_PREVIOUS  = 0562 # previous key 
+  KEY_REDO      = 0563 # redo key 
+  KEY_REFERENCE = 0564 # reference key 
+  KEY_REFRESH   = 0565 # refresh key 
+  KEY_REPLACE   = 0566 # replace key 
+  KEY_RESTART   = 0567 # restart key 
+  KEY_RESUME    = 0570 # resume key 
+  KEY_SAVE      = 0571 # save key 
+  KEY_SBEG      = 0572 # shifted begin key 
+  KEY_SCANCEL   = 0573 # shifted cancel key 
+  KEY_SCOMMAND  = 0574 # shifted command key 
+  KEY_SCOPY     = 0575 # shifted copy key 
+  KEY_SCREATE   = 0576 # shifted create key 
+  KEY_SDC       = 0577 # shifted delete-character key 
+  KEY_SDL       = 0600 # shifted delete-line key 
+  KEY_SELECT    = 0601 # select key 
+  KEY_SEND      = 0602 # shifted end key 
+  KEY_SEOL      = 0603 # shifted clear-to-end-of-line key 
+  KEY_SEXIT     = 0604 # shifted exit key 
+  KEY_SFIND     = 0605 # shifted find key 
+  KEY_SHELP     = 0606 # shifted help key 
+  KEY_SHOME     = 0607 # shifted home key 
+  KEY_SIC       = 0610 # shifted insert-character key 
+  KEY_SLEFT     = 0611 # shifted left-arrow key 
+  KEY_SMESSAGE  = 0612 # shifted message key 
+  KEY_SMOVE     = 0613 # shifted move key 
+  KEY_SNEXT     = 0614 # shifted next key 
+  KEY_SOPTIONS  = 0615 # shifted options key 
+  KEY_SPREVIOUS = 0616 # shifted previous key 
+  KEY_SPRINT    = 0617 # shifted print key 
+  KEY_SREDO     = 0620 # shifted redo key 
+  KEY_SREPLACE  = 0621 # shifted replace key 
+  KEY_SRIGHT    = 0622 # shifted right-arrow key 
+  KEY_SRSUME    = 0623 # shifted resume key 
+  KEY_SSAVE     = 0624 # shifted save key 
+  KEY_SSUSPEND  = 0625 # shifted suspend key 
+  KEY_SUNDO     = 0626 # shifted undo key 
+  KEY_SUSPEND   = 0627 # suspend key 
+  KEY_UNDO      = 0630 # undo key 
+  KEY_MOUSE     = 0631 # Mouse event has occurred 
+  KEY_RESIZE    = 0632 # Terminal resize event 
+  KEY_EVENT     = 0633 # We were interrupted by an event 
+
+  KEY_MAX       = 0777 # Maximum key value is 0633 
+
+end

data/lib/ffi-ncurses/mouse.rb

@@ -0,0 +1,146 @@
+require 'ffi-ncurses'
+module FFI
+  module NCurses
+
+    NCURSES_MOUSE_VERSION = 1
+
+    # mouse interface 
+
+    if NCURSES_MOUSE_VERSION > 1
+      def self.NCURSES_MOUSE_MASK(b,m)
+        ((m) << (((b) - 1) * 5))
+      end
+    else
+      def self.NCURSES_MOUSE_MASK(b,m)
+        ((m) << (((b) - 1) * 6))
+      end
+    end
+
+    NCURSES_BUTTON_RELEASED	= 001
+    NCURSES_BUTTON_PRESSED	= 002
+    NCURSES_BUTTON_CLICKED	= 004
+    NCURSES_DOUBLE_CLICKED  = 010
+    NCURSES_TRIPLE_CLICKED	= 020
+    NCURSES_RESERVED_EVENT	= 040
+
+    # event masks 
+    BUTTON1_RELEASED        = NCURSES_MOUSE_MASK(1, NCURSES_BUTTON_RELEASED)
+    BUTTON1_PRESSED         = NCURSES_MOUSE_MASK(1, NCURSES_BUTTON_PRESSED)
+    BUTTON1_CLICKED         = NCURSES_MOUSE_MASK(1, NCURSES_BUTTON_CLICKED)
+    BUTTON1_DOUBLE_CLICKED  = NCURSES_MOUSE_MASK(1, NCURSES_DOUBLE_CLICKED)
+    BUTTON1_TRIPLE_CLICKED  = NCURSES_MOUSE_MASK(1, NCURSES_TRIPLE_CLICKED)
+
+    BUTTON2_RELEASED        = NCURSES_MOUSE_MASK(2, NCURSES_BUTTON_RELEASED)
+    BUTTON2_PRESSED         = NCURSES_MOUSE_MASK(2, NCURSES_BUTTON_PRESSED)
+    BUTTON2_CLICKED         = NCURSES_MOUSE_MASK(2, NCURSES_BUTTON_CLICKED)
+    BUTTON2_DOUBLE_CLICKED  = NCURSES_MOUSE_MASK(2, NCURSES_DOUBLE_CLICKED)
+    BUTTON2_TRIPLE_CLICKED  = NCURSES_MOUSE_MASK(2, NCURSES_TRIPLE_CLICKED)
+
+    BUTTON3_RELEASED        = NCURSES_MOUSE_MASK(3, NCURSES_BUTTON_RELEASED)
+    BUTTON3_PRESSED         = NCURSES_MOUSE_MASK(3, NCURSES_BUTTON_PRESSED)
+    BUTTON3_CLICKED         = NCURSES_MOUSE_MASK(3, NCURSES_BUTTON_CLICKED)
+    BUTTON3_DOUBLE_CLICKED  = NCURSES_MOUSE_MASK(3, NCURSES_DOUBLE_CLICKED)
+    BUTTON3_TRIPLE_CLICKED  = NCURSES_MOUSE_MASK(3, NCURSES_TRIPLE_CLICKED)
+
+    BUTTON4_RELEASED        = NCURSES_MOUSE_MASK(4, NCURSES_BUTTON_RELEASED)
+    BUTTON4_PRESSED         = NCURSES_MOUSE_MASK(4, NCURSES_BUTTON_PRESSED)
+    BUTTON4_CLICKED         = NCURSES_MOUSE_MASK(4, NCURSES_BUTTON_CLICKED)
+    BUTTON4_DOUBLE_CLICKED  = NCURSES_MOUSE_MASK(4, NCURSES_DOUBLE_CLICKED)
+    BUTTON4_TRIPLE_CLICKED  = NCURSES_MOUSE_MASK(4, NCURSES_TRIPLE_CLICKED)
+
+    #
+    # In 32 bits the version-1 scheme does not provide enough space for a 5th
+    # button, unless we choose to change the ABI by omitting the reserved-events.
+    #
+    
+    if NCURSES_MOUSE_VERSION > 1
+
+      BUTTON5_RELEASED       = NCURSES_MOUSE_MASK(5, NCURSES_BUTTON_RELEASED)
+      BUTTON5_PRESSED        = NCURSES_MOUSE_MASK(5, NCURSES_BUTTON_PRESSED)
+      BUTTON5_CLICKED        = NCURSES_MOUSE_MASK(5, NCURSES_BUTTON_CLICKED)
+      BUTTON5_DOUBLE_CLICKED = NCURSES_MOUSE_MASK(5, NCURSES_DOUBLE_CLICKED)
+      BUTTON5_TRIPLE_CLICKED = NCURSES_MOUSE_MASK(5, NCURSES_TRIPLE_CLICKED)
+      
+      BUTTON_CTRL            = NCURSES_MOUSE_MASK(6, 0001)
+      BUTTON_SHIFT					 = NCURSES_MOUSE_MASK(6, 0002)
+      BUTTON_ALT						 = NCURSES_MOUSE_MASK(6, 0004)
+      REPORT_MOUSE_POSITION	 = NCURSES_MOUSE_MASK(6, 0010)
+
+    else
+
+      BUTTON1_RESERVED_EVENT = NCURSES_MOUSE_MASK(1, NCURSES_RESERVED_EVENT)
+      BUTTON2_RESERVED_EVENT = NCURSES_MOUSE_MASK(2, NCURSES_RESERVED_EVENT)
+      BUTTON3_RESERVED_EVENT = NCURSES_MOUSE_MASK(3, NCURSES_RESERVED_EVENT)
+      BUTTON4_RESERVED_EVENT = NCURSES_MOUSE_MASK(4, NCURSES_RESERVED_EVENT)
+
+      BUTTON_CTRL            = NCURSES_MOUSE_MASK(5, 0001)
+      BUTTON_SHIFT					 = NCURSES_MOUSE_MASK(5, 0002)
+      BUTTON_ALT						 = NCURSES_MOUSE_MASK(5, 0004)
+      REPORT_MOUSE_POSITION	 = NCURSES_MOUSE_MASK(5, 0010)
+
+    end
+
+    ALL_MOUSE_EVENTS = (REPORT_MOUSE_POSITION - 1)
+
+    class << self
+      # macros to extract single event-bits from masks 
+      def	BUTTON_RELEASE(e, x)
+        ((e) & (001 << (6 * ((x) - 1))))
+      end
+      def	BUTTON_PRESS(e, x)
+        ((e) & (002 << (6 * ((x) - 1))))
+      end
+      def	BUTTON_CLICK(e, x)
+        ((e) & (004 << (6 * ((x) - 1))))
+      end
+      def	BUTTON_DOUBLE_CLICK(e, x)
+        ((e) & (010 << (6 * ((x) - 1))))
+      end
+      def	BUTTON_TRIPLE_CLICK(e, x)
+        ((e) & (020 << (6 * ((x) - 1))))
+      end
+      def	BUTTON_RESERVED_EVENT(e, x)
+        ((e) & (040 << (6 * ((x) - 1))))
+      end
+
+      #     if NCURSES_MOUSE_VERSION > 1
+      #       def NCURSES_MOUSE_MASK(b,m)
+      #         ((m) << (((b) - 1) * 5))
+      #       end
+      #     else
+      #       def NCURSES_MOUSE_MASK(b,m)
+      #         ((m) << (((b) - 1) * 6))
+      #       end
+      #     end
+    end
+
+    #   def mouse_trafo(y, x, to_screen)
+    #   end
+    
+    KEY_MOUSE =	0631		# Mouse event has occurred
+
+    #FFI.add_typedef :ulong, :mmask_t
+    class MEVENT < FFI::Struct
+      layout :id, :short,
+      :x, :int,
+      :y, :int,
+      :z, :int,
+      #    :bstate, :mmask_t
+      :bstate, :ulong
+    end
+
+    functions =
+      [
+       [:getmouse, [MEVENT], :int],
+       [:ungetmouse, [MEVENT], :int],
+      ]
+    
+    functions.each do |function|
+      begin
+        attach_function(*function)
+      rescue Object => e
+        (@unattached_functions ||= []) << function
+      end
+    end
+  end
+end