include/tools/globname.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 #ifndef INCLUDED_TOOLS_GLOBNAME_HXX
  20 #define INCLUDED_TOOLS_GLOBNAME_HXX
  21
  22 #include <vector>
  23
  24 #include <tools/toolsdllapi.h>
  25 #include <com/sun/star/uno/Sequence.hxx>
  26 #include <o3tl/cow_wrapper.hxx>
  27
  28 struct SvGUID
  29 {
  30     sal_uInt32 Data1;
  31     sal_uInt16 Data2;
  32     sal_uInt16 Data3;
  33     sal_uInt8  Data4[8];
  34 };
  35
  36 struct ImpSvGlobalName
  37 {
  38     struct SvGUID   szData;
  39
  40     ImpSvGlobalName(const SvGUID &rData)
  41         : szData(rData)
  42     {
  43     }
  44     ImpSvGlobalName(sal_uInt32 n1, sal_uInt16 n2, sal_uInt16 n3,
  45               sal_uInt8 b8, sal_uInt8 b9, sal_uInt8 b10, sal_uInt8 b11,
  46               sal_uInt8 b12, sal_uInt8 b13, sal_uInt8 b14, sal_uInt8 b15);
  47     ImpSvGlobalName( const ImpSvGlobalName & rObj );
  48     ImpSvGlobalName();
  49
  50     bool        operator == ( const ImpSvGlobalName & rObj ) const;
  51 };
  52
  53 class SvStream;
  54
  55 class TOOLS_DLLPUBLIC SvGlobalName
  56 {
  57     ::o3tl::cow_wrapper< ImpSvGlobalName > pImp;
  58
  59 public:
  60     SvGlobalName();
  61     SvGlobalName( const SvGlobalName & rObj ) :
  62         pImp( rObj.pImp )
  63     {
  64     }
  65     SvGlobalName( SvGlobalName && rObj ) :
  66         pImp( std::move(rObj.pImp) )
  67     {
  68     }
  69
  70     SvGlobalName( sal_uInt32 n1, sal_uInt16 n2, sal_uInt16 n3,
  71                   sal_uInt8 b8, sal_uInt8 b9, sal_uInt8 b10, sal_uInt8 b11,
  72                   sal_uInt8 b12, sal_uInt8 b13, sal_uInt8 b14, sal_uInt8 b15 );
  73
  74     // create SvGlobalName from a platform independent representation
  75     SvGlobalName( const css::uno::Sequence< sal_Int8 >& aSeq );
  76
  77     SvGlobalName( const SvGUID & rId );
  78
  79     SvGlobalName & operator = ( const SvGlobalName & rObj );
  80     SvGlobalName & operator = ( SvGlobalName && rObj );
  81     ~SvGlobalName();
  82
  83     TOOLS_DLLPUBLIC friend SvStream & operator >> ( SvStream &, SvGlobalName & );
  84     TOOLS_DLLPUBLIC friend SvStream & WriteSvGlobalName( SvStream &, const SvGlobalName & );
  85
  86     bool          operator < ( const SvGlobalName & rObj ) const;
  87     SvGlobalName& operator += ( sal_uInt32 );
  88
  89     bool          operator == ( const SvGlobalName & rObj ) const;
  90     bool          operator != ( const SvGlobalName & rObj ) const
  91                       { return !(*this == rObj); }
  92
  93     void          MakeFromMemory( void const * pData );
  94     bool          MakeId( const OUString & rId );
  95     OUString      GetHexName() const;
  96
  97     const SvGUID& GetCLSID() const { return pImp->szData; }
  98
  99     // platform independent representation of a "GlobalName"
 100     // maybe transported remotely
 101     css::uno::Sequence < sal_Int8 > GetByteSequence() const;
 102 };
 103
 104 #endif
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */