AbstractSourceFileWriter.st
author fm
Tue, 29 Sep 2009 18:16:28 +0200
changeset 12041 afa57da40ad1
parent 12011 1c12ff1bc536
child 12053 bab73507144f
permissions -rw-r--r--
added: #methodSourceRewriteQuery
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
11962
3303e65f30cd initial checkin
fm
parents:
diff changeset
     1
"{ Package: 'stx:libbasic' }"
3303e65f30cd initial checkin
fm
parents:
diff changeset
     2
3303e65f30cd initial checkin
fm
parents:
diff changeset
     3
Object subclass:#AbstractSourceFileWriter
3303e65f30cd initial checkin
fm
parents:
diff changeset
     4
	instanceVariableNames:''
3303e65f30cd initial checkin
fm
parents:
diff changeset
     5
	classVariableNames:''
3303e65f30cd initial checkin
fm
parents:
diff changeset
     6
	poolDictionaries:''
3303e65f30cd initial checkin
fm
parents:
diff changeset
     7
	category:'Kernel-Classes'
3303e65f30cd initial checkin
fm
parents:
diff changeset
     8
!
3303e65f30cd initial checkin
fm
parents:
diff changeset
     9
12041
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    10
Query subclass:#MethodSourceRewriteQuery
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    11
	instanceVariableNames:'method source'
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    12
	classVariableNames:''
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    13
	poolDictionaries:''
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    14
	privateIn:AbstractSourceFileWriter
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    15
!
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    16
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    17
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    18
!AbstractSourceFileWriter class methodsFor:'signal constants'!
11962
3303e65f30cd initial checkin
fm
parents:
diff changeset
    19
12041
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    20
methodSourceRewriteQuery
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    21
    "hook to allow for just-in-time rewriting of a method's sourceCode while filing out
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    22
    used when saving version_XXX methods in a non-XXX sourceCodeManager
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    23
    (i.e. to rewrite all non-CVS version methods while saving into a CVS repository)
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    24
    this is required because we cannot save an SVN version method (dollar-ID-...-dollar) into a
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    25
    CVS repository without loosing the original string with the next checkout, because it also gets  
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    26
    expanded by CVS. The same is true vice-versa for CVS-Ids, which get clobbered by SVN.
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    27
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    28
    see SmalltalkChunkFileSourceWriter fileOutMethod:on:"
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    29
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
    30
    ^ MethodSourceRewriteQuery
11962
3303e65f30cd initial checkin
fm
parents:
diff changeset
    31
! !
3303e65f30cd initial checkin
fm
parents:
diff changeset
    32
3303e65f30cd initial checkin
fm
parents:
diff changeset
    33
!AbstractSourceFileWriter methodsFor:'fileout'!
3303e65f30cd initial checkin
fm
parents:
diff changeset
    34
3303e65f30cd initial checkin
fm
parents:
diff changeset
    35
fileOut:aClass on:outStreamArg 
3303e65f30cd initial checkin
fm
parents:
diff changeset
    36
3303e65f30cd initial checkin
fm
parents:
diff changeset
    37
    self 
3303e65f30cd initial checkin
fm
parents:
diff changeset
    38
        fileOut:aClass on:outStreamArg 
3303e65f30cd initial checkin
fm
parents:
diff changeset
    39
        withTimeStamp:true withInitialize:true 
3303e65f30cd initial checkin
fm
parents:
diff changeset
    40
        withDefinition:true 
3303e65f30cd initial checkin
fm
parents:
diff changeset
    41
        methodFilter:nil encoder:nil
3303e65f30cd initial checkin
fm
parents:
diff changeset
    42
3303e65f30cd initial checkin
fm
parents:
diff changeset
    43
    "Created: / 15-08-2009 / 13:11:31 / Jan Vrany <vranyj1@fel.cvut.cz>"
3303e65f30cd initial checkin
fm
parents:
diff changeset
    44
! !
3303e65f30cd initial checkin
fm
parents:
diff changeset
    45
3303e65f30cd initial checkin
fm
parents:
diff changeset
    46
!AbstractSourceFileWriter methodsFor:'source writing'!
3303e65f30cd initial checkin
fm
parents:
diff changeset
    47
3303e65f30cd initial checkin
fm
parents:
diff changeset
    48
fileOut: class on:stream withTimeStamp: stampIt withInitialize: initIt withDefinition: withDefinition methodFilter:methodFilter encoder:encoderOrNil
3303e65f30cd initial checkin
fm
parents:
diff changeset
    49
    "raise an error: must be redefined in concrete subclass(es)"
3303e65f30cd initial checkin
fm
parents:
diff changeset
    50
