glimmer-dsl-swt 4.18.7.3 → 4.19.0.0

data/bin/glimmer_runner.rb

@@ -0,0 +1,4 @@
+require_relative '../lib/glimmer-dsl-swt'
+require_relative '../lib/glimmer/launcher'
+
+Glimmer::Launcher.new(ARGV).launch

data/docs/reference/GLIMMER_COMMAND.md

@@ -44,7 +44,7 @@ bin/glimmer samples
 Below are the full usage instructions that come up when running `glimmer` without args.
 
 ```
-Glimmer (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.18.4.4
+Glimmer (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.18.7.4
       
 Usage: glimmer [--bundler] [--pd] [--quiet] [--debug] [--log-level=VALUE] [[ENV_VAR=VALUE]...] [[-jruby-option]...] (application.rb or task[task_args]) [[application2.rb]...]
 
@@ -67,6 +67,7 @@ Tasks are run via rake. Some tasks take arguments in square brackets.
 Available tasks are below (if you do not see any, please add `require 'glimmer/rake_task'` to Rakefile and rerun or run rake -T):
 
 Select a Glimmer task to run: (Press ↑/↓ arrow to move, Enter to select and letters to filter)
+  glimmer list:gems:customshape[query]                       # List Glimmer custom shape gems available at rubygems.org (query is optional) [alt: list:gems:cp]
 ‣ glimmer list:gems:customshell[query]                       # List Glimmer custom shell gems available at rubygems.org (query is optional) [alt: list:gems:cs]
   glimmer list:gems:customwidget[query]                      # List Glimmer custom widget gems available at rubygems.org (query is optional) [alt: list:gems:cw]
   glimmer list:gems:dsl[query]                               # List Glimmer DSL gems available at rubygems.org (query is optional)
@@ -81,8 +82,11 @@ Select a Glimmer task to run: (Press ↑/↓ arrow to move, Enter to select and
   glimmer run[app_path]                                      # Runs Glimmer app or custom shell gem in the current directory, unless app_path is specified, then runs it instead (app_path is optional)
   glimmer samples                                            # Brings up the Glimmer Meta-Sample app to allow browsing, running, and viewing code of Glimmer samples
   glimmer scaffold[app_name]                                 # Scaffold Glimmer application directory structure to build a new app
+  glimmer scaffold:customshape[name,namespace]               # Scaffold Glimmer::UI::CustomShape subclass (part of a view) under app/views (namespace is optional) [alt: scaffold:cp]
   glimmer scaffold:customshell[name,namespace]               # Scaffold Glimmer::UI::CustomShell subclass (full window view) under app/views (namespace is optional) [alt: scaffold:cs]
   glimmer scaffold:customwidget[name,namespace]              # Scaffold Glimmer::UI::CustomWidget subclass (part of a view) under app/views (namespace is optional) [alt: scaffold:cw]
+  glimmer scaffold:desktopify[app_name,website]              # Desktopify a web app
+  glimmer scaffold:gem:customshape[name,namespace]           # Scaffold Glimmer::UI::CustomShape subclass (part of a view) under its own Ruby gem project (namespace is required) [alt: scaffold:gem:cp]
   glimmer scaffold:gem:customshell[name,namespace]           # Scaffold Glimmer::UI::CustomShell subclass (full window view) under its own Ruby gem + app project (namespace is required) [alt: scaffold:ge...
   glimmer scaffold:gem:customwidget[name,namespace]          # Scaffold Glimmer::UI::CustomWidget subclass (part of a view) under its own Ruby gem project (namespace is required) [alt: scaffold:gem:cw]
 ```
@@ -162,15 +166,12 @@ $ glimmer scaffold[greeter]
   create  Rakefile
   create  Gemfile
   create  LICENSE.txt
-  create  README.rdoc
+  create  README.markdown
   create  .document
   create  lib
-  create  lib/greeter.rb
-  create  spec
-  create  spec/spec_helper.rb
-  create  spec/greeter_spec.rb
+  create  lib/snowboard_utah.rb
   create  .rspec
