Class: AbstractSourceFileWriter

• Inheritance
• Class protocol
  • signal constants
• Instance protocol
  • fileout
  • source writing
  • source writing - comments
• Private classes

Inheritance:

   Object
   |
   +--AbstractSourceFileWriter
      |
      +--JavaScriptSourceFileWriter
      |
      +--SmalltalkChunkFileSourceWriter

Package:

stx:libbasic

Category:

Kernel-Classes

Version:

rev: 1.6 date: 2009/10/08 12:03:57

user: fm

file: AbstractSourceFileWriter.st directory: libbasic

module: stx stc-classLibrary: libbasic

Class protocol:

 methodSourceRewriteQuery

hook to allow for just-in-time rewriting of a method's sourceCode while filing out
used when saving version_XXX methods in a non-XXX sourceCodeManager
(i.e. to rewrite all non-CVS version methods while saving into a CVS repository)
this is required because we cannot save an SVN version method (dollar-ID-...-dollar) into a
CVS repository without loosing the original string with the next checkout, because it also gets
expanded by CVS. The same is true vice-versa for CVS-Ids, which get clobbered by SVN.

see SmalltalkChunkFileSourceWriter fileOutMethod:on:

Instance protocol:

 fileOut: aClass on: outStreamArg

 fileOut: class on: stream withTimeStamp: stampIt withInitialize: initIt withDefinition: withDefinition methodFilter: methodFilter encoder: encoderOrNil

raise an error: must be redefined in concrete subclass(es)

** This method raises an error - it must be redefined in concrete classes **

 fileOutComment: aStringOrStringCollection on: aStream

Writes a comment to a stream using proper syntax

 fileOutCommentEndOn: aStream

Writes a comment end mark on aStream.


** This method raises an error - it must be redefined in concrete classes **

 fileOutCommentLine: aString on: aStream

Writes a single line of comment on a comment to a stream.
Should not put an cr to the stream!


** This method raises an error - it must be redefined in concrete classes **

 fileOutCommentStartOn: aStream

Writes a comment start mark on aStream.


** This method raises an error - it must be redefined in concrete classes **

Private classes:

    MethodSourceRewriteQuery