nfloat: Proof of concept wrapping of new nfloat module in Flint

Author: Joel-Dahne

src/ArbCall/ArbArgTypes.jl

@@ -9,9 +9,9 @@ Struct for conversion between C argument types in the Arb
 documentation and Julia types.
 """
 struct ArbArgTypes
-    supported::Dict{String,DataType}
+    supported::Dict{String,Union{DataType,UnionAll}}
     unsupported::Set{String}
-    supported_reversed::Dict{DataType,String}
+    supported_reversed::Dict{Union{DataType,UnionAll},String}
 end
 
 function Base.getindex(arbargtypes::ArbArgTypes, key::AbstractString)
@@ -22,7 +22,7 @@ end
 
 # Define the conversions we use for the rest of the code
 const arbargtypes = ArbArgTypes(
-    Dict{String,DataType}(
+    Dict{String,Union{DataType,UnionAll}}(
         # Primitive
         "void" => Cvoid,
         "int" => Cint,
@@ -43,6 +43,10 @@ const arbargtypes = ArbArgTypes(
         "mpfr_rnd_t" => Base.MPFR.MPFRRoundingMode,
         # mag.h
         "mag_t" => Mag,
+        # nfloat.h
+        "nfloat_ptr" => NFloat,
+        "nfloat_srcptr" => NFloat,
+        "gr_ctx_t" => nfloat_ctx_struct, # Actually in gr_types.h
         # arf.h
         "arf_t" => Arf,
         "arf_rnd_t" => arb_rnd,
@@ -66,7 +70,7 @@ const arbargtypes = ArbArgTypes(
         "acb_mat_t" => AcbMatrix,
     ),
     Set(["FILE *", "flint_rand_t"]),
-    Dict{DataType,String}(
+    Dict{Union{DataType,UnionAll},String}(
         # Primitive
         Cvoid => "void",
         Cint => "int",
@@ -87,6 +91,9 @@ const arbargtypes = ArbArgTypes(
         Base.MPFR.MPFRRoundingMode => "mpfr_rnd_t",
         # mag.h
         Mag => "mag_t",
+        # nfloat.h
+        NFloat => "nfloat_ptr",
+        nfloat_ctx_struct => "gr_ctx_t", # Actually in gr_types.h
         # arf.h
         Arf => "arf_t",
         arb_rnd => "arf_rnd_t",

src/ArbCall/ArbCall.jl

@@ -12,6 +12,9 @@ import ..Arblib:
     cstructtype,
     arb_rnd,
     mag_struct,
+    nfloat_struct,
+    nfloat_ctx_struct,
+    _get_nfloat_ctx_struct,
     arf_struct,
     acf_struct,
     arb_struct,
@@ -23,6 +26,7 @@ import ..Arblib:
     arb_mat_struct,
     acb_mat_struct,
     MagLike,
+    NFloatLike,
     ArfLike,
     AcfLike,
     ArbLike,

src/ArbCall/ArbFunction.jl

@@ -67,6 +67,8 @@ const jlfname_prefixes = (
     "double",
     "cdouble",
     "mag",
+    "nfloat",
+    "ctx",
     "arf",
     "acf",
     "arb",
@@ -78,7 +80,7 @@ const jlfname_prefixes = (
     "scalar",
 )
 const jlfname_suffixes =
-    ("si", "ui", "d", "str", "mpz", "mpfr", "mag", "arf", "acf", "arb", "acb")
+    ("si", "ui", "d", "str", "mpz", "mpfr", "mag", "nfloat", "arf", "acf", "arb", "acb")
 
 function jlfname(
     arbfname::AbstractString;
@@ -146,6 +148,8 @@ function jlargs(af::ArbFunction; argument_detection::Bool = true)
             push!(kwargs, extract_rounding_argument(carg))
         elseif i > 1 && is_length_argument(carg, cargs[i-1])
             push!(kwargs, extract_length_argument(carg, cargs[i-1]))
+        elseif is_ctx_argument(carg)
+            push!(kwargs, extract_ctx_argument(carg, first(cargs)))
         else
             push!(args, jlarg(carg))
         end

src/ArbCall/Carg.jl

@@ -71,6 +71,8 @@ jltype(::Carg{Vector{ComplexF64}}) = Vector{ComplexF64}
 jltype(::Carg{Base.MPFR.MPFRRoundingMode}) = Union{Base.MPFR.MPFRRoundingMode,RoundingMode}
 # mag.h
 jltype(::Carg{Mag}) = MagLike
+# nfloat.h
+jltype(::Carg{NFloat}) = NFloatLike
 # arf.h
 jltype(::Carg{Arf}) = ArfLike
 jltype(::Carg{arb_rnd}) = Union{arb_rnd,RoundingMode}
@@ -103,6 +105,8 @@ ctype(::Carg{T}) where {T<:Union{Mag,Arf,Acf,Arb,Acb,ArbPoly,AcbPoly,ArbMatrix,A
     Ref{cstructtype(T)}
 ctype(::Carg{T}) where {T<:Union{ArbVector,arb_vec_struct}} = Ptr{arb_struct}
 ctype(::Carg{T}) where {T<:Union{AcbVector,acb_vec_struct}} = Ptr{acb_struct}
+ctype(::Carg{T}) where {T<:NFloat} = Ref{nfloat_struct}
+ctype(::Carg{T}) where {T<:nfloat_ctx_struct} = Ref{nfloat_ctx_struct}
 
 """
     jlarg(ca::Carg{T}) where {T}
@@ -131,6 +135,8 @@ is_length_argument(ca::Carg, prev_ca::Carg) =
     rawtype(ca) == Int &&
     rawtype(prev_ca) ∈ (ArbVector, AcbVector)
 
+is_ctx_argument(ca::Carg{T}) where {T} = T <: nfloat_ctx_struct
+
 function extract_precision_argument(ca::Carg, first_ca::Carg)
     is_precision_argument(ca) ||
         throw(ArgumentError("argument is not a valid precision argument, $ca"))
@@ -161,6 +167,14 @@ function extract_length_argument(ca::Carg, prev_ca::Carg)
     return Expr(:kw, jlarg(ca), :(length($(name(prev_ca)))))
 end
 
+# TODO: This needs to handle the case when it is not the first
+# argument we should get the context from. This happens for e.g.
+# nfloat_get_arf.
+function extract_ctx_argument(ca::Carg, first_ca::Carg)
+    is_ctx_argument(ca) || throw(ArgumentError("argument is not a valid ctx argument, $ca"))
+    return Expr(:kw, jlarg(ca), :(_get_nfloat_ctx_struct($(name(first_ca)))))
+end
+
 """
     is_fpwrap_res_argument(ca::Carg, T::Union{Float64,ComplexF64})
 

src/ArbCall/parse.jl

@@ -192,6 +192,7 @@ function parse_and_generate_arbdoc(
     out_dir = "src/arbcalls/";
     filenames = [
         "mag",
+        "nfloat",
         "arf",
         "acf",
         "arb",

src/Arblib.jl

@@ -54,6 +54,8 @@ include("types.jl")
 include("hash.jl")
 include("serialize.jl")
 
+include("nfloat.jl")
+
 include("ArbCall/ArbCall.jl")
 import .ArbCall: @arbcall_str, @arbfpwrapcall_str
 include("manual_overrides.jl")
@@ -84,6 +86,7 @@ include("calc_integrate.jl")
 include("special-functions.jl")
 
 include("arbcalls/mag.jl")
+include("arbcalls/nfloat.jl")
 include("arbcalls/arf.jl")
 include("arbcalls/acf.jl")
 include("arbcalls/arb.jl")