sirens 0.0.1

data/lib/sirens.rb

@@ -0,0 +1,90 @@
+require 'gtk3'
+
+module Sirens
+    class << self
+        def browse(object: nil, klass: nil)
+            if ! klass.nil?
+                klass = klass.class if ! klass.kind_of?(Module)
+
+                Sirens::ModuleBrowser.open_on(klass: klass)
+            else
+                ObjectBrowser.open_on(object: object)
+            end
+
+            Gtk.main if @opened_windows == 1
+        end
+
+        def register_window()
+            @opened_windows = 0 if @opened_windows.nil?
+
+            @opened_windows += 1
+        end
+
+        def unregister_window()
+            @opened_windows -= 1
+
+            Gtk.main_quit if @opened_windows == 0
+        end
+    end
+
+    # Models
+    autoload(:ValueModel, 'models/value_model.rb')
+    autoload(:ListModel, 'models/list_model.rb')
+    autoload(:VirtualTreeModel, 'models/virtual_tree_model.rb')
+    autoload(:ChoiceModel, 'models/choice_model.rb')
+    autoload(:TreeChoiceModel, 'models/tree_choice_model.rb')
+
+    # Components
+    autoload(:ComponentBehaviour, 'components/component_behaviour.rb')
+    autoload(:Component, 'components/component.rb')
+    autoload(:PrimitiveComponent, 'components/primitive_component.rb')
+    autoload(:Window, 'components/containers/window.rb')
+    autoload(:Stack, 'components/containers/stack.rb')
+    autoload(:Splitter, 'components/containers/splitter.rb')
+    autoload(:Tabs, 'components/containers/tabs.rb')
+    autoload(:Button, 'components/widgets/button.rb')
+    autoload(:Checkbox, 'components/widgets/checkbox.rb')
+    autoload(:RadioButton, 'components/widgets/radio_button.rb')
+    autoload(:ColumnProps, 'components/widgets/column_props.rb')
+    autoload(:List, 'components/widgets/list.rb')
+    autoload(:ListChoice, 'components/widgets/list_choice.rb')
+    autoload(:InputText, 'components/widgets/input_text.rb')
+    autoload(:Text, 'components/widgets/text.rb')
+    autoload(:TreeChoice, 'components/widgets/tree_choice.rb')
+
+    # Layouts
+    autoload(:LayoutBuilder, 'layouts/layout_builder.rb')
+    autoload(:ColumnsBuilder, 'layouts/columns_builder.rb')
+    autoload(:RadioButtonGroupBuilder, 'layouts/radio_button_group_builder.rb')
+
+    # Views
+    autoload(:View, 'views/view.rb')
+    autoload(:MenuView, 'views/menu_view.rb')
+    autoload(:WindowView, 'views/window_view.rb')
+    autoload(:StackView, 'views/stack_view.rb')
+    autoload(:PanedView, 'views/paned_view.rb')
+    autoload(:NotebookView, 'views/notebook_view.rb')
+    autoload(:ButtonView, 'views/button_view.rb')
+    autoload(:CheckButtonView, 'views/check_button_view.rb')
+    autoload(:RadioButtonView, 'views/radio_button_view.rb')
+    autoload(:ListView, 'views/list_view.rb')
+    autoload(:EntryView, 'views/entry_view.rb')
+    autoload(:TextView, 'views/text_view.rb')
+    autoload(:TreeView, 'views/tree_view.rb')
+
+    autoload(:ModuleBrowserModel, 'sirens/models/module_browser_model.rb')
+    autoload(:MethodModel, 'sirens/models/method_model.rb')
+    autoload(:ConstantModel, 'sirens/models/constant_model.rb')
+    autoload(:ObjectBrowserModel, 'sirens/models/object_browser_model.rb')
+
+    autoload(:ModuleBrowser, 'sirens/browsers/module_browser.rb')
+    autoload(:ObjectBrowser, 'sirens/browsers/object_browser.rb')
+
+    autoload(:NamespacesList, 'sirens/components/namespaces_list.rb')
+    autoload(:ModulesList, 'sirens/components/modules_list.rb')
+    autoload(:ClassBrowser, 'sirens/components/class_browser.rb')
+    autoload(:AncestorsList, 'sirens/components/ancestors_list.rb')
+    autoload(:MethodsList, 'sirens/components/methods_list.rb')
+    autoload(:ConstantsList, 'sirens/components/constants_list.rb')
+    autoload(:MethodSourceCode, 'sirens/components/method_source_code.rb')
+end

