Kernel-ImportExport.st 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952
  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. jsClassNameFor: aClass
  189. ^ aClass isMetaclass
  190. ifTrue: [ (self jsClassNameFor: aClass instanceClass), '.klass' ]
  191. ifFalse: [
  192. aClass
  193. ifNil: [ 'null' ]
  194. ifNotNil: [ '$globals.', aClass name ] ]
  195. ! !
  196. !Exporter methodsFor: 'output'!
  197. exportDefinitionOf: aClass on: aStream
  198. aStream
  199. lf;
  200. nextPutAll: '$core.addClass(';
  201. nextPutAll: '''', (self classNameFor: aClass), ''', ';
  202. nextPutAll: (self jsClassNameFor: 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: '//>>excludeStart("ide", pragmas.excludeIdeData);';
  215. lf;
  216. nextPutAll: (self jsClassNameFor: aClass);
  217. nextPutAll: '.comment=';
  218. nextPutAll: aClass comment crlfSanitized asJavascript;
  219. nextPutAll: ';';
  220. lf;
  221. nextPutAll: '//>>excludeEnd("ide");' ].
  222. aStream lf
  223. !
  224. exportMetaDefinitionOf: aClass on: aStream
  225. aStream lf.
  226. aClass class instanceVariableNames isEmpty ifFalse: [
  227. aStream
  228. nextPutAll: (self jsClassNameFor: aClass class);
  229. nextPutAll: '.iVarNames = ['.
  230. aClass class instanceVariableNames
  231. do: [ :each | aStream nextPutAll: '''', each, '''' ]
  232. separatedBy: [ aStream nextPutAll: ',' ].
  233. aStream nextPutAll: '];', String lf ]
  234. !
  235. exportMethod: aMethod on: aStream
  236. aStream
  237. nextPutAll: '$core.addMethod(';lf;
  238. nextPutAll: '$core.method({';lf;
  239. nextPutAll: 'selector: ', aMethod selector asJavascript, ',';lf;
  240. nextPutAll: 'protocol: ''', aMethod protocol, ''',';lf;
  241. nextPutAll: 'fn: ', aMethod fn compiledSource, ',';lf;
  242. nextPutAll: '//>>excludeStart("ide", pragmas.excludeIdeData);';lf;
  243. nextPutAll: 'args: ', aMethod arguments asJavascript, ','; lf;
  244. nextPutAll: 'source: ', aMethod source asJavascript, ',';lf;
  245. nextPutAll: 'referencedClasses: ', aMethod referencedClasses asJavascript, ',';lf;
  246. nextPutAll: '//>>excludeEnd("ide");';lf;
  247. nextPutAll: 'messageSends: ', aMethod messageSends asJavascript;lf;
  248. nextPutAll: '}),';lf;
  249. nextPutAll: (self jsClassNameFor: aMethod methodClass);
  250. nextPutAll: ');';lf;lf
  251. !
  252. exportPackage: aPackage on: aStream
  253. self
  254. exportPackagePrologueOf: aPackage on: aStream;
  255. exportPackageDefinitionOf: aPackage on: aStream;
  256. exportPackageTransportOf: aPackage on: aStream.
  257. aPackage sortedClasses do: [ :each |
  258. self exportDefinitionOf: each on: aStream.
  259. each ownMethods do: [ :method |
  260. self exportMethod: method on: aStream ].
  261. self exportMetaDefinitionOf: each on: aStream.
  262. each class ownMethods do: [ :method |
  263. self exportMethod: method on: aStream ] ].
  264. (self extensionMethodsOfPackage: aPackage) do: [ :each |
  265. self exportMethod: each on: aStream ].
  266. self exportPackageEpilogueOf: aPackage on: aStream
  267. !
  268. exportPackageDefinitionOf: aPackage on: aStream
  269. aStream
  270. nextPutAll: '$core.addPackage(';
  271. nextPutAll: '''', aPackage name, ''');';
  272. lf
  273. !
  274. exportPackageEpilogueOf: aPackage on: aStream
  275. aStream
  276. nextPutAll: '})(global_smalltalk,global_nil,global__st);';
  277. lf
  278. !
  279. exportPackagePrologueOf: aPackage on: aStream
  280. aStream
  281. nextPutAll: '(function(smalltalk,nil,_st){';
  282. lf
  283. !
  284. exportPackageTransportOf: aPackage on: aStream
  285. aStream
  286. nextPutAll: '$core.packages[';
  287. nextPutAll: aPackage name asJavascript;
  288. nextPutAll: '].transport = ';
  289. nextPutAll: aPackage transport asJSONString;
  290. nextPutAll: ';';
  291. lf
  292. ! !
  293. Exporter subclass: #AmdExporter
  294. instanceVariableNames: 'namespace'
  295. package: 'Kernel-ImportExport'!
  296. !AmdExporter commentStamp!
  297. I am used to export Packages in an AMD (Asynchronous Module Definition) JavaScript format.!
  298. !AmdExporter methodsFor: 'output'!
  299. exportPackageEpilogueOf: aPackage on: aStream
  300. aStream
  301. nextPutAll: '});';
  302. lf
  303. !
  304. exportPackagePrologueOf: aPackage on: aStream
  305. aStream
  306. nextPutAll: 'define("';
  307. nextPutAll: (self amdNamespaceOfPackage: aPackage);
  308. nextPutAll: '/';
  309. nextPutAll: aPackage name;
  310. nextPutAll: '", ';
  311. nextPutAll: (#('amber/boot'), (self amdNamesOfPackages: aPackage loadDependencies)) asJavascript;
  312. nextPutAll: ', function($boot){';
  313. lf;
  314. nextPutAll: 'var $core=$boot.api,nil=$boot.nil,$recv=$boot.asReceiver,$globals=$boot.globals;';
  315. lf
  316. ! !
  317. !AmdExporter methodsFor: 'private'!
  318. amdNamesOfPackages: anArray
  319. ^ (anArray
  320. select: [ :each | (self amdNamespaceOfPackage: each) notNil ])
  321. collect: [ :each | (self amdNamespaceOfPackage: each), '/', each name ]
  322. !
  323. amdNamespaceOfPackage: aPackage
  324. ^ (aPackage transport type = 'amd')
  325. ifTrue: [ aPackage transport namespace ]
  326. ifFalse: [ nil ]
  327. ! !
  328. Object subclass: #ChunkParser
  329. instanceVariableNames: 'stream last'
  330. package: 'Kernel-ImportExport'!
  331. !ChunkParser commentStamp!
  332. I am responsible for parsing aStream contents in the chunk format.
  333. ## API
  334. ChunkParser new
  335. stream: aStream;
  336. nextChunk!
  337. !ChunkParser methodsFor: 'accessing'!
  338. last
  339. ^ last
  340. !
  341. stream: aStream
  342. stream := aStream
  343. ! !
  344. !ChunkParser methodsFor: 'reading'!
  345. nextChunk
  346. "The chunk format (Smalltalk Interchange Format or Fileout format)
  347. is a trivial format but can be a bit tricky to understand:
  348. - Uses the exclamation mark as delimiter of chunks.
  349. - Inside a chunk a normal exclamation mark must be doubled.
  350. - A non empty chunk must be a valid Smalltalk expression.
  351. - A chunk on top level with a preceding empty chunk is an instruction chunk:
  352. - The object created by the expression then takes over reading chunks.
  353. This method returns next chunk as a String (trimmed), empty String (all whitespace) or nil."
  354. | char result chunk |
  355. result := '' writeStream.
  356. [ char := stream next.
  357. char notNil ] whileTrue: [
  358. char = '!!' ifTrue: [
  359. stream peek = '!!'
  360. ifTrue: [ stream next "skipping the escape double" ]
  361. ifFalse: [ ^ last := result contents trimBoth "chunk end marker found" ]].
  362. result nextPut: char ].
  363. ^ last := nil "a chunk needs to end with !!"
  364. ! !
  365. !ChunkParser class methodsFor: 'instance creation'!
  366. on: aStream
  367. ^ self new stream: aStream
  368. ! !
  369. Object subclass: #ExportMethodProtocol
  370. instanceVariableNames: 'name theClass'
  371. package: 'Kernel-ImportExport'!
  372. !ExportMethodProtocol commentStamp!
  373. I am an abstraction for a method protocol in a class / metaclass.
  374. I know of my class, name and methods.
  375. I am used when exporting a package.!
  376. !ExportMethodProtocol methodsFor: 'accessing'!
  377. methods
  378. ^ (self theClass methodsInProtocol: self name)
  379. sorted: [ :a :b | a selector <= b selector ]
  380. !
  381. name
  382. ^ name
  383. !
  384. name: aString
  385. name := aString
  386. !
  387. theClass
  388. ^ theClass
  389. !
  390. theClass: aClass
  391. theClass := aClass
  392. ! !
  393. !ExportMethodProtocol class methodsFor: 'instance creation'!
  394. name: aString theClass: aClass
  395. ^ self new
  396. name: aString;
  397. theClass: aClass;
  398. yourself
  399. ! !
  400. Object subclass: #Importer
  401. instanceVariableNames: 'lastSection lastChunk'
  402. package: 'Kernel-ImportExport'!
  403. !Importer commentStamp!
  404. I can import Amber code from a string in the chunk format.
  405. ## API
  406. Importer new import: aString!
  407. !Importer methodsFor: 'accessing'!
  408. lastChunk
  409. ^ lastChunk
  410. !
  411. lastSection
  412. ^ lastSection
  413. ! !
  414. !Importer methodsFor: 'fileIn'!
  415. import: aStream
  416. | chunk result parser lastEmpty |
  417. parser := ChunkParser on: aStream.
  418. lastEmpty := false.
  419. lastSection := 'n/a, not started'.
  420. lastChunk := nil.
  421. [
  422. [ chunk := parser nextChunk.
  423. chunk isNil ] whileFalse: [
  424. chunk isEmpty
  425. ifTrue: [ lastEmpty := true ]
  426. ifFalse: [
  427. lastSection := chunk.
  428. result := Compiler new evaluateExpression: chunk.
  429. lastEmpty
  430. ifTrue: [
  431. lastEmpty := false.
  432. result scanFrom: parser ]] ].
  433. lastSection := 'n/a, finished'
  434. ] on: Error do: [:e | lastChunk := parser last. e signal ].
  435. ! !
  436. InterfacingObject subclass: #PackageHandler
  437. instanceVariableNames: ''
  438. package: 'Kernel-ImportExport'!
  439. !PackageHandler commentStamp!
  440. I am responsible for handling package loading and committing.
  441. I should not be used directly. Instead, use the corresponding `Package` methods.!
  442. !PackageHandler methodsFor: 'accessing'!
  443. chunkContentsFor: aPackage
  444. ^ String streamContents: [ :str |
  445. self chunkExporter exportPackage: aPackage on: str ]
  446. !
  447. chunkExporterClass
  448. ^ ChunkExporter
  449. !
  450. commitPathJsFor: aPackage
  451. self subclassResponsibility
  452. !
  453. commitPathStFor: aPackage
  454. self subclassResponsibility
  455. !
  456. contentsFor: aPackage
  457. ^ String streamContents: [ :str |
  458. self exporter exportPackage: aPackage on: str ]
  459. !
  460. exporterClass
  461. ^ Exporter
  462. ! !
  463. !PackageHandler methodsFor: 'committing'!
  464. commit: aPackage
  465. self
  466. commit: aPackage
  467. onSuccess: []
  468. onError: [ :error |
  469. PackageCommitError new
  470. messageText: 'Commiting failed with reason: "' , (error responseText) , '"';
  471. signal ]
  472. !
  473. commit: aPackage onSuccess: aBlock onError: anotherBlock
  474. self
  475. commitJsFileFor: aPackage
  476. onSuccess: [
  477. self
  478. commitStFileFor: aPackage
  479. onSuccess: [ aPackage beClean. aBlock value ]
  480. onError: anotherBlock ]
  481. onError: anotherBlock
  482. !
  483. commitJsFileFor: aPackage onSuccess: aBlock onError: anotherBlock
  484. self
  485. ajaxPutAt: (self commitPathJsFor: aPackage), '/', aPackage name, '.js'
  486. data: (self contentsFor: aPackage)
  487. onSuccess: aBlock
  488. onError: anotherBlock
  489. !
  490. commitStFileFor: aPackage onSuccess: aBlock onError: anotherBlock
  491. self
  492. ajaxPutAt: (self commitPathStFor: aPackage), '/', aPackage name, '.st'
  493. data: (self chunkContentsFor: aPackage)
  494. onSuccess: aBlock
  495. onError: anotherBlock
  496. ! !
  497. !PackageHandler methodsFor: 'error handling'!
  498. onCommitError: anError
  499. PackageCommitError new
  500. messageText: 'Commiting failed with reason: "' , (anError responseText) , '"';
  501. signal
  502. ! !
  503. !PackageHandler methodsFor: 'factory'!
  504. chunkExporter
  505. ^ self chunkExporterClass new
  506. !
  507. exporter
  508. ^ self exporterClass new
  509. ! !
  510. !PackageHandler methodsFor: 'loading'!
  511. load: aPackage
  512. self subclassResponsibility
  513. ! !
  514. !PackageHandler methodsFor: 'private'!
  515. ajaxPutAt: aURL data: aString onSuccess: aBlock onError: anotherBlock
  516. self
  517. ajax: #{
  518. 'url' -> aURL.
  519. 'type' -> 'PUT'.
  520. 'data' -> aString.
  521. 'contentType' -> 'text/plain;charset=UTF-8'.
  522. 'success' -> aBlock.
  523. 'error' -> anotherBlock
  524. }
  525. ! !
  526. PackageHandler subclass: #AmdPackageHandler
  527. instanceVariableNames: ''
  528. package: 'Kernel-ImportExport'!
  529. !AmdPackageHandler commentStamp!
  530. I am responsible for handling package loading and committing.
  531. I should not be used directly. Instead, use the corresponding `Package` methods.!
  532. !AmdPackageHandler methodsFor: 'accessing'!
  533. commitPathJsFor: aPackage
  534. ^ self toUrl: (self namespaceFor: aPackage)
  535. !
  536. commitPathStFor: aPackage
  537. "If _source is not mapped, .st will be committed to .js path.
  538. It is recommended not to use _source as it can be deprecated."
  539. | path pathWithout |
  540. path := self toUrl: (self namespaceFor: aPackage), '/_source'.
  541. pathWithout := self commitPathJsFor: aPackage.
  542. ^ path = (pathWithout, '/_source') ifTrue: [ pathWithout ] ifFalse: [ path ]
  543. !
  544. exporterClass
  545. ^ AmdExporter
  546. ! !
  547. !AmdPackageHandler methodsFor: 'committing'!
  548. namespaceFor: aPackage
  549. ^ aPackage transport namespace
  550. ! !
  551. !AmdPackageHandler methodsFor: 'loading'!
  552. load: aPackage
  553. Smalltalk amdRequire
  554. ifNil: [ self error: 'AMD loader not present' ]
  555. ifNotNil: [ :require |
  556. require value: (Array with: (self namespaceFor: aPackage), '/', aPackage name ) ]
  557. ! !
  558. !AmdPackageHandler methodsFor: 'private'!
  559. toUrl: aString
  560. ^ Smalltalk amdRequire
  561. ifNil: [ self error: 'AMD loader not present' ]
  562. ifNotNil: [ :require | (require basicAt: 'toUrl') value: aString ]
  563. ! !
  564. !AmdPackageHandler class methodsFor: 'commit paths'!
  565. defaultNamespace
  566. ^ Smalltalk defaultAmdNamespace
  567. !
  568. defaultNamespace: aString
  569. Smalltalk defaultAmdNamespace: aString
  570. ! !
  571. Object subclass: #PackageTransport
  572. instanceVariableNames: 'package'
  573. package: 'Kernel-ImportExport'!
  574. !PackageTransport commentStamp!
  575. I represent the transport mechanism used to commit a package.
  576. My concrete subclasses have a `#handler` to which committing is delegated.!
  577. !PackageTransport methodsFor: 'accessing'!
  578. commitHandlerClass
  579. self subclassResponsibility
  580. !
  581. definition
  582. ^ ''
  583. !
  584. package
  585. ^ package
  586. !
  587. package: aPackage
  588. package := aPackage
  589. !
  590. type
  591. ^ self class type
  592. ! !
  593. !PackageTransport methodsFor: 'committing'!
  594. commit
  595. self commitHandler commit: self package
  596. !
  597. commitOnSuccess: aBlock onError: anotherBlock
  598. self commitHandler
  599. commit: self package
  600. onSuccess: aBlock
  601. onError: anotherBlock
  602. ! !
  603. !PackageTransport methodsFor: 'converting'!
  604. asJSON
  605. ^ #{ 'type' -> self type }
  606. ! !
  607. !PackageTransport methodsFor: 'factory'!
  608. commitHandler
  609. ^ self commitHandlerClass new
  610. ! !
  611. !PackageTransport methodsFor: 'initialization'!
  612. setupFromJson: anObject
  613. "no op. override if needed in subclasses"
  614. ! !
  615. !PackageTransport methodsFor: 'loading'!
  616. load
  617. self commitHandler load: self package
  618. ! !
  619. PackageTransport class instanceVariableNames: 'registry'!
  620. !PackageTransport class methodsFor: 'accessing'!
  621. classRegisteredFor: aString
  622. ^ registry at: aString
  623. !
  624. defaultType
  625. ^ AmdPackageTransport type
  626. !
  627. type
  628. "Override in subclasses"
  629. ^ nil
  630. ! !
  631. !PackageTransport class methodsFor: 'initialization'!
  632. initialize
  633. super initialize.
  634. registry := #{}.
  635. self register
  636. ! !
  637. !PackageTransport class methodsFor: 'instance creation'!
  638. for: aString
  639. ^ (self classRegisteredFor: aString) new
  640. !
  641. fromJson: anObject
  642. anObject ifNil: [ ^ self for: self defaultType ].
  643. ^ (self for: anObject type)
  644. setupFromJson: anObject;
  645. yourself
  646. ! !
  647. !PackageTransport class methodsFor: 'registration'!
  648. register
  649. PackageTransport register: self
  650. !
  651. register: aClass
  652. aClass type ifNotNil: [
  653. registry at: aClass type put: aClass ]
  654. ! !
  655. PackageTransport subclass: #AmdPackageTransport
  656. instanceVariableNames: 'namespace'
  657. package: 'Kernel-ImportExport'!
  658. !AmdPackageTransport commentStamp!
  659. I am the default transport for committing packages.
  660. See `AmdExporter` and `AmdPackageHandler`.!
  661. !AmdPackageTransport methodsFor: 'accessing'!
  662. commitHandlerClass
  663. ^ AmdPackageHandler
  664. !
  665. definition
  666. ^ String streamContents: [ :stream |
  667. stream
  668. nextPutAll: self class name;
  669. nextPutAll: ' namespace: ';
  670. nextPutAll: '''', self namespace, '''' ]
  671. !
  672. namespace
  673. ^ namespace ifNil: [ self defaultNamespace ]
  674. !
  675. namespace: aString
  676. namespace := aString
  677. ! !
  678. !AmdPackageTransport methodsFor: 'actions'!
  679. setPath: aString
  680. "Set the path the the receiver's `namespace`"
  681. (require basicAt: 'config') value: #{
  682. 'paths' -> #{
  683. self namespace -> aString
  684. }
  685. }.
  686. ! !
  687. !AmdPackageTransport methodsFor: 'converting'!
  688. asJSON
  689. ^ super asJSON
  690. at: 'amdNamespace' put: self namespace;
  691. yourself
  692. ! !
  693. !AmdPackageTransport methodsFor: 'defaults'!
  694. defaultNamespace
  695. ^ Smalltalk defaultAmdNamespace
  696. ! !
  697. !AmdPackageTransport methodsFor: 'initialization'!
  698. setupFromJson: anObject
  699. self namespace: (anObject at: 'amdNamespace')
  700. ! !
  701. !AmdPackageTransport methodsFor: 'printing'!
  702. printOn: aStream
  703. super printOn: aStream.
  704. aStream
  705. nextPutAll: ' (AMD Namespace: ';
  706. nextPutAll: self namespace;
  707. nextPutAll: ')'
  708. ! !
  709. !AmdPackageTransport class methodsFor: 'accessing'!
  710. type
  711. ^ 'amd'
  712. ! !
  713. !AmdPackageTransport class methodsFor: 'instance creation'!
  714. namespace: aString
  715. ^ self new
  716. namespace: aString;
  717. yourself
  718. ! !
  719. !Package methodsFor: '*Kernel-ImportExport'!
  720. commit
  721. ^ self transport commit
  722. !
  723. load
  724. ^ self transport load
  725. !
  726. loadFromNamespace: aString
  727. ^ self transport
  728. namespace: aString;
  729. load
  730. ! !
  731. !Package class methodsFor: '*Kernel-ImportExport'!
  732. load: aPackageName
  733. (self named: aPackageName) load
  734. !
  735. load: aPackageName fromNamespace: aString
  736. (self named: aPackageName) loadFromNamespace: aString
  737. ! !