Add workaround for Xcode 11.4 issues

Based on the Polymake.jl patch, with a few minor tweaks.
Also adds a Travis test against Xcode 11.4 to verify this works.

.gitignore

@@ -3,6 +3,7 @@
 *.jl.mem
 /deps/build.log
 /deps/build*.jl
+/deps/build/
 /deps/deps.jl
 /deps/src/cmake_install.cmake
 /deps/src/CMakeCache.txt
@@ -11,7 +12,8 @@
 /deps/src/lib/
 /deps/src/Makefile
 /deps/usr/
-/docs/build
+/deps/xcodetypeinfo/build/
+/docs/build/
 /local/*
 /Manifest.toml
 /src/libraryfuncdictionary.jl

.travis.yml

@@ -34,9 +34,16 @@ jobs:
     - julia: nightly
   fast_finish: true
   include:
+    # test (one of) the oldest macOS configuration still supported by us
+    # (older ones have trouble compiling CxxWrap)
     - os: osx
       osx_image: xcode9.2 # latest version available for macOS 10.12 Sierra
 
+    # also test with latest macOS image and latest Julia
+    - julia: 1.4
+      os: osx
+      osx_image: xcode11.4
+
     - stage: "Documentation"
       name: "HTML"
       julia: 1.3

Project.toml

@@ -1,6 +1,6 @@
 name = "Singular"
 uuid = "bcd08a7b-43d2-5ff7-b6d4-c458787f915c"
-version = "0.3.0"
+version = "0.3.1"
 
 [deps]
 AbstractAlgebra = "c3fe647b-3220-5bb0-a1ea-a7954cac585d"

deps/build.jl

@@ -12,7 +12,6 @@ issource_build = "SINGULAR_SOURCE_BUILD" in keys(ENV) && ENV["SINGULAR_SOURCE_BU
 
 const prefixpath = joinpath(@__DIR__, "usr")
 const wdir = joinpath(@__DIR__)
-const oldwdir = pwd()
 
 const nemodir = realpath(joinpath(dirname(pathof(Nemo)), ".."))
 nemovdir = "$nemodir/deps/usr"
@@ -202,11 +201,46 @@ end
 
 push!(Libdl.DL_LOAD_PATH, joinpath(prefixpath, "lib"))
 
-cd(oldwdir)
-
 @show libcxxwrap_prefix = CxxWrap.prefix_path()
 @show julia_exec = joinpath(Sys.BINDIR, "julia")
 
+extra_cppflags = ""
+
+if Sys.isapple()
+   # Work around a bug in Xcode 11.4 that causes SIGABRT, at least until
+   # https://github.com/llvm/llvm-project/commit/2464d8135e
+   # arrives.
+   #
+   # We build a jlcxx library that uses std::string which will
+   # abort with a failed assertion has_julia_type<T> if we are building
+   # with xcode 11.4 but libcxxwrap-julia was built with an older libc++.
+   #
+   # Read the above LLVM commit message for some details; the effect of merged
+   # vs non-merged type_info is that for the former memory addresses are
+   # used as hash_code(), for the latter the type_info.name() string is
+   # hashed.
+
+   xcodetypeinfo_build_path = joinpath(@__DIR__, "xcodetypeinfo", "build")
+   rm(xcodetypeinfo_build_path, recursive = true, force = true)
+   mkpath(xcodetypeinfo_build_path)
+   cd(xcodetypeinfo_build_path)
+   run(`$(CMake.cmake)
+        -DJulia_EXECUTABLE=$julia_exec
+        -DCMAKE_PREFIX_PATH=$libcxxwrap_prefix
+        ..`)
+   run(`$(CMake.cmake) --build .`)
+   libpath = joinpath(xcodetypeinfo_build_path, "libhello.$(Libdl.dlext)")
+   res = run(pipeline(Cmd(`$(Base.julia_cmd()) --project
+                           -e "using CxxWrap; @wrapmodule(\"$libpath\", :define_module_hello); @initcxx;"`,
+                           ignorestatus = true),
+                      stdout=devnull,
+                      stderr=devnull))
+   if res.termsignal == 6
+      println("Applying Xcode type_info.hash_code() workaround")
+      global extra_cppflags *= " -DFORCE_XCODE_TYPEINFO_MERGED"
+   end
+end
+
 cmake_src_path = joinpath(@__DIR__, "src")
 cmake_build_path = joinpath(@__DIR__, "build")
 
@@ -218,6 +252,7 @@ println("Initializing cmake")
 run(`$(CMake.cmake)
     -DJulia_EXECUTABLE=$julia_exec
     -DCMAKE_PREFIX_PATH=$libcxxwrap_prefix
+    -Dextra_cppflags=$extra_cppflags
     -Dsingular_includes=$prefixpath/include
     -Dsingular_libdir=$prefixpath/lib
     -DCMAKE_INSTALL_LIBDIR=$prefixpath/lib

deps/src/CMakeLists.txt

@@ -15,7 +15,7 @@ message(STATUS "Found JlCxx at ${JlCxx_location}")
 include_directories(${singular_includes})
 include_directories(${singular_includes}/singular)
 
-SET( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g" )
+SET( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g ${extra_cppflags}" )
 SET( CMAKE_SHARED_LINKER_FLAGS  "${CMAKE_SHARED_LINKER_FLAGS} -L${singular_libdir} -Wl,-rpath,${singular_libdir}" )
 
 

deps/src/coeff_rings.cpp

@@ -1,9 +1,5 @@
-#include "jlcxx/jlcxx.hpp"
-#include "includes.h"
 #include "coeff_rings.h"
 
-#include <iostream>
-
 typedef struct __singular_coeff_ring_struct {
       int64_t has_simple_alloc;
       int64_t has_simple_Inverse;

deps/src/coeff_rings.h

@@ -1,6 +1,8 @@
 #ifndef COEFF_RINGS_INCLUDE
 #define COEFF_RINGS_INCLUDE
 
+#include "includes.h"
+
 void singular_define_coeff_rings(jlcxx::Module &);
 
 #endif

deps/src/includes.h

@@ -1,6 +1,8 @@
 #ifndef MAIN_INCLUDE_FILE
 #define MAIN_INCLUDE_FILE
 
+#include "xcode_jlcxx_workaround.h"
+
 #include <string>
 #include <cstring>
 #include <iostream>

deps/src/singular.cpp

@@ -1,4 +1,3 @@
-#include "jlcxx/jlcxx.hpp"
 #include "includes.h"
 #include "coeffs.h"
 #include "rings.h"

deps/src/threading.h

@@ -1,3 +1,5 @@
+#include "xcode_jlcxx_workaround.h"
+
 #include <mutex>
 
 #ifdef THREADSAFE_SINGULAR

deps/src/xcode_jlcxx_workaround.h

@@ -0,0 +1,29 @@
+#ifndef XCODE_JLCXX_WORKAROUND
+#define XCODE_JLCXX_WORKAROUND
+
+// This must be the very first include
+#ifdef _LIBCPP_CONFIG
+#error This header must be included before any system headers!
+#endif
+
+// Work around Xcode 11.4 issue until upstream libc++ fix arrives in Xcode:
+// https://github.com/llvm/llvm-project/commit/2464d8135e
+//
+// First include __config from libc++, then override typeinfo flag
+// to force use of address as hash instead of hashing the string.
+
+#if defined(__APPLE__) && defined(FORCE_XCODE_TYPEINFO_MERGED)
+#include <__config>
+#if defined(_LIBCPP_HAS_MERGED_TYPEINFO_NAMES_DEFAULT) && \
+    _LIBCPP_HAS_MERGED_TYPEINFO_NAMES_DEFAULT == 0
+#undef _LIBCPP_HAS_MERGED_TYPEINFO_NAMES_DEFAULT
+#define _LIBCPP_HAS_MERGED_TYPEINFO_NAMES_DEFAULT 1
+#else
+#error Trying to work around Xcode 11.4 bug but libc++ macro not set as expected! \
+ Please try rebuilding and create an issue if this reappears.
+#endif
+#endif
+
+#include "jlcxx/jlcxx.hpp"
+
+#endif

deps/xcodetypeinfo/CMakeLists.txt

@@ -0,0 +1,12 @@
+project(xcodetypeinfo)
+
+cmake_minimum_required(VERSION 3.01)
+
+find_package(JlCxx REQUIRED)
+
+get_target_property(JlCxx_location JlCxx::cxxwrap_julia LOCATION)
+get_filename_component(JlCxx_location ${JlCxx_location} DIRECTORY)
+set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib;${JlCxx_location}")
+
+add_library(hello SHARED hello.cpp)
+target_link_libraries(hello JlCxx::cxxwrap_julia)

deps/xcodetypeinfo/hello.cpp

@@ -0,0 +1,14 @@
+#include <string>
+#include <vector>
+
+#include "jlcxx/jlcxx.hpp"
+
+std::string greet(const std::string& str)
+{
+   return "hello, world";
+}
+
+JLCXX_MODULE define_module_hello(jlcxx::Module& mod)
+{
+  mod.method("greet", &greet);
+}