Merge branch 'nstd.os.windows.shared_lib'

Author: RustEnthusiast

Cargo.toml

@@ -37,6 +37,9 @@ nstd_os_unix_shared_lib = ["libc", "nstd_core", "nstd_os"]
 nstd_os_windows_alloc = [
     "nstd_core", "nstd_os", "windows-sys/Win32_Foundation", "windows-sys/Win32_System_Memory"
 ]
+nstd_os_windows_shared_lib = [
+    "nstd_core", "nstd_os", "windows-sys/Win32_Foundation", "windows-sys/Win32_System_LibraryLoader"
+]
 nstd_shared_lib = ["libloading", "nstd_core", "std"]
 nstd_shared_ptr = ["nstd_alloc", "nstd_core"]
 nstd_string = ["nstd_alloc", "nstd_core", "nstd_vec"]

README.md

@@ -54,6 +54,7 @@ int main()
         - `windows` - OS support for Windows.
             - `alloc` - Low level memory allocation for Windows.
                 - `heap` - Process heap management for Windows.
+            - `shared_lib` - Shared library/module access for Windows.
     - `shared_lib` - Access symbols from loaded shared libraries.
     - `shared_ptr` - A reference counting smart pointer.
     - `string` - Dynamically sized UTF-8 encoded byte string.

include/nstd/os/windows.h

@@ -1,4 +1,5 @@
 #ifndef NSTD_OS_WINDOWS_H
 #define NSTD_OS_WINDOWS_H
 #include "windows/alloc.h"
+#include "windows/shared_lib.h"
 #endif

include/nstd/os/windows/shared_lib.h

@@ -0,0 +1,80 @@
+#ifndef NSTD_OS_WINDOWS_SHARED_LIB_H
+#define NSTD_OS_WINDOWS_SHARED_LIB_H
+#include "../../core/optional.h"
+#include "../../nstd.h"
+
+/// A handle to a loaded library.
+typedef struct {
+    /// A raw handle to the module.
+    NSTDInt handle;
+} NSTDWindowsSharedLib;
+
+/// An optional (possibly null) shared Windows library handle.
+NSTDOptional(NSTDWindowsSharedLib) NSTDWindowsOptionalSharedLib;
+
+/// Loads a shared library/module by name.
+///
+/// # Parameters:
+///
+/// - `const NSTDChar *name` - The name of the module to load.
+///
+/// # Returns
+///
+/// `NSTDWindowsOptionalSharedLib lib` - A handle to the shared library.
+///
+/// # Safety
+///
+/// See
+/// <https://docs.microsoft.com/en-us/windows/win32/api/libloaderapi/nf-libloaderapi-loadlibrarya>.
+NSTDAPI NSTDWindowsOptionalSharedLib nstd_os_windows_shared_lib_load(const NSTDChar *name);
+
+/// Gets a pointer to a function or static variable in a dynamically loaded library by symbol name.
+///
+/// # Parameters
+///
+/// - `const NSTDWindowsSharedLib *lib` - The loaded library.
+///
+/// - `const NSTDChar *symbol` - The name of the function or variable to get a pointer to.
+///
+/// # Returns
+///
+/// `NSTDAny ptr` - A pointer to the function or variable.
+///
+/// # Safety
+///
+/// See <https://docs.microsoft.com/en-us/windows/win32/api/libloaderapi/nf-libloaderapi-getprocaddress>.
+NSTDAPI NSTDAny nstd_os_windows_shared_lib_get(const NSTDWindowsSharedLib *lib,
+const NSTDChar *symbol);
+
+/// Gets a mutable pointer to a function or static variable in a dynamically loaded library by
+/// symbol name.
+///
+/// # Parameters
+///
+/// - `NSTDWindowsSharedLib *lib` - The loaded library.
+///
+/// - `const NSTDChar *symbol` - The name of the function or variable to get a pointer to.
+///
+/// # Returns
+///
+/// `NSTDAnyMut ptr` - A pointer to the function or variable.
+///
+/// # Safety
+///
+/// See <https://docs.microsoft.com/en-us/windows/win32/api/libloaderapi/nf-libloaderapi-getprocaddress>.
+NSTDAPI NSTDAnyMut nstd_os_windows_shared_lib_get_mut(NSTDWindowsSharedLib *lib,
+const NSTDChar *symbol);
+
+/// Unloads and frees a dynamically loaded shared library.
+///
+/// # Parameters:
+///
+/// - `NSTDWindowsSharedLib lib` - The library handle.
+///
+/// # Safety
+///
+/// See
+/// <https://docs.microsoft.com/en-us/windows/win32/api/libloaderapi/nf-libloaderapi-freelibrary>.
+NSTDAPI void nstd_os_windows_shared_lib_free(NSTDWindowsSharedLib lib);
+
+#endif

src/os/windows.rs

@@ -2,3 +2,6 @@
 #[cfg(feature = "nstd_os_windows_alloc")]
 #[cfg_attr(doc_cfg, doc(cfg(feature = "nstd_os_windows_alloc")))]
 pub mod alloc;
+#[cfg(feature = "nstd_os_windows_shared_lib")]
+#[cfg_attr(doc_cfg, doc(cfg(feature = "nstd_os_windows_shared_lib")))]
+pub mod shared_lib;

src/os/windows/shared_lib.rs

