reg_test.h File Reference

#include <stdio.h>
#include <windows.h>
#include "wine/test.h"

Include dependency graph for reg_test.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	lok   ok_(file,line)
#define	KEY_WINE   "Software\\Wine"
#define	KEY_BASE   KEY_WINE "\\reg_test"
#define	REG_EXIT_SUCCESS   0
#define	REG_EXIT_FAILURE   1
#define	TODO_REG_TYPE   (0x0001u)
#define	TODO_REG_SIZE   (0x0002u)
#define	TODO_REG_DATA   (0x0004u)
#define	TODO_REG_COMPARE   (0x0008u)
#define	run_reg_exe(c, r)   run_reg_exe_(__FILE__,__LINE__,c,r)
#define	verify_reg(k, v, t, d, s, todo)   verify_reg_(__FILE__,__LINE__,k,v,t,d,s,todo)
#define	verify_reg_nonexist(k, v)   verify_reg_nonexist_(__FILE__,__LINE__,k,v)
#define	open_key(r, p, s, k)   open_key_(__FILE__,__LINE__,r,p,s,k)
#define	close_key(k)   close_key_(__FILE__,__LINE__,k)
#define	verify_key(r, p, s)   verify_key_(__FILE__,__LINE__,r,p,s)
#define	verify_key_nonexist(r, p, s)   verify_key_nonexist_(__FILE__,__LINE__,r,p,s)
#define	add_key(r, p, s, k)   add_key_(__FILE__,__LINE__,r,p,s,k)
#define	delete_key(r, p, s)   delete_key_(__FILE__,__LINE__,r,p,s)
#define	delete_tree(r, p, s)   delete_tree_(__FILE__,__LINE__,r,p,s)
#define	add_value(k, n, t, d, s)   add_value_(__FILE__,__LINE__,k,n,t,d,s)
#define	delete_value(k, n)   delete_value_(__FILE__,__LINE__,k,n)
#define	compare_export(f, e, todo)   compare_export_(__FILE__,__LINE__,f,e,todo)
#define	delete_file(f)   delete_file_(__FILE__,__LINE__,f)
#define	test_import_str(c, r)   import_reg(__FILE__,__LINE__,c,FALSE,r)
#define	test_import_wstr(c, r)   import_reg(__FILE__,__LINE__,c,TRUE,r)

Functions
BOOL	run_reg_exe_ (const char *file, unsigned line, const char *cmd, DWORD *rc)
void	verify_reg_ (const char *file, unsigned line, HKEY hkey, const char *value, DWORD exp_type, const void *exp_data, DWORD exp_size, DWORD todo)
void	verify_reg_nonexist_ (const char *file, unsigned line, HKEY hkey, const char *value)
void	open_key_ (const char *file, unsigned line, HKEY root, const char *path, REGSAM sam, HKEY *hkey)
void	close_key_ (const char *file, unsigned line, HKEY hkey)
void	verify_key_ (const char *file, unsigned line, HKEY root, const char *path, REGSAM sam)
void	verify_key_nonexist_ (const char *file, unsigned line, HKEY root, const char *path, REGSAM sam)
void	add_key_ (const char *file, unsigned line, const HKEY root, const char *path, REGSAM sam, HKEY *hkey)
void	delete_key_ (const char *file, unsigned line, HKEY root, const char *path, REGSAM sam)
LONG	delete_tree_ (const char *file, unsigned line, HKEY root, const char *path, REGSAM sam)
void	add_value_ (const char *file, unsigned line, HKEY hkey, const char *name, DWORD type, const void *data, size_t size)
void	delete_value_ (const char *file, unsigned line, HKEY hkey, const char *name)
BOOL	compare_export_ (const char *file, unsigned line, const char *filename, const char *expected, DWORD todo)
BOOL	is_elevated_process (void)
BOOL	delete_file_ (const char *file, unsigned line, const char *fname)
BOOL	import_reg (const char *file, unsigned line, const char *contents, BOOL unicode, DWORD *rc)

Variables
const char *	empty_key_test
const char *	simple_data_test
const char *	complex_data_test
const char *	key_order_test
const char *	value_order_test
const char *	empty_hex_test
const char *	empty_hex_test2
const char *	hex_types_test
const char *	slashes_test
const char *	embedded_null_test
const char *	escaped_null_test
const char *	registry_view_test

Macro Definition Documentation

add_key

#define add_key	(		r,
			p,
			s,
			k
	)		add_key_(__FILE__,__LINE__,r,p,s,k)

