Initial commit

Author: OpenByteDev

.gitignore

@@ -0,0 +1,4 @@
+/target
+Cargo.lock
+.metadata
+.vscode

Cargo.toml

@@ -0,0 +1,28 @@
+[package]
+name = "lnks"
+version = "0.1.0"
+description = "A library for reading and writing windows shortcuts (.lnk)."
+repository = "https://github.com/OpenByteDev/lnks"
+documentation = "https://docs.rs/lnks"
+license = "MIT"
+authors = ["OpenByte <development.openbyte@gmail.com>"]
+edition = "2024"
+categories = ["api-bindings", "filesystem", "os::windows-apis"]
+keywords = ["lnk", "windows", "shell-link", "parser"]
+
+[dependencies]
+windows = { version = "0.62", features = [
+  "std",
+  "Win32_System_Com",
+  "Win32_UI_Shell_Common",
+  "Win32_Storage_FileSystem",
+  "Win32_UI_WindowsAndMessaging"
+], default-features = false }
+widestring = { version = "1.2", features = ["std"], default-features = false }
+num_enum = { version = "0.7", default-features = false }
+thiserror = { version = "2.0", default-features = false }
+enumflags2 = { version = "0.7", default-features = false }
+
+[dev-dependencies]
+dunce = { version = "1", default-features = false }
+uuid = { version = "1", features = ["v4"], default-features = false  }

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) OpenByte <development.openbyte@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,151 @@
+# lnks
+
+[![CI](https://github.com/OpenByteDev/lnks/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenByteDev/lnks/actions/workflows/ci.yml) [![crates.io](https://img.shields.io/crates/v/lnks.svg)](https://crates.io/crates/lnks) [![Documentation](https://docs.rs/lnks/badge.svg)](https://docs.rs/lnks) [![dependency status](https://deps.rs/repo/github/openbytedev/lnks/status.svg)](https://deps.rs/repo/github/openbytedev/lnks) [![MIT](https://img.shields.io/crates/l/lnks.svg)](https://github.com/OpenByteDev/lnks/blob/master/LICENSE)
+
+<!-- cargo-sync-readme start -->
+
+A Rust library for hosting the .NET Core runtime.
+
+It utilizes the .NET Core hosting API to load and execute managed code from within the current process.
+
+## Usage
+### Running an application
+The example below will setup the runtime, load `Test.dll` and run its `Main` method:
+```rust
+let hostfxr = nethost::load_hostfxr().unwrap();
+let context = hostfxr.initialize_for_dotnet_command_line(pdcstr!("Test.dll")).unwrap();
+let result = context.run_app().value();
+```
+The full example can be found in [examples/run-app](https://github.com/OpenByteDev/lnks/tree/master/examples/run-app).
+
+### Calling a managed function
+A function pointer to a managed method can be aquired using an [`AssemblyDelegateLoader`](https://docs.rs/lnks/*/lnks/hostfxr/struct.AssemblyDelegateLoader.html).
+This is only supported for [`HostfxrContext`'s](https://docs.rs/lnks/*/lnks/hostfxr/struct.HostfxrContext.html) that are initialized using [`Hostfxr::initialize_for_runtime_config`](https://docs.rs/lnks/*/lnks/hostfxr/struct.Hostfxr.html#method.initialize_for_runtime_config). The [`runtimeconfig.json`](https://docs.microsoft.com/en-us/dotnet/core/run-time-config/) is automatically generated for executables, for libraries it is neccessary to add  `<GenerateRuntimeConfigurationFiles>True</GenerateRuntimeConfigurationFiles>` to the projects `.csproj` file.
+
+#### Using the default signature
+The default method signature is defined as follows:
+```csharp
+public delegate int ComponentEntryPoint(IntPtr args, int sizeBytes);
+```
+
+A method with the default signature (see code below) can be loaded using [`AssemblyDelegateLoader::get_function_with_default_signature`](https://docs.rs/lnks/*/lnks/hostfxr/struct.AssemblyDelegateLoader.html#method.get_function_with_default_signature).
+
+**C#**
+```cs
+using System;
+
+namespace Test {
+    public static class Program {
+        public static int Hello(IntPtr args, int sizeBytes) {
+            Console.WriteLine("Hello from C#!");
+            return 42;
+        }
+    }
+}
+```
+
+**Rust**
+```rust
+let hostfxr = nethost::load_hostfxr().unwrap();
+let context =
+    hostfxr.initialize_for_runtime_config(pdcstr!("Test.runtimeconfig.json")).unwrap();
+let fn_loader =
+    context.get_delegate_loader_for_assembly(pdcstr!("Test.dll")).unwrap();
+let hello = fn_loader.get_function_with_default_signature(
+    pdcstr!("Test.Program, Test"),
+    pdcstr!("Hello"),
+).unwrap();
+let result = unsafe { hello(std::ptr::null(), 0) };
+assert_eq!(result, 42);
+```
+
+#### Using UnmanagedCallersOnly
+A function pointer to a method annotated with [`UnmanagedCallersOnly`](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.unmanagedcallersonlyattribute) can be loaded without specifying its signature (as these methods cannot be overloaded).
+
+**C#**
+```cs
+using System;
+using System.Runtime.InteropServices;
+
+namespace Test {
+    public static class Program {
+        [UnmanagedCallersOnly]
+        public static void UnmanagedHello() {
+            Console.WriteLine("Hello from C#!");
+        }
+    }
+}
+```
+
+**Rust**
+```rust
+let hostfxr = nethost::load_hostfxr().unwrap();
+let context =
+    hostfxr.initialize_for_runtime_config(pdcstr!("Test.runtimeconfig.json")).unwrap();
+let fn_loader =
+    context.get_delegate_loader_for_assembly(pdcstr!("Test.dll")).unwrap();
+let hello = fn_loader.get_function_with_unmanaged_callers_only::<fn()>(
+    pdcstr!("Test.Program, Test"),
+    pdcstr!("UnmanagedHello"),
+).unwrap();
+hello(); // prints "Hello from C#!"
+```
+
+
+#### Specifying the delegate type
+Another option is to define a custom delegate type and passing its assembly qualified name to [`AssemblyDelegateLoader::get_function`](https://docs.rs/lnks/*/lnks/hostfxr/struct.AssemblyDelegateLoader.html#method.get_function).
+
+**C#**
+```cs
+using System;
+
+namespace Test {
+    public static class Program {
+        public delegate void CustomHelloFunc();
+    
+        public static void CustomHello() {
+            Console.WriteLine("Hello from C#!");
+        }
+    }
+}
+```
+
+**Rust**
+```rust
+let hostfxr = nethost::load_hostfxr().unwrap();
+let context =
+    hostfxr.initialize_for_runtime_config(pdcstr!("Test.runtimeconfig.json")).unwrap();
+let fn_loader =
+    context.get_delegate_loader_for_assembly(pdcstr!("Test.dll")).unwrap();
+let hello = fn_loader.get_function::<fn()>(
+    pdcstr!("Test.Program, Test"),
+    pdcstr!("CustomHello"),
+    pdcstr!("Test.Program+CustomHelloFunc, Test")
+).unwrap();
+hello(); // prints "Hello from C#!"
+```
+
+The full examples can be found in [examples/call-managed-function](https://github.com/OpenByteDev/lnks/tree/master/examples/call-managed-function).
+
+### Passing complex parameters
+Examples for passing non-primitive parameters can be found in [examples/passing-parameters](https://github.com/OpenByteDev/lnks/tree/master/examples/passing-parameters).
+
+## Features
+- `nethost` - Links against nethost and allows for automatic detection of the hostfxr library.
+- `download-nethost` - Automatically downloads the latest nethost binary from [NuGet](https://www.nuget.org/packages/Microsoft.NETCore.DotNetHost/).
+
+<!-- cargo-sync-readme end -->
+
+
+## Related crates
+- [nethost-sys](https://crates.io/crates/nethost-sys) - bindings for the nethost library.
+- [hostfxr-sys](https://crates.io/crates/hostfxr-sys) - bindings for the hostfxr library.
+- [coreclr-hosting-shared](https://crates.io/crates/coreclr-hosting-shared) - shared bindings between [hostfxr-sys](https://crates.io/crates/hostfxr-sys) and [nethost-sys](https://crates.io/crates/nethost-sys).
+
+## Additional Information
+- [Hosting layer APIs](https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/hosting-layer-apis.md)
+- [Native hosting](https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/native-hosting.md#runtime-properties)
+- [Write a custom .NET Core host to control the .NET runtime from your native code](https://docs.microsoft.com/en-us/dotnet/core/tutorials/netcore-hosting)
+
+## License
+Licensed under the MIT license ([LICENSE](https://github.com/OpenByteDev/lnks/blob/master/LICENSE) or http://opensource.org/licenses/MIT)

src/buf_utils.rs

@@ -0,0 +1,61 @@
+use crate::Result;
+use std::path::PathBuf;
+use widestring::U16CString;
+use windows::Win32::Foundation::MAX_PATH;
+
+const INITIAL_CAPACITY: usize = MAX_PATH as _;
+const MAX_CAPACITY: usize = 4 * 1024;
+
+pub(crate) fn com_get_with_growth(
+    mut f: impl FnMut(&mut [u16]) -> Result<()>,
+) -> Result<U16CString> {
+    let mut buf = vec![0u16; INITIAL_CAPACITY];
+
+    loop {
+        let res = f(&mut buf);
+
+        // COM APIs do not consitently return an error and just truncate the output
+        // but still include the null terminator.
+        // Thus we just check if the second to last element is null to guess whether
+        // the output was truncated.
+        if buf[0] != 0 && buf[buf.len() - 2] != 0 {
+            let new_capacity = buf.capacity().saturating_mul(2);
+            if new_capacity <= MAX_CAPACITY {
+                buf.resize(new_capacity, 0);
+                continue;
+            }
+        }
+
+        return res.map(|()| U16CString::from_vec_truncate(buf));
+    }
+}
+
+pub(crate) fn com_get_string(f: impl FnMut(&mut [u16]) -> Result<()>) -> Result<String> {
+    com_get_with_growth(f)?
+        .to_string()
+        .map_err(crate::Error::Utf16)
+}
+
+pub(crate) fn com_get_optional_string(
+    f: impl FnMut(&mut [u16]) -> Result<()>,
+) -> Result<Option<String>> {
+    let s = com_get_string(f)?;
+    if s.is_empty() { Ok(None) } else { Ok(Some(s)) }
+}
+
+#[allow(dead_code)]
+pub(crate) fn com_get_path(f: impl FnMut(&mut [u16]) -> Result<()>) -> Result<PathBuf> {
+    let str = com_get_with_growth(f)?;
+    Ok(PathBuf::from(str.to_os_string()))
+}
+
+pub(crate) fn com_get_optional_path(
+    f: impl FnMut(&mut [u16]) -> Result<()>,
+) -> Result<Option<PathBuf>> {
+    let s = com_get_with_growth(f)?;
+    if s.is_empty() {
+        Ok(None)
+    } else {
+        Ok(Some(PathBuf::from(s.to_os_string())))
+    }
+}