This repository has been archived by the owner on Aug 27, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 13
/
Maekfile.js
859 lines (752 loc) · 28.7 KB
/
Maekfile.js
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
//Run this (javascript) file with node:
//$ node Maekfile.js [-jN] [-v] [-q] [--] [target1] [target2] [...]
//
// Maekfile.js will [re-]build all the specified targets.
// Results are re-used by content hash if they match "maek-cache.json"; delete that file to force a full rebuild.
//
//Command line options:
// -jN limit on parallel jobs; defaults to number of cpu cores + 1
// -v verbose output; prints more info
// -q quit on first error (otherwise builds as much as possible)
// -- optional separator between command line switches and targets (useful if you have a target named '-j1')
// targetN target name. Posix-style path to a file to build, or an abstract target (word starting with ':')
//
//maek is configured using properties and methods of the `maek` object:
const maek = init_maek();
// (it's a quirk of javascript that function definitions anywhere in scope get 'hoisted'
// -- you can see the definition of init_maek by scrolling down.)
//Read onward to discover how to configure Maek for your build!
//======================================================================
const NEST_LIBS = `../nest-libs/${maek.OS}`;
//set compile flags (these can also be overridden per-task using the "options" parameter):
if (maek.OS === "windows") {
maek.options.CPPFlags.push(
`/O2`, //optimize
//include paths for nest libraries:
`/I${NEST_LIBS}/SDL2/include`,
`/I${NEST_LIBS}/glm/include`,
`/I${NEST_LIBS}/libpng/include`,
`/I${NEST_LIBS}/opusfile/include`,
`/I${NEST_LIBS}/libopus/include`,
`/I${NEST_LIBS}/libogg/include`,
//#disable a few warnings:
`/wd4146`, //-1U is still unsigned
`/wd4297`, //unforunately SDLmain is nothrow
`/wd4100`, //unreferenced formal parameter
`/wd4201`, //nameless struct/union
`/wd4611` //interaction between setjmp and C++ object destruction
);
maek.options.LINKLibs.push(
`/LIBPATH:${NEST_LIBS}/SDL2/lib`, `SDL2main.lib`, `SDL2.lib`, `OpenGL32.lib`, `Shell32.lib`,
`/LIBPATH:${NEST_LIBS}/libpng/lib`, `libpng.lib`,
`/LIBPATH:${NEST_LIBS}/zlib/lib`, `zlib.lib`,
`/LIBPATH:${NEST_LIBS}/opusfile/lib`, `opusfile.lib`,
`/LIBPATH:${NEST_LIBS}/libopus/lib`, `opus.lib`,
`/LIBPATH:${NEST_LIBS}/libogg/lib`, `libogg.lib`,
`/MANIFEST:EMBED`, `/MANIFESTINPUT:set-utf8-code-page.manifest`
);
} else if (maek.OS === "linux") {
maek.options.CPPFlags.push(
`-O2`, //optimize
//include paths for nest libraries:
`-I${NEST_LIBS}/SDL2/include/SDL2`, `-D_THREAD_SAFE`, //the output of sdl-config --cflags
`-I${NEST_LIBS}/glm/include`,
`-I${NEST_LIBS}/libpng/include`,
`-I${NEST_LIBS}/opusfile/include`,
`-I${NEST_LIBS}/libopus/include`,
`-I${NEST_LIBS}/libogg/include`
);
maek.options.LINKLibs.push(
//linker flags for nest libraries:
`-L${NEST_LIBS}/SDL2/lib`, `-lSDL2`, `-lm`, `-ldl`, `-lasound`, `-lpthread`, `-lX11`, `-lXext`, `-lpthread`, `-lrt`, `-lGL`, //the output of sdl-config --static-libs
`-L${NEST_LIBS}/libpng/lib`, `-lpng`,
`-L${NEST_LIBS}/zlib/lib`, `-lz`,
`-L${NEST_LIBS}/opusfile/lib`, `-lopusfile`,
`-L${NEST_LIBS}/libopus/lib`, `-lopus`,
`-L${NEST_LIBS}/libogg/lib`, `-logg`,
);
} else if (maek.OS === "macos") {
maek.options.CPPFlags.push(
`-O2`, //optimize
//include paths for nest libraries:
`-I${NEST_LIBS}/SDL2/include/SDL2`, `-D_THREAD_SAFE`, //the output of sdl-config --cflags
`-I${NEST_LIBS}/glm/include`,
`-I${NEST_LIBS}/libpng/include`,
`-I${NEST_LIBS}/opusfile/include`,
`-I${NEST_LIBS}/libopus/include`,
`-I${NEST_LIBS}/libogg/include`
);
maek.options.LINKLibs.push(
//linker flags for nest libraries:
`-L${NEST_LIBS}/SDL2/lib`, `-lSDL2`, `-lm`,`-liconv`, `-framework`, `CoreAudio`, `-framework`, `AudioToolbox`, `-weak_framework`, `CoreHaptics`, `-weak_framework`, `GameController`, `-framework`, `ForceFeedback`, `-lobjc`, `-framework`, `CoreVideo`, `-framework`, `Cocoa`, `-framework`, `Carbon`, `-framework`, `IOKit`, `-framework`, `OpenGL`, //the output of sdl-config --static-libs
`-L${NEST_LIBS}/libpng/lib`, `-lpng`,
`-L${NEST_LIBS}/zlib/lib`, `-lz`,
`-L${NEST_LIBS}/opusfile/lib`, `-lopusfile`,
`-L${NEST_LIBS}/libopus/lib`, `-lopus`,
`-L${NEST_LIBS}/libogg/lib`, `-logg`,
);
}
//use COPY to copy a file
// 'COPY(from, to)'
// from: file to copy from
// to: file to copy to
let copies = [
maek.COPY(`${NEST_LIBS}/SDL2/dist/README-SDL.txt`, `dist/README-SDL.txt`),
maek.COPY(`${NEST_LIBS}/libpng/dist/README-libpng.txt`, `dist/README-libpng.txt`),
maek.COPY(`${NEST_LIBS}/glm/dist/README-glm.txt`, `dist/README-glm.txt`),
maek.COPY(`${NEST_LIBS}/libopus/dist/README-libopus.txt`, `dist/README-libopus.txt`),
maek.COPY(`${NEST_LIBS}/opusfile/dist/README-opusfile.txt`, `dist/README-opusfile.txt`),
maek.COPY(`${NEST_LIBS}/libogg/dist/README-libogg.txt`, `dist/README-libogg.txt`)
];
if (maek.OS === 'windows') {
copies.push( maek.COPY(`${NEST_LIBS}/SDL2/dist/SDL2.dll`, `dist/SDL2.dll`) );
}
//call rules on the maek object to specify tasks.
// rules generally look like:
// output = maek.RULE_NAME(input [, output] [, {options}])
//the '[objFile =] CPP(cppFile [, objFileBase] [, options])' compiles a c++ file:
// cppFile: name of c++ file to compile
// objFileBase (optional): base name object file to produce (if not supplied, set to options.objDir + '/' + cppFile without the extension)
//returns objFile: objFileBase + a platform-dependant suffix ('.o' or '.obj')
const game_names = [
maek.CPP('PlayMode.cpp'),
maek.CPP('main.cpp'),
maek.CPP('LitColorTextureProgram.cpp'),
//maek.CPP('ColorTextureProgram.cpp'), //not used right now, but you might want it
maek.CPP('Sound.cpp'),
maek.CPP('load_wav.cpp'),
maek.CPP('load_opus.cpp')
];
const common_names = [
maek.CPP('data_path.cpp'),
maek.CPP('PathFont.cpp'),
maek.CPP('PathFont-font.cpp'),
maek.CPP('DrawLines.cpp'),
maek.CPP('ColorProgram.cpp'),
maek.CPP('Scene.cpp'),
maek.CPP('Mesh.cpp'),
maek.CPP('load_save_png.cpp'),
maek.CPP('gl_compile_program.cpp'),
maek.CPP('Mode.cpp'),
maek.CPP('GL.cpp'),
maek.CPP('Load.cpp')
];
const show_meshes_names = [
maek.CPP('show-meshes.cpp'),
maek.CPP('ShowMeshesProgram.cpp'),
maek.CPP('ShowMeshesMode.cpp')
];
const show_scene_names = [
maek.CPP('show-scene.cpp'),
maek.CPP('ShowSceneProgram.cpp'),
maek.CPP('ShowSceneMode.cpp')
];
//the '[exeFile =] LINK(objFiles, exeFileBase, [, options])' links an array of objects into an executable:
// objFiles: array of objects to link
// exeFileBase: name of executable file to produce
//returns exeFile: exeFileBase + a platform-dependant suffix (e.g., '.exe' on windows)
const game_exe = maek.LINK([...game_names, ...common_names], 'dist/game');
const show_meshes_exe = maek.LINK([...show_meshes_names, ...common_names], 'scenes/show-meshes');
const show_scene_exe = maek.LINK([...show_scene_names, ...common_names], 'scenes/show-scene');
//set the default target to the game (and copy the readme files):
maek.TARGETS = [game_exe, show_meshes_exe, show_scene_exe, ...copies];
//Note that tasks that produce ':abstract targets' are never cached.
// This is similar to how .PHONY targets behave in make.
//======================================================================
//Now, onward to the code that makes all this work:
function init_maek() {
//----------------------------------
//some setup
//standard libraries:
const path = require('path').posix; //NOTE: expect posix-style paths even on windows
const fsPromises = require('fs').promises;
const fs = require('fs');
const os = require('os');
const performance = require('perf_hooks').performance;
const child_process = require('child_process');
//make it so that all paths/commands are relative to this file:
// (regardless of where you run it from)
console.log(`Building in ${__dirname}.`);
process.chdir(__dirname);
//make it slightly more idiomatic to export:
const maek = module.exports;
//-----------------------------------------
//Constants:
//cache file location:
maek.CACHE_FILE = 'maek-cache.json';
//current OS: (with slightly nicer naming than os.platform()
maek.OS = (() => {
const platform = os.platform();
if (platform === 'win32') return 'windows';
else if (platform === 'darwin') return 'macos';
else if (platform === 'linux') return 'linux';
else {
console.error(`ERROR: Unrecognized platform ${os.platform()}.`);
process.exit(1);
}
})();
//-----------------------------------------
//Command line defaults:
//maximum number of jobs to run: (change with -jN)
maek.JOBS = os.cpus().length + 1;
//targets to build by default: (change by passing target names)
maek.TARGETS = [];
//print extra info: (set by passing -v)
maek.VERBOSE = false;
//quit on first failure: (set by passing -q)
maek.QUIT_EAGERLY = false;
//-----------------------------------------
//options: set to change maek rule behavior
const DEFAULT_OPTIONS = {
objPrefix: 'objs/', //prefix for object file paths (if not explicitly specified)
objSuffix: (maek.OS === 'windows' ? '.obj' : '.o'), //suffix for object files
exeSuffix: (maek.OS === 'windows' ? '.exe' : ''), //suffix for executable files
depends: [], //extra dependencies; generally only set locally
CPP: [], //the c++ compiler and any flags to start with (set below, per-OS)
CPPFlags: [], //extra flags for c++ compiler
LINK: [], //the linker and any flags to start with (set below, per-OS)
LINKLibs: [], //extra -L and -l flags for linker
}
if (maek.OS === 'windows') {
DEFAULT_OPTIONS.CPP = ['cl.exe', '/nologo', '/EHsc', '/Z7', '/std:c++17', '/W4', '/WX', '/MD'];
//TODO: could embed manifest to set UTF8 codepage
DEFAULT_OPTIONS.LINK = ['link.exe', '/nologo', '/SUBSYSTEM:CONSOLE', '/DEBUG:FASTLINK', '/INCREMENTAL:NO'];
} else if (maek.OS === 'linux') {
DEFAULT_OPTIONS.CPP = ['g++', '-std=c++17', '-Wall', '-Werror', '-g'];
DEFAULT_OPTIONS.LINK = ['g++', '-std=c++17', '-Wall', '-Werror', '-g'];
} else if (maek.OS === 'macos') {
DEFAULT_OPTIONS.CPP = ['clang++', '-std=c++17', '-Wall', '-Werror', '-g'];
DEFAULT_OPTIONS.LINK = ['clang++', '-std=c++17', '-Wall', '-Werror', '-g'];
}
//any settings here override 'DEFAULT_OPTIONS':
maek.options = Object.assign({}, DEFAULT_OPTIONS); //shallow copy of DEFAULT_OPTIONS in case you want to console.log(maek.options) to check settings.
//this combines DEFAULT_OPTIONS, maek.options, and localOptions:
function combineOptions(localOptions) {
//shallow copy of default options:
const combined = Object.assign({}, DEFAULT_OPTIONS);
//override with maek.options + complain on missing keys:
for (const key of Object.keys(maek.options)) {
if (!(key in combined)) throw new Error(`ERROR: '${key}' (in maek.options) not recognized.`);
combined[key] = maek.options[key];
}
//override with localOptions + complain on missing keys:
for (const key of Object.keys(localOptions)) {
if (!(key in combined)) throw new Error(`ERROR: '${key}' (in local options) not recognized.`);
combined[key] = localOptions[key];
}
return combined;
}
//tasks is a map from targets -> tasks:
maek.tasks = {};
//-----------------------------------------
//RULES.
// helper functions that specify tasks:
//COPY adds a task that copies a file:
maek.COPY = (srcFile, dstFile) => {
if (typeof srcFile !== "string") throw new Error("COPY: from should be a single file.");
if (typeof dstFile !== "string") throw new Error("COPY: to should be a single file.");
const task = async () => {
try {
await fsPromises.mkdir(path.dirname(dstFile), { recursive: true });
await fsPromises.copyFile(srcFile, dstFile);
} catch (e) {
throw new BuildError(`Failed to copy '${srcFile}' to '${dstFile}': ${e}`);
}
};
task.depends = [srcFile];
task.label = `COPY ${dstFile}`;
maek.tasks[dstFile] = task;
return dstFile;
};
//maek.CPP makes an object from a c++ source file:
// cppFile is the source file name
// objFileBase (optional) is the output file (including any subdirectories, but not the extension)
maek.CPP = (cppFile, objFileBase, localOptions = {}) => {
//combine options:
const options = combineOptions(localOptions);
//if objFileBase isn't given, compute by trimming extension from cppFile and appending to objPrefix:
if (typeof objFileBase === 'undefined') {
objFileBase = path.relative('', options.objPrefix + cppFile.replace(/\.[^.]*$/, ''));
}
//object file gets os-dependent suffix:
const objFile = objFileBase + options.objSuffix;
//computed dependencies go in a '.d' file stored next to the object file:
const depsFile = objFileBase + '.d';
let cc, command;
cc = [...options.CPP, ...options.CPPFlags];
if (maek.OS === 'linux') {
command = [...cc, '-MD', '-MT', 'x ', '-MF', depsFile, '-c', '-o', objFile, cppFile];
} else if (maek.OS === 'macos') {
command = [...cc, '-MD', '-MT', 'x ', '-MF', depsFile, '-c', '-o', objFile, cppFile];
} else { //windows
command = [...cc, '/c', `/Fo${objFile}`, '/sourceDependencies', depsFile, '/Tp', cppFile];
}
//will be used by loadDeps to trim explicit dependencies:
async function loadDeps() {
const text = await fsPromises.readFile(depsFile, { encoding: 'utf8' });
if (maek.OS === 'windows') {
//parse JSON-encoded dependency info from /sourceDependencies:
const winpath = require('path').win32;
const parsed = JSON.parse(text);
let paths = [...parsed.Data.Includes, parsed.Data.Source];
paths = paths.map(path => winpath.relative('', path).split('\\').join('/'));
paths = paths.sort();
return paths;
} else {
//parse the makefile-style "targets : prerequisites" line from the file into a list of tokens:
let tokens = text
.replace(/\\?\n/g, ' ') //escaped newline (or regular newline) => whitespace
.trim() //remove leading and trailing whitespace
.replace(/([^\\])\s+/g, '$1\n') //run of non-escaped whitespace => single newline
.split('\n'); //split on single newlines
//because of the `-MT 'x '` option, expect 'x :' at the start of the rule:
console.assert(tokens[0] === 'x');
console.assert(tokens[1] === ':');
tokens = tokens.slice(2); //remove the 'x :'
//tokens = tokens.map(path => path.relative('', path)); //hmmm does this do anything worthwhile?
tokens = tokens.sort(); //sort for consistency
//NOTE: might want to do some path normalization here!
return tokens;
}
}
//The actual build task:
const task = async () => {
//make object file:
await fsPromises.mkdir(path.dirname(objFile), { recursive: true });
await fsPromises.mkdir(path.dirname(depsFile), { recursive: true });
await run(command, `${task.label}: compile + prerequisites`,
async () => {
return {
read:[...await loadDeps()],
written:[objFile, depsFile]
};
}
);
};
task.depends = [cppFile, ...options.depends];
task.label = `CPP ${objFile}`;
if (objFile in maek.tasks) {
throw new Error(`Task ${task.label} purports to create ${objFile}, but ${maek.tasks[objFile].label} already creates that file.`);
}
maek.tasks[objFile] = task;
return objFile;
};
//maek.LINK links an executable file from a collection of object files:
// objFiles is an array of object file names
// exeFileBase is the base name of the executable file ('.exe' will be added on windows)
maek.LINK = (objFiles, exeFileBase, localOptions = {}) => {
const options = combineOptions(localOptions);
const exeFile = exeFileBase + options.exeSuffix;
let link, linkCommand;
link = [...options.LINK];
if (maek.OS === 'linux') {
linkCommand = [...link, '-o', exeFile, ...objFiles, ...options.LINKLibs];
} else if (maek.OS === 'macos') {
linkCommand = [...link, '-o', exeFile, ...objFiles, ...options.LINKLibs];
} else {
linkCommand = [...link, `/out:${exeFile}`, ...objFiles, ...options.LINKLibs];
}
const task = async () => {
await fsPromises.mkdir(path.dirname(exeFile), { recursive: true });
await run(linkCommand, `${task.label}: link`,
async () => {
return {
read:[...objFiles],
written:[exeFile]
};
}
);
};
task.depends = [...objFiles, ...options.depends];
task.label = `LINK ${exeFile}`;
if (exeFile in maek.tasks) {
throw new Error(`Task ${task.label} purports to create ${exeFile}, but ${maek.tasks[exeFile].label} already creates that file.`);
}
maek.tasks[exeFile] = task;
return exeFile;
};
//says something went wrong in building -- should fail loudly:
class BuildError extends Error {
constructor(message) {
super(message);
}
}
//cache stores the hashes of files involved in run()'d commands:
let cache = {};
function loadCache() {
try {
const loaded = JSON.parse(fs.readFileSync(maek.CACHE_FILE, { encoding: 'utf8' }));
let assigned = 0;
let removed = 0;
for (const command of Object.keys(loaded)) {
//cache will have a 'files' and a 'hashes' line
if ('files' in loaded[command] && 'hashes' in loaded[command]) {
cache[command] = {
files:loaded[command].files,
hashes:loaded[command].hashes
};
assigned += 1;
} else {
removed += 1;
}
}
if (maek.VERBOSE) console.log(` -- Loaded cache from '${maek.CACHE_FILE}'; had ${assigned} valid entries and ${removed} invalid ones.`);
} catch (e) {
if (maek.VERBOSE) console.log(` -- No cache loaded; starting fresh.`);
if (e.code !== 'ENOENT') {
console.warn(`Cache loading failed for unexpected reason:`, e);
}
}
}
function saveCache() {
if (maek.VERBOSE) console.log(` -- Writing cache with ${Object.keys(cache).length} entries to '${maek.CACHE_FILE}'...`);
fs.writeFileSync(maek.CACHE_FILE, JSON.stringify(cache), { encoding: 'utf8' });
}
let runTime = 0.0;
//runs a shell command (presented as an array)
// 'message' will be displayed above the command
// 'cacheInfoFn', if provided, will be called after function is run to determine which files to hash when caching the result
async function run(command, message, cacheInfoFn) {
//cache key for the command -- encoded command name:
const cacheKey = JSON.stringify(command);
//executable for the command:
const exe = await findExe(command);
//if no cache info function, remove any existing cache entry:
if (!cacheInfoFn) {
delete cache[cacheKey];
}
//check for existing cache entry:
let extra = ''; //extra message
if (cacheKey in cache) {
const cached = cache[cacheKey].hashes;
const current = await hashFiles([exe, ...cache[cacheKey].files]);
if (JSON.stringify(current) === JSON.stringify(cached)) {
if (maek.VERBOSE) console.log(`\x1b[33m${message} [cached]\x1b[0m`);
return;
} else {
if (maek.VERBOSE) extra = ` \x1b[33m[cache miss!]\x1b[0m`;
}
}
if (typeof message !== 'undefined') {
console.log(`\x1b[90m${message}\x1b[0m${extra}`);
}
//print a command in a way that can be copied to a shell to run:
let prettyCommand = '';
for (const token of command) {
if (prettyCommand !== '') prettyCommand += ' ';
if (/[ \t\n!"'$&()*,;<>?[\\\]^`{|}~]/.test(token)
|| token[0] === '='
|| token[0] === '#') {
//special characters => need to quote:
prettyCommand += "'" + token.replace(/'/g, "'\\''") + "'";
} else {
prettyCommand += token;
}
}
console.log(' ' + prettyCommand);
//package as a promise and await it finishing:
const before = performance.now();
await new Promise((resolve, reject) => {
const proc = child_process.spawn(command[0], command.slice(1), {
shell: false,
stdio: ['ignore', 'inherit', 'inherit']
});
proc.on('exit', (code, signal) => {
if (code !== 0) {
process.stderr.write(`\n`);
reject(new BuildError(`exit ${code} from:\n \x1b[31m${prettyCommand}\x1b[0m\n`));
} else {
resolve();
}
});
proc.on('error', (err) => {
reject(new BuildError(`${err.message} from:\n ${prettyCommand}`));
});
});
runTime += performance.now() - before;
//store result in cache:
if (cacheInfoFn) {
const {read, written} = await cacheInfoFn();
//if hashed one of the written files before, can't rely on it:
for (const file of written) {
delete hashCache[file];
}
//update cache with file content hashes:
const files = [...read, ...written];
cache[cacheKey] = {
files:files,
hashes:await hashFiles([exe, ...files])
};
}
}
let hashCacheHits = 0;
let hashCache = {};
let hashLoadTime = 0.0;
let hashComputeTime = 0.0;
//hash a list of files and return a list of strings describing said hashes (or 'x' on missing file):
async function hashFiles(files) {
const crypto = require('crypto');
//helper that will hash a single file: (non-existent files get special hash 'x')
async function hashFile(file) {
if (file in hashCache) {
hashCacheHits += 1;
return hashCache[file];
}
//would likely be more efficient to use a pipe with large files,
//but this code is a bit more readable:
const hash = await new Promise((resolve, reject) => {
const beforeLoad = performance.now();
fs.readFile(file, (err, data) => {
hashLoadTime += performance.now() - beforeLoad;
if (err) {
//if failed to read file, report hash as 'x':
if (err.code != "ENOENT") {
console.warn(`Failed to hash ${file} because of unexpected error ${err}`); //DEBUG
}
resolve(`x`);
} else {
const beforeHash = performance.now();
//otherwise, report base64-encoded md5sum of file data:
const hash = crypto.createHash('md5');
hash.update(data);
resolve(`${hash.digest('base64')}`);
hashComputeTime += performance.now() - beforeHash;
}
});
});
hashCache[file] = hash;
return hash;
}
//get all hashes:
const hashes = [];
for (let file of files) {
hashes.push(await hashFile(file));
}
return hashes;
}
//find an executable in the system path
// (used by run to figure out what to hash)
async function findExe(command) {
const osPath = require('path');
let PATH;
if (maek.OS === 'windows') {
PATH = process.env.PATH.split(';');
} else {
PATH = process.env.PATH.split(':');
}
for (const prefix of PATH) {
const exe = osPath.resolve(prefix, command[0]);
try {
await fsPromises.access(exe, fs.constants.X_OK);
return exe;
} catch (e) {
if (e.code === 'ENOENT') continue;
else throw e;
}
}
throw new BuildError(`Couldn't find file for command '${command[0]}'`);
return "?";
}
//---------------------------------------
//'update' actually runs tasks to make targets:
maek.update = async (targets) => {
const before = performance.now();
console.log(` -- Maek v0.2 on ${maek.OS} with ${maek.JOBS} max jobs updating '${targets.join("', '")}'...`);
loadCache();
process.on('SIGINT', () => {
console.log(`\x1b[91m!!! FAILED: interrupted\x1b[0m`);
saveCache();
process.exit(1);
}); //allow saving cache on abort
const tasks = maek.tasks;
//clear temporary per-task data:
for (const target in tasks) {
delete tasks[target].neededBy; //which tasks need this task
delete tasks[target].finished; //is this task finished?
delete tasks[target].failed; //has this task failed?
}
//list of all tasks to run:
const pending = [];
//add to list of tasks to run and make neededBy array:
function need(target, from) {
if (!(target in tasks)) {
//no task for the target?
if (target[0] === ':') {
//if it's abstract, that's an error:
throw new BuildError(`Target '${target}' (requested by ${from}) is abstract but doesn't have a task.`);
}
//otherwise, it's a plain file: add a task that checks it exists:
const task = async () => {
try {
await fsPromises.access(target, fs.constants.R_OK);
} catch (e) {
throw new BuildError(`Target '${target}' (requested by ${from}) doesn't exist and doesn't have a task to make it.`);
}
};
task.depends = [];
task.label = `EXISTS '${target}'`;
tasks[target] = task;
}
if ('neededBy' in tasks[target]) return;
pending.push(tasks[target]);
tasks[target].neededBy = [];
for (let depend of tasks[target].depends) {
need(depend, `'${target}'`);
tasks[depend].neededBy.push(tasks[target]);
}
}
//every requested target is needed:
for (const target of targets) {
need(target, 'user');
}
//----------------------------------
//now run up to JOBS tasks at once:
let ready = []; //tasks ready to run
let running = []; //tasks currently running
let CANCEL_ALL_TASKS = false; //skip remaining tasks?
async function launch(task) {
running.push(task);
let failedDepends = [];
for (const depend of task.depends) {
if (tasks[depend].failed) {
failedDepends.push(depend);
} else {
console.assert(tasks[depend].finished, "all depends should be failed or finished");
}
}
if (failedDepends.length) {
task.failed = true;
if (maek.VERBOSE) console.error(`!!! SKIPPED [${task.label}] because target(s) ${failedDepends.join(', ')} failed.`);
}
try {
if (!task.failed) {
await task();
task.finished = true;
}
} catch (e) {
if (e instanceof BuildError) {
console.error(`\x1b[91m!!! FAILED [${task.label}] ${e.message}\x1b[0m`);
task.failed = true;
//if -q flag is set, immediately cancel all jobs:
if (maek.QUIT_EAGERLY) {
CANCEL_ALL_TASKS = true; //set flag so jobs cancel themselves
}
} else {
//don't expect any other exceptions, but if they do arise, re-throw 'em:
throw e;
}
}
//check all neededBy for potential readiness:
for (const needed of task.neededBy) {
let allDone = true;
for (const depend of needed.depends) {
if (!(tasks[depend].finished || tasks[depend].failed)) {
allDone = false;
}
}
if (allDone) {
ready.push(needed);
}
}
//remove task from 'running' list:
let i = running.indexOf(task);
console.assert(i !== -1, "running tasks must exist within running list");
running.splice(i,1);
}
//ready up anything that can be:
for (const task of pending) {
if (task.depends.length === 0) {
ready.push(task);
}
}
//launch tasks until no more can be launched:
await new Promise((resolve,reject) => {
function pollTasks() {
//if can run something now, do so:
while (running.length < maek.JOBS && !CANCEL_ALL_TASKS && ready.length > 0) {
launch(ready.shift());
}
//if can run something eventually, keep waiting:
if (running.length > 0 || (!CANCEL_ALL_TASKS && ready.length > 0)) {
setTimeout(pollTasks, 10);
} else {
resolve(); //otherwise, finish
}
}
setImmediate(pollTasks);
});
//confirm that nothing was left hanging (dependency loop!):
let failed = false;
let skipped = [];
for (const task of pending) {
if (!(task.finished || task.failed)) {
skipped.push(task.label);
}
if (!task.finished) {
failed = true;
}
}
const after = performance.now();
if (!failed) {
console.log(` -- SUCCESS: Target(s) '${targets.join("', '")}' brought up to date in ${((after - before) / 1000.0).toFixed(3)} seconds.`);
} else {
if (skipped.length) {
if (CANCEL_ALL_TASKS) {
console.log(`!!! SKIPPED ${skipped.length} tasks because of failure above.`);
} else {
console.log(`\x1b[91m!!! FAILED: tasks ${skipped.join(', ')} were never run (circular dependancy).\x1b[0m`);
}
} else {
console.log(`\x1b[91m!!! FAILED: see error(s) above.\x1b[0m`);
}
}
//store cache to disk:
saveCache();
if (maek.VERBOSE) {
function t(ms) { return (ms / 1000.0).toFixed(3); }
console.log(`\x1b[35m -- Performance metrics:\x1b[0m`);
console.log(`\x1b[35m . hashCache ended up with ${Object.keys(hashCache).length} items and handled ${hashCacheHits} hits.\x1b[0m`);
console.log(`\x1b[35m . hashFiles spent ${t(hashLoadTime)} seconds loading and ${t(hashComputeTime)} hashing.\x1b[0m`);
console.log(`\x1b[35m . run spent ${t(runTime)} seconds running commands.\x1b[0m`);
}
return !failed;
};
//automatically call 'update' once the main body of the script has finished running:
process.nextTick(() => {
//parse the command line:
let targets = [];
for (let argi = 2; argi < process.argv.length; ++argi) {
const arg = process.argv[argi];
if (arg === '--') { //-- target target ...
//the rest of the command line is targets:
targets.push(...process.argv.slice(argi + 1));
break;
} else if (/^-j\d+$/.test(arg)) { //-jN
//set max jobs
maek.JOBS = parseInt(arg.substr(2));
} else if (arg === '-v') {
//set verbose output
maek.VERBOSE = true;
} else if (arg === '-q') {
//set quit on on first error:
maek.QUIT_EAGERLY = true;
} else if (arg.startsWith('-')) { //unrecognized option
console.error(`Unrecognized option '${arg}'.`);
process.exit(1);
} else if (!arg.startsWith('-')) { //a target name
console.log(`Added target ${arg}.`);
targets.push(arg);
}
}
if (targets.length !== 0) {
maek.TARGETS = targets;
}
if (maek.TARGETS.length === 0) {
console.warn("No targets specified on command line and no default targets.");
}
maek.update(maek.TARGETS).then((success) => {
process.exitCode = (success ? 0 : 1);
});
});
return maek;
}