include/svl/lockfilecommon.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_LOCKFILECOMMON_HXX
  21 #define INCLUDED_SVL_LOCKFILECOMMON_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 <osl/mutex.hxx>
  32 #include <tools/urlobj.hxx>
  33 #include <o3tl/enumarray.hxx>
  34 #include <vector>
  35
  36 enum class LockFileComponent
  37 {
  38     OOOUSERNAME, SYSUSERNAME, LOCALHOST, EDITTIME, USERURL, LAST=USERURL
  39 };
  40
  41 typedef o3tl::enumarray<LockFileComponent,OUString> LockFileEntry;
  42
  43 namespace svt {
  44
  45 // This is a general implementation that is used in document lock file implementation and in sharing control file implementation
  46 class SVL_DLLPUBLIC LockFileCommon
  47 {
  48 protected:
  49     ::osl::Mutex m_aMutex;
  50     OUString m_aURL;
  51
  52     INetURLObject ResolveLinks( const INetURLObject& aDocURL );
  53
  54 public:
  55     LockFileCommon( const OUString& aOrigURL, const OUString& aPrefix );
  56     ~LockFileCommon();
  57
  58     static void ParseList( const css::uno::Sequence< sal_Int8 >& aBuffer, std::vector< LockFileEntry > &rOutput );
  59     static LockFileEntry ParseEntry( const css::uno::Sequence< sal_Int8 >& aBuffer, sal_Int32& o_nCurPos );
  60     static OUString ParseName( const css::uno::Sequence< sal_Int8 >& aBuffer, sal_Int32& o_nCurPos );
  61     static OUString EscapeCharacters( const OUString& aSource );
  62     static OUString GetOOOUserName();
  63     static OUString GetCurrentLocalTime();
  64     static LockFileEntry GenerateOwnEntry();
  65 };
  66
  67 }
  68
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */