include/svl/sharecontrolfile.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_SVL_SHARECONTROLFILE_HXX
  21 #define INCLUDED_SVL_SHARECONTROLFILE_HXX
  22
  23 #include <svl/svldllapi.h>
  24
  25 #include <svl/lockfilecommon.hxx>
  26 #include <vector>
  27
  28 namespace com::sun::star::io { class XInputStream; }
  29 namespace com::sun::star::io { class XOutputStream; }
  30 namespace com::sun::star::io { class XSeekable; }
  31 namespace com::sun::star::io { class XStream; }
  32 namespace com::sun::star::io { class XTruncate; }
  33
  34 namespace svt {
  35
  36 class SVL_DLLPUBLIC ShareControlFile final : public LockFileCommon
  37 {
  38     css::uno::Reference< css::io::XStream >       m_xStream;
  39     css::uno::Reference< css::io::XInputStream >  m_xInputStream;
  40     css::uno::Reference< css::io::XOutputStream > m_xOutputStream;
  41     css::uno::Reference< css::io::XSeekable >     m_xSeekable;
  42     css::uno::Reference< css::io::XTruncate >     m_xTruncate;
  43
  44     std::vector< LockFileEntry >                  m_aUsersData;
  45
  46     void Close();
  47     bool IsValid() const
  48     {
  49         return ( m_xStream.is() && m_xInputStream.is() && m_xOutputStream.is() && m_xSeekable.is() && m_xTruncate.is() );
  50     }
  51
  52 public:
  53
  54     // The constructor will throw exception in case the stream can not be opened
  55     ShareControlFile( std::u16string_view aOrigURL );
  56     virtual ~ShareControlFile() override;
  57
  58     std::vector< LockFileEntry > GetUsersData();
  59     void SetUsersDataAndStore( std::vector< LockFileEntry >&& aUserNames );
  60     LockFileEntry InsertOwnEntry();
  61     bool HasOwnEntry();
  62     void RemoveEntry( const LockFileEntry& aOptionalSpecification );
  63     void RemoveEntry();
  64     void RemoveFile();
  65 };
  66
  67 }
  68
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */