org.armedbear.lisp
Class FileStream

java.lang.Object
  extended by org.armedbear.lisp.Lisp
      extended by org.armedbear.lisp.LispObject
          extended by org.armedbear.lisp.Stream
              extended by org.armedbear.lisp.FileStream

public final class FileStream
extends Stream


Nested Class Summary
 
Nested classes/interfaces inherited from class org.armedbear.lisp.Stream
Stream.EolStyle
 
Field Summary
 
Fields inherited from class org.armedbear.lisp.Stream
charPos, elementType, encoding, eolChar, eolStyle, externalFormat, isBinaryStream, isCharacterStream, isInputStream, isOutputStream, keywordDefault, lastChar, lineNumber, offset, platformEolStyle, reader
 
Fields inherited from class org.armedbear.lisp.Lisp
_AUTOLOAD_VERBOSE_, _BACKQUOTE_COUNT_, _BATCH_MODE_, _BQ_VECTOR_FLAG_, _CL_PACKAGE_, _COMPILE_FILE_ENVIRONMENT_, _COMPILE_FILE_TYPE_, _COMPILE_FILE_ZIP_, _CURRENT_PRINT_LENGTH_, _CURRENT_PRINT_LEVEL_, _DEBUG_, _DISASSEMBLER_, _ENABLE_INLINE_EXPANSION_, _EXPLAIN_, _KEYWORD_PACKAGE_, _LOAD_DEPTH_, _LOAD_STREAM_, _NOINFORM_, _PRINT_FASL_, _PRINT_STRUCTURE_, _REQUIRE_STACK_FRAME_, _SAFETY_, _SAVED_BACKTRACE_, _SLOT_UNBOUND_, _SOURCE_, _SOURCE_POSITION_, _SPACE_, _SPEED_, _TRACED_NAMES_, _WARN_ON_REDEFINITION_, ARRAY_DIMENSION_MAX, CALL_REGISTERS_LIMIT, CALL_REGISTERS_MAX, CHAR_MAX, cold, COMPILE_FILE_TYPE, debug, EOF, FUNCTION_NAME, initialized, interrupted, NIL, NULL_VALUE, PACKAGE_CL, PACKAGE_CL_USER, PACKAGE_EXT, PACKAGE_JAVA, PACKAGE_JVM, PACKAGE_KEYWORD, PACKAGE_LOOP, PACKAGE_MOP, PACKAGE_PROF, PACKAGE_SYS, PACKAGE_TPL, profiling, REMEMBER, sampleNow, sampling, STANDARD_READTABLE, T, TRAP_OVERFLOW, TRAP_UNDERFLOW, UNBOUND_VALUE, UNSIGNED_BYTE_16, UNSIGNED_BYTE_32, UNSIGNED_BYTE_32_MAX_VALUE, UNSIGNED_BYTE_8
 
Constructor Summary
FileStream(Pathname pathname, java.lang.String namestring, LispObject elementType, LispObject direction, LispObject ifExists, LispObject format)
           
 
Method Summary
protected  boolean _charReady()
          Returns a boolean indicating input readily available
 void _clearInput()
          Reads all input from the underlying stream, until _charReady() indicates no more input to be available
 void _close()
          Closes the stream and underlying streams
protected  long _getFilePosition()
          Returns a (non-negative) file position integer or a negative value if the position cannot be determined.
protected  boolean _setFilePosition(LispObject arg)
          Sets the file position based on a position designator passed in arg
protected  void _unreadChar(int n)
          Puts a character back into the (underlying) stream
 LispObject classOf()
           
 LispObject fileLength()
           
 Pathname getPathname()
           
 LispObject typeOf()
           
 LispObject typep(LispObject typeSpecifier)
           
 java.lang.String writeToString()
           
 
Methods inherited from class org.armedbear.lisp.Stream
_finishOutput, _readByte, _readChar, _writeByte, _writeChar, _writeChars, _writeLine, _writeString, clearInput, close, faslRead, faslReadArray, faslReadComplex, faslReadPathname, faslReadRadix, faslReadStructure, fileStringLength, finishOutput, freshLine, getCharPos, getElementType, getEncoding, getExternalFormat, getFilePosition, getLineNumber, getOffset, initAsBinaryInputStream, initAsBinaryOutputStream, initAsCharacterInputStream, initAsCharacterOutputStream, invert, isBinaryInputStream, isBinaryOutputStream, isCharacterInputStream, isCharacterOutputStream, isInputStream, isInteractive, isOpen, isOutputStream, listen, prin1, print, printStackTrace, read, readArray, readByte, readChar, readChar, readCharacterLiteral, readCharNoHang, readComplex, readDelimitedList, readDispatchChar, readLine, readList, readPathname, readPreservingWhitespace, readRadix, readStructure, readSymbol, readSymbol, setCharPos, setExternalFormat, setFilePosition, setInteractive, setOpen, setWriter, skipBalancedComment, streamNotBinaryOutputStream, streamNotCharacterInputStream, streamNotCharacterOutputStream, streamNotInputStream, streamNotOutputStream, terpri, toString, unreadChar
 
