Line data    Source code

       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 _SVT_DOCUMENTLOCKFILE_HXX
      21             : #define _SVT_DOCUMENTLOCKFILE_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             : #include <com/sun/star/lang/XMultiServiceFactory.hpp>
      31             : 
      32             : #include <svl/lockfilecommon.hxx>
      33             : 
      34             : namespace svt {
      35             : 
      36             : class SVL_DLLPUBLIC DocumentLockFile : public LockFileCommon
      37             : {
      38             :     // the workaround for automated testing!
      39             :     static sal_Bool m_bAllowInteraction;
      40             : 
      41             :     ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > OpenStream();
      42             : 
      43             :     void WriteEntryToStream( ::com::sun::star::uno::Sequence< ::rtl::OUString > aEntry, ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream > xStream );
      44             : 
      45             : public:
      46             :     DocumentLockFile( const ::rtl::OUString& aOrigURL, const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xFactory = ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >() );
      47             :     ~DocumentLockFile();
      48             : 
      49             :     sal_Bool CreateOwnLockFile();
      50             :     ::com::sun::star::uno::Sequence< ::rtl::OUString > GetLockData();
      51             :     sal_Bool OverwriteOwnLockFile();
      52             :     void RemoveFile();
      53             : 
      54             :     // the methods allow to control whether UI interaction regarding the locked document file is allowed
      55             :     // this is a workaround for automated tests
      56           0 :     static void AllowInteraction( sal_Bool bAllow ) { m_bAllowInteraction = bAllow; }
      57           0 :     static sal_Bool IsInteractionAllowed() { return m_bAllowInteraction; }
      58             : };
      59             : 
      60             : }
      61             : 
      62             : #endif
      63             : 
      64             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */