kernel-fundamentals.js 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511
  1. /* ====================================================================
  2. |
  3. | Amber Smalltalk
  4. | http://amber-lang.net
  5. |
  6. ======================================================================
  7. ======================================================================
  8. |
  9. | Copyright (c) 2010-2014
  10. | Nicolas Petton <petton.nicolas@gmail.com>
  11. |
  12. | Copyright (c) 2012-2016
  13. | The Amber team https://lolg.it/org/amber/members
  14. | Amber contributors (see /CONTRIBUTORS)
  15. |
  16. | Amber is released under the MIT license
  17. |
  18. | Permission is hereby granted, free of charge, to any person obtaining
  19. | a copy of this software and associated documentation files (the
  20. | 'Software'), to deal in the Software without restriction, including
  21. | without limitation the rights to use, copy, modify, merge, publish,
  22. | distribute, sublicense, and/or sell copies of the Software, and to
  23. | permit persons to whom the Software is furnished to do so, subject to
  24. | the following conditions:
  25. |
  26. | The above copyright notice and this permission notice shall be
  27. | included in all copies or substantial portions of the Software.
  28. |
  29. | THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
  30. | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  31. | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  32. | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  33. | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  34. | TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  35. | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  36. |
  37. ==================================================================== */
  38. //jshint eqnull:true
  39. define(['./compatibility'], function () {
  40. "use strict";
  41. function inherits (child, parent) {
  42. child.prototype = Object.create(parent.prototype, {
  43. constructor: {
  44. value: child,
  45. enumerable: false, configurable: true, writable: true
  46. }
  47. });
  48. return child;
  49. }
  50. function SmalltalkGlobalsBrik (brikz, st) {
  51. // jshint evil:true
  52. var jsGlobals = new Function("return this")();
  53. var globals = Object.create(jsGlobals);
  54. globals.SmalltalkSettings = {};
  55. this.globals = globals;
  56. }
  57. function RootBrik (brikz, st) {
  58. /* Smalltalk foundational objects */
  59. var coreFns = this.coreFns = {};
  60. /* SmalltalkRoot is the hidden root of the normal Amber hierarchy.
  61. All objects including `ProtoObject` inherit from SmalltalkRoot.
  62. Detached roots (eg. wrapped JS classes like Number or Date)
  63. do not directly inherit from SmalltalkRoot, but employ a workaround.*/
  64. function SmalltalkRoot () {
  65. }
  66. function SmalltalkProtoObject () {
  67. }
  68. function SmalltalkObject () {
  69. }
  70. coreFns.ProtoObject = inherits(SmalltalkProtoObject, SmalltalkRoot);
  71. coreFns.Object = inherits(SmalltalkObject, SmalltalkProtoObject);
  72. this.Root = SmalltalkRoot;
  73. this.Object = SmalltalkObject;
  74. }
  75. OrganizeBrik.deps = ["arraySet", "root"];
  76. function OrganizeBrik (brikz, st) {
  77. var SmalltalkObject = brikz.root.Object;
  78. var coreFns = brikz.root.coreFns;
  79. var addElement = brikz.arraySet.addElement;
  80. var removeElement = brikz.arraySet.removeElement;
  81. function SmalltalkOrganizer () {
  82. }
  83. function SmalltalkPackageOrganizer () {
  84. this.elements = [];
  85. }
  86. function SmalltalkClassOrganizer () {
  87. this.elements = [];
  88. }
  89. coreFns.Organizer = inherits(SmalltalkOrganizer, SmalltalkObject);
  90. coreFns.PackageOrganizer = inherits(SmalltalkPackageOrganizer, SmalltalkOrganizer);
  91. coreFns.ClassOrganizer = inherits(SmalltalkClassOrganizer, SmalltalkOrganizer);
  92. this.setupClassOrganization = function (behaviorBody) {
  93. behaviorBody.organization = new SmalltalkClassOrganizer();
  94. behaviorBody.organization.theClass = behaviorBody;
  95. };
  96. this.setupPackageOrganization = function (pkg) {
  97. pkg.organization = new SmalltalkPackageOrganizer();
  98. };
  99. this.addOrganizationElement = function (owner, element) {
  100. addElement(owner.organization.elements, element);
  101. };
  102. this.removeOrganizationElement = function (owner, element) {
  103. removeElement(owner.organization.elements, element);
  104. };
  105. }
  106. SelectorsBrik.deps = ["selectorConversion"];
  107. function SelectorsBrik (brikz, st) {
  108. var selectorSet = Object.create(null);
  109. var selectors = this.selectors = [];
  110. var selectorPairs = this.selectorPairs = [];
  111. this.registerSelector = function (stSelector) {
  112. if (selectorSet[stSelector]) return null;
  113. var jsSelector = st.st2js(stSelector);
  114. selectorSet[stSelector] = true;
  115. selectors.push(stSelector);
  116. var pair = {st: stSelector, js: jsSelector};
  117. selectorPairs.push(pair);
  118. return pair;
  119. };
  120. st.allSelectors = function () {
  121. return selectors;
  122. };
  123. }
  124. PackagesBrik.deps = ["organize", "root"];
  125. function PackagesBrik (brikz, st) {
  126. var setupPackageOrganization = brikz.organize.setupPackageOrganization;
  127. var SmalltalkObject = brikz.root.Object;
  128. var coreFns = brikz.root.coreFns;
  129. function SmalltalkPackage () {
  130. }
  131. coreFns.Package = inherits(SmalltalkPackage, SmalltalkObject);
  132. st.packages = {};
  133. /* Smalltalk package creation. To add a Package, use smalltalk.addPackage() */
  134. function pkg (spec) {
  135. var that = new SmalltalkPackage();
  136. that.pkgName = spec.pkgName;
  137. setupPackageOrganization(that);
  138. that.properties = spec.properties || {};
  139. return that;
  140. }
  141. /* Add a package to the system, creating a new one if needed.
  142. If pkgName is null or empty we return nil.
  143. If package already exists we still update the properties of it. */
  144. st.addPackage = function (pkgName, properties) {
  145. if (!pkgName) return null;
  146. if (!st.packages[pkgName]) {
  147. st.packages[pkgName] = pkg({
  148. pkgName: pkgName,
  149. properties: properties
  150. });
  151. } else {
  152. if (properties) {
  153. st.packages[pkgName].properties = properties;
  154. }
  155. }
  156. return st.packages[pkgName];
  157. };
  158. }
  159. BehaviorsBrik.deps = ["organize", "root", "smalltalkGlobals", "arraySet"];
  160. function BehaviorsBrik (brikz, st) {
  161. var addOrganizationElement = brikz.organize.addOrganizationElement;
  162. var removeOrganizationElement = brikz.organize.removeOrganizationElement;
  163. var globals = brikz.smalltalkGlobals.globals;
  164. var SmalltalkObject = brikz.root.Object;
  165. var coreFns = brikz.root.coreFns;
  166. var addElement = brikz.arraySet.addElement;
  167. var removeElement = brikz.arraySet.removeElement;
  168. function SmalltalkBehaviorBody () {
  169. }
  170. coreFns.BehaviorBody = inherits(SmalltalkBehaviorBody, SmalltalkObject);
  171. this.BehaviorBody = SmalltalkBehaviorBody;
  172. /* Smalltalk classes */
  173. var classes = [];
  174. this.buildBehaviorBody = function (pkgName, builder) {
  175. var pkg = st.packages[pkgName];
  176. if (!pkg) throw new Error("Missing package " + pkgName);
  177. var behaviorBody = globals.hasOwnProperty(builder.className) && globals[builder.className];
  178. if (behaviorBody) {
  179. builder.updateExisting(behaviorBody, pkg);
  180. } else {
  181. behaviorBody = builder.make(pkg);
  182. }
  183. addBehaviorBody(behaviorBody);
  184. return behaviorBody;
  185. };
  186. function addBehaviorBody (behaviorBody) {
  187. globals[behaviorBody.className] = behaviorBody;
  188. addElement(classes, behaviorBody);
  189. addOrganizationElement(behaviorBody.pkg, behaviorBody);
  190. behaviorBody.added();
  191. }
  192. function removeBehaviorBody (behaviorBody) {
  193. behaviorBody.removed();
  194. removeOrganizationElement(behaviorBody.pkg, behaviorBody);
  195. removeElement(classes, behaviorBody);
  196. delete globals[behaviorBody.className];
  197. }
  198. this.removeBehaviorBody = removeBehaviorBody;
  199. /* Create an alias for an existing class */
  200. st.alias = function (behaviorBody, alias) {
  201. globals[alias] = behaviorBody;
  202. };
  203. /* Answer all registered Smalltalk classes */
  204. //TODO: remove the function and make smalltalk.classes an array
  205. st.classes = this.classes = function () {
  206. return classes;
  207. };
  208. }
  209. MethodsBrik.deps = ["composition", "selectors", "root", "selectorConversion"];
  210. function MethodsBrik (brikz, st) {
  211. var registerSelector = brikz.selectors.registerSelector;
  212. var updateMethod = brikz.composition.updateMethod;
  213. var SmalltalkObject = brikz.root.Object;
  214. var coreFns = brikz.root.coreFns;
  215. function SmalltalkMethod () {
  216. }
  217. coreFns.CompiledMethod = inherits(SmalltalkMethod, SmalltalkObject);
  218. /* Smalltalk method object. To add a method to a class,
  219. use api.addMethod() */
  220. st.method = function (spec) {
  221. var that = new SmalltalkMethod();
  222. var selector = spec.selector;
  223. that.selector = selector;
  224. that.jsSelector = st.st2js(selector);
  225. that.args = spec.args || {};
  226. that.protocol = spec.protocol;
  227. that.source = spec.source;
  228. that.messageSends = spec.messageSends || [];
  229. that.referencedClasses = spec.referencedClasses || [];
  230. that.fn = spec.fn;
  231. return that;
  232. };
  233. /* Add/remove a method to/from a class */
  234. st.addMethod = function (method, behaviorBody) {
  235. if (method.methodClass != null) {
  236. throw new Error("addMethod: Method " + method.selector + " already bound to " + method.methodClass);
  237. }
  238. method.methodClass = behaviorBody;
  239. registerNewSelectors(method);
  240. behaviorBody.localMethods[method.selector] = method;
  241. updateMethod(method.selector, behaviorBody);
  242. };
  243. function registerNewSelectors (method) {
  244. var newSelectors = [];
  245. function selectorInUse (stSelector) {
  246. var pair = registerSelector(stSelector);
  247. if (pair) {
  248. newSelectors.push(pair);
  249. }
  250. }
  251. selectorInUse(method.selector);
  252. method.messageSends.forEach(selectorInUse);
  253. if (st._selectorsAdded) st._selectorsAdded(newSelectors);
  254. }
  255. st.removeMethod = function (method, behaviorBody) {
  256. if (behaviorBody.localMethods[method.selector] !== method) return;
  257. delete behaviorBody.localMethods[method.selector];
  258. updateMethod(method.selector, behaviorBody);
  259. };
  260. }
  261. MethodCompositionBrik.deps = ["organize"];
  262. function MethodCompositionBrik (brikz, st) {
  263. var setupClassOrganization = brikz.organize.setupClassOrganization;
  264. var addOrganizationElement = brikz.organize.addOrganizationElement;
  265. this.setupMethods = function (behaviorBody) {
  266. setupClassOrganization(behaviorBody);
  267. behaviorBody.traitComposition = [];
  268. behaviorBody.localMethods = Object.create(null);
  269. behaviorBody.methods = Object.create(null);
  270. };
  271. function addMethod (method, behaviorBody) {
  272. behaviorBody.methods[method.selector] = method;
  273. // During the bootstrap, #addCompiledMethod is not used.
  274. // Therefore we populate the organizer here too
  275. addOrganizationElement(behaviorBody, method.protocol);
  276. behaviorBody.methodAdded(method);
  277. }
  278. function removeMethod (method, behaviorBody) {
  279. delete behaviorBody.methods[method.selector];
  280. behaviorBody.methodRemoved(method);
  281. // Do *not* delete protocols from here.
  282. // This is handled by #removeCompiledMethod
  283. }
  284. function applyTraitTransformation (traitTransformation, obj) {
  285. var traitMethods = traitTransformation.trait.methods;
  286. Object.keys(traitMethods).forEach(function (selector) {
  287. obj[selector] = traitMethods[selector];
  288. });
  289. var traitAliases = traitTransformation.aliases || {};
  290. Object.keys(traitAliases).forEach(function (aliasSelector) {
  291. var aliasedMethod = traitMethods[traitAliases[aliasSelector]];
  292. if (aliasedMethod) obj[aliasSelector] = aliasedMethod;
  293. });
  294. var traitExclusions = traitExclusions || [];
  295. traitExclusions.forEach(function (selector) {
  296. delete obj[selector];
  297. });
  298. return obj;
  299. }
  300. function buildCompositionChain (traitComposition) {
  301. return traitComposition.reduce(function (soFar, each) {
  302. return applyTraitTransformation(each, Object.create(soFar));
  303. }, null);
  304. }
  305. st.setTraitComposition = function (traitComposition, behaviorBody) {
  306. var oldLocalMethods = behaviorBody.localMethods,
  307. newLocalMethods = Object.create(buildCompositionChain(traitComposition));
  308. Object.keys(oldLocalMethods).forEach(function (selector) {
  309. newLocalMethods[selector] = oldLocalMethods[selector];
  310. });
  311. behaviorBody.localMethods = newLocalMethods;
  312. for (var selector in newLocalMethods) {
  313. updateMethod(selector, behaviorBody);
  314. }
  315. for (var selector in oldLocalMethods) {
  316. updateMethod(selector, behaviorBody);
  317. }
  318. behaviorBody.traitComposition.forEach(function (each) {
  319. each.trait.removeUser(behaviorBody);
  320. });
  321. behaviorBody.traitComposition = traitComposition;
  322. behaviorBody.traitComposition.forEach(function (each) {
  323. each.trait.addUser(behaviorBody);
  324. });
  325. };
  326. function updateMethod (selector, behaviorBody) {
  327. var oldMethod = behaviorBody.methods[selector],
  328. newMethod = behaviorBody.localMethods[selector];
  329. if (oldMethod == null && newMethod == null) {
  330. console.warn("Removal of nonexistent method " + behaviorBody + " >> " + selector);
  331. return;
  332. }
  333. if (newMethod === oldMethod) return;
  334. if (newMethod != null) addMethod(newMethod, behaviorBody);
  335. else removeMethod(oldMethod, behaviorBody);
  336. }
  337. this.updateMethod = updateMethod;
  338. }
  339. function ArraySetBrik (brikz, st) {
  340. st.addElement = this.addElement = function (array, el) {
  341. if (typeof el === 'undefined') {
  342. return;
  343. }
  344. if (array.indexOf(el) === -1) {
  345. array.push(el);
  346. }
  347. };
  348. st.removeElement = this.removeElement = function (array, el) {
  349. var i = array.indexOf(el);
  350. if (i !== -1) {
  351. array.splice(i, 1);
  352. }
  353. };
  354. }
  355. function SelectorConversionBrik (brikz, st) {
  356. /* Convert a Smalltalk selector into a JS selector */
  357. st.st2js = function (string) {
  358. return '_' + string
  359. .replace(/:/g, '_')
  360. .replace(/[\&]/g, '_and')
  361. .replace(/[\|]/g, '_or')
  362. .replace(/[+]/g, '_plus')
  363. .replace(/-/g, '_minus')
  364. .replace(/[*]/g, '_star')
  365. .replace(/[\/]/g, '_slash')
  366. .replace(/[\\]/g, '_backslash')
  367. .replace(/[\~]/g, '_tild')
  368. .replace(/%/g, '_percent')
  369. .replace(/>/g, '_gt')
  370. .replace(/</g, '_lt')
  371. .replace(/=/g, '_eq')
  372. .replace(/,/g, '_comma')
  373. .replace(/[@]/g, '_at');
  374. };
  375. /* Convert a string to a valid smalltalk selector.
  376. if you modify the following functions, also change st2js
  377. accordingly */
  378. st.js2st = function (selector) {
  379. if (selector.match(/^__/)) {
  380. return binaryJsToSt(selector);
  381. } else {
  382. return keywordJsToSt(selector);
  383. }
  384. };
  385. function keywordJsToSt (selector) {
  386. return selector.replace(/^_/, '').replace(/_/g, ':');
  387. }
  388. function binaryJsToSt (selector) {
  389. return selector
  390. .replace(/^_/, '')
  391. .replace(/_and/g, '&')
  392. .replace(/_or/g, '|')
  393. .replace(/_plus/g, '+')
  394. .replace(/_minus/g, '-')
  395. .replace(/_star/g, '*')
  396. .replace(/_slash/g, '/')
  397. .replace(/_backslash/g, '\\')
  398. .replace(/_tild/g, '~')
  399. .replace(/_percent/g, '%')
  400. .replace(/_gt/g, '>')
  401. .replace(/_lt/g, '<')
  402. .replace(/_eq/g, '=')
  403. .replace(/_comma/g, ',')
  404. .replace(/_at/g, '@');
  405. }
  406. st.st2prop = function (stSelector) {
  407. var colonPosition = stSelector.indexOf(':');
  408. return colonPosition === -1 ? stSelector : stSelector.slice(0, colonPosition);
  409. };
  410. }
  411. /* Making smalltalk that has basic building blocks */
  412. function configureWithFundamentals (brikz) {
  413. brikz.smalltalkGlobals = SmalltalkGlobalsBrik;
  414. brikz.root = RootBrik;
  415. brikz.arraySet = ArraySetBrik;
  416. brikz.organize = OrganizeBrik;
  417. brikz.selectorConversion = SelectorConversionBrik;
  418. brikz.selectors = SelectorsBrik;
  419. brikz.packages = PackagesBrik;
  420. brikz.composition = MethodCompositionBrik;
  421. brikz.behaviors = BehaviorsBrik;
  422. brikz.methods = MethodsBrik;
  423. brikz.rebuild();
  424. }
  425. return configureWithFundamentals;
  426. });