#DOCUMENTATION by cg
authorClaus Gittinger <cg@exept.de>
Thu, 22 Sep 2016 15:08:00 +0200
changeset 20411 5094bd64e3f0
parent 20410 e29f691e0a22
child 20412 aee4d28b38c5
#DOCUMENTATION by cg class: ExternalStream comment/format in: #documentation
ExternalStream.st
--- a/ExternalStream.st	Thu Sep 22 15:05:59 2016 +0200
+++ b/ExternalStream.st	Thu Sep 22 15:08:00 2016 +0200
@@ -1,3 +1,5 @@
+"{ Encoding: utf8 }"
+
 "
  COPYRIGHT (c) 1988 by Claus Gittinger
 	      All Rights Reserved
@@ -1386,37 +1388,37 @@
 
     [Instance variables:]
 
-	handleType      <Symbol>        desribes what handle is:
-					    win32: #fileHandle, #socketHandle,
-						   #filePointer, #socketFilePointer, #pipeFilePointer
-					    unix: #filePointer, #socketFilePointer, #pipeFilePointer
-					needed for win32, which uses different APIs for the different handles (sigh)
-	handle          <Integer>       used to be always a filePointer somehow mapped to an integer (FILE* - not the fd);
-					now, either a filePointer or a handle (win32)
-	mode            <Symbol>        #readwrite, #readonly or #writeonly
-	buffered        <Boolean>       true, if buffered (i.e. collects characters - does
-					not output immediately)
-	binary          <Boolean>       true if in binary mode (reads bytes instead of chars)
-	eolMode         <Symbol>        one of nil, #nl, #cr or #crlf.
-					determines how lines should be terminated.
-					nil -> newLine (as in Unix);
-					#crlf -> with cr-lf (as in MSDOS)
-					#cr -> with cr (as in VMS)
-	hitEOF          <Boolean>       true, if EOF was reached
-
-	lastErrorNumber <Integer>       the value of errno (only valid right after the error -
-					updated with next i/o operation)
+        handleType      <Symbol>        desribes what handle is:
+                                            win32: #fileHandle, #socketHandle,
+                                                   #filePointer, #socketFilePointer, #pipeFilePointer
+                                            unix: #filePointer, #socketFilePointer, #pipeFilePointer
+                                        needed for win32, which uses different APIs for the different handles (sigh)
+        handle          <Integer>       used to be always a filePointer somehow mapped to an integer (FILE* - not the fd);
+                                        now, either a filePointer or a handle (win32)
+        mode            <Symbol>        #readwrite, #readonly or #writeonly
+        buffered        <Boolean>       true, if buffered (i.e. collects characters - does
+                                        not output immediately)
+        binary          <Boolean>       true if in binary mode (reads bytes instead of chars)
+        eolMode         <Symbol>        one of nil, #nl, #cr or #crlf.
+                                        determines how lines should be terminated.
+                                        nil -> newLine (as in Unix);
+                                        #crlf -> with cr-lf (as in MSDOS)
+                                        #cr -> with cr (as in VMS)
+        hitEOF          <Boolean>       true, if EOF was reached
+
+        lastErrorNumber <Integer>       the value of errno (only valid right after the error -
+                                        updated with next i/o operation)
 
     [Class variables:]
-	Lobby           <Registry>      keeps track of used ext-streams (to free up FILE*'s)
-
-	StreamErrorSignal       <Signal> parent of all stream errors (see Stream class)
-	InvalidReadSignal       <Signal> raised on read from writeonly stream
-	InvalidWriteSignal      <Signal> raised on write to readonly stream
-	InvalidModeSignal       <Signal> raised on text I/O with binary-stream
-					 or binary I/O with text-stream
-	OpenErrorSignal         <Signal> raised if open fails
-	StreamNotOpenSignal     <Signal> raised on I/O with non-open stream
+        Lobby           <Registry>      keeps track of used ext-streams (to free up FILE*'s)
+
+        StreamErrorSignal       <Signal> parent of all stream errors (see Stream class)
+        InvalidReadSignal       <Signal> raised on read from writeonly stream
+        InvalidWriteSignal      <Signal> raised on write to readonly stream
+        InvalidModeSignal       <Signal> raised on text I/O with binary-stream
+                                         or binary I/O with text-stream
+        OpenErrorSignal         <Signal> raised if open fails
+        StreamNotOpenSignal     <Signal> raised on I/O with non-open stream
 
     Additional notes:
       This class is implemented using the underlying stdio-c library package, which
@@ -1430,7 +1432,7 @@
       occur while reading (for example, timer interrupts) - on real unixes (i.e. BSD) the signal
       is handled transparently - on SYS5.3 (i.e. non unixes :-) the read operation returns
       an error and errno is set to EINTR.
-      Thats what the ugly code around all getc-calls is for ...
+      That's what the ugly code around all getc-calls is for ...
       Since things get more and more ugly - we will rewrite ExternalStream
       completely, to NOT use any stdio stuff (and do its buffering itself).
 
@@ -1450,12 +1452,12 @@
       fread/fgetc and fwrite/putc respectively.
 
     [author:]
-	Claus Gittinger
-	Stefan Vogel (many, many fixes ...)
+        Claus Gittinger
+        Stefan Vogel (many, many fixes ...)
 
     [see also:]
-	FileStream Socket PipeStream
-	Filename OperatingSystem
+        FileStream Socket PipeStream
+        Filename OperatingSystem
 "
 !
 
@@ -4618,7 +4620,7 @@
     "
         (FileStream newTemporary
             nextPutUtf16:$B;
-            nextPutUtf16:$Ä;
+            nextPutUtf16:$Ä;
             nextPutUtf16:(Character codePoint:16r10CCCC);
             reset;
             binary;
@@ -6570,7 +6572,7 @@
     ].
 
     "
-	'Bönnigheim' asUnicode16String errorPrintCR
+	'Bönnigheim' asUnicode16String errorPrintCR
     "
 !