include/tools/resid.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_TOOLS_RESID_HXX
  21 #define INCLUDED_TOOLS_RESID_HXX
  22
  23 #include <osl/diagnose.h>
  24 #include <rtl/ustring.hxx>
  25 #include <tools/solar.h>
  26 #include <tools/toolsdllapi.h>
  27
  28 struct RSHEADER_TYPE;
  29 typedef sal_uInt32 RESOURCE_TYPE;
  30 #define RSC_NOTYPE              0x100
  31 #define RSC_DONTRELEASE         (sal_uInt32(1U << 31))
  32
  33 class ResMgr;
  34
  35 class ResId
  36 {
  37     /*
  38     Consider two cases:
  39     either
  40     (a) m_pResource is valid and points to a resource data buffer;
  41         then m_nResId and m_pResMgr are not used and may be 0 and nullptr respectively
  42     or
  43     (b) m_pResource is NULL, then m_nResId and m_pResMgr must be valid.
  44         In this case the highest bit, if set, decides whether or not to
  45         release the Resource context after loading this id.
  46     */
  47     RSHEADER_TYPE*          m_pResource;
  48     mutable sal_uInt32      m_nResId;      // Resource Identifier
  49     mutable RESOURCE_TYPE   m_nRT;         // type for loading (mutable to be set later)
  50     mutable ResMgr *        m_pResMgr;     // load from this ResMgr (mutable for setting on demand)
  51
  52     void ImplInit( sal_uInt32 nId, ResMgr& rMgr, RSHEADER_TYPE* pRes )
  53     {
  54         m_pResource = pRes; m_nResId = nId; m_nRT = RSC_NOTYPE; m_pResMgr = &rMgr;
  55         OSL_ENSURE( m_pResMgr != nullptr, "ResId without ResMgr created" );
  56     }
  57
  58 public:
  59     ResId( RSHEADER_TYPE * pRc, ResMgr& rMgr )
  60     {
  61         ImplInit( 0, rMgr, pRc );
  62     }
  63     ResId( sal_uInt32 nId, ResMgr& rMgr )
  64     {
  65         ImplInit( nId, rMgr, nullptr );
  66     }
  67
  68     RESOURCE_TYPE   GetRT() const { return m_nRT; }
  69
  70     /** Set the type if not already set. Ask for type with GetRT()
  71
  72     [Example]
  73     ResId aId( 1000 );
  74     aId.SetRT( RSC_RESOURCE );    // settype window Resource
  75     //aId.GetRT() == RSC_RESOURCE is true
  76
  77     @see
  78     ResId::GetRT2(), ResId::GetRT()
  79     */
  80      const ResId &   SetRT( RESOURCE_TYPE nType ) const
  81      {
  82          if( RSC_NOTYPE == m_nRT )
  83              m_nRT = nType;
  84          return *this;
  85      }
  86
  87     ResMgr *        GetResMgr() const { return m_pResMgr; }
  88     void            ClearResMgr() const { m_pResMgr = nullptr; }
  89
  90     const ResId &  SetAutoRelease(bool bRelease) const
  91     {
  92         if( bRelease )
  93             m_nResId &= ~RSC_DONTRELEASE;
  94         else
  95             m_nResId |= RSC_DONTRELEASE;
  96         return *this;
  97     }
  98
  99     bool            IsAutoRelease()  const { return !(m_nResId & RSC_DONTRELEASE); }
 100
 101     sal_uInt32      GetId()          const { return m_nResId & ~RSC_DONTRELEASE; }
 102     RSHEADER_TYPE*  GetpResource()   const { return m_pResource; }
 103
 104     TOOLS_DLLPUBLIC OUString toString() const;
 105     TOOLS_DLLPUBLIC operator OUString() const { return toString(); }
 106 };
 107
 108 #endif
 109
 110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */