| 1 |
########################################################################## |
| 2 |
# # |
| 3 |
# This file is part of Frama-C. # |
| 4 |
# # |
| 5 |
# Copyright (C) 2007-2022 # |
| 6 |
# CEA (Commissariat à l'énergie atomique et aux énergies # |
| 7 |
# alternatives) # |
| 8 |
# # |
| 9 |
# you can redistribute it and/or modify it under the terms of the GNU # |
| 10 |
# Lesser General Public License as published by the Free Software # |
| 11 |
# Foundation, version 2.1. # |
| 12 |
# # |
| 13 |
# It is distributed in the hope that it will be useful, # |
| 14 |
# but WITHOUT ANY WARRANTY; without even the implied warranty of # |
| 15 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # |
| 16 |
# GNU Lesser General Public License for more details. # |
| 17 |
# # |
| 18 |
# See the GNU Lesser General Public License version 2.1 # |
| 19 |
# for more details (enclosed in the file licenses/LGPLv2.1). # |
| 20 |
# # |
| 21 |
########################################################################## |
| 22 |
|
| 23 |
$(eval $(call assert_defined,PLUGIN_NAME)) |
| 24 |
|
| 25 |
PLUGIN_ENABLE ?=yes |
| 26 |
PLUGIN_DIR ?=. |
| 27 |
|
| 28 |
FRAMAC_SRC ?=$(PLUGIN_DIR)/../../.. |
| 29 |
|
| 30 |
FRAMAC_INTERNAL ?=no |
| 31 |
|
| 32 |
ifndef MAKECONFIG_DIR |
| 33 |
MAKECONFIG_DIR :=$(FRAMAC_SHARE) |
| 34 |
endif |
| 35 |
|
| 36 |
#Add required packages to merlin |
| 37 |
MERLIN_PACKAGES+=$(PLUGIN_REQUIRES) |
| 38 |
|
| 39 |
#Do not generate documentation for this. |
| 40 |
PLUGIN_UNDOC:=$(PLUGIN_UNDOC) |
| 41 |
|
| 42 |
ifeq ($(FRAMAC_INTERNAL),yes) |
| 43 |
## The plugin is not compiled from an installed frama-c, ie |
| 44 |
## internal plugin (in src/plugins or added during |
| 45 |
## ./configure with --enable-external) |
| 46 |
PLUGIN_RESET :=yes |
| 47 |
|
| 48 |
else |
| 49 |
|
| 50 |
# The plugin is compiled from an installed frama-c |
| 51 |
PLUGIN_RESET :=no |
| 52 |
include $(MAKECONFIG_DIR)/Makefile.common |
| 53 |
include $(MAKECONFIG_DIR)/Makefile.dynamic_config |
| 54 |
|
| 55 |
tests:: external_tests |
| 56 |
|
| 57 |
ifeq ($(PLUGIN_ENABLE),no) |
| 58 |
tests:: |
| 59 |
doc:: |
| 60 |
else |
| 61 |
|
| 62 |
.PHONY: plugin-doc/$(PLUGIN_NAME) |
| 63 |
ifneq ($(FRAMAC_INTERNAL),yes) |
| 64 |
plugin-doc/$(PLUGIN_NAME): |
| 65 |
if test ! -e $(DOC_DIR)/kernel-doc.ocamldoc; then \ |
| 66 |
echo "Frama-C kernel was not installed with code documentation \ |
| 67 |
support. Cannot compile API documentation. To install it, run 'make doc \ |
| 68 |
install-doc-code' in Frama-C's main directory"; \ |
| 69 |
exit 1; \ |
| 70 |
fi |
| 71 |
$(MKDIR) $($(@:plugin-doc/%=%_DOC_DIR)) |
| 72 |
else |
| 73 |
ifeq ($(FRAMAC_INTERNAL),yes) |
| 74 |
plugin-doc/$(PLUGIN_NAME): |
| 75 |
: |
| 76 |
else |
| 77 |
plugin-doc/$(PLUGIN_NAME): |
| 78 |
$(MKDIR) $($(@:plugin-doc/%=%_DOC_DIR)) |
| 79 |
endif |
| 80 |
endif |
| 81 |
|
| 82 |
doc:: plugin-doc/$(PLUGIN_NAME) $(PLUGIN_NAME)_DOC |
| 83 |
|
| 84 |
clean-doc:: $(PLUGIN_DIR)/$(PLUGIN_NAME)_CLEAN_DOC |
| 85 |
|
| 86 |
ifneq ($(FRAMAC_INTERNAL),yes) |
| 87 |
install-doc-code:: $(PLUGIN_NAME)_INSTALL_DOC |
| 88 |
endif |
| 89 |
|
| 90 |
$(PLUGIN_NAME)_INSTALL_DOC: plugin-doc/$(PLUGIN_NAME) |
| 91 |
$(PRINT_CP) $(patsubst %_INSTALL_DOC,%,$@) Documentation |
| 92 |
$(MKDIR) $(DOC_DIR)/$(@:%_INSTALL_DOC=%) |
| 93 |
$(CP) $(patsubst %,"%",\ |
| 94 |
$(wildcard $($(@:%_INSTALL_DOC=%_DOC_DIR))/*.css \ |
| 95 |
$($(@:%_INSTALL_DOC=%_DOC_DIR))/*.html \ |
| 96 |
$($(@:%_INSTALL_DOC=%_DOC_DIR))/*.png)) \ |
| 97 |
$(DOC_DIR)/$(@:%_INSTALL_DOC=%) |
| 98 |
|
| 99 |
endif #PLUGIN_ENABLE |
| 100 |
endif #FRAMAC_INTERNAL |
| 101 |
|
| 102 |
#Must be defined before section TESTS, because function call in make |
| 103 |
#replace not only $(1) but all the other $(..) |
| 104 |
PLUGIN_LIB_DIR ?= $(PLUGIN_DIR) |
| 105 |
PLUGIN_GUI_LIB_DIR ?= $(PLUGIN_DIR)/gui |
| 106 |
PLUGIN_INSTALL_DIR ?=$(DESTDIR)$(FRAMAC_PLUGINDIR) |
| 107 |
|
| 108 |
ifneq ($(PLUGIN_ENABLE),no) |
| 109 |
######################## TESTS ################# |
| 110 |
.PHONY: $(PLUGIN_NAME)_TESTS plugins_ptests_config |
| 111 |
|
| 112 |
$(eval $(call assert_defined,PLUGIN_LIB_DIR)) |
| 113 |
$(eval $(call assert_defined,FRAMAC_SHARE)) |
| 114 |
$(eval $(call assert_defined,FRAMAC_LIB)) |
| 115 |
|
| 116 |
# Do not generate tests-related rules when PLUGIN_NO_TEST is set to 'no' but |
| 117 |
# there is no 'tests' directory. Typically useful for plugins released without |
| 118 |
# their tests. |
| 119 |
HAS_TESTS_DIR:=$(shell if test \! -d $(PLUGIN_DIR)/tests; then echo KO; fi) |
| 120 |
|
| 121 |
ifneq (,$(HAS_TESTS_DIR)$(PLUGIN_INTERNAL_TEST)$(PLUGIN_NO_TEST)) |
| 122 |
$(PLUGIN_NAME)_TESTS: |
| 123 |
|
| 124 |
else |
| 125 |
PTESTS_DEP:=$(PLUGIN_DIR)/Makefile $(FRAMAC_SHARE)/Makefile.dynamic |
| 126 |
|
| 127 |
plugins_ptests_config: $(PLUGIN_DIR)/tests/ptests_config |
| 128 |
|
| 129 |
define TESTS_template |
| 130 |
$(PLUGIN_DIR)/tests/ptests_config: $(PTESTS_DEP) |
| 131 |
$(PRINT_MAKING) $$@ |
| 132 |
$(MKDIR) tests |
| 133 |
$(RM) $$@ |
| 134 |
$(ECHO) "DEFAULT_SUITES=" $(PLUGIN_TESTS_DIRS) > $$@ |
| 135 |
$(ECHO) "TOPLEVEL_PATH=$(FRAMAC_OPT)" >> $$@; |
| 136 |
$(ECHO) "FRAMAC_SHARE=$(FRAMAC_SHARE)" >> $$@ |
| 137 |
$(ECHO) "FRAMAC_LIB=$(FRAMAC_LIB)" >> $$@ |
| 138 |
if test "$(FRAMAC_INTERNAL)" = "no"; then \ |
| 139 |
$(ECHO) "FRAMAC_PLUGIN=$(realpath $(PLUGIN_LIB_DIR)):$(PLUGIN_INSTALL_DIR)" >> $$@; \ |
| 140 |
$(ECHO) "FRAMAC_PLUGIN_GUI=$(realpath $(PLUGIN_GUI_LIB_DIR)):$(PLUGIN_INSTALL_DIR)/gui" >> $$@; \ |
| 141 |
$(ECHO) "OCAMLFIND_IGNORE_DUPS_IN=$(PLUGIN_INSTALL_DIR)" >> $$@; \ |
| 142 |
else \ |
| 143 |
$(ECHO) "FRAMAC_PLUGIN=$(realpath $(PLUGIN_LIB_DIR))" >> $$@; \ |
| 144 |
$(ECHO) "FRAMAC_PLUGIN_GUI=$(realpath $(PLUGIN_GUI_LIB_DIR))" >> $$@; \ |
| 145 |
fi |
| 146 |
$(ECHO) "OCAMLRUNPARAM=" >> $$@ |
| 147 |
$(CHMOD_RO) $$@ |
| 148 |
|
| 149 |
# OCAMLFIND_IGNORE_DUPS_IN in external mode allows to ignore a previous |
| 150 |
# installation of the currently tested plugin. |
| 151 |
|
| 152 |
# $(PLUGIN_NAME)_DEFAULT_TESTS allows plugins to define rules that at |
| 153 |
# the same time depend on $(PLUGIN_NAME)_DEFAULT_TESTS and |
| 154 |
# $(PLUGIN_NAME)_TESTS depend on them |
| 155 |
|
| 156 |
.PHONY: $(PLUGIN_NAME)_DEFAULT_TESTS |
| 157 |
|
| 158 |
$(PLUGIN_NAME)_DEFAULT_TESTS: $$(TARGETS) $$(TARGETS_TOP) $$(TARGETS_GUI) $(PLUGIN_DIR)/tests/ptests_config |
| 159 |
$(PRINT) TESTING PLUG-IN $(PLUGIN_NAME) |
| 160 |
cd $(PLUGIN_DIR) && \ |
| 161 |
time -p $(PTESTS) $$(PTESTS_OPTS) $(PLUGIN_PTESTS_OPTS) |
| 162 |
|
| 163 |
$(PLUGIN_NAME)_TESTS: $(PLUGIN_NAME)_DEFAULT_TESTS |
| 164 |
|
| 165 |
endef |
| 166 |
$(eval $(call TESTS_template)) |
| 167 |
|
| 168 |
external_tests: $(PLUGIN_NAME)_TESTS |
| 169 |
|
| 170 |
endif |
| 171 |
endif # PLUGIN_ENABLE |
| 172 |
################################################ |
| 173 |
|
| 174 |
PLUGIN_FLAGS:=$(FLAGS) $(DEBUG) $(FRAMAC_INCLUDES) |
| 175 |
PLUGIN_BFLAGS:=$(PLUGIN_FLAGS) $(PLUGIN_BFLAGS) |
| 176 |
PLUGIN_OFLAGS:=$(PLUGIN_FLAGS) $(PLUGIN_OFLAGS) |
| 177 |
ifeq ($(FRAMAC_INTERNAL),yes) |
| 178 |
PLUGIN_DEPFLAGS:=$(PLUGIN_DEPFLAGS) |
| 179 |
else |
| 180 |
PLUGIN_DEPFLAGS:=$(FRAMAC_INCLUDES) $(PLUGIN_DEPFLAGS) |
| 181 |
PLUGIN_DOC_DIR:=$(PLUGIN_DIR)/doc/code |
| 182 |
endif |
| 183 |
# For plugins that depends on the API of other ones, we need to add the |
| 184 |
# directory where the plugins' .cmi are compiled |
| 185 |
PLUGIN_DOCFLAGS:=\ |
| 186 |
$(FRAMAC_INCLUDES) -I $(FRAMAC_COMPILED_PLUGINDIR) $(PLUGIN_DOCFLAGS) |
| 187 |
|
| 188 |
$(eval $(call include_generic_plugin_Makefile,$(PLUGIN_NAME))) |
| 189 |
|
| 190 |
TARGETS := $(TARGET_META) $(TARGET_CMI) |
| 191 |
TARGETS_TOP := $(TARGET_TOP_CMO) $(TARGET_TOP_CMX) \ |
| 192 |
$(TARGET_TOP_CMA) $(TARGET_TOP_CMXS) $(TARGET_TOP_O) |
| 193 |
TARGETS_GUI_BYTE := $(TARGET_GUI_CMI) $(TARGET_GUI_CMO) |
| 194 |
TARGETS_GUI := $(TARGETS_GUI_BYTE) $(TARGET_GUI_CMX) $(TARGET_GUI_CMXS) $(TARGET_GUI_O) |
| 195 |
TARGETS_BYTE:= $(TARGET_META) $(TARGET_CMI) $(TARGET_TOP_CMO) $(TARGET_TOP_CMA) |
| 196 |
TARGETS_OPT:= $(TARGET_META) $(TARGET_CMI) $(TARGET_TOP_CMX) $(TARGET_TOP_CMXS) $(TARGET_TOP_O) |
| 197 |
|
| 198 |
byte:: $(TARGETS_BYTE) |
| 199 |
opt:: $(TARGETS_OPT) |
| 200 |
gui-byte:: $(TARGETS_GUI_BYTE) |
| 201 |
gui-opt:: $(TARGETS_GUI) |
| 202 |
|
| 203 |
# do not define additional targets if you come from the Frama-C Makefile |
| 204 |
ifneq ($(FRAMAC_INTERNAL),yes) |
| 205 |
|
| 206 |
################### |
| 207 |
# Clean & Install # |
| 208 |
################### |
| 209 |
|
| 210 |
.PHONY: tests all install uninstall clean depend |
| 211 |
|
| 212 |
dist-clean distclean: $(PLUGIN_DIR)/$(PLUGIN_NAME)_DIST_CLEAN |
| 213 |
|
| 214 |
all:: $(PLUGIN_DIR)/.depend byte $(OCAMLBEST) gui plugins_ptests_config |
| 215 |
|
| 216 |
gui: gui-$(OCAMLBEST) |
| 217 |
|
| 218 |
ifneq ($(PLUGIN_ENABLE),no) |
| 219 |
|
| 220 |
install:: |
| 221 |
$(PRINT_CP) $(PLUGIN_INSTALL_DIR) |
| 222 |
$(MKDIR) $(PLUGIN_INSTALL_DIR)/top |
| 223 |
$(CP) $(TARGETS) $(PLUGIN_INSTALL_DIR) |
| 224 |
$(CP) $(TARGETS_TOP) $(PLUGIN_INSTALL_DIR)/top |
| 225 |
$(PRINT_CP) $(BINDIR) |
| 226 |
if [ -f frama-c-$(PLUGIN_NAME).byte$(EXE) ]; then \ |
| 227 |
$(CP) frama-c-$(PLUGIN_NAME).byte$(EXE) $(BINDIR); \ |
| 228 |
fi |
| 229 |
if [ -f frama-c-$(PLUGIN_NAME).$(OCAMLBEST)$(EXE) ]; then \ |
| 230 |
$(CP) frama-c-$(PLUGIN_NAME).$(OCAMLBEST)$(EXE) \ |
| 231 |
$(BINDIR)/frama-c-$(PLUGIN_NAME)$(EXE); \ |
| 232 |
fi |
| 233 |
ifeq ($(HAS_GUI),yes) |
| 234 |
$(PRINT_CP) $(PLUGIN_INSTALL_DIR)/gui |
| 235 |
$(MKDIR) $(PLUGIN_INSTALL_DIR)/gui |
| 236 |
$(CP) $(TARGETS_GUI) $(PLUGIN_INSTALL_DIR)/gui |
| 237 |
endif |
| 238 |
|
| 239 |
uninstall:: |
| 240 |
$(PRINT_RM) installed $(PLUGIN_NAME) |
| 241 |
$(RM) $(PLUGIN_INSTALL_DIR)/META.$(PLUGIN_PKG) |
| 242 |
$(RM) $(PLUGIN_INSTALL_DIR)/$(PLUGIN_NAME).* |
| 243 |
$(RM) $(BINDIR)/frama-c-$(PLUGIN_NAME).* |
| 244 |
ifeq ($(HAS_GUI),yes) |
| 245 |
$(RM) $(PLUGIN_INSTALL_DIR)/gui/$(PLUGIN_NAME).* |
| 246 |
endif |
| 247 |
endif # PLUGIN_ENABLE <> no |
| 248 |
|
| 249 |
########## |
| 250 |
# Merlin # |
| 251 |
########## |
| 252 |
|
| 253 |
.PHONY: create_merlin |
| 254 |
create_merlin: |
| 255 |
#create Merlin file for external plug-in |
| 256 |
$(PRINT_MAKING) .merlin |
| 257 |
echo "FLG -c $(FLAGS) $(FRAMAC_USER_MERLIN_FLAGS)" > .merlin |
| 258 |
echo "B $(FRAMAC_LIBDIR)" >> .merlin |
| 259 |
echo "B $(FRAMAC_LIBDIR)/plugins" >> .merlin |
| 260 |
echo "B $(FRAMAC_LIBDIR)/plugins/gui" >> .merlin |
| 261 |
for PKG in $(LIBRARY_NAMES); do echo PKG $$PKG >> .merlin; done |
| 262 |
for PKG in $(LIBRARY_NAMES_GUI); do echo PKG $$PKG >> .merlin; done |
| 263 |
for PKG in $(MERLIN_PACKAGES); do echo PKG $$PKG >> .merlin; done |
| 264 |
for DIR in $(patsubst %/,%,$(sort $(dir $(PLUGIN_ML_SRC) $(PLUGIN_TESTS_LIB)))); do echo S $$DIR>> .merlin; echo B $$DIR >> .merlin; done |
| 265 |
|
| 266 |
# To allow completion of .merlin file |
| 267 |
.PHONY: merlin |
| 268 |
merlin:: create_merlin |
| 269 |
|
| 270 |
.merlin: merlin |
| 271 |
|
| 272 |
############ |
| 273 |
# Cleaning # |
| 274 |
############ |
| 275 |
|
| 276 |
clean:: $(PLUGIN_DIR)/$(PLUGIN_NAME)_CLEAN; |
| 277 |
|
| 278 |
################ |
| 279 |
# Generic part # |
| 280 |
################ |
| 281 |
|
| 282 |
include $(MAKECONFIG_DIR)/Makefile.generic |
| 283 |
|
| 284 |
endif # FRAMAC_INTERNAL <> yes |
| 285 |
|
| 286 |
PLUGIN_PTESTS_OPTS:= |
| 287 |
|
| 288 |
############################################################################### |
| 289 |
# Local Variables: |
| 290 |
# mode: makefile |
| 291 |
# End: |