3303e65f30cd initial checkin
fm
parents:
diff changeset
    51
    ^ self subclassResponsibility
3303e65f30cd initial checkin
fm
parents:
diff changeset
    52
3303e65f30cd initial checkin
fm
parents:
diff changeset
    53
    "Modified: / 16-08-2009 / 09:59:49 / Jan Vrany <vranyj1@fel.cvut.cz>"
3303e65f30cd initial checkin
fm
parents:
diff changeset
    54
! !
3303e65f30cd initial checkin
fm
parents:
diff changeset
    55
3303e65f30cd initial checkin
fm
parents:
diff changeset
    56
!AbstractSourceFileWriter methodsFor:'source writing - comments'!
3303e65f30cd initial checkin
fm
parents:
diff changeset
    57
3303e65f30cd initial checkin
fm
parents:
diff changeset
    58
fileOutComment: aStringOrStringCollection on: aStream
3303e65f30cd initial checkin
fm
parents:
diff changeset
    59
3303e65f30cd initial checkin
fm
parents:
diff changeset
    60
    "
3303e65f30cd initial checkin
fm
parents:
diff changeset
    61
        Writes a comment to a stream
3303e65f30cd initial checkin
fm
parents:
diff changeset
    62
        using proper syntax
3303e65f30cd initial checkin
fm
parents:
diff changeset
    63
    "
3303e65f30cd initial checkin
fm
parents:
diff changeset
    64
    self fileOutCommentStartOn: aStream.
3303e65f30cd initial checkin
fm
parents:
diff changeset
    65
    aStringOrStringCollection isStringCollection
3303e65f30cd initial checkin
fm
parents:
diff changeset
    66
        ifTrue:
3303e65f30cd initial checkin
fm
parents:
diff changeset
    67
            [aStringOrStringCollection 
3303e65f30cd initial checkin
fm
parents:
diff changeset
    68
                do:[:line|self fileOutCommentLine: line on: aStream]
3303e65f30cd initial checkin
fm
parents:
diff changeset
    69
                separatedBy: [aStream cr]]
3303e65f30cd initial checkin
fm
parents:
diff changeset
    70
        ifFalse:
3303e65f30cd initial checkin
fm
parents:
diff changeset
    71
            [(aStringOrStringCollection includes: Character cr)
3303e65f30cd initial checkin
fm
parents:
diff changeset
    72
                ifTrue:"/hmm...multiline comment as string
3303e65f30cd initial checkin
fm
parents:
diff changeset
    73
                    [aStringOrStringCollection asStringCollection
3303e65f30cd initial checkin
fm
parents:
diff changeset
    74
                        do:[:line|self fileOutCommentLine: line on: aStream]
3303e65f30cd initial checkin
fm
parents:
diff changeset
    75
                        separatedBy: [aStream cr]]
3303e65f30cd initial checkin
fm
parents:
diff changeset
    76
                ifFalse:
3303e65f30cd initial checkin
fm
parents:
diff changeset
    77
                    [self fileOutCommentLine: aStringOrStringCollection on: aStream]].
3303e65f30cd initial checkin
fm
parents:
diff changeset
    78
    self fileOutCommentEndOn: aStream.
3303e65f30cd initial checkin
fm
parents:
diff changeset
    79
3303e65f30cd initial checkin
fm
parents:
diff changeset
    80
    "Created: / 21-08-2009 / 09:36:03 / Jan Vrany <vranyj1@fel.cvut.cz>"
3303e65f30cd initial checkin
fm
parents:
diff changeset
    81
!
3303e65f30cd initial checkin
fm
parents:
diff changeset
    82
3303e65f30cd initial checkin
fm
parents:
diff changeset
    83
fileOutCommentEndOn: aStream
3303e65f30cd initial checkin
fm
parents:
diff changeset
    84
    "
3303e65f30cd initial checkin
fm
parents:
diff changeset
    85
        Writes a comment end mark on aStream.
3303e65f30cd initial checkin
fm
parents:
diff changeset
    86
    "
3303e65f30cd initial checkin
fm
parents:
diff changeset
    87
3303e65f30cd initial checkin
fm
parents:
diff changeset
    88
    ^self subclassResponsibility
3303e65f30cd initial checkin
fm
parents:
diff changeset
    89
3303e65f30cd initial checkin
fm
parents:
diff changeset
    90
    "Created: / 21-08-2009 / 09:40:42 / Jan Vrany <vranyj1@fel.cvut.cz>"
3303e65f30cd initial checkin
fm
parents:
diff changeset
    91
