Enable ? help for GAP.Globals.FOO

pkg/GAPJulia/JuliaInterface/julia/libgap.jl

@@ -0,0 +1,19 @@
+#
+# This is a very hacky prototype calling libgap from julia
+#
+# It is intended to be a low level interface to the C functions
+# the higher level API can be found in gap.jl
+#
+
+using Libdl
+
+import Base: length, convert
+
+const MPtr = Main.ForeignGAP.MPtr
+
+
+include( "ccalls.jl" )
+include( "gap.jl" )
+include( "gap_to_julia.jl" )
+include( "julia_to_gap.jl" )
+include( "help.jl" )

src/GAP.jl

@@ -129,5 +129,6 @@ include( "gap2.jl" )
 include( "macros.jl" )
 include( "gap_to_julia.jl" )
 include( "julia_to_gap.jl" )
+include( "help.jl" )
 
 end

src/gap2.jl

@@ -144,8 +144,3 @@ function Display(x::GapObj)
         error("variable was not correctly evaluated")
     end
 end
-
-function show_GAP_help( topic::String, onlyexact::Bool=false )
-    print( GAP.gap_to_julia( GAP.Globals.HelpString(
-           GAP.julia_to_gap( topic ), onlyexact ) ) )
-end

src/help.jl

@@ -0,0 +1,25 @@
+function GAP_help_string(topic::String, onlyexact::Bool = false)
+    return GAP.gap_to_julia(GAP.Globals.HelpString(GAP.julia_to_gap(topic), onlyexact))
+end
+
+function show_GAP_help(topic::String, onlyexact::Bool = false)
+    print(GAP_help_string(topic, onlyexact))
+end
+
+import Base.Docs: Binding, getdoc, docstr
+
+## Create a helper type that gets returned by Binding
+struct GAPHelpType
+    name::Symbol
+end
+
+Base.Docs.Binding(x::GlobalsType, name::Symbol) = GAPHelpType(name)
+
+function Base.Docs.doc(x::GAPHelpType, typesig::Type = Union{})
+    return Text(GAP_help_string(string(x.name)))
+end
+
+## Set getdoc for GlobalsType to nothing,
+## so it dispatches on the Binding.
+Base.Docs.getdoc(x::GlobalsType) = nothing
+Base.Docs.getdoc(x::GapObj) = Text(GAP_help_string(gap_to_julia(Globals.NameFunction(x))))