format_msg.c 19.6 KB
Newer Older
Dave Pickles's avatar
Dave Pickles committed
1 2 3 4
/*
 * FormatMessage implementation
 *
 * Copyright 1996 Marcus Meissner
5 6 7 8 9 10 11 12 13 14 15 16 17 18
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
Dave Pickles's avatar
Dave Pickles committed
19 20 21 22
 */

#include "config.h"

23
#include <stdarg.h>
Dave Pickles's avatar
Dave Pickles committed
24 25 26
#include <stdio.h>
#include <string.h>

27
#include "ntstatus.h"
Dave Pickles's avatar
Dave Pickles committed
28 29 30
#include "windef.h"
#include "winbase.h"
#include "winerror.h"
31
#include "winreg.h"
32
#include "winternl.h"
33
#include "winuser.h"
Dave Pickles's avatar
Dave Pickles committed
34
#include "winnls.h"
35
#include "wine/unicode.h"
36
#include "kernel_private.h"
37
#include "wine/debug.h"
Dave Pickles's avatar
Dave Pickles committed
38

39
WINE_DEFAULT_DEBUG_CHANNEL(resource);
Dave Pickles's avatar
Dave Pickles committed
40 41


42
/* Messages...used by FormatMessage (KERNEL32.something)
43
 *
Dave Pickles's avatar
Dave Pickles committed
44 45
 * They can be specified either directly or using a message ID and
 * loading them from the resource.
46
 *
Dave Pickles's avatar
Dave Pickles committed
47 48 49 50 51 52 53 54 55
 * The resourcedata has following format:
 * start:
 * 0: DWORD nrofentries
 * nrofentries * subentry:
 *	0: DWORD firstentry
 *	4: DWORD lastentry
 *      8: DWORD offset from start to the stringentries
 *
 * (lastentry-firstentry) * stringentry:
56
 * 0: WORD len (0 marks end)	[ includes the 4 byte header length ]
Dave Pickles's avatar
Dave Pickles committed
57 58 59 60 61 62 63
 * 2: WORD flags
 * 4: CHAR[len-4]
 * 	(stringentry i of a subentry refers to the ID 'firstentry+i')
 *
 * Yes, ANSI strings in win32 resources. Go figure.
 */

64 65
static const WCHAR PCNTFMTWSTR[] = { '%','%','%','s',0 };
static const WCHAR FMTWSTR[] = { '%','s',0 };
66

Dave Pickles's avatar
Dave Pickles committed
67
/**********************************************************************
68
 *	load_messageW		(internal)
Dave Pickles's avatar
Dave Pickles committed
69
 */
70
static LPWSTR load_messageW( HMODULE module, UINT id, WORD lang )
Dave Pickles's avatar
Dave Pickles committed
71
{
72
    const MESSAGE_RESOURCE_ENTRY *mre;
73
    WCHAR *buffer;
Dave Pickles's avatar
Dave Pickles committed
74

75
    TRACE("module = %p, id = %08x\n", module, id );
Dave Pickles's avatar
Dave Pickles committed
76

77 78
    if (!module) module = GetModuleHandleW( NULL );
    if (RtlFindMessage( module, RT_MESSAGETABLE, lang, id, &mre ) != STATUS_SUCCESS) return NULL;
79

80
    if (mre->Flags & MESSAGE_RESOURCE_UNICODE)
81 82 83 84 85
    {
        int len = (strlenW( (const WCHAR *)mre->Text ) + 1) * sizeof(WCHAR);
        if (!(buffer = HeapAlloc( GetProcessHeap(), 0, len ))) return NULL;
        memcpy( buffer, mre->Text, len );
    }
86
    else
87 88 89 90
    {
        int len = MultiByteToWideChar( CP_ACP, 0, mre->Text, -1, NULL, 0 );
        if (!(buffer = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) ))) return NULL;
        MultiByteToWideChar( CP_ACP, 0, mre->Text, -1, buffer, len );
Dave Pickles's avatar
Dave Pickles committed
91
    }
92 93
    TRACE("returning %s\n", wine_dbgstr_w(buffer));
    return buffer;
Dave Pickles's avatar
Dave Pickles committed
94 95
}

96

