include/comphelper/streamsection.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_COMPHELPER_STREAMSECTION_HXX
  21 #define INCLUDED_COMPHELPER_STREAMSECTION_HXX
  22
  23 #include <config_options.h>
  24 #include <com/sun/star/uno/Reference.h>
  25 #include <comphelper/comphelperdllapi.h>
  26
  27 namespace com::sun::star::io
  28 {
  29 class XDataInputStream;
  30 }
  31 namespace com::sun::star::io
  32 {
  33 class XDataOutputStream;
  34 }
  35 namespace com::sun::star::io
  36 {
  37 class XMarkableStream;
  38 }
  39
  40 namespace comphelper
  41 {
  42 /** implements handling for compatibly reading/writing data from/into an input/output stream.
  43     data written in a block secured by this class should be readable by older versions which
  44     use the same mechanism.
  45 */
  46
  47 class UNLESS_MERGELIBS(COMPHELPER_DLLPUBLIC) OStreamSection
  48 {
  49     css::uno::Reference<css::io::XMarkableStream> m_xMarkStream;
  50     css::uno::Reference<css::io::XDataInputStream> m_xInStream;
  51     css::uno::Reference<css::io::XDataOutputStream> m_xOutStream;
  52
  53     sal_Int32 m_nBlockStart;
  54     sal_Int32 m_nBlockLen;
  55
  56 public:
  57     /** starts reading of a "skippable" section of data within the given input stream<BR>
  58         @param      _rxInput    the stream to read from. Must support the
  59                                 css::io::XMarkableStream interface
  60     */
  61     OStreamSection(const css::uno::Reference<css::io::XDataInputStream>& _rxInput);
  62
  63     /** starts writing of a "skippable" section of data into the given output stream
  64         @param      _rxOutput           the stream the stream to write to. Must support the
  65                                         css::io::XMarkableStream interface
  66     */
  67     OStreamSection(const css::uno::Reference<css::io::XDataOutputStream>& _rxOutput);
  68
  69     /** dtor. <BR>If constructed for writing, the section "opened" by this object will be "closed".<BR>
  70         If constructed for reading, any remaining bytes 'til the end of the section will be skipped.
  71     */
  72     ~OStreamSection();
  73 };
  74
  75 } // namespace comphelper
  76
  77 #endif // INCLUDED_COMPHELPER_STREAMSECTION_HXX
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */