FileText.st
author claus
Thu, 02 Jun 1994 13:36:39 +0200
changeset 28 350f8e9493a4
parent 4 1f66800df351
child 31 e223f3cf2995
permissions -rw-r--r--
*** empty log message ***
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     1
"
4
1f66800df351 *** empty log message ***
claus
parents: 2
diff changeset
     2
 COPYRIGHT (c) 1989 by Claus Gittinger
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     3
              All Rights Reserved
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     4
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     5
 This software is furnished under a license and may be used
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     6
 only in accordance with the terms of that license and with the
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     8
 be provided or otherwise made available to, or used by, any
1cf8d1747859 Initial revision
claus
parents:
diff changeset
     9
 other person.  No title to or ownership of the software is
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    10
 hereby transferred.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    11
"
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    12
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    13
Text subclass:#FileText
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    14
       instanceVariableNames:'myStream lastLineKnown lastLineOfFile
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    15
                              cachedLines cacheLineNr'
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    16
       classVariableNames:''
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    17
       poolDictionaries:''
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    18
       category:'Collections-Text'
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    19
!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    20
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    21
FileText comment:'
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    22
4
1f66800df351 *** empty log message ***
claus
parents: 2
diff changeset
    23
COPYRIGHT (c) 1989 by Claus Gittinger
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    24
              All Rights Reserved
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    25
28
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    26
$Header: /cvs/stx/stx/libbasic2/FileText.st,v 1.5 1994-06-02 11:35:33 claus Exp $
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    27
'!
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    28
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    29
!FileText class methodsFor:'documentation'!
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    30
28
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    31
documentation
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    32
"
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    33
    FileText represents the contents of a text-file;
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    34
    in core only the offsets of the text-lines are stored in an array
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    35
    to save space; the at: method fetches the line from the file.
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    36
    Individual textlines may be replaced by strings.
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    37
    the underlying file is NOT updated in this case.
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    38
    Care should be taken, if the underlying file is rewritten -
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    39
    you have to manually update/flush the pointers.
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    40
    Never rewrite the file using the data from a FileText.
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    41
"
350f8e9493a4 *** empty log message ***
claus
parents: 4
diff changeset
    42
! !
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    43
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    44
!FileText class methodsFor:'instance creation'!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    45
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    46
of:aStream
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    47
    "return a new FileText object for the stream aStream"
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    48
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    49
    ^ (self new:1) of:aStream
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    50
!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    51
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    52
ofFile:aFileName
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    53
    "return a new FileText object for the named file"
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    54
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    55
    |aStream|
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    56
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    57
    aStream := FileStream readonlyFileNamed:aFileName.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    58
    aStream isNil ifTrue:[^ nil].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    59
    ^ (self new:1) of:aStream
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    60
! !
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    61
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    62
!FileText methodsFor:'accessing'!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    63
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    64
of:aStream
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    65
    myStream := aStream.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    66
    lastLineOfFile := nil.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    67
    lastLineKnown := 0.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    68
    cachedLines := nil
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    69
! !
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    70
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    71
!FileText methodsFor:'accessing'!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    72
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    73
at:index
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    74
    |entry oldPosition|
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    75
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    76
    (index > lastLineKnown) ifTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    77
        self scanUpToLine:index.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    78
        (lastLineOfFile notNil) ifTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    79
            (index > lastLineOfFile) ifTrue:[
1
claus
parents: 0
diff changeset
    80
                ^ self subscriptBoundsError
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    81
            ]
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    82
        ]
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    83
    ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    84
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    85
    entry := super at:index.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    86
    (entry isMemberOf:String) ifTrue:[^ entry].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    87
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    88
    cachedLines isNil ifTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    89
        cachedLines := Array new:50.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    90
        cacheLineNr := -9999
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    91
    ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    92
    ((index < cacheLineNr)
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    93
     or:[index >= (cacheLineNr + cachedLines size)]) ifTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    94
        oldPosition := myStream position.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    95
        myStream position:entry.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    96
        1 to:(cachedLines size) do:[:cacheIndex|
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    97
            cachedLines at:cacheIndex put:(myStream nextLine)
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    98
        ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    99
        myStream position:oldPosition.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   100
        cacheLineNr := index
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   101
    ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   102
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   103
    ^ cachedLines at:(index - cacheLineNr + 1)
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   104
!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   105
    
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   106
size
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   107
    "return the number of text-lines - have to scan file the first time"
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   108
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   109
    (lastLineOfFile isNil) ifTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   110
        self scanUpToEnd
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   111
    ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   112
    ^ lastLineOfFile
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   113
! !
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   114
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   115
!FileText methodsFor:'enumerating'!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   116
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   117
do:aBlock
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   118
    self from:1 to:(self size) do:aBlock
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   119
!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   120
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   121
from:index1 to:index2 do:aBlock
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   122
    "must be redefined back since elements are indices into file, not the elements themselfes"
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   123
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   124
    |index "{ Class: SmallInteger }"
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   125
     stop  "{ Class: SmallInteger }" |
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   126
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   127
    index := index1.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   128
    stop := index2.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   129
    [index <= stop] whileTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   130
        aBlock value:(self at:index).
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   131
        index := index + 1
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   132
    ]
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   133
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   134
! !
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   135
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   136
!FileText methodsFor:'private'!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   137
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   138
scanUpToEnd
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   139
    "scan myStream up to the end of file"
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   140
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   141
    (lastLineOfFile notNil) ifTrue:[^ self].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   142
    [true] whileTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   143
        lastLineKnown := lastLineKnown + 1.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   144
        (super size < lastLineKnown) ifTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   145
            super grow:(super size * 2 + 1)
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   146
        ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   147
        super at:lastLineKnown put:(myStream position).
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   148
        myStream skipLine isNil ifTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   149
            lastLineOfFile := lastLineKnown.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   150
            ^ self
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   151
        ]
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   152
    ]
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   153
!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   154
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   155
scanUpToLine:index
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   156
    "scan myStream up to line index and save line-start-positions"
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   157
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   158
    (lastLineOfFile notNil) ifTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   159
        (index > lastLineOfFile) ifTrue:[^ self]
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   160
    ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   161
    [lastLineKnown <= index] whileTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   162
        lastLineKnown := lastLineKnown + 1.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   163
        (super size < lastLineKnown) ifTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   164
            super grow:(super size * 2 + 1)
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   165
        ].
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   166
        super at:lastLineKnown put:(myStream position).
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   167
        myStream skipLine isNil ifTrue:[
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   168
            lastLineOfFile := lastLineKnown.
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   169
            ^ self
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   170
        ]
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   171
    ]
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   172
! !