Definition at line 61 of file reg_test.h.

add_value

#define add_value	(		k,
			n,
			t,
			d,
			s
	)		add_value_(__FILE__,__LINE__,k,n,t,d,s)

Definition at line 70 of file reg_test.h.

close_key

#define close_key

(

k

)

close_key_(__FILE__,__LINE__,k)

Definition at line 52 of file reg_test.h.

compare_export

#define compare_export	(		f,
			e,
			todo
	)		compare_export_(__FILE__,__LINE__,f,e,todo)

Definition at line 78 of file reg_test.h.

delete_file

#define delete_file

(

f

)

delete_file_(__FILE__,__LINE__,f)

Definition at line 97 of file reg_test.h.

delete_key

#define delete_key	(		r,
			p,
			s
	)		delete_key_(__FILE__,__LINE__,r,p,s)

Definition at line 64 of file reg_test.h.

delete_tree

#define delete_tree	(		r,
			p,
			s
	)		delete_tree_(__FILE__,__LINE__,r,p,s)

Definition at line 67 of file reg_test.h.

delete_value

#define delete_value	(		k,
			n
	)		delete_value_(__FILE__,__LINE__,k,n)

Definition at line 74 of file reg_test.h.

KEY_BASE

#define KEY_BASE   KEY_WINE "\\reg_test"

Definition at line 29 of file reg_test.h.

KEY_WINE

#define KEY_WINE   "Software\\Wine"

Definition at line 28 of file reg_test.h.

lok

#define lok   ok_(file,line)

Definition at line 27 of file reg_test.h.

open_key

#define open_key	(		r,
			p,
			s,
			k
	)		open_key_(__FILE__,__LINE__,r,p,s,k)

Definition at line 49 of file reg_test.h.

REG_EXIT_FAILURE

#define REG_EXIT_FAILURE   1

Definition at line 31 of file reg_test.h.

REG_EXIT_SUCCESS

#define REG_EXIT_SUCCESS   0

Definition at line 30 of file reg_test.h.

run_reg_exe

#define run_reg_exe	(		c,
			r
	)		run_reg_exe_(__FILE__,__LINE__,c,r)

Definition at line 39 of file reg_test.h.

test_import_str

#define test_import_str	(		c,
			r
	)		import_reg(__FILE__,__LINE__,c,FALSE,r)

Definition at line 100 of file reg_test.h.

test_import_wstr

#define test_import_wstr	(		c,
			r
	)		import_reg(__FILE__,__LINE__,c,TRUE,r)

Definition at line 101 of file reg_test.h.

TODO_REG_COMPARE

#define TODO_REG_COMPARE   (0x0008u)

Definition at line 36 of file reg_test.h.

TODO_REG_DATA

#define TODO_REG_DATA   (0x0004u)

Definition at line 35 of file reg_test.h.

TODO_REG_SIZE

#define TODO_REG_SIZE   (0x0002u)

Definition at line 34 of file reg_test.h.

TODO_REG_TYPE

#define TODO_REG_TYPE   (0x0001u)

Definition at line 33 of file reg_test.h.

verify_key

#define verify_key	(		r,
			p,
			s
	)		verify_key_(__FILE__,__LINE__,r,p,s)

Definition at line 55 of file reg_test.h.

verify_key_nonexist

#define verify_key_nonexist	(		r,
			p,
			s
	)		verify_key_nonexist_(__FILE__,__LINE__,r,p,s)

Definition at line 58 of file reg_test.h.

verify_reg

#define verify_reg	(		k,
			v,
			t,
			d,
			s,
			todo
	)		verify_reg_(__FILE__,__LINE__,k,v,t,d,s,todo)

Definition at line 42 of file reg_test.h.

verify_reg_nonexist

#define verify_reg_nonexist	(		k,
			v
	)		verify_reg_nonexist_(__FILE__,__LINE__,k,v)

Definition at line 46 of file reg_test.h.

Function Documentation

add_key_()

void add_key_	(	const char *	file,
		unsigned	line,
		const HKEY	root,
		const char *	path,
		REGSAM	sam,
		HKEY *	hkey
	)

Definition at line 124 of file add.c.

{
    LONG err;
    HKEY new_key;
 
    err = RegCreateKeyExA(root, path, 0, NULL, REG_OPTION_NON_VOLATILE,
                          KEY_READ|KEY_WRITE|sam, NULL, &new_key, NULL);
    lok(err == ERROR_SUCCESS, "RegCreateKeyExA failed: got error %d\n", err);
 
    if (hkey)
        *hkey = new_key;
    else
        RegCloseKey(new_key);
}

