xref: /AOO41X/main/oox/source/helper/textinputstream.cxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #include "oox/helper/textinputstream.hxx"
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir #include <com/sun/star/io/XActiveDataSink.hpp>
31*cdf0e10cSrcweir #include <com/sun/star/io/XTextInputStream.hpp>
32*cdf0e10cSrcweir #include <cppuhelper/implbase1.hxx>
33*cdf0e10cSrcweir #include <rtl/tencinfo.h>
34*cdf0e10cSrcweir #include "oox/helper/binaryinputstream.hxx"
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir namespace oox {
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir // ============================================================================
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir using namespace ::com::sun::star::io;
41*cdf0e10cSrcweir using namespace ::com::sun::star::lang;
42*cdf0e10cSrcweir using namespace ::com::sun::star::uno;
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir using ::rtl::OUString;
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir // ============================================================================
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir namespace {
49*cdf0e10cSrcweir 
50*cdf0e10cSrcweir typedef ::cppu::WeakImplHelper1< XInputStream > UnoBinaryInputStream_BASE;
51*cdf0e10cSrcweir 
52*cdf0e10cSrcweir /** Implementation of a UNO input stream wrapping a binary input stream.
53*cdf0e10cSrcweir  */
54*cdf0e10cSrcweir class UnoBinaryInputStream : public UnoBinaryInputStream_BASE
55*cdf0e10cSrcweir {
56*cdf0e10cSrcweir public:
57*cdf0e10cSrcweir     explicit            UnoBinaryInputStream( BinaryInputStream& rInStrm );
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir     virtual sal_Int32 SAL_CALL readBytes( Sequence< sal_Int8 >& rData, sal_Int32 nBytesToRead )
60*cdf0e10cSrcweir                         throw (NotConnectedException, BufferSizeExceededException, IOException, RuntimeException);
61*cdf0e10cSrcweir     virtual sal_Int32 SAL_CALL readSomeBytes( Sequence< sal_Int8 >& rData, sal_Int32 nMaxBytesToRead )
62*cdf0e10cSrcweir                         throw (NotConnectedException, BufferSizeExceededException, IOException, RuntimeException);
63*cdf0e10cSrcweir     virtual void SAL_CALL skipBytes( sal_Int32 nBytesToSkip )
64*cdf0e10cSrcweir                         throw (NotConnectedException, BufferSizeExceededException, IOException, RuntimeException);
65*cdf0e10cSrcweir     virtual sal_Int32 SAL_CALL available()
66*cdf0e10cSrcweir                         throw (NotConnectedException, IOException, RuntimeException);
67*cdf0e10cSrcweir     virtual void SAL_CALL closeInput()
68*cdf0e10cSrcweir                         throw (NotConnectedException, IOException, RuntimeException);
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir private:
71*cdf0e10cSrcweir     void                ensureConnected() const throw (NotConnectedException);
72*cdf0e10cSrcweir 
73*cdf0e10cSrcweir private:
74*cdf0e10cSrcweir     BinaryInputStream*  mpInStrm;
75*cdf0e10cSrcweir };
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir // ----------------------------------------------------------------------------
78*cdf0e10cSrcweir 
79*cdf0e10cSrcweir UnoBinaryInputStream::UnoBinaryInputStream( BinaryInputStream& rInStrm ) :
80*cdf0e10cSrcweir     mpInStrm( &rInStrm )
81*cdf0e10cSrcweir {
82*cdf0e10cSrcweir }
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir sal_Int32 SAL_CALL UnoBinaryInputStream::readBytes( Sequence< sal_Int8 >& rData, sal_Int32 nBytesToRead )
85*cdf0e10cSrcweir         throw (NotConnectedException, BufferSizeExceededException, IOException, RuntimeException)
86*cdf0e10cSrcweir {
87*cdf0e10cSrcweir     ensureConnected();
88*cdf0e10cSrcweir     return mpInStrm->readData( rData, nBytesToRead, 1 );
89*cdf0e10cSrcweir }
90*cdf0e10cSrcweir 
91*cdf0e10cSrcweir sal_Int32 SAL_CALL UnoBinaryInputStream::readSomeBytes( Sequence< sal_Int8 >& rData, sal_Int32 nMaxBytesToRead )
92*cdf0e10cSrcweir         throw (NotConnectedException, BufferSizeExceededException, IOException, RuntimeException)
93*cdf0e10cSrcweir {
94*cdf0e10cSrcweir     ensureConnected();
95*cdf0e10cSrcweir     return mpInStrm->readData( rData, nMaxBytesToRead, 1 );
96*cdf0e10cSrcweir }
97*cdf0e10cSrcweir 
98*cdf0e10cSrcweir void SAL_CALL UnoBinaryInputStream::skipBytes( sal_Int32 nBytesToSkip )
99*cdf0e10cSrcweir         throw (NotConnectedException, BufferSizeExceededException, IOException, RuntimeException)
100*cdf0e10cSrcweir {
101*cdf0e10cSrcweir     ensureConnected();
102*cdf0e10cSrcweir     mpInStrm->skip( nBytesToSkip, 1 );
103*cdf0e10cSrcweir }
104*cdf0e10cSrcweir 
105*cdf0e10cSrcweir sal_Int32 SAL_CALL UnoBinaryInputStream::available() throw (NotConnectedException, IOException, RuntimeException)
106*cdf0e10cSrcweir {
107*cdf0e10cSrcweir     ensureConnected();
108*cdf0e10cSrcweir     throw RuntimeException( CREATE_OUSTRING( "Functionality not supported" ), Reference< XInputStream >() );
109*cdf0e10cSrcweir }
110*cdf0e10cSrcweir 
111*cdf0e10cSrcweir void SAL_CALL UnoBinaryInputStream::closeInput() throw (NotConnectedException, IOException, RuntimeException)
112*cdf0e10cSrcweir {
113*cdf0e10cSrcweir     ensureConnected();
114*cdf0e10cSrcweir     mpInStrm->close();
115*cdf0e10cSrcweir     mpInStrm = 0;
116*cdf0e10cSrcweir }
117*cdf0e10cSrcweir 
118*cdf0e10cSrcweir void UnoBinaryInputStream::ensureConnected() const throw (NotConnectedException)
119*cdf0e10cSrcweir {
120*cdf0e10cSrcweir     if( !mpInStrm )
121*cdf0e10cSrcweir         throw NotConnectedException( CREATE_OUSTRING( "Stream closed" ), Reference< XInterface >() );
122*cdf0e10cSrcweir }
123*cdf0e10cSrcweir 
124*cdf0e10cSrcweir } // namespace
125*cdf0e10cSrcweir 
126*cdf0e10cSrcweir // ============================================================================
127*cdf0e10cSrcweir 
128*cdf0e10cSrcweir TextInputStream::TextInputStream( const Reference< XComponentContext >& rxContext, const Reference< XInputStream >& rxInStrm, rtl_TextEncoding eTextEnc )
129*cdf0e10cSrcweir {
130*cdf0e10cSrcweir     init( rxContext, rxInStrm, eTextEnc );
131*cdf0e10cSrcweir }
132*cdf0e10cSrcweir 
133*cdf0e10cSrcweir TextInputStream::TextInputStream( const Reference< XComponentContext >& rxContext, BinaryInputStream& rInStrm, rtl_TextEncoding eTextEnc )
134*cdf0e10cSrcweir {
135*cdf0e10cSrcweir     init( rxContext, new UnoBinaryInputStream( rInStrm ), eTextEnc );
136*cdf0e10cSrcweir }
137*cdf0e10cSrcweir 
138*cdf0e10cSrcweir TextInputStream::~TextInputStream()
139*cdf0e10cSrcweir {
140*cdf0e10cSrcweir }
141*cdf0e10cSrcweir 
142*cdf0e10cSrcweir bool TextInputStream::isEof() const
143*cdf0e10cSrcweir {
144*cdf0e10cSrcweir     if( mxTextStrm.is() ) try
145*cdf0e10cSrcweir     {
146*cdf0e10cSrcweir         return mxTextStrm->isEOF();
147*cdf0e10cSrcweir     }
148*cdf0e10cSrcweir     catch( Exception& )
149*cdf0e10cSrcweir     {
150*cdf0e10cSrcweir     }
151*cdf0e10cSrcweir     return true;
152*cdf0e10cSrcweir }
153*cdf0e10cSrcweir 
154*cdf0e10cSrcweir OUString TextInputStream::readLine()
155*cdf0e10cSrcweir {
156*cdf0e10cSrcweir     if( mxTextStrm.is() ) try
157*cdf0e10cSrcweir     {
158*cdf0e10cSrcweir         /*  The function createFinalString() adds a character that may have
159*cdf0e10cSrcweir             been buffered in the previous call of readToChar() (see below). */
160*cdf0e10cSrcweir         return createFinalString( mxTextStrm->readLine() );
161*cdf0e10cSrcweir     }
162*cdf0e10cSrcweir     catch( Exception& )
163*cdf0e10cSrcweir     {
164*cdf0e10cSrcweir         mxTextStrm.clear();
165*cdf0e10cSrcweir     }
166*cdf0e10cSrcweir     return OUString();
167*cdf0e10cSrcweir }
168*cdf0e10cSrcweir 
169*cdf0e10cSrcweir OUString TextInputStream::readToChar( sal_Unicode cChar, bool bIncludeChar )
170*cdf0e10cSrcweir {
171*cdf0e10cSrcweir     if( mxTextStrm.is() ) try
172*cdf0e10cSrcweir     {
173*cdf0e10cSrcweir         Sequence< sal_Unicode > aDelimiters( 1 );
174*cdf0e10cSrcweir         aDelimiters[ 0 ] = cChar;
175*cdf0e10cSrcweir         /*  Always get the delimiter character from the UNO text input stream.
176*cdf0e10cSrcweir             In difference to this implementation, it will not return it in the
177*cdf0e10cSrcweir             next call but silently skip it. If caller specifies to exclude the
178*cdf0e10cSrcweir             character in this call, it will be returned in the next call of one
179*cdf0e10cSrcweir             of the own member functions. The function createFinalString() adds
180*cdf0e10cSrcweir             a character that has been buffered in the previous call. */
181*cdf0e10cSrcweir         OUString aString = createFinalString( mxTextStrm->readString( aDelimiters, sal_False ) );
182*cdf0e10cSrcweir         // remove last character from string and remember it for next call
183*cdf0e10cSrcweir         if( !bIncludeChar && (aString.getLength() > 0) && (aString[ aString.getLength() - 1 ] == cChar) )
184*cdf0e10cSrcweir         {
185*cdf0e10cSrcweir             mcPendingChar = cChar;
186*cdf0e10cSrcweir             aString = aString.copy( 0, aString.getLength() - 1 );
187*cdf0e10cSrcweir         }
188*cdf0e10cSrcweir         return aString;
189*cdf0e10cSrcweir     }
190*cdf0e10cSrcweir     catch( Exception& )
191*cdf0e10cSrcweir     {
192*cdf0e10cSrcweir         mxTextStrm.clear();
193*cdf0e10cSrcweir     }
194*cdf0e10cSrcweir     return OUString();
195*cdf0e10cSrcweir }
196*cdf0e10cSrcweir 
197*cdf0e10cSrcweir /*static*/ Reference< XTextInputStream > TextInputStream::createXTextInputStream(
198*cdf0e10cSrcweir         const Reference< XComponentContext >& rxContext, const Reference< XInputStream >& rxInStrm, rtl_TextEncoding eTextEnc )
199*cdf0e10cSrcweir {
200*cdf0e10cSrcweir     Reference< XTextInputStream > xTextStrm;
201*cdf0e10cSrcweir     const char* pcCharset = rtl_getMimeCharsetFromTextEncoding( eTextEnc );
202*cdf0e10cSrcweir     OSL_ENSURE( pcCharset, "TextInputStream::createXTextInputStream - unsupported text encoding" );
203*cdf0e10cSrcweir     if( rxContext.is() && rxInStrm.is() && pcCharset ) try
204*cdf0e10cSrcweir     {
205*cdf0e10cSrcweir         Reference< XMultiServiceFactory > xFactory( rxContext->getServiceManager(), UNO_QUERY_THROW );
206*cdf0e10cSrcweir         Reference< XActiveDataSink > xDataSink( xFactory->createInstance( CREATE_OUSTRING( "com.sun.star.io.TextInputStream" ) ), UNO_QUERY_THROW );
207*cdf0e10cSrcweir         xDataSink->setInputStream( rxInStrm );
208*cdf0e10cSrcweir         xTextStrm.set( xDataSink, UNO_QUERY_THROW );
209*cdf0e10cSrcweir         xTextStrm->setEncoding( OUString::createFromAscii( pcCharset ) );
210*cdf0e10cSrcweir     }
211*cdf0e10cSrcweir     catch( Exception& )
212*cdf0e10cSrcweir     {
213*cdf0e10cSrcweir     }
214*cdf0e10cSrcweir     return xTextStrm;
215*cdf0e10cSrcweir }
216*cdf0e10cSrcweir 
217*cdf0e10cSrcweir // private --------------------------------------------------------------------
218*cdf0e10cSrcweir 
219*cdf0e10cSrcweir OUString TextInputStream::createFinalString( const OUString& rString )
220*cdf0e10cSrcweir {
221*cdf0e10cSrcweir     if( mcPendingChar == 0 )
222*cdf0e10cSrcweir         return rString;
223*cdf0e10cSrcweir 
224*cdf0e10cSrcweir     OUString aString = OUString( mcPendingChar ) + rString;
225*cdf0e10cSrcweir     mcPendingChar = 0;
226*cdf0e10cSrcweir     return aString;
227*cdf0e10cSrcweir }
228*cdf0e10cSrcweir 
229*cdf0e10cSrcweir void TextInputStream::init( const Reference< XComponentContext >& rxContext, const Reference< XInputStream >& rxInStrm, rtl_TextEncoding eTextEnc )
230*cdf0e10cSrcweir {
231*cdf0e10cSrcweir     mcPendingChar = 0;
232*cdf0e10cSrcweir     mxTextStrm = createXTextInputStream( rxContext, rxInStrm, eTextEnc );
233*cdf0e10cSrcweir }
234*cdf0e10cSrcweir 
235*cdf0e10cSrcweir // ============================================================================
236*cdf0e10cSrcweir 
237*cdf0e10cSrcweir } // namespace oox
238