@@ -0,0 +1,110 @@
+//! Shared library/module access for Windows.
+use crate::{core::optional::NSTDOptional, NSTDAny, NSTDAnyMut, NSTDChar, NSTDInt};
+use windows_sys::Win32::System::LibraryLoader::{FreeLibrary, GetProcAddress, LoadLibraryA};
+
+/// A handle to a loaded library.
+#[repr(C)]
+pub struct NSTDWindowsSharedLib {
+    /// A raw handle to the module.
+    handle: NSTDInt,
+}
+impl Drop for NSTDWindowsSharedLib {
+    /// [NSTDWindowsSharedLib]'s destructor.
+    #[inline]
+    fn drop(&mut self) {
+        // SAFETY: `handle` is non-null.
+        unsafe { FreeLibrary(self.handle) };
+    }
+}
+
+/// An optional (possibly null) shared Windows library handle.
+pub type NSTDWindowsOptionalSharedLib = NSTDOptional<NSTDWindowsSharedLib>;
+
+/// Loads a shared library/module by name.
+///
+/// # Parameters:
+///
+/// - `const NSTDChar *name` - The name of the module to load.
+///
+/// # Returns
+///
+/// `NSTDWindowsOptionalSharedLib lib` - A handle to the shared library.
+///
+/// # Safety
+///
+/// See
+/// <https://docs.microsoft.com/en-us/windows/win32/api/libloaderapi/nf-libloaderapi-loadlibrarya>.
+#[inline]
+#[cfg_attr(feature = "clib", no_mangle)]
+pub unsafe extern "C" fn nstd_os_windows_shared_lib_load(
+    name: *const NSTDChar,
+) -> NSTDWindowsOptionalSharedLib {
+    match LoadLibraryA(name.cast()) {
+        0 => NSTDOptional::None,
+        handle => NSTDOptional::Some(NSTDWindowsSharedLib { handle }),
+    }
+}
+
+/// Gets a pointer to a function or static variable in a dynamically loaded library by symbol name.
+///
+/// # Parameters
+///
+/// - `const NSTDWindowsSharedLib *lib` - The loaded library.
+///
+/// - `const NSTDChar *symbol` - The name of the function or variable to get a pointer to.
+///
+/// # Returns
+///
+/// `NSTDAny ptr` - A pointer to the function or variable.
+///
+/// # Safety
+///
+/// See <https://docs.microsoft.com/en-us/windows/win32/api/libloaderapi/nf-libloaderapi-getprocaddress>.
+#[inline]
+#[cfg_attr(feature = "clib", no_mangle)]
+pub unsafe extern "C" fn nstd_os_windows_shared_lib_get(
+    lib: &NSTDWindowsSharedLib,
+    symbol: *const NSTDChar,
+) -> NSTDAny {
+    core::mem::transmute(GetProcAddress(lib.handle, symbol.cast()))
+}
+
+/// Gets a mutable pointer to a function or static variable in a dynamically loaded library by
+/// symbol name.
+///
+/// # Parameters
+///
+/// - `NSTDWindowsSharedLib *lib` - The loaded library.
+///
+/// - `const NSTDChar *symbol` - The name of the function or variable to get a pointer to.
+///
+/// # Returns
+///
+/// `NSTDAnyMut ptr` - A pointer to the function or variable.
+///
+/// # Safety
+///
+/// See <https://docs.microsoft.com/en-us/windows/win32/api/libloaderapi/nf-libloaderapi-getprocaddress>.
+#[inline]
+#[cfg_attr(feature = "clib", no_mangle)]
+pub unsafe extern "C" fn nstd_os_windows_shared_lib_get_mut(
+    lib: &mut NSTDWindowsSharedLib,
+    symbol: *const NSTDChar,
+) -> NSTDAnyMut {
+    core::mem::transmute(GetProcAddress(lib.handle, symbol.cast()))
+}
+
+/// Unloads and frees a dynamically loaded shared library.
+///
+/// # Parameters:
+///
+/// - `NSTDWindowsSharedLib lib` - The library handle.
+///
+/// # Safety
+///
+/// See
+/// <https://docs.microsoft.com/en-us/windows/win32/api/libloaderapi/nf-libloaderapi-freelibrary>.
+#[inline]
+#[cfg_attr(feature = "clib", no_mangle)]
+#[allow(unused_variables)]
+pub unsafe extern "C" fn nstd_os_windows_shared_lib_free(lib: NSTDWindowsSharedLib) {}

test.py

@@ -1,8 +1,9 @@
 import os
 
 FEATURES = ("nstd_alloc", "nstd_core", "nstd_cstring", "nstd_fs", "nstd_heap_ptr", "nstd_io",
-            "nstd_math", "nstd_os_unix_shared_lib", "nstd_os_windows_alloc", "nstd_shared_lib",
-            "nstd_shared_ptr", "nstd_string", "nstd_vec")
+            "nstd_math", "nstd_os_unix_shared_lib", "nstd_os_windows_alloc",
+            "nstd_os_windows_shared_lib", "nstd_shared_lib", "nstd_shared_ptr", "nstd_string",
+            "nstd_vec")
 
 TARGETS = ("x86_64-pc-windows-msvc", "x86_64-apple-darwin",
            "x86_64-unknown-linux-gnu", "x86_64-apple-ios", "x86_64-linux-android")