Skip to content

Align Windows registry callable signatures #9573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
youknowone merged 1 commit into from
Nov 3, 2026
Merged

Align Windows registry callable signatures #9573

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 22 additions & 14 deletions crates/vm/src/stdlib/winreg.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ mod winreg {
use crate::common::hash::PyHash;
use crate::convert::{ToPyException, TryFromObject};
use crate::exceptions::nul_char_error;
use crate::function::{FuncArgs, OptionalOption, PyComparisonValue};
use crate::function::{FuncArgs, PyComparisonValue};
use crate::object::AsObject;
use crate::protocol::PyNumberMethods;
use crate::types::{AsNumber, Comparable, Hashable, PyComparisonOp};
Expand Down Expand Up @@ -363,13 +363,18 @@ mod winreg {
}
}

#[derive(FromArgs)]
struct DeleteTreeSubKey {
#[pyarg(positional, optional)]
sub_key: Option<PyRef<PyStr>>,
}

#[pyfunction]
fn DeleteTree(
key: HKEYArg,
sub_key: OptionalOption<PyRef<PyStr>>,
DeleteTreeSubKey { sub_key }: DeleteTreeSubKey,
vm: &VirtualMachine,
) -> PyResult<()> {
let sub_key = sub_key.flatten();
let wide_sub_key = sub_key
.as_ref()
.map(|s| WideCString::from_vec(s.as_wtf8().encode_wide().collect::<Vec<_>>()))
Expand Down Expand Up @@ -450,11 +455,11 @@ mod winreg {
}

#[pyfunction]
fn EnumValue(hkey: PyRef<PyHkey>, index: u32, vm: &VirtualMachine) -> PyResult {
fn EnumValue(key: PyRef<PyHkey>, index: u32, vm: &VirtualMachine) -> PyResult {
// Query registry for the required buffer sizes.
let mut ret_value_size: u32 = 0;
let mut ret_data_size: u32 = 0;
let hkey: host_winreg::HKEY = hkey.hkey.load();
let hkey: host_winreg::HKEY = key.hkey.load();
let rc = unsafe {
host_winreg::query_info_key(
hkey,
Expand Down Expand Up @@ -666,11 +671,11 @@ mod winreg {
fn SetValue(
key: PyRef<PyHkey>,
sub_key: String,
typ: u32,
r#type: u32,
value: String,
vm: &VirtualMachine,
) -> PyResult<()> {
if typ != host_winreg::REG_SZ {
if r#type != host_winreg::REG_SZ {
return Err(vm.new_type_error("type must be winreg.REG_SZ"));
}

Expand All @@ -687,7 +692,7 @@ mod winreg {
let mut wide_value = WideString::with_capacity(value.len() + 1);
wide_value.push_str(&value);
wide_value.push_str("\0");
let res = host_winreg::set_default_value(hkey, &sub_key, typ, &wide_value);
let res = host_winreg::set_default_value(hkey, &sub_key, r#type, &wide_value);

if res == 0 {
Ok(())
Expand Down Expand Up @@ -873,21 +878,21 @@ mod winreg {
key: PyRef<PyHkey>,
value_name: Option<String>,
_reserved: PyObjectRef,
typ: u32,
r#type: u32,
value: PyObjectRef,
vm: &VirtualMachine,
) -> PyResult<()> {
let value_name = value_name
.map(WideCString::from_str)
.transpose()
.map_err(|e| e.to_pyexception(vm))?;
let reg_value = py2reg(value, typ, vm)?;
let reg_value = py2reg(value, r#type, vm)?;
let (ptr, len) = match &reg_value {
Some(v) => (v.as_ptr(), v.len() as u32),
None => (core::ptr::null(), 0),
};
let res = unsafe {
host_winreg::set_value_ex(key.hkey.load(), value_name.as_deref(), typ, ptr, len)
host_winreg::set_value_ex(key.hkey.load(), value_name.as_deref(), r#type, ptr, len)
};
if res != 0 {
return Err(os_error_from_windows_code(vm, res as i32));
Expand Down Expand Up @@ -927,10 +932,13 @@ mod winreg {
}

#[pyfunction]
fn ExpandEnvironmentStrings(i: PyRef<PyStr>, vm: &VirtualMachine) -> PyResult<PyRef<PyStr>> {
let i = WideCString::from_vec(i.as_wtf8().encode_wide().collect::<Vec<_>>())
fn ExpandEnvironmentStrings(
string: PyRef<PyStr>,
vm: &VirtualMachine,
) -> PyResult<PyRef<PyStr>> {
let string = WideCString::from_vec(string.as_wtf8().encode_wide().collect::<Vec<_>>())
.map_err(|_| nul_char_error(vm))?;
let expanded = host_winreg::expand_environment_strings_wide(&i)
let expanded = host_winreg::expand_environment_strings_wide(&string)
.map_err(|err| err.to_pyexception(vm))?;
Ok(vm.ctx.new_str(Wtf8Buf::from_wide(&expanded)))
}
Expand Down
Loading