glimmer-dsl-swt 4.18.7.6 → 4.20.0.0

data/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md

@@ -368,7 +368,7 @@ These proxy objects have an API and provide some convenience methods, some of wh
 
 Glimmer SWT proxies come with the instance method `#swt_widget`, which returns the actual SWT `Widget` object wrapped by the Glimmer widget proxy. It is useful in cases you'd like to do some custom SWT programming outside of Glimmer.
 
-##### Shell widget proxy methods
+##### Shell Widget Proxy Methods
 
 Shell widget proxy has extra methods specific to SWT Shell:
 - `#open`: Opens the shell, making it visible and active, and starting the SWT Event Loop (you may learn more about it here: https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Display.html). If shell was already open, but hidden, it makes the shell visible.
@@ -380,6 +380,7 @@ Shell widget proxy has extra methods specific to SWT Shell:
 - `#visible?`: Returns whether a shell is visible
 - `#opened_before?`: Returns whether a shell has been opened at least once before (additionally implying the SWT Event Loop has been started already)
 - `#visible=`: Setting to true opens/shows shell. Setting to false hides the shell.
+- `#layout`: Lays out contained widgets using SWT's `Shell#layout` method
 - `#pack`: Packs contained widgets using SWT's `Shell#pack` method
 - `#pack_same_size`: Packs contained widgets without changing shell's size when widget sizes change
 
