Rework the package -- Take 1

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       matrix:
         version:
-          - '1.5'
+          - '1.6'
         os:
           - ubuntu-latest
           - macOS-latest
@@ -38,7 +38,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
         with:
-          version: '1.5'
+          version: '1.6'
       - run: |
           julia --project=docs -e '
             using Pkg

.gitignore

@@ -1,19 +1,8 @@
-*.so
-*.dylib
-*.o
-*.swp
-*~
-*.kate-swp
+*.jl.*.cov
+*.jl.cov
+*.jl.mem
+.DS_Store
+/Manifest.toml
 
-deps/usr
-deps/deps.jl
-deps/build.log
-gen/LibTemplate.jl
-gen/CEnum.jl
-gen/ctypes.jl
-
-test/test_api.jl
-test/test_common.jl
 Manifest.toml
-test/libclang_api.jl
-test/libclang_common.jl
+test/LibClang.jl

LICENSE

@@ -1,6 +1,5 @@
-MIT License
 
-Copyright (c) 2018 Isaiah Norton and other [contributors](https://github.com/ihnorton/Clang.jl/graphs/contributors)
+Copyright (c) 2021 JuliaInterop
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +17,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

Project.toml

@@ -1,21 +1,21 @@
 name = "Clang"
 uuid = "40e3b903-d033-50b4-a0cc-940c62c95e31"
-authors = ["Isaiah Norton"]
-version = "0.12.1"
+authors = ["Isaiah Norton", "Yupei Qi <qiyupei@gmail.com>"]
+version = "0.13.0"
 
 [deps]
 CEnum = "fa961155-64e5-5f13-b03f-caf6b980ea82"
 Clang_jll = "0ee61d77-7f21-5576-8119-9fcc46b10100"
-DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
-Libdl = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
+TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
 
 [compat]
 CEnum = "0.4"
-DataStructures = "0.17, 0.18"
-julia = "~1.5.0"
+Clang_jll = "~11.0.1"
+julia = "~1.6.0"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 
 [targets]
-test = ["Test"]
+test = ["Test", "Pkg"]

README.md

@@ -113,7 +113,7 @@ for trans_unit in ctx.trans_units
     ctx.children = children(root_cursor)
     for (i, child) in enumerate(ctx.children)
         child_name = name(child)
-        child_header = filename(child)
+        child_header = get_filename(child)
         ctx.children_index = i
         # choose which cursor to wrap
         startswith(child_name, "__") && continue  # skip compiler definitions

docs/src/index.md

@@ -104,7 +104,7 @@ for trans_unit in ctx.trans_units
     ctx.children = children(root_cursor)
     for (i, child) in enumerate(ctx.children)
         child_name = name(child)
-        child_header = filename(child)
+        child_header = get_filename(child)
         ctx.children_index = i
         # choose which cursor to wrap
         startswith(child_name, "__") && continue  # skip compiler definitions

docs/src/tutorial.md

@@ -45,7 +45,7 @@ julia> struct_cursor = search(root_cursor, "ExStruct")[1]
 CLCursor (CLStructDecl) ExStruct
 
 julia> for c in children(struct_cursor)  # print children
-           println("Cursor: ", c, "\n  Kind: ", kind(c), "\n  Name: ", name(c), "\n  Type: ", type(c))
+           println("Cursor: ", c, "\n  Kind: ", kind(c), "\n  Name: ", name(c), "\n  Type: ", getCursorType(c))
        end
 Cursor: CLCursor (CLFieldDecl) kind
   Kind: CXCursor_FieldDecl(6)
@@ -166,15 +166,15 @@ julia> fdecl_children = [c for c in children(fdecl)]
 ```
 The first three children are `CLParmDecl` cursors with the same name as the arguments in the function signature. Checking the types of the `CLParmDecl` cursors indicates a similarity to the function signature:
 ```julia
-julia> [type(t) for t in fdecl_children[1:3]]
+julia> [getCursorType(t) for t in fdecl_children[1:3]]
 3-element Array{CLType,1}:
  CLType (CLInt)     
  CLType (CLPointer)
  CLType (CLPointer)
 ```
 And, finally, retrieving the target type of each `CLPointer` argument confirms that these cursors represent the function argument type declaration:
 ```julia
-julia> [pointee_type(type(t)) for t in fdecl_children[2:3]]
+julia> [getPointeeType(getCursorType(t)) for t in fdecl_children[2:3]]
 2-element Array{CLType,1}:
  CLType (CLChar_S)
  CLType (CLFloat)  
@@ -188,11 +188,11 @@ printind(ind::Int, st...) = println(join([repeat(" ", 2*ind), st...]))
 printobj(cursor::CLCursor) = printobj(0, cursor)
 printobj(t::CLType) = join(typeof(t), " ", spelling(t))
 printobj(t::CLInt) = t
-printobj(t::CLPointer) = pointee_type(t)
+printobj(t::CLPointer) = getPointeeType(t)
 printobj(ind::Int, t::CLType) = printind(ind, printobj(t))
 
 function printobj(ind::Int, cursor::Union{CLFieldDecl, CLParmDecl})
-    printind(ind+1, typeof(cursor), " ", printobj(type(cursor)), " ", name(cursor))
+    printind(ind+1, typeof(cursor), " ", printobj(getCursorType(cursor)), " ", name(cursor))
 end
 
 function printobj(ind::Int, node::Union{CLCursor, CLStructDecl, CLCompoundStmt,

gen/generator.jl

@@ -1,11 +1,34 @@
-using Clang
+using Clang.Generators
 using Clang.LibClang.Clang_jll
 
-const LIBCLANG_INCLUDE = joinpath(dirname(Clang_jll.libclang_path), "..", "include", "clang-c") |> normpath
-const LIBCLANG_HEADERS = [joinpath(LIBCLANG_INCLUDE, header) for header in readdir(LIBCLANG_INCLUDE) if endswith(header, ".h")]
+cd(@__DIR__)
 
+const INCLUDE_DIR = joinpath(Clang_jll.artifact_dir, "include") |> normpath
+const CLANG_C_DIR = joinpath(INCLUDE_DIR, "clang-c")
 
+headers = [joinpath(CLANG_C_DIR, header) for header in readdir(CLANG_C_DIR) if endswith(header, ".h")]
+options = load_options(joinpath(@__DIR__, "generator.toml"))
+
+# add compiler flags
+args = ["-I$INCLUDE_DIR"]
+
+@static if Sys.iswindows()
+    include("windows.jl")
+    push!(args, "--sysroot=$mingw_sys", "-I$mingw_inc")
+end
+
+# add extra definition
+@add_def time_t AbstractJuliaSIT JuliaCtime_t Ctime_t
+
+# create context
+ctx = create_context(headers, args, options)
+
+# build without printing so we can do custom rewriting
+build!(ctx, BUILDSTAGE_NO_PRINTING)
+
+# custom rewriter
 function rewrite!(e::Expr)
+    Meta.isexpr(e, :function) || return e
     # Add deprecated warning to some functions
     #   ref: [Remove unused CompilationDatabase::MappedSources](https://reviews.llvm.org/D32351)
     fname = e.args[1].args[1]
@@ -20,75 +43,23 @@ function rewrite!(e::Expr)
         `$fname` Left here for backward compatibility.
         No mapped sources exists in the C++ backend anymore.
         This function just return Null `CXString`.
-
         See:
         - [Remove unused CompilationDatabase::MappedSources](https://reviews.llvm.org/D32351)
         """
         insert!(e.args[2].args, 1, Expr(:macrocall, Symbol("@warn"), :Base, msg))
     end
     return e
 end
-rewrite!(x) = x
-rewrite(v::Vector) = map(rewrite!, v)
 
-# create a work context
-ctx = DefaultContext()
-
-# parse headers
-parse_headers!(ctx, LIBCLANG_HEADERS,
-               args=["-I", joinpath(LIBCLANG_INCLUDE, ".."), map(x->"-I"*x, find_std_headers())...],
-               includes=vcat(LIBCLANG_INCLUDE, CLANG_INCLUDE),
-               )
-
-# settings
-ctx.libname = "libclang"
-ctx.options["is_function_strictly_typed"] = false
-ctx.options["is_struct_mutable"] = false
-
-# write output
-api_file = joinpath(@__DIR__, "libclang_api.jl")
-api_stream = open(api_file, "w")
-
-for trans_unit in ctx.trans_units
-    root_cursor = getcursor(trans_unit)
-    push!(ctx.cursor_stack, root_cursor)
-    header = spelling(root_cursor)
-    @info "wrapping header: $header ..."
-    # loop over all of the child cursors and wrap them, if appropriate.
-    ctx.children = children(root_cursor)
-    for (i, child) in enumerate(ctx.children)
-        child_name = name(child)
-        child_header = filename(child)
-        ctx.children_index = i
-        # choose which cursor to wrap
-        startswith(child_name, "__") && continue  # skip compiler definitions
-        child_name in keys(ctx.common_buffer) && continue  # already wrapped
-        child_header != header && continue  # skip if cursor filename is not in the headers to be wrapped
-
-        # issues#243
-        if occursin("clang_CompileCommand_getNumMappedSources", child_name)
-            @info "Ignore $child_name, because this function is not export anymore."
-            continue
+function rewrite!(dag::ExprDAG)
+    for node in get_nodes(dag)
+        for expr in get_exprs(node)
+            rewrite!(expr)
         end
-
-        wrap!(ctx, child)
     end
-    @info "writing $(api_file)"
-    println(api_stream, "# Julia wrapper for header: $(basename(header))")
-    println(api_stream, "# Automatically generated using Clang.jl\n")
-    ctx.api_buffer = rewrite(ctx.api_buffer)
-    print_buffer(api_stream, ctx.api_buffer)
-    empty!(ctx.api_buffer)  # clean up api_buffer for the next header
 end
-close(api_stream)
 
-# write "common" definitions: types, typealiases, etc.
-common_file = joinpath(@__DIR__, "libclang_common.jl")
-open(common_file, "w") do f
-    println(f, "# Automatically generated using Clang.jl\n")
-    return print_buffer(f, dump_to_buffer(ctx.common_buffer))
-end
+rewrite!(ctx.dag)
 
-# uncomment the following code to generate dependency and template files
-# copydeps(dirname(api_file))
-# print_template(joinpath(dirname(api_file), "LibTemplate.jl"))
+# print
+build!(ctx, BUILDSTAGE_PRINTING_ONLY)