-Juwelier has prepared your gem in ./greeter
+Juwelier has prepared your gem in ./snowboard_utah
 Created greeter/.gitignore
 Created greeter/.ruby-version
 Created greeter/.ruby-gemset
@@ -179,17 +180,19 @@ Created greeter/LICENSE.txt
 Created greeter/Gemfile
 Created greeter/Rakefile
 Created greeter/app/greeter.rb
-Created greeter/app/views/greeter/app_view.rb
-Created greeter/package/windows/Greeter.ico
-Created greeter/package/macosx/Greeter.icns
-Created greeter/package/linux/Greeter.png
+Created greeter/app/greeter/view/app_view.rb
+Created greeter/package/windows/Snowboard Utah.ico
+Created greeter/package/macosx/Snowboard Utah.icns
+Created greeter/package/linux/Snowboard Utah.png
+Created greeter/app/greeter/launch.rb
 Created greeter/bin/greeter
-Created greeter/spec/spec_helper.rb
 ...
 ```
 
 Eventually, it will launch an advanced "Hello, World!" app window having the title of your application ("Greeter").
 
+(note: javapackager might claim at the end "Error: Bundler "DMG Installer" (dmg) failed to produce a bundle.", but it's a false negative since it works fully anyways)
+
 ![Glimmer Scaffold App](/images/glimmer-scaffolding-app.png)
 
 It also comes with a boilerplate Preferences dialog.
@@ -252,21 +255,6 @@ You should see output like the following:
 
 ```
 $ glimmer scaffold:desktopify[snowboard_utah,https://www.brightonresort.com]
-Fetching kamelcase-0.0.2.gem
-Fetching github_api-0.19.0.gem
-Fetching highline-2.0.3.gem
-Fetching juwelier-2.4.9.gem
-Fetching hashie-3.6.0.gem
-Fetching nokogiri-1.10.10-java.gem
-Fetching semver2-3.4.2.gem
-Successfully installed semver2-3.4.2
-Successfully installed kamelcase-0.0.2
-Successfully installed highline-2.0.3
-Successfully installed hashie-3.6.0
-Successfully installed github_api-0.19.0
-Successfully installed nokogiri-1.10.10-java
-Successfully installed juwelier-2.4.9
-7 gems installed
   create  .gitignore
   create  Rakefile
   create  Gemfile
@@ -285,16 +273,19 @@ Created snowboard_utah/LICENSE.txt
 Created snowboard_utah/Gemfile
 Created snowboard_utah/Rakefile
 Created snowboard_utah/app/snowboard_utah.rb
-Created snowboard_utah/app/views/snowboard_utah/app_view.rb
+Created snowboard_utah/app/snowboard_utah/view/app_view.rb
 Created snowboard_utah/package/windows/Snowboard Utah.ico
 Created snowboard_utah/package/macosx/Snowboard Utah.icns
 Created snowboard_utah/package/linux/Snowboard Utah.png
+Created snowboard_utah/app/snowboard_utah/launch.rb
 Created snowboard_utah/bin/snowboard_utah
 ...
 ```
 
 Eventually, it will launch a desktopified version of "https://www.brightonresort.com" having the title of ("Snowboard Utah").
 
+(note: javapackager might claim at the end "Error: Bundler "DMG Installer" (dmg) failed to produce a bundle.", but it's a false negative since it works fully anyways)
+
 Desktopified App on Mac
 
 ![Glimmer Scaffold App](/images/glimmer-scaffolding-desktopify.png)
@@ -333,7 +324,7 @@ glimmer scaffold:cs[name]
 
 #### Custom Widget
 
-To scaffold a Glimmer [custom widget](#custom-widgets) (part of a view) for an existing Glimmer app, run the following command:
+To scaffold a Glimmer [custom widget](GLIMMER_GUI_DSL_SYNTAX.md#custom-widgets) (part of a view) for an existing Glimmer app, run the following command:
 
 ```
 glimmer scaffold:customwidget[name]
@@ -345,6 +336,20 @@ Or the following alternative abbreviation:
 glimmer scaffold:cw[name]
 ```
 
+#### Custom Shape
+
+To scaffold a Glimmer [custom shape](GLIMMER_GUI_DSL_SYNTAX.md#custom-shapes) (a composite or customized shape) for an existing Glimmer app, run the following command:
+
+```
+glimmer scaffold:customshape[name]
+```
+
+Or the following alternative abbreviation:
+
+```
+glimmer scaffold:cp[name]
+```
+
 #### Custom Shell Gem
 
 Custom shell gems are self-contained Glimmer apps as well as reusable [custom shells](#custom-shells).
@@ -382,7 +387,7 @@ Examples:
 
 #### Custom Widget Gem
 
-To scaffold a Glimmer [custom widget](#custom-widgets) gem (part of a view distributed as a Ruby gem), run the following command:
+To scaffold a Glimmer [custom widget](GLIMMER_GUI_DSL_SYNTAX.md#custom-widgets) gem (part of a view distributed as a Ruby gem), run the following command:
 
 ```
 glimmer scaffold:gem:customwidget[name,namespace]
@@ -397,14 +402,40 @@ glimmer scaffold:gem:cw[name,namespace]
 
 It is important to specify a namespace to avoid having your gem clash with existing gems.
 
-The Ruby gem name will follow the convention "glimmer-cw-customwidgetname-namespace" (the 'cw' is for Custom Widget)
+The Ruby gem name will follow the convention "glimmer-cw-customwidgetname-namespace" (the 'cw' is for Custom Widget; name words are not separated)
 
 Only official Glimmer gems created by the Glimmer project committers will have no namespace (e.g. [glimmer-cw-video](https://rubygems.org/gems/glimmer-cw-video) Ruby gem)
 
 Examples:
 
 - [glimmer-cw-video](https://github.com/AndyObtiva/glimmer-cw-video): Video Widget
-- [glimmer-cw-cdatetime-nebula](https://github.com/AndyObtiva/glimmer-cw-cdatetime-nebula): Nebula CDateTime Widget
+- [glimmer-cw-nebula](https://github.com/AndyObtiva/glimmer-cw-nebula): The Nebula Project 50+ enterprise-grade high quality custom widgets for SWT
+- [glimmer-cw-cdatetime-nebula](https://github.com/AndyObtiva/glimmer-cw-cdatetime-nebula): Nebula CDateTime Widget (piecemeal)
+
+#### Custom Shape Gem
+
+To scaffold a Glimmer [custom shape](GLIMMER_GUI_DSL_SYNTAX.md#custom-shapes) gem (part of a view distributed as a Ruby gem), run the following command:
+
+```
+glimmer scaffold:gem:customshape[name,namespace]
+```
+
+Or the following alternative abbreviation:
+
+```
+glimmer scaffold:gem:cp[name,namespace]
+```
+
+
+It is important to specify a namespace to avoid having your gem clash with existing gems.
+
+The Ruby gem name will follow the convention "glimmer-cp-customshapename-namespace" (the 'cp' is for Custom Shape; name words are not separated)
+
+Only official Glimmer gems created by the Glimmer project committers will have no namespace (e.g. [glimmer-cp-bevel](https://rubygems.org/gems/glimmer-cp-bevel) Ruby gem)
+
+Examples:
+
+- [glimmer-cp-bevel](https://github.com/AndyObtiva/glimmer-cp-bevel): Bevel
 
 ### Gem Listing
 
@@ -500,6 +531,39 @@ Output:
   
 ```
 
+#### Listing Custom Shape Gems
+
+The following command lists available Glimmer [Custom Shape Gems](#custom-shape-gem) (prefixed with "glimmer-cp-" by scaffolding convention) created by the the Glimmer community and published on [rubygems.org](http://www.rubygems.org):
+
+```
+glimmer list:gems:customshape[query]
+```
+
+Or the following alternative abbreviation:
+
+```
+glimmer list:gems:cp[query]
+```
+
+Example:
+
+```
+glimmer list:gems:customshape
+```
+
+Output:
+
+```
+
+  Glimmer Custom Shape Gems at rubygems.org:
+                                                                                                     
+     Name                Gem             Version     Author                 Description
+                                                                                                     
+  Bevel         glimmer-cp-bevel         0.1.1     Andy Maleh   Bevel - Glimmer Custom Shape
+  Stickfigure   glimmer-cp-stickfigure   0.1.1     Andy Maleh   Stick Figure - Glimmer Custom Shape
+  
+```
+
 #### Listing DSL Gems
 
 The following command lists available Glimmer [DSL Gems](#multi-dsl-support) (prefixed with "glimmer-dsl-" by convention) created by the the Glimmer community and published on [rubygems.org](http://www.rubygems.org):
@@ -554,6 +618,8 @@ Or, the following on Mac:
 jruby -J-XstartOnFirstThread -r glimmer-dsl-swt -S application.rb
 ```
 
+Unless you ran `glimmer-setup`, which adds `JRUBY_OPTS` environment variable that includes the `-J-XstartOnFirstThread` option automatically so you would not have to specify manually.
+
 If you want to use a specific custom version of SWT, run the following on Windows/Linux:
 
 ```

data/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md

@@ -163,7 +163,7 @@ Dynamic keywords are dynamically figured out from currently imported (aka requir
 
 The only reason to distinguish between the two is to realize that importing new Glimmer [custom widgets](#custom-widgets) and Java SWT custom widget libraries automatically expands Glimmer's DSL vocabulary with new dynamic keywords.
 
-For example, if a project adds this custom Java SWT library from the [Nebula Project](https://www.eclipse.org/nebula/):
+For example, if a project adds this custom Java SWT library from the [Nebula Project](https://github.com/AndyObtiva/glimmer-cw-nebula):
 
 https://www.eclipse.org/nebula/widgets/gallery/gallery.php
 
@@ -284,9 +284,7 @@ shell {
 
 If you are new to Glimmer, you have learned enough to start running some [samples](#samples) directly or by reading through [Glimmer GUI DSL Keywords](#glimmer-gui-dsl-keywords) (which list each keyword's samples). Go ahead and run all Glimmer [samples](#samples), and come back to read the rest in any order you like since this material is more organized like a reference.
 
-If you are advanced and need more widgets, check out the [Nebula Project](https://www.eclipse.org/nebula/) for an extensive list of high quality custom widgets:
-
-https://www.eclipse.org/nebula/
+If you are an advanced user of Glimmer DSL for SWT and need more widgets, check out the [Nebula Project](https://github.com/AndyObtiva/glimmer-cw-nebula) for an extensive list (50+) of high quality custom widgets.
 
 #### Glimmer GUI DSL Keywords
 
@@ -370,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.
@@ -1042,6 +1040,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:
@@ -1416,7 +1418,7 @@ Shape keywords and their args (including defaults) are listed below (they basica
 - `text(string, x, y, is_transparent = true)` text with optional is_transparent to indicate if background is transparent (default is true)
 - `text(string, x, y, flags)` text with optional flags (flag format is `swt(comma_separated_flags)` where flags can be `:draw_delimiter` (i.e. new lines), `:draw_tab`, `:draw_mnemonic`, and `:draw_transparent` as explained in [GC API](https://help.eclipse.org/2020-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/GC.html))
 
-Shape keywords that can be filled with color can take a keyword argument `fill: true`. Defaults to false when not specified unless background is set with no foreground (or foreground is set with no background), in which case a smart default is applied.
+Shape keywords that can be filled with color can take a keyword argument `fill: true` (or `filled: true`). Defaults to false when not specified unless background is set with no foreground (or foreground is set with no background), in which case a smart default is applied.
 Smart defaults can be applied to automatically infer `gradient: true` (rectangle with both foreground and background) and `round: true` (rectangle with more than 4 args, the extra args are numeric) as well.
 
 Optionally, a shape keyword takes a block that can set any attributes from [org.eclipse.swt.graphics.GC](https://help.eclipse.org/2020-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/GC.html) (methods starting with `set`), which enable setting the `background` for filling and `foreground` for drawing.
@@ -3473,7 +3475,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,18 @@ 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 (`c_tab_folder` and `c_tab_item`), which supports more customizations to tab fonts/background/foreground colors and display of extra additional tabs 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)
+
 #### Hello, Combo!
 
 This sample demonstrates combo data-binding.
@@ -112,6 +126,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/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