data/lib/views/button_view.rb

@@ -0,0 +1,56 @@
+module Sirens
+    class ButtonView < View
+
+        # Class methods
+
+        class << self
+            ##
+            # Answer the styles accepted by this view.
+            #
+            def view_accepted_styles()
+                super() + [:label, :on_clicked].freeze
+            end
+        end
+
+        # Initializing
+
+        def initialize_handles()
+            @main_handle = Gtk::Button.new()
+            @on_clicked = nil
+        end
+
+        def subscribe_to_ui_events()
+            main_handle.signal_connect('clicked') {
+                on_clicked
+            }
+        end
+
+        # Styles
+
+        def label=(value)
+            main_handle.label = value
+        end
+
+        def label()
+            main_handle.label
+        end
+
+        # Actions
+
+        def click()
+            main_handle.clicked
+        end
+
+        # Handlers
+
+        def on_clicked=(block)
+            @on_clicked = block
+        end
+
+        # Events
+
+        def on_clicked()
+            @on_clicked.call(self) unless @on_clicked.nil?
+        end
+    end
+end

data/lib/views/check_button_view.rb

@@ -0,0 +1,65 @@
+module Sirens
+    class CheckButtonView < View
+
+        # Class methods
+
+        class << self
+            ##
+            # Answer the styles accepted by this view.
+            #
+            def view_accepted_styles()
+                super() + [:label].freeze
+            end
+        end
+
+        # Initializing
+
+        def initialize(on_toggled:)
+            super()
+
+            @on_toggled_block = on_toggled
+        end
+
+        def initialize_handles()
+            @main_handle = Gtk::CheckButton.new()
+        end
+
+        def subscribe_to_ui_events()
+            main_handle.signal_connect('clicked') {
+                on_toggled
+            }
+        end
+
+        # Styles
+
+        def label=(value)
+            main_handle.label = value
+        end
+
+        def label()
+            main_handle.label
+        end
+
+        # Actions
+
+        def click()
+            main_handle.clicked
+        end
+
+        # Querying
+
+        def get_value()
+            main_handle.active?
+        end
+
+        def set_value(boolean)
+            main_handle.active = boolean
+        end
+
+        # Events
+
+        def on_toggled()
+            @on_toggled_block.call(state: get_value)
+        end
+    end
+end

data/lib/views/entry_view.rb

@@ -0,0 +1,25 @@
+module Sirens
+    class EntryView < View
+
+        # Initializing
+
+        def initialize_handles()
+            @main_handle = Gtk::Entry.new
+        end
+
+        def subscribe_to_ui_events()
+        end
+
+        # Accessing
+
+        def text()
+            main_handle.buffer.text
+        end
+
+        def set_text(text)
+            text = '' if text.nil?
+
+            main_handle.buffer.text = text
+        end
+    end
+end

data/lib/views/list_view.rb

