libui_paradise 0.2.48

data/doc/SNIPPETS.md

@@ -0,0 +1,94 @@
+# How to add a new main window:
+                                             # width, height, hasMenubar
+  main_window = UI.new_window('hello world', 300, 200, 1)
+
+  Source code:
+
+    https://raw.githubusercontent.com/andlabs/libui/master/unix/window.c
+
+# How to add a libui-widget to the main window / Designate a child widget:
+
+  UI.window_set_child(main_window, button)
+
+# Act on closing-event (on quit tag):
+
+  UI.window_on_closing(main_window) {
+    puts 'Bye Bye'
+    UI.control_destroy(main_window)
+    UI.quit
+    0
+  }
+  # Or simpler:
+  close_properly(main_window)
+
+# Add the window to the main UI:
+
+  UI.control_show(main_window)
+  main_window.show_the_controls # Or use this one here.
+
+
+# Add a checkbox (checkbox tag, checkbutton)
+
+  checkbox = UI.new_checkbox('Checkbox') # or ui_checkbox
+  checkbox_toggle_callback = proc { |pointer|
+    checked = UI.checkbox_checked(pointer) == 1
+    UI.window_set_title(MAIN_WINDOW, "Checkbox is #{checked}")
+    UI.checkbox_set_text(pointer, "I am the checkbox (#{checked})")
+    0
+  }
+  UI.checkbox_on_toggled(checkbox, checkbox_toggle_callback, nil)
+  UI.box_append(inner, checkbox, 0)
+
+  To set it checked:
+
+  checkbox.set_checked(1)
+
+  To query its state:
+
+    checked = UI.checkbox_checked(pointer) == 1
+
+# And the control:
+
+  UI.control_show(main_window)
+
+# Using a text-entry (ui entry tag):
+
+  text_entry = UI.new_entry
+  UI.entry_set_text(text_entry, 'Please enter your feelings')
+  UI.entry_on_changed(text_entry, text_changed_callback, nil)
+
+  # To set this on a "multiline entry", aka spanning several
+  # rows, do use:
+  UI.multiline_entry_set_text(entry1, 'Yo there')
+  ui_text_view # an alias used in libui_paradise
+
+  text1 = UI.entry_text(entry1) # Obtain text. You may have to call .to_s on it, to guarantee the String.
+  UI.multiline_entry_text # Obtain the text from a multiline entry.
+
+# Create a combobox (combo tag, combobox tag):
+
+  combobox_selected_callback = proc { |ptr|
+    puts "New combobox selection: #{UI.combobox_selected(ptr)}"
+  }
+  cbox = UI.new_combobox
+  UI.combobox_append(cbox, 'combobox Item 1')
+  UI.combobox_append(cbox, 'combobox Item 2')
+  UI.combobox_append(cbox, 'combobox Item 3')
+  UI.box_append(inner, cbox, 0)
+  UI.combobox_on_selected(cbox, combobox_selected_callback, nil)
+
+  # Or more concise:
+  combo_box = UI.combobox {
+    ['combobox Item 1', 'combobox Item 2', 'combobox Item 3']
+  }
+
+
+# Add content to an editable combox:
+
+  UI.append() # .append() adds the named item to the end of the EditableCombobox.
+
+# How to build a menu-interface (menu tag):
+
+  help_menu = UI.new_menu('Help')
+  version_item = UI.menu_append_item(help_menu, 'Version')
+

data/doc/todo/todo.md

@@ -0,0 +1,16 @@
+- Make sure that each component has a screenshot. It's ok to
+  re-use existing screenshots from other projects.
+
+- Make sure the project is API compatible to glimmer-libui.
+
+- Rewrite the project from the get-go. Also integrate 
+  @main_window into the main hash, rather than have it
+  standalone. ^^^ this should be fixed ASAP - it is not
+  elegant to have a separate @main_window ... but for
+  now we'll keep it as-is.
+
+- Re-organize the examples, perhaps starting with another
+  one.
+
+- Check for image and font support again. Something isn't
+  working!

data/lib/libui_paradise/autoinclude.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/autoinclude.rb'
+# =========================================================================== #
+require 'libui_paradise/requires/require_the_libui_paradise_project.rb'
+
+include LibuiParadise::Extensions

data/lib/libui_paradise/base/base.rb

