'sizeof type' is best avoided as it won't always compile (e.g. 'int
[wine] / dlls / ntdll / resource.c
1 /*
2  * PE file resources
3  *
4  * Copyright 1995 Thomas Sandford
5  * Copyright 1996 Martin von Loewis
6  * Copyright 2003 Alexandre Julliard
7  *
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
12  *
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.
17  *
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.
22  *
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  */
27
28 #include "config.h"
29
30 #include <stdlib.h>
31 #include <sys/types.h>
32
33 #define NONAMELESSUNION
34 #define NONAMELESSSTRUCT
35 #include "windef.h"
36 #include "winnls.h"
37 #include "winnt.h"
38 #include "winternl.h"
39 #include "winerror.h"
40 #include "thread.h"
41 #include "excpt.h"
42 #include "wine/exception.h"
43 #include "wine/unicode.h"
44 #include "wine/debug.h"
45
46 WINE_DEFAULT_DEBUG_CHANNEL(resource);
47
48 static LCID user_lcid, system_lcid;
49
50 static WINE_EXCEPTION_FILTER(page_fault)
51 {
52     if (GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION ||
53         GetExceptionCode() == EXCEPTION_PRIV_INSTRUCTION)
54         return EXCEPTION_EXECUTE_HANDLER;
55     return EXCEPTION_CONTINUE_SEARCH;
56 }
57
58 /**********************************************************************
59  *  is_data_file_module
60  *
61  * Check if a module handle is for a LOAD_LIBRARY_AS_DATAFILE module.
62  */
63 inline static int is_data_file_module( HMODULE hmod )
64 {
65     return (ULONG_PTR)hmod & 1;
66 }
67
68
69 /**********************************************************************
70  *  push_language
71  *
72  * push a language in the list of languages to try
73  */
74 static inline int push_language( WORD *list, int pos, WORD lang )
75 {
76     int i;
77     for (i = 0; i < pos; i++) if (list[i] == lang) return pos;
78     list[pos++] = lang;
79     return pos;
80 }
81
82
83 /**********************************************************************
84  *  find_first_entry
85  *
86  * Find the first suitable entry in a resource directory
87  */
88 static const IMAGE_RESOURCE_DIRECTORY *find_first_entry( const IMAGE_RESOURCE_DIRECTORY *dir,
89                                                          const void *root, int want_dir )
90 {
91     const IMAGE_RESOURCE_DIRECTORY_ENTRY *entry = (const IMAGE_RESOURCE_DIRECTORY_ENTRY *)(dir + 1);
92     int pos;
93
94     for (pos = 0; pos < dir->NumberOfNamedEntries + dir->NumberOfIdEntries; pos++)
95     {
96         if (!entry[pos].u2.s3.DataIsDirectory == !want_dir)
97             return (IMAGE_RESOURCE_DIRECTORY *)((char *)root + entry[pos].u2.s3.OffsetToDirectory);
98     }
99     return NULL;
100 }
101
102
103 /**********************************************************************
104  *  find_entry_by_id
105  *
106  * Find an entry by id in a resource directory
107  */
108 static const IMAGE_RESOURCE_DIRECTORY *find_entry_by_id( const IMAGE_RESOURCE_DIRECTORY *dir,
109                                                          WORD id, const void *root, int want_dir )
110 {
111     const IMAGE_RESOURCE_DIRECTORY_ENTRY *entry;
112     int min, max, pos;
113
114     entry = (const IMAGE_RESOURCE_DIRECTORY_ENTRY *)(dir + 1);
115     min = dir->NumberOfNamedEntries;
116     max = min + dir->NumberOfIdEntries - 1;
117     while (min <= max)
118     {
119         pos = (min + max) / 2;
120         if (entry[pos].u1.s2.Id == id)
121         {
122             if (!entry[pos].u2.s3.DataIsDirectory == !want_dir)
123             {
124                 TRACE("root %p dir %p id %04x ret %p\n",
125                       root, dir, id, (char *)root + entry[pos].u2.s3.OffsetToDirectory);
126                 return (IMAGE_RESOURCE_DIRECTORY *)((char *)root + entry[pos].u2.s3.OffsetToDirectory);
127             }
128             break;
129         }
130         if (entry[pos].u1.s2.Id > id) max = pos - 1;
131         else min = pos + 1;
132     }
133     TRACE("root %p dir %p id %04x not found\n", root, dir, id );
134     return NULL;
135 }
136
137
138 /**********************************************************************
139  *  find_entry_by_name
140  *
141  * Find an entry by name in a resource directory
142  */
143 static const IMAGE_RESOURCE_DIRECTORY *find_entry_by_name( const IMAGE_RESOURCE_DIRECTORY *dir,
144                                                            LPCWSTR name, const void *root,
145                                                            int want_dir )
146 {
147     const IMAGE_RESOURCE_DIRECTORY_ENTRY *entry;
148     const IMAGE_RESOURCE_DIR_STRING_U *str;
149     int min, max, res, pos, namelen;
150
151     if (!HIWORD(name)) return find_entry_by_id( dir, LOWORD(name), root, want_dir );
152     entry = (const IMAGE_RESOURCE_DIRECTORY_ENTRY *)(dir + 1);
153     namelen = strlenW(name);
154     min = 0;
155     max = dir->NumberOfNamedEntries - 1;
156     while (min <= max)
157     {
158         pos = (min + max) / 2;
159         str = (IMAGE_RESOURCE_DIR_STRING_U *)((char *)root + entry[pos].u1.s1.NameOffset);
160         res = strncmpW( name, str->NameString, str->Length );
161         if (!res && namelen == str->Length)
162         {
163             if (!entry[pos].u2.s3.DataIsDirectory == !want_dir)
164             {
165                 TRACE("root %p dir %p name %s ret %p\n",
166                       root, dir, debugstr_w(name), (char *)root + entry[pos].u2.s3.OffsetToDirectory);
167                 return (IMAGE_RESOURCE_DIRECTORY *)((char *)root + entry[pos].u2.s3.OffsetToDirectory);
168             }
169             break;
170         }
171         if (res < 0) max = pos - 1;
172         else min = pos + 1;
173     }
174     TRACE("root %p dir %p name %s not found\n", root, dir, debugstr_w(name) );
175     return NULL;
176 }
177
178
179 /**********************************************************************
180  *  find_entry
181  *
182  * Find a resource entry
183  */
184 static NTSTATUS find_entry( HMODULE hmod, const LDR_RESOURCE_INFO *info,
185                             ULONG level, const void **ret, int want_dir )
186 {
187     ULONG size;
188     const void *root;
189     const IMAGE_RESOURCE_DIRECTORY *resdirptr;
190     WORD list[9];  /* list of languages to try */
191     int i, pos = 0;
192
193     root = RtlImageDirectoryEntryToData( hmod, TRUE, IMAGE_DIRECTORY_ENTRY_RESOURCE, &size );
194     if (!root) return STATUS_RESOURCE_DATA_NOT_FOUND;
195     resdirptr = root;
196
197     if (!level--) goto done;
198     if (!(*ret = find_entry_by_name( resdirptr, (LPCWSTR)info->Type, root, want_dir || level )))
199         return STATUS_RESOURCE_TYPE_NOT_FOUND;
200     if (!level--) return STATUS_SUCCESS;
201
202     resdirptr = *ret;
203     if (!(*ret = find_entry_by_name( resdirptr, (LPCWSTR)info->Name, root, want_dir || level )))
204         return STATUS_RESOURCE_NAME_NOT_FOUND;
205     if (!level--) return STATUS_SUCCESS;
206     if (level) return STATUS_INVALID_PARAMETER;  /* level > 3 */
207
208     /* 1. specified language */
209     pos = push_language( list, pos, info->Language );
210
211     /* 2. specified language with neutral sublanguage */
212     pos = push_language( list, pos, MAKELANGID( PRIMARYLANGID(info->Language), SUBLANG_NEUTRAL ) );
213
214     /* 3. neutral language with neutral sublanguage */
215     pos = push_language( list, pos, MAKELANGID( LANG_NEUTRAL, SUBLANG_NEUTRAL ) );
216
217     /* if no explicitly specified language, try some defaults */
218     if (PRIMARYLANGID(info->Language) == LANG_NEUTRAL)
219     {
220         /* user defaults, unless SYS_DEFAULT sublanguage specified  */
221         if (SUBLANGID(info->Language) != SUBLANG_SYS_DEFAULT)
222         {
223             /* 4. current thread locale language */
224             pos = push_language( list, pos, LANGIDFROMLCID(NtCurrentTeb()->CurrentLocale) );
225
226             /* 5. user locale language */
227             pos = push_language( list, pos, LANGIDFROMLCID(user_lcid) );
228
229             /* 6. user locale language with neutral sublanguage  */
230             pos = push_language( list, pos, MAKELANGID( PRIMARYLANGID(user_lcid), SUBLANG_NEUTRAL ) );
231         }
232
233         /* now system defaults */
234
235         /* 7. system locale language */
236         pos = push_language( list, pos, LANGIDFROMLCID( system_lcid ) );
237
238         /* 8. system locale language with neutral sublanguage */
239         pos = push_language( list, pos, MAKELANGID( PRIMARYLANGID(system_lcid), SUBLANG_NEUTRAL ) );
240
241         /* 9. English */
242         pos = push_language( list, pos, MAKELANGID( LANG_ENGLISH, SUBLANG_DEFAULT ) );
243     }
244
245     resdirptr = *ret;
246     for (i = 0; i < pos; i++)
247         if ((*ret = find_entry_by_id( resdirptr, list[i], root, want_dir ))) return STATUS_SUCCESS;
248
249     /* if no explicitly specified language, return the first entry */
250     if (PRIMARYLANGID(info->Language) == LANG_NEUTRAL)
251     {
252         if ((*ret = find_first_entry( resdirptr, root, want_dir ))) return STATUS_SUCCESS;
253     }
254     return STATUS_RESOURCE_LANG_NOT_FOUND;
255
256 done:
257     *ret = resdirptr;
258     return STATUS_SUCCESS;
259 }
260
261
262 /**********************************************************************
263  *      LdrFindResourceDirectory_U  (NTDLL.@)
264  */
265 NTSTATUS WINAPI LdrFindResourceDirectory_U( HMODULE hmod, const LDR_RESOURCE_INFO *info,
266                                             ULONG level, const IMAGE_RESOURCE_DIRECTORY **dir )
267 {
268     const void *res;
269     NTSTATUS status;
270
271     if (info) TRACE( "module %p type %s name %s lang %04lx level %ld\n",
272                      hmod, debugstr_w((LPCWSTR)info->Type),
273                      debugstr_w((LPCWSTR)info->Name), info->Language, level );
274
275     __TRY
276     {
277         status = find_entry( hmod, info, level, &res, TRUE );
278         if (status == STATUS_SUCCESS) *dir = res;
279     }
280     __EXCEPT(page_fault)
281     {
282         return GetExceptionCode();
283     }
284     __ENDTRY;
285     return status;
286 }
287
288
289 /**********************************************************************
290  *      LdrFindResource_U  (NTDLL.@)
291  */
292 NTSTATUS WINAPI LdrFindResource_U( HMODULE hmod, const LDR_RESOURCE_INFO *info,
293                                    ULONG level, const IMAGE_RESOURCE_DATA_ENTRY **entry )
294 {
295     const void *res;
296     NTSTATUS status;
297
298     if (info) TRACE( "module %p type %s name %s lang %04lx level %ld\n",
299                      hmod, debugstr_w((LPCWSTR)info->Type),
300                      debugstr_w((LPCWSTR)info->Name), info->Language, level );
301
302     __TRY
303     {
304         status = find_entry( hmod, info, level, &res, FALSE );
305         if (status == STATUS_SUCCESS) *entry = res;
306     }
307     __EXCEPT(page_fault)
308     {
309         return GetExceptionCode();
310     }
311     __ENDTRY;
312     return status;
313 }
314
315
316 /**********************************************************************
317  *      LdrAccessResource  (NTDLL.@)
318  */
319 NTSTATUS WINAPI LdrAccessResource( HMODULE hmod, const IMAGE_RESOURCE_DATA_ENTRY *entry,
320                                    void **ptr, ULONG *size )
321 {
322     NTSTATUS status;
323
324     __TRY
325     {
326         ULONG dirsize;
327
328         if (!RtlImageDirectoryEntryToData( hmod, TRUE, IMAGE_DIRECTORY_ENTRY_RESOURCE, &dirsize ))
329             status = STATUS_RESOURCE_DATA_NOT_FOUND;
330         else
331         {
332             if (ptr)
333             {
334                 if (is_data_file_module(hmod))
335                 {
336                     HMODULE mod = (HMODULE)((ULONG_PTR)hmod & ~1);
337                     *ptr = RtlImageRvaToVa( RtlImageNtHeader(mod), mod, entry->OffsetToData, NULL );
338                 }
339                 else *ptr = (char *)hmod + entry->OffsetToData;
340             }
341             if (size) *size = entry->Size;
342             status = STATUS_SUCCESS;
343         }
344     }
345     __EXCEPT(page_fault)
346     {
347         return GetExceptionCode();
348     }
349     __ENDTRY;
350     return status;
351 }
352
353
354 /**********************************************************************
355  *      RtlFindMessage  (NTDLL.@)
356  */
357 NTSTATUS WINAPI RtlFindMessage( HMODULE hmod, ULONG type, ULONG lang,
358                                 ULONG msg_id, const MESSAGE_RESOURCE_ENTRY **ret )
359 {
360     const MESSAGE_RESOURCE_DATA *data;
361     const MESSAGE_RESOURCE_BLOCK *block;
362     const IMAGE_RESOURCE_DATA_ENTRY *rsrc;
363     LDR_RESOURCE_INFO info;
364     NTSTATUS status;
365     void *ptr;
366     int i;
367
368     info.Type     = type;
369     info.Name     = 1;
370     info.Language = lang;
371
372     if ((status = LdrFindResource_U( hmod, &info, 3, &rsrc )) != STATUS_SUCCESS)
373         return status;
374     if ((status = LdrAccessResource( hmod, rsrc, &ptr, NULL )) != STATUS_SUCCESS)
375         return status;
376
377     data = ptr;
378     block = data->Blocks;
379     for (i = 0; i < data->NumberOfBlocks; i++, block++)
380     {
381         if (msg_id >= block->LowId && msg_id <= block->HighId)
382         {
383             const MESSAGE_RESOURCE_ENTRY *entry;
384
385             entry = (MESSAGE_RESOURCE_ENTRY *)((char *)data + block->OffsetToEntries);
386             for (i = msg_id - block->LowId; i > 0; i--)
387                 entry = (MESSAGE_RESOURCE_ENTRY *)((char *)entry + entry->Length);
388             *ret = entry;
389             return STATUS_SUCCESS;
390         }
391     }
392     return STATUS_MESSAGE_NOT_FOUND;
393 }
394
395
396 /**********************************************************************
397  *      NtQueryDefaultLocale  (NTDLL.@)
398  */
399 NTSTATUS WINAPI NtQueryDefaultLocale( BOOLEAN user, LCID *lcid )
400 {
401     *lcid = user ? user_lcid : system_lcid;
402     return STATUS_SUCCESS;
403 }
404
405
406 /**********************************************************************
407  *      NtSetDefaultLocale  (NTDLL.@)
408  */
409 NTSTATUS WINAPI NtSetDefaultLocale( BOOLEAN user, LCID lcid )
410 {
411     if (user) user_lcid = lcid;
412     else system_lcid = lcid;
413     return STATUS_SUCCESS;
414 }