@@ -0,0 +1,230 @@
+module Sirens
+    class ListView < View
+
+        # Class methods
+
+        class << self
+            ##
+            # Answer the styles accepted by this view.
+            #
+            def view_accepted_styles()
+                super() + [:show_headers, :clickable_headers].freeze
+            end
+        end
+
+        # Initializing
+
+        def initialize_handles()
+            @tree_view = Gtk::TreeView.new()
+            @tree_view.set_model(Gtk::ListStore.new(String))
+
+            @main_handle = Gtk::ScrolledWindow.new
+            @main_handle.add(tree_view)
+            @main_handle.set_policy(:automatic, :automatic)
+
+            @current_selection_indices = []
+
+            @columns_props = []
+
+            @on_selection_changed = nil
+        end
+
+        # Configuring callbacks
+
+        def on_selection_changed_block(&block)
+            @on_selection_changed_block = block
+
+            self
+        end
+
+        def get_item_block(&block)
+            @get_item_block = block
+
+            self
+        end
+
+        # Building columns
+
+        def define_columns(columns_props_array)
+            @columns_props = columns_props_array
+
+            list_store_types = @columns_props
+                .collect { |each_column_props| each_column_props.fetch(:type, :text) }
+                .collect { |type| String }
+
+            tree_view.set_model(Gtk::ListStore.new(*list_store_types))
+
+            @columns_props.each do |each_column_props|
+                add_column_with_props(each_column_props)
+            end
+        end
+
+        def add_column_with_props(props)
+            column_type = props.fetch(:type, :text)
+            column_index = tree_view.columns.size
+
+            renderer = Gtk::CellRendererText.new
+
+            col = Gtk::TreeViewColumn.new(props[:label], renderer, column_type => column_index)
+
+            tree_view.append_column(col)
+        end
+
+        # Hooking GUI signals
+
+        def subscribe_to_ui_events()
+            tree_view.selection.signal_connect('changed') { |tree_selection|
+                on_selection_changed(tree_selection)
+            }
+
+            tree_view.signal_connect('row-activated') {
+                @on_selection_action.call(self) unless @on_selection_action.nil?
+            }
+        end
+
+        # Accessing
+
+        def list_store()
+            tree_view.model
+        end
+
+        def tree_view()
+            @tree_view
+        end
+
+        ##
+        # Returns the rows contents of the list.
+        # For testing and debugging only.
+        #
+        def rows()
+            list_store.collect { |store, path, iter|
+                iter[0]
+            }
+        end
+
+        # Styles
+
+        def show_headers=(boolean)
+            tree_view.headers_visible = boolean
+        end
+
+        def show_headers?()
+            tree_view.headers_visible?
+        end
+
+        def clickable_headers=(boolean)
+            tree_view.headers_clickable = boolean
+        end
+
+        def clickable_headers?()
+            tree_view.headers_clickable?
+        end
+
+        # Handlers
+
+        def on_selection_changed(tree_selection)
+            indices = []
+            items = []
+
+            tree_selection.each do |tree_store, tree_path, iter|
+                index = tree_path_to_index(tree_path)
+
+                indices << index
+                items << @get_item_block.call(index)
+            end
+
+            @on_selection_changed_block.call(
+                selection_items: items,
+                selection_indices: indices
+            )
+        end
+
+        # Actions
+
+        def clear_items()
+            list_store.clear
+        end
+
+        # Adding
+
+        def add_items(items:, index:)
+            items.each_with_index do |each_item, i|
+                add_item(item: each_item, index: index + i)
+            end
+        end
+
+        def add_item(item:, index:)
+            iter = list_store.insert(index)
+
+            set_item_column_values(item: item, iter: iter)
+        end
+
+        # Updating
+
+        def update_items(items:, indices:)
+            items.each_with_index do |each_item, i|
+                update_item(item: each_item, index: indices[i])
+            end
+        end
+
+        def update_item(item:, index:)
+            iter = list_store.get_iter(index.to_s)
+
+            set_item_column_values(item: item, iter: iter)
+        end
+
+        # Removing
+
+        def remove_items(items:, indices:)
+            items.each_with_index do |each_item, i|
+                remove_item(item: each_item, index: indices[i])
+            end
+        end
+
+        def remove_item(item:, index:)
+            iter = list_store.get_iter(index.to_s)
+
+            list_store.remove(iter)
+        end
+
+        def set_item_column_values(item:, iter:)
+            @columns_props.each_with_index { |column, column_index|
+                iter[column_index] = column.display_text_of(item)
+            }
+        end
+
+        # Querying
+
+        def selection_indices()
+            indices = []
+
+            tree_view.selection.each { |list, tree_path, iter|
+                indices << tree_path_to_index(tree_path)
+            }
+
+            indices
+        end
+
+        def set_selection_indices(indices)
+            if indices.empty?
+                tree_view.unselect_all
+                return
+            end
+
+            path = Gtk::TreePath.new(
+                    indices.join(':')
+                )
+
+            tree_view.selection.select_path(path)
+
+            tree_view.scroll_to_cell(path, nil, false, 0.0, 0.0)
+        end
+
+        # Utility methods
+
+        def tree_path_to_index(tree_path)
+            tree_path.to_s
+                .to_i
+        end
+    end
+end

data/lib/views/menu_view.rb

