-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkutils.mk
2249 lines (2053 loc) · 80.9 KB
/
mkutils.mk
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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
#! \file ~/mkutils.mk
#! \author Jiří Kučera, <sanczes AT gmail.com>
#! \stamp 2018-09-05 15:52:56 +0200
#! \project mkutils - Makefile Utilities
#! \license MIT
#! \version 0.0.0
#! \brief Makefile utilities.
#
ifndef __mkutils_version__
## ============================================================================
## == 1) System settings ==
## ============================================================================
# mkutils name
__mkutils_name__ := mkutils
# mkutils version
__mkutils_version__ := 0.0.0
##
# Handy constants.
EMPTY :=
SPACE := $(EMPTY) $(EMPTY)
LINE := ---------------------------------------
LINE := $(LINE)$(LINE)-
DLINE := =======================================
DLINE := $(DLINE)$(DLINE)=
[ := (
] := )
. := .
, := ,
define nl =
endef
[a-z] := a b c d e f g h i j k l m n o p q r s t u v w x y z
[A-Z] := A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
##
# Help to specify the location of tools used by mkutils. TOOLS_PREFIX should
# be an absolute path to the tools directory (must ends with `/`),
# TOOLS_EXESUFF specifies the tool's extension (e.g. `.exe`). If TOOLS_PREFIX
# (TOOLS_EXESUFF) is not defined, PREFIX (EXESUFF) are used as default.
TOOLS_PREFIX ?= $(PREFIX)
export TOOLS_PREFIX
TOOLS_EXESUFF ?= $(EXESUFF)
export TOOLS_EXESUFF
##
# Tools. The user has last word here.
TRUE ?= $(TOOLS_PREFIX)true$(TOOLS_EXESUFF)
export TRUE
FALSE ?= $(TOOLS_PREFIX)false$(TOOLS_EXESUFF)
export FALSE
ECHO ?= $(TOOLS_PREFIX)echo$(TOOLS_EXESUFF)
export ECHO
TEST ?= $(TOOLS_PREFIX)test$(TOOLS_EXESUFF)
export TEST
WHICH ?= $(TOOLS_PREFIX)which$(TOOLS_EXESUFF)
export WHICH
PRINTF ?= $(TOOLS_PREFIX)printf$(TOOLS_EXESUFF)
export PRINTF
EXPR ?= $(TOOLS_PREFIX)expr$(TOOLS_EXESUFF)
export EXPR
# Detect if are running under MS Windows
ifneq ($(PATHEXT),)
MSWINDOWS ?= 1
else
MSWINDOWS ?= 0
endif
export MSWINDOWS
# Determine shell quote
ifneq ($(MSWINDOWS),1)
SHQ := '
else
SHQ := "
endif
export SHQ
# Detect if we are running in interactive shell
ifneq ($(MSWINDOWS),1)
ifeq ($(ISATTY),)
$(shell $(TEST) -t 0 >/dev/null 2>&1)
ifeq ($(.SHELLSTATUS),0)
ISATTY := 1
else
ISATTY := 0
endif
export ISATTY
endif
endif
# Set default goal's name
.DEFAULT_GOAL := all
.PHONY: all
## ============================================================================
## == 2) Boolean operations ==
## ============================================================================
##
# Identity $1
# -----------------------------------------------------------------------------
# $1 - value
# -----------------------------------------------------------------------------
# Return $1.
Identity = $(call $(0)_,$(strip $1))
Identity_ = $1
##
# Not $1
# -----------------------------------------------------------------------------
# $1 - value
# -----------------------------------------------------------------------------
# Return true (non-empty value) if $1 is false (empty) and vice versa.
Not = $(call $(0)_,$(strip $1))
Not_ = $(if $1,,X)
## ============================================================================
## == 3) List operations ==
## ============================================================================
##
# Head $1
# -----------------------------------------------------------------------------
# $1 - list
# -----------------------------------------------------------------------------
# Return first element of $1.
Head = $(call $(0)_,$(strip $1))
Head_ = $(firstword $1)
##
# Elem $1 $2
# -----------------------------------------------------------------------------
# $1 - list
# $2 - element position (1 if missing)
# -----------------------------------------------------------------------------
# Return the $2th element of $1 (starting from 1). If $2 is out of range,
# return false. $2 can be omitted; in this case `Elem $1` is an alias for
# `Head $1`.
Elem = $(call $(0)_,$(strip $1),$(strip $2))
Elem_ = $(word $(if $2,$2,1),$1)
##
# Tail $1
# -----------------------------------------------------------------------------
# $1 - list
# -----------------------------------------------------------------------------
# Return the list equal to $1 without first element.
Tail = $(call $(0)_,$(strip $1))
Tail_ = $(wordlist 2,$(words $1),$1)
##
# Slice $1 $2 $3
# -----------------------------------------------------------------------------
# $1 - list
# $2 - from
# $3 - to (optional)
# -----------------------------------------------------------------------------
# Return a sublist of $1 starting from element number $2 and ending by element
# number $3. Both $2 and $3 are included in the returned sublist. If $3 is not
# given, it is treated as the index of the last element of $1. All indexes are
# 1-based. If there is no element between $2 and $3, empty list is returned.
# Note that if $2 == $3 and $2 is in range then there is exactly one element
# in the returned sublist.
Slice = $(call $(0)_,$(strip $1),$(strip $2),$(strip $3))
Slice_ = $(wordlist $2,$(if $3,$3,$(words $1)),$1)
## ============================================================================
## == 4) String services ==
## ============================================================================
__mkutils_translate_temp :=
__mkutils_tolowertab := A,a B,b C,c D,d E,e F,f G,g H,h I,i J,j K,k L,l M,m
__mkutils_tolowertab += N,n O,o P,p Q,q R,r S,s T,t U,u V,v W,w X,x Y,y Z,z
__mkutils_touppertab := a,A b,B c,C d,D e,E f,F g,G h,H i,I j,J k,K l,L m,M
__mkutils_touppertab += n,N o,O p,P q,Q r,R s,S t,T u,U v,V w,W x,X y,Y z,Z
##
# Strlen $1
# -----------------------------------------------------------------------------
# $1 - string
# -----------------------------------------------------------------------------
# Return the length of $1 or report an error.
Strlen = $(call EvalExpr,length "$(strip $1)")
##
# Translate $1 $2
# -----------------------------------------------------------------------------
# $1 - variable name holding the translation table
# $2 - string
# -----------------------------------------------------------------------------
# Translate $2 according to $1. $1 is a name of a variable that holds
# translation table. A translation table is a list of pairs X,Y (the comma
# between X and Y is important). Given a pair X,Y from $1, every occurence of
# X in $2 is substituted by Y.
Translate = $(strip \
$(eval __mkutils_translate_temp := $2) \
$(foreach x,$($(strip $1)),$(call $(0)_,$(subst $(,), ,$x))) \
$(__mkutils_translate_temp) \
)
Translate_ = $(eval \
__mkutils_translate_temp := $(subst \
$(call Elem_,$1,1),$(call Elem_,$1,2),$(__mkutils_translate_temp) \
) \
)
##
# ToLower $1
# -----------------------------------------------------------------------------
# $1 - string
# -----------------------------------------------------------------------------
# Convert all uppercase letters in $1 to lowercase.
ToLower = $(call Translate, __mkutils_tolowertab, $1)
##
# ToUpper $1
# -----------------------------------------------------------------------------
# $1 - string
# -----------------------------------------------------------------------------
# Convert all lowercase letters in $1 to uppercase.
ToUpper = $(call Translate, __mkutils_touppertab, $1)
## ============================================================================
## == 5) Hashing ==
## ============================================================================
##
# MakeMap $1
# -----------------------------------------------------------------------------
# $1 - map name
# -----------------------------------------------------------------------------
# Create a map under the name $1.
MakeMap = $(eval __mkutils_map_$(strip $1)_keys :=)
##
# MapKeys $1
# -----------------------------------------------------------------------------
# $1 - map name
# -----------------------------------------------------------------------------
# Return the list of keys of $1.
MapKeys = $(__mkutils_map_$(strip $1)_keys)
##
# MapSize $1
# -----------------------------------------------------------------------------
# $1 - map name
# -----------------------------------------------------------------------------
# Return the number of items in $1.
MapSize = $(words $(call MapKeys, $1))
##
# KVSetKey $1 $2 $3
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# $3 - value
# -----------------------------------------------------------------------------
# Store $3 to $1 under the $2. Low-level routine.
KVSetKey = $(eval __mkutils_map_$1[$2] := $3)
##
# KVGetKey $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Get the value stored under the key $2 in $1. Low-level routine.
KVGetKey = $(__mkutils_map_$1[$2])
##
# KVHasKey $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Return true if $2 is in $1. Low-level routine.
KVHasKey = $(if $2,$(filter $2,$(call MapKeys, $1)))
##
# KVAddKey $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Add key $2 to $1, but do not associate $2 with any value (the former
# associations remain untouched). Low-level routine.
KVAddKey = $(if $(call KVHasKey,$1,$2),,$(eval __mkutils_map_$1_keys += $2))
##
# KVTagKey $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Tag $2 in $1. Tagging is used to mark selected keys for further processing.
# Low-level routine.
KVTagKey = $(if $(call KVHasKey,$1,$2),$(eval __mkutils_map_$1[$2]_ := 1))
##
# KVIsTagged $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Return true if $2 is tagged in $1. Low-level routine.
KVIsTagged = $(__mkutils_map_$1[$2]_)
##
# KVUntagKey $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Untag $2 in $1. Low-level routine.
KVUntagKey = $(if $(call KVIsTagged,$1,$2),$(eval __mkutils_map_$1[$2]_ :=))
##
# KVRemoveKey $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Remove $2 from $1. Low-level routine.
KVRemoveKey = $(eval \
__mkutils_map_$1_keys := $(filter-out $2,$(call MapKeys, $1)) \
)
##
# KVSet $1 $2 $3
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# $3 - value
# -----------------------------------------------------------------------------
# Add $3 to $1 under the key $2. This also untag $2. Also create $1 if it is
# not created yet.
KVSet = $(call $(0)_,$(strip $1),$(strip $2),$(strip $3))
KVSet_ = $(if $2,$(strip \
$(if $(call MapKeys, $1),,$(call MakeMap, $1)) \
$(call KVAddKey,$1,$2) \
$(call KVUntagKey,$1,$2) \
$(call KVSetKey,$1,$2,$3) \
))
##
# KVGet $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Get the value stored under the key $2 in $1.
KVGet = $(call $(0)Key,$(strip $1),$(strip $2))
##
# KVHas $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Return true if $2 is in $1.
KVHas = $(call $(0)Key,$(strip $1),$(strip $2))
##
# KVDel $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Remove $2 from $1. This also untag $2.
KVDel = $(call $(0)_,$(strip $1),$(strip $2))
KVDel_ = $(if $(call KVHasKey,$1,$2),$(strip \
$(call KVSetKey,$1,$2,) \
$(call KVUntagKey,$1,$2) \
$(call KVRemoveKey,$1,$2) \
))
##
# KVHide $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Hide $2 in $1, so algorithms working with $1 behave like if $2 was removed.
# The value stored under the key $2 remains untouched. Use hiding instead of
# removing for reusable keys.
KVHide = $(call KVTagKey,$(strip $1),$(strip $2))
##
# KVIsHidden $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Return true if $2 is hidden in $1.
KVIsHidden = $(call KVIsTagged,$(strip $1),$(strip $2))
##
# KVUnhide $1 $2
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - key
# -----------------------------------------------------------------------------
# Unhide $2 in $1.
KVUnhide = $(call KVUntagKey,$(strip $1),$(strip $2))
##
# KVApply $1 $2 $3
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - function
# $3 - user argument to $2
# -----------------------------------------------------------------------------
# Iterate over all visible keys of $1. During every iteration, call $2 with the
# value stored under the current key in $1 as the 1st argument, the current key
# as the 2nd argument, the $1 as the 3rd argument, and the $3 as the 4th
# argument.
KVApply = $(call $(0)_,$(strip $1),$(strip $2),$(strip $3))
KVApply_ = $(strip $(foreach x,$(call MapKeys,$1),$(call $(0)a,$x,$1,$2,$3)))
KVApply_a = $(if $(call KVIsTagged,$2,$1),, \
$(call $3,$(call KVGetKey,$2,$1),$1,$2,$4) \
)
##
# KVApplyHidden $1 $2 $3
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - function
# $3 - user argument to $2
# -----------------------------------------------------------------------------
# Iterate over all hidden keys of $1. During every iteration, call $2 with the
# value stored under the current key in $1 as the 1st argument, the current key
# as the 2nd argument, the $1 as the 3rd argument, and the $3 as the 4th
# argument.
KVApplyHidden = $(call $(0)_,$(strip $1),$(strip $2),$(strip $3))
KVApplyHidden_ = $(strip \
$(foreach x,$(call MapKeys,$1),$(call $(0)a,$x,$1,$2,$3)) \
)
KVApplyHidden_a = $(if $(call KVIsTagged,$2,$1), \
$(call $3,$(call KVGetKey,$2,$1),$1,$2,$4) \
)
##
# KVApplyAll $1 $2 $3
# -----------------------------------------------------------------------------
# $1 - map name
# $2 - function
# $3 - user argument to $2
# -----------------------------------------------------------------------------
# Iterate over all keys of $1. During every iteration, call $2 with the value
# stored under the current key in $1 as the 1st argument, the current key as
# the 2nd argument, the $1 as the 3rd argument, and the $3 as the 4th argument.
KVApplyAll = $(call $(0)_,$(strip $1),$(strip $2),$(strip $3))
KVApplyAll_ = $(strip $(foreach x,$(call MapKeys,$1), \
$(call $2,$(call KVGetKey,$1,$x),$x,$1,$3) \
))
## ============================================================================
## == 6) Evaluating expressions ==
## ============================================================================
# Counters
__mkutils_counter_a := 0
__mkutils_counter_b := 0
__mkutils_counter_c := 0
__mkutils_counter_d := 0
__mkutils_counter_e := 0
__mkutils_counter_f := 0
__mkutils_counter_g := 0
__mkutils_counter_h := 0
__mkutils_counter_i := 0
__mkutils_counter_j := 0
##
# EvalExpr $1
# -----------------------------------------------------------------------------
# $1 - expression to be evaluated
# -----------------------------------------------------------------------------
# Eval $1 using $(EXPR) and return the result or report an error.
EvalExpr = $(call RunWithHooks_,$(EXPR) $1,Identity,$(0)_)
EvalExpr_ = $(if $(call Equal_,$1,1),$(__mkutils_Run_output), \
$(error Evaluating expression failed with $1: $(__mkutils_Run_output)) \
)
##
# AssertCounter $1
# -----------------------------------------------------------------------------
# $1 - counter name (must be a letter from "a" to "j")
# -----------------------------------------------------------------------------
# Report an error if $1 is not defined.
AssertCounter = $(call AssertVar_,__mkutils_counter_$(strip $1))
##
# Reset $1 $2
# -----------------------------------------------------------------------------
# $1 - counter name (must be a letter from "a" to "j")
# $2 - counter value (must be an integer or empty)
# -----------------------------------------------------------------------------
# Set $1's value to $2. If $2 is ommited, set $1 to 0.
Reset = $(call $(0)_,$(strip $1),$(strip $2))
Reset_ = $(call AssertCounter,$1)$(eval __mkutils_counter_$1 := $(if $2,$2,0))
##
# Value $1
# -----------------------------------------------------------------------------
# $1 - counter name (must be a letter from "a" to "j")
# -----------------------------------------------------------------------------
# Get the $1's value.
Value = $(call AssertCounter,$1)$(__mkutils_counter_$(strip $1))
##
# IsZero $1
# -----------------------------------------------------------------------------
# $1 - counter name (must be a letter from "a" to "j")
# -----------------------------------------------------------------------------
# Test if $1 is zero.
IsZero = $(call Eq,$(call Value,$1),0)
##
# Inc $1
# -----------------------------------------------------------------------------
# $1 - counter name (must be a letter from "a" to "j")
# -----------------------------------------------------------------------------
# Increase $1 by one.
Inc = $(call $(0)_,$(strip $1))
Inc_ = $(eval __mkutils_counter_$1 := $(call Add,$(call Value,$1),1))
##
# Dec $1
# -----------------------------------------------------------------------------
# $1 - counter name (must be a letter from "a" to "j")
# -----------------------------------------------------------------------------
# Decrease $1 by one, but not to negative value (Dec 0 will be always 0).
Dec = $(call $(0)_,$(strip $1))
Dec_ = $(strip \
$(if $(call Gt_,$(call Value,$1),0), \
$(eval __mkutils_counter_$1 := $(call Sub,$(call Value,$1),1)), \
$(eval __mkutils_counter_$1 := 0) \
) \
)
##
# Add $1 $2
# -----------------------------------------------------------------------------
# $1 - 1st operand (must be an integer)
# $2 - 2nd operand (must be an integer)
# -----------------------------------------------------------------------------
# Return the value of `$1 + $2` or report an error.
Add = $(call EvalExpr,$1 + $2)
##
# Sub $1 $2
# -----------------------------------------------------------------------------
# $1 - 1st operand (must be an integer)
# $2 - 2nd operand (must be an integer)
# -----------------------------------------------------------------------------
# Return the value of `$1 - $2` or report an error.
Sub = $(call EvalExpr,$1 - $2)
##
# Mul $1 $2
# -----------------------------------------------------------------------------
# $1 - 1st operand (must be an integer)
# $2 - 2nd operand (must be an integer)
# -----------------------------------------------------------------------------
# Return the value of `$1 * $2` or report an error.
Mul = $(call EvalExpr,$1 \* $2)
##
# Div $1 $2
# -----------------------------------------------------------------------------
# $1 - 1st operand (must be an integer)
# $2 - 2nd operand (must be a non-zero integer)
# -----------------------------------------------------------------------------
# Return the value of `$1 / $2` or report an error.
Div = $(call AssertNe_,$2,0)$(call EvalExpr,$1 / $2)
##
# Mod $1 $2
# -----------------------------------------------------------------------------
# $1 - 1st operand (must be an integer)
# $2 - 2nd operand (must be a non-zero integer)
# -----------------------------------------------------------------------------
# Return the value of `$1 % $2` or report an error.
Mod = $(call AssertNe_,$2,0)$(call EvalExpr,$1 % $2)
## ============================================================================
## == 7) Value testing ==
## ============================================================================
##
# IfEmpty $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - values
# -----------------------------------------------------------------------------
# Return $2 if $1 is empty. Otherwise $1 is returned.
IfEmpty = $(call $(0)_,$(strip $1),$(strip $2))
IfEmpty_ = $(if $1,$1,$2)
##
# Eq $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - integers
# -----------------------------------------------------------------------------
# Return true if $1 == $2.
Eq = $(call $(0)_,$(strip $1),$(strip $2))
Eq_ = $(call ExitsWith,$(TEST) $1 -eq $2,0)
##
# Ne $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - integers
# -----------------------------------------------------------------------------
# Return true if $1 != $2.
Ne = $(call $(0)_,$(strip $1),$(strip $2))
Ne_ = $(call ExitsWith,$(TEST) $1 -ne $2,0)
##
# Lt $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - integers
# -----------------------------------------------------------------------------
# Return true if $1 < $2.
Lt = $(call $(0)_,$(strip $1),$(strip $2))
Lt_ = $(call ExitsWith,$(TEST) $1 -lt $2,0)
##
# Gt $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - integers
# -----------------------------------------------------------------------------
# Return true if $1 > $2.
Gt = $(call $(0)_,$(strip $1),$(strip $2))
Gt_ = $(call ExitsWith,$(TEST) $1 -gt $2,0)
##
# Le $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - integers
# -----------------------------------------------------------------------------
# Return true if $1 <= $2.
Le = $(call $(0)_,$(strip $1),$(strip $2))
Le_ = $(call ExitsWith,$(TEST) $1 -le $2,0)
##
# Ge $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - integers
# -----------------------------------------------------------------------------
# Return true if $1 >= $2.
Ge = $(call $(0)_,$(strip $1),$(strip $2))
Ge_ = $(call ExitsWith,$(TEST) $1 -ge $2,0)
##
# Equal $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - strings
# -----------------------------------------------------------------------------
# Return true if $1 == $2.
Equal = $(call $(0)_,$(strip $1),$(strip $2))
Equal_ = $(call Not_,$(call NotEqual_,$1,$2))
##
# NotEqual $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - strings
# -----------------------------------------------------------------------------
# Return true if $1 != $2.
NotEqual = $(call $(0)_,$(strip $1),$(strip $2))
NotEqual_ = $(subst x$1,,x$2)$(subst x$2,,x$1)
## ============================================================================
## == 8) Assertions ==
## ============================================================================
##
# Assert $1 $2
# -----------------------------------------------------------------------------
# $1 - value
# $2 - error message
# -----------------------------------------------------------------------------
# Proceed with error and print $2 if $1 is false.
Assert = $(call $(0)_,$(strip $1),$(strip $2))
Assert_ = $(if $1,,$(error $2))
##
# AssertVar $1
# -----------------------------------------------------------------------------
# $1 - variable name
# -----------------------------------------------------------------------------
# Proceed with error if $1 is empty or undefined.
AssertVar = $(call $(0)_,$(strip $1))
AssertVar_ = $(call Assert_,$($1),$1 is empty or undefined)
##
# AssertEq $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - integers
# -----------------------------------------------------------------------------
# Proceed with error if $1 != $2.
AssertEq = $(call $(0)_,$(strip $1),$(strip $2))
AssertEq_ = $(call Assert_,$(call Eq_,$1,$2),Assertion x == y failed: $1 != $2)
##
# AssertNe $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - integers
# -----------------------------------------------------------------------------
# Proceed with error if $1 == $2.
AssertNe = $(call $(0)_,$(strip $1),$(strip $2))
AssertNe_ = $(call Assert_,$(call Ne_,$1,$2),Assertion x != y failed: $1 == $2)
##
# AssertLt $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - integers
# -----------------------------------------------------------------------------
# Proceed with error if $1 >= $2.
AssertLt = $(call $(0)_,$(strip $1),$(strip $2))
AssertLt_ = $(call Assert_,$(call Lt_,$1,$2),Assertion x < y failed: $1 >= $2)
##
# AssertGt $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - integers
# -----------------------------------------------------------------------------
# Proceed with error if $1 <= $2.
AssertGt = $(call $(0)_,$(strip $1),$(strip $2))
AssertGt_ = $(call Assert_,$(call Gt_,$1,$2),Assertion x > y failed: $1 <= $2)
##
# AssertLe $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - integers
# -----------------------------------------------------------------------------
# Proceed with error if $1 > $2.
AssertLe = $(call $(0)_,$(strip $1),$(strip $2))
AssertLe_ = $(call Assert_,$(call Le_,$1,$2),Assertion x <= y failed: $1 > $2)
##
# AssertGe $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - integers
# -----------------------------------------------------------------------------
# Proceed with error if $1 < $2.
AssertGe = $(call $(0)_,$(strip $1),$(strip $2))
AssertGe_ = $(call Assert_,$(call Ge_,$1,$2),Assertion x >= y failed: $1 < $2)
##
# AssertEqual $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - strings
# -----------------------------------------------------------------------------
# Proceed with error if $1 != $2.
AssertEqual = $(call $(0)_,$(strip $1),$(strip $2))
AssertEqual_ = $(call Assert_,$(call Equal_,$1,$2),$(strip \
Assertion x == y failed: '$1' != '$2' \
))
##
# AssertNotEqual $1 $2
# -----------------------------------------------------------------------------
# $1, $2 - strings
# -----------------------------------------------------------------------------
# Proceed with error if $1 == $2.
AssertNotEqual = $(call $(0)_,$(strip $1),$(strip $2))
AssertNotEqual_ = $(call Assert_,$(call NotEqual_,$1,$2),$(strip \
Assertion x != y failed: '$1' == '$2' \
))
## ============================================================================
## == 9) Printing ==
## ============================================================================
# Detect for coloured output support
ifneq ($(COLORTERM),)
__mkutils_color = $1
else ifneq ($(findstring color,$(TERM)),)
__mkutils_color = $1
else ifeq ($(TERM),xterm)
__mkutils_color = $1
else ifeq ($(TERM),linux)
__mkutils_color = $1
else
__mkutils_color =
endif
# Not running in terminal
ifneq ($(ISATTY),1)
__mkutils_color =
endif
# The user has the last word
ifdef NOCOLORS
__mkutils_color =
export NOCOLORS
endif
# Enable `-e` option for $(ECHO) only if coloring is supported
__mkutils_echo_e := $(call __mkutils_color,-e)
##
# ANSI color escape codes to be handled by `$(ECHO) -e`.
ANSI_COLOR_OFF := $(call __mkutils_color,\e[0m)
ANSI_COLOR_BLACK := $(call __mkutils_color,\e[0;30m)
ANSI_COLOR_RED := $(call __mkutils_color,\e[0;31m)
ANSI_COLOR_GREEN := $(call __mkutils_color,\e[0;32m)
ANSI_COLOR_BROWN := $(call __mkutils_color,\e[0;33m)
ANSI_COLOR_BLUE := $(call __mkutils_color,\e[0;34m)
ANSI_COLOR_PURPLE := $(call __mkutils_color,\e[0;35m)
ANSI_COLOR_CYAN := $(call __mkutils_color,\e[0;36m)
ANSI_COLOR_LIGHT_GRAY := $(call __mkutils_color,\e[0;37m)
ANSI_COLOR_DARK_GRAY := $(call __mkutils_color,\e[1;30m)
ANSI_COLOR_LIGHT_RED := $(call __mkutils_color,\e[1;31m)
ANSI_COLOR_LIGHT_GREEN := $(call __mkutils_color,\e[1;32m)
ANSI_COLOR_YELLOW := $(call __mkutils_color,\e[1;33m)
ANSI_COLOR_LIGHT_BLUE := $(call __mkutils_color,\e[1;34m)
ANSI_COLOR_LIGHT_PURPLE := $(call __mkutils_color,\e[1;35m)
ANSI_COLOR_LIGHT_CYAN := $(call __mkutils_color,\e[1;36m)
ANSI_COLOR_WHITE := $(call __mkutils_color,\e[1;37m)
##
# Colorize $1 $2
# -----------------------------------------------------------------------------
# $1 - color name without ANSI_COLOR_ prefix
# $2 - text
# -----------------------------------------------------------------------------
# Make $2 $1-colored.
Colorize = $(ANSI_COLOR_$1)$2$(ANSI_COLOR_OFF)
##
# Print $1 $2
# -----------------------------------------------------------------------------
# $1 - text
# $2 - additional options to $(ECHO)
# -----------------------------------------------------------------------------
# Print $1 to standard error output.
Print = $(shell $(ECHO) $2 "$1" >&2)
##
# ColorPrint $1 $2 $3
# -----------------------------------------------------------------------------
# $1 - color name without `ANSI_COLOR_` prefix
# $2 - text
# $3 - additional options to $(ECHO)
# -----------------------------------------------------------------------------
# Print $2 to standard error output colored.
ColorPrint = $(call Print,$(call Colorize,$1,$2),$(__mkutils_echo_e) $3)
##
# LightColorPrint $1 $2 $3
# -----------------------------------------------------------------------------
# $1 - color name without `ANSI_COLOR_LIGHT_` prefix
# $2 - text
# $3 - additional options to $(ECHO)
# -----------------------------------------------------------------------------
# Like ColorPrint but use light colors.
LightColorPrint = $(call ColorPrint,LIGHT_$1,$2,$3)
## ============================================================================
## == 10) Running programs ==
## ============================================================================
__mkutils_Run_output :=
__mkutils_Run_exitcode := 0
__mkutils_SoftRun_ :=
##
# ShowOutput
# -----------------------------------------------------------------------------
# Show the output of the last command invoked by Run.
ShowOutput = $(call LightColorPrint,GREEN,$(__mkutils_Run_output))
##
# ShowExitcode
# -----------------------------------------------------------------------------
# Show the exit code of the last command invoked by Run.
ShowExitcode = $(call \
LightColorPrint,RED,[exit_code = $(__mkutils_Run_exitcode)], \
)
##
# ShowStatus
# -----------------------------------------------------------------------------
# Show both output and exit code of the last command invoked by Run.
ShowStatus = $(call ShowOutput)$(call ShowExitcode)
##
# Run $1
# -----------------------------------------------------------------------------
# $1 - shell command
# -----------------------------------------------------------------------------
# Run $1, save output to __var_Run_output and exit code to __var_Run_exitcode.
Run = $(strip \
$(eval __mkutils_Run_output := $(shell $1 2>&1)) \
$(eval __mkutils_Run_exitcode := $(.SHELLSTATUS)) \
)
##
# SoftRun $1
# -----------------------------------------------------------------------------
# $1 - shell command
# -----------------------------------------------------------------------------
# Run $1 quietly.
SoftRun = $(eval __mkutils_SoftRun_ := $(shell $1 >/dev/null 2>&1))
##
# RunWithHooks $1 $2 $3
# -----------------------------------------------------------------------------
# $1 - shell command
# $2, $3 - name of a function with one argument
# -----------------------------------------------------------------------------
# Run $1. If $1 succeeds, call $2 with $1's output. Otherwise, call $3 with
# $1's exit code. Return the value returned by $2 or $3.
RunWithHooks = $(call $(0)_,$1,$(strip $2),$(strip $3))
RunWithHooks_ = $(strip $(if $(call ExitsWith,$1,0), \
$(call $2,$(__mkutils_Run_output)), \
$(call $3,$(__mkutils_Run_exitcode)) \
))
##
# WhenOk $1 $2
# -----------------------------------------------------------------------------
# $1 - shell command
# $2 - name of a function with one argument
# -----------------------------------------------------------------------------
# Run $1. If $1 succeeds, call $2 with $1's output and return the value
# returned by $2. Otherwise, return false.
WhenOk = $(call $(0)_,$1,$(strip $2))
WhenOk_ = $(if $(call ExitsWith,$1,0),$(call $2,$(__mkutils_Run_output)))
##
# WhenFail $1 $2
# -----------------------------------------------------------------------------
# $1 - shell command
# $2 - name of a function with one argument
# -----------------------------------------------------------------------------
# Run $1. If $1 fails, call $2 with $1's exit code and return the value
# returned by $2. Otherwise, return false.
WhenFail = $(call $(0)_,$1,$(strip $2))
WhenFail_ = $(if $(call ExitsWith,$1,0),,$(call $2,$(__mkutils_Run_exitcode)))
##
# ExitsWith $1 $2
# -----------------------------------------------------------------------------
# $1 - shell command
# $2 - expected exit code
# -----------------------------------------------------------------------------
# Return true if $1 exits with $2.
ExitsWith = $(call Run,$1)$(call Equal_,$(__mkutils_Run_exitcode),$(strip $2))
##
# NotExitsWith $1 $2
# -----------------------------------------------------------------------------
# $1 - shell command
# $2 - exit code
# -----------------------------------------------------------------------------
# Return false if $1 exits with $2.
NotExitsWith = $(strip \
$(call Run,$1) \
$(call NotEqual_,$(__mkutils_Run_exitcode),$(strip $2)) \
)
##
# Which $1
# -----------------------------------------------------------------------------
# $1 - name of executable
# -----------------------------------------------------------------------------
# Return true if $1 is installed on a system.
Which = $(call ExitsWith,$(WHICH) $1,0)
##
# FindProgram $1
# -----------------------------------------------------------------------------
# $1 - list of program names
# -----------------------------------------------------------------------------
# Search $1 and return the name of first existing program within $1. If such a
# program is not installed on a system, return false.
FindProgram = $(call $(0)_,$(strip $1))
FindProgram_ = $(if $1,$(strip \
$(call FindProgram_a,$(call Head_,$1),$(call Tail_,$1)) \
))
FindProgram_a = $(if $(call Which,$1),$1,$(call FindProgram_,$2))
## ============================================================================
## == 11) Probing Python interpreter ==
## ============================================================================
##
# PyVersion $1 $2
# -----------------------------------------------------------------------------
# $1 - Python interpreter
# $2 - `major` or `minor`
# -----------------------------------------------------------------------------
# Depending on $2's value, return major or minor version number of $1. On
# error, return false.