aboutsummaryrefslogtreecommitdiffhomepage
path: root/maker.org
blob: b2b7ba02b3fecf34168ce3f60755062d94d3c2b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
#+TITLE: sdp (project) makefile
#+AUTHOR: Ralph Amissah
#+EMAIL: ralph.amissah@gmail.com
#+STARTUP: indent content
#+LANGUAGE: en
#+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t ^:nil _:nil -:t f:t *:t <:t
#+OPTIONS: TeX:t LaTeX:t skip:nil d:nil todo:t pri:nil tags:not-in-toc
#+OPTIONS: author:nil email:nil creator:nil timestamp:nil
#+PROPERTY: header-args :padline no :exports code :noweb yes
#+EXPORT_SELECT_TAGS: export
#+EXPORT_EXCLUDE_TAGS: noexport
#+FILETAGS: :sdp:rel:makefile:
#+TAGS: assert(a) class(c) debug(d) mixin(m) sdp(s) tangle(T) template(t) WEB(W) noexport(n)

* sdp makefile                                                     :makefile:
[[./org/sdp.org][sdp.org]]  [[./org/][org/]]
** TODO settings [+2]                                              :settings:
*** alternative D compilers [+1]                                   :compiler:
**** dmd                                                                :dmd:

#+BEGIN_SRC makefile :tangle makefile
DMD=dmd
DMD_FLAGS=-de -w -J./lib
DMD_FLAGS_RELEASE=-O -release
DMD_FLAG_BINOF=-of
#+END_SRC

**** ldc2                                                               :ldc:

#+BEGIN_SRC makefile :tangle makefile
LDC=ldc2
LDC_FLAGS=-w -J=lib
LDC_FLAGS_RELEASE=-O4 -release
LDC_FLAG_BINOF=-of=
#+END_SRC

**** gdc                                                                :gdc:

#+BEGIN_SRC makefile :tangle makefile
GDC=gdc
#GDC=gdc-5
GDC_FLAGS=
GDC_FLAGS_RELEASE=-march=native -O3 -pipe -frelease
#GDC_FLAGS_RELEASE=-frelease
GDC_FLAG_BINOF=-o
#+END_SRC

**** rdmd

#+BEGIN_SRC makefile :tangle makefile
RDMD=rdmd
RDMD_FLAGS=--build-only --compiler=
#+END_SRC

*** TODO set/select: ~D compiler~ & ~debug flags~ [+1] [2/2]   :select:
- [X] Set D_COMPILER (one of DMD LDC or GDC)
- [X] Set debug flags (using DMD standard flag -debug=)

**** SET compiler: "SET_D_COMPILER=":                         :compiler:select:
[[http://wiki.dlang.org/Compilers][D Compilers wiki]]
[[http://dlang.org/download.html][D Compilers download]]
Set D_COMPILER one of DMD, LDC or GDC e.g.: SET_D_COMPILER=DMD

***** TODO [#A] set compiler
#+BEGIN_SRC makefile :tangle makefile
# SET_D_COMPILER=(one of: DMD LDC or GDC):
SET_D_COMPILER=DMD
#+END_SRC

***** +note+

"nice how you can get 2x speedup without a single line of asm just by using ldc", p0nce
"gdc might be worth a shot if your code is compatible", profan
re: dmd "one can easily get 2x (and even more) speedup by simply switching to gdc -O2", ketmar

**** SET debug flags: "SET_DC_FLAGS_DEBUG_EXTRA=-debug=":  :compiler:flags:debug:
Set debug flags using DMD standard flag -debug= e.g.:
  SET_DC_FLAGS_DEBUG_EXTRA=-debug=headings -debug=bookindex
  SET_DC_FLAGS_DEBUG_EXTRA=-debug=headings -debug=footnotes -debug=endnotes

***** TODO [#A] set debug flags
#+BEGIN_SRC makefile :tangle makefile
SET_DC_FLAGS_DEBUG_EXTRA=-debug=dumpdoc
#+END_SRC

***** debug flags

Set debug flags using DMD standard flag -debug= e.g.:
  SET_DC_FLAGS_DEBUG_EXTRA=-debug=dumpdoc
  SET_DC_FLAGS_DEBUG_EXTRA=-debug=headings -debug=bookindex
  SET_DC_FLAGS_DEBUG_EXTRA=-debug=headings -debug=biblio
  SET_DC_FLAGS_DEBUG_EXTRA=-debug=code

  biblio
  biblio_sorted
  bibliosorted
  block
  bookindex
  bookindexmatch
  bookindexraw
  check
  checkdoc
  code
  comment
  dumpdoc                    write out document contents, with object type and ocn
  endnotes
  endnotes_build
  footnotes
  footnotesdone
  group
  header
  header1
  headerjson
  headermakejson
  headermetadatajson
  heading
  headings
  headingsfound
  insert
  munge
  node
  objectrelated1
  objectrelated2
  objects
  ocnoff
  para
  parabullet
  parabulletindent
  paraindent
  paraindenthang
  parent
  poem
  quote
  raw
  source
  srclines
  structattrib
  summary
  table

*** D compiler settings [+1]                              :settings:compiler:
**** compiler settings

#+BEGIN_SRC makefile :tangle makefile
DC=$($(SET_D_COMPILER))
DC_FLAGS=$($(shell echo $(SET_D_COMPILER)_FLAGS))
DC_FLAGS_RELEASE=$($(shell echo $(SET_D_COMPILER)_FLAGS_RELEASE))
DC_FLAG_BINOF=$($(shell echo $(SET_D_COMPILER)_FLAG_BINOF))
DC_FLAGS_DEBUG_DEFAULT_SET=-unittest -debug=checkdoc -debug=summary
DC_FLAGS_DEBUG_SET=\
	$(shell echo $(DC_FLAGS_DEBUG_DEFAULT_SET) $(SET_DC_FLAGS_DEBUG_EXTRA))
#+END_SRC

**** compiler conditional settings (depending on selected D compiler)

#+BEGIN_SRC makefile :tangle makefile
ifeq ($(DC), $(DMD))
	DC_FLAGS_DEBUG :=$(shell echo $(DC_FLAGS_DEBUG_SET))
endif
ifeq ($(DC) ,$(LDC))
	DC_FLAGS_DEBUG :=$(shell echo $(DC_FLAGS_DEBUG_SET)| sed -e "s/-debug=/-d-debug=/g")
endif
ifeq ($(DC), $(GDC))
	DC_FLAGS_DEBUG :=$(shell echo $(DC_FLAGS_DEBUG_SET)| sed -e "s/-debug/-fdebug/g")
endif
#+END_SRC

*** Project Details                                             :project:sdp:

#+BEGIN_SRC makefile :tangle makefile
PRG_NAME=sdp
PRG_SRC=$(PRG_NAME).d
PRG_SRCDIR=./lib
PRG_BIN=$(PRG_NAME)
PRG_BINDIR=./bin
#+END_SRC

*** Emacs Org settings                            :settings:emacs:org:tangle:

#+BEGIN_SRC makefile :tangle makefile
# ORG
ORG_VERSION=20160411
EMACSLISP=/usr/share/emacs/site-lisp
EMACSLISP_ORG=~/.emacs.d/elpa/org-$($(shell echo $(ORG_VERSION)))
EMACSLISP_ORG_CONTRIB=~/.emacs.d/elpa/org-plus-contrib-$($(shell echo $(ORG_VERSION)))
ORGFILELIST=$(shell echo `ls -1 maker.org org/*.org`)
ORGFILES=""
ORGDIR=$(shell echo `pwd`)
#+END_SRC

** "make" commands [+2]                                       :make:commands:
- build commands
  - build
  - debug
  - release
- init, clean, distclean etc.
  - init
  - clean
  - expunge
  - distclean
  - distclean_and_init
- org babel tangle
  - tangle
- git snapshot
  - gitsnapshot

*** build commands [+1]                                       :build:compile:
**** build rebuild

#+BEGIN_SRC makefile :tangle makefile
all: tangle build

build: $(PRG_SRCDIR)/$(PRG_SRC)
	$(DC) $(DC_FLAGS) \
	$(DC_FLAG_BINOF)$(PRG_BINDIR)/$(PRG_BIN) \
	$(PRG_SRCDIR)/$(PRG_SRC)

rebuild: $(PRG_SRCDIR)/$(PRG_SRC) $(PRG_BINDIR)/$(PRG_BIN).o clean build

makefile_new:
	make -k tangle_maker
#+END_SRC

**** rdmd build rebuild

#+BEGIN_SRC makefile :tangle makefile
rdmd: $(PRG_SRCDIR)/$(PRG_SRC)
	$(RDMD) $(RDMD_FLAGS)$(DC) $(DC_FLAGS) \
	$(DC_FLAG_BINOF)$(PRG_BINDIR)/$(PRG_BIN) \
	$(PRG_SRCDIR)/$(PRG_NAME)/$(PRG_SRC)
#+END_SRC

**** debug

#+BEGIN_SRC makefile :tangle makefile
debug: $(PRG_SRCDIR)/$(PRG_SRC)
	$(DC) $(DC_FLAGS) $(DC_FLAGS_DEBUG) \
	$(DC_FLAG_BINOF)$(PRG_BINDIR)/$(PRG_BIN) \
	$(PRG_SRCDIR)/$(PRG_SRC)

debug_dmd: $(PRG_SRCDIR)/$(PRG_SRC)
	$(DMD) $(DMD_FLAGS) $(DMD_FLAGS_DEBUG) \
	$(DMD_FLAG_BINOF)$(PRG_BINDIR)/$(PRG_BIN) \
	$(PRG_SRCDIR)/$(PRG_SRC)

debug_ldc: $(PRG_SRCDIR)/$(PRG_SRC)
	$(LDC) $(LDC_FLAGS) $(LDC_FLAGS_DEBUG) \
	$(LDC_FLAG_BINOF)$(PRG_BINDIR)/$(PRG_BIN) \
	$(PRG_SRCDIR)/$(PRG_SRC)

debug_gdc: $(PRG_SRCDIR)/$(PRG_SRC)
	$(GDC) $(GDC_FLAGS) $(GDC_FLAGS_DEBUG) \
	$(GDC_FLAG_BINOF)$(PRG_BINDIR)/$(PRG_BIN) \
	$(PRG_SRCDIR)/$(PRG_SRC)
#+END_SRC

**** debug rdmd

#+BEGIN_SRC makefile :tangle makefile
debug_rdmd: $(PRG_SRCDIR)/$(PRG_SRC)
	$(RDMD) $(RDMD_FLAGS)$(DC) $(DC_FLAGS) $(DC_FLAGS_DEBUG) \
	$(DC_FLAG_BINOF)$(PRG_BINDIR)/$(PRG_BIN) \
	$(PRG_SRCDIR)/$(PRG_NAME)/$(PRG_SRC)

debug_rdmd_dmd: $(PRG_SRCDIR)/$(PRG_SRC)
	$(RDMD) $(RDMD_FLAGS)$(DMD) $(DC_FLAGS) $(DC_FLAGS_DEBUG) \
	$(DC_FLAG_BINOF)$(PRG_BINDIR)/$(PRG_BIN) \
	$(PRG_SRCDIR)/$(PRG_NAME)/$(PRG_SRC)

debug_rdmd_ldc: $(PRG_SRCDIR)/$(PRG_SRC)
	$(RDMD) $(RDMD_FLAGS)$(LDC) $(DC_FLAGS) $(LDC_FLAGS_DEBUG) \
	$(DC_FLAG_BINOF)$(PRG_BINDIR)/$(PRG_BIN) \
	$(PRG_SRCDIR)/$(PRG_NAME)/$(PRG_SRC)

debug_rdmd_gdc: $(PRG_SRCDIR)/$(PRG_SRC)
	$(RDMD) $(RDMD_FLAGS)$(GDC) $(DC_FLAGS) $(GDC_FLAGS_DEBUG) \
	$(DC_FLAG_BINOF)$(PRG_BINDIR)/$(PRG_BIN) \
	$(PRG_SRCDIR)/$(PRG_NAME)/$(PRG_SRC)
#+END_SRC

**** release

#+BEGIN_SRC makefile :tangle makefile
release: distclean tangle $(PRG_SRCDIR)/$(PRG_SRC)
	$(DC) $(DC_FLAGS) $(DC_FLAGS_RELEASE) \
	$(DC_FLAG_BINOF)$(PRG_BINDIR)/$(PRG_BIN) \
	$(PRG_SRCDIR)/$(PRG_SRC)
#+END_SRC

**** release rdmd

#+BEGIN_SRC makefile :tangle makefile
release_rdmd: distclean tangle $(PRG_SRCDIR)/$(PRG_SRC)
	$(RDMD) $(RDMD_FLAGS)$(DC) $(DC_FLAGS) $(DC_FLAGS_RELEASE) \
	$(DC_FLAG_BINOF)$(PRG_BINDIR)/$(PRG_BIN) \
	$(PRG_SRCDIR)/$(PRG_SRC)
#+END_SRC

*** init clean distclean etc.                                         :clean:

#+BEGIN_SRC makefile :tangle makefile
skel:
	mkdir -p $(PRG_SRCDIR)/$(PRG_NAME); \
	mkdir -p $(PRG_BINDIR);

init: skel

clean:
	rm $(PRG_BINDIR)/*

expunge:
	rm -rf $(PRG_BINDIR); \
	rm -rf $(PRG_SRCDIR);

distclean: expunge

distclean_and_init: expunge skel
#+END_SRC

*** Org Babel Tangle batch process command                           :tangle:
**** tangle: org babel tangle *.org
#+BEGIN_SRC makefile :tangle makefile
tangle: skel
	for f in $(ORGFILELIST); do \
		ORGFILES="$$ORGFILES \"$$f\""; \
	done; \
	emacs --batch -Q -q \
	--eval "(progn \
		(add-to-list 'load-path \
			(expand-file-name \"$(EMACSLISP)\")) \
		(add-to-list 'load-path \
			(expand-file-name \"$(EMACSLISP_ORG)\" t)) \
		(add-to-list 'load-path \
			(expand-file-name \"$(EMACSLISP_ORG_CONTRIB)\" t)) \
		(require 'org)(require 'ob)(require 'ob-tangle) \
		(mapc (lambda (file) \
			(find-file (expand-file-name file \"$(ORGDIR)\")) \
				(setq-local org-src-preserve-indentation t) \
			(org-babel-tangle) \
			(kill-buffer)) '($$ORGFILES)))" 2>&1
#+END_SRC

**** tangle maker: org babel tangle maker.org, makefile new
#+BEGIN_SRC makefile :tangle makefile
tangle_maker:
	for f in $(ORGFILELIST); do \
		ORGFILES="\"maker.org\""; \
	done; \
	emacs --batch -Q -q \
	--eval "(progn \
		(add-to-list 'load-path \
			(expand-file-name \"$(EMACSLISP)\")) \
		(add-to-list 'load-path \
			(expand-file-name \"$(EMACSLISP_ORG)\" t)) \
		(add-to-list 'load-path \
			(expand-file-name \"$(EMACSLISP_ORG_CONTRIB)\" t)) \
		(require 'org)(require 'ob)(require 'ob-tangle) \
		(mapc (lambda (file) \
			(find-file (expand-file-name file \".\")) \
				(setq-local org-src-preserve-indentation t) \
			(org-babel-tangle) \
			(kill-buffer)) '($$ORGFILES)))" 2>&1
#+END_SRC

*** Git snapshot

#+BEGIN_SRC makefile :tangle makefile
gitsnapshot: distclean tangle
	git commit -a
#+END_SRC

** phony                                                              :phony:

#+BEGIN_SRC makefile :tangle makefile
.PHONY : all build rebuild debug release \
	clean distclean init \
	tangle gitsnapshot
#+END_SRC

* sh script to batch process emacs org babel tangle     :shell_script:tangle:
  [http://orgmode.org/manual/Batch-execution.html]
creates a shell batch script called "tangle", that will tangle (emacs org
babel tangle) org files in ./org/ to create .d source files in ./lib/sdp/
(similar functionality is contained within the "makefile" created by this
"maker.org" file make tangle)

#+BEGIN_SRC sh :tangle tangle :tangle-mode (identity #o755) :shebang #!/bin/sh
# -*- mode: shell-script -*-
# tangle files with org-mode
DIR=`pwd`
ORGFILES=""
EMACSLISP=/usr/share/emacs/site-lisp
ORG_VERSION=20160411
EMACSLISP_ORG=~/.emacs.d/elpa/org-$($(shell echo $(ORG_VERSION)))
EMACSLISP_ORG_CONTRIB=~/.emacs.d/elpa/org-plus-contrib-$($(shell echo $(ORG_VERSION)))
# wrap each argument in the code required to call tangle on it
for i in $@; do
  ORGFILES="$ORGFILES \"$i\""
done
emacs --batch -Q -q \
--eval "(progn
(add-to-list 'load-path (expand-file-name \"$EMACSLISP\"))
(add-to-list 'load-path (expand-file-name \"$EMACSLISP_ORG\" t))
(add-to-list 'load-path (expand-file-name \"$EMACSLISP_ORG_CONTRIB\" t))
(require 'org)(require 'ob)(require 'ob-tangle)
(mapc (lambda (file)
  (find-file (expand-file-name file \"$DIR\"))
  (setq-local org-src-preserve-indentation t)
  (org-babel-tangle)
  (kill-buffer)) '($ORGFILES)))" 2>&1 #|grep tangled
#+END_SRC