src/Plugin/Plugin.hxx

   1 // Created on: 1997-02-28
   2 // Created by: Jean-Louis Frenkel
   3 // Copyright (c) 1997-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _Plugin_HeaderFile
  18 #define _Plugin_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Boolean.hxx>
  25 class Standard_Transient;
  26 class Standard_GUID;
  27 class Resource_Manager;
  28
  29
  30
  31 class Plugin
  32 {
  33 public:
  34
  35   DEFINE_STANDARD_ALLOC
  36
  37
  38   Standard_EXPORT static Handle(Standard_Transient) Load (const Standard_GUID& aGUID, const Standard_Boolean theVerbose = Standard_True);
  39
  40   //! Returns a global map of {guid, plugin_library} pairs.
  41   //! The Load() method will use this map to search for plugins if and only if
  42   //! the GUID is not found in the Plugin file specified by the CSF_PluginDefaults
  43   //! (or CSF_PluginUserDefaults) environment variable, or if they are not defined.
  44   //!
  45   //! This allows to populate this additional resource manager
  46   //! in run-time and to avoid using the above environment variables.
  47   //! This map must be populated (using Resource_Manager::SetResource() method)
  48   //! following syntax conventions of the Plugin file, for instance:
  49   //! const Handle(Resource_Manager)& aPluginMap = Plugin::AdditionalPluginMap();
  50   //! aPluginMap->SetResource ("ad696000-5b34-11d1-b5ba-00a0c9064368.Location", "TKStdSchema");
  51   Standard_EXPORT static const Handle(Resource_Manager)& AdditionalPluginMap();
  52
  53
  54
  55
  56 protected:
  57
  58
  59
  60
  61
  62 private:
  63
  64
  65
  66
  67
  68 };
  69
  70
  71
  72
  73
  74
  75
  76 #endif // _Plugin_HeaderFile