err.no Git - sope/blob - sope-core/NGStreams/NGStreams/NGTextStream.h

   1 /*
   2   Copyright (C) 2000-2003 SKYRIX Software AG
   3
   4   This file is part of OGo
   5
   6   OGo is free software; you can redistribute it and/or modify it under
   7   the terms of the GNU Lesser General Public License as published by the
   8   Free Software Foundation; either version 2, or (at your option) any
   9   later version.
  10
  11   OGo is distributed in the hope that it will be useful, but WITHOUT ANY
  12   WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  14   License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public
  17   License along with OGo; see the file COPYING.  If not, write to the
  18   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19   02111-1307, USA.
  20 */
  21 // $Id$
  22
  23 #ifndef __NGStreams_NGTextStream_H__
  24 #define __NGStreams_NGTextStream_H__
  25
  26 #import <Foundation/NSObject.h>
  27 #include <NGStreams/NGTextStreamProtocols.h>
  28
  29 @class NSException;
  30
  31 @interface NGTextStream : NSObject < NGExtendedTextStream >
  32 {
  33 @private
  34   NSException *lastException;
  35 }
  36
  37 // NGTextInputStream
  38
  39 - (unichar)readCharacter;       // abstract
  40 - (NSException *)lastException;
  41 - (void)setLastException:(NSException *)_exception;
  42 - (void)resetLastException;
  43
  44 // NGExtendedTextInputStream
  45
  46 - (NSString *)readLineAsString; // inefficient
  47 - (unsigned)readCharacters:(unichar *)_chars count:(unsigned)_count;
  48 - (BOOL)safeReadCharacters:(unichar *)_chars count:(unsigned)_count;
  49
  50 // NGTextOutputStream
  51
  52 - (BOOL)writeCharacter:(unichar)_character; // abstract
  53 - (BOOL)writeString:(NSString *)_string;    // writeCharacter: based
  54 - (BOOL)flush; // does nothing
  55
  56 // NGExtendedTextOutputStream
  57
  58 - (BOOL)writeFormat:(NSString *)_format arguments:(va_list)_ap;
  59 - (BOOL)writeFormat:(NSString *)_format, ...;
  60 - (BOOL)writeNewline;
  61
  62 - (unsigned)writeCharacters:(const unichar *)_chars count:(unsigned)_count;
  63 - (BOOL)safeWriteCharacters:(const unichar *)_chars count:(unsigned)_count;
  64
  65 @end
  66
  67 #endif /* __NGStreams_NGTextStream_H__ */