erlang.mk 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832
  1. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  2. #
  3. # Permission to use, copy, modify, and/or distribute this software for any
  4. # purpose with or without fee is hereby granted, provided that the above
  5. # copyright notice and this permission notice appear in all copies.
  6. #
  7. # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  8. # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  9. # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  10. # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  11. # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  12. # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  13. # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  14. .PHONY: all deps app rel docs tests clean distclean help
  15. ERLANG_MK_VERSION = 1
  16. # Core configuration.
  17. PROJECT ?= $(notdir $(CURDIR))
  18. PROJECT := $(strip $(PROJECT))
  19. # Verbosity.
  20. V ?= 0
  21. gen_verbose_0 = @echo " GEN " $@;
  22. gen_verbose = $(gen_verbose_$(V))
  23. # Core targets.
  24. all:: deps app rel
  25. clean::
  26. $(gen_verbose) rm -f erl_crash.dump
  27. distclean:: clean
  28. help::
  29. @printf "%s\n" \
  30. "erlang.mk (version $(ERLANG_MK_VERSION)) is distributed under the terms of the ISC License." \
  31. "Copyright (c) 2013-2014 Loïc Hoguin <essen@ninenines.eu>" \
  32. "" \
  33. "Usage: [V=1] make [target]" \
  34. "" \
  35. "Core targets:" \
  36. " all Run deps, app and rel targets in that order" \
  37. " deps Fetch dependencies (if needed) and compile them" \
  38. " app Compile the project" \
  39. " rel Build a release for this project, if applicable" \
  40. " docs Build the documentation for this project" \
  41. " tests Run the tests for this project" \
  42. " clean Delete temporary and output files from most targets" \
  43. " distclean Delete all temporary and output files" \
  44. " help Display this help and exit" \
  45. "" \
  46. "The target clean only removes files that are commonly removed." \
  47. "Dependencies and releases are left untouched." \
  48. "" \
  49. "Setting V=1 when calling make enables verbose mode."
  50. # Core functions.
  51. ifeq ($(shell which wget 2>/dev/null | wc -l), 1)
  52. define core_http_get
  53. wget --no-check-certificate -O $(1) $(2)|| rm $(1)
  54. endef
  55. else
  56. define core_http_get
  57. erl -noshell -eval 'ssl:start(), inets:start(), case httpc:request(get, {"$(2)", []}, [{autoredirect, true}], []) of {ok, {{_, 200, _}, _, Body}} -> case file:write_file("$(1)", Body) of ok -> ok; {error, R1} -> halt(R1) end; {error, R2} -> halt(R2) end, halt(0).'
  58. endef
  59. endif
  60. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  61. # This file is part of erlang.mk and subject to the terms of the ISC License.
  62. .PHONY: distclean-deps distclean-pkg pkg-list pkg-search
  63. # Configuration.
  64. DEPS_DIR ?= $(CURDIR)/deps
  65. export DEPS_DIR
  66. REBAR_DEPS_DIR = $(DEPS_DIR)
  67. export REBAR_DEPS_DIR
  68. ALL_DEPS_DIRS = $(addprefix $(DEPS_DIR)/,$(DEPS))
  69. ifeq ($(filter $(DEPS_DIR),$(subst :, ,$(ERL_LIBS))),)
  70. ifeq ($(ERL_LIBS),)
  71. ERL_LIBS = $(DEPS_DIR)
  72. else
  73. ERL_LIBS := $(ERL_LIBS):$(DEPS_DIR)
  74. endif
  75. endif
  76. export ERL_LIBS
  77. PKG_FILE2 ?= $(CURDIR)/.erlang.mk.packages.v2
  78. export PKG_FILE2
  79. PKG_FILE_URL ?= https://raw.githubusercontent.com/ninenines/erlang.mk/master/packages.v2.tsv
  80. # Core targets.
  81. deps:: $(ALL_DEPS_DIRS)
  82. @for dep in $(ALL_DEPS_DIRS) ; do \
  83. if [ -f $$dep/GNUmakefile ] || [ -f $$dep/makefile ] || [ -f $$dep/Makefile ] ; then \
  84. $(MAKE) -C $$dep ; \
  85. else \
  86. echo "include $(CURDIR)/erlang.mk" | ERLC_OPTS=+debug_info $(MAKE) -f - -C $$dep ; \
  87. fi ; \
  88. done
  89. distclean:: distclean-deps distclean-pkg
  90. # Deps related targets.
  91. define dep_fetch
  92. if [ "$$$$VS" = "git" ]; then \
  93. git clone -n -- $$$$REPO $(DEPS_DIR)/$(1); \
  94. cd $(DEPS_DIR)/$(1) && git checkout -q $$$$COMMIT; \
  95. elif [ "$$$$VS" = "hg" ]; then \
  96. hg clone -U $$$$REPO $(DEPS_DIR)/$(1); \
  97. cd $(DEPS_DIR)/$(1) && hg update -q $$$$COMMIT; \
  98. else \
  99. echo "Unknown or invalid dependency: $(1). Please consult the erlang.mk README for instructions." >&2; \
  100. exit 78; \
  101. fi
  102. endef
  103. define dep_target
  104. $(DEPS_DIR)/$(1):
  105. @mkdir -p $(DEPS_DIR)
  106. ifeq (,$(dep_$(1)))
  107. @if [ ! -f $(PKG_FILE2) ]; then $(call core_http_get,$(PKG_FILE2),$(PKG_FILE_URL)); fi
  108. @DEPPKG=$$$$(awk 'BEGIN { FS = "\t" }; $$$$1 == "$(1)" { print $$$$2 " " $$$$3 " " $$$$4 }' $(PKG_FILE2);); \
  109. VS=$$$$(echo $$$$DEPPKG | cut -d " " -f1); \
  110. REPO=$$$$(echo $$$$DEPPKG | cut -d " " -f2); \
  111. COMMIT=$$$$(echo $$$$DEPPKG | cut -d " " -f3); \
  112. $(call dep_fetch,$(1))
  113. else
  114. @VS=$(word 1,$(dep_$(1))); \
  115. REPO=$(word 2,$(dep_$(1))); \
  116. COMMIT=$(word 3,$(dep_$(1))); \
  117. $(call dep_fetch,$(1))
  118. endif
  119. endef
  120. $(foreach dep,$(DEPS),$(eval $(call dep_target,$(dep))))
  121. distclean-deps:
  122. $(gen_verbose) rm -rf $(DEPS_DIR)
  123. # Packages related targets.
  124. $(PKG_FILE2):
  125. @$(call core_http_get,$(PKG_FILE2),$(PKG_FILE_URL))
  126. pkg-list: $(PKG_FILE2)
  127. @cat $(PKG_FILE2) | awk 'BEGIN { FS = "\t" }; { print \
  128. "Name:\t\t" $$1 "\n" \
  129. "Repository:\t" $$3 "\n" \
  130. "Website:\t" $$5 "\n" \
  131. "Description:\t" $$6 "\n" }'
  132. ifdef q
  133. pkg-search: $(PKG_FILE2)
  134. @cat $(PKG_FILE2) | grep -i ${q} | awk 'BEGIN { FS = "\t" }; { print \
  135. "Name:\t\t" $$1 "\n" \
  136. "Repository:\t" $$3 "\n" \
  137. "Website:\t" $$5 "\n" \
  138. "Description:\t" $$6 "\n" }'
  139. else
  140. pkg-search:
  141. $(error Usage: make pkg-search q=STRING)
  142. endif
  143. ifeq ($(PKG_FILE2),$(CURDIR)/.erlang.mk.packages.v2)
  144. distclean-pkg:
  145. $(gen_verbose) rm -f $(PKG_FILE2)
  146. endif
  147. help::
  148. @printf "%s\n" "" \
  149. "Package-related targets:" \
  150. " pkg-list List all known packages" \
  151. " pkg-search q=STRING Search for STRING in the package index"
  152. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  153. # This file is part of erlang.mk and subject to the terms of the ISC License.
  154. .PHONY: clean-app
  155. # Configuration.
  156. ERLC_OPTS ?= -Werror +debug_info +warn_export_all +warn_export_vars \
  157. +warn_shadow_vars +warn_obsolete_guard # +bin_opt_info +warn_missing_spec
  158. COMPILE_FIRST ?=
  159. COMPILE_FIRST_PATHS = $(addprefix src/,$(addsuffix .erl,$(COMPILE_FIRST)))
  160. ERLC_EXCLUDE ?=
  161. ERLC_EXCLUDE_PATHS = $(addprefix src/,$(addsuffix .erl,$(ERLC_EXCLUDE)))
  162. # Verbosity.
  163. appsrc_verbose_0 = @echo " APP " $(PROJECT).app.src;
  164. appsrc_verbose = $(appsrc_verbose_$(V))
  165. erlc_verbose_0 = @echo " ERLC " $(filter-out $(patsubst %,%.erl,$(ERLC_EXCLUDE)),\
  166. $(filter %.erl %.core,$(?F)));
  167. erlc_verbose = $(erlc_verbose_$(V))
  168. xyrl_verbose_0 = @echo " XYRL " $(filter %.xrl %.yrl,$(?F));
  169. xyrl_verbose = $(xyrl_verbose_$(V))
  170. # Core targets.
  171. app:: erlc-include ebin/$(PROJECT).app
  172. $(eval MODULES := $(shell find ebin -type f -name \*.beam \
  173. | sed "s/ebin\//'/;s/\.beam/',/" | sed '$$s/.$$//'))
  174. @if [ -z "$$(grep -E '^[^%]*{modules,' src/$(PROJECT).app.src)" ]; then \
  175. echo "Empty modules entry not found in $(PROJECT).app.src. Please consult the erlang.mk README for instructions." >&2; \
  176. exit 1; \
  177. fi
  178. $(eval GITDESCRIBE := $(shell git describe --dirty --abbrev=7 --tags --always --first-parent 2>/dev/null || true))
  179. $(appsrc_verbose) cat src/$(PROJECT).app.src \
  180. | sed "s/{modules,[[:space:]]*\[\]}/{modules, \[$(MODULES)\]}/" \
  181. | sed "s/{id,[[:space:]]*\"git\"}/{id, \"$(GITDESCRIBE)\"}/" \
  182. > ebin/$(PROJECT).app
  183. define compile_erl
  184. $(erlc_verbose) erlc -v $(ERLC_OPTS) -o ebin/ \
  185. -pa ebin/ -I include/ $(filter-out $(ERLC_EXCLUDE_PATHS),\
  186. $(COMPILE_FIRST_PATHS) $(1))
  187. endef
  188. define compile_xyrl
  189. $(xyrl_verbose) erlc -v -o ebin/ $(1)
  190. $(xyrl_verbose) erlc $(ERLC_OPTS) -o ebin/ ebin/*.erl
  191. @rm ebin/*.erl
  192. endef
  193. ifneq ($(wildcard src/),)
  194. ebin/$(PROJECT).app::
  195. @mkdir -p ebin/
  196. ebin/$(PROJECT).app:: $(shell find src -type f -name \*.erl) \
  197. $(shell find src -type f -name \*.core)
  198. $(if $(strip $?),$(call compile_erl,$?))
  199. ebin/$(PROJECT).app:: $(shell find src -type f -name \*.xrl) \
  200. $(shell find src -type f -name \*.yrl)
  201. $(if $(strip $?),$(call compile_xyrl,$?))
  202. endif
  203. clean:: clean-app
  204. # Extra targets.
  205. erlc-include:
  206. -@if [ -d ebin/ ]; then \
  207. find include/ src/ -type f -name \*.hrl -newer ebin -exec touch $(shell find src/ -type f -name "*.erl") \; 2>/dev/null || printf ''; \
  208. fi
  209. clean-app:
  210. $(gen_verbose) rm -rf ebin/
  211. # Copyright (c) 2014, Loïc Hoguin <essen@ninenines.eu>
  212. # This file is part of erlang.mk and subject to the terms of the ISC License.
  213. .PHONY: bootstrap bootstrap-lib bootstrap-rel new list-templates
  214. # Core targets.
  215. help::
  216. @printf "%s\n" "" \
  217. "Bootstrap targets:" \
  218. " bootstrap Generate a skeleton of an OTP application" \
  219. " bootstrap-lib Generate a skeleton of an OTP library" \
  220. " bootstrap-rel Generate the files needed to build a release" \
  221. " new t=TPL n=NAME Generate a module NAME based on the template TPL" \
  222. " list-templates List available templates"
  223. # Bootstrap templates.
  224. bs_appsrc = "{application, $(PROJECT), [" \
  225. " {description, \"\"}," \
  226. " {vsn, \"0.1.0\"}," \
  227. " {id, \"git\"}," \
  228. " {modules, []}," \
  229. " {registered, []}," \
  230. " {applications, [" \
  231. " kernel," \
  232. " stdlib" \
  233. " ]}," \
  234. " {mod, {$(PROJECT)_app, []}}," \
  235. " {env, []}" \
  236. "]}."
  237. bs_appsrc_lib = "{application, $(PROJECT), [" \
  238. " {description, \"\"}," \
  239. " {vsn, \"0.1.0\"}," \
  240. " {id, \"git\"}," \
  241. " {modules, []}," \
  242. " {registered, []}," \
  243. " {applications, [" \
  244. " kernel," \
  245. " stdlib" \
  246. " ]}" \
  247. "]}."
  248. bs_Makefile = "PROJECT = $(PROJECT)" \
  249. "include erlang.mk"
  250. bs_app = "-module($(PROJECT)_app)." \
  251. "-behaviour(application)." \
  252. "" \
  253. "-export([start/2])." \
  254. "-export([stop/1])." \
  255. "" \
  256. "start(_Type, _Args) ->" \
  257. " $(PROJECT)_sup:start_link()." \
  258. "" \
  259. "stop(_State) ->" \
  260. " ok."
  261. bs_relx_config = "{release, {$(PROJECT)_release, \"1\"}, [$(PROJECT)]}." \
  262. "{extended_start_script, true}." \
  263. "{sys_config, \"rel/sys.config\"}." \
  264. "{vm_args, \"rel/vm.args\"}."
  265. bs_sys_config = "[" \
  266. "]."
  267. bs_vm_args = "-name $(PROJECT)@127.0.0.1" \
  268. "-setcookie $(PROJECT)" \
  269. "-heart"
  270. # Normal templates.
  271. tpl_supervisor = "-module($(n))." \
  272. "-behaviour(supervisor)." \
  273. "" \
  274. "-export([start_link/0])." \
  275. "-export([init/1])." \
  276. "" \
  277. "start_link() ->" \
  278. " supervisor:start_link({local, ?MODULE}, ?MODULE, [])." \
  279. "" \
  280. "init([]) ->" \
  281. " Procs = []," \
  282. " {ok, {{one_for_one, 1, 5}, Procs}}."
  283. tpl_gen_server = "-module($(n))." \
  284. "-behaviour(gen_server)." \
  285. "" \
  286. "%% API." \
  287. "-export([start_link/0])." \
  288. "" \
  289. "%% gen_server." \
  290. "-export([init/1])." \
  291. "-export([handle_call/3])." \
  292. "-export([handle_cast/2])." \
  293. "-export([handle_info/2])." \
  294. "-export([terminate/2])." \
  295. "-export([code_change/3])." \
  296. "" \
  297. "-record(state, {" \
  298. "})." \
  299. "" \
  300. "%% API." \
  301. "" \
  302. "-spec start_link() -> {ok, pid()}." \
  303. "start_link() ->" \
  304. " gen_server:start_link(?MODULE, [], [])." \
  305. "" \
  306. "%% gen_server." \
  307. "" \
  308. "init([]) ->" \
  309. " {ok, \#state{}}." \
  310. "" \
  311. "handle_call(_Request, _From, State) ->" \
  312. " {reply, ignored, State}." \
  313. "" \
  314. "handle_cast(_Msg, State) ->" \
  315. " {noreply, State}." \
  316. "" \
  317. "handle_info(_Info, State) ->" \
  318. " {noreply, State}." \
  319. "" \
  320. "terminate(_Reason, _State) ->" \
  321. " ok." \
  322. "" \
  323. "code_change(_OldVsn, State, _Extra) ->" \
  324. " {ok, State}."
  325. tpl_cowboy_http = "-module($(n))." \
  326. "-behaviour(cowboy_http_handler)." \
  327. "" \
  328. "-export([init/3])." \
  329. "-export([handle/2])." \
  330. "-export([terminate/3])." \
  331. "" \
  332. "-record(state, {" \
  333. "})." \
  334. "" \
  335. "init(_, Req, _Opts) ->" \
  336. " {ok, Req, \#state{}}." \
  337. "" \
  338. "handle(Req, State=\#state{}) ->" \
  339. " {ok, Req2} = cowboy_req:reply(200, Req)," \
  340. " {ok, Req2, State}." \
  341. "" \
  342. "terminate(_Reason, _Req, _State) ->" \
  343. " ok."
  344. tpl_cowboy_loop = "-module($(n))." \
  345. "-behaviour(cowboy_loop_handler)." \
  346. "" \
  347. "-export([init/3])." \
  348. "-export([info/3])." \
  349. "-export([terminate/3])." \
  350. "" \
  351. "-record(state, {" \
  352. "})." \
  353. "" \
  354. "init(_, Req, _Opts) ->" \
  355. " {loop, Req, \#state{}, 5000, hibernate}." \
  356. "" \
  357. "info(_Info, Req, State) ->" \
  358. " {loop, Req, State, hibernate}." \
  359. "" \
  360. "terminate(_Reason, _Req, _State) ->" \
  361. " ok."
  362. tpl_cowboy_rest = "-module($(n))." \
  363. "" \
  364. "-export([init/3])." \
  365. "-export([content_types_provided/2])." \
  366. "-export([get_html/2])." \
  367. "" \
  368. "init(_, _Req, _Opts) ->" \
  369. " {upgrade, protocol, cowboy_rest}." \
  370. "" \
  371. "content_types_provided(Req, State) ->" \
  372. " {[{{<<\"text\">>, <<\"html\">>, '*'}, get_html}], Req, State}." \
  373. "" \
  374. "get_html(Req, State) ->" \
  375. " {<<\"<html><body>This is REST!</body></html>\">>, Req, State}."
  376. tpl_cowboy_ws = "-module($(n))." \
  377. "-behaviour(cowboy_websocket_handler)." \
  378. "" \
  379. "-export([init/3])." \
  380. "-export([websocket_init/3])." \
  381. "-export([websocket_handle/3])." \
  382. "-export([websocket_info/3])." \
  383. "-export([websocket_terminate/3])." \
  384. "" \
  385. "-record(state, {" \
  386. "})." \
  387. "" \
  388. "init(_, _, _) ->" \
  389. " {upgrade, protocol, cowboy_websocket}." \
  390. "" \
  391. "websocket_init(_, Req, _Opts) ->" \
  392. " Req2 = cowboy_req:compact(Req)," \
  393. " {ok, Req2, \#state{}}." \
  394. "" \
  395. "websocket_handle({text, Data}, Req, State) ->" \
  396. " {reply, {text, Data}, Req, State};" \
  397. "websocket_handle({binary, Data}, Req, State) ->" \
  398. " {reply, {binary, Data}, Req, State};" \
  399. "websocket_handle(_Frame, Req, State) ->" \
  400. " {ok, Req, State}." \
  401. "" \
  402. "websocket_info(_Info, Req, State) ->" \
  403. " {ok, Req, State}." \
  404. "" \
  405. "websocket_terminate(_Reason, _Req, _State) ->" \
  406. " ok."
  407. tpl_ranch_protocol = "-module($(n))." \
  408. "-behaviour(ranch_protocol)." \
  409. "" \
  410. "-export([start_link/4])." \
  411. "-export([init/4])." \
  412. "" \
  413. "-type opts() :: []." \
  414. "-export_type([opts/0])." \
  415. "" \
  416. "-record(state, {" \
  417. " socket :: inet:socket()," \
  418. " transport :: module()" \
  419. "})." \
  420. "" \
  421. "start_link(Ref, Socket, Transport, Opts) ->" \
  422. " Pid = spawn_link(?MODULE, init, [Ref, Socket, Transport, Opts])," \
  423. " {ok, Pid}." \
  424. "" \
  425. "-spec init(ranch:ref(), inet:socket(), module(), opts()) -> ok." \
  426. "init(Ref, Socket, Transport, _Opts) ->" \
  427. " ok = ranch:accept_ack(Ref)," \
  428. " loop(\#state{socket=Socket, transport=Transport})." \
  429. "" \
  430. "loop(State) ->" \
  431. " loop(State)."
  432. # Plugin-specific targets.
  433. bootstrap:
  434. ifneq ($(wildcard src/),)
  435. $(error Error: src/ directory already exists)
  436. endif
  437. @printf "%s\n" $(bs_Makefile) > Makefile
  438. @mkdir src/
  439. @printf "%s\n" $(bs_appsrc) > src/$(PROJECT).app.src
  440. @printf "%s\n" $(bs_app) > src/$(PROJECT)_app.erl
  441. $(eval n := $(PROJECT)_sup)
  442. @printf "%s\n" $(tpl_supervisor) > src/$(PROJECT)_sup.erl
  443. bootstrap-lib:
  444. ifneq ($(wildcard src/),)
  445. $(error Error: src/ directory already exists)
  446. endif
  447. @printf "%s\n" $(bs_Makefile) > Makefile
  448. @mkdir src/
  449. @printf "%s\n" $(bs_appsrc_lib) > src/$(PROJECT).app.src
  450. bootstrap-rel:
  451. ifneq ($(wildcard relx.config),)
  452. $(error Error: relx.config already exists)
  453. endif
  454. ifneq ($(wildcard rel/),)
  455. $(error Error: rel/ directory already exists)
  456. endif
  457. @printf "%s\n" $(bs_relx_config) > relx.config
  458. @mkdir rel/
  459. @printf "%s\n" $(bs_sys_config) > rel/sys.config
  460. @printf "%s\n" $(bs_vm_args) > rel/vm.args
  461. new:
  462. ifeq ($(wildcard src/),)
  463. $(error Error: src/ directory does not exist)
  464. endif
  465. ifndef t
  466. $(error Usage: make new t=TEMPLATE n=NAME)
  467. endif
  468. ifndef tpl_$(t)
  469. $(error Unknown template)
  470. endif
  471. ifndef n
  472. $(error Usage: make new t=TEMPLATE n=NAME)
  473. endif
  474. @printf "%s\n" $(tpl_$(t)) > src/$(n).erl
  475. list-templates:
  476. @echo Available templates: $(sort $(patsubst tpl_%,%,$(filter tpl_%,$(.VARIABLES))))
  477. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  478. # This file is part of erlang.mk and subject to the terms of the ISC License.
  479. .PHONY: build-ct-deps build-ct-suites tests-ct clean-ct distclean-ct
  480. # Configuration.
  481. CT_OPTS ?=
  482. ifneq ($(wildcard test/),)
  483. CT_SUITES ?= $(sort $(subst _SUITE.erl,,$(shell find test -type f -name \*_SUITE.erl -exec basename {} \;)))
  484. else
  485. CT_SUITES ?=
  486. endif
  487. TEST_ERLC_OPTS ?= +debug_info +warn_export_vars +warn_shadow_vars +warn_obsolete_guard
  488. TEST_ERLC_OPTS += -DTEST=1 -DEXTRA=1 +'{parse_transform, eunit_autoexport}'
  489. # Core targets.
  490. tests:: tests-ct
  491. clean:: clean-ct
  492. distclean:: distclean-ct
  493. help::
  494. @printf "%s\n" "" \
  495. "All your common_test suites have their associated targets." \
  496. "A suite named http_SUITE can be ran using the ct-http target."
  497. # Plugin-specific targets.
  498. ALL_TEST_DEPS_DIRS = $(addprefix $(DEPS_DIR)/,$(TEST_DEPS))
  499. CT_RUN = ct_run \
  500. -no_auto_compile \
  501. -noshell \
  502. -pa $(realpath ebin) $(DEPS_DIR)/*/ebin \
  503. -dir test \
  504. -logdir logs
  505. $(foreach dep,$(TEST_DEPS),$(eval $(call dep_target,$(dep))))
  506. build-ct-deps: $(ALL_TEST_DEPS_DIRS)
  507. @for dep in $(ALL_TEST_DEPS_DIRS) ; do $(MAKE) -C $$dep; done
  508. build-ct-suites: build-ct-deps
  509. $(gen_verbose) erlc -v $(TEST_ERLC_OPTS) -I include/ -o test/ \
  510. $(wildcard test/*.erl test/*/*.erl) -pa ebin/
  511. tests-ct: ERLC_OPTS = $(TEST_ERLC_OPTS)
  512. tests-ct: clean deps app build-ct-suites
  513. @if [ -d "test" ] ; \
  514. then \
  515. mkdir -p logs/ ; \
  516. $(CT_RUN) -suite $(addsuffix _SUITE,$(CT_SUITES)) $(CT_OPTS) ; \
  517. fi
  518. $(gen_verbose) rm -f test/*.beam
  519. define ct_suite_target
  520. ct-$(1): ERLC_OPTS = $(TEST_ERLC_OPTS)
  521. ct-$(1): clean deps app build-ct-suites
  522. @if [ -d "test" ] ; \
  523. then \
  524. mkdir -p logs/ ; \
  525. $(CT_RUN) -suite $(addsuffix _SUITE,$(1)) $(CT_OPTS) ; \
  526. fi
  527. $(gen_verbose) rm -f test/*.beam
  528. endef
  529. $(foreach test,$(CT_SUITES),$(eval $(call ct_suite_target,$(test))))
  530. clean-ct:
  531. $(gen_verbose) rm -rf test/*.beam
  532. distclean-ct:
  533. $(gen_verbose) rm -rf logs/
  534. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  535. # This file is part of erlang.mk and subject to the terms of the ISC License.
  536. .PHONY: plt distclean-plt dialyze
  537. # Configuration.
  538. DIALYZER_PLT ?= $(CURDIR)/.$(PROJECT).plt
  539. export DIALYZER_PLT
  540. PLT_APPS ?=
  541. DIALYZER_DIRS ?= --src -r src
  542. DIALYZER_OPTS ?= -Werror_handling -Wrace_conditions \
  543. -Wunmatched_returns # -Wunderspecs
  544. # Core targets.
  545. distclean:: distclean-plt
  546. help::
  547. @printf "%s\n" "" \
  548. "Dialyzer targets:" \
  549. " plt Build a PLT file for this project" \
  550. " dialyze Analyze the project using Dialyzer"
  551. # Plugin-specific targets.
  552. $(DIALYZER_PLT): deps app
  553. @dialyzer --build_plt --apps erts kernel stdlib $(PLT_APPS) $(ALL_DEPS_DIRS)
  554. plt: $(DIALYZER_PLT)
  555. distclean-plt:
  556. $(gen_verbose) rm -f $(DIALYZER_PLT)
  557. ifneq ($(wildcard $(DIALYZER_PLT)),)
  558. dialyze:
  559. else
  560. dialyze: $(DIALYZER_PLT)
  561. endif
  562. @dialyzer --no_native $(DIALYZER_DIRS) $(DIALYZER_OPTS)
  563. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  564. # This file is part of erlang.mk and subject to the terms of the ISC License.
  565. .PHONY: distclean-edoc
  566. # Configuration.
  567. EDOC_OPTS ?=
  568. # Core targets.
  569. docs:: distclean-edoc
  570. $(gen_verbose) erl -noshell \
  571. -eval 'edoc:application($(PROJECT), ".", [$(EDOC_OPTS)]), init:stop().'
  572. distclean:: distclean-edoc
  573. # Plugin-specific targets.
  574. distclean-edoc:
  575. $(gen_verbose) rm -f doc/*.css doc/*.html doc/*.png doc/edoc-info
  576. # Copyright (c) 2014, Juan Facorro <juan@inaka.net>
  577. # This file is part of erlang.mk and subject to the terms of the ISC License.
  578. .PHONY: elvis distclean-elvis
  579. # Configuration.
  580. ELVIS_CONFIG ?= $(CURDIR)/elvis.config
  581. ELVIS ?= $(CURDIR)/elvis
  582. export ELVIS
  583. ELVIS_URL ?= https://github.com/inaka/elvis/releases/download/0.2.3/elvis
  584. ELVIS_CONFIG_URL ?= https://github.com/inaka/elvis/releases/download/0.2.3/elvis.config
  585. ELVIS_OPTS ?=
  586. # Core targets.
  587. help::
  588. @printf "%s\n" "" \
  589. "Elvis targets:" \
  590. " elvis Run Elvis using the local elvis.config or download the default otherwise"
  591. ifneq ($(wildcard $(ELVIS_CONFIG)),)
  592. rel:: distclean-elvis
  593. endif
  594. distclean:: distclean-elvis
  595. # Plugin-specific targets.
  596. $(ELVIS):
  597. @$(call core_http_get,$(ELVIS_CONFIG),$(ELVIS_CONFIG_URL))
  598. @$(call core_http_get,$(ELVIS),$(ELVIS_URL))
  599. @chmod +x $(ELVIS)
  600. elvis: $(ELVIS)
  601. @$(ELVIS) rock -c $(ELVIS_CONFIG) $(ELVIS_OPTS)
  602. distclean-elvis:
  603. $(gen_verbose) rm -rf $(ELVIS)
  604. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  605. # This file is part of erlang.mk and subject to the terms of the ISC License.
  606. # Verbosity.
  607. dtl_verbose_0 = @echo " DTL " $(filter %.dtl,$(?F));
  608. dtl_verbose = $(dtl_verbose_$(V))
  609. # Core targets.
  610. define compile_erlydtl
  611. $(dtl_verbose) erl -noshell -pa ebin/ $(DEPS_DIR)/erlydtl/ebin/ -eval ' \
  612. Compile = fun(F) -> \
  613. Module = list_to_atom( \
  614. string:to_lower(filename:basename(F, ".dtl")) ++ "_dtl"), \
  615. erlydtl:compile(F, Module, [{out_dir, "ebin/"}]) \
  616. end, \
  617. _ = [Compile(F) || F <- string:tokens("$(1)", " ")], \
  618. init:stop()'
  619. endef
  620. ifneq ($(wildcard src/),)
  621. ebin/$(PROJECT).app:: $(shell find templates -type f -name \*.dtl 2>/dev/null)
  622. $(if $(strip $?),$(call compile_erlydtl,$?))
  623. endif
  624. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  625. # This file is part of erlang.mk and subject to the terms of the ISC License.
  626. .PHONY: relx-rel distclean-relx-rel distclean-relx
  627. # Configuration.
  628. RELX_CONFIG ?= $(CURDIR)/relx.config
  629. RELX ?= $(CURDIR)/relx
  630. export RELX
  631. RELX_URL ?= https://github.com/erlware/relx/releases/download/v1.0.2/relx
  632. RELX_OPTS ?=
  633. RELX_OUTPUT_DIR ?= _rel
  634. ifeq ($(firstword $(RELX_OPTS)),-o)
  635. RELX_OUTPUT_DIR = $(word 2,$(RELX_OPTS))
  636. else
  637. RELX_OPTS += -o $(RELX_OUTPUT_DIR)
  638. endif
  639. # Core targets.
  640. ifneq ($(wildcard $(RELX_CONFIG)),)
  641. rel:: distclean-relx-rel relx-rel
  642. endif
  643. distclean:: distclean-relx-rel distclean-relx
  644. # Plugin-specific targets.
  645. define relx_fetch
  646. $(call core_http_get,$(RELX),$(RELX_URL))
  647. chmod +x $(RELX)
  648. endef
  649. $(RELX):
  650. @$(call relx_fetch)
  651. relx-rel: $(RELX)
  652. @$(RELX) -c $(RELX_CONFIG) $(RELX_OPTS)
  653. distclean-relx-rel:
  654. $(gen_verbose) rm -rf $(RELX_OUTPUT_DIR)
  655. distclean-relx:
  656. $(gen_verbose) rm -rf $(RELX)
  657. # Copyright (c) 2014, M Robert Martin <rob@version2beta.com>
  658. # This file is contributed to erlang.mk and subject to the terms of the ISC License.
  659. .PHONY: shell
  660. # Configuration.
  661. SHELL_PATH ?= -pa ../$(PROJECT)/ebin $(DEPS_DIR)/*/ebin
  662. SHELL_OPTS ?=
  663. ALL_SHELL_DEPS_DIRS = $(addprefix $(DEPS_DIR)/,$(SHELL_DEPS))
  664. # Core targets
  665. help::
  666. @printf "%s\n" "" \
  667. "Shell targets:" \
  668. " shell Run an erlang shell with SHELL_OPTS or reasonable default"
  669. # Plugin-specific targets.
  670. $(foreach dep,$(SHELL_DEPS),$(eval $(call dep_target,$(dep))))
  671. build-shell-deps: $(ALL_SHELL_DEPS_DIRS)
  672. @for dep in $(ALL_SHELL_DEPS_DIRS) ; do $(MAKE) -C $$dep ; done
  673. shell: build-shell-deps
  674. $(gen_verbose) erl $(SHELL_PATH) $(SHELL_OPTS)