2
0

amberc.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  1. /**
  2. * This is a "compiler" for Amber code.
  3. * Put the following code into compiler.js:
  4. * var amberc = require('amberc');
  5. * var compiler = new amberc.Compiler('path/to/amber');
  6. * var options = amberc.createDefaults();
  7. * // edit options entries
  8. * compiler.main(options);
  9. */
  10. var path = require('path'),
  11. fs = require('fs'),
  12. Promise = require('es6-promise').Promise,
  13. requirejs = require('requirejs');
  14. /**
  15. * AmberCompiler constructor function.
  16. * amber_dir: points to the location of an amber installation
  17. */
  18. function AmberCompiler(amber_dir) {
  19. if (amber_dir == null || !fs.existsSync(amber_dir)) {
  20. throw new Error('amber_dir needs to be a valid directory');
  21. }
  22. this.amber_dir = amber_dir;
  23. }
  24. /**
  25. * Default values.
  26. */
  27. var createDefaultConfiguration = function () {
  28. return {
  29. paths: {},
  30. configFile: null,
  31. load: [],
  32. stFiles: [],
  33. jsGlobals: [],
  34. amdNamespace: 'amber_core',
  35. compile: [],
  36. compiled: [],
  37. outputDir: undefined,
  38. verbose: false
  39. };
  40. };
  41. /**
  42. * Main function for executing the compiler.
  43. * If check_configuration_ok() returns successfully
  44. * the configuration is used to trigger the following compilation steps.
  45. */
  46. AmberCompiler.prototype.main = function (configuration, finished_callback) {
  47. console.time('Compile Time');
  48. if (configuration.amdNamespace.length === 0) {
  49. configuration.amdNamespace = 'amber_core';
  50. }
  51. console.ambercLog = console.log;
  52. if (false === configuration.verbose) {
  53. console.log = function () {
  54. };
  55. }
  56. // the evaluated compiler will be stored in this variable (see create_compiler)
  57. configuration.core = {};
  58. configuration.globals = {};
  59. configuration.amber_dir = this.amber_dir;
  60. var rjsConfig;
  61. if (configuration.configFile) {
  62. var configSrc = fs.readFileSync(configuration.configFile, "utf8");
  63. rjsConfig = (function () {
  64. var require, requirejs;
  65. requirejs = require = {
  66. config: function (x) {
  67. requirejs = require = x;
  68. }
  69. };
  70. eval(configSrc);
  71. return require;
  72. })();
  73. } else {
  74. rjsConfig = {
  75. paths: configuration.paths
  76. };
  77. }
  78. if (!rjsConfig.paths.amber) rjsConfig.paths.amber = path.join(this.amber_dir, 'support');
  79. if (!rjsConfig.paths.amber_core) rjsConfig.paths.amber_core = path.join(this.amber_dir, 'src');
  80. rjsConfig.paths['text'] = require.resolve('requirejs-text').replace(/\.js$/, "");
  81. rjsConfig.paths['amber/without-imports'] = path.join(__dirname, 'without-imports');
  82. rjsConfig.map = rjsConfig.map || {};
  83. rjsConfig.map["*"] = rjsConfig.map["*"] || {};
  84. rjsConfig.map["*"]["amber/Platform"] = "amber_core/Platform-Node";
  85. rjsConfig.nodeRequire = require;
  86. rjsConfig.context = "amberc";
  87. configuration.requirejs = requirejs.config(rjsConfig);
  88. check_configuration(configuration)
  89. .then(collect_st_files)
  90. .then(create_compiler)
  91. .then(compile)
  92. .then(category_export)
  93. .then(verify)
  94. .then(function () {
  95. console.timeEnd('Compile Time');
  96. }, function (error) {
  97. console.error(error);
  98. })
  99. .then(function () {
  100. console.log = console.ambercLog;
  101. finished_callback && finished_callback();
  102. });
  103. };
  104. /**
  105. * Check if the passed in configuration object has sufficient/nonconflicting values.
  106. * Returns a Promise which resolves into the configuration object.
  107. */
  108. function check_configuration(configuration) {
  109. return new Promise(function (resolve, reject) {
  110. if (configuration == null) {
  111. reject(Error('AmberCompiler.check_configuration_ok(): missing configuration object'));
  112. }
  113. if (0 === configuration.stFiles.length) {
  114. reject(Error('AmberCompiler.check_configuration_ok(): no files to compile specified in configuration object'));
  115. }
  116. resolve(configuration);
  117. });
  118. }
  119. /**
  120. * Check if the file given as parameter exists in any of the following directories:
  121. * 1. current local directory
  122. * 2. $AMBER/
  123. *
  124. * @param filename name of a .st file
  125. * @param configuration the main amberc configuration object
  126. */
  127. function resolve_st(filename, configuration) {
  128. return resolve_file(filename, [configuration.amber_dir]);
  129. }
  130. /**
  131. * Resolve the location of a file given as parameter filename.
  132. * First check if the file exists at given location,
  133. * then check in each of the directories specified in parameter searchDirectories.
  134. */
  135. function resolve_file(filename, searchDirectories) {
  136. return new Promise(function (resolve, reject) {
  137. console.log('Resolving: ' + filename);
  138. fs.exists(filename, function (exists) {
  139. if (exists) {
  140. resolve(filename);
  141. } else {
  142. var alternativeFile = '';
  143. // check for filename in any of the given searchDirectories
  144. var found = searchDirectories.some(function (directory) {
  145. alternativeFile = path.join(directory, filename);
  146. return fs.existsSync(alternativeFile);
  147. });
  148. if (found) {
  149. resolve(alternativeFile);
  150. } else {
  151. reject(Error('File not found: ' + alternativeFile));
  152. }
  153. }
  154. });
  155. });
  156. }
  157. /**
  158. * Resolve st files given by stFiles and add them to configuration.compile.
  159. * Returns a Promise which resolves into the configuration object.
  160. */
  161. function collect_st_files(configuration) {
  162. return Promise.all(
  163. configuration.stFiles.map(function (stFile) {
  164. return resolve_st(stFile, configuration);
  165. })
  166. )
  167. .then(function (data) {
  168. configuration.compile = configuration.compile.concat(data);
  169. return configuration;
  170. });
  171. }
  172. /**
  173. * Resolve .js files needed by compiler, read and eval() them.
  174. * The finished Compiler gets stored in configuration.{core,globals}.
  175. * Returns a Promise object which resolves into the configuration object.
  176. */
  177. function create_compiler(configuration) {
  178. var include_files = configuration.load;
  179. return new Promise(configuration.requirejs.bind(null, ["amber/lang"]))
  180. .then(function (boot) {
  181. boot.api.initialize();
  182. configuration.core = boot.api;
  183. configuration.globals = boot.globals;
  184. var pluginPrefixedLibraries = include_files.map(function (each) {
  185. return 'amber/without-imports!' + each;
  186. });
  187. return new Promise(configuration.requirejs.bind(null, pluginPrefixedLibraries));
  188. })
  189. .then(function () {
  190. console.log('Compiler loaded');
  191. configuration.globals.ErrorHandler._register_(configuration.globals.RethrowErrorHandler._new());
  192. if (0 !== configuration.jsGlobals.length) {
  193. var jsGlobalVariables = configuration.core.globalJsVariables;
  194. jsGlobalVariables.push.apply(jsGlobalVariables, configuration.jsGlobals);
  195. }
  196. return configuration;
  197. });
  198. }
  199. /**
  200. * Compile all given .st files by importing them.
  201. * Returns a Promise object that resolves into the configuration object.
  202. */
  203. function compile(configuration) {
  204. // return function which does the actual work
  205. // and use the compile function to reference the configuration object
  206. return Promise.all(
  207. configuration.compile.map(function (stFile) {
  208. return new Promise(function (resolve, reject) {
  209. if (/\.st/.test(stFile)) {
  210. console.ambercLog('Reading: ' + stFile);
  211. fs.readFile(stFile, 'utf8', function (err, data) {
  212. if (!err)
  213. resolve(data);
  214. else
  215. reject(Error('Could not read: ' + stFile));
  216. });
  217. }
  218. });
  219. })
  220. )
  221. .then(function (fileContents) {
  222. console.log('Compiling collected .st files');
  223. // import/compile content of .st files
  224. return Promise.all(
  225. fileContents.map(function (code) {
  226. return new Promise(function (resolve, reject) {
  227. var importer = configuration.globals.Importer._new();
  228. try {
  229. importer._import_(code._stream());
  230. resolve(true);
  231. } catch (ex) {
  232. reject(Error("Compiler error in section:\n" +
  233. importer._lastSection() + "\n\n" +
  234. "while processing chunk:\n" +
  235. importer._lastChunk() + "\n\n" +
  236. (ex._messageText && ex._messageText() || ex.message || ex))
  237. );
  238. }
  239. });
  240. })
  241. );
  242. })
  243. .then(function () {
  244. return configuration;
  245. });
  246. }
  247. /**
  248. * Export compiled categories to JavaScript files.
  249. * Returns a Promise() that resolves into the configuration object.
  250. */
  251. function category_export(configuration) {
  252. return Promise.all(
  253. configuration.compile.map(function (stFile) {
  254. return new Promise(function (resolve, reject) {
  255. var category = path.basename(stFile, '.st');
  256. var jsFilePath = configuration.outputDir;
  257. if (jsFilePath == null) {
  258. jsFilePath = path.dirname(stFile);
  259. }
  260. var jsFile = category + '.js';
  261. jsFile = path.join(jsFilePath, jsFile);
  262. configuration.compiled.push(jsFile);
  263. var smalltalkGlobals = configuration.globals;
  264. var packageObject = smalltalkGlobals.Package._named_(category);
  265. packageObject._transport()._namespace_(configuration.amdNamespace);
  266. fs.writeFile(jsFile, smalltalkGlobals.String._streamContents_(function (stream) {
  267. smalltalkGlobals.AmdExporter._new()._exportPackage_on_(packageObject, stream);
  268. }), function (err) {
  269. if (err)
  270. reject(err);
  271. else
  272. resolve(true);
  273. });
  274. });
  275. })
  276. )
  277. .then(function () {
  278. return configuration;
  279. });
  280. }
  281. /**
  282. * Verify if all .st files have been compiled.
  283. * Returns a Promise() that resolves into the configuration object.
  284. */
  285. function verify(configuration) {
  286. console.log('Verifying if all .st files were compiled');
  287. return Promise.all(
  288. configuration.compiled.map(function (file) {
  289. return new Promise(function (resolve, reject) {
  290. fs.exists(file, function (exists) {
  291. if (exists)
  292. resolve(true);
  293. else
  294. reject(Error('Compilation failed of: ' + file));
  295. });
  296. });
  297. })
  298. )
  299. .then(function () {
  300. return configuration;
  301. });
  302. }
  303. module.exports.Compiler = AmberCompiler;
  304. module.exports.createDefaultConfiguration = createDefaultConfiguration;