[OCaml] Ensure consistent naming.
[oota-llvm.git] / bindings / ocaml / Makefile.ocaml
index d98a489f7c424b38817eab512a25725aba57460d..1bd14e9486fa8a7186140b126c8bb5df6f3cae70 100644 (file)
@@ -1,27 +1,31 @@
-##===- tools/ml/Makefile -----------------------------------*- Makefile -*-===##
-# 
+##===- bindings/ocaml/Makefile.ocaml -----------------------*- Makefile -*-===##
+#
 #                     The LLVM Compiler Infrastructure
 #
 # This file is distributed under the University of Illinois Open Source
 # License. See LICENSE.TXT for details.
-# 
+#
 ##===----------------------------------------------------------------------===##
-# 
-# An ocaml library is a unique project type in the context of LLVM, so rules are
+#
+# An OCaml library is a unique project type in the context of LLVM, so rules are
 # here rather than in Makefile.rules.
-# 
-# Reference materials on installing ocaml libraries:
-# 
+#
+# Reference materials on installing OCaml libraries:
+#
 #   https://fedoraproject.org/wiki/Packaging/OCaml
 #   http://pkg-ocaml-maint.alioth.debian.org/ocaml_packaging_policy.txt
-# 
+#
 ##===----------------------------------------------------------------------===##
 
 include $(LEVEL)/Makefile.config
 
 # CFLAGS needs to be set before Makefile.rules is included.
-CXX.Flags += -I"$(shell $(OCAMLC) -where)"
-C.Flags += -I"$(shell $(OCAMLC) -where)"
+CXX.Flags += -I"$(shell $(OCAMLFIND) c -where)"
+C.Flags += -I"$(shell $(OCAMLFIND) c -where)"
+
+ifeq ($(ENABLE_SHARED),1)
+LINK_COMPONENTS := all
+endif
 
 include $(LEVEL)/Makefile.common
 
@@ -31,66 +35,140 @@ PROJ_libocamldir := $(DESTDIR)$(OCAML_LIBDIR)
 OcamlDir := $(LibDir)/ocaml
 
 # Info from llvm-config and similar
+ifndef IS_CLEANING_TARGET
 ifdef UsedComponents
-UsedLibs = $(shell $(LLVM_CONFIG) --libs $(UsedComponents))
+UsedLibs = $(shell $(LLVM_CONFIG) --libs --system-libs $(UsedComponents))
 UsedLibNames = $(shell $(LLVM_CONFIG) --libnames $(UsedComponents))
 endif
+endif
+
+# How do we link OCaml executables with LLVM?
+# 1) If this is a --enable-shared build, build stub libraries. This also allows
+#    to use LLVM from toplevels.
+# 2) If this is a --disable-shared build, embed ocamlc options for building
+#    a custom runtime and a static executable. It is not possible to use LLVM
+#    from toplevels.
+ifneq ($(ObjectsO),)
+ifeq ($(ENABLE_SHARED),1)
+OCAMLSTUBS := 1
+endif
+endif
 
 # Tools
-OCAMLCFLAGS += -I $(ObjDir) -I $(OcamlDir)
+OCAMLCFLAGS += -I $(OcamlDir) $(addprefix -package ,$(FindlibPackages))
+
+ifndef IS_CLEANING_TARGET
 ifneq ($(ObjectsO),)
 OCAMLAFLAGS += $(patsubst %,-cclib %, \
                  $(filter-out -L$(LibDir),-l$(LIBRARYNAME) \
                                           $(shell $(LLVM_CONFIG) --ldflags)) \
-                                          $(UsedLibs))
+                                          $(UsedLibs) $(ExtraLibs))
 else
 OCAMLAFLAGS += $(patsubst %,-cclib %, \
                  $(filter-out -L$(LibDir),$(shell $(LLVM_CONFIG) --ldflags)) \
-                                          $(UsedLibs))
+                                          $(UsedLibs) $(ExtraLibs))
+endif
+endif
+
+ifneq ($(ENABLE_OPTIMIZED),1)
+  OCAMLDEBUGFLAG := -g
+endif
+
+Compile.CMI  := $(strip $(OCAMLFIND) c -c $(OCAMLCFLAGS) $(OCAMLDEBUGFLAG) -o)
+Compile.CMO  := $(strip $(OCAMLFIND) c -c $(OCAMLCFLAGS) $(OCAMLDEBUGFLAG) -o)
+Compile.CMX  := $(strip $(OCAMLFIND) opt -c $(OCAMLCFLAGS) $(OCAMLDEBUGFLAG) -o)
+
+ifdef OCAMLSTUBS
+# Avoid the need for LD_LIBRARY_PATH
+ifneq ($(HOST_OS), $(filter $(HOST_OS), Cygwin MingW))
+ifneq ($(HOST_OS),Darwin)
+OCAMLRPATH   := $(RPATH) -Wl,'$(SharedLibDir)'
+endif
+endif
 endif
