include/oox/helper/textinputstream.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_OOX_HELPER_TEXTINPUTSTREAM_HXX
  21 #define INCLUDED_OOX_HELPER_TEXTINPUTSTREAM_HXX
  22
  23 #include <com/sun/star/uno/Reference.hxx>
  24 #include <rtl/textenc.h>
  25 #include <rtl/ustring.hxx>
  26 #include <sal/types.h>
  27
  28 namespace com::sun::star {
  29     namespace io { class XInputStream; }
  30     namespace io { class XTextInputStream2; }
  31     namespace uno { class XComponentContext; }
  32 }
  33
  34 namespace oox {
  35
  36 class BinaryInputStream;
  37
  38
  39 class TextInputStream
  40 {
  41 public:
  42     explicit            TextInputStream(
  43                             const css::uno::Reference< css::uno::XComponentContext >& rxContext,
  44                             const css::uno::Reference< css::io::XInputStream >& rxInStrm,
  45                             rtl_TextEncoding eTextEnc );
  46
  47     explicit            TextInputStream(
  48                             const css::uno::Reference< css::uno::XComponentContext >& rxContext,
  49                             BinaryInputStream& rInStrm,
  50                             rtl_TextEncoding eTextEnc );
  51
  52                         ~TextInputStream();
  53
  54     /** Returns true, if no more text is available in the stream.
  55      */
  56     bool                isEof() const;
  57
  58     /** Reads a text line from the stream.
  59
  60         If the last line in the stream is not terminated with line-end
  61         character(s), the stream will immediately go into EOF state and return
  62         the text line. Otherwise, if the last character in the stream is a
  63         line-end character, the next call to this function will turn the stream
  64         into EOF state and return an empty string.
  65      */
  66     OUString     readLine();
  67
  68     /** Reads a text portion from the stream until the specified character is
  69         found.
  70
  71         If the end of the stream is not terminated with the specified
  72         character, the stream will immediately go into EOF state and return the
  73         remaining text portion. Otherwise, if the last character in the stream
  74         is the specified character (and caller specifies to read and return it,
  75         see parameter bIncludeChar), the next call to this function will turn
  76         the stream into EOF state and return an empty string.
  77
  78         @param cChar
  79             The separator character to be read to.
  80
  81         @param bIncludeChar
  82             True = if found, the specified character will be read from stream
  83                 and included in the returned string.
  84             False = the specified character will neither be read from the
  85                 stream nor included in the returned string, but will be
  86                 returned as first character in the next call of this function
  87                 or readLine().
  88      */
  89     OUString     readToChar( sal_Unicode cChar, bool bIncludeChar );
  90
  91
  92     /** Creates a UNO text input stream object from the passed UNO input stream.
  93      */
  94     static css::uno::Reference< css::io::XTextInputStream2 >
  95                         createXTextInputStream(
  96                             const css::uno::Reference< css::uno::XComponentContext >& rxContext,
  97                             const css::uno::Reference< css::io::XInputStream >& rxInStrm,
  98                             rtl_TextEncoding eTextEnc );
  99
 100
 101 private:
 102     void                init(
 103                             const css::uno::Reference< css::uno::XComponentContext >& rxContext,
 104                             const css::uno::Reference< css::io::XInputStream >& rxInStrm,
 105                             rtl_TextEncoding eTextEnc );
 106
 107     /** Adds the pending character in front of the passed string, if existing. */
 108     OUString     createFinalString( const OUString& rString );
 109
 110 private:
 111     css::uno::Reference< css::io::XTextInputStream2 >
 112                         mxTextStrm;
 113     sal_Unicode         mcPendingChar;
 114 };
 115
 116
 117 } // namespace oox
 118
 119 #endif
 120
 121 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */