Add open_documentation()

README.md

@@ -42,3 +42,14 @@ The code bindings within this package are autogenerated from the following
  * `LibraryProduct`: `libgurobi`
  * `ExecutableProduct`: `gurobi_cl`
  * `ExecutableProduct`: `grbgetkey`
+
+## Documentationn
+
+Use `Gurobi_jll.open_documentation()` to open a local copy of the Gurobi
+documentation in your browser.
+
+```julia
+julia> import Gurobi_jll
+
+julia> Gurobi_jll.open_documentation()
+```

src/Gurobi_jll.jl

@@ -14,4 +14,31 @@ JLLWrappers.@generate_main_file_header("Gurobi")
 
 JLLWrappers.@generate_main_file("Gurobi", UUID("c018c7e6-a5b0-4aea-8f80-9c1ef9991411"))
 
+function get_documentation_path()
+    path = @static if Sys.iswindows()
+        joinpath("Doc", "Gurobi", "refman", "index.html")
+    else
+        joinpath("share", "doc", "gurobi", "refman", "index.html")
+    end
+    return joinpath(artifact_dir, path)
+end
+
+function _browser_command(path::String)
+    @static if Sys.isapple()
+        return `open $path`
+    elseif Sys.iswindows()
+        return `cmd /c start $path`
+    else
+        @assert Sys.islinux()
+        return `xdg-open $path`
+    end
+end
+
+"""
+    open_documentation()
+
+Open a local copy of the Gurobi documentation in your browser.
+"""
+open_documentation() = run(_browser_command(get_documentation_path()))
+
 end  # module Gurobi_jll

test/runtests.jl

@@ -45,7 +45,23 @@ end
     error = @ccall libgurobi.GRBemptyenv(envptr::Ptr{Ptr{Cvoid}})::Cint
     @test error == 0
     error = @ccall libgurobi.GRBstartenv(envptr[]::Ptr{Cvoid})::Cint
-    @test error == 10009
-    msg = unsafe_string(@ccall libgurobi.GRBgeterrormsg(envptr[]::Ptr{Cvoid})::Ptr{Cchar})
-    @test startswith(msg, "No Gurobi license found")
+    @test error == 10009 || error == 0
+    if error == 10009
+        ret = @ccall libgurobi.GRBgeterrormsg(envptr[]::Ptr{Cvoid})::Ptr{Cchar}
+        @test startswith(unsafe_string(ret), "No Gurobi license found")
+    end
+end
+
+@testset "open_documentation" begin
+    @test isfile(Gurobi_jll.get_documentation_path())
+    if Sys.isapple()
+        @test Gurobi_jll._browser_command("abc") == `open abc`
+        Gurobi_jll.open_documentation()
+    elseif Sys.iswindows()
+        @test Gurobi_jll._browser_command("abc") == `cmd /c start abc`
+        Gurobi_jll.open_documentation()
+    else
+        @test Gurobi_jll._browser_command("abc") == `xdg-open abc`
+        # Gurobi_jll.open_documentation()  # Errors in CI
+    end
 end