registry.js 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. import {
  2. assign,
  3. forEach,
  4. bind
  5. } from 'min-dash';
  6. import {
  7. isBuiltIn as isBuiltInType
  8. } from './types';
  9. import DescriptorBuilder from './descriptor-builder';
  10. import {
  11. parseName as parseNameNs
  12. } from './ns';
  13. /**
  14. * A registry of Moddle packages.
  15. *
  16. * @param {Array<Package>} packages
  17. * @param {Properties} properties
  18. */
  19. export default function Registry(packages, properties) {
  20. this.packageMap = {};
  21. this.typeMap = {};
  22. this.packages = [];
  23. this.properties = properties;
  24. forEach(packages, bind(this.registerPackage, this));
  25. }
  26. Registry.prototype.getPackage = function(uriOrPrefix) {
  27. return this.packageMap[uriOrPrefix];
  28. };
  29. Registry.prototype.getPackages = function() {
  30. return this.packages;
  31. };
  32. Registry.prototype.registerPackage = function(pkg) {
  33. // copy package
  34. pkg = assign({}, pkg);
  35. var pkgMap = this.packageMap;
  36. ensureAvailable(pkgMap, pkg, 'prefix');
  37. ensureAvailable(pkgMap, pkg, 'uri');
  38. // register types
  39. forEach(pkg.types, bind(function(descriptor) {
  40. this.registerType(descriptor, pkg);
  41. }, this));
  42. pkgMap[pkg.uri] = pkgMap[pkg.prefix] = pkg;
  43. this.packages.push(pkg);
  44. };
  45. /**
  46. * Register a type from a specific package with us
  47. */
  48. Registry.prototype.registerType = function(type, pkg) {
  49. type = assign({}, type, {
  50. superClass: (type.superClass || []).slice(),
  51. extends: (type.extends || []).slice(),
  52. properties: (type.properties || []).slice(),
  53. meta: assign(({}, type.meta || {}))
  54. });
  55. var ns = parseNameNs(type.name, pkg.prefix),
  56. name = ns.name,
  57. propertiesByName = {};
  58. // parse properties
  59. forEach(type.properties, bind(function(p) {
  60. // namespace property names
  61. var propertyNs = parseNameNs(p.name, ns.prefix),
  62. propertyName = propertyNs.name;
  63. // namespace property types
  64. if (!isBuiltInType(p.type)) {
  65. p.type = parseNameNs(p.type, propertyNs.prefix).name;
  66. }
  67. assign(p, {
  68. ns: propertyNs,
  69. name: propertyName
  70. });
  71. propertiesByName[propertyName] = p;
  72. }, this));
  73. // update ns + name
  74. assign(type, {
  75. ns: ns,
  76. name: name,
  77. propertiesByName: propertiesByName
  78. });
  79. forEach(type.extends, bind(function(extendsName) {
  80. var extended = this.typeMap[extendsName];
  81. extended.traits = extended.traits || [];
  82. extended.traits.push(name);
  83. }, this));
  84. // link to package
  85. this.definePackage(type, pkg);
  86. // register
  87. this.typeMap[name] = type;
  88. };
  89. /**
  90. * Traverse the type hierarchy from bottom to top,
  91. * calling iterator with (type, inherited) for all elements in
  92. * the inheritance chain.
  93. *
  94. * @param {Object} nsName
  95. * @param {Function} iterator
  96. * @param {Boolean} [trait=false]
  97. */
  98. Registry.prototype.mapTypes = function(nsName, iterator, trait) {
  99. var type = isBuiltInType(nsName.name) ? { name: nsName.name } : this.typeMap[nsName.name];
  100. var self = this;
  101. /**
  102. * Traverse the selected trait.
  103. *
  104. * @param {String} cls
  105. */
  106. function traverseTrait(cls) {
  107. return traverseSuper(cls, true);
  108. }
  109. /**
  110. * Traverse the selected super type or trait
  111. *
  112. * @param {String} cls
  113. * @param {Boolean} [trait=false]
  114. */
  115. function traverseSuper(cls, trait) {
  116. var parentNs = parseNameNs(cls, isBuiltInType(cls) ? '' : nsName.prefix);
  117. self.mapTypes(parentNs, iterator, trait);
  118. }
  119. if (!type) {
  120. throw new Error('unknown type <' + nsName.name + '>');
  121. }
  122. forEach(type.superClass, trait ? traverseTrait : traverseSuper);
  123. // call iterator with (type, inherited=!trait)
  124. iterator(type, !trait);
  125. forEach(type.traits, traverseTrait);
  126. };
  127. /**
  128. * Returns the effective descriptor for a type.
  129. *
  130. * @param {String} type the namespaced name (ns:localName) of the type
  131. *
  132. * @return {Descriptor} the resulting effective descriptor
  133. */
  134. Registry.prototype.getEffectiveDescriptor = function(name) {
  135. var nsName = parseNameNs(name);
  136. var builder = new DescriptorBuilder(nsName);
  137. this.mapTypes(nsName, function(type, inherited) {
  138. builder.addTrait(type, inherited);
  139. });
  140. var descriptor = builder.build();
  141. // define package link
  142. this.definePackage(descriptor, descriptor.allTypes[descriptor.allTypes.length - 1].$pkg);
  143. return descriptor;
  144. };
  145. Registry.prototype.definePackage = function(target, pkg) {
  146. this.properties.define(target, '$pkg', { value: pkg });
  147. };
  148. ///////// helpers ////////////////////////////
  149. function ensureAvailable(packageMap, pkg, identifierKey) {
  150. var value = pkg[identifierKey];
  151. if (value in packageMap) {
  152. throw new Error('package with ' + identifierKey + ' <' + value + '> already defined');
  153. }
  154. }