termkit 0.0.0 → 0.1.0

data/lib/termkit/app/app_ui.rb

@@ -0,0 +1,153 @@
+
+module TheFox
+	module TermKit
+		
+		class UIApp < App
+			
+			attr_accessor :app_controller
+			attr_accessor :active_controller
+			
+			def initialize
+				super()
+				
+				#puts 'UIApp initialize'
+				
+				@render_count = 0
+				@app_controller = nil
+				@active_controller = nil
+				
+				ui_init
+			end
+			
+			##
+			# See App `run_cycle()` method.
+			def run_cycle
+				super()
+				
+				#puts 'UIApp->run_cycle'
+				
+				render
+			end
+			
+			def set_app_controller(app_controller)
+				if !app_controller.is_a?(AppController)
+					raise ArgumentError, "Argument is not a AppController -- #{app_controller.class} given"
+				end
+				
+				@app_controller = app_controller
+			end
+			
+			def set_active_controller(active_controller)
+				if !active_controller.is_a?(ViewController)
+					raise ArgumentError, "Argument is not a ViewController -- #{active_controller.class} given"
+				end
+				
+				if !@active_controller.nil?
+					@active_controller.inactive
+				end
+				
+				@active_controller = active_controller
+				@active_controller.active
+			end
+			
+			##
+			# Handles the actual rendering and drawing of the UI layer. Calls `draw_point()` for all points of `@active_controller`.
+			def render
+				#sleep 1 # @TODO: remove this line
+				
+				area = nil # @TODO: use current terminal size as area
+				
+				@render_count += 1
+				# @logger.debug("--- RENDER: #{@render_count} ---")
+				if !@active_controller.nil?
+					# @logger.debug("RENDER active_controller OK: #{@active_controller.inspect}")
+					# @logger.debug("RENDER active_controller view grid_cache: #{@active_controller.view.grid_cache.inspect}")
+					
+					@active_controller.render(area).each do |y_pos, row|
+						row.each do |x_pos, content|
+							#sleep 0.1 # @TODO: remove this line
+							
+							# @logger.debug("RENDER #{x_pos}:#{y_pos} '#{content}'")
+							
+							draw_point(Point.new(x_pos, y_pos), content)
+							
+							#ui_refresh # @TODO: remove this line
+						end
+					end
+				end
+				ui_refresh
+			end
+			
+			def draw_line(point, row)
+				x_pos = point.x
+				y_pos = point.y
+				
+				row.length.times do |n|
+					draw_point(Point.new(x_pos, y_pos), ViewContent.new(row[n]))
+					x_pos += 1
+				end
+			end
+			
+			##
+			# Needs to be implemented by the sub-class.
+			#
+			# For example, CursesApp is a sub-class of UIApp. CursesApp uses `Curses.setpos` and `Curses.addstr` in `draw_point()` to draw the points.
+			def draw_point(point, content)
+				raise NotImplementedError
+			end
+			
+			def ui_refresh
+				raise NotImplementedError
+			end
+			
+			def ui_max_x
+				-1
+			end
+			
+			def ui_max_y
+				-1
+			end
+			
+			protected
+			
+			def app_will_terminate
+				#puts 'UIApp app_will_terminate'
+				
+				ui_close
+			end
+			
+			def ui_init
+				# raise NotImplementedError
+			end
+			
+			def ui_close
+				# raise NotImplementedError
+			end
+			
+			def key_down(key)
+				if !key.nil? && !@active_controller.nil?
+					event = KeyEvent.new
+					event.key = key
+					
+					begin
+						@active_controller.handle_event(event)
+					rescue Exception::UnhandledKeyEventException => e
+						@logger.warn("#{self.class} UnhandledKeyEventException: #{e}")
+						
+						if @app_controller.nil?
+							@logger.warn("#{self.class} UnhandledKeyEventException: no app controller set, raise")
+							
+							raise e
+						end
+						
+						@app_controller.handle_event(e.event)
+					rescue Exception::UnhandledEventException => e
+						@logger.warn("#{self.class} UnhandledEventException: #{e}")
+					end
+				end
+			end
+			
+		end
+		
+	end
+end

