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_SYSTEM)
175 && (dwFlags & FORMAT_MESSAGE_FROM_HMODULE)) return 0;
176 if ((dwFlags & FORMAT_MESSAGE_FROM_STRING)
177 &&((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
178 || (dwFlags & FORMAT_MESSAGE_FROM_HMODULE))) return 0;
180 if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
181 FIXME("line wrapping (%lu) not supported.\n", width);
183 if (dwFlags & FORMAT_MESSAGE_FROM_STRING)
185 from = HeapAlloc( GetProcessHeap(), 0, strlen((LPSTR)lpSource)+1 );
186 strcpy( from, (LPSTR)lpSource );
189 if (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
190 hmodule = GetModuleHandleA("kernel32");
191 bufsize=load_messageA(hmodule,dwMessageId,dwLanguageId,NULL,100);
194 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
197 bufsize=load_messageA(hmodule,dwMessageId,
198 MAKELANGID(LANG_NEUTRAL,SUBLANG_NEUTRAL),NULL,100);
199 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
200 MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),NULL,100);
201 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
202 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
203 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
204 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
205 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
206 MAKELANGID(LANG_ENGLISH,SUBLANG_ENGLISH_US),NULL,100);
208 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
212 from = HeapAlloc( GetProcessHeap(), 0, bufsize + 1 );
213 load_messageA(hmodule,dwMessageId,dwLanguageId,from,bufsize+1);
215 target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100);
219 #define ADD_TO_T(c) do { \
221 if (t-target == talloced) {\
222 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
223 t = target+talloced;\
230 if (dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS) {
238 char *fmtstr,*x,*lastf;
249 case '1':case '2':case '3':case '4':case '5':
250 case '6':case '7':case '8':case '9':
253 case '0':case '1':case '2':case '3':
254 case '4':case '5':case '6':case '7':
257 insertnr=insertnr*10+*f-'0';
266 if (NULL!=(x=strchr(f,'!'))) {
268 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
269 sprintf(fmtstr,"%%%s",f);
272 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
273 sprintf(fmtstr,"%%%s",f);
274 f+=strlen(f); /*at \0*/
278 fmtstr = HeapAlloc(GetProcessHeap(),0,3);
279 strcpy( fmtstr, "%s" );
285 if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
286 argliststart=args+insertnr-1;
288 argliststart=(*(DWORD**)args)+insertnr-1;
290 /* FIXME: precision and width components are not handled correctly */
291 if ( (strcmp(fmtstr, "%ls") == 0) || (strcmp(fmtstr,"%S") == 0) ) {
292 sz = WideCharToMultiByte( CP_ACP, 0, *(WCHAR**)argliststart, -1, NULL, 0, NULL, NULL);
293 b = HeapAlloc(GetProcessHeap(), 0, sz);
294 WideCharToMultiByte( CP_ACP, 0, *(WCHAR**)argliststart, -1, b, sz, NULL, NULL);
296 b = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sz = 1000);
297 /* CMF - This makes a BIG assumption about va_list */
298 TRACE("A BIG assumption\n");
299 vsnprintf(b, sz, fmtstr, (va_list) argliststart);
301 for (x=b; *x; x++) ADD_TO_T(*x);
303 HeapFree(GetProcessHeap(),0,b);
305 /* NULL args - copy formatstr
308 while ((lastf<f)&&(*lastf)) {
312 HeapFree(GetProcessHeap(),0,fmtstr);
359 talloced = strlen(target)+1;
360 if (nSize && talloced<nSize) {
361 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize);
363 TRACE("-- %s\n",debugstr_a(target));
364 if (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) {
365 *((LPVOID*)lpBuffer) = (LPVOID)LocalAlloc(GMEM_ZEROINIT,max(nSize, talloced));
366 memcpy(*(LPSTR*)lpBuffer,target,talloced);
368 lstrcpynA(lpBuffer,target,nSize);
370 HeapFree(GetProcessHeap(),0,target);
371 if (from) HeapFree(GetProcessHeap(),0,from);
372 TRACE("-- returning %d\n", (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ? strlen(*(LPSTR*)lpBuffer):strlen(lpBuffer));
373 return (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
374 strlen(*(LPSTR*)lpBuffer):
378 #endif /* __i386__ */
383 /***********************************************************************
384 * FormatMessageW (KERNEL32.@)
386 DWORD WINAPI FormatMessageW(
395 LPDWORD args=(LPDWORD)_args;
396 #if defined(__i386__) || defined(__sparc__)
397 /* This implementation is completely dependant on the format of the va_list on x86 CPUs */
401 DWORD width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
404 HMODULE hmodule = (HMODULE)lpSource;
407 TRACE("(0x%lx,%p,%ld,0x%lx,%p,%ld,%p)\n",
408 dwFlags,lpSource,dwMessageId,dwLanguageId,lpBuffer,nSize,args);
409 if ((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
410 && (dwFlags & FORMAT_MESSAGE_FROM_HMODULE)) return 0;
411 if ((dwFlags & FORMAT_MESSAGE_FROM_STRING)
412 &&((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
413 || (dwFlags & FORMAT_MESSAGE_FROM_HMODULE))) return 0;
415 if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
416 FIXME("line wrapping not supported.\n");
418 if (dwFlags & FORMAT_MESSAGE_FROM_STRING) {
419 from = HEAP_strdupWtoA(GetProcessHeap(),0,(LPWSTR)lpSource);
422 if (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
423 hmodule = GetModuleHandleA("kernel32");
424 bufsize=load_messageA(hmodule,dwMessageId,dwLanguageId,NULL,100);
427 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
430 bufsize=load_messageA(hmodule,dwMessageId,
431 MAKELANGID(LANG_NEUTRAL,SUBLANG_NEUTRAL),NULL,100);
432 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
433 MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),NULL,100);
434 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
435 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
436 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
437 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
438 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
439 MAKELANGID(LANG_ENGLISH,SUBLANG_ENGLISH_US),NULL,100);
441 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
445 from = HeapAlloc( GetProcessHeap(), 0, bufsize + 1 );
446 load_messageA(hmodule,dwMessageId,dwLanguageId,from,bufsize+1);
448 target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100 );
452 #define ADD_TO_T(c) do {\
454 if (t-target == talloced) {\
455 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
456 t = target+talloced;\
463 if (dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS) {
471 char *fmtstr,*sprintfbuf,*x;
482 case '1':case '2':case '3':case '4':case '5':
483 case '6':case '7':case '8':case '9':
486 case '0':case '1':case '2':case '3':
487 case '4':case '5':case '6':case '7':
490 insertnr=insertnr*10+*f-'0';
499 if (NULL!=(x=strchr(f,'!'))) {
501 fmtstr=HeapAlloc( GetProcessHeap(), 0, strlen(f)+2);
502 sprintf(fmtstr,"%%%s",f);
505 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f));
506 sprintf(fmtstr,"%%%s",f);
507 f+=strlen(f); /*at \0*/
511 fmtstr = HeapAlloc( GetProcessHeap(),0,3);
512 strcpy( fmtstr, "%s" );
514 if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
515 argliststart=args+insertnr-1;
517 argliststart=(*(DWORD**)args)+insertnr-1;
519 if (fmtstr[strlen(fmtstr)-1]=='s' && argliststart[0]) {
522 xarr[0]=(DWORD)HEAP_strdupWtoA(GetProcessHeap(),0,(LPWSTR)(*(argliststart+0)));
523 /* possible invalid pointers */
524 xarr[1]=*(argliststart+1);
525 xarr[2]=*(argliststart+2);
526 sprintfbuf=HeapAlloc(GetProcessHeap(),0,strlenW((LPWSTR)argliststart[0])*2+1);
528 /* CMF - This makes a BIG assumption about va_list */
529 vsprintf(sprintfbuf, fmtstr, (va_list) xarr);
530 HeapFree(GetProcessHeap(), 0, (LPVOID) xarr[0]);
532 sprintfbuf=HeapAlloc(GetProcessHeap(),0,100);
534 /* CMF - This makes a BIG assumption about va_list */
535 vsprintf(sprintfbuf, fmtstr, (va_list) argliststart);
541 HeapFree(GetProcessHeap(),0,sprintfbuf);
542 HeapFree(GetProcessHeap(),0,fmtstr);
589 talloced = strlen(target)+1;
590 if (nSize && talloced<nSize)
591 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize);
592 if (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) {
593 /* nSize is the MINIMUM size */
594 DWORD len = MultiByteToWideChar( CP_ACP, 0, target, -1, NULL, 0 );
595 *((LPVOID*)lpBuffer) = (LPVOID)LocalAlloc(GMEM_ZEROINIT,len*sizeof(WCHAR));
596 MultiByteToWideChar( CP_ACP, 0, target, -1, *(LPWSTR*)lpBuffer, len );
600 if (nSize > 0 && !MultiByteToWideChar( CP_ACP, 0, target, -1, lpBuffer, nSize ))
601 lpBuffer[nSize-1] = 0;
603 HeapFree(GetProcessHeap(),0,target);
604 if (from) HeapFree(GetProcessHeap(),0,from);
605 return (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
606 strlenW(*(LPWSTR*)lpBuffer):
610 #endif /* __i386__ */