OSFileHandle.st
author Jan Vrany <jan.vrany@labware.com>
Wed, 22 Mar 2023 13:57:18 +0000
branchjv
changeset 25445 1623217d2268
parent 18120 e3a375d5f6a8
permissions -rw-r--r--
Cherry-picked OrderedCollection.st from 0b286fd51da7: * d4c86d7c0bfc: #TUNING by stefan, Stefan Vogel <sv@exept.de> * 692b6497a669: #DOCUMENTATION by stefan, Stefan Vogel <sv@exept.de> * d47bb2912953: #DOCUMENTATION by stefan, Stefan Vogel <sv@exept.de> * abb4316c6bff: #FEATURE by cg, Claus Gittinger <cg@exept.de> * 3a8fce0e8d11: #TUNING by stefan, Stefan Vogel <sv@exept.de> * 03d29bf8c5bb: #REFACTORING by stefan, Stefan Vogel <sv@exept.de> * cccc6c4abcfc: #REFACTORING by stefan, Stefan Vogel <sv@exept.de> * 35d957c7a840: #FEATURE by cg, Claus Gittinger <cg@exept.de> * 6b11890f5f2c: #OTHER by cg, Claus Gittinger <cg@exept.de> * abb6108fb06b: #FEATURE by cg, Claus Gittinger <cg@exept.de> * 2c4768bb2e89: #FEATURE by cg, Claus Gittinger <cg@exept.de> * 4029e964d0f1: #FEATURE by cg, Claus Gittinger <cg@exept.de> * ddcab3a9c2df: #OTHER by cg, Claus Gittinger <cg@exept.de> * 2213eb56e0c7: #REFACTORING by exept, Claus Gittinger <cg@exept.de> * 09ca874a6160: #REFACTORING by exept, Claus Gittinger <cg@exept.de> * 30b332af1f33: #BUGFIX by stefan, Stefan Vogel <sv@exept.de> * 779764ba117b: #REFACTORING by cg, Claus Gittinger <cg@exept.de> * b3d232a613c9: #BUGFIX by stefan, Stefan Vogel <sv@exept.de> * c417f7edaec1: #BUGFIX by stefan, Stefan Vogel <sv@exept.de> * 904b6538f379: #FEATURE by exept, Claus Gittinger <cg@exept.de> * c5887f03e01f: #REFACTORING by stefan, Stefan Vogel <sv@exept.de> * 8912d03aff48: #BUGFIX by exept, Claus Gittinger <cg@exept.de> * de5cd1dab4c3: #DOCUMENTATION by exept, Claus Gittinger <cg@exept.de> * 9bbd26603378: #OTHER by exept, Claus Gittinger <cg@exept.de> * c2c9dc110f42: #FEATURE by stefan, Stefan Vogel <sv@exept.de> * 81d123c6703d: #DOCUMENTATION by stefan, Stefan Vogel <sv@exept.de> * 8aadbb21458a: #BUGFIX by stefan, Stefan Vogel <sv@exept.de> * f210dbb8b2f6: #TUNING by stefan, Stefan Vogel <sv@exept.de> * c2c774fc53c0: #FEATURE by exept, Claus Gittinger <cg@exept.de> * b6f462670875: #DOCUMENTATION by exept, Claus Gittinger <cg@exept.de> * 27ae4021d5d6: #FEATURE by stefan, Stefan Vogel <sv@exept.de> * 10d9e9d85594: #TUNING by exept, Claus Gittinger <cg@exept.de> * 2653d855dcc7: #DOCUMENTATION by exept, Claus Gittinger <cg@exept.de> * 6ea1698a1a34: #FEATURE by stefan, Stefan Vogel <sv@exept.de> * 28762315e664: #OTHER by exept, Claus Gittinger <cg@exept.de> * 7142ea786f3e: #TUNING by stefan, Stefan Vogel <sv@exept.de> * 7875acb42b53: #BUGFIX by stefan, Stefan Vogel <sv@exept.de> * 163a0eebc97e: #BUGFIX by Maren, matilk
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
7593
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
     1
"
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
     2
 COPYRIGHT (c) 1999 by eXept Software AG
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
     3
              All Rights Reserved
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
     4
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
     5
 This software is furnished under a license and may be used
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
     6
 only in accordance with the terms of that license and with the
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
     8
 be provided or otherwise made available to, or used by, any
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
     9
 other person.  No title to or ownership of the software is
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    10
 hereby transferred.
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    11
"
5409
9b5890348f9c *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 4763
diff changeset
    12
"{ Package: 'stx:libbasic' }"
9b5890348f9c *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 4763
diff changeset
    13
4763
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    14
OSHandle subclass:#OSFileHandle
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    15
	instanceVariableNames:''
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    16
	classVariableNames:'ConcreteClass'
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    17
	poolDictionaries:''
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    18
	category:'System-Support'
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    19
!
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    20
7593
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    21
!OSFileHandle class methodsFor:'documentation'!
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    22
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    23
copyright
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    24
"
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    25
 COPYRIGHT (c) 1999 by eXept Software AG
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    26
              All Rights Reserved
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    27
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    28
 This software is furnished under a license and may be used
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    29
 only in accordance with the terms of that license and with the
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    30
 inclusion of the above copyright notice.   This software may not
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    31
 be provided or otherwise made available to, or used by, any
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    32
 other person.  No title to or ownership of the software is
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    33
 hereby transferred.
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    34
"
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
    35