-# -g was introduced in 3.10.0.
-#ifneq ($(ENABLE_OPTIMIZED),1)
-#  OCAMLDEBUGFLAG := -g
-#endif
 
-Compile.CMI  := $(strip $(OCAMLC) -c $(OCAMLCFLAGS) $(OCAMLDEBUGFLAG) -o)
-Compile.CMO  := $(strip $(OCAMLC) -c $(OCAMLCFLAGS) $(OCAMLDEBUGFLAG) -o)
-Archive.CMA  := $(strip $(OCAMLC) -a -custom $(OCAMLAFLAGS) $(OCAMLDEBUGFLAG) \
-                                  -o)
+ifdef OCAMLSTUBS
+Archive.CMA  := $(strip $(OCAMLFIND) c -a -dllib -l$(LIBRARYNAME) $(OCAMLDEBUGFLAG) \
+                                       -o)
+else
+Archive.CMA  := $(strip $(OCAMLFIND) c -a -custom $(OCAMLAFLAGS) $(OCAMLDEBUGFLAG) \
+                                       -o)
+endif
 
-Compile.CMX  := $(strip $(OCAMLOPT) -c $(OCAMLCFLAGS) $(OCAMLDEBUGFLAG) -o)
-Archive.CMXA := $(strip $(OCAMLOPT) -a $(OCAMLAFLAGS) $(OCAMLDEBUGFLAG) -o)
+ifdef OCAMLSTUBS
+Archive.CMXA := $(strip $(OCAMLFIND) opt -a $(patsubst %,-cclib %, \
+                                    $(LLVMLibsOptions) -l$(LIBRARYNAME) \
+                                    -L$(SharedLibDir) $(OCAMLRPATH)) \
+                                    $(OCAMLDEBUGFLAG) -o)
+else
+Archive.CMXA := $(strip $(OCAMLFIND) opt -a $(OCAMLAFLAGS) $(OCAMLDEBUGFLAG) -o)
+endif
 
 # Source files