@@ -0,0 +1,46 @@
+module Sirens
+    class MenuView < View
+
+        # Initializing
+
+        def initialize(menu_handle: Gtk::Menu.new)
+            @main_handle = menu_handle
+        end
+
+        # Adding
+
+        def item(label:, enabled: true, action:)
+            menu_item_handle = Gtk::MenuItem.new(label: label)
+            menu_item_handle.sensitive = enabled
+
+            menu_item_handle.signal_connect('activate') { |props|
+               action.call
+            }
+
+            @main_handle.append(menu_item_handle)
+        end
+
+        def separator()
+            @main_handle.append(Gtk::SeparatorMenuItem.new)
+        end
+
+        ##
+        # Subscribes this View to the events/signals emitted by the GUI handle(s) of interest.
+        # When an event/signal is received calls the proper event_handler provided by the PrimitiveComponent,
+        # if one was given.
+        #
+        def subscribe_to_ui_events()
+        end
+
+        # Asking
+
+        def empty?()
+            main_handle.children.empty?
+        end
+
+        def open(props)
+            main_handle.show_all
+            main_handle.popup(nil, nil, props[:button], props[:time])
+        end
+    end
+end

data/lib/views/notebook_view.rb

@@ -0,0 +1,27 @@
+module Sirens
+    class NotebookView < View
+
+        # Initializing
+
+        def initialize_handles()
+            @main_handle = Gtk::Notebook.new
+        end
+
+        def subscribe_to_ui_events()
+        end
+
+        # Styles
+
+        def set_tab_label_at(index:, text:)
+            page_handle = main_handle.children[index]
+
+            main_handle.set_tab_label_text(page_handle, text)
+        end
+
+        # Querying
+
+        def tab_label_at(index:)
+            main_handle.get_tab_label_text(main_handle.children[index])
+        end
+    end
+end

data/lib/views/paned_view.rb

@@ -0,0 +1,26 @@
+module Sirens
+    class PanedView < View
+
+        # Initializing
+
+        def initialize(orientation:, on_size_allocation:)
+            @orientation = orientation
+            @on_size_allocation = on_size_allocation
+
+            super()
+        end
+
+        def initialize_handles()
+            @main_handle = Gtk::Paned.new(@orientation)
+        end
+
+        def subscribe_to_ui_events()
+            main_handle.signal_connect('size-allocate') {
+                @on_size_allocation.call(
+                    width: main_handle.allocation.width,
+                    height: main_handle.allocation.height
+                )
+            }
+        end
+    end
+end

data/lib/views/radio_button_view.rb

@@ -0,0 +1,67 @@
+module Sirens
+    class RadioButtonView < View
+
+        # Class methods
+
+        class << self
+            ##
+            # Answer the styles accepted by this view.
+            #
+            def view_accepted_styles()
+                super() + [:label].freeze
+            end
+        end
+
+        # Initializing
+
+        def initialize(previous_button:, on_toggled:)
+            @previous_button = previous_button.main_handle unless previous_button.nil?
+
+            @on_toggled_block = on_toggled
+
+            super()
+        end
+
+        def initialize_handles()
+            @main_handle = Gtk::RadioButton.new(member: @previous_button)
+        end
+
+        def subscribe_to_ui_events()
+            main_handle.signal_connect('clicked') {
+                on_toggled
+            }
+        end
+
+        # Styles
+
+        def label=(value)
+            main_handle.label = value
+        end
+
+        def label()
+            main_handle.label
+        end
+
+        # Actions
+
+        def click()
+            main_handle.clicked
+        end
+
+        # Querying
+
+        def get_value()
+            main_handle.active?
+        end
+
+        def set_value(boolean)
+            main_handle.active = boolean
+        end
+
+        # Events
+
+        def on_toggled()
+            @on_toggled_block.call(state: get_value)
+        end
+    end
+end

data/lib/views/stack_view.rb

@@ -0,0 +1,26 @@
+module Sirens
+    class StackView < View
+
+        # Initializing
+
+        def initialize(orientation)
+            @orientation = orientation
+
+            super()
+        end
+
+        def initialize_handles()
+            @main_handle = Gtk::Box.new(@orientation, 0)
+        end
+
+        def subscribe_to_ui_events()
+        end
+
+        ##
+        # Adds a child_view.
+        #
+        def add_view(view, expand: true, fill: true, padding: 0)
+            main_handle.pack_start(view.main_handle, expand: expand, fill: fill, padding: padding)
+        end
+    end
+end