arcadia 0.1.3 → 0.2.0

data/base/a-contracts.rb

@@ -1,322 +1,207 @@
-#
-#   a-contracts.rb - Arcadia Ruby ide
-#   by Antonio Galeone <antonio-galeone@rubyforge.org>
-#
-
-# Catalog of all contracts used by extensions. This astraction guarantees 
-# the separation of ext
-# contract must extend AeContract
-
-require "base/a-ext"
-
-
-
-
-#---------------- contracts ----------------------
-class MainContract < ArcadiaContract
-  class TMainObj < TObj
-  		attr_accessor :obj, :domain, :extension
-  end
-
-  EXTENSION_BEFORE_BUILD = "EXTENSION_BEFORE_BUILD"
-  EXTENSION_BUILD = "EXTENSION_BUILD"
-  EXTENSION_AFTER_BUILD = "EXTENSION_AFTER_BUILD"
-  EXTENSION_FINALIZE = "EXTENSION_FINALIZE"
-  CONTRACT_RETRIVE = "CONTRACT_RETRIVE"
-  RAISE_EXTENSION = "RAISE_EXTENSION"
-  EVENT_HANDLED = "EVENT_HANDLED"
-
-
-  def event_handled(_sender, *args)
-    raise_event(EVENT_HANDLED, TMainObj.new(_sender, *args))
-  end
-  
-  def extension_before_build(_sender, *args)
-    raise_event(EXTENSION_BEFORE_BUILD, TMainObj.new(_sender, *args))
-  end
-  
-  def extension_build(_sender, *args)
-    raise_event(EXTENSION_BUILD, TMainObj.new(_sender, *args))
-  end
-  
-  def extension_after_build(_sender, *args)
-    raise_event(EXTENSION_AFTER_BUILD, TMainObj.new(_sender, *args))
-  end
-
-  def raise_extension(_sender, *args)
-    raise_event(RAISE_EXTENSION, TMainObj.new(_sender, *args))
-  end
-
-end
-
-
-class EditorContract < ArcadiaContract
-  class TEditorObj < TObj
-    attr_accessor :file, :line, :col, :title, :text, :candidates, :xdoc, :ydoc, :doc_entry,:doc
-  end
-  OPEN_FILE = "OPEN_FILE"
-  CLOSE_FILE = "CLOSE_FILE"
-  SHOW_SEARCH_DIALOG = "SHOW_SEARCH_DIALOG"
-  SHOW_GOTO_LINE_DIALOG = "SHOW_GOTO_LINE_DIALOG"
-  SAVE_FILE = "SAVE_FILE"
-  SAVE_AS_FILE = "SAVE_AS_FILE"
-  SAVE_FILE_RAISED = "SAVE_FILE_RAISED"
-  SAVE_AS_FILE_RAISED = "SAVE_AS_FILE_RAISED"
-  OPEN_TEXT = "OPEN_TEXT"
-  COMPLETE_CODE = "COMPLETE_CODE"
-  DOC_CODE = "DOC_CODE"
-  BUILD_DOC_TREE = "BUILD_DOC_TREE"
-
-  #AFTER_CREATE = "AFTER_CREATE"
-  BREAKPOINT_AFTER_CREATE = "BREAKPOINT_AFTER_CREATE"
-  BREAKPOINT_AFTER_DELETE = "BREAKPOINT_AFTER_DELETE"
-  BREAKPOINTS_AFTER_CREATE = "BREAKPOINTS_AFTER_CREATE"
-  BREAKPOINTS_AFTER_DELETE = "BREAKPOINTS_AFTER_DELETE"
-  FILE_AFTER_OPEN = "FILE_AFTER_OPEN"
-  FILE_AFTER_CLOSE = "FILE_AFTER_CLOSE"
-  FILE_AFTER_SAVE = "FILE_AFTER_SAVE"
-  FILE_AFTER_CREATE = "FILE_AFTER_CREATE"
-  BUFFER_AFTER_RAISE = "BUFFER_AFTER_RAISE"
-  EVAL_EXPRESSION = "EVAL_EXPRESSION"  
-  def open_file(_sender, *args)
-    raise_action(OPEN_FILE, TEditorObj.new(_sender, *args))
-  end
-
-  def close_file(_sender, *args)
-    raise_action(CLOSE_FILE, TEditorObj.new(_sender, *args))
-  end
-
-  def save_file(_sender, *args)
-    raise_action(SAVE_FILE, TEditorObj.new(_sender, *args))
-  end
-
-  def save_file_raised(_sender, *args)
-    raise_action(SAVE_FILE_RAISED, TEditorObj.new(_sender, *args))
-  end
-
-  def save_as_file(_sender, *args)
-    raise_action(SAVE_AS_FILE, TEditorObj.new(_sender, *args))
-  end
-
-  def save_as_file_raised(_sender, *args)
-    raise_action(SAVE_AS_FILE_RAISED, TEditorObj.new(_sender, *args))
-  end
-
-  def show_search_dialog(_sender, *args)
-    raise_action(SHOW_SEARCH_DIALOG, TEditorObj.new(_sender, *args))
-  end
-
-
-  def show_goto_line_dialog(_sender, *args)
-    raise_action(SHOW_GOTO_LINE_DIALOG, TEditorObj.new(_sender, *args))
-  end
-
-  def open_text(_sender, *args)
-    raise_action(OPEN_TEXT, TEditorObj.new(_sender, *args))
-  end
-
-  def complete_code(_sender, *args)
-    raise_action(COMPLETE_CODE, TEditorObj.new(_sender, *args))
-  end
-
-  def doc_code(_sender, *args)
-    raise_action(DOC_CODE, TEditorObj.new(_sender, *args))
-  end
-
-  def build_doc_tree(_sender, *args)
-    raise_action(BUILD_DOC_TREE, TEditorObj.new(_sender, *args))
-  end
-
-  def file_opened(_sender, *args)
-    raise_event(FILE_AFTER_OPEN, TEditorObj.new(_sender, *args))
-  end
-
-  def file_saved(_sender, *args)
-    raise_event(FILE_AFTER_SAVE, TEditorObj.new(_sender, *args))
-  end
-
-  def file_created(_sender, *args)
-    raise_event(FILE_AFTER_CREATE, TEditorObj.new(_sender, *args))
-  end
-
-  def buffer_raised(_sender, *args)
-    raise_event(BUFFER_AFTER_RAISE, TEditorObj.new(_sender, *args))
-  end
-
-  def file_closed(_sender, *args)
-    raise_event(FILE_AFTER_CLOSE, TEditorObj.new(_sender, *args))
-  end
- 
-  def breakpoint_created(_sender, *args)
-    raise_event(BREAKPOINT_AFTER_CREATE, TEditorObj.new(_sender, *args))
-  end
-  
-  def breakpoint_deleted(_sender, *args)
-    raise_event(BREAKPOINT_AFTER_DELETE, TEditorObj.new(_sender, *args))
-  end
-
-  def eval_expression(_sender, *args)
-    raise_action(EVAL_EXPRESSION, TEditorObj.new(_sender, *args))
-  end
-
-
-  
-#  def breakpoints_created(_array_of_tobj=nil)
-#    raise_event(BREAKPOINTS_AFTER_CREATE, _array_of_tobj)
-#  end
-#  def breakpoints_deleted(_array_of_tobj=nil)
-#    raise_event(BREAKPOINTS_AFTER_DELETE, _array_of_tobj)
-#  end
-
-end
-
-class MsgContract < ArcadiaContract
-  TYPE_SIMPLE = "TYPE_SIMPLE"
-  TYPE_DEBUG = "TYPE_DEBUG"
-  TYPE_ERROR = "TYPE_ERROR"
-  SObj = Struct.new("MsgState"
-  )
-  class TMsgObj < TObj
-  		attr_accessor :type, :text
-  end
-  
-  EVENT_EXT_MSG_OUT = "EVENT_EXT_MSG_OUT"
-  def out(_sender, *args)
-    raise_event(EVENT_EXT_MSG_OUT, TMsgObj.new(_sender, *args))
-  end
-  
-  def out_simple(_sender, _msg, _channel=nil)
-    self.out(_sender, 'type'=>TYPE_SIMPLE, 'text'=>_msg, 'channel'=>_channel)
-  end
-  
-  def out_debug(_sender, _msg, _channel=nil)
-    self.out(_sender, 'type'=>TYPE_DEBUG, 'text'=>_msg, 'channel'=>_channel)
-  end
-
-  def out_error(_sender, _msg, _channel=nil)
-    self.out(_sender, 'type'=>TYPE_ERROR, 'text'=>_msg, 'channel'=>_channel)
-  end
-end
-
-class ShellContract < ArcadiaContract
-  SObj = Struct.new("ShellState"
-  )
-  class TShellObj < TObj
-  		attr_accessor :file
-  end
-
-  def run(_sender, *args)
-  end  
-  
-  def debug(_sender, *args)
-  end  
-end
-
-
-class DebugContract < ArcadiaContract
-  SObj = Struct.new("DebugState"
-  )
-  class TDebugObj < TObj
-    attr_accessor :file, :line, :error_text, :error_class,:callers, :variables
-  end
-  
-  DEBUG_BEGIN="DEBUG_BEGIN"
-  DEBUG_END="DEBUG_END"
-  DEBUG_STEP="DEBUG_STEP"
-  
-  def debug_begin(_sender, *args)
-  		raise_event(DEBUG_BEGIN, TDebugObj.new(_sender, *args))
-  end
-  def debug_end(_sender, *args)
-  		raise_event(DEBUG_END, TDebugObj.new(_sender, *args))
-  end
-  def debug_step(_sender, *args)
-  		raise_event(DEBUG_STEP, TDebugObj.new(_sender, *args))
-  end
-end
-
-class InspectorContract < ArcadiaContract
-  SObj = Struct.new("InspectorActionState"
-  )
-  class TInspectorObj < TObj
-  		attr_accessor	 :wrapper, :requires, :property_family,:property_name,:property_value
-  end
-
-  SELECT_WRAPPER = "SELECT_WRAPPER"
-  #ACTIVATE_WRAPPER = "ACTIVATE_WRAPPER"
-  DELETE_WRAPPER = "DELETE_WRAPPER"
-  ADD_REQUIRE = "ADD_REQUIRE"
-  REGISTER_WRAPPER = "REGISTER_WRAPPER"
-#  UPDATE_PROPERTY = "UPDATE_PROPERTY"
-  DELETE_INSPECTOR = "DELETE_INSPECTOR"
-  RAISE_LAST_WIDGET = "RAISE_LAST_WIDGET"
-  RAISE_ACTIVE_TOPLEVEL = "RAISE_ACTIVE_TOPLEVEL"
-  
-  def delete_wrapper(_sender, *args)
-  		raise_action(DELETE_WRAPPER, TInspectorObj.new(_sender, *args))
-  end
-  
-  def raise_last_widget(_sender, *args)
-  		raise_action(RAISE_LAST_WIDGET, TInspectorObj.new(_sender, *args))
-  end
-
-  def raise_active_toplevel(_sender, *args)
-  		raise_action(RAISE_ACTIVE_TOPLEVEL, TInspectorObj.new(_sender, *args))
-  end
-  
-  def select(_sender, *args)
-  		raise_action(SELECT_WRAPPER, TInspectorObj.new(_sender, *args))
-  end 
-
-  def add_require(_sender, *args)
-  		raise_action(ADD_REQUIRE, TInspectorObj.new(_sender, *args))
-  end
-  
-  def register(_sender, *args)
-  		raise_action(REGISTER_WRAPPER, TInspectorObj.new(_sender, *args))
-  end 
-  
-  def delete_inspector(_sender, *args)
-    raise_action(DELETE_INSPECTOR, TInspectorObj.new(_sender, *args))
-  end
-  
-  publish_action :raise_active_object
-end
-
-class PublishContract < ArcadiaContract
-  ADD_COMAND_ACTOR = "ADD_COMAND_ACTOR"
-  def add_command_actor(_sender, *args)
-    raise_action(ADD_COMAND_ACTOR, TObj.new(_sender, *args))
-  end
-end
-
-
-
-class WrapperContract < ArcadiaContract
-  class TWrapperObj < TObj
-  		attr_accessor	 :wrapper, :property_name, :property_family, :property_old_value, :property_new_value
-  end
-  WRAPPER_AFTER_CREATE="WRAPPER_AFTER_CREATE"
-  PROPERTY_AFTER_UPDATE="PROPERTY_AFTER_UPDATE"
-  UPDATE_PROPERTY="UPDATE_PROPERTY"
-  def update_property(_sender, *args)
-    raise_action(UPDATE_PROPERTY, TWrapperObj.new(_sender, *args))
-  end
-  def property_updated(_sender, *args)
-    raise_event(PROPERTY_AFTER_UPDATE, TWrapperObj.new(_sender, *args))
-  end
-  def wrapper_created(_sender, *args)
-    raise_event(WRAPPER_AFTER_CREATE, TWrapperObj.new(_sender, *args))
-  end
-end
-
-class PaletteContract < ArcadiaContract
-  class TPaletteObj < TObj
-  		attr_accessor	 :parent, :x, :y
-  end
-  MAKE_SELECTED_WRAPPER = "MAKE_SELECTED_WRAPPER"
-  def make_selected(_sender, *args)
-    raise_action(MAKE_SELECTED_WRAPPER, TPaletteObj.new(_sender, *args))
-  end
-end
-
+#
+#   a-contracts.rb - Arcadia Ruby ide
+#   by Antonio Galeone <antonio-galeone@rubyforge.org>
+#
+
+# Catalog of events used by arcadia obj. 
+# Obj must comunicate through raise/catch event
+# in order to guarantees decoupling
+
+# +------------------------------------------+
+#      Arcadia Event
+# +------------------------------------------+
+
+class ArcadiaEvent < Event
+end
+
+class QuitEvent < ArcadiaEvent
+end
+
+# +------------------------------------------+
+#     Extention Event (raised only by Arcadia)
+#     do not raise! 
+# +------------------------------------------+
+
+class BuildEvent < ArcadiaEvent
+  attr_accessor :name
+end 
+
+class ExitQueryEvent < ArcadiaEvent
+  attr_accessor :can_exit
+end
+
+class FinalizeEvent < ArcadiaEvent
+end
+
+#  +---------------------------------------------+
+#         Buffer event
+#  +---------------------------------------------+
+
+class BufferEvent < ArcadiaEvent # Abstract
+  attr_accessor :file, :title, :text, :row, :col 
+  # if file==nil && title==nil buffer=current buffer
+end
+
+class NewBufferEvent < BufferEvent
+end
+
+class OpenBufferEvent < BufferEvent
+end
+
+class CloseBufferEvent < BufferEvent
+end
+
+class SaveBufferEvent < BufferEvent
+end
+
+class SaveAsBufferEvent < SaveBufferEvent
+  attr_accessor :new_file	
+end
+
+class GoToLineBufferEvent < BufferEvent
+  attr_accessor :line
+end
+
+class SearchBufferEvent < BufferEvent
+  class Result < Result
+    attr_accessor :row, :col
+  end
+  attr_accessor :what
+end
+
+class CompleteCodeEvent < BufferEvent
+  class Result < Result
+    attr_accessor :candidates
+  end
+end
+
+class DocCodeEvent < BufferEvent
+  class Result < Result
+    attr_accessor :doc, :title
+  end
+  attr_accessor :xdoc, :ydoc, :doc_entry
+end
+
+class BufferRaisedEvent < BufferEvent
+end
+
+#  +---------------------------------------------+
+#         Debug event
+#  +---------------------------------------------+
+
+class DebugEvent < ArcadiaEvent
+   attr_accessor :file, :row
+end
+
+class SetBreakpointEvent < DebugEvent
+end
+
+class UnsetBreakpointEvent < DebugEvent
+end
+
+class EvalExpressionEvent < DebugEvent
+  attr_accessor :expression
+end
+
+class StartDebugEvent < DebugEvent
+end
+
+class StopDebugEvent < DebugEvent
+end
+
+class StepDebugEvent < DebugEvent
+  class Result < Result
+    attr_accessor :file, :row
+  end
+  # step_over, step_into, step_out, resume, where, quit
+  attr_accessor :command
+end
+
+class DebugStepInfoEvent < DebugEvent
+  attr_accessor :file, :row
+end
+
+#  +---------------------------------------------+
+#         Message event (raised only by Arcadia)
+#         to raise use: 
+#         Arcadia.new_msg
+#         Arcadia.new_debug_msg
+#         Arcadia.new_error_msg
+#  +---------------------------------------------+
+
+class MsgEvent < ArcadiaEvent
+   attr_accessor :msg
+end
+
+class DebugMsgEvent < MsgEvent
+end
+
+class ErrorMsgEvent < MsgEvent
+end
+
+#  +---------------------------------------------+
+#         Other event
+#  +---------------------------------------------+
+
+class SearchInFilesEvent < ArcadiaEvent
+  class Result < SearchBufferEvent::Result
+    attr_accessor :file
+  end
+  attr_accessor :what, :files_filter, :dir
+end
+
+class SystemExecEvent < ArcadiaEvent
+  class Result < Result
+    attr_accessor :std_output, :std_error
+  end
+  attr_accessor :command
+end
+
+class RunRubyFileEvent < ArcadiaEvent
+  class Result < Result
+    attr_accessor :output
+  end
+  attr_accessor :file
+end
+
+#  +---------------------------------------------+
+#         Dialog event (raised only by Arcadia)
+#         to raise use: 
+#         Arcadia.ok
+#         Arcadia.ok_cancel
+#         Arcadia.yes_no_cancel
+#         Arcadia.abort_retry_ignore
+#  +---------------------------------------------+
+
+# default actions_pattern  = 'OK'
+class DialogEvent < ArcadiaEvent
+  TYPE_PATTERNS = ['ok', 'yes_no', 'ok_cancel', 'yes_no_cancel', 'abort_retry_ignore']
+  class Result < Result
+    attr_accessor :value
+  end
+  attr_accessor :title, :msg, :type
+end
+
+class QuestionDialogEvent < DialogEvent
+end
+
+class InfoDialogEvent < DialogEvent
+end
+
+class WarningDialogEvent < DialogEvent
+end
+
+class ErrorDialogEvent < DialogEvent
+end
+
+
+#  +---------------------------------------------+
+#         Action event
+#  +---------------------------------------------+
+
+class ActionEvent < ArcadiaEvent
+  attr_accessor :receiver
+  attr_accessor :action
+  attr_accessor :action_args
+end
+