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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
31 #include "wine/unicode.h"
34 #include "wine/debug.h"
36 WINE_DEFAULT_DEBUG_CHANNEL(resource);
39 /* Messages...used by FormatMessage32* (KERNEL32.something)
41 * They can be specified either directly or using a message ID and
42 * loading them from the resource.
44 * The resourcedata has following format:
46 * 0: DWORD nrofentries
47 * nrofentries * subentry:
50 * 8: DWORD offset from start to the stringentries
52 * (lastentry-firstentry) * stringentry:
53 * 0: WORD len (0 marks end) [ includes the 4 byte header length ]
56 * (stringentry i of a subentry refers to the ID 'firstentry+i')
58 * Yes, ANSI strings in win32 resources. Go figure.
61 /**********************************************************************
62 * load_messageA (internal)
64 static INT load_messageA( HMODULE instance, UINT id, WORD lang,
65 LPSTR buffer, INT buflen )
69 PMESSAGE_RESOURCE_DATA mrd;
70 PMESSAGE_RESOURCE_BLOCK mrb;
71 PMESSAGE_RESOURCE_ENTRY mre;
74 TRACE("instance = %08lx, id = %08lx, buffer = %p, length = %ld\n", (DWORD)instance, (DWORD)id, buffer, (DWORD)buflen);
76 /*FIXME: I am not sure about the '1' ... But I've only seen those entries*/
77 hrsrc = FindResourceExW(instance,RT_MESSAGETABLEW,(LPWSTR)1,lang);
79 hmem = LoadResource( instance, hrsrc );
82 mrd = (PMESSAGE_RESOURCE_DATA)LockResource(hmem);
84 mrb = &(mrd->Blocks[0]);
85 for (i=mrd->NumberOfBlocks;i--;) {
86 if ((id>=mrb->LowId) && (id<=mrb->HighId)) {
87 mre = (PMESSAGE_RESOURCE_ENTRY)(((char*)mrd)+mrb->OffsetToEntries);
98 mre = (PMESSAGE_RESOURCE_ENTRY)(((char*)mre)+mre->Length);
101 TRACE(" - strlen=%d\n",slen);
102 i = min(buflen - 1, slen);
106 if (mre->Flags & MESSAGE_RESOURCE_UNICODE)
107 WideCharToMultiByte( CP_ACP, 0, (LPWSTR)mre->Text, -1, buffer, i, NULL, NULL );
109 lstrcpynA(buffer, (LPSTR)mre->Text, i);
118 TRACE("'%s' copied !\n", buffer);
123 /**********************************************************************
124 * load_messageW (internal)
126 static INT load_messageW( HMODULE instance, UINT id, WORD lang,
127 LPWSTR buffer, INT buflen )
130 LPSTR buffer2 = NULL;
131 if (buffer && buflen)
132 buffer2 = HeapAlloc( GetProcessHeap(), 0, buflen );
133 retval = load_messageA(instance,id,lang,buffer2,buflen);
137 lstrcpynAtoW( buffer, buffer2, buflen );
138 retval = strlenW( buffer );
140 HeapFree( GetProcessHeap(), 0, buffer2 );
147 /***********************************************************************
148 * FormatMessageA (KERNEL32.@)
149 * FIXME: missing wrap,
151 DWORD WINAPI FormatMessageA(
160 LPDWORD args=(LPDWORD)_args;
161 #if defined(__i386__) || defined(__sparc__)
162 /* This implementation is completely dependant on the format of the va_list on x86 CPUs */
166 DWORD width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
169 HMODULE hmodule = (HMODULE)lpSource;
172 TRACE("(0x%lx,%p,%ld,0x%lx,%p,%ld,%p)\n",
173 dwFlags,lpSource,dwMessageId,dwLanguageId,lpBuffer,nSize,args);
174 if ((dwFlags & FORMAT_MESSAGE_FROM_STRING)
175 &&((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
176 || (dwFlags & FORMAT_MESSAGE_FROM_HMODULE))) return 0;
178 if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
179 FIXME("line wrapping (%lu) not supported.\n", width);
181 if (dwFlags & FORMAT_MESSAGE_FROM_STRING)
183 from = HeapAlloc( GetProcessHeap(), 0, strlen((LPSTR)lpSource)+1 );
184 strcpy( from, (LPSTR)lpSource );
189 if (dwFlags & FORMAT_MESSAGE_FROM_HMODULE)
191 bufsize=load_messageA(hmodule,dwMessageId,dwLanguageId,NULL,100);
192 if ((!bufsize) && (!dwLanguageId)) {
193 bufsize=load_messageA(hmodule,dwMessageId,
194 MAKELANGID(LANG_NEUTRAL,SUBLANG_NEUTRAL),NULL,100);
195 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
196 MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),NULL,100);
197 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
198 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
199 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
200 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
201 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
202 MAKELANGID(LANG_ENGLISH,SUBLANG_ENGLISH_US),NULL,100);
205 if ((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM) && (!bufsize))
207 hmodule = GetModuleHandleA("kernel32");
208 bufsize=load_messageA(hmodule,dwMessageId,dwLanguageId,NULL,100);
209 if ((!bufsize) && (!dwLanguageId)) {
210 bufsize=load_messageA(hmodule,dwMessageId,
211 MAKELANGID(LANG_NEUTRAL,SUBLANG_NEUTRAL),NULL,100);
212 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
213 MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),NULL,100);
214 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
215 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
216 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
217 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
218 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
219 MAKELANGID(LANG_ENGLISH,SUBLANG_ENGLISH_US),NULL,100);
224 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
228 from = HeapAlloc( GetProcessHeap(), 0, bufsize + 1 );
229 load_messageA(hmodule,dwMessageId,dwLanguageId,from,bufsize+1);
231 target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100);
235 #define ADD_TO_T(c) do { \
237 if (t-target == talloced) {\
238 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
239 t = target+talloced;\
246 if (dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS) {
254 char *fmtstr,*x,*lastf;
265 case '1':case '2':case '3':case '4':case '5':
266 case '6':case '7':case '8':case '9':
269 case '0':case '1':case '2':case '3':
270 case '4':case '5':case '6':case '7':
273 insertnr=insertnr*10+*f-'0';
282 if (NULL!=(x=strchr(f,'!'))) {
284 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
285 sprintf(fmtstr,"%%%s",f);
288 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
289 sprintf(fmtstr,"%%%s",f);
290 f+=strlen(f); /*at \0*/
294 fmtstr = HeapAlloc(GetProcessHeap(),0,3);
295 strcpy( fmtstr, "%s" );
301 if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
302 argliststart=args+insertnr-1;
304 argliststart=(*(DWORD**)args)+insertnr-1;
306 /* FIXME: precision and width components are not handled correctly */
307 if ( (strcmp(fmtstr, "%ls") == 0) || (strcmp(fmtstr,"%S") == 0) ) {
308 sz = WideCharToMultiByte( CP_ACP, 0, *(WCHAR**)argliststart, -1, NULL, 0, NULL, NULL);
309 b = HeapAlloc(GetProcessHeap(), 0, sz);
310 WideCharToMultiByte( CP_ACP, 0, *(WCHAR**)argliststart, -1, b, sz, NULL, NULL);
312 b = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sz = 1000);
313 /* CMF - This makes a BIG assumption about va_list */
314 TRACE("A BIG assumption\n");
315 vsnprintf(b, sz, fmtstr, (va_list) argliststart);
317 for (x=b; *x; x++) ADD_TO_T(*x);
319 HeapFree(GetProcessHeap(),0,b);
321 /* NULL args - copy formatstr
324 while ((lastf<f)&&(*lastf)) {
328 HeapFree(GetProcessHeap(),0,fmtstr);
375 talloced = strlen(target)+1;
376 if (nSize && talloced<nSize) {
377 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize);
379 TRACE("-- %s\n",debugstr_a(target));
380 if (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) {
381 *((LPVOID*)lpBuffer) = (LPVOID)LocalAlloc(GMEM_ZEROINIT,max(nSize, talloced));
382 memcpy(*(LPSTR*)lpBuffer,target,talloced);
384 lstrcpynA(lpBuffer,target,nSize);
386 HeapFree(GetProcessHeap(),0,target);
387 if (from) HeapFree(GetProcessHeap(),0,from);
388 TRACE("-- returning %d\n", (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ? strlen(*(LPSTR*)lpBuffer):strlen(lpBuffer));
389 return (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
390 strlen(*(LPSTR*)lpBuffer):
394 #endif /* __i386__ */
399 /***********************************************************************
400 * FormatMessageW (KERNEL32.@)
402 DWORD WINAPI FormatMessageW(
411 LPDWORD args=(LPDWORD)_args;
412 #if defined(__i386__) || defined(__sparc__)
413 /* This implementation is completely dependant on the format of the va_list on x86 CPUs */
417 DWORD width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
420 HMODULE hmodule = (HMODULE)lpSource;
423 TRACE("(0x%lx,%p,%ld,0x%lx,%p,%ld,%p)\n",
424 dwFlags,lpSource,dwMessageId,dwLanguageId,lpBuffer,nSize,args);
425 if ((dwFlags & FORMAT_MESSAGE_FROM_STRING)
426 &&((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
427 || (dwFlags & FORMAT_MESSAGE_FROM_HMODULE))) return 0;
429 if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
430 FIXME("line wrapping not supported.\n");
432 if (dwFlags & FORMAT_MESSAGE_FROM_STRING) {
433 from = HEAP_strdupWtoA(GetProcessHeap(),0,(LPWSTR)lpSource);
438 if (dwFlags & FORMAT_MESSAGE_FROM_HMODULE)
440 bufsize=load_messageA(hmodule,dwMessageId,dwLanguageId,NULL,100);
441 if ((!bufsize) && (!dwLanguageId)) {
442 bufsize=load_messageA(hmodule,dwMessageId,
443 MAKELANGID(LANG_NEUTRAL,SUBLANG_NEUTRAL),NULL,100);
444 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
445 MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),NULL,100);
446 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
447 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
448 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
449 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
450 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
451 MAKELANGID(LANG_ENGLISH,SUBLANG_ENGLISH_US),NULL,100);
454 if ((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM) && (!bufsize))
456 hmodule = GetModuleHandleA("kernel32");
457 bufsize=load_messageA(hmodule,dwMessageId,dwLanguageId,NULL,100);
458 if ((!bufsize) && (!dwLanguageId)) {
459 bufsize=load_messageA(hmodule,dwMessageId,
460 MAKELANGID(LANG_NEUTRAL,SUBLANG_NEUTRAL),NULL,100);
461 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
462 MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),NULL,100);
463 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
464 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
465 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
466 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
467 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
468 MAKELANGID(LANG_ENGLISH,SUBLANG_ENGLISH_US),NULL,100);
473 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
477 from = HeapAlloc( GetProcessHeap(), 0, bufsize + 1 );
478 load_messageA(hmodule,dwMessageId,dwLanguageId,from,bufsize+1);
480 target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100 );
484 #define ADD_TO_T(c) do {\
486 if (t-target == talloced) {\
487 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
488 t = target+talloced;\
495 if (dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS) {
503 char *fmtstr,*sprintfbuf,*x;
514 case '1':case '2':case '3':case '4':case '5':
515 case '6':case '7':case '8':case '9':
518 case '0':case '1':case '2':case '3':
519 case '4':case '5':case '6':case '7':
522 insertnr=insertnr*10+*f-'0';
531 if (NULL!=(x=strchr(f,'!'))) {
533 fmtstr=HeapAlloc( GetProcessHeap(), 0, strlen(f)+2);
534 sprintf(fmtstr,"%%%s",f);
537 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f));
538 sprintf(fmtstr,"%%%s",f);
539 f+=strlen(f); /*at \0*/
543 fmtstr = HeapAlloc( GetProcessHeap(),0,3);
544 strcpy( fmtstr, "%s" );
546 if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
547 argliststart=args+insertnr-1;
549 argliststart=(*(DWORD**)args)+insertnr-1;
551 if (fmtstr[strlen(fmtstr)-1]=='s' && argliststart[0]) {
554 xarr[0]=(DWORD)HEAP_strdupWtoA(GetProcessHeap(),0,(LPWSTR)(*(argliststart+0)));
555 /* possible invalid pointers */
556 xarr[1]=*(argliststart+1);
557 xarr[2]=*(argliststart+2);
558 sprintfbuf=HeapAlloc(GetProcessHeap(),0,strlenW((LPWSTR)argliststart[0])*2+1);
560 /* CMF - This makes a BIG assumption about va_list */
561 vsprintf(sprintfbuf, fmtstr, (va_list) xarr);
562 HeapFree(GetProcessHeap(), 0, (LPVOID) xarr[0]);
564 sprintfbuf=HeapAlloc(GetProcessHeap(),0,100);
566 /* CMF - This makes a BIG assumption about va_list */
567 vsprintf(sprintfbuf, fmtstr, (va_list) argliststart);
573 HeapFree(GetProcessHeap(),0,sprintfbuf);
574 HeapFree(GetProcessHeap(),0,fmtstr);
621 talloced = strlen(target)+1;
622 if (nSize && talloced<nSize)
623 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize);
624 if (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) {
625 /* nSize is the MINIMUM size */
626 DWORD len = MultiByteToWideChar( CP_ACP, 0, target, -1, NULL, 0 );
627 *((LPVOID*)lpBuffer) = (LPVOID)LocalAlloc(GMEM_ZEROINIT,len*sizeof(WCHAR));
628 MultiByteToWideChar( CP_ACP, 0, target, -1, *(LPWSTR*)lpBuffer, len );
632 if (nSize > 0 && !MultiByteToWideChar( CP_ACP, 0, target, -1, lpBuffer, nSize ))
633 lpBuffer[nSize-1] = 0;
635 HeapFree(GetProcessHeap(),0,target);
636 if (from) HeapFree(GetProcessHeap(),0,from);
637 return (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
638 strlenW(*(LPWSTR*)lpBuffer):
642 #endif /* __i386__ */