Methods inherited from class org.armedbear.lisp.LispObject
ABS, add, add, aref_long, aref, AREF, AREF, aset, aset, aset, ash, ash, atom, ATOM, caddr, cadr, car, cddr, cdr, CHAR, characterp, CHARACTERP, chars, COMPLEXP, constantp, CONSTANTP, copyToArray, decr, DENOMINATOR, dispatch, divideBy, doubleValue, elt, endp, ENDP, EQ, eql, eql, eql, EQL, equal, equal, EQUAL, equalp, equalp, evenp, EVENP, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, floatp, FLOATP, floatValue, getBooleanValue, getCallCount, getDescription, getDocumentation, getFixnumSlotValue, getInstance, getParts, getPropertyList, getSlotValue_0, getSlotValue_1, getSlotValue_2, getSlotValue_3, getSlotValue, getSlotValueAsBoolean, getStringChars, getStringValue, getSymbolFunction, getSymbolFunctionOrDie, getSymbolValue, incr, incrementCallCount, integerp, INTEGERP, intValue, IS_E, IS_GE, IS_GT, IS_LE, IS_LT, IS_NE, isEqualTo, isEqualTo, isGreaterThan, isGreaterThan, isGreaterThanOrEqualTo, isGreaterThanOrEqualTo, isLessThan, isLessThan, isLessThanOrEqualTo, isLessThanOrEqualTo, isNotEqualTo, isNotEqualTo, isSpecialOperator, isSpecialVariable, javaInstance, javaInstance, LDB, length, LENGTH, listp, LISTP, LOGAND, LOGAND, LOGIOR, LOGIOR, LOGNOT, LOGXOR, LOGXOR, longValue, minusp, MINUSP, MOD, MOD, multiplyBy, multiplyBy, negate, noFillPointer, NOT, nreverse, NTH, NTH, nthcdr, numberp, NUMBERP, NUMERATOR, oddp, ODDP, plusp, PLUSP, psxhash, psxhash, push, rationalp, RATIONALP, realp, REALP, reverse, RPLACA, RPLACD, SCHAR, setCallCount, setCar, setCdr, setDocumentation, setPropertyList, setSlotValue_0, setSlotValue_1, setSlotValue_2, setSlotValue_3, setSlotValue, setSlotValue, SIMPLE_STRING_P, SLOT_VALUE, STRING, stringp, STRINGP, subtract, subtract, SVREF, svset, sxhash, SYMBOLP, truncate, unreadableString, unreadableString, VECTOR_PUSH_EXTEND, VECTOR_PUSH_EXTEND, vectorp, VECTORP, vectorPushExtend, zerop, ZEROP
 
Methods inherited from class org.armedbear.lisp.Lisp
assq, bindArg, checkArray, checkBinaryInputStream, checkBounds, checkCharacter, checkCharacterInputStream, checkCharacterOutputStream, checkEnvironment, checkFunction, checkList, checkPackage, checkReadtable, checkStream, checkSymbol, checkVector, coerceJavaByteToLispObject, coerceLispObjectToJavaByte, coerceToFunction, coerceToPackage, coerceToPathname, currentReadtable, designator_readtable, error, error, eval, eval, evalCall, exit, exportConstant, exportSpecial, format, funcall, gensym, gensym, get, get, getCurrentPackage, getf, getStandardInput, getStandardOutput, getTerminalIO, getUpgradedArrayElementType, handleInterrupt, inSynonymOf, intern, internConstant, internInPackage, internKeyword, internSpecial, isValidSetfFunctionName, javaString, list, list1, list2, list3, list4, list5, list6, list7, list8, list9, loadCompiledFunction, loadTimeValue, macroexpand_1, macroexpand, makeCompiledClosure, memq, memql, mix, mod, multipleValueCall1, multipleValueList, number, number, number, progn, progvBindVars, put, putf, readObjectFromString, recall, remprop, resetIO, resetIO, safeWriteToString, setInterrupted, type_error, writeByte
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FileStream

public FileStream(Pathname pathname,
                  java.lang.String namestring,
                  LispObject elementType,
                  LispObject direction,
                  LispObject ifExists,
                  LispObject format)
           throws java.io.IOException
Throws:
java.io.IOException
Method Detail

typeOf

public LispObject typeOf()
Overrides:
typeOf in class Stream

classOf

public LispObject classOf()
Overrides:
classOf in class Stream

typep

public LispObject typep(LispObject typeSpecifier)
                 throws ConditionThrowable
Overrides:
typep in class Stream
Throws:
ConditionThrowable

getPathname

public Pathname getPathname()

fileLength

public LispObject fileLength()
                      throws ConditionThrowable
Overrides:
fileLength in class Stream
Throws:
ConditionThrowable

_unreadChar

protected void _unreadChar(int n)
                    throws ConditionThrowable
Description copied from class: Stream
Puts a character back into the (underlying) stream

Overrides:
_unreadChar in class Stream
Throws:
ConditionThrowable

_charReady

protected boolean _charReady()
                      throws ConditionThrowable
Description copied from class: Stream
Returns a boolean indicating input readily available

Overrides:
_charReady in class Stream
Returns:
true if a character is available
Throws:
ConditionThrowable

_clearInput

public void _clearInput()
                 throws ConditionThrowable
Description copied from class: Stream
Reads all input from the underlying stream, until _charReady() indicates no more input to be available

Overrides:
_clearInput in class Stream
Throws:
ConditionThrowable

_getFilePosition

protected long _getFilePosition()
                         throws ConditionThrowable
Description copied from class: Stream
Returns a (non-negative) file position integer or a negative value if the position cannot be determined.

Overrides:
_getFilePosition in class Stream
Returns:
non-negative value as a position spec
Throws:
ConditionThrowable

_setFilePosition

protected boolean _setFilePosition(LispObject arg)
                            throws ConditionThrowable
Description copied from class: Stream
Sets the file position based on a position designator passed in arg

Overrides:
_setFilePosition in class Stream
Parameters:
arg - File position specifier as described in the CLHS
Returns:
true on success, false on failure
Throws:
ConditionThrowable

_close

public void _close()
            throws ConditionThrowable
Description copied from class: Stream
Closes the stream and underlying streams

Overrides:
_close in class Stream
Throws:
ConditionThrowable

writeToString

public java.lang.String writeToString()
                               throws ConditionThrowable
Overrides:
writeToString in class LispObject
Throws:
ConditionThrowable