1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_XTextInputStream_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_io_XTextInputStream_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_XInputStream_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/io/XInputStream.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_IOException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/io/IOException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================= 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module io { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski/** Interface to read strings from a stream. 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski <p>This interfaces allows to read strings seperated by 43*b1cdbd2cSJim Jagielski delimiters and to read lines. The character encoding 44*b1cdbd2cSJim Jagielski to be used can be set by <member>setEncoding()</member>. 45*b1cdbd2cSJim Jagielski Default encoding is "utf8".</p> 46*b1cdbd2cSJim Jagielski */ 47*b1cdbd2cSJim Jagielskipublished interface XTextInputStream: com::sun::star::io::XInputStream 48*b1cdbd2cSJim Jagielski{ 49*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 50*b1cdbd2cSJim Jagielski /** reads text until a line break (CR, LF, or CR/LF) or 51*b1cdbd2cSJim Jagielski EOF is found and returns it as string (without CR, LF). 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski <p>The read characters are converted according to the 54*b1cdbd2cSJim Jagielski encoding defined by <member>setEncoding</member>. If 55*b1cdbd2cSJim Jagielski EOF is already reached before calling this method 56*b1cdbd2cSJim Jagielski an empty string is returned.<p> 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski @see setEncoding 59*b1cdbd2cSJim Jagielski @see isEOF 60*b1cdbd2cSJim Jagielski */ 61*b1cdbd2cSJim Jagielski string readLine() 62*b1cdbd2cSJim Jagielski raises( com::sun::star::io::IOException ); 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 65*b1cdbd2cSJim Jagielski /** reads text until one of the given delimiter characters 66*b1cdbd2cSJim Jagielski or EOF is found and returns it as string (without delimiter). 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski <p><strong>Important:</strong> CR/LF is not used as default 69*b1cdbd2cSJim Jagielski delimiter! So if no delimiter is defined or none of the 70*b1cdbd2cSJim Jagielski delimiters is found, the stream will be read to EOF. The 71*b1cdbd2cSJim Jagielski read characters are converted according to the encoding 72*b1cdbd2cSJim Jagielski defined by <member>setEncoding</member>. If EOF is already 73*b1cdbd2cSJim Jagielski reached before calling this method an empty string is returned.</p> 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski @see setEncoding 76*b1cdbd2cSJim Jagielski @see isEOF 77*b1cdbd2cSJim Jagielski */ 78*b1cdbd2cSJim Jagielski string readString( [in] sequence<char> Delimiters, [in] boolean bRemoveDelimiter ) 79*b1cdbd2cSJim Jagielski raises( com::sun::star::io::IOException ); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 82*b1cdbd2cSJim Jagielski /** Returns the EOF status. 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski <p>This method has to be used to detect if the end 85*b1cdbd2cSJim Jagielski of the stream is reached.</p> 86*b1cdbd2cSJim Jagielski <p><strong>Important:</strong> 87*b1cdbd2cSJim Jagielski This cannot be detected by asking for an empty string 88*b1cdbd2cSJim Jagielski because that can be a valid return value of <member> 89*b1cdbd2cSJim Jagielski readLine()</member> (if the line is empty) and 90*b1cdbd2cSJim Jagielski readString() (if a delimiter is directly followed 91*b1cdbd2cSJim Jagielski by the next one).</p> 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski @returns 94*b1cdbd2cSJim Jagielski <TRUE/>, if the end of file is reached, so that 95*b1cdbd2cSJim Jagielski no next string can be read. <FALSE/> otherwise 96*b1cdbd2cSJim Jagielski */ 97*b1cdbd2cSJim Jagielski boolean isEOF() 98*b1cdbd2cSJim Jagielski raises( com::sun::star::io::IOException ); 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 101*b1cdbd2cSJim Jagielski /** sets character encoding. 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski @param Encoding 104*b1cdbd2cSJim Jagielski sets the character encoding that should be used. 105*b1cdbd2cSJim Jagielski The character encoding names refer to the document 106*b1cdbd2cSJim Jagielski http://www.iana.org/assignments/character-sets. 107*b1cdbd2cSJim Jagielski Which character sets are supported depends on 108*b1cdbd2cSJim Jagielski the implementation. 109*b1cdbd2cSJim Jagielski */ 110*b1cdbd2cSJim Jagielski void setEncoding( [in] string Encoding ); 111*b1cdbd2cSJim Jagielski}; 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski//============================================================================= 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski}; }; }; }; 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski#endif 118