+ifndef OcamlSources1
 OcamlSources1 := $(sort $(wildcard $(PROJ_SRC_DIR)/*.ml))
-OcamlHeaders1 := $(OcamlSources1:.ml=.mli)
+endif
+
+ifndef OcamlHeaders1
+OcamlHeaders1 := $(sort $(wildcard $(PROJ_SRC_DIR)/*.mli))
+endif
+
+OcamlSources2 := $(filter-out $(ExcludeSources),$(OcamlSources1))
+OcamlHeaders2 := $(filter-out $(ExcludeHeaders),$(OcamlHeaders1))
 
-OcamlSources := $(OcamlSources1:$(PROJ_SRC_DIR)/%=$(ObjDir)/%)
-OcamlHeaders := $(OcamlHeaders1:$(PROJ_SRC_DIR)/%=$(ObjDir)/%)
+OcamlSources := $(OcamlSources2:$(PROJ_SRC_DIR)/%=$(ObjDir)/%)
+OcamlHeaders := $(OcamlHeaders2:$(PROJ_SRC_DIR)/%=$(ObjDir)/%)
 
 # Intermediate files
-LibraryCMA   := $(ObjDir)/$(LIBRARYNAME).cma
-LibraryCMXA  := $(ObjDir)/$(LIBRARYNAME).cmxa
 ObjectsCMI   := $(OcamlSources:%.ml=%.cmi)
 ObjectsCMO   := $(OcamlSources:%.ml=%.cmo)
 ObjectsCMX   := $(OcamlSources:%.ml=%.cmx)
 
+ifdef LIBRARYNAME
+LibraryCMA   := $(ObjDir)/$(LIBRARYNAME).cma
+LibraryCMXA  := $(ObjDir)/$(LIBRARYNAME).cmxa
+endif
+
+ifdef TOOLNAME
+ToolEXE      := $(ObjDir)/$(TOOLNAME)$(EXEEXT)
+endif
+
 # Output files
 #   The .cmo files are the only intermediates; all others are to be installed.
-LibraryA   := $(OcamlDir)/lib$(LIBRARYNAME).a
-OutputCMA  := $(LibraryCMA:$(ObjDir)/%.cma=$(OcamlDir)/%.cma)
-OutputCMXA := $(LibraryCMXA:$(ObjDir)/%.cmxa=$(OcamlDir)/%.cmxa)
 OutputsCMI := $(ObjectsCMI:$(ObjDir)/%.cmi=$(OcamlDir)/%.cmi)
 OutputsCMX := $(ObjectsCMX:$(ObjDir)/%.cmx=$(OcamlDir)/%.cmx)
 OutputLibs := $(UsedLibNames:%=$(OcamlDir)/%)
 
+ifdef LIBRARYNAME
+LibraryA   := $(OcamlDir)/lib$(LIBRARYNAME).a
+OutputCMA  := $(LibraryCMA:$(ObjDir)/%.cma=$(OcamlDir)/%.cma)
+OutputCMXA := $(LibraryCMXA:$(ObjDir)/%.cmxa=$(OcamlDir)/%.cmxa)
+endif
+
+ifdef OCAMLSTUBS
+SharedLib := $(OcamlDir)/dll$(LIBRARYNAME)$(SHLIBEXT)
+endif
+
+ifdef TOOLNAME
+ifdef EXAMPLE_TOOL
+OutputEXE := $(ExmplDir)/$(strip $(TOOLNAME))$(EXEEXT)
+else
+OutputEXE := $(ToolDir)/$(strip $(TOOLNAME))$(EXEEXT)
+endif
+endif
+
 # Installation targets
+DestLibs := $(UsedLibNames:%=$(PROJ_libocamldir)/%)
+
+ifdef LIBRARYNAME
 DestA    := $(PROJ_libocamldir)/lib$(LIBRARYNAME).a
 DestCMA  := $(PROJ_libocamldir)/$(LIBRARYNAME).cma
 DestCMXA := $(PROJ_libocamldir)/$(LIBRARYNAME).cmxa
-DestLibs := $(UsedLibNames:%=$(PROJ_libocamldir)/%)
+endif
 
+ifdef OCAMLSTUBS
+DestSharedLib := $(PROJ_libocamldir)/dll$(LIBRARYNAME)$(SHLIBEXT)
+endif
 
 ##===- Dependencies -------------------------------------------------------===##
 # Copy the sources into the intermediate directory because older ocamlc doesn't
@@ -102,18 +180,27 @@ $(ObjDir)/%.mli: $(PROJ_SRC_DIR)/%.mli $(ObjDir)/.dir
 $(ObjDir)/%.ml: $(PROJ_SRC_DIR)/%.ml $(ObjDir)/.dir
        $(Verb) $(CP) -f $< $@
 
+$(ObjectsCMI): $(UsedOcamlInterfaces:%=$(OcamlDir)/%.cmi)
+
+ifdef LIBRARYNAME
 $(ObjDir)/$(LIBRARYNAME).ocamldep: $(OcamlSources) $(OcamlHeaders) \
                                    $(OcamlDir)/.dir $(ObjDir)/.dir
-       $(Verb) $(OCAMLDEP) $(OCAMLCFLAGS) $(OcamlSources) $(OcamlHeaders) > $@
-
-$(ObjectsCMI): $(UsedOcamlInterfaces:%=$(OcamlDir)/%.cmi)
+       $(Verb) $(OCAMLFIND) dep $(OCAMLCFLAGS) $(OcamlSources) $(OcamlHeaders) > $@
 
 -include $(ObjDir)/$(LIBRARYNAME).ocamldep
+endif
+
+ifdef TOOLNAME
+$(ObjDir)/$(TOOLNAME).ocamldep: $(OcamlSources) $(OcamlHeaders) \
+                                $(OcamlDir)/.dir $(ObjDir)/.dir
+       $(Verb) $(OCAMLFIND) dep $(OCAMLCFLAGS) $(OcamlSources) $(OcamlHeaders) > $@
 
+-include $(ObjDir)/$(TOOLNAME).ocamldep
+endif
 
 ##===- Build static library from C sources --------------------------------===##
 
-ifneq ($(ObjectsO),)
+ifdef LibraryA
 all-local:: $(LibraryA)
 clean-local:: clean-a
 install-local:: install-a
@@ -132,7 +219,7 @@ install-a:: $(LibraryA)
        $(Echo) "Installing $(BuildMode) $(DestA)"
        $(Verb) $(MKDIR) $(PROJ_libocamldir)
        $(Verb) $(INSTALL) $(LibraryA) $(DestA)
-       $(Verb) 
+       $(Verb)
 
 uninstall-a::
        $(Echo) "Uninstalling $(DestA)"
@@ -140,6 +227,34 @@ uninstall-a::
 endif
 
 
+##===- Build stub library from C sources ----------------------------------===##
+
+ifdef SharedLib
+all-local:: $(SharedLib)
+clean-local:: clean-shared
+install-local:: install-shared
+uninstall-local:: uninstall-shared
+
+$(SharedLib): $(ObjectsO) $(OcamlDir)/.dir
+       $(Echo) "Building $(BuildMode) $(notdir $@)"
+       $(Verb) $(Link) $(SharedLinkOptions) $(OCAMLRPATH) $(LLVMLibsOptions) \
+                       -o $@ $(ObjectsO)
+
+clean-shared::
+       -$(Verb) $(RM) -f $(SharedLib)
+
+install-shared:: $(SharedLib)
+       $(Echo) "Installing $(BuildMode) $(DestSharedLib)"
+       $(Verb) $(MKDIR) $(PROJ_libocamldir)
+       $(Verb) $(INSTALL) $(SharedLib) $(DestSharedLib)
+       $(Verb)
+
+uninstall-shared::
+       $(Echo) "Uninstalling $(DestSharedLib)"
+       -$(Verb) $(RM) -f $(DestSharedLib)
+endif
+
+
 ##===- Deposit dependent libraries adjacent to Ocaml libs -----------------===##
 
 all-local:: build-deplibs
@@ -156,19 +271,21 @@ $(OcamlDir)/%.o: $(LibDir)/%.o
        $(Verb) ln -sf $< $@
 
 clean-deplibs:
-       $(Verb) rm -f $(OutputLibs)
+       $(Verb) $(RM) -f $(OutputLibs)
 
 install-deplibs:
+       $(Verb) $(MKDIR) $(PROJ_libocamldir)
        $(Verb) for i in $(DestLibs:$(PROJ_libocamldir)/%=%); do \
          ln -sf "$(PROJ_libdir)/$$i" "$(PROJ_libocamldir)/$$i"; \
        done
 
 uninstall-deplibs:
-       $(Verb) rm -f $(DestLibs)
+       $(Verb) $(RM) -f $(DestLibs)
 
 
 ##===- Build ocaml interfaces (.mli's -> .cmi's) --------------------------===##
 
+ifneq ($(OcamlHeaders),)
 all-local:: build-cmis
 clean-local:: clean-cmis
 install-local:: install-cmis
@@ -189,14 +306,14 @@ clean-cmis::
 # Also install the .mli's (headers) as documentation.
 install-cmis: $(OutputsCMI) $(OcamlHeaders)
        $(Verb) $(MKDIR) $(PROJ_libocamldir)
-       $(Verb) for i in $(OutputsCMI:$(OcamlDir)/%=%); do \
-         $(EchoCmd) "Installing $(BuildMode) $(PROJ_libocamldir)/$$i"; \
-         $(DataInstall) $(OcamlDir)/$$i "$(PROJ_libocamldir)/$$i"; \
-       done
        $(Verb) for i in $(OcamlHeaders:$(ObjDir)/%=%); do \
          $(EchoCmd) "Installing $(BuildMode) $(PROJ_libocamldir)/$$i"; \
          $(DataInstall) $(ObjDir)/$$i "$(PROJ_libocamldir)/$$i"; \
        done
+       $(Verb) for i in $(OutputsCMI:$(OcamlDir)/%=%); do \
+         $(EchoCmd) "Installing $(BuildMode) $(PROJ_libocamldir)/$$i"; \
+         $(DataInstall) $(OcamlDir)/$$i "$(PROJ_libocamldir)/$$i"; \
+       done
 
 uninstall-cmis::
        $(Verb) for i in $(OutputsCMI:$(OcamlDir)/%=%); do \
@@ -207,10 +324,16 @@ uninstall-cmis::
          $(EchoCmd) "Uninstalling $(PROJ_libocamldir)/$$i"; \
          $(RM) -f "$(PROJ_libocamldir)/$$i"; \
        done
+endif
 
 
 ##===- Build ocaml bytecode archive (.ml's -> .cmo's -> .cma) -------------===##
 
+$(ObjDir)/%.cmo: $(ObjDir)/%.ml
+       $(Echo) "Compiling $(notdir $<) for $(BuildMode) build"
+       $(Verb) $(Compile.CMO) $@ $<
+
+ifdef LIBRARYNAME
 all-local:: $(OutputCMA)
 clean-local:: clean-cma
 install-local:: install-cma
@@ -223,10 +346,6 @@ $(LibraryCMA): $(ObjectsCMO) $(OcamlDir)/.dir
        $(Echo) "Archiving $(notdir $@) for $(BuildMode) build"
        $(Verb) $(Archive.CMA) $@ $(ObjectsCMO)
 
-$(ObjDir)/%.cmo: $(ObjDir)/%.ml
-       $(Echo) "Compiling $(notdir $<) for $(BuildMode) build"
-       $(Verb) $(Compile.CMO) $@ $<
-
 clean-cma::
        $(Verb) $(RM) -f $(OutputCMA) $(UsedLibNames:%=$(OcamlDir)/%)
 
@@ -238,14 +357,22 @@ install-cma:: $(OutputCMA)
 uninstall-cma::
        $(Echo) "Uninstalling $(DestCMA)"
        -$(Verb) $(RM) -f $(DestCMA)
-
+endif
 
 ##===- Build optimized ocaml archive (.ml's -> .cmx's -> .cmxa, .a) -------===##
 
 # The ocamlopt compiler is supported on a set of targets disjoint from LLVM's.
-# If unavailable, 'configure' will not define OCAMLOPT in Makefile.config.
-ifdef OCAMLOPT
+# If unavailable, 'configure' will set HAVE_OCAMLOPT to 0 in Makefile.config.
+ifeq ($(HAVE_OCAMLOPT),1)
+
+$(OcamlDir)/%.cmx: $(ObjDir)/%.cmx
+       $(Verb) $(CP) -f $< $@
 
+$(ObjDir)/%.cmx: $(ObjDir)/%.ml
+       $(Echo) "Compiling optimized $(notdir $<) for $(BuildMode) build"
+       $(Verb) $(Compile.CMX) $@ $<
+
+ifdef LIBRARYNAME
 all-local:: $(OutputCMXA) $(OutputsCMX)
 clean-local:: clean-cmxa
 install-local:: install-cmxa
@@ -255,18 +382,11 @@ $(OutputCMXA): $(LibraryCMXA)
        $(Verb) $(CP) -f $< $@
        $(Verb) $(CP) -f $(<:.cmxa=.a) $(@:.cmxa=.a)
 
-$(OcamlDir)/%.cmx: $(ObjDir)/%.cmx
-       $(Verb) $(CP) -f $< $@
-
 $(LibraryCMXA): $(ObjectsCMX)
        $(Echo) "Archiving $(notdir $@) for $(BuildMode) build"
        $(Verb) $(Archive.CMXA) $@ $(ObjectsCMX)
        $(Verb) $(RM) -f $(@:.cmxa=.o)
 
-$(ObjDir)/%.cmx: $(ObjDir)/%.ml
-       $(Echo) "Compiling optimized $(notdir $<) for $(BuildMode) build"
-       $(Verb) $(Compile.CMX) $@ $<
-
 clean-cmxa::
        $(Verb) $(RM) -f $(OutputCMXA) $(OutputCMXA:.cmxa=.a) $(OutputsCMX)
 
@@ -290,14 +410,14 @@ uninstall-cmxa::
          $(EchoCmd) "Uninstalling $(PROJ_libocamldir)/$$i"; \
          $(RM) -f $(PROJ_libocamldir)/$$i; \
        done
-
+endif
 endif
 
 ##===- Generate documentation ---------------------------------------------===##
 
 $(ObjDir)/$(LIBRARYNAME).odoc: $(ObjectsCMI)
        $(Echo) "Documenting $(notdir $@)"
-       $(Verb) $(OCAMLDOC) -I $(ObjDir) -I $(OcamlDir) -dump $@ $(OcamlHeaders)
+       $(Verb) $(OCAMLFIND) doc -I $(ObjDir) -I $(OcamlDir) -dump $@ $(OcamlHeaders)
 
 ocamldoc: $(ObjDir)/$(LIBRARYNAME).odoc
 
@@ -308,9 +428,7 @@ printcamlvars::
        $(Echo) "LLVM_CONFIG  : " '$(LLVM_CONFIG)'
        $(Echo) "OCAMLCFLAGS  : " '$(OCAMLCFLAGS)'
        $(Echo) "OCAMLAFLAGS  : " '$(OCAMLAFLAGS)'
-       $(Echo) "OCAMLC       : " '$(OCAMLC)'
-       $(Echo) "OCAMLOPT     : " '$(OCAMLOPT)'
-       $(Echo) "OCAMLDEP     : " '$(OCAMLDEP)'
+       $(Echo) "OCAMLFIND    : " '$(OCAMLFIND)'
        $(Echo) "Compile.CMI  : " '$(Compile.CMI)'
        $(Echo) "Compile.CMO  : " '$(Compile.CMO)'
        $(Echo) "Archive.CMA  : " '$(Archive.CMA)'
@@ -319,8 +437,12 @@ printcamlvars::
        $(Echo) "CAML_LIBDIR  : " '$(CAML_LIBDIR)'
        $(Echo) "LibraryCMA   : " '$(LibraryCMA)'
        $(Echo) "LibraryCMXA  : " '$(LibraryCMXA)'
+       $(Echo) "SharedLib    : " '$(SharedLib)'
        $(Echo) "OcamlSources1: " '$(OcamlSources1)'
+       $(Echo) "OcamlSources2: " '$(OcamlSources2)'
        $(Echo) "OcamlSources : " '$(OcamlSources)'
+       $(Echo) "OcamlHeaders1: " '$(OcamlHeaders1)'
+       $(Echo) "OcamlHeaders2: " '$(OcamlHeaders2)'
        $(Echo) "OcamlHeaders : " '$(OcamlHeaders)'
        $(Echo) "ObjectsCMI   : " '$(ObjectsCMI)'
        $(Echo) "ObjectsCMO   : " '$(ObjectsCMO)'
@@ -329,10 +451,14 @@ printcamlvars::
        $(Echo) "DestA        : " '$(DestA)'
        $(Echo) "DestCMA      : " '$(DestCMA)'
        $(Echo) "DestCMXA     : " '$(DestCMXA)'
+       $(Echo) "DestSharedLib: " '$(DestSharedLib)'
        $(Echo) "UsedLibs     : " '$(UsedLibs)'
        $(Echo) "UsedLibNames : " '$(UsedLibNames)'
+       $(Echo) "ExtraLibs    : " '$(ExtraLibs)'
 
 .PHONY: printcamlvars   build-cmis \
             clean-a     clean-cmis     clean-cma     clean-cmxa \
           install-a   install-cmis   install-cma   install-cmxa \
-               uninstall-a uninstall-cmis uninstall-cma uninstall-cmxa
+          install-exe \
+               uninstall-a uninstall-cmis uninstall-cma uninstall-cmxa \
+               uninstall-exe