@@ -0,0 +1,154 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === LibuiParadise::Base
+# =========================================================================== #
+# require 'libui_paradise/base/base.rb'
+# < LibuiParadise::Base
+# =========================================================================== #
+module LibuiParadise
+
+class Base # === LibuiParadise::Base
+
+  alias e puts
+
+  require 'libui_paradise'
+  include LibuiParadise::Extensions
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Generic Title'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH  = 800
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 640
+
+  # ========================================================================= #
+  # === default_title_width_height
+  # ========================================================================= #
+  def default_title_width_height(
+      title  = TITLE,
+      width  = WIDTH,
+      height = HEIGHT
+    )
+    title_width_height(
+      title,
+      width,
+      height
+    )
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    title_width_height(TITLE, WIDTH, HEIGHT)
+    # ======================================================================= #
+    # === @window
+    # ======================================================================= #
+    set_window(
+      return_default_window
+    )
+  end
+
+  # ======================================================================= #
+  # === update_the_main_window
+  # ======================================================================= #
+  def update_the_main_window
+    set_window(
+      return_default_window
+    )
+  end
+
+  # ======================================================================= #
+  # === return_default_window
+  # ======================================================================= #
+  def return_default_window(
+      title  = title?,
+      width  = width?,
+      height = height?
+    )
+    return ui_padded_main_window(title, width, height, 0)
+  end
+
+  # ======================================================================= #
+  # === set_window
+  #
+  # Simply assign to @window here.
+  # ======================================================================= #
+  def set_window(i = return_default_window)
+    @window = i
+  end
+
+  # ========================================================================= #
+  # === create_skeleton                            (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_skeleton
+  end
+
+  # ========================================================================= #
+  # === add_these_widgets_to_the_main_window
+  #
+  # This method can be used to batch-add several widgets into the
+  # main window at hand. It has been created in September 2022 to
+  # simplify adding widgets from simple scripts. If we can easily
+  # add widgets then this will help write smaller GUIs quickly.
+  #
+  # For now the main container to be used is a vertical-box here.
+  # In theory this could be changed, but for now this is how it
+  # is.
+  # ========================================================================= #
+  def add_these_widgets_to_the_main_window(*i)
+    outer_vbox = padded_vbox
+    # ======================================================================= #
+    # First add the two buttons on top:
+    # ======================================================================= #
+    outer_vbox.add_hsep
+    i.flatten.each {|this_widget|
+      # ===================================================================== #
+      # Some symbols exist as special keywords:
+      # ===================================================================== #
+      case this_widget
+      # ===================================================================== #
+      # === :create_a_quit_button
+      # ===================================================================== #
+      when :create_a_quit_button
+        this_widget = quit_button
+      end
+      outer_vbox.minimal(this_widget)
+    }
+    @window.add(outer_vbox)
+    if i.size > 0
+      Thread.new {
+        sleep 5
+        require 'save_file'
+        SaveFile.write_what_into('YO','/Depot/j/ACK.md')
+        exit
+      }
+    end
+    @window.intelligent_exit
+  end; alias add_these_widgets add_these_widgets_to_the_main_window # === add_these_widgets
+
+  # ========================================================================= #
+  # === run_in_the_background
+  # ========================================================================= #
+  def run_in_the_background
+    Process.daemon
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    create_skeleton_then_connect_skeleton
+  end
+
+end; end

data/lib/libui_paradise/colours/colours.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/colours/colours.rb
+# =========================================================================== #
+module LibuiParadise
+
+  # ========================================================================= #
+  # === COLOR_BLUE
+  # ========================================================================= #
+  COLOR_BLUE = 0x1E90FF
+
+end

data/lib/libui_paradise/domain_specific_language/README.md

@@ -0,0 +1,5 @@
+The directory here is an attempt to simplify the bindings in
+libui_paradise even more.
+
+For instance, the user should be able to parse widgets that
+are described in pure yaml.

data/lib/libui_paradise/domain_specific_language/button.yml

@@ -0,0 +1,7 @@
+button:
+ id:               button1
+ text: 'This is a button.'
+ width:                120
+ height:                80
+ on_clicked:
+  do_call_this_method

data/lib/libui_paradise/examples/complex/001_hbox_example.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'complex/001_hbox_example.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = ui_padded_window(:filename, 500, 200)
+
+hbox1 = ui_hbox
+hbox1 << text('This is a hbox example.')
+hbox1 << ui_entry
+hbox1 << text('As can be seen we add elements in a horizontal (side-by-side) manner.')
+window << hbox1
+window.child = hbox1
+window.intelligent_exit

data/lib/libui_paradise/examples/complex/002_tabs_example.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require '002_tabs_example.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+#require 'libui_paradise/requires/require_the_libui_paradise_project.rb'
+
+window = ui_main_window('A notebook with tabs example', 1200, 200, 15)
+
+tab = ui_tabs
+tab.add('Page 1', hbox(text('One! 😎️')))
+tab.add('Page 2', hbox(text('Two! 😍️')))
+tab.add('Page 3', hbox(text('Three! 😘️')))
+tab.add('Page 4', hbox(text('Four! 😗️')))
+tab.add('Page 5', hbox(text('Five! 😙️')))
+tab.add('Page 6', hbox(text('Six! 😚️')))
+
+box = ui_padded_vbox
+box << tab
+
+window.child = box
+window.control_show
+window.intelligent_exit

