DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (6663d3dc883b)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_DynamicallyLinkedFunctionPtr_h
#define mozilla_DynamicallyLinkedFunctionPtr_h

#include <windows.h>

#include <utility>

#include "mozilla/Attributes.h"

namespace mozilla {
namespace detail {

template <typename T>
struct FunctionPtrCracker;

template <typename R, typename... Args>
struct FunctionPtrCracker<R (*)(Args...)> {
  using ReturnT = R;
  using FunctionPtrT = R (*)(Args...);
};

#if defined(_M_IX86)
template <typename R, typename... Args>
struct FunctionPtrCracker<R(__stdcall*)(Args...)> {
  using ReturnT = R;
  using FunctionPtrT = R(__stdcall*)(Args...);
};

template <typename R, typename... Args>
struct FunctionPtrCracker<R(__fastcall*)(Args...)> {
  using ReturnT = R;
  using FunctionPtrT = R(__fastcall*)(Args...);
};
#endif  // defined(_M_IX86)

template <typename T>
class DynamicallyLinkedFunctionPtrBase {
 public:
  using ReturnT = typename FunctionPtrCracker<T>::ReturnT;
  using FunctionPtrT = typename FunctionPtrCracker<T>::FunctionPtrT;

  DynamicallyLinkedFunctionPtrBase(const wchar_t* aLibName,
                                   const char* aFuncName)
      : mModule(::LoadLibraryW(aLibName)), mFunction(nullptr) {
    if (!mModule) {
      return;
    }

    mFunction =
        reinterpret_cast<FunctionPtrT>(::GetProcAddress(mModule, aFuncName));

    if (!mFunction) {
      // Since the function doesn't exist, there is no point in holding a
      // reference to mModule anymore.
      ::FreeLibrary(mModule);
      mModule = nullptr;
    }
  }

  DynamicallyLinkedFunctionPtrBase(const DynamicallyLinkedFunctionPtrBase&) =
      delete;
  DynamicallyLinkedFunctionPtrBase& operator=(
      const DynamicallyLinkedFunctionPtrBase&) = delete;

  DynamicallyLinkedFunctionPtrBase(DynamicallyLinkedFunctionPtrBase&&) = delete;
  DynamicallyLinkedFunctionPtrBase& operator=(
      DynamicallyLinkedFunctionPtrBase&&) = delete;

  template <typename... Args>
  ReturnT operator()(Args&&... args) const {
    return mFunction(std::forward<Args>(args)...);
  }

  explicit operator bool() const { return !!mFunction; }

 protected:
  HMODULE mModule;
  FunctionPtrT mFunction;
};

}  // namespace detail

/**
 * In most cases, this class is the one that you want to use for resolving a
 * dynamically-linked function pointer. It should be instantiated as a static
 * local variable.
 *
 * NB: It has a trivial destructor, so the DLL that is loaded is never freed.
 * Assuming that this function is called fairly often, this is the most
 * sensible option. OTOH, if the function you are calling is a one-off, or the
 * static local requirement is too restrictive, use DynamicallyLinkedFunctionPtr
 * instead.
 */
template <typename T>
class MOZ_STATIC_LOCAL_CLASS StaticDynamicallyLinkedFunctionPtr final
    : public detail::DynamicallyLinkedFunctionPtrBase<T> {
 public:
  StaticDynamicallyLinkedFunctionPtr(const wchar_t* aLibName,
                                     const char* aFuncName)
      : detail::DynamicallyLinkedFunctionPtrBase<T>(aLibName, aFuncName) {}

  /**
   * We only offer this operator for the static local case, as it is not
   * possible for this object to be destroyed while the returned pointer is
   * being held.
   */
  operator typename detail::DynamicallyLinkedFunctionPtrBase<T>::FunctionPtrT()
      const {
    return this->mFunction;
  }
};

template <typename T>
class MOZ_NON_PARAM MOZ_NON_TEMPORARY_CLASS DynamicallyLinkedFunctionPtr final
    : public detail::DynamicallyLinkedFunctionPtrBase<T> {
 public:
  DynamicallyLinkedFunctionPtr(const wchar_t* aLibName, const char* aFuncName)
      : detail::DynamicallyLinkedFunctionPtrBase<T>(aLibName, aFuncName) {}

  ~DynamicallyLinkedFunctionPtr() {
    if (!this->mModule) {
      return;
    }

    ::FreeLibrary(this->mModule);
  }
};

}  // namespace mozilla

#endif  // mozilla_DynamicallyLinkedFunctionPtr_h