iup-ffi 0.13.0-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8edd907aec07e5ed908a4b5f20468f1b7a35a129ba2989304f65f6572d0f0494
+  data.tar.gz: dcbe30a536bcb097cecd1dda0a53600b11d225c34523ae93a3a7cd0ae8ff1c17
+SHA512:
+  metadata.gz: 0bcd15aef23b41fc7bab2efbe43ed6ef9125e937482990adc45e30fe843f23d8c8447a37eca80f892ae7a8cce2f3dbfc1c3886225bff1eb96fe15df9b0bdc489
+  data.tar.gz: 9341a856b6949d9a21c7a830066772de7546567c2f599afd4728cd5861888ef4fad4d6d965a45ad7382d6df933dd1e5ffbfe33d6d08a5294fd3c6a9a5f98f07d

data/LICENCE.md

@@ -0,0 +1,21 @@
+# The MIT Licence (MIT)
+
+Copyright (c) 2014-26, Peter Lane.
+
+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.

data/README.md

@@ -0,0 +1,139 @@
+# iup-ffi
+
+FFI binding for Ruby to [Tecgraf's IUP](http://www.tecgraf.puc-rio.br/iup/)
+portable user interface toolkit; IUP is a multi-platform toolkit for building
+graphical user interfaces.  The library provides both a low-level binding to
+the C library calls, and a high-level wrapping of most widgets to give a more
+natural Ruby syntax.
+
+This library is available as a [rubygem](https://rubygems.org/gems/iup-ffi) or
+in [source](https://codeberg.org/peterlane/iup-ffi) format.
+
+[Tecgraf's IUP](http://www.tecgraf.puc-rio.br/iup/) documentation (Version
+3.32) should be read along with the API documentation for iup-ffi.  A number of
+examples can be found in the source, or downloaded with the latest tagged
+[version](https://codeberg.org/peterlane/iup-ffi/tags).
+
+## Description
+
+The module Iup provides a Ruby-flavoured syntax for creating a GUI, wrapping
+each IUP component in a Ruby class with suitable mutators/accessors for the
+attributes and associated methods.  For example:
+
+```
+require "iup-ffi"
+
+Iup.mainloop do
+  btn = Iup::Button.new("click me", ->{ puts "clicked" }) do |b|
+    b.font = "Times, Bold 18"
+  end
+  puts "Button font is: ", btn.font
+
+  Iup::Dialog.new(btn) do |d|
+    d.title = "Example program"
+  end.show
+end
+```
+
+For direct access to the shared libraries, the bound functions for IUP, CD and
+IM are available in separate modules (names ending in "Lib"). These low-level
+functions provide a direct mapping to the C API of IUP.  This can be useful
+when converting code from other sources or when something is missing from the
+wrapper.  For example, the C program
+(https://www.tecgraf.puc-rio.br/iup/examples/C/message.c):
+
+```
+/* IupMessage Example */
+
+#include <stdlib.h>
+#include <stdio.h>
+
+/* IUP libraries include */
+#include <iup.h>
+
+/* Main program */
+int main(int argc, char **argv)
+{
+  /* Initializes IUP */
+  IupOpen(&argc, &argv);
+  
+  /* Executes IupMessage */
+  IupMessage("IupMessage Example", "Press the button");
+
+  /* Finishes IUP */
+  IupClose ();
+
+  /* Program finished successfully */
+  return EXIT_SUCCESS;
+
+}
+```
+
+is translated into Ruby as:
+
+```
+require "iup-ffi" # or "iup-ffi-plain" for just the low-level bindings
+
+IupLib.IupOpen(0, nil)
+IupLib.IupMessage("IupMessage Example", "Press the button")
+IupLib.IupClose
+```
+
+## Supported Widgets
+
+(As IUP is a large library and continues to be expanded, the list of supported
+widgets and their properties is at best partial.)
+
+Top-level containers:
+
+* Iup::ColorDialog, Iup::Dialog, Iup::FileDialog,
+Iup::FontDialog, Iup::MessageDialog, Iup::ProgressDialog
+
+Layout containers to arrange child widgets:
+
+* Iup::Fill, Iup::GridBox, Iup::HBox, Iup::VBox, Iup::ZBox, Iup::ScrollBox, Iup::SplitBox, Iup::StretchBox, 
+
+Grouping containers to organise related controls: 
+
+* Iup::BackgroundBox, Iup::Expander, Iup::Frame, Iup::Radio, Iup::Tabs
+
+Information controls to display data: 
+
+* Iup::Image, Iup::ImageRGB, Iup::ImageRGBA, Iup::Label, Iup::Link, Iup::ProgressBar
+
+Interactive controls: 
+
+* Iup::Button, Iup::ColorBar, Iup::Dial, Iup::List, Iup::Text, Iup::Toggle, Iup::Tree, Iup::Val
+
+Specialised/complex widgets: 
+
+* Iup::Canvas, Iup::Matrix, Iup::Scintilla
+
+Non-visual controls and menus:
+
+* Iup::Menu, Iup::MenuItem, Iup::Separator, Iup::SubMenu, Iup::Timer
+  
+## Installation
+
+Pre-built binaries are supported on Linux and Windows (x64) platforms:
+
+```
+$ gem install iup-ffi
+```
+
+* Windows gem does not include Iup::Scintilla.
+
+From source, download the CD, IM and IUP shared libraries from
+https://www.tecgraf.puc-rio.br/iup/en/download_tips.html into the appropriate
+"lib/library" folder: Linux68_64 and Win64_dllw6 are used in the pre-built
+binaries.
+
+## Support
+
+File bugs at the [codeberg issues page](https://codeberg.org/peterlane/iup-ffi/issues), or send an email to `peterlane@gmx.com`.
+
+## Copyright/Licence
+
+iup-ffi is copyright (c) 2014-26 Peter Lane, and released under the [MIT Licence](https://opensource.org/license/MIT).
+Tecgraf IUP products are also released under the MIT licence: https://www.tecgraf.puc-rio.br/iup/en/copyright.html
+

data/lib/iup-ffi-plain.rb

@@ -0,0 +1,51 @@
+# Provides the direct bindings through FFI to the IUP libraries.
+
+require 'ffi'
+require 'rbconfig'
+require "securerandom"
+
+module Iup
+  # :nodoc:
+  library_base = File.expand_path("../library", __FILE__)
+  IUP_LIBS = case RbConfig::CONFIG['host_os']
+             when /linux|cygwin/
+               library_path = File.join(library_base, "linux")
+               [
+                 "gobject-2.0", "pango-1.0",
+                 File.join(library_path, 'libcd.so'),
+                 File.join(library_path, 'libim.so'),
+                 File.join(library_path, "libiup.so"),
+                 File.join(library_path, 'libiupcd.so'),
+                 File.join(library_path, 'libiupcontrols.so'),
+                 File.join(library_path, 'libiupim.so'),
+                 File.join(library_path, 'libiupimglib.so'),
+                 File.join(library_path, 'libiup_scintilla.so')
+               ]
+             when /mswin|mingw/
+               library_path = File.join(library_base, "windows")
+               [
+                 File.join(library_path, "freetype6.dll"),
+                 File.join(library_path, "zlib1.dll"),
+                 File.join(library_path, 'cd.dll'),
+                 File.join(library_path, 'im.dll'),
+                 File.join(library_path, "iup.dll"),
+                 File.join(library_path, 'iupcd.dll'),
+                 File.join(library_path, 'iupcontrols.dll'),
+                 File.join(library_path, 'iupim.dll'),
+                 File.join(library_path, 'iupimglib.dll') #,
+                 #               File.join(library_path, 'iup_scintilla.dll')
+               ]
+             else
+               raise Exception, 
+                 'iup libraries not found this platform', 
+                 RbConfig::CONFIG['host_os']
+             end
+end
+
+require 'wrapped/constants'
+require 'plain/iuplib'
+require 'plain/iupcdlib'
+require 'plain/iupcontrolslib'
+require 'plain/iupimlib'
+require 'plain/iupimglib'
+require 'plain/scintilla-lib' unless /mswin|mingw/ === RbConfig::CONFIG['host_os']

data/lib/iup-ffi.rb

@@ -0,0 +1,70 @@
+# Requires files needed for wrapping the plain Iup libraries.
+#
+require 'iup-ffi-plain'
+
+# helper code
+require 'wrapped/attribute-builders'
+require 'wrapped/attribute-reference'
+require 'wrapped/dynamic-fill-methods'
+require 'wrapped/common-attributes'
+require 'wrapped/image-attributes'
+require 'wrapped/callback-setter'
+require 'wrapped/drag-drop-attributes'
+require 'wrapped/scrollbar-attributes'
+
+# the wrapper classes themselves
+# -- core libraries
+require 'wrapped/widget'
+require 'wrapped/button'
+require 'wrapped/canvas'
+require 'wrapped/frame'
+require 'wrapped/label'
+require 'wrapped/link'
+require 'wrapped/list'
+require 'wrapped/progressbar'
+require 'wrapped/tabs'
+require 'wrapped/text'
+require 'wrapped/toggle'
+require 'wrapped/tree'
+require 'wrapped/val'
+
+# -- dialogs
+require 'wrapped/dialog'
+require 'wrapped/colordialog'
+require 'wrapped/filedialog'
+require 'wrapped/fontdialog'
+require 'wrapped/messagedialog'
+require 'wrapped/progressdialog'
+
+# -- resources
+require 'wrapped/image'
+require 'wrapped/menu'
+require 'wrapped/menuitem'
+require 'wrapped/separator'
+require 'wrapped/submenu'
+require 'wrapped/timer'
+
+# -- layout
+require 'wrapped/background-box'
+require 'wrapped/expander'
+require 'wrapped/fill'
+require 'wrapped/gridbox'
+require 'wrapped/hbox'
+require 'wrapped/radio'
+require 'wrapped/scrollbox'
+require 'wrapped/splitbox'
+require 'wrapped/stretchbox'
+require 'wrapped/vbox'
+require 'wrapped/zbox'
+
+# -- extensions
+require 'wrapped/scintilla'
+
+# -- additional controls
+require 'wrapped/colorbar'
+require 'wrapped/dial'
+require 'wrapped/matrix'
+
+# -- global methods
+require 'wrapped/iup-global' 
+

data/lib/plain/iupcdlib.rb

@@ -0,0 +1,158 @@
+# Binding to the iupcd shared library: CD is a vector graphics
+# toolkit.
+# This module can be used to access features not available 
+# in Iup. 
+#
+# For reference, the following functions are bound:
+#
+# * cdContextIup, [], :pointer
+# * cdCreateCanvas, [:pointer, :pointer], :pointer
+# * cdKillCanvas, [:pointer], :void
+# * cdCanvasActivate, [:pointer], :int
+# * cdCanvasDeactivate, [:pointer], :void
+# * cdUseContextPlus, [:int], :int
+# * cdCanvasGetContext, [:pointer], :pointer
+# * cdContextCaps, [:pointer], :int
+# * cdContextType, [:pointer], :int
+# * cdContextIsPlus, [:pointer], :int
+# * cdCanvasSimulate, [:pointer, :int], :int
+# * wdCanvasViewport, [:pointer, :int, :int, :int, :int], :void
+# * wdCanvasWindow, [:pointer, :double, :double, :double, :double], :void
+# * cdCanvasForeground, [:pointer, :long], :long
+# * cdCanvasBackground, [:pointer, :long], :long
+# * cdCanvasWriteMode, [:pointer, :int], :int
+# * cdCanvasClear, [:pointer], :int
+# * cdCanvasBegin, [:pointer, :int], :void
+# * cdCanvasVertex, [:pointer, :int, :int], :void
+# * cdCanvasEnd, [:pointer], :void
+# * cdCanvasPathSet, [:pointer, :int], :void
+# * cdCanvasPixel, [:pointer, :int, :int], :void
+# * cdCanvasMark, [:pointer, :int, :int], :void
+# * cdCanvasMarkType, [:pointer, :int], :int
+# * cdCanvasMarkSize, [:pointer, :int], :int
+# * cdCanvasLine, [:pointer, :int, :int, :int, :int], :void
+# * cdCanvasRect, [:pointer, :int, :int, :int, :int], :void
+# * cdCanvasArc, [:pointer, :int, :int, :int, :int, :double, :double], :void
+# * cdCanvasLineStyle, [:pointer, :int], :int
+# * cdCanvasLineWidth, [:pointer, :int], :int
+# * cdCanvasLineJoin, [:pointer, :int], :int
+# * cdCanvasLineCap, [:pointer, :int], :int
+# * cdCanvasBox, [:pointer, :int, :int, :int, :int], :void
+# * cdCanvasSector, [:pointer, :int, :int, :int, :int, :double, :double], :int
+# * cdCanvasChord, [:pointer, :int, :int, :int, :int, :double, :double], :int
+# * cdCanvasBackOpacity, [:pointer, :int], :int
+# * cdCanvasFillMode, [:pointer, :int], :int
+# * cdCanvasInteriorStyle, [:pointer, :int], :int
+# * cdCanvasHatch, [:pointer, :int], :int
+# * cdCanvasStipple, [:pointer, :int, :int, :string], :void
+# * cdCanvasText, [:pointer, :int, :int, :string], :void
+# * cdCanvasFont, [:pointer, :string, :int, :int], :void
+# * cdCanvasNativeFont, [:pointer, :string], :string
+# * cdCanvasTextAlignment, [:pointer, :int], :int
+# * cdCanvasTextOrientation, [:pointer, :double], :double
+# * cdCanvasVectorText, [:pointer, :int, :int, :string], :void
+# * cdCanvasVectorTextDirection, [:pointer, :int, :int, :int, :int], :void
+# * cdCanvasVectorTextSize, [:pointer, :int, :int, :string], :void
+# * cdCanvasVectorCharSize, [:pointer, :int], :void
+# * cdCanvasVectorFontSize, [:pointer, :double, :double], :void
+# * cdCanvasVectorFont, [:pointer, :string], :string
+# * cdEncodeColor, [:int, :int, :int], :long
+# 
+# TODO: 
+# - images
+# - various get functions
+#
+module CdLib 
+  extend FFI::Library
+
+  ffi_lib *Iup::IUP_LIBS
+
+  attach_function :cdContextIup, [], :pointer
+
+  # -- initialisation
+
+  attach_function :cdCreateCanvas, [:pointer, :pointer], :pointer
+  attach_function :cdKillCanvas, [:pointer], :void
+  attach_function :cdCanvasActivate, [:pointer], :int
+  attach_function :cdCanvasDeactivate, [:pointer], :void
+  attach_function :cdUseContextPlus, [:int], :int
+  # attach_function :cdInitContextPlus, [:void], :void
+  attach_function :cdCanvasGetContext, [:pointer], :pointer
+  attach_function :cdContextCaps, [:pointer], :int
+  attach_function :cdContextType, [:pointer], :int
+  attach_function :cdContextIsPlus, [:pointer], :int
+  attach_function :cdCanvasSimulate, [:pointer, :int], :int
+
+  attach_function :wdCanvasViewport, [:pointer, :int, :int, :int, :int], :void
+  attach_function :wdCanvasWindow, [:pointer, :double, :double, :double, :double], :void
+
+  # -- general attributes
+  attach_function :cdCanvasForeground, [:pointer, :long], :long
+  attach_function :cdCanvasBackground, [:pointer, :long], :long
+  attach_function :cdCanvasWriteMode, [:pointer, :int], :int
+
+  # -- control
+
+  attach_function :cdCanvasClear, [:pointer], :int
+
+  # -- begin/end blocks
+  attach_function :cdCanvasBegin, [:pointer, :int], :void
+  attach_function :cdCanvasVertex, [:pointer, :int, :int], :void
+  attach_function :cdCanvasEnd, [:pointer], :void
+  attach_function :cdCanvasPathSet, [:pointer, :int], :void
+
+  # --- marks
+  attach_function :cdCanvasPixel, [:pointer, :int, :int], :void
+  attach_function :cdCanvasMark, [:pointer, :int, :int], :void
+  attach_function :cdCanvasMarkType, [:pointer, :int], :int
+  attach_function :cdCanvasMarkSize, [:pointer, :int], :int
+
+  # --- lines
+
+  attach_function :cdCanvasLine, [:pointer, :int, :int, :int, :int], :void
+  attach_function :cdCanvasRect, [:pointer, :int, :int, :int, :int], :void
+  attach_function :cdCanvasArc, [:pointer, :int, :int, :int, :int, :double, :double], :void
+  attach_function :cdCanvasLineStyle, [:pointer, :int], :int
+  #  attach_function :cdCanvasLineStyleDashes, [:pointer, :pointer, :int], :void # TODO: pointer to int array?
+  attach_function :cdCanvasLineWidth, [:pointer, :int], :int
+  attach_function :cdCanvasLineJoin, [:pointer, :int], :int
+  attach_function :cdCanvasLineCap, [:pointer, :int], :int
+
+  # --- filled areas
+
+  attach_function :cdCanvasBox, [:pointer, :int, :int, :int, :int], :void
+  attach_function :cdCanvasSector, [:pointer, :int, :int, :int, :int, :double, :double], :int
+  attach_function :cdCanvasChord, [:pointer, :int, :int, :int, :int, :double, :double], :int
+  attach_function :cdCanvasBackOpacity, [:pointer, :int], :int
+  attach_function :cdCanvasFillMode, [:pointer, :int], :int
+  attach_function :cdCanvasInteriorStyle, [:pointer, :int], :int
+  attach_function :cdCanvasHatch, [:pointer, :int], :int
+  attach_function :cdCanvasStipple, [:pointer, :int, :int, :string], :void
+
+  # --- text
+
+  attach_function :cdCanvasText, [:pointer, :int, :int, :string], :void
+  attach_function :cdCanvasFont, [:pointer, :string, :int, :int], :void
+  attach_function :cdCanvasNativeFont, [:pointer, :string], :string
+  attach_function :cdCanvasTextAlignment, [:pointer, :int], :int
+  attach_function :cdCanvasTextOrientation, [:pointer, :double], :double
+  # TODO: Get functions
+
+  # --- vector text
+
+  attach_function :cdCanvasVectorText, [:pointer, :int, :int, :string], :void
+  attach_function :cdCanvasVectorTextDirection, [:pointer, :int, :int, :int, :int], :void
+  attach_function :cdCanvasVectorTextSize, [:pointer, :int, :int, :string], :void
+  attach_function :cdCanvasVectorCharSize, [:pointer, :int], :void
+  attach_function :cdCanvasVectorFontSize, [:pointer, :double, :double], :void
+  attach_function :cdCanvasVectorFont, [:pointer, :string], :string
+  # TODO: Get functions
+
+  # --- client images
+
+  # --- server images
+
+  # -- colour functions
+
+  attach_function :cdEncodeColor, [:int, :int, :int], :long
+end

data/lib/plain/iupcontrolslib.rb

@@ -0,0 +1,28 @@
+# Binding to the iupcontrols shared library.
+# This module can be used to access features not available 
+# in Iup. 
+#
+# For reference, the following functions are bound:
+#
+# * IupControlsOpen, [], :int
+# * IupColorbar, [], :pointer
+# * IupDial, [:string], :pointer
+# * IupMatrix, [:string], :pointer
+#
+module ControlsLib
+  extend FFI::Library
+
+  ffi_lib *Iup::IUP_LIBS
+
+  attach_function :IupControlsOpen, [], :int
+
+  # -- additional
+  #  attach_function :IupCells, [], :pointer
+  attach_function :IupColorbar, [], :pointer
+  #  attach_function :IupColorBrowser, [], :pointer
+  attach_function :IupDial, [:string], :pointer
+  attach_function :IupMatrix, [:string], :pointer
+  #  attach_function :IupMatrixList, [], :pointer
+  #  attach_function :IupMatrixEx, [], :pointer
+  #  attach_function :IupWebBrowser, [], :pointer
+end

data/lib/plain/iupimglib.rb

@@ -0,0 +1,15 @@
+# Binding to the iupimglib shared library.
+# This module can be used to access features not available 
+# in Iup. 
+#
+# For reference, the following functions are bound:
+#
+# * IupImageLibOpen, [], :void
+#
+module ImgLib
+  extend FFI::Library
+
+  ffi_lib *Iup::IUP_LIBS
+
+  attach_function :IupImageLibOpen, [], :void
+end

data/lib/plain/iupimlib.rb

@@ -0,0 +1,18 @@
+# Binding to the imlib shared library: IM is a toolkit for images.
+# This module can be used to access features not available 
+# in Iup. 
+#
+# For reference, the following functions are bound:
+#
+# * IupLoadImage, [:string], :pointer
+# * IupSaveImage, [:string, :string], :int
+#
+module ImLib
+  extend FFI::Library
+
+  ffi_lib *Iup::IUP_LIBS
+
+  attach_function :IupLoadImage, [:string], :pointer
+  attach_function :IupSaveImage, [:string, :string], :int
+
+end