Overhaul library and engine detection (#188)

Move code the determines the engine paths to deps/build.jl file.
This has the benefit to allow us to handle and load the package in cases
MATLAB doesn't exist on the CI.

Author: musm

.github/workflows/CI.yml

@@ -9,29 +9,25 @@ on:
   pull_request:
 
 jobs:
-  name: julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
-  runs-on: ${{ matrix.os }}
-  strategy:
-    fail-fast: false
-    matrix:
-      version:
-        - '1.3'
-        - '1'
-        - 'nightly'
-      os:
-        - ubuntu-latest
-        - macOS-latest
-        - windows-latest
-      arch:
-        - x64
-        - x86
-  steps:
-    - uses: actions/checkout@v2
-    - uses: julia-actions/setup-julia@latest
-      with:
-        version: ${{ matrix.version }}
-        arch: ${{ matrix.arch }}
-    - uses: julia-actions/julia-buildpkg@latest
-    - uses: julia-actions/julia-runtest@latest
-      with:
-        file: lcov.info
+  test:
+    name: julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.3'
+          - '1'
+          - 'nightly'
+        os:
+          - ubuntu-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: julia-actions/julia-buildpkg@latest
+      - uses: julia-actions/julia-runtest@latest

.gitignore

@@ -1,2 +1,4 @@
+deps/build.log
+deps/deps.jl
 *.mat
 Manifest.toml

Project.toml

@@ -1,7 +1,7 @@
 name = "MATLAB"
 uuid = "10e44e05-a98a-55b3-a45b-ba969058deb6"
-repo = "https://github.com/JuliaInterop/MATLAB.jl.git"
 license = "MIT"
+repo = "https://github.com/JuliaInterop/MATLAB.jl.git"
 version = "0.8.0"
 
 [deps]

deps/build.jl

@@ -0,0 +1,119 @@
+import Libdl
+
+const depsfile = joinpath(@__DIR__, "deps.jl")
+
+# Determine MATLAB library path and provide facilities to load libraries with
+# this path
+
+function find_matlab_homepath()
+    matlab_home = get(ENV, "MATLAB_HOME", nothing)
+    if isnothing(matlab_home)
+        matlab_exe = Sys.which("matlab")
+        matlab_home = !isnothing(matlab_exe) ? dirname(dirname(matlab_exe)) : nothing
+        if isnothing(matlab_home)
+            if Sys.isapple()
+                default_dir = "/Applications"
+                if isdir(default_dir)
+                    dirs = readdir(default_dir)
+                    filter!(app -> occursin(r"^MATLAB_R[0-9]+[ab]\.app$", app), dirs)
+                    if !isempty(dirs)
+                        matlab_home = joinpath(default_dir, maximum(dirs))
+                    end
+                end
+            elseif Sys.iswindows()
+                default_dir = Sys.WORD_SIZE == 32 ? "C:\\Program Files (x86)\\MATLAB" : "C:\\Program Files\\MATLAB"
+                if isdir(default_dir)
+                    dirs = readdir(default_dir)
+                    filter!(dir -> occursin(r"^R[0-9]+[ab]$", dir), dirs)
+                    if !isempty(dirs)
+                        matlab_home = joinpath(default_dir, maximum(dirs))
+                    end
+                end
+            end
+        end
+    end
+    if isnothing(matlab_home)
+        return nothing
+    else
+        @info("Found MATLAB home path at $matlab_home")
+        return matlab_home
+    end
+end
+
+function find_matlab_libpath(matlab_home)
+    # get path to MATLAB libraries
+    matlab_lib_dir = if Sys.islinux()
+        Sys.WORD_SIZE == 32 ? "glnx86" : "glnxa64"
+    elseif Sys.isapple()
+        Sys.WORD_SIZE == 32 ? "maci" : "maci64"
+    elseif Sys.iswindows()
+        Sys.WORD_SIZE == 32 ? "win32" : "win64"
+    end
+    matlab_libpath = joinpath(matlab_home, "bin", matlab_lib_dir)
+    if !isdir(matlab_libpath)
+        @warn("The MATLAB library path could not be found.")
+    end
+    return matlab_libpath
+end
+
+function find_matlab_cmd(matlab_home)
+    if !Sys.iswindows()
+        matlab_cmd = joinpath(matlab_home, "bin", "matlab")
+        if !isfile(matlab_cmd)
+            @warn("The MATLAB path is invalid. Ensure the \"MATLAB_HOME\" evironmental variable to the MATLAB root directory.")
+        end
+        matlab_cmd = "exec $(Base.shell_escape(matlab_cmd))"
+    elseif Sys.iswindows()
+        matlab_cmd = joinpath(matlab_home, "bin", (Sys.WORD_SIZE == 32 ? "win32" : "win64"), "MATLAB.exe")
+        if !isfile(matlab_cmd)
+            error("The MATLAB path is invalid. Ensure the \"MATLAB_HOME\" evironmental variable to the MATLAB root directory.")
+        end
+    end
+    return matlab_cmd
+end
+
+matlab_homepath = find_matlab_homepath()
+
+if !isnothing(matlab_homepath)
+    matlab_libpath = find_matlab_libpath(matlab_homepath)
+    matlab_cmd = find_matlab_cmd(matlab_homepath)
+    libmx_size = filesize(Libdl.dlpath(joinpath(matlab_libpath, "libmx")))
+    open(depsfile, "w") do io
+        println(io,
+            """
+            # This file is automatically generated, do not edit.
+
+            function check_deps()
+                if libmx_size != filesize(Libdl.dlpath(joinpath(matlab_libpath, "libmx")))
+                    error("MATLAB library has changed, re-run Pkg.build(\\\"MATLAB\\\")")
+                end
+            end
+            """
+            )
+            println(io, "const matlab_libpath = \"$(escape_string(matlab_libpath))\"")
+            println(io, "const matlab_cmd = \"$(escape_string(matlab_cmd))\"")
+            println(io, "const libmx_size = $libmx_size")
+    end
+elseif get(ENV, "JULIA_REGISTRYCI_AUTOMERGE", nothing) == "true" || get(ENV, "CI", nothing) == "true"
+    # We need to be able to install and load this package without error for
+    # Julia's registry AutoMerge to work, so we just use dummy values.
+    # Similarly we want to also be able to install and load this package for CI.
+    matlab_libpath = ""
+    matlab_cmd = ""
+    libmx_size = 0
+
+    open(depsfile, "w") do io
+        println(io,
+            """
+            # This file is automatically generated, do not edit.
+
+            check_deps() = nothing
+            """
+            )
+            println(io, "const matlab_libpath = \"$(escape_string(matlab_libpath))\"")
+            println(io, "const matlab_cmd = \"$(escape_string(matlab_cmd))\"")
+            println(io, "const libmx_size = $libmx_size")
+    end
+else
+    error("MATLAB cannot be found. Set the \"MATLAB_HOME\" environment variable to the MATLAB root directory and re-run Pkg.build(\"MATLAB\").")
+end

src/MATLAB.jl

@@ -1,6 +1,5 @@
 module MATLAB
 
-using Base.Sys: islinux, iswindows, isapple
 using Libdl
 using SparseArrays
 
@@ -30,23 +29,29 @@ export MSession, MatFile,
        mxcall,
        @mput, @mget, @mat_str
 
-if iswindows()
+if Sys.iswindows()
     export show_msession, hide_msession, get_msession_visiblity
 end
 
+const depsfile = joinpath(dirname(@__DIR__), "deps", "deps.jl")
+if isfile(depsfile)
+    include(depsfile)
+else
+    error("MATLAB is not properly installed. Please run Pkg.build(\"MATLAB\") and restart Julia.")
+end
+
 # exceptions
 struct MEngineError <: Exception
     message::String
 end
 
 include("init.jl") # initialize Refs
-include("mxbase.jl")
 include("mxarray.jl")
 include("matfile.jl")
 include("engine.jl")
 include("matstr.jl")
 
-if iswindows()
+if Sys.iswindows()
     # workaround "primary message table for module 77" error
     # creates a dummy Engine session and keeps it open so the libraries used by all other
     # Engine clients are not loaded and unloaded repeatedly
@@ -64,14 +69,21 @@ if iswindows()
     end
 end
 
+# helper library access function
+engfunc(fun::Symbol) = Libdl.dlsym(libeng[], fun)
+mxfunc(fun::Symbol)  = Libdl.dlsym(libmx[], fun)
+matfunc(fun::Symbol) = Libdl.dlsym(libmat[], fun)
+
 function __init__()
+    check_deps()
 
+    if libmx_size > 0 # non-zero size library path
 
     # load libraries
 
-    libmx[]  = Libdl.dlopen(joinpath(matlab_libpath(), "libmx"), Libdl.RTLD_GLOBAL)
-    libmat[] = Libdl.dlopen(joinpath(matlab_libpath(), "libmat"), Libdl.RTLD_GLOBAL)
-    libeng[] = Libdl.dlopen(joinpath(matlab_libpath(), "libeng"), Libdl.RTLD_GLOBAL)
+    libmx[]  = Libdl.dlopen(joinpath(matlab_libpath, "libmx"), Libdl.RTLD_GLOBAL)
+    libmat[] = Libdl.dlopen(joinpath(matlab_libpath, "libmat"), Libdl.RTLD_GLOBAL)
+    libeng[] = Libdl.dlopen(joinpath(matlab_libpath, "libeng"), Libdl.RTLD_GLOBAL)
 
     # engine functions
 
@@ -166,6 +178,7 @@ function __init__()
     mat_put_variable[] = matfunc(:matPutVariable)
     mat_get_dir[]      = matfunc(:matGetDir)
 
+    end
 end
 
 

src/engine.jl

@@ -6,10 +6,10 @@
 #
 ###########################################################
 const default_startflag = "" # no additional flags
-default_matlabcmd() = matlab_cmd() * " -nosplash"
+const default_matlabcmd = matlab_cmd * " -nosplash"
 # pass matlab flags directly or as a Vector of flags, i.e. "-a" or ["-a", "-b", "-c"]
-startcmd(flag::AbstractString = default_startflag) = isempty(flag) ? default_matlabcmd() : default_matlabcmd() * " " * flag
-startcmd(flags::AbstractVector{T}) where {T<:AbstractString} = isempty(flags) ? default_matlabcmd() : default_matlabcmd() * " " * join(flags, " ")
+startcmd(flag::AbstractString = default_startflag) = isempty(flag) ? default_matlabcmd : default_matlabcmd * " " * flag
+startcmd(flags::AbstractVector{T}) where {T<:AbstractString} = isempty(flags) ? default_matlabcmd : default_matlabcmd * " " * join(flags, " ")
 
 # 64 K buffer should be sufficient to store the output text in most cases
 const default_output_buffer_size = 64 * 1024
@@ -20,20 +20,20 @@ mutable struct MSession
     bufptr::Ptr{UInt8}
 
     function MSession(bufsize::Integer = default_output_buffer_size; flags=default_startflag)
-        if iswindows()
+        if Sys.iswindows()
             assign_persistent_msession()
         end
         ep = ccall(eng_open[], Ptr{Cvoid}, (Ptr{UInt8},), startcmd(flags))
         if ep == C_NULL
             @warn("Confirm MATLAB is installed and discoverable.", maxlog=1)
-            if iswindows()
+            if Sys.iswindows()
                 @warn("Ensure `matlab -regserver` has been run in a Command Prompt as Administrator.", maxlog=1)
-            elseif islinux()
+            elseif Sys.islinux()
                 @warn("Ensure `csh` is installed; this may require running `sudo apt-get install csh`.", maxlog=1)
             end
             throw(MEngineError("failed to open MATLAB engine session"))
         end
-        if iswindows()
+        if Sys.iswindows()
             # hide the MATLAB command window on Windows and change to current directory
             ccall(eng_set_visible[], Cint, (Ptr{Cvoid}, Cint), ep, 0)
             ccall(eng_eval_string[], Cint, (Ptr{Cvoid}, Ptr{UInt8}),
@@ -103,7 +103,7 @@ function close_default_msession()
     return nothing
 end
 
-if iswindows()
+if Sys.iswindows()
     function show_msession(m::MSession = get_default_msession())
         ret = ccall(eng_set_visible[], Cint, (Ptr{Cvoid}, Cint), m, 1)
         ret != 0 && throw(MEngineError("failed to show MATLAB engine session (err = $ret)"))

src/mxbase.jl

@@ -1,7 +1,11 @@
 using MATLAB
 using Test
 
+is_ci() = get(ENV, "CI", nothing) == "true"
+
+if !is_ci() # only test if not CI
 include("engine.jl")
 include("matfile.jl")
 include("matstr.jl")
 include("mxarray.jl")
+end