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

   1 /*
   2   Copyright (C) 2000-2005 SKYRIX Software AG
   3
   4   This file is part of SOPE.
   5
   6   SOPE 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   SOPE 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 SOPE; 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
  22 #ifndef __NGStreams_NGStringTextStream_H__
  23 #define __NGStreams_NGStringTextStream_H__
  24
  25 #include <NGStreams/NGTextStream.h>
  26 #include <NGStreams/NGTextStreamProtocols.h>
  27
  28 /*
  29   NGStringTextStream
  30
  31   A text stream which navigates inside an NSString or NSMutableString object.
  32 */
  33
  34 @interface NGStringTextStream : NGTextStream
  35 {
  36 @private
  37   NSString *string; // retained
  38   unsigned index;   // position
  39   BOOL     isMutable;
  40 }
  41
  42 + (id)textStreamWithString:(NSString *)_string;
  43 - (id)initWithString:(NSString *)_string;
  44
  45 // accessors
  46
  47 - (NSString *)string;
  48
  49 // operations
  50
  51 - (BOOL)close; // releases string
  52
  53 // NGTextInputStream, NGExtendedTextInputStream
  54
  55 - (unichar)readCharacter;
  56
  57 - (NSString *)readLineAsString; // inefficient implementation
  58
  59 // NGTextOutputStream, NGExtendedTextOutputStream
  60
  61 // throws
  62 //   NGReadOnlyStreamException when the stream is not writeable
  63 //   NGStreamNotOpenException  when the stream is not open
  64 - (BOOL)writeCharacter:(unichar)_character;
  65
  66 // throws
  67 //   NGReadOnlyStreamException when the stream is not writeable
  68 //   NGStreamNotOpenException  when the stream is not open
  69 - (BOOL)writeString:(NSString *)_string;
  70
  71 - (BOOL)flush;
  72
  73 @end
  74
  75 #endif /* __NGStreams_NGStringTextStream_H__ */