@@ -919,6 +920,7 @@ Example loading a URL (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
 ```ruby
 shell {
   minimum_size 1024, 860
+  maximum_size 2000, 1000
   browser {
     url 'http://brightonresort.com/about'
   }
@@ -1040,6 +1042,10 @@ shell(:no_resize) {
 }
 ```
 
+##### Fill Screen Window
+
+SWT Shell can open and fill the screen with this style `swt(:fill_screen)`. This makes it have the size of the display, thus filling the screen. Keep in mind that this is different from being maximized (which is a special window state, not just filling the screen).
+
 ### Widget Properties
 
 Widget properties such as text value, enablement, visibility, and layout details are set within the widget block using methods matching SWT widget property names in lower snakecase. You may refer to SWT widget guide for details on available widget properties:
@@ -2226,13 +2232,13 @@ This example adds on the one above it by specifying converters on read and write
 
 `text bind(contact, 'address.street', sync_exec: true)`
 
-**(ALPHA FEATURE)**
+**(BETA FEATURE)**
 
 This example forces GUI updates via [sync_exec](#sync_exec) assuming they are coming from another thread (different from the GUI thread)
 
 `text bind(contact, 'address.street', async_exec: true)`
 
-**(ALPHA FEATURE)**
+**(BETA FEATURE)**
 
 This example forces GUI updates via [async_exec](#async_exec) assuming they are coming from another thread (different from the GUI thread)
 
@@ -2244,7 +2250,7 @@ This example also specifies a converter on read of the model property, but via a
 
 This is a block shortcut version of the syntax above it. It facilitates formatting model data for read-only widgets since it's a very common view concern. It also saves the developer from having to create a separate formatter/presenter for the model when the view can be an active view that handles common simple formatting operations directly.
 
-`text bind(contact, 'address.street', read_only: true)
+`text bind(contact, 'address.street', read_only: true)`
 
 This is read-ohly data-binding. It doesn't update contact.address.street when widget text property is changed.
 
@@ -2266,6 +2272,33 @@ This example demonstrates nested indexed computed value data binding whereby the
 
 Example from [samples/hello/hello_combo.rb](samples/hello_combo.rb) sample (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
 
+#### Shine
+
+**(EARLY ALPHA FEATURE)**
+
+The new Shine syntax for View/Model Attribute Mapping allows data-binding visually with simple arrow operators in Ruby.
+
+Use `<=> [model, attribute, options]` for bidirectional (two-way) data-binding instead of `bind(model, attribute, options)`.
+Use `<= [model, attribute, options]` for unidirectional (one-way) data-binding instead of `bind(model, attribute, read_only: true, more_options)`
+
+Examples:
+
+```ruby
+text <=> [@contact, :first_name]
+```
+
+```ruby
+text <=> [@contact, :last_name]
+```
+
+```ruby
+text <= [@contact, :name, computed_by: [:first_name, :last_name]]
+```
+
+Note that `table`, `tree`, custom widgets, custom shapes, and animations are not supported by Shine syntax for data-binding yet, so continue to use `bind` with them for the time being.
+
+Check out [sample code](/samples) for more examples of Shine syntax in action, such as [Hello, Computed!](/docs/reference/GLIMMER_SAMPLES.md#hello-computed).
+
 #### Combo
 
 The `combo` widget provides a dropdown of options. By default, it also allows typing in a new option. To disable that behavior, you may use with the `:read_only` SWT style.
@@ -3119,8 +3152,6 @@ You may see another example at the [Hello, Radio Group!](GLIMMER_SAMPLES.md#hell
 
 ##### Code Text Custom Widget
 
-**(BETA FEATURE)**
-
 `code_text` is a Glimmer built-in custom widget that displays syntax highlighted Ruby code in a customized SWT [StyledText](https://help.eclipse.org/2020-09/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/custom/StyledText.html) widget.
 
 It is used in the [Glimmer Meta-Sample (The Sample of Samples)](#samples):
@@ -3145,8 +3176,6 @@ To use, simply use `code_text` in place of the `text` or `styled_text` widget. I
 **lines**
 (default: `false`)
 
-**(BETA FEATURE)**
-
 Shows line numbers when set to true.
 
 If set to a hash like `{width: 4}`, it sets the initial width of the line numbers lane in character count (default: 4)
@@ -3184,7 +3213,7 @@ Sets the code language, which can be one of the following [rouge gem](#https://r
 - bibtex
 - biml
 - bpf
-- brainfuck
+- brainf*ck
 - brightscript
 - bsl
 - c
@@ -3471,7 +3500,7 @@ shell { |app_shell|
 }.open
 ```
 
-If you use a Custom Shell as the top-level app shell, you may invoke the class method `::launch` instead to avoid building an app class yourself or including Glimmer into the top-level namespace (e.g. `Tetris.launch` instead of `include Glimmer; tetris.open`)
+If you use a Custom Shell as the top-level app shell, you may invoke the class method `.launch` instead to avoid building an app class yourself or including Glimmer into the top-level namespace (e.g. `Tetris.launch` instead of `include Glimmer; tetris.open`)
 
 You may check out [Hello, Custom Shell!](GLIMMER_SAMPLES.md#hello-custom-shell) for another example.
 

data/docs/reference/GLIMMER_PACKAGING_AND_DISTRIBUTION.md

@@ -20,6 +20,12 @@ You may choose to generate a specific type of packaging instead by addionally pa
 glimmer package[msi]
 ```
 
+Make sure to surround with double-quotes when running from ZShell (zsh):
+
+```
+glimmer "package[msi]"
+```
+
 - Available Mac packaging types are `dmg`, `pkg`, and `image` (image means a pure Mac `app` without a setup program). Keep in mind that the packages you produce are compatible with the same MacOS you are on or older.
 - Available Windows packaging types are `msi`, `exe`, and `image` (image means a Windows application directory without a setup program). Learn more about Windows packaging are [over here](#windows-application-packaging).
 
@@ -190,7 +196,7 @@ Currently, `Glimmer::RakeTask::Package.javapackager_extra_args` is only honored
 You can get around that in zsh by running glimmer package commands with `bash -c` prefix:
 
 ```
-bash -c 'glimmer package'
+bash -c 'source ~/.glimmer_source; glimmer package'
 ```
 
 4. Java on Windows System PATH

data/docs/reference/GLIMMER_SAMPLES.md

@@ -2,7 +2,9 @@
   - [Hello Samples](#hello-samples)
     - [Hello, World!](#hello-world)
     - [Hello, Tab!](#hello-tab)
+    - [Hello, C Tab!](#hello-c-tab)
     - [Hello, Combo!](#hello-combo)
+    - [Hello, C Combo!](#hello-c-combo)
     - [Hello, List Single Selection!](#hello-list-single-selection)
     - [Hello, List Multi Selection!](#hello-list-multi-selection)
     - [Hello, Computed!](#hello-computed)
@@ -101,6 +103,20 @@ Code:
 ![Hello Tab English](/images/glimmer-hello-tab-english.png)
 ![Hello Tab French](/images/glimmer-hello-tab-french.png)
 
+#### Hello, C Tab!
+
+This sample demonstrates custom tab widget usage via the `c_tab_folder` and `c_tab_item` variations of `tab_folder` and `tab_item`, which can customize fonts/background/foreground colors for tabs and display additional tabs that do not fit in the window via a drop down.
+
+Code:
+
+[samples/hello/hello_c_tab.rb](/samples/hello/hello_c_tab.rb)
+
+![Hello C Tab](/images/glimmer-hello-c-tab.png)
+![Hello C Tab Extra Tabs](/images/glimmer-hello-c-tab-extra-tabs.png)
+![Hello C Tab Other Tab](/images/glimmer-hello-c-tab-other-tab.png)
+
+Country flag images were made by [Freepik](https://www.flaticon.com/authors/freepik) from [www.flaticon.com](http://www.flaticon.com)
+
 #### Hello, Combo!
 
 This sample demonstrates combo data-binding.
@@ -112,6 +128,17 @@ Code:
 ![Hello Combo](/images/glimmer-hello-combo.png)
 ![Hello Combo Expanded](/images/glimmer-hello-combo-expanded.png)
 
+#### Hello, C Combo!
+
+This sample demonstrates the custom combo variation on combo, which allows the adjustment of the combo height based on font height or layout data.
+
+Code:
+
+[samples/hello/hello_c_combo.rb](/samples/hello/hello_c_combo.rb)
+
+![Hello Combo](/images/glimmer-hello-c-combo.png)
+![Hello Combo Expanded](/images/glimmer-hello-c-combo-expanded.png)
+
 #### Hello, List Single Selection!
 
 This sample demonstrates list single-selection data-binding.

data/lib/glimmer-dsl-swt.rb

@@ -42,3 +42,11 @@ require 'facets/hash/symbolize_keys'
 require 'ext/glimmer/config'
 require 'ext/glimmer'
 require 'glimmer/dsl/swt/dsl'
+
+if defined?(::IRB)
+  begin
+    Kernel.send(:remove_method, :y)
+  rescue
+    # No Op
+  end
+end

data/lib/glimmer/data_binding/shine.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2007-2021 Andy Maleh
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
 # "Software"), to deal in the Software without restriction, including
@@ -7,10 +7,10 @@
 # distribute, sublicense, and/or sell copies of the Software, and to
 # permit persons to whom the Software is furnished to do so, subject to
 # the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be
 # included in all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
@@ -19,26 +19,41 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-## NOTE: Unsupported for now TODO support in the future
-#
-# require File.dirname(__FILE__) + "/glimmer"
-#
-# class Array
-#   include Glimmer
-#
-#   alias original_compare <=>
-#
-#   def <=>(other)
-#     if (self[0].class.name == "WidgetProxy")
-#       content(self[0]) {
-#         if (other.size == 2)
-#           eval("#{self[1]} bind (other[0], other[1])")
-#         elsif (other.size == 3)
-#           eval("#{self[1]} bind (other[0], other[1], other[2])")
-#         end
-#       }
-#     else
-#       original_compare(other)
-#     end
-#   end
-# end
+module Glimmer
+  module DataBinding
+    class Shine
+      include Glimmer
+      
+      def initialize(parent, parent_attribute)
+        @parent = parent
+        @parent_attribute = parent_attribute
+      end
+    
+      alias original_compare <=>
+    
+      def <=>(other)
+        if other.is_a?(Array)
+          @parent.content {
+            send(@parent_attribute, bind(*other))
+          }
+        else  # || other.is_a?(Hash) # TODO support hash e.g. {model: model_obj, attribute: :some_attribute, more-options...}
+          original_compare(other)
+        end
+      end
+    
+      def <=(other)
+        if other.is_a?(Array)
+          args_clone = other.clone
+          if args_clone.last.is_a?(Hash)
+            args_clone.last[:read_only] = true
+          else # || other.is_a?(Hash) # TODO support hash e.g. {model: model_obj, attribute: :some_attribute, more-options...}
+            args_clone << {read_only: true}
+          end
+          @parent.content {
+            send(@parent_attribute, bind(*args_clone))
+          }
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/data_binding/widget_binding.rb

@@ -53,7 +53,7 @@ module Glimmer
             return
           end
           # need the rescue false for a scenario with tree items not being equal to model objects raising an exception
-          unless ((value == evaluate_property) rescue false) # need the rescue false for a scenario with tree items not being equal to model objects raising an exception
+          if @async_exec || !((value == evaluate_property) rescue false) # need the rescue false for a scenario with tree items not being equal to model objects raising an exception
             @widget.set_attribute(@property, value)
           end
         end

data/lib/glimmer/dsl/swt/c_tab_item_expression.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2007-2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'glimmer'
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/parent_expression'
+require 'glimmer/swt/widget_proxy'
+require 'glimmer/swt/c_tab_item_proxy'
+
+module Glimmer
+  module DSL
+    module SWT
+      class CTabItemExpression < StaticExpression
+        include ParentExpression
+  
+        include_package 'org.eclipse.swt.custom'
+  
+        def can_interpret?(parent, keyword, *args, &block)
+          initial_condition = (keyword == 'c_tab_item') and parent.respond_to?(:swt_widget)
+          if initial_condition
+            if parent.swt_widget.is_a?(CTabFolder)
+              return true
+            else
+              Glimmer::Config.logger.error {"c_tab_item widget may only be used directly under a c_tab_folder widget!"}
+            end
+          end
+          false
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::SWT::CTabItemProxy.new(parent, args)
+        end
+        
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/glimmer/dsl/swt/combo_selection_data_binding_expression.rb

@@ -29,12 +29,13 @@ module Glimmer
     module SWT
       class ComboSelectionDataBindingExpression < Expression
         include_package 'org.eclipse.swt.widgets'
+        include_package 'org.eclipse.swt.custom'
   
         def can_interpret?(parent, keyword, *args, &block)
           keyword == 'selection' and
             block.nil? and
             parent.respond_to?(:swt_widget) and
-            parent.swt_widget.is_a?(Combo) and
+            (parent.swt_widget.is_a?(Combo) || parent.swt_widget.is_a?(CCombo)) and
             args.size == 1 and
             args[0].is_a?(DataBinding::ModelBinding) and
             args[0].evaluate_options_property.is_a?(Array)

data/lib/glimmer/dsl/swt/dsl.rb

@@ -20,7 +20,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'glimmer/launcher'
-require Glimmer::Launcher.swt_jar_file
+require ENV['SWT_JAR_FILE_PATH'] || "#{Glimmer::Launcher.swt_jar_file}#{Glimmer::Launcher.special_cpu_architecture_suffix}"
 require 'glimmer/dsl/engine'
 Dir[File.expand_path('../*_expression.rb', __FILE__)].each {|f| require f}
 
@@ -52,6 +52,7 @@ module Glimmer
           image
           multiply
           property
+          shine_data_binding
           block_property
           dialog
           widget

data/lib/glimmer/dsl/swt/shine_data_binding_expression.rb

@@ -0,0 +1,49 @@
+# Copyright (c) 2007-2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'glimmer/dsl/expression'
+require 'glimmer/data_binding/model_binding'
+require 'glimmer/data_binding/widget_binding'
+require 'glimmer/swt/display_proxy'
+require 'glimmer/data_binding/shine'
+
+module Glimmer
+  module DSL
+    module SWT
+      class ShineDataBindingExpression < Expression
+        def can_interpret?(parent, keyword, *args, &block)
+          args.size == 0 and
+            block.nil? and
+            parent.respond_to?(:set_attribute) and
+            parent.respond_to?(:has_attribute?) and
+            parent.has_attribute?(keyword, *args) and
+            !parent.is_a?(Glimmer::UI::CustomWidget) and
+            !parent.is_a?(Glimmer::UI::CustomShape) and
+            !(parent.respond_to?(:swt_widget) && parent.swt_widget.class == org.eclipse.swt.widgets.Canvas && keyword == 'image')
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::DataBinding::Shine.new(parent, keyword)
+        end
+      end
+    end
+  end
+end