Dave Pickles's avatar
Dave Pickles committed
97
/**********************************************************************
98
 *	load_messageA		(internal)
Dave Pickles's avatar
Dave Pickles committed
99
 */
100
static LPSTR load_messageA( HMODULE module, UINT id, WORD lang )
Dave Pickles's avatar
Dave Pickles committed
101
{
102 103
    const MESSAGE_RESOURCE_ENTRY *mre;
    char *buffer;
104

105
    TRACE("module = %p, id = %08x\n", module, id );
106

107 108
    if (!module) module = GetModuleHandleW( NULL );
    if (RtlFindMessage( module, RT_MESSAGETABLE, lang, id, &mre ) != STATUS_SUCCESS) return NULL;
109

110
    if (mre->Flags & MESSAGE_RESOURCE_UNICODE)
Dave Pickles's avatar
Dave Pickles committed
111
    {
112 113 114 115 116 117 118 119 120 121 122 123
        int len = WideCharToMultiByte( CP_ACP, 0, (const WCHAR *)mre->Text, -1, NULL, 0, NULL, NULL );
        if (!(buffer = HeapAlloc( GetProcessHeap(), 0, len ))) return NULL;
        WideCharToMultiByte( CP_ACP, 0, (const WCHAR *)mre->Text, -1, buffer, len, NULL, NULL );
    }
    else
    {
        int len = strlen(mre->Text) + 1;
        if (!(buffer = HeapAlloc( GetProcessHeap(), 0, len ))) return NULL;
        memcpy( buffer, mre->Text, len );
    }
    TRACE("returning %s\n", wine_dbgstr_a(buffer));
    return buffer;
Dave Pickles's avatar
Dave Pickles committed
124 125 126 127
}


/***********************************************************************
128
 *           FormatMessageA   (KERNEL32.@)
Dave Pickles's avatar
Dave Pickles committed
129 130 131 132 133 134 135 136 137
 * FIXME: missing wrap,
 */
DWORD WINAPI FormatMessageA(
	DWORD	dwFlags,
	LPCVOID	lpSource,
	DWORD	dwMessageId,
	DWORD	dwLanguageId,
	LPSTR	lpBuffer,
	DWORD	nSize,
138 139 140
	va_list* _args )
{
    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 */
143 144 145 146 147 148 149 150 151 152 153 154 155
    LPSTR	target,t;
    DWORD	talloced;
    LPSTR	from,f;
    DWORD	width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
    BOOL    eos = FALSE;
    CHAR	ch;

    TRACE("(0x%lx,%p,%ld,0x%lx,%p,%ld,%p)\n",
          dwFlags,lpSource,dwMessageId,dwLanguageId,lpBuffer,nSize,args);
    if ((dwFlags & FORMAT_MESSAGE_FROM_STRING)
        &&((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
           || (dwFlags & FORMAT_MESSAGE_FROM_HMODULE))) return 0;

156
    if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
157 158
        FIXME("line wrapping (%lu) not supported.\n", width);
    from = NULL;
159 160
    if (dwFlags & FORMAT_MESSAGE_FROM_STRING)
    {
161 162
        from = HeapAlloc( GetProcessHeap(), 0, strlen((LPCSTR)lpSource)+1 );
        strcpy( from, (LPCSTR)lpSource );
163 164
    }
    else {
165
        from = NULL;
166
        if (dwFlags & FORMAT_MESSAGE_FROM_HMODULE)
167 168 169
            from = load_messageA( (HMODULE)lpSource, dwMessageId, dwLanguageId );
        if (!from && (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM))
            from = load_messageA( kernel32_handle, dwMessageId, dwLanguageId );
170

171 172
        if (!from)
        {
173 174 175
            SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
            return 0;
        }
176 177 178 179
    }
    target	= HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100);
    t	= target;
    talloced= 100;
Dave Pickles's avatar
Dave Pickles committed
180

181
#define ADD_TO_T(c) do { \
182 183 184 185 186 187
        *t++=c;\
        if (t-target == talloced) {\
            target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
            t = target+talloced;\
            talloced*=2;\
      }\
188
} while (0)
Dave Pickles's avatar
Dave Pickles committed
189

190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
    if (from) {
        f=from;
        if (dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS) {
            while (*f && !eos)
                ADD_TO_T(*f++);
        }
        else {
            while (*f && !eos) {
                if (*f=='%') {
                    int insertnr;
                    char *fmtstr,*x,*lastf;
                    DWORD *argliststart;

                    fmtstr = NULL;
                    lastf = f;
                    f++;
                    if (!*f) {
                        ADD_TO_T('%');
                        continue;
                    }
                    switch (*f) {
                    case '1':case '2':case '3':case '4':case '5':
                    case '6':case '7':case '8':case '9':
                        insertnr=*f-'0';
                        switch (f[1]) {
                        case '0':case '1':case '2':case '3':
                        case '4':case '5':case '6':case '7':
                        case '8':case '9':
                            f++;
                            insertnr=insertnr*10+*f-'0';
                            f++;
                            break;
                        default:
                            f++;
                            break;
                        }
                        if (*f=='!') {
                            f++;
                            if (NULL!=(x=strchr(f,'!'))) {
                                *x='\0';
                                fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
                                sprintf(fmtstr,"%%%s",f);
                                f=x+1;
                            } else {
                                fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
                                sprintf(fmtstr,"%%%s",f);
                                f+=strlen(f); /*at \0*/
                            }
                        } else {
239 240 241
                            if(!args) break;
                            fmtstr = HeapAlloc(GetProcessHeap(),0,3);
                            strcpy( fmtstr, "%s" );
242 243 244 245 246 247 248 249 250 251 252
                        }
                        if (args) {
                            int sz;
                            LPSTR b;

                            if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
                                argliststart=args+insertnr-1;
                            else
                                argliststart=(*(DWORD**)args)+insertnr-1;

                                /* FIXME: precision and width components are not handled correctly */
253
                            if ( (strcmp(fmtstr, "%ls") == 0) || (strcmp(fmtstr,"%S") == 0) ) {
254 255 256 257
                                sz = WideCharToMultiByte( CP_ACP, 0, *(WCHAR**)argliststart, -1, NULL, 0, NULL, NULL);
                                b = HeapAlloc(GetProcessHeap(), 0, sz);
                                WideCharToMultiByte( CP_ACP, 0, *(WCHAR**)argliststart, -1, b, sz, NULL, NULL);
                            } else {
258
                                b = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sz = 1000);
259 260
                                /* CMF - This makes a BIG assumption about va_list */
                                TRACE("A BIG assumption\n");
261
                                vsnprintf(b, sz, fmtstr, (va_list) argliststart);
262 263 264 265 266
                            }
                            for (x=b; *x; x++) ADD_TO_T(*x);

                            HeapFree(GetProcessHeap(),0,b);
                        } else {
267
                                /* NULL args - copy formatstr
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
                                 * (probably wrong)
                                 */
                            while ((lastf<f)&&(*lastf)) {
                                ADD_TO_T(*lastf++);
                            }
                        }
                        HeapFree(GetProcessHeap(),0,fmtstr);
                        break;
                    case 'n':
                        ADD_TO_T('\r');
                        ADD_TO_T('\n');
                        f++;
                        break;
                    case '0':
                        eos = TRUE;
                        f++;
                        break;
                    default:
                        ADD_TO_T(*f++);
                        break;
                    }
                } else {
                    ch = *f;
                    f++;
                    if (ch == '\r') {
                        if (*f == '\n')
                            f++;
295 296 297
                        if(width)
                            ADD_TO_T(' ');
                        else
298 299 300 301
                        {
                            ADD_TO_T('\r');
                            ADD_TO_T('\n');
                        }
302 303 304 305 306 307 308 309 310 311 312
                    } else {
                        if (ch == '\n')
                        {
                            if(width)
                                ADD_TO_T(' ');
                            else
                            {
                                ADD_TO_T('\r');
                                ADD_TO_T('\n');
                            }
                        }
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
                        else
                            ADD_TO_T(ch);
                    }
                }
            }
        }
        *t='\0';
    }
    talloced = strlen(target)+1;
    if (nSize && talloced<nSize) {
        target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize);
    }
    TRACE("-- %s\n",debugstr_a(target));
    if (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) {
        *((LPVOID*)lpBuffer) = (LPVOID)LocalAlloc(GMEM_ZEROINIT,max(nSize, talloced));
        memcpy(*(LPSTR*)lpBuffer,target,talloced);
    } else {
        lstrcpynA(lpBuffer,target,nSize);
    }
    HeapFree(GetProcessHeap(),0,target);
333
    HeapFree(GetProcessHeap(),0,from);
334 335 336 337
    TRACE("-- returning %d\n", (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?  strlen(*(LPSTR*)lpBuffer):strlen(lpBuffer));
    return (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
        strlen(*(LPSTR*)lpBuffer):
            strlen(lpBuffer);
Dave Pickles's avatar
Dave Pickles committed
338
#else
339
    return 0;
Dave Pickles's avatar
Dave Pickles committed
340 341 342 343 344 345
#endif /* __i386__ */
}
#undef ADD_TO_T


/***********************************************************************
346
 *           FormatMessageW   (KERNEL32.@)
Dave Pickles's avatar
Dave Pickles committed
347 348 349 350 351 352 353 354
 */
DWORD WINAPI FormatMessageW(
	DWORD	dwFlags,
	LPCVOID	lpSource,
	DWORD	dwMessageId,
	DWORD	dwLanguageId,
	LPWSTR	lpBuffer,
	DWORD	nSize,
355 356 357
	va_list* _args )
{
    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 */
360
    LPWSTR target,t;
361
    DWORD talloced;
362
    LPWSTR from,f;
363 364 365 366 367 368 369 370 371 372 373 374 375 376
    DWORD width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
    BOOL eos = FALSE;
    CHAR ch;

    TRACE("(0x%lx,%p,%ld,0x%lx,%p,%ld,%p)\n",
          dwFlags,lpSource,dwMessageId,dwLanguageId,lpBuffer,nSize,args);
    if ((dwFlags & FORMAT_MESSAGE_FROM_STRING)
        &&((dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
           || (dwFlags & FORMAT_MESSAGE_FROM_HMODULE))) return 0;

    if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
        FIXME("line wrapping not supported.\n");
    from = NULL;
    if (dwFlags & FORMAT_MESSAGE_FROM_STRING) {
377
        from = HeapAlloc( GetProcessHeap(), 0, (strlenW((LPCWSTR)lpSource) + 1) *
378
            sizeof(WCHAR) );
379
        strcpyW( from, (LPCWSTR)lpSource );
380 381
    }
    else {
382
        from = NULL;
383
        if (dwFlags & FORMAT_MESSAGE_FROM_HMODULE)
384 385 386
            from = load_messageW( (HMODULE)lpSource, dwMessageId, dwLanguageId );
        if (!from && (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM))
            from = load_messageW( kernel32_handle, dwMessageId, dwLanguageId );
387

388 389
        if (!from)
        {
390 391 392
            SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
            return 0;
        }
393
    }
394
    target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100 * sizeof(WCHAR) );
395 396
    t = target;
    talloced= 100;
Dave Pickles's avatar
Dave Pickles committed
397

398
#define ADD_TO_T(c)  do {\
399 400
    *t++=c;\
    if (t-target == talloced) {\
401
        target = (WCHAR*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2*sizeof(WCHAR));\
402 403 404
        t = target+talloced;\
        talloced*=2;\
    } \
405
} while (0)
Dave Pickles's avatar
Dave Pickles committed
406

407 408 409 410 411
    if (from) {
        f=from;
        if (dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS) {
            while (*f && !eos)
                ADD_TO_T(*f++);
412
        }
413 414 415 416
        else {
            while (*f && !eos) {
                if (*f=='%') {
                    int insertnr;
417
                    WCHAR *fmtstr,*sprintfbuf,*x;
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
                    DWORD *argliststart;

                    fmtstr = NULL;
                    f++;
                    if (!*f) {
                        ADD_TO_T('%');
                        continue;
                    }

                    switch (*f) {
                    case '1':case '2':case '3':case '4':case '5':
                    case '6':case '7':case '8':case '9':
                        insertnr=*f-'0';
                        switch (f[1]) {
                        case '0':case '1':case '2':case '3':
                        case '4':case '5':case '6':case '7':
                        case '8':case '9':
                            f++;
                            insertnr=insertnr*10+*f-'0';
                            f++;
                            break;
                        default:
                            f++;
                            break;
                        }
                        if (*f=='!') {
                            f++;
445
                            if (NULL!=(x=strchrW(f,'!'))) {
446
                                *x='\0';
447 448
                                fmtstr=HeapAlloc( GetProcessHeap(), 0,(strlenW(f)+2)*sizeof(WCHAR));
                                sprintfW(fmtstr,PCNTFMTWSTR,f);
449 450
                                f=x+1;
                            } else {
451 452 453
                                fmtstr=HeapAlloc(GetProcessHeap(),0,(strlenW(f)+2)*sizeof(WCHAR));
                                sprintfW(fmtstr,PCNTFMTWSTR,f);
                                f+=strlenW(f); /*at \0*/
454 455
                            }
                        } else {
456
                            if(!args) break;
457 458
                            fmtstr = HeapAlloc( GetProcessHeap(),0,3*sizeof(WCHAR));
                            strcpyW( fmtstr, FMTWSTR );
459 460 461 462 463 464
                        }
                        if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
                            argliststart=args+insertnr-1;
                        else
                            argliststart=(*(DWORD**)args)+insertnr-1;

465
                        if (fmtstr[strlenW(fmtstr)-1]=='s' && argliststart[0]) {
466 467
                            DWORD xarr[3];

468
                            xarr[0]=*(argliststart+0);
469 470 471
                            /* possible invalid pointers */
                            xarr[1]=*(argliststart+1);
                            xarr[2]=*(argliststart+2);
472
                            sprintfbuf=HeapAlloc(GetProcessHeap(),0,(strlenW((LPWSTR)argliststart[0])*2+1)*sizeof(WCHAR));
473 474

                            /* CMF - This makes a BIG assumption about va_list */
475
                            vsprintfW(sprintfbuf, fmtstr, (va_list) xarr);
476 477 478 479
                        } else {
                            sprintfbuf=HeapAlloc(GetProcessHeap(),0,100);

                            /* CMF - This makes a BIG assumption about va_list */
480
                            vsprintfW(sprintfbuf, fmtstr, (va_list) argliststart);
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
                        }
                        x=sprintfbuf;
                        while (*x) {
                            ADD_TO_T(*x++);
                        }
                        HeapFree(GetProcessHeap(),0,sprintfbuf);
                        HeapFree(GetProcessHeap(),0,fmtstr);
                        break;
                    case 'n':
                        ADD_TO_T('\r');
                        ADD_TO_T('\n');
                        f++;
                        break;
                    case '0':
                        eos = TRUE;
                        f++;
                        break;
                    default:
                        ADD_TO_T(*f++);
                        break;
                    }
                } else {
                    ch = *f;
                    f++;
                    if (ch == '\r') {
                        if (*f == '\n')
                            f++;
508 509 510
                        if(width)
                            ADD_TO_T(' ');
                        else
511 512 513 514
                        {
                            ADD_TO_T('\r');
                            ADD_TO_T('\n');
                        }
515 516 517 518 519 520 521 522 523 524 525
                    } else {
                        if (ch == '\n')
                        {
                            if(width)
                                ADD_TO_T(' ');
                            else
                            {
                                ADD_TO_T('\r');
                                ADD_TO_T('\n');
                            }
                        }
526 527 528 529 530
                        else
                            ADD_TO_T(ch);
                    }
                }
            }
531
        }
532 533
        *t='\0';
    }
534
    talloced = strlenW(target)+1;
535
    if (nSize && talloced<nSize)
536
        target = (WCHAR*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize*sizeof(WCHAR));
537 538
    if (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) {
        /* 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);
542
    }
543 544
    else lstrcpynW(lpBuffer, target, nSize);

545
    HeapFree(GetProcessHeap(),0,target);
546
    HeapFree(GetProcessHeap(),0,from);
547 548
    TRACE("ret=%s\n", wine_dbgstr_w((dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
        *(LPWSTR*)lpBuffer : lpBuffer));
549 550 551
    return (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
        strlenW(*(LPWSTR*)lpBuffer):
            strlenW(lpBuffer);
Dave Pickles's avatar
Dave Pickles committed
552
#else
553
    return 0;
Dave Pickles's avatar
Dave Pickles committed
554 555 556
#endif /* __i386__ */
}
#undef ADD_TO_T