! !
4763
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    36
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    37
!OSFileHandle class methodsFor:'initialization'!
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    38
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    39
initialize
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    40
    "initialize for the OS we are running on"
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    41
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    42
    self initializeConcreteClass
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    43
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    44
    "
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    45
     self initialize
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    46
    "
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    47
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    48
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    49
!
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    50
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    51
initializeConcreteClass
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    52
    "initialize for the OS we are running on"
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    53
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    54
    OperatingSystem isMSDOSlike ifTrue:[
6289
82cf5f13d5d7 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5413
diff changeset
    55
        ConcreteClass := Win32FILEHandle
4763
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    56
    ] ifFalse:[
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    57
        OperatingSystem isVMSlike ifTrue:[
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    58
            ConcreteClass := OpenVMSFileHandle
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    59
        ] ifFalse:[
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    60
            OperatingSystem isUNIXlike ifTrue:[
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    61
                ConcreteClass := UnixFileHandle
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    62
            ] ifFalse:[
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    63
                ConcreteClass := nil
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    64
            ]
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    65
        ]
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    66
    ]
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    67
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    68
    "
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    69
     self initializeConcreteClass
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    70
    "
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    71
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    72
    "Modified: 7.9.1997 / 23:32:37 / cg"
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    73
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    74
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    75
!
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    76
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    77
reinitialize
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    78
    "initialize for the OS we are running on"
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    79
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    80
    self initializeConcreteClass
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    81
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    82
    "
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    83
     self reinitialize
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    84
    "
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    85
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    86
! !
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    87
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    88
!OSFileHandle methodsFor:'finalization'!
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    89
6439
0f841258ec4a Use #finalize instead of #disposed
Stefan Vogel <sv@exept.de>
parents: 6289
diff changeset
    90
finalize
5409
9b5890348f9c *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 4763
diff changeset
    91
    "a filedescriptor was garbage collected - close the underlying file"
4763
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    92
16549
f390a82315e7 class: OSFileHandle
Claus Gittinger <cg@exept.de>
parents: 9101
diff changeset
    93
    "/ with timeout to avoid blocking in a bad pty/socket
f390a82315e7 class: OSFileHandle
Claus Gittinger <cg@exept.de>
parents: 9101
diff changeset
    94
    [
f390a82315e7 class: OSFileHandle
Claus Gittinger <cg@exept.de>
parents: 9101
diff changeset
    95
        self closeFile
f390a82315e7 class: OSFileHandle
Claus Gittinger <cg@exept.de>
parents: 9101
diff changeset
    96
    ] valueWithTimeout:30 seconds
5409
9b5890348f9c *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 4763
diff changeset
    97
! !
9b5890348f9c *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 4763
diff changeset
    98
5413
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
    99
!OSFileHandle methodsFor:'input/output'!
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   100
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   101
readBytes:count into:aByteBuffer startingAt:startAddress
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   102
    "read count bytes into a byte-buffer;
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   103
     Return the number of bytes read (negative on error)"
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   104
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   105
    ^ self subclassResponsibility
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   106
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   107
!
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   108
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   109
writeBytes:count from:aByteBuffer startingAt:startAddress
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   110
    "write count bytes from a byte-buffer;
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   111
     Return the number of bytes written (negative on error)"
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   112
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   113
    ^ self subclassResponsibility
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   114
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   115
! !
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   116
5409
9b5890348f9c *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 4763
diff changeset
   117
!OSFileHandle methodsFor:'release'!
9b5890348f9c *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 4763
diff changeset
   118
9b5890348f9c *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 4763
diff changeset
   119
close
9b5890348f9c *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 4763
diff changeset
   120
    "close the file"
9b5890348f9c *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 4763
diff changeset
   121
9b5890348f9c *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 4763
diff changeset
   122
    self closeFile.
9b5890348f9c *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 4763
diff changeset
   123
    self unregisterForFinalization.
5413
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   124
!
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   125
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   126
closeFile
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   127
    "close the underlying file"
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   128
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   129
    self subclassResponsibility
4e67713bf25a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 5409
diff changeset
   130
4763
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   131
! !
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   132
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   133
!OSFileHandle class methodsFor:'documentation'!
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   134
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   135
version
16549
f390a82315e7 class: OSFileHandle
Claus Gittinger <cg@exept.de>
parents: 9101
diff changeset
   136
    ^ '$Header: /cvs/stx/stx/libbasic/OSFileHandle.st,v 1.8 2014-06-07 15:08:16 cg Exp $'
4763
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   137
! !
7593
e7550b9ef84a *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 6439
diff changeset
   138
16549
f390a82315e7 class: OSFileHandle
Claus Gittinger <cg@exept.de>
parents: 9101
diff changeset
   139
4763
d15c41a66ec4 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   140
OSFileHandle initialize!