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