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
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 (KERNEL32.something)
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, mre
->Text
, -1, NULL
, 0 );
89 if (!(buffer
= HeapAlloc( GetProcessHeap(), 0, len
* sizeof(WCHAR
) ))) return NULL
;
90 MultiByteToWideChar( CP_ACP
, 0, 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(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(
140 LPDWORD args
=(LPDWORD
)_args
;
141 #if defined(__i386__) || defined(__sparc__)
142 /* This implementation is completely dependent on the format of the va_list on x86 CPUs */
146 DWORD width
= dwFlags
& FORMAT_MESSAGE_MAX_WIDTH_MASK
;
150 TRACE("(0x%lx,%p,%ld,0x%lx,%p,%ld,%p)\n",
151 dwFlags
,lpSource
,dwMessageId
,dwLanguageId
,lpBuffer
,nSize
,args
);
152 if ((dwFlags
& FORMAT_MESSAGE_FROM_STRING
)
153 &&((dwFlags
& FORMAT_MESSAGE_FROM_SYSTEM
)
154 || (dwFlags
& FORMAT_MESSAGE_FROM_HMODULE
))) return 0;
156 if (width
&& width
!= FORMAT_MESSAGE_MAX_WIDTH_MASK
)
157 FIXME("line wrapping (%lu) not supported.\n", width
);
159 if (dwFlags
& FORMAT_MESSAGE_FROM_STRING
)
161 from
= HeapAlloc( GetProcessHeap(), 0, strlen((LPCSTR
)lpSource
)+1 );
162 strcpy( from
, (LPCSTR
)lpSource
);
166 if (dwFlags
& FORMAT_MESSAGE_FROM_HMODULE
)
167 from
= load_messageA( (HMODULE
)lpSource
, dwMessageId
, dwLanguageId
);
168 if (!from
&& (dwFlags
& FORMAT_MESSAGE_FROM_SYSTEM
))
169 from
= load_messageA( kernel32_handle
, dwMessageId
, dwLanguageId
);
173 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND
);
177 target
= HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY
, 100);
181 #define ADD_TO_T(c) do { \
183 if (t-target == talloced) {\
184 target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
185 t = target+talloced;\
192 if (dwFlags
& FORMAT_MESSAGE_IGNORE_INSERTS
) {
200 char *fmtstr
,*x
,*lastf
;
211 case '1':case '2':case '3':case '4':case '5':
212 case '6':case '7':case '8':case '9':
215 case '0':case '1':case '2':case '3':
216 case '4':case '5':case '6':case '7':
219 insertnr
=insertnr
*10+*f
-'0';
228 if (NULL
!=(x
=strchr(f
,'!'))) {
230 fmtstr
=HeapAlloc(GetProcessHeap(),0,strlen(f
)+2);
231 sprintf(fmtstr
,"%%%s",f
);
234 fmtstr
=HeapAlloc(GetProcessHeap(),0,strlen(f
)+2);
235 sprintf(fmtstr
,"%%%s",f
);
236 f
+=strlen(f
); /*at \0*/
240 fmtstr
= HeapAlloc(GetProcessHeap(),0,3);
241 strcpy( fmtstr
, "%s" );
247 if (dwFlags
& FORMAT_MESSAGE_ARGUMENT_ARRAY
)
248 argliststart
=args
+insertnr
-1;
250 argliststart
=(*(DWORD
**)args
)+insertnr
-1;
252 /* FIXME: precision and width components are not handled correctly */
253 if ( (strcmp(fmtstr
, "%ls") == 0) || (strcmp(fmtstr
,"%S") == 0) ) {
254 sz
= WideCharToMultiByte( CP_ACP
, 0, *(WCHAR
**)argliststart
, -1, NULL
, 0, NULL
, NULL
);
255 b
= HeapAlloc(GetProcessHeap(), 0, sz
);
256 WideCharToMultiByte( CP_ACP
, 0, *(WCHAR
**)argliststart
, -1, b
, sz
, NULL
, NULL
);
258 b
= HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
, sz
= 1000);
259 /* CMF - This makes a BIG assumption about va_list */
260 TRACE("A BIG assumption\n");
261 vsnprintf(b
, sz
, fmtstr
, (va_list) argliststart
);
263 for (x
=b
; *x
; x
++) ADD_TO_T(*x
);
265 HeapFree(GetProcessHeap(),0,b
);
267 /* NULL args - copy formatstr
270 while ((lastf
<f
)&&(*lastf
)) {
274 HeapFree(GetProcessHeap(),0,fmtstr
);
321 talloced
= strlen(target
)+1;
322 if (nSize
&& talloced
<nSize
) {
323 target
= (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY
,target
,nSize
);
325 TRACE("-- %s\n",debugstr_a(target
));
326 if (dwFlags
& FORMAT_MESSAGE_ALLOCATE_BUFFER
) {
327 *((LPVOID
*)lpBuffer
) = (LPVOID
)LocalAlloc(GMEM_ZEROINIT
,max(nSize
, talloced
));
328 memcpy(*(LPSTR
*)lpBuffer
,target
,talloced
);
330 lstrcpynA(lpBuffer
,target
,nSize
);
332 HeapFree(GetProcessHeap(),0,target
);
333 HeapFree(GetProcessHeap(),0,from
);
334 TRACE("-- returning %d\n", (dwFlags
& FORMAT_MESSAGE_ALLOCATE_BUFFER
) ? strlen(*(LPSTR
*)lpBuffer
):strlen(lpBuffer
));
335 return (dwFlags
& FORMAT_MESSAGE_ALLOCATE_BUFFER
) ?
336 strlen(*(LPSTR
*)lpBuffer
):
340 #endif /* __i386__ */
345 /***********************************************************************
346 * FormatMessageW (KERNEL32.@)
348 DWORD WINAPI
FormatMessageW(
357 LPDWORD args
=(LPDWORD
)_args
;
358 #if defined(__i386__) || defined(__sparc__)
359 /* This implementation is completely dependent on the format of the va_list on x86 CPUs */
363 DWORD width
= dwFlags
& FORMAT_MESSAGE_MAX_WIDTH_MASK
;
367 TRACE("(0x%lx,%p,%ld,0x%lx,%p,%ld,%p)\n",
368 dwFlags
,lpSource
,dwMessageId
,dwLanguageId
,lpBuffer
,nSize
,args
);
369 if ((dwFlags
& FORMAT_MESSAGE_FROM_STRING
)
370 &&((dwFlags
& FORMAT_MESSAGE_FROM_SYSTEM
)
371 || (dwFlags
& FORMAT_MESSAGE_FROM_HMODULE
))) return 0;
373 if (width
&& width
!= FORMAT_MESSAGE_MAX_WIDTH_MASK
)
374 FIXME("line wrapping not supported.\n");
376 if (dwFlags
& FORMAT_MESSAGE_FROM_STRING
) {
377 from
= HeapAlloc( GetProcessHeap(), 0, (strlenW((LPCWSTR
)lpSource
) + 1) *
379 strcpyW( from
, (LPCWSTR
)lpSource
);
383 if (dwFlags
& FORMAT_MESSAGE_FROM_HMODULE
)
384 from
= load_messageW( (HMODULE
)lpSource
, dwMessageId
, dwLanguageId
);
385 if (!from
&& (dwFlags
& FORMAT_MESSAGE_FROM_SYSTEM
))
386 from
= load_messageW( kernel32_handle
, dwMessageId
, dwLanguageId
);
390 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND
);
394 target
= HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY
, 100 * sizeof(WCHAR
) );
398 #define ADD_TO_T(c) do {\
400 if (t-target == talloced) {\
401 target = (WCHAR*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2*sizeof(WCHAR));\
402 t = target+talloced;\
409 if (dwFlags
& FORMAT_MESSAGE_IGNORE_INSERTS
) {
417 WCHAR
*fmtstr
,*sprintfbuf
,*x
;
428 case '1':case '2':case '3':case '4':case '5':
429 case '6':case '7':case '8':case '9':
432 case '0':case '1':case '2':case '3':
433 case '4':case '5':case '6':case '7':
436 insertnr
=insertnr
*10+*f
-'0';
445 if (NULL
!=(x
=strchrW(f
,'!'))) {
447 fmtstr
=HeapAlloc( GetProcessHeap(), 0,(strlenW(f
)+2)*sizeof(WCHAR
));
448 sprintfW(fmtstr
,PCNTFMTWSTR
,f
);
451 fmtstr
=HeapAlloc(GetProcessHeap(),0,(strlenW(f
)+2)*sizeof(WCHAR
));
452 sprintfW(fmtstr
,PCNTFMTWSTR
,f
);
453 f
+=strlenW(f
); /*at \0*/
457 fmtstr
= HeapAlloc( GetProcessHeap(),0,3*sizeof(WCHAR
));
458 strcpyW( fmtstr
, FMTWSTR
);
460 if (dwFlags
& FORMAT_MESSAGE_ARGUMENT_ARRAY
)
461 argliststart
=args
+insertnr
-1;
463 argliststart
=(*(DWORD
**)args
)+insertnr
-1;
465 if (fmtstr
[strlenW(fmtstr
)-1]=='s' && argliststart
[0]) {
468 xarr
[0]=*(argliststart
+0);
469 /* possible invalid pointers */
470 xarr
[1]=*(argliststart
+1);
471 xarr
[2]=*(argliststart
+2);
472 sprintfbuf
=HeapAlloc(GetProcessHeap(),0,(strlenW((LPWSTR
)argliststart
[0])*2+1)*sizeof(WCHAR
));
474 /* CMF - This makes a BIG assumption about va_list */
475 vsprintfW(sprintfbuf
, fmtstr
, (va_list) xarr
);
477 sprintfbuf
=HeapAlloc(GetProcessHeap(),0,100);
479 /* CMF - This makes a BIG assumption about va_list */
480 vsprintfW(sprintfbuf
, fmtstr
, (va_list) argliststart
);
486 HeapFree(GetProcessHeap(),0,sprintfbuf
);
487 HeapFree(GetProcessHeap(),0,fmtstr
);
534 talloced
= strlenW(target
)+1;
535 if (nSize
&& talloced
<nSize
)
536 target
= (WCHAR
*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY
,target
,nSize
*sizeof(WCHAR
));
537 if (dwFlags
& FORMAT_MESSAGE_ALLOCATE_BUFFER
) {
538 /* nSize is the MINIMUM size */
539 DWORD len
= strlenW(target
) + 1;
540 *((LPVOID
*)lpBuffer
) = (LPVOID
)LocalAlloc(GMEM_ZEROINIT
,len
*sizeof(WCHAR
));
541 strcpyW(*(LPWSTR
*)lpBuffer
, target
);
543 else lstrcpynW(lpBuffer
, target
, nSize
);
545 HeapFree(GetProcessHeap(),0,target
);
546 HeapFree(GetProcessHeap(),0,from
);
547 TRACE("ret=%s\n", wine_dbgstr_w((dwFlags
& FORMAT_MESSAGE_ALLOCATE_BUFFER
) ?
548 *(LPWSTR
*)lpBuffer
: lpBuffer
));
549 return (dwFlags
& FORMAT_MESSAGE_ALLOCATE_BUFFER
) ?
550 strlenW(*(LPWSTR
*)lpBuffer
):
554 #endif /* __i386__ */