lfilesystem_DynamicLibrary.h

Go to the documentation of this file.

/*
 * ======================================================================================
 *  __    ____  __  __  ____  ___
 * (  )  (_  _)(  \/  )( ___)/ __)
 *  )(__  _)(_  )    (  )__) \__ \
 * (____)(____)(_/\/\_)(____)(___/
 *
 *  This file is part of the Limes open source library and is licensed under the terms of the GNU Public License.
 *
 *  Commercial licenses are available; contact the maintainers at ben.the.vining@gmail.com to inquire for details.
 *
 * ======================================================================================
 */
 
#pragma once
 
#if defined(_WIN32) || defined(WIN32)
#   include <windows.h>
#endif
 
#include <string_view>
#include <string>
#include <atomic>
#include <vector>
#include "lfilesystem/lfilesystem_Export.h"
#include "lfilesystem/lfilesystem_FileWatcher.h"
#include "lfilesystem/lfilesystem_File.h"
 
namespace limes::files
{
 
class LFILE_EXPORT DynamicLibrary final
{
public:
 
    DynamicLibrary() = default;
 
    explicit DynamicLibrary (const std::string_view& nameOrPath) noexcept;
 
 
    ~DynamicLibrary();
 
    DynamicLibrary (DynamicLibrary&& other) noexcept;
    DynamicLibrary& operator= (DynamicLibrary&& other) noexcept;
 
    DynamicLibrary (const DynamicLibrary&) = delete;
    DynamicLibrary& operator= (const DynamicLibrary&) = delete;
 
#if (defined(_WIN32) || defined(WIN32)) && ! defined(DOXYGEN)
    using Handle = HMODULE;
#else
    using Handle = void*;
#endif
 
    [[nodiscard]] bool operator== (const DynamicLibrary& other) const noexcept;
 
    [[nodiscard]] bool operator!= (const DynamicLibrary& other) const noexcept;
 
    [[nodiscard]] bool isOpen() const noexcept;
 
    [[nodiscard]] Handle getHandle() const noexcept;
 
    [[nodiscard]] void* findFunction (const std::string_view& functionName) noexcept;
 
    bool open (const std::string_view& nameOrPath) noexcept;
 
    void close();
 
    bool reload();
 
    [[nodiscard]] File getFile() const;
 
    [[nodiscard]] std::string getName() const;
 
    class LFILE_EXPORT Reloader final : public FileWatcher
    {
    public:
        explicit Reloader (DynamicLibrary& libraryToReload);
 
    private:
        void fileDeleted (const FilesystemEntry&) final;
        void fileModified (const FilesystemEntry&) final;
 
        DynamicLibrary& library;
    };
 
    class LFILE_EXPORT Listener
    {
    public:
        explicit Listener (DynamicLibrary& library);
 
        virtual ~Listener();
 
        virtual void libraryOpened (bool /*wasSuccessful*/) { }
 
        virtual void libraryClosed() { }
 
        virtual void libraryReloaded (bool /*wasSuccessful*/) { }
 
    private:
        DynamicLibrary& lib;
    };
 
private:
    std::atomic<Handle> handle { nullptr };
 
    std::vector<Listener*> listeners;
 
    bool suppressNotifs { false };
};
 
}  // namespace limes::files
 
namespace std
{
 
template <>
struct LFILE_EXPORT hash<limes::files::DynamicLibrary> final
{
    size_t operator() (const limes::files::DynamicLibrary& l) const noexcept;
};
 
}  // namespace std