data/lib/termkit/controller/controller.rb

@@ -0,0 +1,58 @@
+
+module TheFox
+	module TermKit
+		
+		class Controller
+			
+			attr_reader :subcontrollers
+			
+			def initialize
+				#puts 'Controller initialize'
+				
+				@is_active = false
+				@subcontrollers = []
+			end
+			
+			def active
+				@is_active = true
+				
+				@subcontrollers.each do |subcontroller|
+					subcontroller.active
+				end
+			end
+			
+			def inactive
+				@is_active = false
+				
+				@subcontrollers.each do |subcontroller|
+					subcontroller.inactive
+				end
+			end
+			
+			def is_active?
+				@is_active
+			end
+			
+			def handle_event(event)
+				#puts "Controller handle_event: #{event.class}"
+			end
+			
+			def add_subcontroller(subcontroller)
+				if !subcontroller.is_a?(Controller)
+					raise ArgumentError, "Argument is not a Controller -- #{subcontroller.class} given"
+				end
+				if !@subcontrollers.is_a?(Array)
+					raise Exception::ParentClassNotInitializedException, "@subcontrollers is not an Array -- #{@subcontrollers.class} given"
+				end
+				
+				@subcontrollers.push(subcontroller)
+			end
+			
+			def remove_subcontroller(subcontroller)
+				@subcontrollers.delete(subcontroller)
+			end
+			
+		end
+		
+	end
+end

data/lib/termkit/controller/controller_app.rb

@@ -0,0 +1,22 @@
+
+module TheFox
+	module TermKit
+		
+		##
+		# Controller sub-class.
+		class AppController < Controller
+			
+			def initialize(app)
+				if !app.is_a?(App)
+					raise ArgumentError, "Argument is not a App -- #{app.class} given"
+				end
+				
+				super()
+				
+				@app = app
+			end
+			
+		end
+		
+	end
+end

data/lib/termkit/controller/controller_view.rb

@@ -0,0 +1,28 @@
+
+module TheFox
+	module TermKit
+		
+		class ViewController < Controller
+			
+			attr_accessor :app
+			attr_accessor :view
+			
+			def initialize(view = nil)
+				if !view.nil? && !view.is_a?(View)
+					raise ArgumentError, "Argument is not a View -- #{view.class} given"
+				end
+				
+				super()
+				
+				@app = nil
+				@view = view
+			end
+			
+			def render(area = nil)
+				@view.render(area)
+			end
+			
+		end
+		
+	end
+end

data/lib/termkit/event/event.rb

@@ -0,0 +1,14 @@
+
+module TheFox
+	module TermKit
+		
+		class Event
+			
+			def initialize
+				#puts 'Event initialize'
+			end
+			
+		end
+		
+	end
+end

data/lib/termkit/event/event_key.rb

@@ -0,0 +1,33 @@
+
+module TheFox
+	module TermKit
+		
+		##
+		# Typically used to handle user keystrokes.
+		class KeyEvent
+			
+			attr_accessor :key
+			
+			def initialize
+				super()
+				
+				@key = nil
+			end
+			
+			def to_s
+				@key.to_s
+			end
+			
+			def inspect
+				s = "#<#{self.class}"
+				unless @key.nil?
+					s << "->#{@key.ord}[#{@key}]"
+				end
+				s << '>'
+				s
+			end
+			
+		end
+		
+	end
+end

data/lib/termkit/event/event_later.rb

@@ -0,0 +1,16 @@
+
+# Cronjob
+
+module TheFox
+	module TermKit
+		
+		class LaterEvent
+			
+			def initialize
+				
+			end
+			
+		end
+		
+	end
+end

data/lib/termkit/exception/exception_event_key_unhandled.rb

@@ -0,0 +1,11 @@
+
+module TheFox
+	module TermKit
+		module Exception
+			
+			class UnhandledKeyEventException < UnhandledEventException
+			end
+			
+		end
+	end
+end

data/lib/termkit/exception/exception_event_unhandled.rb

@@ -0,0 +1,18 @@
+
+module TheFox
+	module TermKit
+		module Exception
+			
+			class UnhandledEventException < StdException
+				
+				attr_reader :event
+				
+				def initialize(event)
+					@event = event
+				end
+				
+			end
+		
+		end
+	end
+end

data/lib/termkit/exception/exception_initialized_not_class_parent.rb

@@ -0,0 +1,17 @@
+
+module TheFox
+	module TermKit
+		module Exception
+			
+			class ParentClassNotInitializedException < StdException
+				
+				def initialize(msg = nil)
+					msg << ' -- Forgot to call super() for parent initialization?'
+					super
+				end
+				
+			end
+			
+		end
+	end
+end

data/lib/termkit/exception/exception_std.rb

@@ -0,0 +1,11 @@
+
+module TheFox
+	module TermKit
+		module Exception
+			
+			class StdException < ::StandardError
+			end
+			
+		end
+	end
+end

data/lib/termkit/misc/curses_color.rb

@@ -0,0 +1,23 @@
+
+require 'curses'
+
+module TheFox
+	module TermKit
+		
+		class CursesColor
+			
+			COLORS = {
+				:color_black => Curses::COLOR_BLACK,
+				:color_blue => Curses::COLOR_BLUE,
+				:color_cyan => Curses::COLOR_CYAN,
+				:color_green => Curses::COLOR_GREEN,
+				:color_magenta => Curses::COLOR_MAGENTA,
+				:color_red => Curses::COLOR_RED,
+				:color_white => Curses::COLOR_WHITE,
+				:color_yellow => Curses::COLOR_YELLOW,
+			}
+			
+		end
+		
+	end
+end

data/lib/termkit/misc/point.rb

@@ -0,0 +1,114 @@
+
+module TheFox
+	module TermKit
+		
+		##
+		# A single point on a x-y-grid.
+		class Point
+			
+			attr_accessor :x
+			attr_accessor :y
+			
+			def initialize(x = nil, y = nil)
+				case x
+				when Array
+					y = x[1]
+					x = x[0]
+				when Hash
+					y = if x['y']
+							x['y']
+						elsif x[:y]
+							x[:y]
+						end
+					
+					x = if x['x']
+							x['x']
+						elsif x[:x]
+							x[:x]
+						end
+				end
+				
+				@x = x
+				@y = y
+			end
+			
+			def ==(point)
+				# puts "Point == compare"
+				@x == point.x && @y == point.y
+			end
+			
+			# def ===(point)
+			# 	puts "Point === compare"
+			# 	#@x == point.x && @y == point.y
+			# 	false
+			# end
+			
+			# def eql?(point)
+			# 	puts "Point eql? compare"
+			# 	false
+			# end
+			
+			def +(point)
+				x = nil
+				y = nil
+				
+				if !@x.nil? || !point.x.nil?
+					x = @x.to_i + point.x.to_i
+				end
+				
+				if !@y.nil? || !point.y.nil?
+					y = @y.to_i + point.y.to_i
+				end
+				
+				self.class.new(x, y)
+			end
+			
+			def -(point)
+				x = nil
+				y = nil
+				
+				if !@x.nil? || !point.x.nil?
+					x = @x.to_i - point.x.to_i
+				end
+				
+				if !@y.nil? || !point.y.nil?
+					y = @y.to_i - point.y.to_i
+				end
+				
+				self.class.new(x, y)
+			end
+			
+			def to_s
+				"#{@x}:#{@y}"
+			end
+			
+			def to_a
+				[@x, @y]
+			end
+			
+			def inspect
+				x_s = x.nil? ? 'NIL' : x
+				y_s = y.nil? ? 'NIL' : y
+				
+				"#<Point x=#{x_s} y=#{y_s}>"
+			end
+			
+			def missing_function
+				
+			end
+			
+			def self.from_s(s)
+				x, y =
+					s
+					.split(/[:,]/, 2)
+					.map{ |pos|
+						pos.nil? || pos == '' ? nil : pos.to_i
+					}
+				
+				new(x, y)
+			end
+			
+		end
+		
+	end
+end