Smalltalk current createPackage: 'Importer-Exporter'! Object subclass: #ChunkExporter instanceVariableNames: '' package: 'Importer-Exporter'! !ChunkExporter commentStamp! I am an exporter dedicated to outputting Amber source code in the classic Smalltalk chunk format. I do not output any compiled code.! !ChunkExporter class methodsFor: 'exporting-accessing'! extensionCategoriesOfPackage: package "Issue #143: sort protocol alphabetically" | name map result | name := package name. result := OrderedCollection new. (Package sortedClasses: Smalltalk current classes) do: [:each | {each. each class} do: [:aClass | map := Dictionary new. aClass protocolsDo: [:category :methods | (category match: '^\*', name) ifTrue: [ map at: category put: methods ]]. result addAll: ((map keys sorted: [:a :b | a <= b ]) collect: [:category | MethodCategory name: category theClass: aClass methods: (map at: category)]) ]]. ^result ! methodsOfCategory: category "Issue #143: sort methods alphabetically" ^(category methods) sorted: [:a :b | a selector <= b selector] ! ownCategoriesOfClass: aClass "Issue #143: sort protocol alphabetically" | map | map := Dictionary new. aClass protocolsDo: [:category :methods | (category match: '^\*') ifFalse: [ map at: category put: methods ]]. ^(map keys sorted: [:a :b | a <= b ]) collect: [:category | MethodCategory name: category theClass: aClass methods: (map at: category) ] ! ownCategoriesOfMetaClass: aClass "Issue #143: sort protocol alphabetically" ^self ownCategoriesOfClass: aClass class ! ! !ChunkExporter class methodsFor: 'exporting-output'! exportCategoryEpilogueOf: category on: aStream aStream nextPutAll: ' !!'; lf; lf ! exportCategoryPrologueOf: category on: aStream aStream nextPutAll: '!!', (self classNameFor: category theClass); nextPutAll: ' methodsFor: ''', category name, '''!!' ! exportDefinitionOf: aClass on: aStream "Chunk format." aStream nextPutAll: (self classNameFor: aClass superclass); nextPutAll: ' subclass: #', (self classNameFor: aClass); lf; tab; nextPutAll: 'instanceVariableNames: '''. aClass instanceVariableNames do: [:each | aStream nextPutAll: each] separatedBy: [aStream nextPutAll: ' ']. aStream nextPutAll: ''''; lf; tab; nextPutAll: 'package: ''', aClass category, '''!!'; lf. aClass comment notEmpty ifTrue: [ aStream nextPutAll: '!!', (self classNameFor: aClass), ' commentStamp!!';lf; nextPutAll: (self chunkEscape: aClass comment), '!!';lf]. aStream lf ! exportMetaDefinitionOf: aClass on: aStream aClass class instanceVariableNames isEmpty ifFalse: [ aStream nextPutAll: (self classNameFor: aClass class); nextPutAll: ' instanceVariableNames: '''. aClass class instanceVariableNames do: [:each | aStream nextPutAll: each] separatedBy: [aStream nextPutAll: ' ']. aStream nextPutAll: '''!!'; lf; lf] ! exportMethod: aMethod on: aStream aStream lf; lf; nextPutAll: (self chunkEscape: aMethod source); lf; nextPutAll: '!!' ! exportPackageDefinitionOf: package on: aStream "Chunk format." aStream nextPutAll: 'Smalltalk current createPackage: ''', package name, '''!!'; lf ! ! !ChunkExporter class methodsFor: 'fileOut'! recipe "Export a given package." | exportCategoryRecipe | exportCategoryRecipe := { self -> #exportCategoryPrologueOf:on:. { self -> #methodsOfCategory:. self -> #exportMethod:on: }. self -> #exportCategoryEpilogueOf:on: }. ^{ self -> #exportPackageDefinitionOf:on:. { PluggableExporter -> #ownClassesOfPackage:. self -> #exportDefinitionOf:on:. { self -> #ownCategoriesOfClass: }, exportCategoryRecipe. self -> #exportMetaDefinitionOf:on:. { self -> #ownCategoriesOfMetaClass: }, exportCategoryRecipe }. { self -> #extensionCategoriesOfPackage: }, exportCategoryRecipe } ! ! !ChunkExporter class methodsFor: 'private'! chunkEscape: aString "Replace all occurrences of !! with !!!! and trim at both ends." ^(aString replace: '!!' with: '!!!!') trimBoth ! classNameFor: aClass ^aClass isMetaclass ifTrue: [aClass instanceClass name, ' class'] ifFalse: [ aClass isNil ifTrue: ['nil'] ifFalse: [aClass name]] ! ! Object subclass: #ChunkParser instanceVariableNames: 'stream' package: 'Importer-Exporter'! !ChunkParser commentStamp! I am responsible for parsing aStream contents in the chunk format. ## API ChunkParser new stream: aStream; nextChunk! !ChunkParser methodsFor: 'accessing'! stream: aStream stream := aStream ! ! !ChunkParser methodsFor: 'reading'! nextChunk "The chunk format (Smalltalk Interchange Format or Fileout format) is a trivial format but can be a bit tricky to understand: - Uses the exclamation mark as delimiter of chunks. - Inside a chunk a normal exclamation mark must be doubled. - A non empty chunk must be a valid Smalltalk expression. - A chunk on top level with a preceding empty chunk is an instruction chunk: - The object created by the expression then takes over reading chunks. This metod returns next chunk as a String (trimmed), empty String (all whitespace) or nil." | char result chunk | result := '' writeStream. [char := stream next. char notNil] whileTrue: [ char = '!!' ifTrue: [ stream peek = '!!' ifTrue: [stream next "skipping the escape double"] ifFalse: [^result contents trimBoth "chunk end marker found"]]. result nextPut: char]. ^nil "a chunk needs to end with !!" ! ! !ChunkParser class methodsFor: 'not yet classified'! on: aStream ^self new stream: aStream ! ! Object subclass: #Exporter instanceVariableNames: '' package: 'Importer-Exporter'! !Exporter commentStamp! I am responsible for outputting Amber code into a JavaScript string. The generated output is enough to reconstruct the exported data, including Smalltalk source code and other metadata. ## Use case I am typically used to save code outside of the Amber runtime (committing to disk, etc.). ## API Use `#exportAll`, `#exportClass:` or `#exportPackage:` methods.! !Exporter class methodsFor: 'exporting-accessing'! extensionMethodsOfPackage: package "Issue #143: sort classes and methods alphabetically" | name result | name := package name. result := OrderedCollection new. (Package sortedClasses: Smalltalk current classes) do: [:each | {each. each class} do: [:aClass | result addAll: (((aClass methodDictionary values) sorted: [:a :b | a selector <= b selector]) select: [:method | method category match: '^\*', name]) ]]. ^result ! ownMethodsOfClass: aClass "Issue #143: sort methods alphabetically" ^((aClass methodDictionary values) sorted: [:a :b | a selector <= b selector]) reject: [:each | (each category match: '^\*')] ! ownMethodsOfMetaClass: aClass "Issue #143: sort methods alphabetically" ^self ownMethodsOfClass: aClass class ! ! !Exporter class methodsFor: 'exporting-output'! exportDefinitionOf: aClass on: aStream aStream lf; nextPutAll: 'smalltalk.addClass('; nextPutAll: '''', (self classNameFor: aClass), ''', '; nextPutAll: 'smalltalk.', (self classNameFor: aClass superclass); nextPutAll: ', ['. aClass instanceVariableNames do: [:each | aStream nextPutAll: '''', each, ''''] separatedBy: [aStream nextPutAll: ', ']. aStream nextPutAll: '], '''; nextPutAll: aClass category, ''''; nextPutAll: ');'. aClass comment notEmpty ifTrue: [ aStream lf; nextPutAll: 'smalltalk.'; nextPutAll: (self classNameFor: aClass); nextPutAll: '.comment='; nextPutAll: aClass comment asJavascript; nextPutAll: ';']. aStream lf ! exportMetaDefinitionOf: aClass on: aStream aStream lf. aClass class instanceVariableNames isEmpty ifFalse: [ aStream nextPutAll: 'smalltalk.', (self classNameFor: aClass class); nextPutAll: '.iVarNames = ['. aClass class instanceVariableNames do: [:each | aStream nextPutAll: '''', each, ''''] separatedBy: [aStream nextPutAll: ',']. aStream nextPutAll: '];', String lf] ! exportMethod: aMethod on: aStream aStream nextPutAll: 'smalltalk.addMethod(';lf; "nextPutAll: aMethod selector asSelector asJavascript, ',';lf;" nextPutAll: 'smalltalk.method({';lf; nextPutAll: 'selector: ', aMethod selector asJavascript, ',';lf; nextPutAll: 'category: ''', aMethod category, ''',';lf; nextPutAll: 'fn: ', aMethod fn compiledSource, ',';lf; nextPutAll: 'args: ', aMethod arguments asJavascript, ','; lf; nextPutAll: 'source: ', aMethod source asJavascript, ',';lf; nextPutAll: 'messageSends: ', aMethod messageSends asJavascript, ',';lf; nextPutAll: 'referencedClasses: ', aMethod referencedClasses asJavascript. aStream lf; nextPutAll: '}),';lf; nextPutAll: 'smalltalk.', (self classNameFor: aMethod methodClass); nextPutAll: ');';lf;lf ! exportPackageDefinitionOf: package on: aStream aStream nextPutAll: 'smalltalk.addPackage('; nextPutAll: '''', package name, ''');'; lf ! exportPackageEpilogueOf: aPackage on: aStream aStream nextPutAll: '})(global_smalltalk,global_nil,global__st);'; lf ! exportPackagePrologueOf: aPackage on: aStream aStream nextPutAll: '(function(smalltalk,nil,_st){'; lf ! ! !Exporter class methodsFor: 'fileOut'! recipe "Export a given package." ^{ self -> #exportPackagePrologueOf:on:. self -> #exportPackageDefinitionOf:on:. { PluggableExporter -> #ownClassesOfPackage:. self -> #exportDefinitionOf:on:. { self -> #ownMethodsOfClass:. self -> #exportMethod:on: }. self -> #exportMetaDefinitionOf:on:. { self -> #ownMethodsOfMetaClass:. self -> #exportMethod:on: } }. { self -> #extensionMethodsOfPackage:. self -> #exportMethod:on: }. self -> #exportPackageEpilogueOf:on: } ! ! !Exporter class methodsFor: 'private'! classNameFor: aClass ^aClass isMetaclass ifTrue: [aClass instanceClass name, '.klass'] ifFalse: [ aClass isNil ifTrue: ['nil'] ifFalse: [aClass name]] ! ! Exporter subclass: #StrippedExporter instanceVariableNames: '' package: 'Importer-Exporter'! !StrippedExporter commentStamp! I export Amber code into a JavaScript string, but without any optional associated data like the Amber source code.! !StrippedExporter class methodsFor: 'exporting-output'! exportDefinitionOf: aClass on: aStream aStream lf; nextPutAll: 'smalltalk.addClass('; nextPutAll: '''', (self classNameFor: aClass), ''', '; nextPutAll: 'smalltalk.', (self classNameFor: aClass superclass); nextPutAll: ', ['. aClass instanceVariableNames do: [:each | aStream nextPutAll: '''', each, ''''] separatedBy: [aStream nextPutAll: ', ']. aStream nextPutAll: '], '''; nextPutAll: aClass category, ''''; nextPutAll: ');'. aStream lf ! exportMethod: aMethod on: aStream aStream nextPutAll: 'smalltalk.addMethod(';lf; "nextPutAll: aMethod selector asSelector asJavascript, ',';lf;" nextPutAll: 'smalltalk.method({';lf; nextPutAll: 'selector: ', aMethod selector asJavascript, ',';lf; nextPutAll: 'fn: ', aMethod fn compiledSource, ',';lf; nextPutAll: 'messageSends: ', aMethod messageSends asJavascript; nextPutAll: '}),';lf; nextPutAll: 'smalltalk.', (self classNameFor: aMethod methodClass); nextPutAll: ');';lf;lf ! ! Object subclass: #Importer instanceVariableNames: '' package: 'Importer-Exporter'! !Importer commentStamp! I can import Amber code from a string in the chunk format. ## API Importer new import: aString! !Importer methodsFor: 'fileIn'! import: aStream | chunk result parser lastEmpty | parser := ChunkParser on: aStream. lastEmpty := false. [chunk := parser nextChunk. chunk isNil] whileFalse: [ chunk isEmpty ifTrue: [lastEmpty := true] ifFalse: [ result := Compiler new evaluateExpression: chunk. lastEmpty ifTrue: [ lastEmpty := false. result scanFrom: parser]]] ! ! Object subclass: #MethodCategory instanceVariableNames: 'methods name theClass' package: 'Importer-Exporter'! !MethodCategory commentStamp! I am an abstraction for a method category in a class / metaclass. I know of my class, name and methods. I am used when exporting a package.! !MethodCategory methodsFor: 'accessing'! methods ^methods ! methods: anArray methods := anArray ! name ^name ! name: aString name := aString ! theClass ^theClass ! theClass: aClass theClass := aClass ! ! !MethodCategory class methodsFor: 'not yet classified'! name: aString theClass: aClass methods: anArray ^self new name: aString; theClass: aClass; methods: anArray; yourself ! ! InterfacingObject subclass: #PackageHandler instanceVariableNames: '' package: 'Importer-Exporter'! !PackageHandler commentStamp! I am responsible for handling package loading and committing. I should not be used directly. Instead, use the corresponding `Package` methods.! !PackageHandler methodsFor: 'committing'! commit: aPackage self commitChannels do: [ :commitStrategyFactory || fileContents commitStrategy | commitStrategy := commitStrategyFactory value: aPackage. fileContents := String streamContents: [ :stream | (PluggableExporter newUsing: commitStrategy key) exportPackage: aPackage on: stream ]. self ajaxPutAt: commitStrategy value data: fileContents ] displayingProgress: 'Committing package ', aPackage name ! commitChannels self subclassResponsibility ! ! !PackageHandler methodsFor: 'private'! ajaxPutAt: aURL data: aString self ajax: #{ 'url' -> aURL. 'type' -> 'PUT'. 'data' -> aString. 'contentType' -> 'text/plain;charset=UTF-8'. 'error' -> [ :xhr | self error: 'Commiting ' , aURL , ' failed with reason: "' , (xhr responseText) , '"'] } ! ! PackageHandler class instanceVariableNames: 'registry'! !PackageHandler class methodsFor: 'accessing'! classRegisteredFor: aString ^registry at: aString ! for: aString ^(self classRegisteredFor: aString) new ! ! !PackageHandler class methodsFor: 'initialization'! initialize super initialize. registry := #{} ! ! !PackageHandler class methodsFor: 'registry'! register: aClass for: aString registry at: aString put: aClass ! registerFor: aString PackageHandler register: self for: aString ! ! PackageHandler subclass: #LegacyPackageHandler instanceVariableNames: '' package: 'Importer-Exporter'! !LegacyPackageHandler commentStamp! I am responsible for handling package loading and committing. I should not be used directly. Instead, use the corresponding `Package` methods.! !LegacyPackageHandler methodsFor: 'committing'! commitChannels ^{ [ :pkg | Exporter recipe -> (pkg commitPathJs, '/', pkg name, '.js') ]. [ :pkg | StrippedExporter recipe -> (pkg commitPathJs, '/', pkg name, '.deploy.js') ]. [ :pkg | ChunkExporter recipe -> (pkg commitPathSt, '/', pkg name, '.st') ] } ! commitPathJsFor: aPackage ^self class defaultCommitPathJs ! commitPathStFor: aPackage ^self class defaultCommitPathSt ! ! !LegacyPackageHandler methodsFor: 'loading'! loadPackage: packageName prefix: aString | url | url := '/', aString, '/js/', packageName, '.js'. self ajax: #{ 'url' -> url. 'type' -> 'GET'. 'dataType' -> 'script'. 'complete' -> [ :jqXHR :textStatus | jqXHR readyState = 4 ifTrue: [ self setupPackageNamed: packageName prefix: aString ] ]. 'error' -> [ self alert: 'Could not load package at: ', url ] } ! loadPackages: aCollection prefix: aString aCollection do: [ :each | self loadPackage: each prefix: aString ] ! ! !LegacyPackageHandler methodsFor: 'private'! setupPackageNamed: packageName prefix: aString (Package named: packageName) setupClasses; commitPathJs: '/', aString, '/js'; commitPathSt: '/', aString, '/st' ! ! LegacyPackageHandler class instanceVariableNames: 'defaultCommitPathJs defaultCommitPathSt'! !LegacyPackageHandler class methodsFor: 'commit paths'! commitPathsFromLoader < var commitPath = typeof amber !!== 'undefined' && amber.commitPath; if (!!commitPath) return; if (commitPath.js) self._defaultCommitPathJs_(commitPath.js); if (commitPath.st) self._defaultCommitPathSt_(commitPath.st); > ! defaultCommitPathJs ^ defaultCommitPathJs ifNil: [ defaultCommitPathJs := 'js'] ! defaultCommitPathJs: aString defaultCommitPathJs := aString ! defaultCommitPathSt ^ defaultCommitPathSt ifNil: [ defaultCommitPathSt := 'st'] ! defaultCommitPathSt: aString defaultCommitPathSt := aString ! resetCommitPaths defaultCommitPathJs := nil. defaultCommitPathSt := nil ! ! !LegacyPackageHandler class methodsFor: 'initialization'! initialize super initialize. self registerFor: 'unknown'. self commitPathsFromLoader ! ! !LegacyPackageHandler class methodsFor: 'loading'! loadPackages: aCollection prefix: aString ^ self new loadPackages: aCollection prefix: aString ! ! Object subclass: #PluggableExporter instanceVariableNames: 'recipe' package: 'Importer-Exporter'! !PluggableExporter commentStamp! I am an engine for exporting structured data on a Stream. My instances are created using PluggableExporter newUsing: recipe, where recipe is structured description of the exporting algorithm, Then actual exporting is done using aPluggableExporter export: data usingRecipe: recipe on: stream Recipe is an array, which can contain two kinds of elements: - an assocation where key is the receiver and value is two-arg selector In this case, `receiver perform: selector withArguments: { data. stream }` is called. This essentially defines one step of export process. The key (eg. receiver) is presumed to be some kind of 'repository' of the exporting methods that just format appropriate aspect of data into a stream; like a class or a singleton, so you can make the recipe itself decoupled from data. - a subarray (sa), where first element is special and the rest is recursive recipe `sa first` must be an association similar to one above, with key being the 'repository' receiver, but value is one-arg selector. In this case, `receiver perform: selector withArguments: { data }` should create a collection. Then, the sub-recipe (`sa allButFirst`) is applied to every element of a collection, eg. collection do: [ :each | self export: each using: sa allButFirst on: stream ] I am used to export amber packages, so I have convenience method exportPackage: aPackage on: aStream which exports aPackage using recipe you passed on newUsing: (it is otherwise no special, so it may be renamed to export:on:)! !PluggableExporter methodsFor: 'accessing'! recipe ^recipe ! recipe: anArray recipe := anArray ! ! !PluggableExporter methodsFor: 'fileOut'! export: anObject usingRecipe: anArray on: aStream | args | args := { anObject. aStream }. anArray do: [ :each | | val | val := each value. val == each ifFalse: [ "association" each key perform: val withArguments: args ] ifTrue: [ "sub-array" | selection | selection := each first key perform: each first value withArguments: { anObject }. selection do: [ :eachPart | self export: eachPart usingRecipe: each allButFirst on: aStream ]]] ! exportAll "Export all packages in the system." ^String streamContents: [:stream | Smalltalk current packages do: [:pkg | self exportPackage: pkg on: stream]] ! exportPackage: aPackage on: aStream self export: aPackage usingRecipe: self recipe on: aStream ! ! !PluggableExporter class methodsFor: 'exporting-accessing'! newUsing: recipe ^self new recipe: recipe; yourself ! ownClassesOfPackage: package "Export classes in dependency order. Update (issue #171): Remove duplicates for export" ^package sortedClasses asSet ! ! !Package methodsFor: '*Importer-Exporter'! commit ^ self transport commit: self ! commitPathJs ^ (extension ifNil: [ extension := #{} ]) at: #commitPathJs ifAbsentPut: [self transport commitPathJsFor: self] ! commitPathJs: aString ^ (extension ifNil: [ extension := #{} ]) at: #commitPathJs put: aString ! commitPathSt ^ (extension ifNil: [ extension := #{} ]) at: #commitPathSt ifAbsentPut: [self transport commitPathStFor: self] ! commitPathSt: aString ^ (extension ifNil: [ extension := #{} ]) at: #commitPathSt put: aString ! loadDependencies "Returns list of packages that need to be present before loading this package. These are determined as set of packages covering all classes used either for subclassing or for defining extension methods on." "Fake one for now. TODO" | root | root := Object package. self == root ifTrue: [ ^#() ] ifFalse: [ ^{root} ] ! transport ^ PackageHandler for: self transportType ! transportType ! !