!
3303e65f30cd initial checkin
fm
parents:
diff changeset
    92
3303e65f30cd initial checkin
fm
parents:
diff changeset
    93
fileOutCommentLine: aString on: aStream
3303e65f30cd initial checkin
fm
parents:
diff changeset
    94
3303e65f30cd initial checkin
fm
parents:
diff changeset
    95
    "
3303e65f30cd initial checkin
fm
parents:
diff changeset
    96
        Writes a single line of comment on a comment to a stream.
3303e65f30cd initial checkin
fm
parents:
diff changeset
    97
        Should not put an cr to the stream!!
3303e65f30cd initial checkin
fm
parents:
diff changeset
    98
    "
3303e65f30cd initial checkin
fm
parents:
diff changeset
    99
3303e65f30cd initial checkin
fm
parents:
diff changeset
   100
    ^self subclassResponsibility
3303e65f30cd initial checkin
fm
parents:
diff changeset
   101
3303e65f30cd initial checkin
fm
parents:
diff changeset
   102
    "Created: / 21-08-2009 / 09:42:23 / Jan Vrany <vranyj1@fel.cvut.cz>"
3303e65f30cd initial checkin
fm
parents:
diff changeset
   103
!
3303e65f30cd initial checkin
fm
parents:
diff changeset
   104
3303e65f30cd initial checkin
fm
parents:
diff changeset
   105
fileOutCommentStartOn: aStream
3303e65f30cd initial checkin
fm
parents:
diff changeset
   106
    "
3303e65f30cd initial checkin
fm
parents:
diff changeset
   107
        Writes a comment start mark on aStream.
3303e65f30cd initial checkin
fm
parents:
diff changeset
   108
    "
3303e65f30cd initial checkin
fm
parents:
diff changeset
   109
3303e65f30cd initial checkin
fm
parents:
diff changeset
   110
    ^self subclassResponsibility
3303e65f30cd initial checkin
fm
parents:
diff changeset
   111
3303e65f30cd initial checkin
fm
parents:
diff changeset
   112
    "Created: / 21-08-2009 / 09:40:28 / Jan Vrany <vranyj1@fel.cvut.cz>"
3303e65f30cd initial checkin
fm
parents:
diff changeset
   113
! !
3303e65f30cd initial checkin
fm
parents:
diff changeset
   114
12041
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   115
!AbstractSourceFileWriter::MethodSourceRewriteQuery class methodsFor:'documentation'!
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   116
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   117
documentation
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   118
"
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   119
    hook to allow for just-in-time rewriting of a method's sourceCode while filing out
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   120
    used when saving version_XXX methods in a non-XXX sourceCodeManager
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   121
    (i.e. to rewrite all non-CVS version methods while saving into a CVS repository)
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   122
    this is required because we cannot save an SVN version method (dollar-ID-...-dollar) into a
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   123
    CVS repository without loosing the original string with the next checkout, because it also gets  
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   124
    expanded by CVS. The same is true vice-versa for CVS-Ids, which get clobbered by SVN.
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   125
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   126
    see SmalltalkChunkFileSourceWriter fileOutMethod:on:
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   127
"
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   128
! !
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   129
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   130
!AbstractSourceFileWriter::MethodSourceRewriteQuery methodsFor:'accessing'!
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   131
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   132
method
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   133
    ^ method
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   134
!
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   135
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   136
method:methodArg source:sourceArg 
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   137
    method := methodArg.
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   138
    source := sourceArg.
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   139
!
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   140
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   141
source
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   142
    ^ source
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   143
! !
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   144
11962
3303e65f30cd initial checkin
fm
parents:
diff changeset
   145
!AbstractSourceFileWriter class methodsFor:'documentation'!
3303e65f30cd initial checkin
fm
parents:
diff changeset
   146
3303e65f30cd initial checkin
fm
parents:
diff changeset
   147
version
12041
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   148
    ^ '$Header: /cvs/stx/stx/libbasic/AbstractSourceFileWriter.st,v 1.3 2009-09-29 16:16:28 fm Exp $'
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   149
!
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   150
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   151
version_CVS
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   152
    ^ '$Header: /cvs/stx/stx/libbasic/AbstractSourceFileWriter.st,v 1.3 2009-09-29 16:16:28 fm Exp $'
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   153
!
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   154
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   155
version_SVN
afa57da40ad1 added: #methodSourceRewriteQuery
fm
parents: 12011
diff changeset
   156
    ^'Id: AbstractSourceFileWriter.st,v 1.2 2009/09/23 12:23:23 fm Exp '
11962
3303e65f30cd initial checkin
fm
parents:
diff changeset
   157
! !