Kernel-ImportExport.st 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950
  1. Smalltalk createPackage: 'Kernel-ImportExport'!
  2. Object subclass: #AbstractExporter
  3. instanceVariableNames: ''
  4. package: 'Kernel-ImportExport'!
  5. !AbstractExporter commentStamp!
  6. I am an abstract exporter for Amber source code.
  7. ## API
  8. Use `#exportPackage:on:` to export a given package on a Stream.!
  9. !AbstractExporter methodsFor: 'accessing'!
  10. extensionMethodsOfPackage: aPackage
  11. | result |
  12. result := OrderedCollection new.
  13. (self extensionProtocolsOfPackage: aPackage) do: [ :each |
  14. result addAll: each methods ].
  15. ^ result
  16. !
  17. extensionProtocolsOfPackage: aPackage
  18. | extensionName result |
  19. extensionName := '*', aPackage name.
  20. result := OrderedCollection new.
  21. "The classes must be loaded since it is extensions only.
  22. Therefore topological sorting (dependency resolution) does not matter here.
  23. Not sorting topologically improves the speed by a number of magnitude.
  24. Not to shuffle diffs, classes are sorted by their name."
  25. (Smalltalk classes asArray sorted: [ :a :b | a name < b name ]) do: [ :each |
  26. {each. each class} do: [ :behavior |
  27. (behavior protocols includes: extensionName) ifTrue: [
  28. result add: (ExportMethodProtocol name: extensionName theClass: behavior) ] ] ].
  29. ^ result
  30. ! !
  31. !AbstractExporter methodsFor: 'convenience'!
  32. chunkEscape: aString
  33. "Replace all occurrences of !! with !!!! and trim at both ends."
  34. ^ (aString replace: '!!' with: '!!!!') trimBoth
  35. !
  36. classNameFor: aClass
  37. ^ aClass isMetaclass
  38. ifTrue: [ aClass instanceClass name, ' class' ]
  39. ifFalse: [
  40. aClass isNil
  41. ifTrue: [ 'nil' ]
  42. ifFalse: [ aClass name ] ]
  43. ! !
  44. !AbstractExporter methodsFor: 'output'!
  45. exportPackage: aPackage on: aStream
  46. self subclassResponsibility
  47. ! !
  48. AbstractExporter subclass: #ChunkExporter
  49. instanceVariableNames: ''
  50. package: 'Kernel-ImportExport'!
  51. !ChunkExporter commentStamp!
  52. I am an exporter dedicated to outputting Amber source code in the classic Smalltalk chunk format.
  53. I do not output any compiled code.!
  54. !ChunkExporter methodsFor: 'accessing'!
  55. extensionCategoriesOfPackage: aPackage
  56. "Issue #143: sort protocol alphabetically"
  57. | name map result |
  58. name := aPackage name.
  59. result := OrderedCollection new.
  60. (Package sortedClasses: Smalltalk classes) do: [ :each |
  61. {each. each class} do: [ :aClass |
  62. map := Dictionary new.
  63. aClass protocolsDo: [ :category :methods |
  64. category = ('*', name) ifTrue: [ map at: category put: methods ] ].
  65. result addAll: ((map keys sorted: [ :a :b | a <= b ]) collect: [ :category |
  66. MethodCategory name: category theClass: aClass methods: (map at: category) ]) ] ].
  67. ^ result
  68. !
  69. ownCategoriesOfClass: aClass
  70. "Answer the protocols of aClass that are not package extensions"
  71. "Issue #143: sort protocol alphabetically"
  72. | map |
  73. map := Dictionary new.
  74. aClass protocolsDo: [ :each :methods |
  75. (each match: '^\*') ifFalse: [ map at: each put: methods ] ].
  76. ^ (map keys sorted: [ :a :b | a <= b ]) collect: [ :each |
  77. MethodCategory name: each theClass: aClass methods: (map at: each) ]
  78. !
  79. ownCategoriesOfMetaClass: aClass
  80. "Issue #143: sort protocol alphabetically"
  81. ^ self ownCategoriesOfClass: aClass class
  82. !
  83. ownMethodProtocolsOfClass: aClass
  84. "Answer a collection of ExportMethodProtocol object of aClass that are not package extensions"
  85. ^ aClass ownProtocols collect: [ :each |
  86. ExportMethodProtocol name: each theClass: aClass ]
  87. ! !
  88. !ChunkExporter methodsFor: 'output'!
  89. exportCategoryEpilogueOf: aCategory on: aStream
  90. aStream nextPutAll: ' !!'; lf; lf
  91. !
  92. exportCategoryPrologueOf: aCategory on: aStream
  93. aStream
  94. nextPutAll: '!!', (self classNameFor: aCategory theClass);
  95. nextPutAll: ' methodsFor: ''', aCategory name, '''!!'
  96. !
  97. exportDefinitionOf: aClass on: aStream
  98. "Chunk format."
  99. aStream
  100. nextPutAll: (self classNameFor: aClass superclass);
  101. nextPutAll: ' subclass: #', (self classNameFor: aClass); lf;
  102. tab; nextPutAll: 'instanceVariableNames: '''.
  103. aClass instanceVariableNames
  104. do: [ :each | aStream nextPutAll: each ]
  105. separatedBy: [ aStream nextPutAll: ' ' ].
  106. aStream
  107. nextPutAll: ''''; lf;
  108. tab; nextPutAll: 'package: ''', aClass category, '''!!'; lf.
  109. aClass comment notEmpty ifTrue: [
  110. aStream
  111. nextPutAll: '!!', (self classNameFor: aClass), ' commentStamp!!';lf;
  112. nextPutAll: (self chunkEscape: aClass comment), '!!';lf ].
  113. aStream lf
  114. !
  115. exportMetaDefinitionOf: aClass on: aStream
  116. aClass class instanceVariableNames isEmpty ifFalse: [
  117. aStream
  118. nextPutAll: (self classNameFor: aClass class);
  119. nextPutAll: ' instanceVariableNames: '''.
  120. aClass class instanceVariableNames
  121. do: [ :each | aStream nextPutAll: each ]
  122. separatedBy: [ aStream nextPutAll: ' ' ].
  123. aStream
  124. nextPutAll: '''!!'; lf; lf ]
  125. !
  126. exportMethod: aMethod on: aStream
  127. aStream
  128. lf; lf; nextPutAll: (self chunkEscape: aMethod source); lf;
  129. nextPutAll: '!!'
  130. !
  131. exportPackage: aPackage on: aStream
  132. self exportPackageDefinitionOf: aPackage on: aStream.
  133. aPackage sortedClasses do: [ :each |
  134. self exportDefinitionOf: each on: aStream.
  135. self
  136. exportProtocols: (self ownMethodProtocolsOfClass: each)
  137. on: aStream.
  138. self exportMetaDefinitionOf: each on: aStream.
  139. self
  140. exportProtocols: (self ownMethodProtocolsOfClass: each class)
  141. on: aStream ].
  142. self
  143. exportProtocols: (self extensionProtocolsOfPackage: aPackage)
  144. on: aStream
  145. !
  146. exportPackageDefinitionOf: aPackage on: aStream
  147. aStream
  148. nextPutAll: 'Smalltalk createPackage: ''', aPackage name, '''!!';
  149. lf
  150. !
  151. exportProtocol: aProtocol on: aStream
  152. self exportProtocolPrologueOf: aProtocol on: aStream.
  153. aProtocol methods do: [ :method |
  154. self exportMethod: method on: aStream ].
  155. self exportProtocolEpilogueOf: aProtocol on: aStream
  156. !
  157. exportProtocolEpilogueOf: aProtocol on: aStream
  158. aStream nextPutAll: ' !!'; lf; lf
  159. !
  160. exportProtocolPrologueOf: aProtocol on: aStream
  161. aStream
  162. nextPutAll: '!!', (self classNameFor: aProtocol theClass);
  163. nextPutAll: ' methodsFor: ''', aProtocol name, '''!!'
  164. !
  165. exportProtocols: aCollection on: aStream
  166. aCollection do: [ :each |
  167. self exportProtocol: each on: aStream ]
  168. ! !
  169. AbstractExporter subclass: #Exporter
  170. instanceVariableNames: ''
  171. package: 'Kernel-ImportExport'!
  172. !Exporter commentStamp!
  173. I am responsible for outputting Amber code into a JavaScript string.
  174. The generated output is enough to reconstruct the exported data, including Smalltalk source code and other metadata.
  175. ## Use case
  176. I am typically used to save code outside of the Amber runtime (committing to disk, etc.).!
  177. !Exporter methodsFor: 'accessing'!
  178. ownMethodsOfClass: aClass
  179. "Issue #143: sort methods alphabetically"
  180. ^ ((aClass methodDictionary values) sorted: [ :a :b | a selector <= b selector ])
  181. reject: [ :each | (each protocol match: '^\*') ]
  182. !
  183. ownMethodsOfMetaClass: aClass
  184. "Issue #143: sort methods alphabetically"
  185. ^ self ownMethodsOfClass: aClass class
  186. ! !
  187. !Exporter methodsFor: 'convenience'!
  188. classNameFor: aClass
  189. ^ aClass isMetaclass
  190. ifTrue: [ aClass instanceClass name, '.klass' ]
  191. ifFalse: [
  192. aClass isNil
  193. ifTrue: [ 'nil' ]
  194. ifFalse: [ aClass name ] ]
  195. ! !
  196. !Exporter methodsFor: 'output'!
  197. exportDefinitionOf: aClass on: aStream
  198. aStream
  199. lf;
  200. nextPutAll: 'smalltalk.addClass(';
  201. nextPutAll: '''', (self classNameFor: aClass), ''', ';
  202. nextPutAll: 'globals.', (self classNameFor: aClass superclass);
  203. nextPutAll: ', ['.
  204. aClass instanceVariableNames
  205. do: [ :each | aStream nextPutAll: '''', each, '''' ]
  206. separatedBy: [ aStream nextPutAll: ', ' ].
  207. aStream
  208. nextPutAll: '], ''';
  209. nextPutAll: aClass category, '''';
  210. nextPutAll: ');'.
  211. aClass comment notEmpty ifTrue: [
  212. aStream
  213. lf;
  214. nextPutAll: 'globals.';
  215. nextPutAll: (self classNameFor: aClass);
  216. nextPutAll: '.comment=';
  217. nextPutAll: aClass comment asJavascript;
  218. nextPutAll: ';' ].
  219. aStream lf
  220. !
  221. exportMetaDefinitionOf: aClass on: aStream
  222. aStream lf.
  223. aClass class instanceVariableNames isEmpty ifFalse: [
  224. aStream
  225. nextPutAll: 'globals.', (self classNameFor: aClass class);
  226. nextPutAll: '.iVarNames = ['.
  227. aClass class instanceVariableNames
  228. do: [ :each | aStream nextPutAll: '''', each, '''' ]
  229. separatedBy: [ aStream nextPutAll: ',' ].
  230. aStream nextPutAll: '];', String lf ]
  231. !
  232. exportMethod: aMethod on: aStream
  233. aStream
  234. nextPutAll: 'smalltalk.addMethod(';lf;
  235. "nextPutAll: aMethod selector asSelector asJavascript, ',';lf;"
  236. nextPutAll: 'smalltalk.method({';lf;
  237. nextPutAll: 'selector: ', aMethod selector asJavascript, ',';lf;
  238. nextPutAll: 'protocol: ''', aMethod protocol, ''',';lf;
  239. nextPutAll: 'fn: ', aMethod fn compiledSource, ',';lf;
  240. nextPutAll: 'args: ', aMethod arguments asJavascript, ','; lf;
  241. nextPutAll: 'source: ', aMethod source asJavascript, ',';lf;
  242. nextPutAll: 'messageSends: ', aMethod messageSends asJavascript, ',';lf;
  243. nextPutAll: 'referencedClasses: ', aMethod referencedClasses asJavascript.
  244. aStream
  245. lf;
  246. nextPutAll: '}),';lf;
  247. nextPutAll: 'globals.', (self classNameFor: aMethod methodClass);
  248. nextPutAll: ');';lf;lf
  249. !
  250. exportPackage: aPackage on: aStream
  251. self
  252. exportPackagePrologueOf: aPackage on: aStream;
  253. exportPackageDefinitionOf: aPackage on: aStream;
  254. exportPackageTransportOf: aPackage on: aStream.
  255. aPackage sortedClasses do: [ :each |
  256. self exportDefinitionOf: each on: aStream.
  257. each ownMethods do: [ :method |
  258. self exportMethod: method on: aStream ].
  259. self exportMetaDefinitionOf: each on: aStream.
  260. each class ownMethods do: [ :method |
  261. self exportMethod: method on: aStream ] ].
  262. (self extensionMethodsOfPackage: aPackage) do: [ :each |
  263. self exportMethod: each on: aStream ].
  264. self exportPackageEpilogueOf: aPackage on: aStream
  265. !
  266. exportPackageDefinitionOf: aPackage on: aStream
  267. aStream
  268. nextPutAll: 'smalltalk.addPackage(';
  269. nextPutAll: '''', aPackage name, ''');';
  270. lf
  271. !
  272. exportPackageEpilogueOf: aPackage on: aStream
  273. aStream
  274. nextPutAll: '})(global_smalltalk,global_nil,global__st);';
  275. lf
  276. !
  277. exportPackagePrologueOf: aPackage on: aStream
  278. aStream
  279. nextPutAll: '(function(smalltalk,nil,_st){';
  280. lf
  281. !
  282. exportPackageTransportOf: aPackage on: aStream
  283. aStream
  284. nextPutAll: 'smalltalk.packages[';
  285. nextPutAll: aPackage name asJavascript;
  286. nextPutAll: '].transport = ';
  287. nextPutAll: aPackage transport asJSONString;
  288. nextPutAll: ';';
  289. lf
  290. ! !
  291. Exporter subclass: #AmdExporter
  292. instanceVariableNames: 'namespace'
  293. package: 'Kernel-ImportExport'!
  294. !AmdExporter commentStamp!
  295. I am used to export Packages in an AMD (Asynchronous Module Definition) JavaScript format.!
  296. !AmdExporter methodsFor: 'output'!
  297. exportPackageEpilogueOf: aPackage on: aStream
  298. aStream
  299. nextPutAll: '});';
  300. lf
  301. !
  302. exportPackagePrologueOf: aPackage on: aStream
  303. aStream
  304. nextPutAll: 'define("';
  305. nextPutAll: (self amdNamespaceOfPackage: aPackage);
  306. nextPutAll: '/';
  307. nextPutAll: aPackage name;
  308. nextPutAll: '", ';
  309. nextPutAll: (#('amber/boot'), (self amdNamesOfPackages: aPackage loadDependencies)) asJavascript;
  310. nextPutAll: ', function($boot){';
  311. lf;
  312. nextPutAll: 'var smalltalk=$boot.vm,nil=$boot.nil,_st=$boot.asReceiver,globals=$boot.globals;';
  313. lf
  314. ! !
  315. !AmdExporter methodsFor: 'private'!
  316. amdNamesOfPackages: anArray
  317. ^ (anArray
  318. select: [ :each | (self amdNamespaceOfPackage: each) notNil ])
  319. collect: [ :each | (self amdNamespaceOfPackage: each), '/', each name ]
  320. !
  321. amdNamespaceOfPackage: aPackage
  322. ^ (aPackage transport type = 'amd')
  323. ifTrue: [ aPackage transport namespace ]
  324. ifFalse: [ nil ]
  325. ! !
  326. Object subclass: #ChunkParser
  327. instanceVariableNames: 'stream last'
  328. package: 'Kernel-ImportExport'!
  329. !ChunkParser commentStamp!
  330. I am responsible for parsing aStream contents in the chunk format.
  331. ## API
  332. ChunkParser new
  333. stream: aStream;
  334. nextChunk!
  335. !ChunkParser methodsFor: 'accessing'!
  336. last
  337. ^ last
  338. !
  339. stream: aStream
  340. stream := aStream
  341. ! !
  342. !ChunkParser methodsFor: 'reading'!
  343. nextChunk
  344. "The chunk format (Smalltalk Interchange Format or Fileout format)
  345. is a trivial format but can be a bit tricky to understand:
  346. - Uses the exclamation mark as delimiter of chunks.
  347. - Inside a chunk a normal exclamation mark must be doubled.
  348. - A non empty chunk must be a valid Smalltalk expression.
  349. - A chunk on top level with a preceding empty chunk is an instruction chunk:
  350. - The object created by the expression then takes over reading chunks.
  351. This method returns next chunk as a String (trimmed), empty String (all whitespace) or nil."
  352. | char result chunk |
  353. result := '' writeStream.
  354. [ char := stream next.
  355. char notNil ] whileTrue: [
  356. char = '!!' ifTrue: [
  357. stream peek = '!!'
  358. ifTrue: [ stream next "skipping the escape double" ]
  359. ifFalse: [ ^ last := result contents trimBoth "chunk end marker found" ]].
  360. result nextPut: char ].
  361. ^ last := nil "a chunk needs to end with !!"
  362. ! !
  363. !ChunkParser class methodsFor: 'instance creation'!
  364. on: aStream
  365. ^ self new stream: aStream
  366. ! !
  367. Object subclass: #ExportMethodProtocol
  368. instanceVariableNames: 'name theClass'
  369. package: 'Kernel-ImportExport'!
  370. !ExportMethodProtocol commentStamp!
  371. I am an abstraction for a method protocol in a class / metaclass.
  372. I know of my class, name and methods.
  373. I am used when exporting a package.!
  374. !ExportMethodProtocol methodsFor: 'accessing'!
  375. methods
  376. ^ (self theClass methodsInProtocol: self name)
  377. sorted: [ :a :b | a selector <= b selector ]
  378. !
  379. name
  380. ^ name
  381. !
  382. name: aString
  383. name := aString
  384. !
  385. theClass
  386. ^ theClass
  387. !
  388. theClass: aClass
  389. theClass := aClass
  390. ! !
  391. !ExportMethodProtocol class methodsFor: 'instance creation'!
  392. name: aString theClass: aClass
  393. ^ self new
  394. name: aString;
  395. theClass: aClass;
  396. yourself
  397. ! !
  398. Object subclass: #Importer
  399. instanceVariableNames: 'lastSection lastChunk'
  400. package: 'Kernel-ImportExport'!
  401. !Importer commentStamp!
  402. I can import Amber code from a string in the chunk format.
  403. ## API
  404. Importer new import: aString!
  405. !Importer methodsFor: 'accessing'!
  406. lastChunk
  407. ^ lastChunk
  408. !
  409. lastSection
  410. ^ lastSection
  411. ! !
  412. !Importer methodsFor: 'fileIn'!
  413. import: aStream
  414. | chunk result parser lastEmpty |
  415. parser := ChunkParser on: aStream.
  416. lastEmpty := false.
  417. lastSection := 'n/a, not started'.
  418. lastChunk := nil.
  419. [
  420. [ chunk := parser nextChunk.
  421. chunk isNil ] whileFalse: [
  422. chunk isEmpty
  423. ifTrue: [ lastEmpty := true ]
  424. ifFalse: [
  425. lastSection := chunk.
  426. result := Compiler new evaluateExpression: chunk.
  427. lastEmpty
  428. ifTrue: [
  429. lastEmpty := false.
  430. result scanFrom: parser ]] ].
  431. lastSection := 'n/a, finished'
  432. ] on: Error do: [:e | lastChunk := parser last. e signal ].
  433. ! !
  434. InterfacingObject subclass: #PackageHandler
  435. instanceVariableNames: ''
  436. package: 'Kernel-ImportExport'!
  437. !PackageHandler commentStamp!
  438. I am responsible for handling package loading and committing.
  439. I should not be used directly. Instead, use the corresponding `Package` methods.!
  440. !PackageHandler methodsFor: 'accessing'!
  441. chunkContentsFor: aPackage
  442. ^ String streamContents: [ :str |
  443. self chunkExporter exportPackage: aPackage on: str ]
  444. !
  445. chunkExporterClass
  446. ^ ChunkExporter
  447. !
  448. commitPathJsFor: aPackage
  449. self subclassResponsibility
  450. !
  451. commitPathStFor: aPackage
  452. self subclassResponsibility
  453. !
  454. contentsFor: aPackage
  455. ^ String streamContents: [ :str |
  456. self exporter exportPackage: aPackage on: str ]
  457. !
  458. exporterClass
  459. ^ Exporter
  460. ! !
  461. !PackageHandler methodsFor: 'committing'!
  462. commit: aPackage
  463. self
  464. commit: aPackage
  465. onSuccess: []
  466. onError: [ :error |
  467. PackageCommitError new
  468. messageText: 'Commiting failed with reason: "' , (error responseText) , '"';
  469. signal ]
  470. !
  471. commit: aPackage onSuccess: aBlock onError: anotherBlock
  472. self
  473. commitJsFileFor: aPackage
  474. onSuccess: [
  475. self
  476. commitStFileFor: aPackage
  477. onSuccess: [ aPackage beClean. aBlock value ]
  478. onError: anotherBlock ]
  479. onError: anotherBlock
  480. !
  481. commitJsFileFor: aPackage onSuccess: aBlock onError: anotherBlock
  482. self
  483. ajaxPutAt: (self commitPathJsFor: aPackage), '/', aPackage name, '.js'
  484. data: (self contentsFor: aPackage)
  485. onSuccess: aBlock
  486. onError: anotherBlock
  487. !
  488. commitStFileFor: aPackage onSuccess: aBlock onError: anotherBlock
  489. self
  490. ajaxPutAt: (self commitPathStFor: aPackage), '/', aPackage name, '.st'
  491. data: (self chunkContentsFor: aPackage)
  492. onSuccess: aBlock
  493. onError: anotherBlock
  494. ! !
  495. !PackageHandler methodsFor: 'error handling'!
  496. onCommitError: anError
  497. PackageCommitError new
  498. messageText: 'Commiting failed with reason: "' , (anError responseText) , '"';
  499. signal
  500. ! !
  501. !PackageHandler methodsFor: 'factory'!
  502. chunkExporter
  503. ^ self chunkExporterClass new
  504. !
  505. exporter
  506. ^ self exporterClass new
  507. ! !
  508. !PackageHandler methodsFor: 'loading'!
  509. load: aPackage
  510. self subclassResponsibility
  511. ! !
  512. !PackageHandler methodsFor: 'private'!
  513. ajaxPutAt: aURL data: aString onSuccess: aBlock onError: anotherBlock
  514. self
  515. ajax: #{
  516. 'url' -> aURL.
  517. 'type' -> 'PUT'.
  518. 'data' -> aString.
  519. 'contentType' -> 'text/plain;charset=UTF-8'.
  520. 'success' -> aBlock.
  521. 'error' -> anotherBlock
  522. }
  523. ! !
  524. PackageHandler subclass: #AmdPackageHandler
  525. instanceVariableNames: ''
  526. package: 'Kernel-ImportExport'!
  527. !AmdPackageHandler commentStamp!
  528. I am responsible for handling package loading and committing.
  529. I should not be used directly. Instead, use the corresponding `Package` methods.!
  530. !AmdPackageHandler methodsFor: 'accessing'!
  531. commitPathJsFor: aPackage
  532. ^ self toUrl: (self namespaceFor: aPackage)
  533. !
  534. commitPathStFor: aPackage
  535. "If _source is not mapped, .st will be committed to .js path.
  536. It is recommended not to use _source as it can be deprecated."
  537. | path pathWithout |
  538. path := self toUrl: (self namespaceFor: aPackage), '/_source'.
  539. pathWithout := self commitPathJsFor: aPackage.
  540. ^ path = (pathWithout, '/_source') ifTrue: [ pathWithout ] ifFalse: [ path ]
  541. !
  542. exporterClass
  543. ^ AmdExporter
  544. ! !
  545. !AmdPackageHandler methodsFor: 'committing'!
  546. namespaceFor: aPackage
  547. ^ aPackage transport namespace
  548. ! !
  549. !AmdPackageHandler methodsFor: 'loading'!
  550. load: aPackage
  551. Smalltalk amdRequire
  552. ifNil: [ self error: 'AMD loader not present' ]
  553. ifNotNil: [ :require |
  554. require value: (Array new: (self namespaceFor: aPackage), '/', aPackage name ) ]
  555. ! !
  556. !AmdPackageHandler methodsFor: 'private'!
  557. toUrl: aString
  558. ^ Smalltalk amdRequire
  559. ifNil: [ self error: 'AMD loader not present' ]
  560. ifNotNil: [ :require | (require basicAt: 'toUrl') value: aString ]
  561. ! !
  562. !AmdPackageHandler class methodsFor: 'commit paths'!
  563. defaultNamespace
  564. ^ Smalltalk defaultAmdNamespace
  565. !
  566. defaultNamespace: aString
  567. Smalltalk defaultAmdNamespace: aString
  568. ! !
  569. Object subclass: #PackageTransport
  570. instanceVariableNames: 'package'
  571. package: 'Kernel-ImportExport'!
  572. !PackageTransport commentStamp!
  573. I represent the transport mechanism used to commit a package.
  574. My concrete subclasses have a `#handler` to which committing is delegated.!
  575. !PackageTransport methodsFor: 'accessing'!
  576. commitHandlerClass
  577. self subclassResponsibility
  578. !
  579. definition
  580. ^ ''
  581. !
  582. package
  583. ^ package
  584. !
  585. package: aPackage
  586. package := aPackage
  587. !
  588. type
  589. ^ self class type
  590. ! !
  591. !PackageTransport methodsFor: 'committing'!
  592. commit
  593. self commitHandler commit: self package
  594. !
  595. commitOnSuccess: aBlock onError: anotherBlock
  596. self commitHandler
  597. commit: self package
  598. onSuccess: aBlock
  599. onError: anotherBlock
  600. ! !
  601. !PackageTransport methodsFor: 'converting'!
  602. asJSON
  603. ^ #{ 'type' -> self type }
  604. ! !
  605. !PackageTransport methodsFor: 'factory'!
  606. commitHandler
  607. ^ self commitHandlerClass new
  608. ! !
  609. !PackageTransport methodsFor: 'initialization'!
  610. setupFromJson: anObject
  611. "no op. override if needed in subclasses"
  612. ! !
  613. !PackageTransport methodsFor: 'loading'!
  614. load
  615. self commitHandler load: self package
  616. ! !
  617. PackageTransport class instanceVariableNames: 'registry'!
  618. !PackageTransport class methodsFor: 'accessing'!
  619. classRegisteredFor: aString
  620. ^ registry at: aString
  621. !
  622. defaultType
  623. ^ AmdPackageTransport type
  624. !
  625. type
  626. "Override in subclasses"
  627. ^ nil
  628. ! !
  629. !PackageTransport class methodsFor: 'initialization'!
  630. initialize
  631. super initialize.
  632. registry := #{}.
  633. self register
  634. ! !
  635. !PackageTransport class methodsFor: 'instance creation'!
  636. for: aString
  637. ^ (self classRegisteredFor: aString) new
  638. !
  639. fromJson: anObject
  640. anObject ifNil: [ ^ self for: self defaultType ].
  641. ^ (self for: anObject type)
  642. setupFromJson: anObject;
  643. yourself
  644. ! !
  645. !PackageTransport class methodsFor: 'registration'!
  646. register
  647. PackageTransport register: self
  648. !
  649. register: aClass
  650. aClass type ifNotNil: [
  651. registry at: aClass type put: aClass ]
  652. ! !
  653. PackageTransport subclass: #AmdPackageTransport
  654. instanceVariableNames: 'namespace'
  655. package: 'Kernel-ImportExport'!
  656. !AmdPackageTransport commentStamp!
  657. I am the default transport for committing packages.
  658. See `AmdExporter` and `AmdPackageHandler`.!
  659. !AmdPackageTransport methodsFor: 'accessing'!
  660. commitHandlerClass
  661. ^ AmdPackageHandler
  662. !
  663. definition
  664. ^ String streamContents: [ :stream |
  665. stream
  666. nextPutAll: self class name;
  667. nextPutAll: ' namespace: ';
  668. nextPutAll: '''', self namespace, '''' ]
  669. !
  670. namespace
  671. ^ namespace ifNil: [ self defaultNamespace ]
  672. !
  673. namespace: aString
  674. namespace := aString
  675. ! !
  676. !AmdPackageTransport methodsFor: 'actions'!
  677. setPath: aString
  678. "Set the path the the receiver's `namespace`"
  679. (require basicAt: 'config') value: #{
  680. 'paths' -> #{
  681. self namespace -> aString
  682. }
  683. }.
  684. ! !
  685. !AmdPackageTransport methodsFor: 'converting'!
  686. asJSON
  687. ^ super asJSON
  688. at: 'amdNamespace' put: self namespace;
  689. yourself
  690. ! !
  691. !AmdPackageTransport methodsFor: 'defaults'!
  692. defaultNamespace
  693. ^ Smalltalk defaultAmdNamespace
  694. ! !
  695. !AmdPackageTransport methodsFor: 'initialization'!
  696. setupFromJson: anObject
  697. self namespace: (anObject at: 'amdNamespace')
  698. ! !
  699. !AmdPackageTransport methodsFor: 'printing'!
  700. printOn: aStream
  701. super printOn: aStream.
  702. aStream
  703. nextPutAll: ' (AMD Namespace: ';
  704. nextPutAll: self namespace;
  705. nextPutAll: ')'
  706. ! !
  707. !AmdPackageTransport class methodsFor: 'accessing'!
  708. type
  709. ^ 'amd'
  710. ! !
  711. !AmdPackageTransport class methodsFor: 'instance creation'!
  712. namespace: aString
  713. ^ self new
  714. namespace: aString;
  715. yourself
  716. ! !
  717. !Package methodsFor: '*Kernel-ImportExport'!
  718. commit
  719. ^ self transport commit
  720. !
  721. load
  722. ^ self transport load
  723. !
  724. loadFromNamespace: aString
  725. ^ self transport
  726. namespace: aString;
  727. load
  728. ! !
  729. !Package class methodsFor: '*Kernel-ImportExport'!
  730. load: aPackageName
  731. (self named: aPackageName) load
  732. !
  733. load: aPackageName fromNamespace: aString
  734. (self named: aPackageName) loadFromNamespace: aString
  735. ! !