add_value_()

void add_value_	(	const char *	file,
		unsigned	line,
		HKEY	hkey,
		const char *	name,
		DWORD	type,
		const void *	data,
		size_t	size
	)

Definition at line 204 of file add.c.

{
    LONG err;
 
    err = RegSetValueExA(hkey, name, 0, type, (const BYTE *)data, size);
    lok(err == ERROR_SUCCESS, "RegSetValueExA failed: got error %d\n", err);
}

close_key_()

void close_key_	(	const char *	file,
		unsigned	line,
		HKEY	hkey
	)

Definition at line 92 of file add.c.

{
    LONG err;
 
    err = RegCloseKey(hkey);
    lok(err == ERROR_SUCCESS, "RegCloseKey failed: got error %d\n", err);
}

compare_export_()

BOOL compare_export_	(	const char *	file,
		unsigned	line,
		const char *	filename,
		const char *	expected,
		DWORD	todo
	)

Definition at line 21 of file export.c.

{
    FILE *fp;
    long file_size;
    WCHAR *fbuf = NULL, *wstr = NULL;
    size_t len;
    BOOL ret = FALSE;
 
    fp = fopen(filename, "rb");
    if (!fp) return FALSE;
 
    if (fseek(fp, 0, SEEK_END)) goto error;
    file_size = ftell(fp);
    if (file_size == -1) goto error;
    rewind(fp);
 
    fbuf = HeapAlloc(GetProcessHeap(), 0, file_size + sizeof(WCHAR));
    if (!fbuf) goto error;
 
    fread(fbuf, file_size, 1, fp);
    fbuf[file_size/sizeof(WCHAR)] = 0;
    fclose(fp);
 
    len = MultiByteToWideChar(CP_UTF8, 0, expected, -1, NULL, 0);
    wstr = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
    if (!wstr) goto exit;
    MultiByteToWideChar(CP_UTF8, 0, expected, -1, wstr, len);
 
    todo_wine_if (todo & TODO_REG_COMPARE)
        lok(!lstrcmpW(fbuf, wstr), "export data does not match expected data\n");
 
    ret = delete_file_(file, line, filename);
 
exit:
    HeapFree(GetProcessHeap(), 0, fbuf);
    HeapFree(GetProcessHeap(), 0, wstr);
    return ret;
 
error:
    fclose(fp);
    return FALSE;
}

delete_file_()

BOOL delete_file_	(	const char *	file,
		unsigned	line,
		const char *	fname
	)

Definition at line 44 of file import.c.

{
    BOOL ret;
 
    ret = DeleteFileA(fname);
    lok(ret, "DeleteFile failed: %u\n", GetLastError());
 
    return ret;
}

Referenced by compare_export_().

delete_key_()

void delete_key_	(	const char *	file,
		unsigned	line,
		HKEY	root,
		const char *	path,
		REGSAM	sam
	)

Definition at line 139 of file add.c.

{
    LONG err;
 
    if (!path) return;
 
    if (!sam)
    {
        err = RegDeleteKeyA(root, path);
        lok(err == ERROR_SUCCESS, "RegDeleteKeyA failed: got error %d\n", err);
    }
    else
    {
        err = RegDeleteKeyExA(root, path, sam, 0);
        lok(err == ERROR_SUCCESS, "RegDeleteKeyExA failed: got error %d\n", err);
    }
}

delete_tree_()

LONG delete_tree_	(	const char *	file,
		unsigned	line,
		HKEY	root,
		const char *	path,
		REGSAM	sam
	)

Definition at line 157 of file add.c.

