Unify the method name to get library versions (#23323)

JuliaLang · Aug 24, 2017 · 2406b6e · 2406b6e
1 parent 8809617
commit 2406b6e
Showing 9 changed files with 34 additions and 21 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -359,6 +359,11 @@ Deprecated or removed
 
   * `diagm(A::BitMatrix)` has been deprecated, use `diagm(vec(A))` instead ([#23373]).
 
+  * `GMP.gmp_version()`, `GMP.GMP_VERSION`, `GMP.gmp_bits_per_limb()`, and `GMP.GMP_BITS_PER_LIBM`
+    have been renamed to `GMP.version()`, `GMP.VERSION`, `GMP.bits_per_libm()`, and `GMP.BITS_PER_LIBM`,
+    respectively. Similarly, `MPFR.get_version()`, has been renamed to `MPFR.version()` ([#23323]). Also,
+    `LinAlg.LAPACK.laver()` has been renamed to `LinAlg.LAPACK.version()` and now returns a `VersionNumber`.
+
 Command-line option changes
 ---------------------------
 

diff --git a/base/deprecated.jl b/base/deprecated.jl
@@ -1726,6 +1726,14 @@ export hex2num
 # PR #23373
 @deprecate diagm(A::BitMatrix) diagm(vec(A))
 
+# PR 23341
+@eval GMP @deprecate gmp_version() version() false
+@eval GMP @Base.deprecate_binding GMP_VERSION VERSION false
+@eval GMP @deprecate gmp_bits_per_limb() bits_per_limb() false
+@eval GMP @Base.deprecate_binding GMP_BITS_PER_LIMB BITS_PER_LIMB false
+@eval MPFR @deprecate get_version() version() false
+@eval LinAlg.LAPACK @deprecate laver() version() false
+
 # PR #23271
 function IOContext(io::IO; kws...)
     depwarn("IOContext(io, k=v, ...) is deprecated, use IOContext(io, :k => v, ...) instead.", :IOContext)

diff --git a/base/gmp.jl b/base/gmp.jl
@@ -21,25 +21,25 @@ else
 end
 const CdoubleMax = Union{Float16, Float32, Float64}
 
-gmp_version() = VersionNumber(unsafe_string(unsafe_load(cglobal((:__gmp_version, :libgmp), Ptr{Cchar}))))
-gmp_bits_per_limb() = Int(unsafe_load(cglobal((:__gmp_bits_per_limb, :libgmp), Cint)))
+version() = VersionNumber(unsafe_string(unsafe_load(cglobal((:__gmp_version, :libgmp), Ptr{Cchar}))))
+bits_per_limb() = Int(unsafe_load(cglobal((:__gmp_bits_per_limb, :libgmp), Cint)))
 
-const GMP_VERSION = gmp_version()
-const GMP_BITS_PER_LIMB = gmp_bits_per_limb()
+const VERSION = version()
+const BITS_PER_LIMB = bits_per_limb()
 
 # GMP's mp_limb_t is by default a typedef of `unsigned long`, but can also be configured to be either
 # `unsigned int` or `unsigned long long int`. The correct unsigned type is here named Limb, and must
 # be used whenever mp_limb_t is in the signature of ccall'ed GMP functions.
-if GMP_BITS_PER_LIMB == 32
+if BITS_PER_LIMB == 32
     const Limb = UInt32
     const SLimbMax = Union{Int8, Int16, Int32}
     const ULimbMax = Union{UInt8, UInt16, UInt32}
-elseif GMP_BITS_PER_LIMB == 64
+elseif BITS_PER_LIMB == 64
     const Limb = UInt64
     const SLimbMax = Union{Int8, Int16, Int32, Int64}
     const ULimbMax = Union{UInt8, UInt16, UInt32, UInt64}
 else
-    error("GMP: cannot determine the type mp_limb_t (__gmp_bits_per_limb == $GMP_BITS_PER_LIMB)")
+    error("GMP: cannot determine the type mp_limb_t (__gmp_bits_per_limb == $BITS_PER_LIMB)")
 end
 
 """
@@ -82,10 +82,10 @@ BigInt(x)
 
 function __init__()
     try
-        if gmp_version().major != GMP_VERSION.major || gmp_bits_per_limb() != GMP_BITS_PER_LIMB
-            msg = gmp_bits_per_limb() != GMP_BITS_PER_LIMB ? error : warn
-            msg(string("The dynamically loaded GMP library (version $(gmp_version()) with __gmp_bits_per_limb == $(gmp_bits_per_limb()))\n",
-                       "does not correspond to the compile time version (version $GMP_VERSION with __gmp_bits_per_limb == $GMP_BITS_PER_LIMB).\n",
+        if version().major != VERSION.major || bits_per_limb() != BITS_PER_LIMB
+            msg = bits_per_limb() != BITS_PER_LIMB ? error : warn
+            msg(string("The dynamically loaded GMP library (version $(version()) with __gmp_bits_per_limb == $(bits_per_limb()))\n",
+                       "does not correspond to the compile time version (version $VERSION with __gmp_bits_per_limb == $BITS_PER_LIMB).\n",
                        "Please rebuild Julia."))
         end
 

diff --git a/base/libgit2/utils.jl b/base/libgit2/utils.jl
@@ -26,7 +26,7 @@ function version()
     minor = Ref{Cint}(0)
     patch = Ref{Cint}(0)
     ccall((:git_libgit2_version, :libgit2), Void,
-          (Ptr{Cint}, Ptr{Cint}, Ptr{Cint}), major, minor, patch)
+          (Ref{Cint}, Ref{Cint}, Ref{Cint}), major, minor, patch)
     return VersionNumber(major[], minor[], patch[])
 end
 const VERSION = version()

diff --git a/base/linalg/lapack.jl b/base/linalg/lapack.jl
@@ -92,14 +92,14 @@ function chkfinite(A::StridedMatrix)
 end
 
 # LAPACK version number
-function laver()
+function version()
     major = Ref{BlasInt}(0)
     minor = Ref{BlasInt}(0)
     patch = Ref{BlasInt}(0)
     ccall((@blasfunc(ilaver_), liblapack), Void,
-        (Ptr{BlasInt}, Ptr{BlasInt}, Ptr{BlasInt}),
-        major, minor, patch)
-    return major[], minor[], patch[]
+          (Ptr{BlasInt}, Ptr{BlasInt}, Ptr{BlasInt}),
+          major, minor, patch)
+    return VersionNumber(major[], minor[], patch[])
 end
 
 # (GB) general banded matrices, LU decomposition and solver

diff --git a/base/linalg/svd.jl b/base/linalg/svd.jl
@@ -193,7 +193,7 @@ end
 """
 function svdfact!(A::StridedMatrix{T}, B::StridedMatrix{T}) where T<:BlasFloat
     # xggsvd3 replaced xggsvd in LAPACK 3.6.0
-    if LAPACK.laver() < (3, 6, 0)
+    if LAPACK.version() < v"3.6.0"
         U, V, Q, a, b, k, l, R = LAPACK.ggsvd!('U', 'V', 'Q', A, B)
     else
         U, V, Q, a, b, k, l, R = LAPACK.ggsvd3!('U', 'V', 'Q', A, B)
@@ -290,7 +290,7 @@ end
 
 function svdvals!(A::StridedMatrix{T}, B::StridedMatrix{T}) where T<:BlasFloat
     # xggsvd3 replaced xggsvd in LAPACK 3.6.0
-    if LAPACK.laver() < (3, 6, 0)
+    if LAPACK.version() < v"3.6.0"
         _, _, _, a, b, k, l, _ = LAPACK.ggsvd!('N', 'N', 'N', A, B)
     else
         _, _, _, a, b, k, l, _ = LAPACK.ggsvd3!('N', 'N', 'N', A, B)

diff --git a/base/mpfr.jl b/base/mpfr.jl
@@ -27,7 +27,7 @@ import Base.Math.lgamma_r
 
 import Base.FastMath.sincos_fast
 
-function get_version()
+function version()
     version = unsafe_string(ccall((:mpfr_get_version,:libmpfr), Ptr{Cchar}, ()))
     build = replace(unsafe_string(ccall((:mpfr_get_patches,:libmpfr), Ptr{Cchar}, ())), ' ', '.')
     isempty(build) ? VersionNumber(version) : VersionNumber(version * '+' * build)

diff --git a/test/linalg/lapack.jl b/test/linalg/lapack.jl
@@ -172,7 +172,7 @@ end
         @test V' ≈ lVt
         B = rand(elty,10,10)
         # xggsvd3 replaced xggsvd in LAPACK 3.6.0
-        if LAPACK.laver() < (3, 6, 0)
+        if LAPACK.version() < v"3.6.0"
             @test_throws DimensionMismatch LAPACK.ggsvd!('S','S','S',A,B)
         else
             @test_throws DimensionMismatch LAPACK.ggsvd3!('S','S','S',A,B)

diff --git a/test/mpfr.jl b/test/mpfr.jl
@@ -887,7 +887,7 @@ setprecision(256) do
 end
 
 # issue #22758
-if MPFR.get_version() > v"3.1.5" || "r11590" in MPFR.get_version().build
+if MPFR.version() > v"3.1.5" || "r11590" in MPFR.version().build
     setprecision(2_000_000) do
         @test abs(sin(big(pi)/6) - 0.5) < ldexp(big(1.0),-1_999_000)
     end