library.h

// Copyright (c) 2020-now by the Zeek Project. See LICENSE for details.
 
#pragma once
 
#include <cstdint>
#include <string>
 
#include <hilti/rt/filesystem.h>
#include <hilti/rt/result.h>
#include <hilti/rt/util.h>
 
namespace hilti::rt::library {
 
struct Version {
    std::string magic;      
    uint64_t hilti_version; 
    bool debug;             
    hilti::rt::filesystem::path path; 
    std::string toJSON() const;
 
    static hilti::rt::Result<Version> fromJSON(const std::string& json);
 
    void checkCompatibility() const;
 
    friend bool operator==(const Version& a, const Version& b) {
        return a.magic == b.magic && a.hilti_version == b.hilti_version && a.debug == b.debug;
    }
 
    friend bool operator!=(const Version& a, const Version& b) { return ! (a == b); }
};
 
} // namespace hilti::rt::library
 
namespace hilti::rt {
 
class Library {
public:
    Library(const hilti::rt::filesystem::path& path);
    ~Library();
 
    // Since this library has exclusive ownership of some path it cannot be copied.
    Library(const Library&) = delete;
    Library& operator=(const Library&) = delete;
 
    Library(Library&&) = default;
    Library& operator=(Library&&) = default;
 
    hilti::rt::Result<hilti::rt::library::Version> open() const;
 
    hilti::rt::Result<Nothing> save(const hilti::rt::filesystem::path& path) const;
 
    // Gets a symbol from the library.
    //
    // @param name name of the symbol
    // @return a valid pointer to the symbol or an error
    hilti::rt::Result<void*> symbol(const char* name) const;
 
    /*
     * Remove the file corresponding to this library without unloading it.
     *
     * @return nothing or an error
     */
    hilti::rt::Result<Nothing> remove() const;
 
    static void setScope(uint64_t* scope);
 
private:
    hilti::rt::filesystem::path _path; // Absolute path to the physical file wrapped by this instance.
    mutable void* _handle = nullptr;   // Handle to the library.
 
    static std::optional<hilti::rt::filesystem::path>
        _current_path; // absolute path to library currently being loaded, if any
};
 
} // namespace hilti::rt