{
    HKEY hkey;
    LONG ret;
    char *subkey_name = NULL;
    DWORD max_subkey_len, subkey_len;
    static const char empty[1];
 
    ret = RegOpenKeyExA(root, path, 0, KEY_READ|sam, &hkey);
    lok(!ret || ret == ERROR_FILE_NOT_FOUND, "RegOpenKeyExA failed, got error %d\n", ret);
    if (ret) return ret;
 
    ret = RegQueryInfoKeyA(hkey, NULL, NULL, NULL, NULL, &max_subkey_len,
                           NULL, NULL, NULL, NULL, NULL, NULL);
    if (ret) goto cleanup;
 
    max_subkey_len++;
 
    subkey_name = HeapAlloc(GetProcessHeap(), 0, max_subkey_len);
    if (!subkey_name)
    {
        ret = ERROR_NOT_ENOUGH_MEMORY;
        goto cleanup;
    }
 
    for (;;)
    {
        subkey_len = max_subkey_len;
        ret = RegEnumKeyExA(hkey, 0, subkey_name, &subkey_len, NULL, NULL, NULL, NULL);
        if (ret == ERROR_NO_MORE_ITEMS) break;
        if (ret) goto cleanup;
        ret = delete_tree_(file, line, hkey, subkey_name, sam);
        if (ret) goto cleanup;
    }
 
    if (!sam)
        ret = RegDeleteKeyA(hkey, empty);
    else
        ret = RegDeleteKeyExA(hkey, empty, sam, 0);
 
cleanup:
    lok(!ret, "Failed to delete registry key, got error %d\n", ret);
    HeapFree(GetProcessHeap(), 0, subkey_name);
    RegCloseKey(hkey);
    return ret;
}

Referenced by delete_tree_().

delete_value_()

void delete_value_	(	const char *	file,
		unsigned	line,
		HKEY	hkey,
		const char *	name
	)

Definition at line 213 of file add.c.

{
    LONG err;
 
    err = RegDeleteValueA(hkey, name);
    lok(err == ERROR_SUCCESS, "RegDeleteValueA failed: got error %d\n", err);
}

import_reg()

BOOL import_reg	(	const char *	file,
		unsigned	line,
		const char *	contents,
		BOOL	unicode,
		DWORD *	rc
	)

Definition at line 96 of file import.c.

{
    BOOL ret;
 
    ret = write_reg_file("test.reg", contents, unicode);
    if (!ret) return FALSE;
 
    run_reg_exe("reg import test.reg", rc);
 
    delete_file("test.reg");
 
    return ret;
}

is_elevated_process()

BOOL is_elevated_process

(

void

)

Definition at line 21 of file import.c.

{
    LONG err;
    HKEY hkey;
 
    err = RegDeleteKeyA(HKEY_CLASSES_ROOT, KEY_BASE);
 
    if (err == ERROR_ACCESS_DENIED)
        return FALSE;
 
    if (err == ERROR_FILE_NOT_FOUND)
    {
        if (RegCreateKeyExA(HKEY_CLASSES_ROOT, KEY_BASE, 0, NULL, REG_OPTION_NON_VOLATILE,
                            KEY_READ, NULL, &hkey, NULL))
            return FALSE;
 
        RegCloseKey(hkey);
        RegDeleteKeyA(HKEY_CLASSES_ROOT, KEY_BASE);
    }
 
    return TRUE;
}

Referenced by START_TEST(), and test_import_win31().

open_key_()

void open_key_	(	const char *	file,
		unsigned	line,
		HKEY	root,
		const char *	path,
		REGSAM	sam,
		HKEY *	hkey
	)

Definition at line 84 of file add.c.

{
    LONG err;
 
    err = RegOpenKeyExA(root, path, 0, KEY_READ|sam, hkey);
    lok(err == ERROR_SUCCESS, "RegOpenKeyExA failed: got error %d\n", err);
}

run_reg_exe_()

BOOL run_reg_exe_	(	const char *	file,
		unsigned	line,
		const char *	cmd,
		DWORD *	rc
	)

Definition at line 21 of file add.c.

{
    STARTUPINFOA si = {sizeof(STARTUPINFOA)};
    PROCESS_INFORMATION pi;
    BOOL bret;
    DWORD ret;
    char cmdline[256];
 
    si.dwFlags = STARTF_USESTDHANDLES;
    si.hStdInput  = INVALID_HANDLE_VALUE;
    si.hStdOutput = INVALID_HANDLE_VALUE;
    si.hStdError  = INVALID_HANDLE_VALUE;
 
    strcpy(cmdline, cmd);
    if (!CreateProcessA(NULL, cmdline, NULL, NULL, TRUE, 0, NULL, NULL, &si, &pi))
        return FALSE;
 
    ret = WaitForSingleObject(pi.hProcess, 10000);
    if (ret == WAIT_TIMEOUT)
        TerminateProcess(pi.hProcess, 1);
 
    bret = GetExitCodeProcess(pi.hProcess, rc);
    lok(bret, "GetExitCodeProcess failed: %d\n", GetLastError());
 
    CloseHandle(pi.hThread);
    CloseHandle(pi.hProcess);
    return bret;
}

verify_key_()

