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