2 * FormatMessage implementation
4 * Copyright 1996 Marcus Meissner
17 #include "wine/unicode.h"
20 #include "debugtools.h"
22 DEFAULT_DEBUG_CHANNEL(resource);
25 /* Messages...used by FormatMessage32* (KERNEL32.something)
27 * They can be specified either directly or using a message ID and
28 * loading them from the resource.
30 * The resourcedata has following format:
32 * 0: DWORD nrofentries
33 * nrofentries * subentry:
36 * 8: DWORD offset from start to the stringentries
38 * (lastentry-firstentry) * stringentry:
39 * 0: WORD len (0 marks end) [ includes the 4 byte header length ]
42 * (stringentry i of a subentry refers to the ID 'firstentry+i')
44 * Yes, ANSI strings in win32 resources. Go figure.
47 /**********************************************************************
48 * load_messageA (internal)
50 static INT load_messageA( HMODULE instance, UINT id, WORD lang,
51 LPSTR buffer, INT buflen )
55 PMESSAGE_RESOURCE_DATA mrd;
56 PMESSAGE_RESOURCE_BLOCK mrb;
57 PMESSAGE_RESOURCE_ENTRY mre;
60 TRACE("instance = %08lx, id = %08lx, buffer = %p, length = %ld\n", (DWORD)instance, (DWORD)id, buffer, (DWORD)buflen);
62 /*FIXME: I am not sure about the '1' ... But I've only seen those entries*/
63 hrsrc = FindResourceExW(instance,RT_MESSAGETABLEW,(LPWSTR)1,lang);
65 hmem = LoadResource( instance, hrsrc );
68 mrd = (PMESSAGE_RESOURCE_DATA)LockResource(hmem);
70 mrb = &(mrd->Blocks[0]);
71 for (i=mrd->NumberOfBlocks;i--;) {
72 if ((id>=mrb->LowId) && (id<=mrb->HighId)) {
73 mre = (PMESSAGE_RESOURCE_ENTRY)(((char*)mrd)+mrb->OffsetToEntries);
84 mre = (PMESSAGE_RESOURCE_ENTRY)(((char*)mre)+mre->Length);
87 TRACE(" - strlen=%d\n",slen);
88 i = min(buflen - 1, slen);
92 if (mre->Flags & MESSAGE_RESOURCE_UNICODE)
93 WideCharToMultiByte( CP_ACP, 0, (LPWSTR)mre->Text, -1, buffer, i, NULL, NULL );
95 lstrcpynA(buffer, (LPSTR)mre->Text, i);
104 TRACE("'%s' copied !\n", buffer);
109 /**********************************************************************
110 * load_messageW (internal)
112 static INT load_messageW( HMODULE instance, UINT id, WORD lang,
113 LPWSTR buffer, INT buflen )
116 LPSTR buffer2 = NULL;
117 if (buffer && buflen)
118 buffer2 = HeapAlloc( GetProcessHeap(), 0, buflen );
119 retval = load_messageA(instance,id,lang,buffer2,buflen);
123 lstrcpynAtoW( buffer, buffer2, buflen );
124 retval = strlenW( buffer );
126 HeapFree( GetProcessHeap(), 0, buffer2 );
133 /***********************************************************************
134 * FormatMessageA (KERNEL32.@)
135 * FIXME: missing wrap,
137 DWORD WINAPI FormatMessageA(
146 LPDWORD args=(LPDWORD)_args;
148 /* This implementation is completely dependant on the format of the va_list on x86 CPUs */
152 DWORD width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
155 HMODULE hmodule = (HMODULE)lpSource;
158 TRACE("(0x%lx,%p,%ld,0x%lx,%p,%ld,%p)\n",
159 dwFlags,lpSource,dwMessageId,dwLanguageId,lpBuffer,nSize,args);
160 if ((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
161 && (dwFlags & FORMAT_MESSAGE_FROM_HMODULE)) return 0;
162 if ((dwFlags & FORMAT_MESSAGE_FROM_STRING)
163 &&((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
164 || (dwFlags & FORMAT_MESSAGE_FROM_HMODULE))) return 0;
166 if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
167 FIXME("line wrapping (%lu) not supported.\n", width);
169 if (dwFlags & FORMAT_MESSAGE_FROM_STRING)
171 from = HeapAlloc( GetProcessHeap(), 0, strlen((LPSTR)lpSource)+1 );
172 strcpy( from, (LPSTR)lpSource );
175 if (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
176 hmodule = GetModuleHandleA("kernel32");
177 bufsize=load_messageA(hmodule,dwMessageId,dwLanguageId,NULL,100);
180 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
183 bufsize=load_messageA(hmodule,dwMessageId,
184 MAKELANGID(LANG_NEUTRAL,SUBLANG_NEUTRAL),NULL,100);
185 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
186 MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),NULL,100);
187 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
188 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
189 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
190 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
191 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
192 MAKELANGID(LANG_ENGLISH,SUBLANG_ENGLISH_US),NULL,100);
194 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
198 from = HeapAlloc( GetProcessHeap(), 0, bufsize + 1 );
199 load_messageA(hmodule,dwMessageId,dwLanguageId,from,bufsize+1);
201 target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100);
205 #define ADD_TO_T(c) do { \
207 if (t-target == talloced) {\
208 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
209 t = target+talloced;\
216 if (dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS) {
224 char *fmtstr,*x,*lastf;
235 case '1':case '2':case '3':case '4':case '5':
236 case '6':case '7':case '8':case '9':
239 case '0':case '1':case '2':case '3':
240 case '4':case '5':case '6':case '7':
243 insertnr=insertnr*10+*f-'0';
252 if (NULL!=(x=strchr(f,'!'))) {
254 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
255 sprintf(fmtstr,"%%%s",f);
258 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
259 sprintf(fmtstr,"%%%s",f);
260 f+=strlen(f); /*at \0*/
264 fmtstr = HeapAlloc(GetProcessHeap(),0,3);
265 strcpy( fmtstr, "%s" );
271 if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
272 argliststart=args+insertnr-1;
274 argliststart=(*(DWORD**)args)+insertnr-1;
276 /* FIXME: precision and width components are not handled correctly */
277 if (strcmp(fmtstr, "%ls") == 0) {
278 sz = WideCharToMultiByte( CP_ACP, 0, *(WCHAR**)argliststart, -1, NULL, 0, NULL, NULL);
279 b = HeapAlloc(GetProcessHeap(), 0, sz);
280 WideCharToMultiByte( CP_ACP, 0, *(WCHAR**)argliststart, -1, b, sz, NULL, NULL);
282 b = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sz = 100);
283 /* CMF - This makes a BIG assumption about va_list */
284 TRACE("A BIG assumption\n");
285 while (vsnprintf(b, sz, fmtstr, (va_list) argliststart) < 0) {
286 b = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, b, sz += 100);
289 for (x=b; *x; x++) ADD_TO_T(*x);
291 HeapFree(GetProcessHeap(),0,b);
293 /* NULL args - copy formatstr
296 while ((lastf<f)&&(*lastf)) {
300 HeapFree(GetProcessHeap(),0,fmtstr);
336 talloced = strlen(target)+1;
337 if (nSize && talloced<nSize) {
338 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize);
340 TRACE("-- %s\n",debugstr_a(target));
341 if (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) {
342 *((LPVOID*)lpBuffer) = (LPVOID)LocalAlloc(GMEM_ZEROINIT,max(nSize, talloced));
343 memcpy(*(LPSTR*)lpBuffer,target,talloced);
345 lstrcpynA(lpBuffer,target,nSize);
347 HeapFree(GetProcessHeap(),0,target);
348 if (from) HeapFree(GetProcessHeap(),0,from);
349 TRACE("-- returning %d\n", (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ? strlen(*(LPSTR*)lpBuffer):strlen(lpBuffer));
350 return (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
351 strlen(*(LPSTR*)lpBuffer):
355 #endif /* __i386__ */
360 /***********************************************************************
361 * FormatMessageW (KERNEL32.@)
363 DWORD WINAPI FormatMessageW(
372 LPDWORD args=(LPDWORD)_args;
374 /* This implementation is completely dependant on the format of the va_list on x86 CPUs */
378 DWORD width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
381 HMODULE hmodule = (HMODULE)lpSource;
384 TRACE("(0x%lx,%p,%ld,0x%lx,%p,%ld,%p)\n",
385 dwFlags,lpSource,dwMessageId,dwLanguageId,lpBuffer,nSize,args);
386 if ((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
387 && (dwFlags & FORMAT_MESSAGE_FROM_HMODULE)) return 0;
388 if ((dwFlags & FORMAT_MESSAGE_FROM_STRING)
389 &&((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
390 || (dwFlags & FORMAT_MESSAGE_FROM_HMODULE))) return 0;
392 if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
393 FIXME("line wrapping not supported.\n");
395 if (dwFlags & FORMAT_MESSAGE_FROM_STRING) {
396 from = HEAP_strdupWtoA(GetProcessHeap(),0,(LPWSTR)lpSource);
399 if (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
400 hmodule = GetModuleHandleA("kernel32");
401 bufsize=load_messageA(hmodule,dwMessageId,dwLanguageId,NULL,100);
404 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
407 bufsize=load_messageA(hmodule,dwMessageId,
408 MAKELANGID(LANG_NEUTRAL,SUBLANG_NEUTRAL),NULL,100);
409 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
410 MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),NULL,100);
411 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
412 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
413 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
414 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
415 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
416 MAKELANGID(LANG_ENGLISH,SUBLANG_ENGLISH_US),NULL,100);
418 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
422 from = HeapAlloc( GetProcessHeap(), 0, bufsize + 1 );
423 load_messageA(hmodule,dwMessageId,dwLanguageId,from,bufsize+1);
425 target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100 );
429 #define ADD_TO_T(c) do {\
431 if (t-target == talloced) {\
432 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
433 t = target+talloced;\
440 if (dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS) {
448 char *fmtstr,*sprintfbuf,*x;
459 case '1':case '2':case '3':case '4':case '5':
460 case '6':case '7':case '8':case '9':
463 case '0':case '1':case '2':case '3':
464 case '4':case '5':case '6':case '7':
467 insertnr=insertnr*10+*f-'0';
476 if (NULL!=(x=strchr(f,'!'))) {
478 fmtstr=HeapAlloc( GetProcessHeap(), 0, strlen(f)+2);
479 sprintf(fmtstr,"%%%s",f);
482 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f));
483 sprintf(fmtstr,"%%%s",f);
484 f+=strlen(f); /*at \0*/
488 fmtstr = HeapAlloc( GetProcessHeap(),0,3);
489 strcpy( fmtstr, "%s" );
491 if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
492 argliststart=args+insertnr-1;
494 argliststart=(*(DWORD**)args)+insertnr-1;
496 if (fmtstr[strlen(fmtstr)-1]=='s' && argliststart[0]) {
499 xarr[0]=(DWORD)HEAP_strdupWtoA(GetProcessHeap(),0,(LPWSTR)(*(argliststart+0)));
500 /* possible invalid pointers */
501 xarr[1]=*(argliststart+1);
502 xarr[2]=*(argliststart+2);
503 sprintfbuf=HeapAlloc(GetProcessHeap(),0,strlenW((LPWSTR)argliststart[0])*2+1);
505 /* CMF - This makes a BIG assumption about va_list */
506 vsprintf(sprintfbuf, fmtstr, (va_list) xarr);
508 sprintfbuf=HeapAlloc(GetProcessHeap(),0,100);
510 /* CMF - This makes a BIG assumption about va_list */
511 vsprintf(sprintfbuf, fmtstr, (va_list) argliststart);
517 HeapFree(GetProcessHeap(),0,sprintfbuf);
518 HeapFree(GetProcessHeap(),0,fmtstr);
554 talloced = strlen(target)+1;
555 if (nSize && talloced<nSize)
556 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize);
557 if (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) {
558 /* nSize is the MINIMUM size */
559 DWORD len = MultiByteToWideChar( CP_ACP, 0, target, -1, NULL, 0 );
560 *((LPVOID*)lpBuffer) = (LPVOID)LocalAlloc(GMEM_ZEROINIT,len*sizeof(WCHAR));
561 MultiByteToWideChar( CP_ACP, 0, target, -1, *(LPWSTR*)lpBuffer, len );
565 if (nSize > 0 && !MultiByteToWideChar( CP_ACP, 0, target, -1, lpBuffer, nSize ))
566 lpBuffer[nSize-1] = 0;
568 HeapFree(GetProcessHeap(),0,target);
569 if (from) HeapFree(GetProcessHeap(),0,from);
570 return (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
571 strlenW(*(LPWSTR*)lpBuffer):
575 #endif /* __i386__ */