void verify_key_	(	const char *	file,
		unsigned	line,
		HKEY	root,
		const char *	path,
		REGSAM	sam
	)

Definition at line 100 of file add.c.

{
    HKEY hkey;
    LONG err;
 
    err = RegOpenKeyExA(root, path, 0, KEY_READ|sam, &hkey);
    lok(err == ERROR_SUCCESS, "RegOpenKeyExA failed: got error %d\n", err);
 
    if (hkey)
        RegCloseKey(hkey);
}

verify_key_nonexist_()

void verify_key_nonexist_	(	const char *	file,
		unsigned	line,
		HKEY	root,
		const char *	path,
		REGSAM	sam
	)

Definition at line 112 of file add.c.

{
    HKEY hkey;
    LONG err;
 
    err = RegOpenKeyExA(root, path, 0, KEY_READ|sam, &hkey);
    lok(err == ERROR_FILE_NOT_FOUND, "registry key '%s' shouldn't exist; got %d, expected 2\n", path, err);
 
    if (hkey)
        RegCloseKey(hkey);
}

verify_reg_()

void verify_reg_	(	const char *	file,
		unsigned	line,
		HKEY	hkey,
		const char *	value,
		DWORD	exp_type,
		const void *	exp_data,
		DWORD	exp_size,
		DWORD	todo
	)

Definition at line 50 of file add.c.

{
    DWORD type, size;
    BYTE data[256];
    LONG err;
 
    size = sizeof(data);
    memset(data, 0xdd, size);
    err = RegQueryValueExA(hkey, value, NULL, &type, data, &size);
    lok(err == ERROR_SUCCESS, "RegQueryValueEx failed: got error %d\n", err);
    if (err != ERROR_SUCCESS)
        return;
 
    todo_wine_if (todo & TODO_REG_TYPE)
        lok(type == exp_type, "got registry type %d, expected %d\n", type, exp_type);
    todo_wine_if (todo & TODO_REG_SIZE)
        lok(size == exp_size, "got data size %d, expected %d\n", size, exp_size);
    if (exp_data)
    {
        todo_wine_if (todo & TODO_REG_DATA)
            lok(memcmp(data, exp_data, size) == 0, "registry data does not match\n");
    }
}

verify_reg_nonexist_()

void verify_reg_nonexist_	(	const char *	file,
		unsigned	line,
		HKEY	hkey,
		const char *	value
	)

Definition at line 75 of file add.c.

{
    LONG err;
 
    err = RegQueryValueExA(hkey, value, NULL, NULL, NULL, NULL);
    lok(err == ERROR_FILE_NOT_FOUND, "registry value '%s' shouldn't exist; got %d, expected 2\n",
        (value && *value) ? value : "(Default)", err);
}

Variable Documentation

complex_data_test

const char* complex_data_test

extern

Definition at line 75 of file export.c.

Referenced by test_copy_complex_data(), and test_export().

embedded_null_test

const char* embedded_null_test

extern

Definition at line 139 of file export.c.

Referenced by test_copy_embedded_null_values(), and test_export().

empty_hex_test

const char* empty_hex_test

extern

Definition at line 113 of file export.c.

Referenced by test_copy_hex_data(), and test_export().

empty_hex_test2

const char* empty_hex_test2

extern

Definition at line 125 of file export.c.

Referenced by test_copy_hex_data(), and test_export().

empty_key_test

const char* empty_key_test

extern

Definition at line 65 of file export.c.

Referenced by test_copy_empty_key(), and test_export().

escaped_null_test

const char* escaped_null_test

extern

Definition at line 158 of file export.c.

Referenced by test_copy_escaped_null_values(), and test_export().

hex_types_test

const char* hex_types_test

extern

Definition at line 132 of file export.c.

Referenced by test_copy_hex_data(), and test_export().

key_order_test

const char* key_order_test

extern

Definition at line 101 of file export.c.

Referenced by test_copy_key_order(), and test_export().

registry_view_test

const char* registry_view_test

extern

Definition at line 168 of file export.c.

simple_data_test

const char* simple_data_test

extern

Definition at line 69 of file export.c.

Referenced by test_copy_complex_data(), test_copy_simple_data(), and test_export().

slashes_test

const char* slashes_test

extern

Definition at line 151 of file export.c.

Referenced by test_copy_slashes(), and test_export().

value_order_test

const char* value_order_test

extern

Definition at line 107 of file export.c.

Referenced by test_copy_value_order(), and test_export().