kernel32: Convert FormatMessageA/W to use an MS ABI vararg list for x86_64.
[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     resdirptr = root;
190
191     if (!level--) goto done;
192     if (!(*ret = find_entry_by_name( resdirptr, (LPCWSTR)info->Type, root, want_dir || level )))
193         return STATUS_RESOURCE_TYPE_NOT_FOUND;
194     if (!level--) return STATUS_SUCCESS;
195
196     resdirptr = *ret;
197     if (!(*ret = find_entry_by_name( resdirptr, (LPCWSTR)info->Name, root, want_dir || level )))
198         return STATUS_RESOURCE_NAME_NOT_FOUND;
199     if (!level--) return STATUS_SUCCESS;
200     if (level) return STATUS_INVALID_PARAMETER;  /* level > 3 */
201
202     /* 1. specified language */
203     pos = push_language( list, pos, info->Language );
204
205     /* 2. specified language with neutral sublanguage */
206     pos = push_language( list, pos, MAKELANGID( PRIMARYLANGID(info->Language), SUBLANG_NEUTRAL ) );
207
208     /* 3. neutral language with neutral sublanguage */
209     pos = push_language( list, pos, MAKELANGID( LANG_NEUTRAL, SUBLANG_NEUTRAL ) );
210
211     /* if no explicitly specified language, try some defaults */
212     if (PRIMARYLANGID(info->Language) == LANG_NEUTRAL)
213     {
214         /* user defaults, unless SYS_DEFAULT sublanguage specified  */
215         if (SUBLANGID(info->Language) != SUBLANG_SYS_DEFAULT)
216         {
217             /* 4. current thread locale language */
218             pos = push_language( list, pos, LANGIDFROMLCID(NtCurrentTeb()->CurrentLocale) );
219
220             /* 5. user locale language */
221             pos = push_language( list, pos, LANGIDFROMLCID(user_lcid) );
222
223             /* 6. user locale language with neutral sublanguage  */
224             pos = push_language( list, pos, MAKELANGID( PRIMARYLANGID(user_lcid), SUBLANG_NEUTRAL ) );
225         }
226
227         /* now system defaults */
228
229         /* 7. system locale language */
230         pos = push_language( list, pos, LANGIDFROMLCID( system_lcid ) );
231
232         /* 8. system locale language with neutral sublanguage */
233         pos = push_language( list, pos, MAKELANGID( PRIMARYLANGID(system_lcid), SUBLANG_NEUTRAL ) );
234
235         /* 9. English */
236         pos = push_language( list, pos, MAKELANGID( LANG_ENGLISH, SUBLANG_DEFAULT ) );
237     }
238
239     resdirptr = *ret;
240     for (i = 0; i < pos; i++)
241         if ((*ret = find_entry_by_id( resdirptr, list[i], root, want_dir ))) return STATUS_SUCCESS;
242
243     /* if no explicitly specified language, return the first entry */
244     if (PRIMARYLANGID(info->Language) == LANG_NEUTRAL)
245     {
246         if ((*ret = find_first_entry( resdirptr, root, want_dir ))) return STATUS_SUCCESS;
247     }
248     return STATUS_RESOURCE_LANG_NOT_FOUND;
249
250 done:
251     *ret = resdirptr;
252     return STATUS_SUCCESS;
253 }
254
255
256 /**********************************************************************
257  *      LdrFindResourceDirectory_U  (NTDLL.@)
258  */
259 NTSTATUS WINAPI LdrFindResourceDirectory_U( HMODULE hmod, const LDR_RESOURCE_INFO *info,
260                                             ULONG level, const IMAGE_RESOURCE_DIRECTORY **dir )
261 {
262     const void *res;
263     NTSTATUS status;
264
265     __TRY
266     {
267         if (info) TRACE( "module %p type %s name %s lang %04x level %d\n",
268                      hmod, debugstr_w((LPCWSTR)info->Type),
269                      level > 1 ? debugstr_w((LPCWSTR)info->Name) : "",
270                      level > 2 ? info->Language : 0, level );
271
272         status = find_entry( hmod, info, level, &res, TRUE );
273         if (status == STATUS_SUCCESS) *dir = res;
274     }
275     __EXCEPT_PAGE_FAULT
276     {
277         return GetExceptionCode();
278     }
279     __ENDTRY;
280     return status;
281 }
282
283
284 /**********************************************************************
285  *      LdrFindResource_U  (NTDLL.@)
286  */
287 NTSTATUS WINAPI LdrFindResource_U( HMODULE hmod, const LDR_RESOURCE_INFO *info,
288                                    ULONG level, const IMAGE_RESOURCE_DATA_ENTRY **entry )
289 {
290     const void *res;
291     NTSTATUS status;
292
293     __TRY
294     {
295         if (info) TRACE( "module %p type %s name %s lang %04x level %d\n",
296                      hmod, debugstr_w((LPCWSTR)info->Type),
297                      level > 1 ? debugstr_w((LPCWSTR)info->Name) : "",
298                      level > 2 ? info->Language : 0, level );
299
300         status = find_entry( hmod, info, level, &res, FALSE );
301         if (status == STATUS_SUCCESS) *entry = res;
302     }
303     __EXCEPT_PAGE_FAULT
304     {
305         return GetExceptionCode();
306     }
307     __ENDTRY;
308     return status;
309 }
310
311
312 /* don't penalize other platforms stuff needed on i386 for compatibility */
313 #ifdef __i386__
314 NTSTATUS WINAPI access_resource( HMODULE hmod, const IMAGE_RESOURCE_DATA_ENTRY *entry,
315                                  void **ptr, ULONG *size )
316 #else
317 static inline NTSTATUS access_resource( HMODULE hmod, const IMAGE_RESOURCE_DATA_ENTRY *entry,
318                                         void **ptr, ULONG *size )
319 #endif
320 {
321     NTSTATUS status;
322
323     __TRY
324     {
325         ULONG dirsize;
326
327         if (!RtlImageDirectoryEntryToData( hmod, TRUE, IMAGE_DIRECTORY_ENTRY_RESOURCE, &dirsize ))
328             status = STATUS_RESOURCE_DATA_NOT_FOUND;
329         else
330         {
331             if (ptr)
332             {
333                 if (is_data_file_module(hmod))
334                 {
335                     HMODULE mod = (HMODULE)((ULONG_PTR)hmod & ~1);
336                     *ptr = RtlImageRvaToVa( RtlImageNtHeader(mod), mod, entry->OffsetToData, NULL );
337                 }
338                 else *ptr = (char *)hmod + entry->OffsetToData;
339             }
340             if (size) *size = entry->Size;
341             status = STATUS_SUCCESS;
342         }
343     }
344     __EXCEPT_PAGE_FAULT
345     {
346         return GetExceptionCode();
347     }
348     __ENDTRY;
349     return status;
350 }
351
352 /**********************************************************************
353  *      LdrAccessResource  (NTDLL.@)
354  *
355  * NOTE
356  * On x86, Shrinker, an executable compressor, depends on the
357  * "call access_resource" instruction being there.
358  */
359 #ifdef __i386__
360 __ASM_GLOBAL_FUNC( LdrAccessResource,
361     "pushl %ebp\n\t"
362     "movl %esp, %ebp\n\t"
363     "subl $4,%esp\n\t"
364     "pushl 24(%ebp)\n\t"
365     "pushl 20(%ebp)\n\t"
366     "pushl 16(%ebp)\n\t"
367     "pushl 12(%ebp)\n\t"
368     "pushl 8(%ebp)\n\t"
369     "call " __ASM_NAME("access_resource") "\n\t"
370     "leave\n\t"
371     "ret $16"
372 )
373 #else
374 NTSTATUS WINAPI LdrAccessResource( HMODULE hmod, const IMAGE_RESOURCE_DATA_ENTRY *entry,
375                                    void **ptr, ULONG *size )
376 {
377     return access_resource( hmod, entry, ptr, size );
378 }
379 #endif
380
381 /**********************************************************************
382  *      RtlFindMessage  (NTDLL.@)
383  */
384 NTSTATUS WINAPI RtlFindMessage( HMODULE hmod, ULONG type, ULONG lang,
385                                 ULONG msg_id, const MESSAGE_RESOURCE_ENTRY **ret )
386 {
387     const MESSAGE_RESOURCE_DATA *data;
388     const MESSAGE_RESOURCE_BLOCK *block;
389     const IMAGE_RESOURCE_DATA_ENTRY *rsrc;
390     LDR_RESOURCE_INFO info;
391     NTSTATUS status;
392     void *ptr;
393     unsigned int i;
394
395     info.Type     = type;
396     info.Name     = 1;
397     info.Language = lang;
398
399     if ((status = LdrFindResource_U( hmod, &info, 3, &rsrc )) != STATUS_SUCCESS)
400         return status;
401     if ((status = LdrAccessResource( hmod, rsrc, &ptr, NULL )) != STATUS_SUCCESS)
402         return status;
403
404     data = ptr;
405     block = data->Blocks;
406     for (i = 0; i < data->NumberOfBlocks; i++, block++)
407     {
408         if (msg_id >= block->LowId && msg_id <= block->HighId)
409         {
410             const MESSAGE_RESOURCE_ENTRY *entry;
411
412             entry = (const MESSAGE_RESOURCE_ENTRY *)((const char *)data + block->OffsetToEntries);
413             for (i = msg_id - block->LowId; i > 0; i--)
414                 entry = (const MESSAGE_RESOURCE_ENTRY *)((const char *)entry + entry->Length);
415             *ret = entry;
416             return STATUS_SUCCESS;
417         }
418     }
419     return STATUS_MESSAGE_NOT_FOUND;
420 }
421
422 /**********************************************************************
423  *      RtlFormatMessage  (NTDLL.@)
424  *
425  * Formats a message (similar to sprintf).
426  *
427  * PARAMS
428  *   Message          [I] Message to format.
429  *   MaxWidth         [I] Maximum width in characters of each output line.
430  *   IgnoreInserts    [I] Whether to copy the message without processing inserts.
431  *   Ansi             [I] Whether Arguments may have ANSI strings.
432  *   ArgumentsIsArray [I] Whether Arguments is actually an array rather than a va_list *.
433  *   Buffer           [O] Buffer to store processed message in.
434  *   BufferSize       [I] Size of Buffer (in bytes?).
435  *
436  * RETURNS
437  *      NTSTATUS code.
438  */
439 NTSTATUS WINAPI RtlFormatMessage( LPWSTR Message, UCHAR MaxWidth,
440                                   BOOLEAN IgnoreInserts, BOOLEAN Ansi,
441                                   BOOLEAN ArgumentIsArray, __ms_va_list * Arguments,
442                                   LPWSTR Buffer, ULONG BufferSize )
443 {
444     FIXME("(%s, %u, %s, %s, %s, %p, %p, %d)\n", debugstr_w(Message),
445         MaxWidth, IgnoreInserts ? "TRUE" : "FALSE", Ansi ? "TRUE" : "FALSE",
446         ArgumentIsArray ? "TRUE" : "FALSE", Arguments, Buffer, BufferSize);
447     return STATUS_SUCCESS;
448 }
449
450
451 /**********************************************************************
452  *      NtQueryDefaultLocale  (NTDLL.@)
453  */
454 NTSTATUS WINAPI NtQueryDefaultLocale( BOOLEAN user, LCID *lcid )
455 {
456     *lcid = user ? user_lcid : system_lcid;
457     return STATUS_SUCCESS;
458 }
459
460
461 /**********************************************************************
462  *      NtSetDefaultLocale  (NTDLL.@)
463  */
464 NTSTATUS WINAPI NtSetDefaultLocale( BOOLEAN user, LCID lcid )
465 {
466     if (user) user_lcid = lcid;
467     else
468     {
469         system_lcid = lcid;
470         system_ui_language = LANGIDFROMLCID(lcid); /* there is no separate call to set it */
471     }
472     return STATUS_SUCCESS;
473 }
474
475
476 /**********************************************************************
477  *      NtQueryDefaultUILanguage  (NTDLL.@)
478  */
479 NTSTATUS WINAPI NtQueryDefaultUILanguage( LANGID *lang )
480 {
481     *lang = user_ui_language;
482     return STATUS_SUCCESS;
483 }
484
485
486 /**********************************************************************
487  *      NtSetDefaultUILanguage  (NTDLL.@)
488  */
489 NTSTATUS WINAPI NtSetDefaultUILanguage( LANGID lang )
490 {
491     user_ui_language = lang;
492     return STATUS_SUCCESS;
493 }
494
495
496 /**********************************************************************
497  *      NtQueryInstallUILanguage  (NTDLL.@)
498  */
499 NTSTATUS WINAPI NtQueryInstallUILanguage( LANGID *lang )
500 {
501     *lang = system_ui_language;
502     return STATUS_SUCCESS;
503 }