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}}(
         "void" => Cvoid,
         "void *" => Ptr{Cvoid},
         "int" => Cint,
@@ -37,6 +37,9 @@ const arbargtypes = ArbArgTypes(
         "arb_t" => Arb,
         "acb_t" => Acb,
         "mag_t" => Mag,
+        "nfloat_ptr" => NFloat,
+        "nfloat_srcptr" => NFloat,
+        "gr_ctx_t" => nfloat_ctx_struct,
         "arb_srcptr" => ArbVector,
         "arb_ptr" => ArbVector,
         "acb_srcptr" => AcbVector,
@@ -54,7 +57,7 @@ const arbargtypes = ArbArgTypes(
         "ulong *" => Vector{UInt},
     ),
     Set(["FILE *", "fmpr_t", "fmpr_rnd_t", "flint_rand_t", "bool_mat_t"]),
-    Dict{DataType,String}(
+    Dict{Union{DataType,UnionAll},String}(
         Cvoid => "void",
         Ptr{Cvoid} => "void *",
         Cint => "int",
@@ -69,6 +72,8 @@ const arbargtypes = ArbArgTypes(
         Arb => "arb_t",
         Acb => "acb_t",
         Mag => "mag_t",
+        NFloat => "nfloat_ptr",
+        nfloat_ctx_struct => "gr_ctx_t",
         ArbVector => "arb_ptr",
         AcbVector => "acb_ptr",
         ArbPoly => "arb_poly_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

@@ -69,6 +69,8 @@ const jlfname_prefixes = (
     "arb",
     "acb",
     "mag",
+    "nfloat",
+    "ctx",
     "mat",
     "vec",
     "poly",
@@ -78,7 +80,7 @@ const jlfname_prefixes = (
     "cdouble",
 )
 const jlfname_suffixes =
-    ("si", "ui", "d", "mag", "arf", "acf", "arb", "acb", "mpz", "mpfr", "str")
+    ("si", "ui", "d", "mag", "nfloat", "arf", "acf", "arb", "acb", "mpz", "mpfr", "str")
 
 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!(jl_arg_names_types, (name(carg), jltype(carg)))
         end

src/ArbCall/Carg.jl

@@ -69,6 +69,7 @@ jltype(::Carg{Vector{UInt}}) = Vector{<:Unsigned}
 jltype(::Carg{Vector{Float64}}) = Vector{<:Base.GMP.CdoubleMax}
 jltype(::Carg{Vector{ComplexF64}}) = Vector{<:Union{ComplexF16,ComplexF32,ComplexF64}}
 jltype(::Carg{Mag}) = MagLike
+jltype(::Carg{NFloat}) = NFloatLike
 jltype(::Carg{Arf}) = ArfLike
 jltype(::Carg{Acf}) = AcfLike
 jltype(::Carg{Arb}) = ArbLike
@@ -92,6 +93,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{BigFloat,BigInt}} = Ref{T}
 ctype(::Carg{Vector{T}}) where {T} = Ref{T}
+ctype(::Carg{T}) where {T<:NFloat} = Ref{nfloat_struct}
+ctype(::Carg{T}) where {T<:nfloat_ctx_struct} = Ref{nfloat_ctx_struct}
 
 is_precision_argument(ca::Carg) = ca == Carg{Int}(:prec, false)
 
@@ -105,6 +108,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"))
@@ -143,6 +148,18 @@ function extract_length_argument(ca::Carg, prev_ca::Carg)
     return Expr(:kw, :($(name(ca))::Integer), :(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,
+        :($(name(ca))::nfloat_ctx_struct),
+        :(_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")