4 * Copyright 1995 Thomas Sandford
5 * Copyright 1996 Martin von Loewis
6 * Copyright 2003 Alexandre Julliard
8 * Based on the Win16 resource handling code in loader/resource.c
9 * Copyright 1993 Robert J. Amstadt
10 * Copyright 1995 Alexandre Julliard
11 * Copyright 1997 Marcus Meissner
13 * This library is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU Lesser General Public
15 * License as published by the Free Software Foundation; either
16 * version 2.1 of the License, or (at your option) any later version.
18 * This library is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 * Lesser General Public License for more details.
23 * You should have received a copy of the GNU Lesser General Public
24 * License along with this library; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
30 #include <sys/types.h>
33 #define WIN32_NO_STATUS
38 #include "ntdll_misc.h"
40 #include "wine/exception.h"
41 #include "wine/debug.h"
43 WINE_DEFAULT_DEBUG_CHANNEL(resource
);
45 #define IS_INTRESOURCE(x) (((ULONG_PTR)(x) >> 16) == 0)
47 /**********************************************************************
50 * Check if a module handle is for a LOAD_LIBRARY_AS_DATAFILE module.
52 static inline BOOL
is_data_file_module( HMODULE hmod
)
54 return (ULONG_PTR
)hmod
& 1;
58 /**********************************************************************
61 * push a language in the list of languages to try
63 static inline int push_language( WORD
*list
, int pos
, WORD lang
)
66 for (i
= 0; i
< pos
; i
++) if (list
[i
] == lang
) return pos
;
72 /**********************************************************************
75 * Find the first suitable entry in a resource directory
77 static const IMAGE_RESOURCE_DIRECTORY
*find_first_entry( const IMAGE_RESOURCE_DIRECTORY
*dir
,
78 const void *root
, int want_dir
)
80 const IMAGE_RESOURCE_DIRECTORY_ENTRY
*entry
= (const IMAGE_RESOURCE_DIRECTORY_ENTRY
*)(dir
+ 1);
83 for (pos
= 0; pos
< dir
->NumberOfNamedEntries
+ dir
->NumberOfIdEntries
; pos
++)
85 if (!entry
[pos
].DataIsDirectory
== !want_dir
)
86 return (const IMAGE_RESOURCE_DIRECTORY
*)((const char *)root
+ entry
[pos
].OffsetToDirectory
);
92 /**********************************************************************
95 * Find an entry by id in a resource directory
97 static const IMAGE_RESOURCE_DIRECTORY
*find_entry_by_id( const IMAGE_RESOURCE_DIRECTORY
*dir
,
98 WORD id
, const void *root
, int want_dir
)
100 const IMAGE_RESOURCE_DIRECTORY_ENTRY
*entry
;
103 entry
= (const IMAGE_RESOURCE_DIRECTORY_ENTRY
*)(dir
+ 1);
104 min
= dir
->NumberOfNamedEntries
;
105 max
= min
+ dir
->NumberOfIdEntries
- 1;
108 pos
= (min
+ max
) / 2;
109 if (entry
[pos
].Id
== id
)
111 if (!entry
[pos
].DataIsDirectory
== !want_dir
)
113 TRACE("root %p dir %p id %04x ret %p\n",
114 root
, dir
, id
, (const char*)root
+ entry
[pos
].OffsetToDirectory
);
115 return (const IMAGE_RESOURCE_DIRECTORY
*)((const char *)root
+ entry
[pos
].OffsetToDirectory
);
119 if (entry
[pos
].Id
> id
) max
= pos
- 1;
122 TRACE("root %p dir %p id %04x not found\n", root
, dir
, id
);
127 /**********************************************************************
130 * Find an entry by name in a resource directory
132 static const IMAGE_RESOURCE_DIRECTORY
*find_entry_by_name( const IMAGE_RESOURCE_DIRECTORY
*dir
,
133 LPCWSTR name
, const void *root
,
136 const IMAGE_RESOURCE_DIRECTORY_ENTRY
*entry
;
137 const IMAGE_RESOURCE_DIR_STRING_U
*str
;
138 int min
, max
, res
, pos
, namelen
;
140 if (IS_INTRESOURCE(name
)) return find_entry_by_id( dir
, LOWORD(name
), root
, want_dir
);
141 entry
= (const IMAGE_RESOURCE_DIRECTORY_ENTRY
*)(dir
+ 1);
142 namelen
= wcslen(name
);
144 max
= dir
->NumberOfNamedEntries
- 1;
147 pos
= (min
+ max
) / 2;
148 str
= (const IMAGE_RESOURCE_DIR_STRING_U
*)((const char *)root
+ entry
[pos
].NameOffset
);
149 res
= wcsncmp( name
, str
->NameString
, str
->Length
);
150 if (!res
&& namelen
== str
->Length
)
152 if (!entry
[pos
].DataIsDirectory
== !want_dir
)
154 TRACE("root %p dir %p name %s ret %p\n",
155 root
, dir
, debugstr_w(name
), (const char*)root
+ entry
[pos
].OffsetToDirectory
);
156 return (const IMAGE_RESOURCE_DIRECTORY
*)((const char *)root
+ entry
[pos
].OffsetToDirectory
);
160 if (res
< 0) max
= pos
- 1;
163 TRACE("root %p dir %p name %s not found\n", root
, dir
, debugstr_w(name
) );
168 /**********************************************************************
171 * Find a resource entry
173 static NTSTATUS
find_entry( HMODULE hmod
, const LDR_RESOURCE_INFO
*info
,
174 ULONG level
, const void **ret
, int want_dir
)
178 const IMAGE_RESOURCE_DIRECTORY
*resdirptr
;
179 WORD list
[9]; /* list of languages to try */
182 root
= RtlImageDirectoryEntryToData( hmod
, TRUE
, IMAGE_DIRECTORY_ENTRY_RESOURCE
, &size
);
183 if (!root
) return STATUS_RESOURCE_DATA_NOT_FOUND
;
184 if (size
< sizeof(*resdirptr
)) return STATUS_RESOURCE_DATA_NOT_FOUND
;
187 if (!level
--) goto done
;
188 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Type
, root
, want_dir
|| level
)))
189 return STATUS_RESOURCE_TYPE_NOT_FOUND
;
190 if (!level
--) return STATUS_SUCCESS
;
193 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Name
, root
, want_dir
|| level
)))
194 return STATUS_RESOURCE_NAME_NOT_FOUND
;
195 if (!level
--) return STATUS_SUCCESS
;
196 if (level
) return STATUS_INVALID_PARAMETER
; /* level > 3 */
198 /* 1. specified language */
199 pos
= push_language( list
, pos
, info
->Language
);
201 /* 2. specified language with neutral sublanguage */
202 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(info
->Language
), SUBLANG_NEUTRAL
) );
204 /* 3. neutral language with neutral sublanguage */
205 pos
= push_language( list
, pos
, MAKELANGID( LANG_NEUTRAL
, SUBLANG_NEUTRAL
) );
207 /* if no explicitly specified language, try some defaults */
208 if (PRIMARYLANGID(info
->Language
) == LANG_NEUTRAL
)
210 LANGID user_lang
, user_neutral_lang
, system_lang
;
212 get_resource_lcids( &user_lang
, &user_neutral_lang
, &system_lang
);
214 /* user defaults, unless SYS_DEFAULT sublanguage specified */
215 if (SUBLANGID(info
->Language
) != SUBLANG_SYS_DEFAULT
)
217 /* 4. current thread locale language */
218 pos
= push_language( list
, pos
, LANGIDFROMLCID(NtCurrentTeb()->CurrentLocale
) );
220 /* 5. user locale language */
221 pos
= push_language( list
, pos
, user_lang
);
223 /* 6. user locale language with neutral sublanguage */
224 pos
= push_language( list
, pos
, user_neutral_lang
);
227 /* 7. system locale language */
228 pos
= push_language( list
, pos
, system_lang
);
230 /* 8. system locale language with neutral sublanguage */
231 pos
= push_language( list
, pos
, PRIMARYLANGID( system_lang
));
234 pos
= push_language( list
, pos
, MAKELANGID( LANG_ENGLISH
, SUBLANG_DEFAULT
) );
238 for (i
= 0; i
< pos
; i
++)
239 if ((*ret
= find_entry_by_id( resdirptr
, list
[i
], root
, want_dir
))) return STATUS_SUCCESS
;
241 /* if no explicitly specified language, return the first entry */
242 if (PRIMARYLANGID(info
->Language
) == LANG_NEUTRAL
)
244 if ((*ret
= find_first_entry( resdirptr
, root
, want_dir
))) return STATUS_SUCCESS
;
246 return STATUS_RESOURCE_LANG_NOT_FOUND
;
250 return STATUS_SUCCESS
;
254 /**********************************************************************
255 * LdrFindResourceDirectory_U (NTDLL.@)
257 NTSTATUS WINAPI DECLSPEC_HOTPATCH
LdrFindResourceDirectory_U( HMODULE hmod
, const LDR_RESOURCE_INFO
*info
,
258 ULONG level
, const IMAGE_RESOURCE_DIRECTORY
**dir
)
265 if (info
) TRACE( "module %p type %s name %s lang %04lx level %ld\n",
266 hmod
, debugstr_w((LPCWSTR
)info
->Type
),
267 level
> 1 ? debugstr_w((LPCWSTR
)info
->Name
) : "",
268 level
> 2 ? info
->Language
: 0, level
);
270 status
= find_entry( hmod
, info
, level
, &res
, TRUE
);
271 if (status
== STATUS_SUCCESS
) *dir
= res
;
275 return GetExceptionCode();
282 /**********************************************************************
283 * LdrFindResource_U (NTDLL.@)
285 NTSTATUS WINAPI DECLSPEC_HOTPATCH
LdrFindResource_U( HMODULE hmod
, const LDR_RESOURCE_INFO
*info
,
286 ULONG level
, const IMAGE_RESOURCE_DATA_ENTRY
**entry
)
293 if (info
) TRACE( "module %p type %s name %s lang %04lx level %ld\n",
294 hmod
, debugstr_w((LPCWSTR
)info
->Type
),
295 level
> 1 ? debugstr_w((LPCWSTR
)info
->Name
) : "",
296 level
> 2 ? info
->Language
: 0, level
);
298 status
= find_entry( hmod
, info
, level
, &res
, FALSE
);
299 if (status
== STATUS_SUCCESS
) *entry
= res
;
303 return GetExceptionCode();
310 /* don't penalize other platforms with stuff needed on i386 for compatibility */
312 NTSTATUS WINAPI
access_resource( HMODULE hmod
, const IMAGE_RESOURCE_DATA_ENTRY
*entry
,
313 void **ptr
, ULONG
*size
)
315 static inline NTSTATUS
access_resource( HMODULE hmod
, const IMAGE_RESOURCE_DATA_ENTRY
*entry
,
316 void **ptr
, ULONG
*size
)
325 if (!RtlImageDirectoryEntryToData( hmod
, TRUE
, IMAGE_DIRECTORY_ENTRY_RESOURCE
, &dirsize
))
326 status
= STATUS_RESOURCE_DATA_NOT_FOUND
;
331 BOOL is_data_file
= is_data_file_module(hmod
);
332 hmod
= (HMODULE
)((ULONG_PTR
)hmod
& ~3);
334 *ptr
= RtlImageRvaToVa( RtlImageNtHeader(hmod
), hmod
, entry
->OffsetToData
, NULL
);
336 *ptr
= (char *)hmod
+ entry
->OffsetToData
;
338 if (size
) *size
= entry
->Size
;
339 status
= STATUS_SUCCESS
;
344 return GetExceptionCode();
350 /**********************************************************************
351 * LdrAccessResource (NTDLL.@)
354 * On x86, Shrinker, an executable compressor, depends on the
355 * "call access_resource" instruction being there.
358 __ASM_STDCALL_FUNC( LdrAccessResource
, 16,
360 "movl %esp, %ebp\n\t"
367 "call " __ASM_STDCALL("access_resource",16) "\n\t"
372 NTSTATUS WINAPI
LdrAccessResource( HMODULE hmod
, const IMAGE_RESOURCE_DATA_ENTRY
*entry
,
373 void **ptr
, ULONG
*size
)
375 return access_resource( hmod
, entry
, ptr
, size
);
379 /**********************************************************************
380 * RtlFindMessage (NTDLL.@)
382 NTSTATUS WINAPI
RtlFindMessage( HMODULE hmod
, ULONG type
, ULONG lang
,
383 ULONG msg_id
, const MESSAGE_RESOURCE_ENTRY
**ret
)
385 const MESSAGE_RESOURCE_DATA
*data
;
386 const MESSAGE_RESOURCE_BLOCK
*block
;
387 const IMAGE_RESOURCE_DATA_ENTRY
*rsrc
;
388 LDR_RESOURCE_INFO info
;
395 info
.Language
= lang
;
397 if ((status
= LdrFindResource_U( hmod
, &info
, 3, &rsrc
)) != STATUS_SUCCESS
)
399 if ((status
= LdrAccessResource( hmod
, rsrc
, &ptr
, NULL
)) != STATUS_SUCCESS
)
403 block
= data
->Blocks
;
404 for (i
= 0; i
< data
->NumberOfBlocks
; i
++, block
++)
406 if (msg_id
>= block
->LowId
&& msg_id
<= block
->HighId
)
408 const MESSAGE_RESOURCE_ENTRY
*entry
;
410 entry
= (const MESSAGE_RESOURCE_ENTRY
*)((const char *)data
+ block
->OffsetToEntries
);
411 for (i
= msg_id
- block
->LowId
; i
> 0; i
--)
412 entry
= (const MESSAGE_RESOURCE_ENTRY
*)((const char *)entry
+ entry
->Length
);
414 return STATUS_SUCCESS
;
417 return STATUS_MESSAGE_NOT_FOUND
;