data/lib/libui_paradise/examples/complex/003_open_file_button_example.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This example shows how to open a file via ruby-libui.
+# =========================================================================== #
+# require 'libui_paradise/complex/003_open_file_button_example.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = ui_padded_main_window('An open-file button-example', 1200, 200, 15)
+
+outer_vbox = ui_padded_vbox
+button_open_file = ui_button('Open file')
+button_open_file.on_clicked {
+  begin
+    #filename = ui_open_file(window).to_s
+    filename = ::LibUI.open_file(main_window).to_s
+    e "The filename was: #{filename}"
+  rescue ArgumentError => error # Rescue from "NULL pointer given"
+    pp error
+  end
+}
+outer_vbox << button_open_file
+
+window.child = outer_vbox
+window.intelligent_quit
+
+
+if false
+LibUI.button_on_clicked(button) {
+  result = ::LibUI.open_file(main_window).to_s
+  if File.exist?(result)
+    e 'The file exists. \o/'
+  end
+}
+
+end

data/lib/libui_paradise/examples/complex/004_font_button.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'examples/complex/004_font_button.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+alias e puts
+
+main_window = ui_window('hello world', 300, 200, 1)
+
+font_button = ui_font_button
+# =========================================================================== #
+# === font_descriptor
+#
+# The font_descriptor will contain all the important information about the
+# font at hand. It will be updated via UI.font_button_font().
+# =========================================================================== #
+font_descriptor = ui_font_descriptor('Hack')
+LibUI.font_button_on_changed(font_button) {
+  LibUI.font_button_font(font_button, font_descriptor)
+  # ========================================================================= #
+  # The following line will output something like:
+  #
+  #   {:family=>"Georgia", :size=>12.0, :weight=>700, :italic=>0, :stretch=>4}
+  #
+  # ========================================================================= #
+  e
+  e 'The chosen font is:'
+  e
+  p family:  font_descriptor.Family.to_s,
+    size:    font_descriptor.Size,
+    weight:  font_descriptor.Weight,
+    italic:  font_descriptor.Italic,
+    stretch: font_descriptor.Stretch
+}
+main_window.close_properly
+main_window.child = font_button
+main_window.control_show
+LibUI.main_then_quit

data/lib/libui_paradise/examples/complex/005_search_entry_example.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require '005_search_entry_example.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = ui_main_window('A search-entry example', 1200, 200, 15)
+
+search_entry = ui_search_entry
+box = ui_padded_vbox
+box << search_entry
+box.is_padded
+
+window.child = box
+window.control_show
+window.intelligent_exit

data/lib/libui_paradise/examples/complex/006_coloured_boxes_example.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/examples/complex/006_coloured_boxes_example.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+require 'colours' # Needs the colours gem.
+
+window = ui_main_window('Coloured boxes example', 320, 200, 1)
+
+outer_hbox = ui_hbox
+outer_hbox.maximal LibuiParadise.draw_rectangle(:default, :default, Colours.random_html_colour)
+outer_hbox.maximal LibuiParadise.draw_rectangle(:default, :default, :seagreen)
+outer_hbox.maximal LibuiParadise.draw_rectangle(:default, :default, :springgreen)
+outer_hbox.maximal LibuiParadise.draw_rectangle(:default, :default, :royalblue)
+outer_hbox.maximal LibuiParadise.draw_rectangle(:default, :default, :lightblue)
+outer_hbox.maximal LibuiParadise.draw_rectangle(:default, :default, :steelblue)
+
+window.add(outer_hbox)
+window.intelligent_quit

data/lib/libui_paradise/examples/complex/007_slider_example.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/examples/033_slider_example.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = ui_main_window('Slider Example', 250, 70, 1)
+
+slider = ui_slider(0, 100)
+
+# =========================================================================== #
+# === callback_for_the_slider
+# =========================================================================== #
+def callback_for_the_slider
+  proc { |pointer|
+    puts "New Slider value: #{UI.slider_value(pointer)}"
+  }
+end
+slider.on_changed { callback_for_the_slider }
+
+# =========================================================================== #
+# The original variant would go like this:
+#
+#   LibUI.slider_on_changed(slider, slider_changed_callback)
+#
+# =========================================================================== #
+outer_vbox = ui_padded_vbox(slider)
+window.add(outer_vbox)
+window.intelligent_quit

