ntdll: Silence RtlNtStatusToDosErrorNoTeb() a bit.
[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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
26  */
27
28 #include "config.h"
29 #include "wine/port.h"
30
31 #include <stdarg.h>
32 #include <stdlib.h>
33 #include <sys/types.h>
34
35 #define NONAMELESSUNION
36 #define NONAMELESSSTRUCT
37 #include "ntstatus.h"
38 #define WIN32_NO_STATUS
39 #include "windef.h"
40 #include "winbase.h"
41 #include "winnt.h"
42 #include "winternl.h"
43 #include "wine/exception.h"
44 #include "wine/unicode.h"
45 #include "wine/debug.h"
46
47 WINE_DEFAULT_DEBUG_CHANNEL(resource);
48
49 static LCID user_lcid, system_lcid;
50 static LANGID user_ui_language, system_ui_language;
51
52 /**********************************************************************
53  *  is_data_file_module
54  *
55  * Check if a module handle is for a LOAD_LIBRARY_AS_DATAFILE module.
56  */
57 static inline int is_data_file_module( HMODULE hmod )
58 {
59     return (ULONG_PTR)hmod & 1;
60 }
61
62
63 /**********************************************************************
64  *  push_language
65  *
66  * push a language in the list of languages to try
67  */
68 static inline int push_language( WORD *list, int pos, WORD lang )
69 {
70     int i;
71     for (i = 0; i < pos; i++) if (list[i] == lang) return pos;
72     list[pos++] = lang;
73     return pos;
74 }
75
76
77 /**********************************************************************
78  *  find_first_entry
79  *
80  * Find the first suitable entry in a resource directory
81  */
82 static const IMAGE_RESOURCE_DIRECTORY *find_first_entry( const IMAGE_RESOURCE_DIRECTORY *dir,
83                                                          const void *root, int want_dir )
84 {
85     const IMAGE_RESOURCE_DIRECTORY_ENTRY *entry = (const IMAGE_RESOURCE_DIRECTORY_ENTRY *)(dir + 1);
86     int pos;
87
88     for (pos = 0; pos < dir->NumberOfNamedEntries + dir->NumberOfIdEntries; pos++)
89     {
90         if (!entry[pos].u2.s3.DataIsDirectory == !want_dir)
91             return (const IMAGE_RESOURCE_DIRECTORY *)((const char *)root + entry[pos].u2.s3.OffsetToDirectory);
92     }
93     return NULL;
94 }
95
96
97 /**********************************************************************
98  *  find_entry_by_id
99  *
100  * Find an entry by id in a resource directory
101  */
102 static const IMAGE_RESOURCE_DIRECTORY *find_entry_by_id( const IMAGE_RESOURCE_DIRECTORY *dir,
103                                                          WORD id, const void *root, int want_dir )
104 {
105     const IMAGE_RESOURCE_DIRECTORY_ENTRY *entry;
106     int min, max, pos;
107
108     entry = (const IMAGE_RESOURCE_DIRECTORY_ENTRY *)(dir + 1);
109     min = dir->NumberOfNamedEntries;
110     max = min + dir->NumberOfIdEntries - 1;
111     while (min <= max)
112     {
113         pos = (min + max) / 2;
114         if (entry[pos].u1.s2.Id == id)
115         {
116             if (!entry[pos].u2.s3.DataIsDirectory == !want_dir)
117             {
118                 TRACE("root %p dir %p id %04x ret %p\n",
119                       root, dir, id, (const char*)root + entry[pos].u2.s3.OffsetToDirectory);
120                 return (const IMAGE_RESOURCE_DIRECTORY *)((const char *)root + entry[pos].u2.s3.OffsetToDirectory);
121             }
122             break;
123         }
124         if (entry[pos].u1.s2.Id > id) max = pos - 1;
125         else min = pos + 1;
126     }
127     TRACE("root %p dir %p id %04x not found\n", root, dir, id );
128     return NULL;
129 }
130
131
132 /**********************************************************************
133  *  find_entry_by_name
134  *
135  * Find an entry by name in a resource directory
136  */
137 static const IMAGE_RESOURCE_DIRECTORY *find_entry_by_name( const IMAGE_RESOURCE_DIRECTORY *dir,
138                                                            LPCWSTR name, const void *root,
139                                                            int want_dir )
140 {
141     const IMAGE_RESOURCE_DIRECTORY_ENTRY *entry;
142     const IMAGE_RESOURCE_DIR_STRING_U *str;
143     int min, max, res, pos, namelen;
144
145     if (!HIWORD(name)) return find_entry_by_id( dir, LOWORD(name), root, want_dir );
146     entry = (const IMAGE_RESOURCE_DIRECTORY_ENTRY *)(dir + 1);
147     namelen = strlenW(name);
148     min = 0;
149     max = dir->NumberOfNamedEntries - 1;
150     while (min <= max)
151     {
152         pos = (min + max) / 2;
153         str = (const IMAGE_RESOURCE_DIR_STRING_U *)((const char *)root + entry[pos].u1.s1.NameOffset);
154         res = strncmpW( name, str->NameString, str->Length );
155         if (!res && namelen == str->Length)
156         {
157             if (!entry[pos].u2.s3.DataIsDirectory == !want_dir)
158             {
159                 TRACE("root %p dir %p name %s ret %p\n",
160                       root, dir, debugstr_w(name), (const char*)root + entry[pos].u2.s3.OffsetToDirectory);
161                 return (const IMAGE_RESOURCE_DIRECTORY *)((const char *)root + entry[pos].u2.s3.OffsetToDirectory);
162             }
163             break;
164         }
165         if (res < 0) max = pos - 1;
166         else min = pos + 1;
167     }
168     TRACE("root %p dir %p name %s not found\n", root, dir, debugstr_w(name) );
169     return NULL;
170 }
171
172
173 /**********************************************************************
174  *  find_entry
175  *
176  * Find a resource entry
177  */
178 static NTSTATUS find_entry( HMODULE hmod, const LDR_RESOURCE_INFO *info,
179                             ULONG level, const void **ret, int want_dir )
180 {
181     ULONG size;
182     const void *root;
183     const IMAGE_RESOURCE_DIRECTORY *resdirptr;
184     WORD list[9];  /* list of languages to try */
185     int i, pos = 0;
186
187     root = RtlImageDirectoryEntryToData( hmod, TRUE, IMAGE_DIRECTORY_ENTRY_RESOURCE, &size );
188     if (!root) return STATUS_RESOURCE_DATA_NOT_FOUND;
189     if (size < sizeof(*resdirptr)) return STATUS_RESOURCE_DATA_NOT_FOUND;
190     resdirptr = root;
191
192     if (!level--) goto done;
193     if (!(*ret = find_entry_by_name( resdirptr, (LPCWSTR)info->Type, root, want_dir || level )))
194         return STATUS_RESOURCE_TYPE_NOT_FOUND;
195     if (!level--) return STATUS_SUCCESS;
196
197     resdirptr = *ret;
198     if (!(*ret = find_entry_by_name( resdirptr, (LPCWSTR)info->Name, root, want_dir || level )))
199         return STATUS_RESOURCE_NAME_NOT_FOUND;
200     if (!level--) return STATUS_SUCCESS;
201     if (level) return STATUS_INVALID_PARAMETER;  /* level > 3 */
202
203     /* 1. specified language */
204     pos = push_language( list, pos, info->Language );
205
206     /* 2. specified language with neutral sublanguage */
207     pos = push_language( list, pos, MAKELANGID( PRIMARYLANGID(info->Language), SUBLANG_NEUTRAL ) );
208
209     /* 3. neutral language with neutral sublanguage */
210     pos = push_language( list, pos, MAKELANGID( LANG_NEUTRAL, SUBLANG_NEUTRAL ) );
211
212     /* if no explicitly specified language, try some defaults */
213     if (PRIMARYLANGID(info->Language) == LANG_NEUTRAL)
214     {
215         /* user defaults, unless SYS_DEFAULT sublanguage specified  */
216         if (SUBLANGID(info->Language) != SUBLANG_SYS_DEFAULT)
217         {
218             /* 4. current thread locale language */
219             pos = push_language( list, pos, LANGIDFROMLCID(NtCurrentTeb()->CurrentLocale) );
220
221             /* 5. user locale language */
222             pos = push_language( list, pos, LANGIDFROMLCID(user_lcid) );
223
224             /* 6. user locale language with neutral sublanguage  */
225             pos = push_language( list, pos, MAKELANGID( PRIMARYLANGID(user_lcid), SUBLANG_NEUTRAL ) );
226         }
227
228         /* now system defaults */
229
230         /* 7. system locale language */
231         pos = push_language( list, pos, LANGIDFROMLCID( system_lcid ) );
232
233         /* 8. system locale language with neutral sublanguage */
234         pos = push_language( list, pos, MAKELANGID( PRIMARYLANGID(system_lcid), SUBLANG_NEUTRAL ) );
235
236         /* 9. English */
237         pos = push_language( list, pos, MAKELANGID( LANG_ENGLISH, SUBLANG_DEFAULT ) );
238     }
239
240     resdirptr = *ret;
241     for (i = 0; i < pos; i++)
242         if ((*ret = find_entry_by_id( resdirptr, list[i], root, want_dir ))) return STATUS_SUCCESS;
243
244     /* if no explicitly specified language, return the first entry */
245     if (PRIMARYLANGID(info->Language) == LANG_NEUTRAL)
246     {
247         if ((*ret = find_first_entry( resdirptr, root, want_dir ))) return STATUS_SUCCESS;
248     }
249     return STATUS_RESOURCE_LANG_NOT_FOUND;
250
251 done:
252     *ret = resdirptr;
253     return STATUS_SUCCESS;
254 }
255
256
257 /**********************************************************************
258  *      LdrFindResourceDirectory_U  (NTDLL.@)
259  */
260 NTSTATUS WINAPI LdrFindResourceDirectory_U( HMODULE hmod, const LDR_RESOURCE_INFO *info,
261                                             ULONG level, const IMAGE_RESOURCE_DIRECTORY **dir )
262 {
263     const void *res;
264     NTSTATUS status;
265
266     __TRY
267     {
268         if (info) TRACE( "module %p type %s name %s lang %04x level %d\n",
269                      hmod, debugstr_w((LPCWSTR)info->Type),
270                      level > 1 ? debugstr_w((LPCWSTR)info->Name) : "",
271                      level > 2 ? info->Language : 0, level );
272
273         status = find_entry( hmod, info, level, &res, TRUE );
274         if (status == STATUS_SUCCESS) *dir = res;
275     }
276     __EXCEPT_PAGE_FAULT
277     {
278         return GetExceptionCode();
279     }
280     __ENDTRY;
281     return status;
282 }
283
284
285 /**********************************************************************
286  *      LdrFindResource_U  (NTDLL.@)
287  */
288 NTSTATUS WINAPI LdrFindResource_U( HMODULE hmod, const LDR_RESOURCE_INFO *info,
289                                    ULONG level, const IMAGE_RESOURCE_DATA_ENTRY **entry )
290 {
291     const void *res;
292     NTSTATUS status;
293
294     __TRY
295     {
296         if (info) TRACE( "module %p type %s name %s lang %04x level %d\n",
297                      hmod, debugstr_w((LPCWSTR)info->Type),
298                      level > 1 ? debugstr_w((LPCWSTR)info->Name) : "",
299                      level > 2 ? info->Language : 0, level );
300
301         status = find_entry( hmod, info, level, &res, FALSE );
302         if (status == STATUS_SUCCESS) *entry = res;
303     }
304     __EXCEPT_PAGE_FAULT
305     {
306         return GetExceptionCode();
307     }
308     __ENDTRY;
309     return status;
310 }
311
312
313 /* don't penalize other platforms stuff needed on i386 for compatibility */
314 #ifdef __i386__
315 NTSTATUS WINAPI access_resource( HMODULE hmod, const IMAGE_RESOURCE_DATA_ENTRY *entry,
316                                  void **ptr, ULONG *size )
317 #else
318 static inline NTSTATUS access_resource( HMODULE hmod, const IMAGE_RESOURCE_DATA_ENTRY *entry,
319                                         void **ptr, ULONG *size )
320 #endif
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  *      LdrAccessResource  (NTDLL.@)
355  *
356  * NOTE
357  * On x86, Shrinker, an executable compressor, depends on the
358  * "call access_resource" instruction being there.
359  */
360 #ifdef __i386__
361 __ASM_STDCALL_FUNC( LdrAccessResource, 16,
362     "pushl %ebp\n\t"
363     "movl %esp, %ebp\n\t"
364     "subl $4,%esp\n\t"
365     "pushl 24(%ebp)\n\t"
366     "pushl 20(%ebp)\n\t"
367     "pushl 16(%ebp)\n\t"
368     "pushl 12(%ebp)\n\t"
369     "pushl 8(%ebp)\n\t"
370     "call " __ASM_NAME("access_resource") "\n\t"
371     "leave\n\t"
372     "ret $16"
373 )
374 #else
375 NTSTATUS WINAPI LdrAccessResource( HMODULE hmod, const IMAGE_RESOURCE_DATA_ENTRY *entry,
376                                    void **ptr, ULONG *size )
377 {
378     return access_resource( hmod, entry, ptr, size );
379 }
380 #endif
381
382 /**********************************************************************
383  *      RtlFindMessage  (NTDLL.@)
384  */
385 NTSTATUS WINAPI RtlFindMessage( HMODULE hmod, ULONG type, ULONG lang,
386                                 ULONG msg_id, const MESSAGE_RESOURCE_ENTRY **ret )
387 {
388     const MESSAGE_RESOURCE_DATA *data;
389     const MESSAGE_RESOURCE_BLOCK *block;
390     const IMAGE_RESOURCE_DATA_ENTRY *rsrc;
391     LDR_RESOURCE_INFO info;
392     NTSTATUS status;
393     void *ptr;
394     unsigned int i;
395
396     info.Type     = type;
397     info.Name     = 1;
398     info.Language = lang;
399
400     if ((status = LdrFindResource_U( hmod, &info, 3, &rsrc )) != STATUS_SUCCESS)
401         return status;
402     if ((status = LdrAccessResource( hmod, rsrc, &ptr, NULL )) != STATUS_SUCCESS)
403         return status;
404
405     data = ptr;
406     block = data->Blocks;
407     for (i = 0; i < data->NumberOfBlocks; i++, block++)
408     {
409         if (msg_id >= block->LowId && msg_id <= block->HighId)
410         {
411             const MESSAGE_RESOURCE_ENTRY *entry;
412
413             entry = (const MESSAGE_RESOURCE_ENTRY *)((const char *)data + block->OffsetToEntries);
414             for (i = msg_id - block->LowId; i > 0; i--)
415                 entry = (const MESSAGE_RESOURCE_ENTRY *)((const char *)entry + entry->Length);
416             *ret = entry;
417             return STATUS_SUCCESS;
418         }
419     }
420     return STATUS_MESSAGE_NOT_FOUND;
421 }
422
423 /**********************************************************************
424  *      RtlFormatMessage  (NTDLL.@)
425  *
426  * Formats a message (similar to sprintf).
427  *
428  * PARAMS
429  *   Message          [I] Message to format.
430  *   MaxWidth         [I] Maximum width in characters of each output line.
431  *   IgnoreInserts    [I] Whether to copy the message without processing inserts.
432  *   Ansi             [I] Whether Arguments may have ANSI strings.
433  *   ArgumentsIsArray [I] Whether Arguments is actually an array rather than a va_list *.
434  *   Buffer           [O] Buffer to store processed message in.
435  *   BufferSize       [I] Size of Buffer (in bytes?).
436  *
437  * RETURNS
438  *      NTSTATUS code.
439  */
440 NTSTATUS WINAPI RtlFormatMessage( LPWSTR Message, UCHAR MaxWidth,
441                                   BOOLEAN IgnoreInserts, BOOLEAN Ansi,
442                                   BOOLEAN ArgumentIsArray, __ms_va_list * Arguments,
443                                   LPWSTR Buffer, ULONG BufferSize )
444 {
445     FIXME("(%s, %u, %s, %s, %s, %p, %p, %d)\n", debugstr_w(Message),
446         MaxWidth, IgnoreInserts ? "TRUE" : "FALSE", Ansi ? "TRUE" : "FALSE",
447         ArgumentIsArray ? "TRUE" : "FALSE", Arguments, Buffer, BufferSize);
448     return STATUS_SUCCESS;
449 }
450
451
452 /**********************************************************************
453  *      NtQueryDefaultLocale  (NTDLL.@)
454  */
455 NTSTATUS WINAPI NtQueryDefaultLocale( BOOLEAN user, LCID *lcid )
456 {
457     *lcid = user ? user_lcid : system_lcid;
458     return STATUS_SUCCESS;
459 }
460
461
462 /**********************************************************************
463  *      NtSetDefaultLocale  (NTDLL.@)
464  */
465 NTSTATUS WINAPI NtSetDefaultLocale( BOOLEAN user, LCID lcid )
466 {
467     if (user) user_lcid = lcid;
468     else
469     {
470         system_lcid = lcid;
471         system_ui_language = LANGIDFROMLCID(lcid); /* there is no separate call to set it */
472     }
473     return STATUS_SUCCESS;
474 }
475
476
477 /**********************************************************************
478  *      NtQueryDefaultUILanguage  (NTDLL.@)
479  */
480 NTSTATUS WINAPI NtQueryDefaultUILanguage( LANGID *lang )
481 {
482     *lang = user_ui_language;
483     return STATUS_SUCCESS;
484 }
485
486
487 /**********************************************************************
488  *      NtSetDefaultUILanguage  (NTDLL.@)
489  */
490 NTSTATUS WINAPI NtSetDefaultUILanguage( LANGID lang )
491 {
492     user_ui_language = lang;
493     return STATUS_SUCCESS;
494 }
495
496
497 /**********************************************************************
498  *      NtQueryInstallUILanguage  (NTDLL.@)
499  */
500 NTSTATUS WINAPI NtQueryInstallUILanguage( LANGID *lang )
501 {
502     *lang = system_ui_language;
503     return STATUS_SUCCESS;
504 }