OpalKelly 5.3.6 → 6.1.0

data/ext/OpalKelly/extconf.rb

@@ -16,13 +16,24 @@ if sdk_lib_dir
 end
 
 case RbConfig::CONFIG['arch']
-  when 'x64-mingw32'
-    include_dirs << "#{sdk_dir}/include"
-    lib_dirs << "#{sdk_dir}/lib/x64"
+  when /mingw|mswin/
+    # The API directory of the FrontPanel 6 developer kit is flat: the header
+    # and the import library sit next to each other in it, exactly as under
+    # Unix. Look there first, as this is what okFP_SDK is documented to point
+    # at.
+    include_dirs << "#{sdk_dir}"
+    lib_dirs << "#{sdk_dir}"
+
+    # FrontPanel 5 installed the SDK with include/ and lib/<Platform>/
+    # subdirectories instead, so keep searching those too for anyone still
+    # building against such a tree, or against one laid out like it.
+    # RubyInstaller reports "x64" here for 64 bit builds and "i386" for 32 bit
+    # ones, but match on the width rather than on a list of names, so that any
+    # other spelling of a 64 bit target still picks the right subdirectory.
+    win_lib_subdir = RbConfig::CONFIG['target_cpu'] =~ /64/ ? 'x64' : 'Win32'
 
-  when 'i386-mingw32'
     include_dirs << "#{sdk_dir}/include"
-    lib_dirs << "#{sdk_dir}/lib/Win32"
+    lib_dirs << "#{sdk_dir}/lib/#{win_lib_subdir}"
 
   else
     # Assume Unix-like system, where subdirectories are not used.
@@ -30,14 +41,40 @@ case RbConfig::CONFIG['arch']
     lib_dirs << "#{sdk_dir}"
 end
 
-dir_config('frontpanel', include_dirs, lib_dirs)
+# Note that we report what dir_config() returns rather than the defaults
+# computed above, because --with-frontpanel-include and --with-frontpanel-lib
+# replace those defaults entirely: showing the okFP_SDK-derived directories to
+# someone who passed the options would point them at paths that were never
+# searched.
+frontpanel_include, frontpanel_lib = dir_config('frontpanel', include_dirs, lib_dirs)
+
+# When the SDK is not found, the useful thing to know is where we looked, which
+# is otherwise buried in mkmf.log.
+message "looking for the FrontPanel SDK in:\n"
+message "  headers:   %s\n" % Array(frontpanel_include).join(', ')
+message "  libraries: %s\n" % Array(frontpanel_lib).join(', ')
+
+# Note that this is deliberately written as a plain string rather than a
+# squeezed heredoc, which is only available since Ruby 2.3, while this file
+# still supports Ruby 2.0.
+sdk_hint =
+  "The SDK is looked for in these places, in order of precedence:\n" \
+  "\n" \
+  "  1. the --with-frontpanel-include=<dir> and --with-frontpanel-lib=<dir>\n" \
+  "     options, passed after -- on the gem install command line\n" \
+  "  2. the okFP_SDK_INCLUDE and okFP_SDK_LIBS environment variables\n" \
+  "  3. the okFP_SDK environment variable, naming the API directory of the\n" \
+  "     FrontPanel developer kit\n" \
+  "\n" \
+  "For the FrontPanel 6 developer kit the headers and the library are both in\n" \
+  "that one API directory.\n"
 
 unless have_header('okFrontPanel.h')
-  abort 'Required header "okFrontPanel.h" not found, use --with-frontpanel-include=<dir> to specify its location.'
+  abort %(Required header "okFrontPanel.h" not found in any of the directories listed above.\n\n#{sdk_hint})
 end
 
 unless have_library('okFrontPanel', 'okFrontPanel_CheckAPIVersion', 'okFrontPanel.h')
-  abort 'Required okFrontPanel library not found, use --with-frontpanel-lib=<dir> to specify its location.'
+  abort %(Required okFrontPanel library not found in any of the directories listed above.\n\n#{sdk_hint})
 end
 
 # Ensure we can use C++11 features. This is not needed with most compilers but
@@ -53,4 +90,38 @@ end
 $CPPFLAGS << ' -std=c++11'
 $CPPFLAGS << ' -Wno-deprecated-declarations'
 
+# Record /usr/local/lib in the extension's own runtime library search path.
+#
+# The documented way to make the SDK library loadable is to copy it into a
+# directory searched by default, i.e. /usr/local/lib. That does not work on its
+# own: libokFrontPanel's install name under macOS is @rpath-relative, and an
+# extension with no LC_RPATH entries at all expands @rpath to nothing, so no
+# directory is searched and the copy is never found. /usr/local/lib is not part
+# of the default dyld search path either. Under Linux the same copy is only
+# found once ldconfig has been run to refresh its cache.
+#
+# One rpath entry fixes both: it is searched directly, before the loader cache,
+# and a non-existent directory in this list is simply skipped.
+#
+# Windows has no equivalent, and the DLL is located there via RUBY_DLL_PATH.
+unless RbConfig::CONFIG['host_os'] =~ /mingw|mswin|cygwin/
+  $DLDFLAGS << ' -Wl,-rpath,/usr/local/lib'
+
+  # Ask for DT_RUNPATH rather than DT_RPATH. Debian and Ubuntu patch their
+  # binutils to do this by default, but Red Hat and its derivatives do not, at
+  # any version, so this is a distribution family difference rather than an old
+  # toolchain that will age out.
+  #
+  # It matters because DT_RPATH takes precedence over LD_LIBRARY_PATH while
+  # DT_RUNPATH yields to it. Without this, the directory recorded above would
+  # silently win over a library the user had deliberately pointed at, which is
+  # the opposite of what someone setting LD_LIBRARY_PATH is asking for.
+  #
+  # Only under Linux: this option is specific to the GNU linker and Apple's
+  # linker rejects it outright.
+  if RbConfig::CONFIG['host_os'] =~ /linux/
+    $DLDFLAGS << ' -Wl,--enable-new-dtags'
+  end
+end
+
 create_makefile('OpalKelly')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: OpalKelly
 version: !ruby/object:Gem::Version
-  version: 5.3.6
+  version: 6.1.0
 platform: ruby
 authors:
 - Opal Kelly Incorporated
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2026-08-03 00:00:00.000000000 Z
 dependencies: []
 description: Provides access to FrontPanel devices.
 email: tech+rubygems@opalkelly.com