data/lib/libui_paradise/examples/complex/008_radio_button_example.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require '032_form_example.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = margined_window(:filename, 320, 200, 0)
+
+outer_vbox = padded_vbox
+array_to_use = ['Radio Button 1', 'Radio Button 2', 'Radio Button 3']
+# =========================================================================== #
+# Keep the buttons padded via hsep on top and on the bottom.
+# =========================================================================== #
+
+outer_vbox.minimal(hsep, 0)
+rb = ui_radio_buttons(array_to_use)
+outer_vbox.minimal(rb)
+outer_vbox.minimal(hsep, 0)
+
+window.child = outer_vbox
+window.intelligent_quit

data/lib/libui_paradise/examples/complex/009_separator_example.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/009_separator_example.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = margined_window(:filename, 250, 150, 0)
+
+outer_vbox = padded_vbox
+
+button_hello_world = button('A button')
+button_hello_world.on_clicked {
+  e 'Hello world!'
+}
+
+outer_vbox.minimal(hsep, 1)
+outer_vbox.minimal(hsep, 0)
+outer_vbox.minimal(button_hello_world, 1)
+outer_vbox.minimal(hsep, 0)
+outer_vbox.minimal(hsep, 1)
+
+window.child = outer_vbox
+window.intelligent_quit

data/lib/libui_paradise/examples/complex/010_table_example.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Todo:
+#
+# - Add editable entry to the table
+#
+# =========================================================================== #
+# require 'libui_paradise/010_table_example.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+main_window = padded_window('30) Table example', 300, 200, 1)
+hbox = padded_hbox
+data = [
+  %w( cat calm meow ),
+  %w( dog loyal woof ),
+  %w( chicken bird cock-a-doodle-doo ),
+  %w( horse fast neigh ),
+  %w( cow slow moo )
+]
+
+# Protect BlockCaller objects from garbage collection.
+@block_callers = []
+def rbcallback(*args, &block)
+  args << [0] if args.size == 1 # Argument types are ommited
+  block_caller = Fiddle::Closure::BlockCaller.new(*args, &block)
+  @block_callers << block_caller
+  block_caller
+end
+
+model_handler = LibUI::FFI::TableModelHandler.malloc
+model_handler.to_ptr.free = Fiddle::RUBY_FREE
+
+model_handler.NumColumns = rbcallback(4) { 2 }
+model_handler.ColumnType = rbcallback(4) { 0 }
+model_handler.NumRows    = rbcallback(4) { 5 }
+model_handler.CellValue  = rbcallback(1, [1, 1, 4, 4]) do |_, _, row, column|
+  LibUI.new_table_value_string(data[row][column])
+end
+model_handler.SetCellValue = rbcallback(0, [0]) {}
+
+model = LibUI.new_table_model(model_handler)
+
+table_params = ui_table_params_malloc(model)
+
+table = ui_table(table_params)
+table.append_text_column('Animal',      0, -1)
+table.append_text_column('Description', 1, -1)
+table.append_text_column('Fancy Stuff', 2, -1)
+
+hbox.add(table, 1)
+main_window.child = hbox
+main_window.intelligent_quit

data/lib/libui_paradise/examples/complex/011_two_buttons_showing_how_to_enable_and_disable_them.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'examples/complex/011_two_buttons_showing_how_to_enable_and_disable_them.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+main_window = padded_main_window(
+  'Two buttons showing how to enable and disable them', 300, 60, 0
+)
+
+outer_hbox = padded_hbox
+
+button1 = button('Button #1')
+button2 = button('Button #2')
+button2.disable # Start-state for this button.
+
+outer_hbox << button1
+outer_hbox << button2
+
+button1.on_clicked {|widget|
+  button2.enable
+  button1.disable
+}
+button2.on_clicked {|widget|
+  button1.enable
+  button2.disable
+}
+
+main_window.child = outer_hbox
+main_window.intelligent_exit

data/lib/libui_paradise/examples/complex/012_password_entry_example.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'libui_paradise/examples/012_password_entry_example.rb'
+# =========================================================================== #
+require 'libui_paradise/autoinclude'
+
+window = margined_window('Password Entry Example', 280, 80, 0)
+
+outer_vbox = padded_vbox
+entry_containing_the_password = password_entry
+LibUI.entry_on_changed(entry_containing_the_password) { |entry|
+  e 'The text is now: '+entry_containing_the_password.text?
+}
+
+outer_vbox.minimal(text('Password: '), 0)
+outer_vbox.minimal(entry_containing_the_password, 0)
+
+button = button('Show the password')
+button.on_clicked {
+  _ = entry_containing_the_password.text?.to_s
+  e _
+  message_box(window, _)
+}
+outer_vbox.minimal(button, 0)
+
+window.child = outer_vbox
+window.intelligent_quit