ruby-qt6-rice 1.0.0

data/lib/mkmf-rice.rb

@@ -0,0 +1,101 @@
+# This file is part of [rice](https://github.com/ruby-rice/rice).
+#
+# Copyright (C) 2025 Jason Roelofs <jasongroelofs@gmail.com>
+#                    Paul Brannan <curlypaul924@gmail.com>,
+#                    Charlie Savage
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'mkmf'
+
+IS_MSWIN = /mswin/ =~ RUBY_PLATFORM
+IS_MINGW = /mingw/ =~ RUBY_PLATFORM
+IS_DARWIN = RbConfig::CONFIG['host_os'].match?(/darwin/)
+
+# The cpp_command is not overwritten in the experimental mkmf C++ support.
+# See https://bugs.ruby-lang.org/issues/17578
+MakeMakefile['C++'].module_eval do
+  def cpp_command(outfile, opt="")
+    conf = cc_config(opt)
+    if $universal and (arch_flag = conf['ARCH_FLAG']) and !arch_flag.empty?
+      conf['ARCH_FLAG'] = arch_flag.gsub(/(?:\G|\s)-arch\s+\S+/, '')
+    end
+    RbConfig::expand("$(CXX) -E #$INCFLAGS #$CPPFLAGS #$CFLAGS #{opt} #{CONFTEST_CXX} #{outfile}",
+                     conf)
+  end
+end
+
+# Now pull in the C++ support
+include MakeMakefile['C++']
+
+# Rice needs c++17.
+if IS_MSWIN
+  $CXXFLAGS += " /std:c++17 /EHs /permissive- /bigobj /utf-8"
+  $CPPFLAGS += " -D_ALLOW_KEYWORD_MACROS -D_CRT_SECURE_NO_DEPRECATE -D_CRT_NONSTDC_NO_DEPRECATE"
+elsif IS_MINGW
+  $CXXFLAGS += " -std=c++17 -Wa,-mbig-obj"
+else
+  $CXXFLAGS += " -std=c++17"
+end
+
+# Rice needs to include its header. Let's setup the include path
+# to make this easy
+path = File.expand_path(File.join(__dir__, '../include'))
+
+unless find_header('rice/rice.hpp', path)
+  raise("Could not find rice/rice.hpp header")
+end
+
+if !IS_DARWIN && !IS_MSWIN && !have_library('stdc++fs')
+  have_library('stdc++')
+end
+
+# Copied from Ruby FFI bindings - see
+# https://github.com/ffi/ffi/blob/1715332d553d53fae13fd9fcbbd9d2c1982a5c2f/ext/ffi_c/extconf.rb#L7C1-L27C6
+def system_libffi_usable?
+  # We need pkg_config or ffi.h
+  libffi_ok = pkg_config("libffi") ||
+      have_header("ffi.h") ||
+      find_header("ffi.h", "/usr/local/include", "/usr/include/ffi",
+                  "/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include/ffi",
+                  "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/include/ffi") ||
+      (find_header("ffi.h", `xcrun --sdk macosx --show-sdk-path`.strip + "/usr/include/ffi") rescue false)
+
+  # Ensure we can link to ffi_prep_closure_loc
+  libffi_ok &&= have_library("ffi", "ffi_prep_closure_loc", [ "ffi.h" ]) ||
+                have_library("libffi", "ffi_prep_closure_loc", [ "ffi.h" ]) ||
+                have_library("libffi-8", "ffi_prep_closure_loc", [ "ffi.h" ])
+
+  if RbConfig::CONFIG['host_os'] =~ /mswin/
+    have_library('libffi_convenience')
+    have_library('shlwapi')
+  end
+
+  libffi_ok
+end
+
+def have_libffi
+  # Check for libffi to support C style callacks.
+  libffi_usable = system_libffi_usable?
+  $CPPFLAGS += " -DHAVE_LIBFFI" if libffi_usable
+  libffi_usable
+end

data/lib/mkmf-rubyqt6.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "mkmf-rice"
+
+def qmake
+  return @qmake if @qmake
+
+  ["qmake6", "qmake"].each do |qmake|
+    `#{qmake} -v`
+    return @qmake = qmake if $?.success?
+  end
+  raise "Could not find qmake"
+end
+
+def qt_install_headers
+  return @qt_install_headers if @qt_install_headers
+
+  r = ENV["QT_INSTALL_HEADERS"] || ""
+  return @qt_install_headers = r unless r == ""
+
+  r = `#{qmake} -query QT_INSTALL_HEADERS`.strip
+  return @qt_install_headers = r unless r == ""
+
+  raise "Could not determine QT_INSTALL_HEADERS folder"
+end
+
+RUBYQT6_CXX_FLAGS = ENV["RUBYQT6_CXX_FLAGS"] || "-Os -fno-fast-math"
+append_cppflags(RUBYQT6_CXX_FLAGS) unless RUBYQT6_CXX_FLAGS.strip == ""

data/lib/qt6/rice/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RubyQt6
+  module Rice
+    RICE_RUBYGEM_VERSION = "1.0.0"
+  end
+end

data/lib/qt6/rice.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "rice/version"

data/lib/qt6/rspec/bando_file_parser.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module RubyQt6
+  module RSpec
+    class BandoFileParser
+      class MissingLine < StandardError
+        def initialize(expected, got)
+          super("Missing line: expected '#{expected}', but got '#{got}'")
+        end
+      end
+
+      def initialize(cppfile, qmod)
+        @qmod = qmod
+        @bandoes = []
+        @lines, @lineno = File.read(cppfile).lines, 0
+      end
+
+      def parse
+        parse_bando_variants_declaration
+        parse_bando_definitions
+        raise MissingLine.new("}", line) unless line == "}"
+        @bandoes
+      end
+
+      def parse_bando_variants_declaration
+        while line == "" || line.start_with?("#include") || line.start_with?("using ")
+          matched = line.match(/^using Bando_(\w+) = Bando(\w+)<(\w+), (.*)>/)
+          if matched.nil?
+            take_next_line
+            next
+          end
+
+          if matched[1] != matched[3]
+            expected = "using Bando_#{matched[1]} = Bando#{matched[2]}<#{matched[1]}, ..."
+            raise MissingLine.new(expected, line)
+          else
+            take_next_line
+          end
+
+          @bandoes << Struct.new(:name, :template, :constructor_args).new(matched[1], matched[2], matched[4])
+        end
+
+        @bandoes.each do |bando|
+          expected = "Rice::Class rb_mBando_c#{bando.name};"
+          if line == expected
+            take_next_line
+          else
+            raise MissingLine.new(expected, line)
+          end
+        end
+
+        while line == "" || line.start_with?("void Init_bando_q") || line == "{"
+          take_next_line
+        end
+      end
+
+      def parse_bando_definitions
+        @bandoes.each do |bando|
+          parse_bando_definition(bando)
+        end
+      end
+
+      def parse_bando_definition(bando)
+        name = bando.name
+
+        expected = "rb_mBando_c#{name} ="
+        if line == expected
+          take_next_line
+        else
+          raise MissingLine.new(expected, line)
+        end
+
+        expected = "define_bando_#{bando.template.downcase}_under<Bando_#{name}, #{name}>(rb_mQt6Bando, \"#{name}\")"
+        if line == expected
+          take_next_line
+        else
+          raise MissingLine.new(expected, line)
+        end
+
+        expected = ".define_constructor(Constructor<Bando_#{name}, #{bando.constructor_args}>()"
+        if line.start_with?(expected)
+          take_next_line
+        else
+          raise MissingLine.new(expected, line)
+        end
+
+        while line == "" || line == "}"
+          return if line == "}"
+          take_next_line
+        end
+      end
+
+      def take_next_line
+        @lineno += 1
+      end
+
+      def line
+        @lines[@lineno].strip
+      end
+    end
+  end
+end

data/lib/qt6/rspec/qlass_file_parser.rb

@@ -0,0 +1,255 @@
+# frozen_string_literal: true
+
+module RubyQt6
+  module RSpec
+    class QlassFileParser
+      NESTED_QLASSES = [
+        "QMetaObjectConnection",
+        "QPainterPathElement",
+        "QFormLayoutTakeRowResult",
+        "QTextEditExtraSelection"
+      ]
+
+      class MissingLine < StandardError
+        def initialize(expected, got)
+          super("Missing line: expected '#{expected}', but got '#{got}'")
+        end
+      end
+
+      def initialize(cppfile, qmod)
+        @qmod = qmod
+        @qlasses = []
+        @lines, @lineno = File.read(cppfile).lines, 0
+      end
+
+      def parse
+        parse_qlass_variants_declaration
+        parse_qlass_definitions
+        raise MissingLine.new("}", line) unless line == "}"
+        @qlasses
+      end
+
+      def parse_qlass_variants_declaration
+        while line == "" || line.start_with?("#include") || line == "using namespace Rice;"
+          take_next_line
+        end
+
+        while (matched = line.match(/^Rice::Class rb_c(\w+)/))
+          @qlasses << Struct.new(:name, :methods, :enums, :flags).new(matched[1], [], [], [])
+          take_next_line
+        end
+
+        if @qlasses.length.zero?
+          raise MissingLine.new("Rice::Class rb_c...", line)
+        end
+
+        until line.start_with?("void Init_q")
+          take_next_line
+        end
+
+        while line == "" || line.start_with?("void Init_q") || line == "{"
+          take_next_line
+        end
+      end
+
+      def parse_qlass_definitions
+        @qlasses.each do |qlass|
+          if NESTED_QLASSES.include?(qlass.name)
+            take_next_line until line == "" || line == "}"
+            next
+          end
+          parse_qlass_definition(qlass)
+        end
+      end
+
+      def parse_qlass_definition(qlass)
+        qmod_name = @qmod.name
+        name = qlass.name
+
+        expected = "rb_c#{name} ="
+        if line == expected
+          take_next_line
+        else
+          raise MissingLine.new(expected, line)
+        end
+
+        expected = "// RubyQt6::#{qmod_name}::#{name}"
+        if line == expected
+          take_next_line
+        else
+          raise MissingLine.new(expected, line)
+        end
+
+        if line.start_with?(/define_class_under<#{name}.*rb_mQt6#{qmod_name}, "#{name}"/)
+          take_next_line
+        else
+          raise MissingLine.new("define_class_under<#{name}...", line)
+        end
+
+        loop do
+          case line
+          when /\/\/ RubyQt6-Defined Functions/
+            qlass.methods.concat parse_qlass_definition_methods(qlass, :rubyqt6_defined_functions)
+          when /\/\/ Constructor/
+            qlass.methods.concat parse_qlass_definition_methods(qlass, :constructor)
+          when /\/\/ Inherits/
+            qlass.methods.concat parse_qlass_definition_methods(qlass, :inherits)
+          when /\/\/ Public Functions/
+            qlass.methods.concat parse_qlass_definition_methods(qlass, :public_functions)
+          when /\/\/ Public Slots/
+            qlass.methods.concat parse_qlass_definition_methods(qlass, :public_slots)
+          when /\/\/ Signals/
+            qlass.methods.concat parse_qlass_definition_methods(qlass, :signals)
+          when /\/\/ Static Public Members/
+            qlass.methods.concat parse_qlass_definition_methods(qlass, :static_public_members)
+          when /.define_attr/
+            take_next_line
+            next
+          when "", "}"
+            break
+          else
+            raise MissingLine.new("// Constructor", line)
+          end
+        end
+
+        while line == "" || line == "}"
+          return if line == "}"
+          take_next_line
+        end
+
+        while (matched = line.match(/^Data_Type<(.*)rb_c#{name}(.*) =/))
+          break if matched[1].start_with?("QFlags")
+          enum = Struct.new(:name).new(matched[2])
+          qlass.enums << enum
+          parse_qlass_definition_enum(qlass, enum)
+        end
+
+        while line == "" || line == "}"
+          return if line == "}"
+          take_next_line
+        end
+
+        while (matched = line.match(/^Data_Type<QFlags.*rb_c#{name}(.*) =/))
+          flag = Struct.new(:name, :enum_name).new(matched[1], "")
+          qlass.flags << flag
+          parse_qlass_definition_flag(qlass, flag)
+        end
+      end
+
+      def parse_qlass_definition_methods(qlass, type)
+        [].tap do |methods|
+          loop do
+            take_next_line
+            break if line.start_with?(/\/\/ (RubyQt6|Constructor|Inherits|Public|Signals|Static)/) || line == "" || line == "}"
+
+            if line.start_with?("// .define_")
+              next
+            elsif line.start_with?(".define_")
+              methods << parse_qlass_definition_method(line, qlass, type)
+            else
+              raise MissingLine.new(".define_...", line)
+            end
+          end
+        end
+      end
+
+      def parse_qlass_definition_method(line, qlass, type)
+        rawline = line
+        line = line.sub(".define_constructor", "")
+        line = line.sub(".define_singleton_function", "")
+        line = line.sub(".define_method", "")
+        case line
+        when /Constructor<#{qlass.name}.*>/
+          rbname = "initialize"
+        when /(<.*>)?\("([\w?]+)", \[\]\(/
+          rbname = $2
+        when /(<.*>)?\("([\w?]+)", [A-Z]/
+          rbname = $2
+        when /(<.*>)?\("([\w?]+)", &#{qlass.name}::([a-zA-Z0-9_]+)/
+          rbname = $2
+          cppname = $3
+        when /(<.*>)?\("(\W+)", \[\]/
+          rbname = $2
+        when /(<.*>)?\("(\W+)", [A-Z]/
+          rbname = $2
+        when /(<.*>)?\("(\W+)", &#{qlass.name}::operator/
+          rbname = $2
+        else
+          raise "Invalid method line: #{line}"
+        end
+        Struct.new(:type, :rbname, :cppname, :rawline).new(type, rbname, cppname, rawline)
+      end
+
+      def parse_qlass_definition_enum(qlass, enum)
+        qmod_name = @qmod.name
+        name = qlass.name
+        enum_name = enum.name
+
+        expected = "Data_Type<#{name}::#{enum_name}> rb_c#{name}#{enum_name} ="
+        if line == expected
+          take_next_line
+        else
+          raise MissingLine.new(expected, line)
+        end
+
+        expected = "// RubyQt6::#{qmod_name}::#{name}::#{enum_name}"
+        if line == expected
+          take_next_line
+        else
+          raise MissingLine.new(expected, line)
+        end
+
+        expected = "define_qenum_under<#{name}::#{enum_name}>(rb_c#{name}, \"#{enum_name}\");"
+        if line == expected
+          take_next_line
+        else
+          raise MissingLine.new(expected, line)
+        end
+
+        while line == "" || line.start_with?("define_qenum_value_under")
+          take_next_line
+        end
+      end
+
+      def parse_qlass_definition_flag(qlass, flag)
+        qmod_name = @qmod.name
+        name = qlass.name
+        flag_name = flag.name
+
+        expected = /Data_Type<QFlags<#{name}::(.*)>> rb_c#{name}#{flag_name} =/
+        if (matched = line.match(expected))
+          flag.enum_name = matched[1]
+          take_next_line
+        else
+          raise MissingLine.new(expected, line)
+        end
+
+        expected = "// RubyQt6::#{qmod_name}::#{name}::#{flag_name}"
+        if line == expected
+          take_next_line
+        else
+          raise MissingLine.new(expected, line)
+        end
+
+        expected = "define_qflags_under<#{name}::#{flag.enum_name}>(rb_c#{name}, \"#{flag_name}\");"
+        if line == expected
+          take_next_line
+        else
+          raise MissingLine.new(expected, line)
+        end
+
+        while line == ""
+          take_next_line
+        end
+      end
+
+      def take_next_line
+        @lineno += 1
+      end
+
+      def line
+        @lines[@lineno].strip
+      end
+    end
+  end
+end