include/svl/documentlockfile.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_DOCUMENTLOCKFILE_HXX
  21 #define INCLUDED_SVL_DOCUMENTLOCKFILE_HXX
  22
  23 #include <svl/svldllapi.h>
  24
  25 #include <svl/lockfilecommon.hxx>
  26
  27 namespace com::sun::star::io { class XInputStream; }
  28 namespace com::sun::star::io { class XOutputStream; }
  29
  30 namespace svt {
  31
  32 /// Generalized class for LO and MSO lockfile handling.
  33 class SVL_DLLPUBLIC GenDocumentLockFile : public LockFileCommon
  34 {
  35 public:
  36     GenDocumentLockFile(const OUString& aLockFileURL);
  37     virtual ~GenDocumentLockFile() override;
  38
  39     bool CreateOwnLockFile();
  40     bool OverwriteOwnLockFile();
  41     /// Delete the Lockfile, if current user is the owner
  42     virtual void RemoveFile();
  43     /// Only delete lockfile, disregarding ownership
  44     void RemoveFileDirectly();
  45
  46     LockFileEntry GetLockData();
  47
  48 protected:
  49     virtual LockFileEntry GetLockDataImpl(std::unique_lock<std::mutex>& rGuard) = 0;
  50     virtual void WriteEntryToStream( std::unique_lock<std::mutex>& rGuard, const LockFileEntry& aEntry, const css::uno::Reference< css::io::XOutputStream >& xStream ) = 0;
  51     virtual css::uno::Reference< css::io::XInputStream > OpenStream(std::unique_lock<std::mutex>& rGuard);
  52 };
  53
  54 /// Class implementing reading and writing LO lockfiles.
  55 class SVL_DLLPUBLIC DocumentLockFile final : public GenDocumentLockFile
  56 {
  57     virtual void WriteEntryToStream( std::unique_lock<std::mutex>& rGuard, const LockFileEntry& aEntry, const css::uno::Reference< css::io::XOutputStream >& xStream ) override;
  58
  59 public:
  60     DocumentLockFile( std::u16string_view aOrigURL );
  61     virtual ~DocumentLockFile() override;
  62
  63 protected:
  64     virtual LockFileEntry GetLockDataImpl(std::unique_lock<std::mutex>& rGuard) override;
  65 };
  66
  67 }
  68
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */