2 * FormatMessage implementation
4 * Copyright 1996 Marcus Meissner
16 #include "wine/unicode.h"
19 #include "debugtools.h"
21 DEFAULT_DEBUG_CHANNEL(resource);
24 /* Messages...used by FormatMessage32* (KERNEL32.something)
26 * They can be specified either directly or using a message ID and
27 * loading them from the resource.
29 * The resourcedata has following format:
31 * 0: DWORD nrofentries
32 * nrofentries * subentry:
35 * 8: DWORD offset from start to the stringentries
37 * (lastentry-firstentry) * stringentry:
38 * 0: WORD len (0 marks end) [ includes the 4 byte header length ]
41 * (stringentry i of a subentry refers to the ID 'firstentry+i')
43 * Yes, ANSI strings in win32 resources. Go figure.
46 /**********************************************************************
47 * load_messageA (internal)
49 static INT load_messageA( HMODULE instance, UINT id, WORD lang,
50 LPSTR buffer, INT buflen )
54 PMESSAGE_RESOURCE_DATA mrd;
55 PMESSAGE_RESOURCE_BLOCK mrb;
56 PMESSAGE_RESOURCE_ENTRY mre;
59 TRACE("instance = %08lx, id = %08lx, buffer = %p, length = %ld\n", (DWORD)instance, (DWORD)id, buffer, (DWORD)buflen);
61 /*FIXME: I am not sure about the '1' ... But I've only seen those entries*/
62 hrsrc = FindResourceExW(instance,RT_MESSAGELISTW,(LPWSTR)1,lang);
64 hmem = LoadResource( instance, hrsrc );
67 mrd = (PMESSAGE_RESOURCE_DATA)LockResource(hmem);
69 mrb = &(mrd->Blocks[0]);
70 for (i=mrd->NumberOfBlocks;i--;) {
71 if ((id>=mrb->LowId) && (id<=mrb->HighId)) {
72 mre = (PMESSAGE_RESOURCE_ENTRY)(((char*)mrd)+mrb->OffsetToEntries);
83 mre = (PMESSAGE_RESOURCE_ENTRY)(((char*)mre)+mre->Length);
86 TRACE(" - strlen=%d\n",slen);
87 i = min(buflen - 1, slen);
91 if (mre->Flags & MESSAGE_RESOURCE_UNICODE)
92 WideCharToMultiByte( CP_ACP, 0, (LPWSTR)mre->Text, -1, buffer, i, NULL, NULL );
94 lstrcpynA(buffer, (LPSTR)mre->Text, i);
103 TRACE("'%s' copied !\n", buffer);
108 /**********************************************************************
109 * load_messageW (internal)
111 static INT load_messageW( HMODULE instance, UINT id, WORD lang,
112 LPWSTR buffer, INT buflen )
115 LPSTR buffer2 = NULL;
116 if (buffer && buflen)
117 buffer2 = HeapAlloc( GetProcessHeap(), 0, buflen );
118 retval = load_messageA(instance,id,lang,buffer2,buflen);
122 lstrcpynAtoW( buffer, buffer2, buflen );
123 retval = strlenW( buffer );
125 HeapFree( GetProcessHeap(), 0, buffer2 );
132 /***********************************************************************
133 * FormatMessageA (KERNEL32.138)
134 * FIXME: missing wrap,
136 DWORD WINAPI FormatMessageA(
145 LPDWORD args=(LPDWORD)_args;
147 /* This implementation is completely dependant on the format of the va_list on x86 CPUs */
151 DWORD width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
154 HMODULE hmodule = (HMODULE)lpSource;
157 TRACE("(0x%lx,%p,%ld,0x%lx,%p,%ld,%p)\n",
158 dwFlags,lpSource,dwMessageId,dwLanguageId,lpBuffer,nSize,args);
159 if ((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
160 && (dwFlags & FORMAT_MESSAGE_FROM_HMODULE)) return 0;
161 if ((dwFlags & FORMAT_MESSAGE_FROM_STRING)
162 &&((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
163 || (dwFlags & FORMAT_MESSAGE_FROM_HMODULE))) return 0;
165 if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
166 FIXME("line wrapping (%lu) not supported.\n", width);
168 if (dwFlags & FORMAT_MESSAGE_FROM_STRING) {
169 from = HEAP_strdupA( GetProcessHeap(), 0, (LPSTR)lpSource);
172 if (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
173 hmodule = GetModuleHandleA("kernel32");
174 bufsize=load_messageA(hmodule,dwMessageId,dwLanguageId,NULL,100);
177 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
180 bufsize=load_messageA(hmodule,dwMessageId,
181 MAKELANGID(LANG_NEUTRAL,SUBLANG_NEUTRAL),NULL,100);
182 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
183 MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),NULL,100);
184 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
185 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
186 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
187 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
188 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
189 MAKELANGID(LANG_ENGLISH,SUBLANG_ENGLISH_US),NULL,100);
191 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
195 from = HeapAlloc( GetProcessHeap(), 0, bufsize + 1 );
196 load_messageA(hmodule,dwMessageId,dwLanguageId,from,bufsize+1);
198 target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100);
202 #define ADD_TO_T(c) do { \
204 if (t-target == talloced) {\
205 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
206 t = target+talloced;\
216 char *fmtstr,*x,*lastf;
227 case '1':case '2':case '3':case '4':case '5':
228 case '6':case '7':case '8':case '9':
231 case '0':case '1':case '2':case '3':
232 case '4':case '5':case '6':case '7':
235 insertnr=insertnr*10+*f-'0';
244 if (NULL!=(x=strchr(f,'!'))) {
246 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
248 if (!strcmp(f,"ls")) f++;
249 sprintf(fmtstr,"%%%s",f);
252 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
253 if (!strcmp(f,"ls")) f++;
254 sprintf(fmtstr,"%%%s",f);
255 f+=strlen(f); /*at \0*/
261 fmtstr=HEAP_strdupA(GetProcessHeap(),0,"%s");
264 LPSTR b = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sz = 100);
266 if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
267 argliststart=args+insertnr-1;
269 argliststart=(*(DWORD**)args)+insertnr-1;
271 /* CMF - This makes a BIG assumption about va_list */
272 while (vsnprintf(b, sz, fmtstr, (va_list) argliststart) < 0) {
273 b = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, b, sz += 100);
275 for (x=b; *x; x++) ADD_TO_T(*x);
277 HeapFree(GetProcessHeap(),0,b);
279 /* NULL args - copy formatstr
282 while ((lastf<f)&&(*lastf)) {
286 HeapFree(GetProcessHeap(),0,fmtstr);
322 talloced = strlen(target)+1;
323 if (nSize && talloced<nSize) {
324 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize);
326 TRACE("-- %s\n",debugstr_a(target));
327 if (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) {
328 *((LPVOID*)lpBuffer) = (LPVOID)LocalAlloc(GMEM_ZEROINIT,max(nSize, talloced));
329 memcpy(*(LPSTR*)lpBuffer,target,talloced);
331 lstrcpynA(lpBuffer,target,nSize);
333 HeapFree(GetProcessHeap(),0,target);
334 if (from) HeapFree(GetProcessHeap(),0,from);
335 TRACE("-- returning %d\n", (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ? strlen(*(LPSTR*)lpBuffer):strlen(lpBuffer));
336 return (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
337 strlen(*(LPSTR*)lpBuffer):
341 #endif /* __i386__ */
346 /***********************************************************************
347 * FormatMessageW (KERNEL32.138)
349 DWORD WINAPI FormatMessageW(
358 LPDWORD args=(LPDWORD)_args;
360 /* This implementation is completely dependant on the format of the va_list on x86 CPUs */
364 DWORD width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
367 HMODULE hmodule = (HMODULE)lpSource;
370 TRACE("(0x%lx,%p,%ld,0x%lx,%p,%ld,%p)\n",
371 dwFlags,lpSource,dwMessageId,dwLanguageId,lpBuffer,nSize,args);
372 if ((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
373 && (dwFlags & FORMAT_MESSAGE_FROM_HMODULE)) return 0;
374 if ((dwFlags & FORMAT_MESSAGE_FROM_STRING)
375 &&((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
376 || (dwFlags & FORMAT_MESSAGE_FROM_HMODULE))) return 0;
378 if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
379 FIXME("line wrapping not supported.\n");
381 if (dwFlags & FORMAT_MESSAGE_FROM_STRING) {
382 from = HEAP_strdupWtoA(GetProcessHeap(),0,(LPWSTR)lpSource);
385 if (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
386 hmodule = GetModuleHandleA("kernel32");
387 bufsize=load_messageA(hmodule,dwMessageId,dwLanguageId,NULL,100);
390 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
393 bufsize=load_messageA(hmodule,dwMessageId,
394 MAKELANGID(LANG_NEUTRAL,SUBLANG_NEUTRAL),NULL,100);
395 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
396 MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),NULL,100);
397 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
398 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
399 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
400 MAKELANGID(LANG_NEUTRAL,SUBLANG_SYS_DEFAULT),NULL,100);
401 if (!bufsize) bufsize=load_messageA(hmodule,dwMessageId,
402 MAKELANGID(LANG_ENGLISH,SUBLANG_ENGLISH_US),NULL,100);
404 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
408 from = HeapAlloc( GetProcessHeap(), 0, bufsize + 1 );
409 load_messageA(hmodule,dwMessageId,dwLanguageId,from,bufsize+1);
411 target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100 );
415 #define ADD_TO_T(c) do {\
417 if (t-target == talloced) {\
418 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
419 t = target+talloced;\
429 char *fmtstr,*sprintfbuf,*x;
439 case '1':case '2':case '3':case '4':case '5':
440 case '6':case '7':case '8':case '9':
443 case '0':case '1':case '2':case '3':
444 case '4':case '5':case '6':case '7':
447 insertnr=insertnr*10+*f-'0';
456 if (NULL!=(x=strchr(f,'!')))
459 fmtstr=HeapAlloc( GetProcessHeap(), 0, strlen(f)+2);
460 sprintf(fmtstr,"%%%s",f);
463 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f));
464 sprintf(fmtstr,"%%%s",f);
465 f+=strlen(f); /*at \0*/
471 fmtstr=HEAP_strdupA( GetProcessHeap(),0,"%s");
472 if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
473 argliststart=args+insertnr-1;
475 argliststart=(*(DWORD**)args)+insertnr-1;
477 if (fmtstr[strlen(fmtstr)-1]=='s' && argliststart[0]) {
480 xarr[0]=(DWORD)HEAP_strdupWtoA(GetProcessHeap(),0,(LPWSTR)(*(argliststart+0)));
481 /* possible invalid pointers */
482 xarr[1]=*(argliststart+1);
483 xarr[2]=*(argliststart+2);
484 sprintfbuf=HeapAlloc(GetProcessHeap(),0,strlenW((LPWSTR)argliststart[0])*2+1);
486 /* CMF - This makes a BIG assumption about va_list */
487 vsprintf(sprintfbuf, fmtstr, (va_list) xarr);
489 sprintfbuf=HeapAlloc(GetProcessHeap(),0,100);
491 /* CMF - This makes a BIG assumption about va_list */
492 vsprintf(sprintfbuf, fmtstr, (va_list) argliststart);
498 HeapFree(GetProcessHeap(),0,sprintfbuf);
499 HeapFree(GetProcessHeap(),0,fmtstr);
535 talloced = strlen(target)+1;
536 if (nSize && talloced<nSize)
537 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize);
538 if (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) {
539 /* nSize is the MINIMUM size */
540 DWORD len = MultiByteToWideChar( CP_ACP, 0, target, -1, NULL, 0 );
541 *((LPVOID*)lpBuffer) = (LPVOID)LocalAlloc(GMEM_ZEROINIT,len*sizeof(WCHAR));
542 MultiByteToWideChar( CP_ACP, 0, target, -1, *(LPWSTR*)lpBuffer, len );
546 if (nSize > 0 && !MultiByteToWideChar( CP_ACP, 0, target, -1, lpBuffer, nSize ))
547 lpBuffer[nSize-1] = 0;
549 HeapFree(GetProcessHeap(),0,target);
550 if (from) HeapFree(GetProcessHeap(),0,from);
551 return (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
552 strlenW(*(LPWSTR*)lpBuffer):
556 #endif /* __i386__ */