2 * FormatMessage implementation
4 * Copyright 1996 Marcus Meissner
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
28 #define WIN32_NO_STATUS
35 #include "wine/unicode.h"
36 #include "kernel_private.h"
37 #include "wine/debug.h"
39 WINE_DEFAULT_DEBUG_CHANNEL(resource);
42 /* Messages used by FormatMessage
44 * They can be specified either directly or using a message ID and
45 * loading them from the resource.
47 * The resourcedata has following format:
49 * 0: DWORD nrofentries
50 * nrofentries * subentry:
53 * 8: DWORD offset from start to the stringentries
55 * (lastentry-firstentry) * stringentry:
56 * 0: WORD len (0 marks end) [ includes the 4 byte header length ]
59 * (stringentry i of a subentry refers to the ID 'firstentry+i')
61 * Yes, ANSI strings in win32 resources. Go figure.
64 static const WCHAR PCNTFMTWSTR[] = { '%','%','%','s',0 };
65 static const WCHAR FMTWSTR[] = { '%','s',0 };
67 /**********************************************************************
68 * load_messageW (internal)
70 static LPWSTR load_messageW( HMODULE module, UINT id, WORD lang )
72 const MESSAGE_RESOURCE_ENTRY *mre;
75 TRACE("module = %p, id = %08x\n", module, id );
77 if (!module) module = GetModuleHandleW( NULL );
78 if (RtlFindMessage( module, RT_MESSAGETABLE, lang, id, &mre ) != STATUS_SUCCESS) return NULL;
80 if (mre->Flags & MESSAGE_RESOURCE_UNICODE)
82 int len = (strlenW( (const WCHAR *)mre->Text ) + 1) * sizeof(WCHAR);
83 if (!(buffer = HeapAlloc( GetProcessHeap(), 0, len ))) return NULL;
84 memcpy( buffer, mre->Text, len );
88 int len = MultiByteToWideChar( CP_ACP, 0, (const char *)mre->Text, -1, NULL, 0 );
89 if (!(buffer = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) ))) return NULL;
90 MultiByteToWideChar( CP_ACP, 0, (const char*)mre->Text, -1, buffer, len );
92 TRACE("returning %s\n", wine_dbgstr_w(buffer));
97 /**********************************************************************
98 * load_messageA (internal)
100 static LPSTR load_messageA( HMODULE module, UINT id, WORD lang )
102 const MESSAGE_RESOURCE_ENTRY *mre;
105 TRACE("module = %p, id = %08x\n", module, id );
107 if (!module) module = GetModuleHandleW( NULL );
108 if (RtlFindMessage( module, RT_MESSAGETABLE, lang, id, &mre ) != STATUS_SUCCESS) return NULL;
110 if (mre->Flags & MESSAGE_RESOURCE_UNICODE)
112 int len = WideCharToMultiByte( CP_ACP, 0, (const WCHAR *)mre->Text, -1, NULL, 0, NULL, NULL );
113 if (!(buffer = HeapAlloc( GetProcessHeap(), 0, len ))) return NULL;
114 WideCharToMultiByte( CP_ACP, 0, (const WCHAR *)mre->Text, -1, buffer, len, NULL, NULL );
118 int len = strlen((const char*)mre->Text) + 1;
119 if (!(buffer = HeapAlloc( GetProcessHeap(), 0, len ))) return NULL;
120 memcpy( buffer, mre->Text, len );
122 TRACE("returning %s\n", wine_dbgstr_a(buffer));
127 /***********************************************************************
128 * FormatMessageA (KERNEL32.@)
129 * FIXME: missing wrap,
131 DWORD WINAPI FormatMessageA(
138 __ms_va_list* _args )
140 LPDWORD args=(LPDWORD)_args;
142 #if defined(__i386__) || defined(__sparc__)
143 /* This implementation is completely dependent on the format of the va_list on x86 CPUs */
147 DWORD width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
151 TRACE("(0x%x,%p,%d,0x%x,%p,%d,%p)\n",
152 dwFlags,lpSource,dwMessageId,dwLanguageId,lpBuffer,nSize,args);
153 if ((dwFlags & FORMAT_MESSAGE_FROM_STRING)
154 &&((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
155 || (dwFlags & FORMAT_MESSAGE_FROM_HMODULE))) return 0;
159 SetLastError(ERROR_NOT_ENOUGH_MEMORY);
163 if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
164 FIXME("line wrapping (%u) not supported.\n", width);
166 if (dwFlags & FORMAT_MESSAGE_FROM_STRING)
168 from = HeapAlloc( GetProcessHeap(), 0, strlen(lpSource) + 1 );
169 strcpy( from, lpSource );
173 if (dwFlags & FORMAT_MESSAGE_FROM_HMODULE)
174 from = load_messageA( (HMODULE)lpSource, dwMessageId, dwLanguageId );
175 if (!from && (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM))
176 from = load_messageA( kernel32_handle, dwMessageId, dwLanguageId );
180 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
184 target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100);
188 #define ADD_TO_T(c) do { \
190 if ((DWORD)(t-target) == talloced) {\
191 target = HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
192 t = target+talloced;\
199 if (dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS) {
207 char *fmtstr,*x,*lastf;
218 case '1':case '2':case '3':case '4':case '5':
219 case '6':case '7':case '8':case '9':
222 case '0':case '1':case '2':case '3':
223 case '4':case '5':case '6':case '7':
226 insertnr=insertnr*10+*f-'0';
235 if (NULL!=(x=strchr(f,'!'))) {
237 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
238 sprintf(fmtstr,"%%%s",f);
241 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
242 sprintf(fmtstr,"%%%s",f);
243 f+=strlen(f); /*at \0*/
247 fmtstr = HeapAlloc(GetProcessHeap(),0,3);
248 strcpy( fmtstr, "%s" );
254 if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
255 argliststart=args+insertnr-1;
257 argliststart=(*(DWORD**)args)+insertnr-1;
259 /* FIXME: precision and width components are not handled correctly */
260 if (strcmp(fmtstr, "%ls") == 0 || strcmp(fmtstr,"%S") == 0 || strcmp(fmtstr,"%ws") == 0)
262 sz = WideCharToMultiByte(CP_ACP, 0, *(WCHAR**)argliststart, -1, NULL, 0, NULL, NULL);
263 b = HeapAlloc(GetProcessHeap(), 0, sz);
264 WideCharToMultiByte(CP_ACP, 0, *(WCHAR**)argliststart, -1, b, sz, NULL, NULL);
266 else if (strcmp(fmtstr, "%wc") == 0)
268 sz = WideCharToMultiByte(CP_ACP, 0, (WCHAR *)argliststart, 1, NULL, 0, NULL, NULL);
269 b = HeapAlloc(GetProcessHeap(), 0, sz + 1);
270 WideCharToMultiByte(CP_ACP, 0, (WCHAR *)argliststart, 1, b, sz, NULL, NULL);
275 b = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sz = 1000);
276 /* CMF - This makes a BIG assumption about va_list */
277 TRACE("A BIG assumption\n");
278 vsnprintf(b, sz, fmtstr, (va_list) argliststart);
280 for (x=b; *x; x++) ADD_TO_T(*x);
282 HeapFree(GetProcessHeap(),0,b);
284 /* NULL args - copy formatstr
287 while ((lastf<f)&&(*lastf)) {
291 HeapFree(GetProcessHeap(),0,fmtstr);
338 talloced = strlen(target)+1;
339 if (nSize && talloced<nSize) {
340 target = HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize);
342 TRACE("-- %s\n",debugstr_a(target));
343 if (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) {
344 *((LPVOID*)lpBuffer) = LocalAlloc(LMEM_ZEROINIT,max(nSize, talloced));
345 memcpy(*(LPSTR*)lpBuffer,target,talloced);
347 lstrcpynA(lpBuffer,target,nSize);
349 HeapFree(GetProcessHeap(),0,target);
350 HeapFree(GetProcessHeap(),0,from);
351 ret = (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ? strlen(*(LPSTR*)lpBuffer) : strlen(lpBuffer);
352 #endif /* __i386__ */
353 TRACE("-- returning %d\n", ret);
359 /***********************************************************************
360 * FormatMessageW (KERNEL32.@)
362 DWORD WINAPI FormatMessageW(
369 __ms_va_list* _args )
371 LPDWORD args=(LPDWORD)_args;
372 #if defined(__i386__) || defined(__sparc__)
373 /* This implementation is completely dependent on the format of the va_list on x86 CPUs */
377 DWORD width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
380 static const WCHAR fmt_wc[] = {'%','w','c',0};
382 TRACE("(0x%x,%p,%d,0x%x,%p,%d,%p)\n",
383 dwFlags,lpSource,dwMessageId,dwLanguageId,lpBuffer,nSize,args);
384 if ((dwFlags & FORMAT_MESSAGE_FROM_STRING)
385 &&((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
386 || (dwFlags & FORMAT_MESSAGE_FROM_HMODULE))) return 0;
390 SetLastError(ERROR_INVALID_PARAMETER);
394 if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
395 FIXME("line wrapping not supported.\n");
397 if (dwFlags & FORMAT_MESSAGE_FROM_STRING) {
398 from = HeapAlloc( GetProcessHeap(), 0, (strlenW(lpSource) + 1) *
400 strcpyW( from, lpSource );
404 if (dwFlags & FORMAT_MESSAGE_FROM_HMODULE)
405 from = load_messageW( (HMODULE)lpSource, dwMessageId, dwLanguageId );
406 if (!from && (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM))
407 from = load_messageW( kernel32_handle, dwMessageId, dwLanguageId );
411 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
415 target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100 * sizeof(WCHAR) );
419 #define ADD_TO_T(c) do {\
421 if ((DWORD)(t-target) == talloced) {\
422 target = HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2*sizeof(WCHAR));\
423 t = target+talloced;\
430 if (dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS) {
438 WCHAR *fmtstr,*sprintfbuf,*x;
449 case '1':case '2':case '3':case '4':case '5':
450 case '6':case '7':case '8':case '9':
453 case '0':case '1':case '2':case '3':
454 case '4':case '5':case '6':case '7':
457 insertnr=insertnr*10+*f-'0';
466 if (NULL!=(x=strchrW(f,'!'))) {
468 fmtstr=HeapAlloc( GetProcessHeap(), 0,(strlenW(f)+2)*sizeof(WCHAR));
469 sprintfW(fmtstr,PCNTFMTWSTR,f);
472 fmtstr=HeapAlloc(GetProcessHeap(),0,(strlenW(f)+2)*sizeof(WCHAR));
473 sprintfW(fmtstr,PCNTFMTWSTR,f);
474 f+=strlenW(f); /*at \0*/
478 fmtstr = HeapAlloc( GetProcessHeap(),0,3*sizeof(WCHAR));
479 strcpyW( fmtstr, FMTWSTR );
481 if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
482 argliststart=args+insertnr-1;
484 argliststart=(*(DWORD**)args)+insertnr-1;
486 if (fmtstr[strlenW(fmtstr)-1]=='s' && argliststart[0]) {
488 WCHAR *fmt_end = fmtstr + strlenW(fmtstr) - 1;
490 /* remap %ws to %ls */
491 if (fmt_end > fmtstr && (fmt_end[-1] == 'w')) fmt_end[-1] = 'l';
492 xarr[0]=*(argliststart+0);
493 /* possible invalid pointers */
494 xarr[1]=*(argliststart+1);
495 xarr[2]=*(argliststart+2);
496 sprintfbuf=HeapAlloc(GetProcessHeap(),0,(strlenW((LPWSTR)argliststart[0])*2+1)*sizeof(WCHAR));
498 /* CMF - This makes a BIG assumption about va_list */
499 vsprintfW(sprintfbuf, fmtstr, (va_list) xarr);
501 else if (strcmpW(fmtstr, fmt_wc) == 0) {
502 sprintfbuf = HeapAlloc(GetProcessHeap(), 0, sizeof(WCHAR) * 2);
503 sprintfbuf[0] = *(WCHAR *)argliststart;
506 sprintfbuf=HeapAlloc(GetProcessHeap(),0,100);
508 /* CMF - This makes a BIG assumption about va_list */
509 vsprintfW(sprintfbuf, fmtstr, (va_list) argliststart);
515 HeapFree(GetProcessHeap(),0,sprintfbuf);
516 HeapFree(GetProcessHeap(),0,fmtstr);
563 talloced = strlenW(target)+1;
564 if (nSize && talloced<nSize)
565 target = HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize*sizeof(WCHAR));
566 if (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) {
567 /* nSize is the MINIMUM size */
568 DWORD len = strlenW(target) + 1;
569 *((LPVOID*)lpBuffer) = LocalAlloc(LMEM_ZEROINIT,len*sizeof(WCHAR));
570 strcpyW(*(LPWSTR*)lpBuffer, target);
572 else lstrcpynW(lpBuffer, target, nSize);
574 HeapFree(GetProcessHeap(),0,target);
575 HeapFree(GetProcessHeap(),0,from);
576 TRACE("ret=%s\n", wine_dbgstr_w((dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
577 *(LPWSTR*)lpBuffer : lpBuffer));
578 return (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
579 strlenW(*(LPWSTR*)lpBuffer):
583 #endif /* __i386__ */