/* * FormatMessage implementation * * Copyright 1996 Marcus Meissner * Copyright 2009 Alexandre Julliard * * 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA */ #include "config.h" #include #include #include #include "ntstatus.h" #define WIN32_NO_STATUS #include "windef.h" #include "winbase.h" #include "winerror.h" #include "winternl.h" #include "winuser.h" #include "winnls.h" #include "wine/unicode.h" #include "kernel_private.h" #include "wine/debug.h" WINE_DEFAULT_DEBUG_CHANNEL(resource); struct format_args { ULONG_PTR *args; __ms_va_list *list; int last; }; /* Messages used by FormatMessage * * They can be specified either directly or using a message ID and * loading them from the resource. * * 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: * 0: WORD len (0 marks end) [ includes the 4 byte header length ] * 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. */ static const WCHAR PCNTFMTWSTR[] = { '%','%','%','s',0 }; static const WCHAR FMTWSTR[] = { '%','s',0 }; /********************************************************************** * load_messageW (internal) */ static LPWSTR load_messageW( HMODULE module, UINT id, WORD lang ) { const MESSAGE_RESOURCE_ENTRY *mre; WCHAR *buffer; NTSTATUS status; TRACE("module = %p, id = %08x\n", module, id ); if (!module) module = GetModuleHandleW( NULL ); if ((status = RtlFindMessage( module, RT_MESSAGETABLE, lang, id, &mre )) != STATUS_SUCCESS) { SetLastError( RtlNtStatusToDosError(status) ); return NULL; } if (mre->Flags & MESSAGE_RESOURCE_UNICODE) { int len = (strlenW( (const WCHAR *)mre->Text ) + 1) * sizeof(WCHAR); if (!(buffer = HeapAlloc( GetProcessHeap(), 0, len ))) return NULL; memcpy( buffer, mre->Text, len ); } else { int len = MultiByteToWideChar( CP_ACP, 0, (const char *)mre->Text, -1, NULL, 0 ); if (!(buffer = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) ))) return NULL; MultiByteToWideChar( CP_ACP, 0, (const char*)mre->Text, -1, buffer, len ); } TRACE("returning %s\n", wine_dbgstr_w(buffer)); return buffer; } /********************************************************************** * load_messageA (internal) */ static LPSTR load_messageA( HMODULE module, UINT id, WORD lang ) { const MESSAGE_RESOURCE_ENTRY *mre; char *buffer; NTSTATUS status; TRACE("module = %p, id = %08x\n", module, id ); if (!module) module = GetModuleHandleW( NULL ); if ((status = RtlFindMessage( module, RT_MESSAGETABLE, lang, id, &mre )) != STATUS_SUCCESS) { SetLastError( RtlNtStatusToDosError(status) ); return NULL; } if (mre->Flags & MESSAGE_RESOURCE_UNICODE) { 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((const char*)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; } /********************************************************************** * get_arg (internal) */ static ULONG_PTR get_arg( int nr, DWORD flags, struct format_args *args ) { if (nr == -1) nr = args->last + 1; if (args->list) { if (!args->args) args->args = HeapAlloc( GetProcessHeap(), 0, 99 * sizeof(ULONG_PTR) ); while (nr > args->last) args->args[args->last++] = va_arg( *args->list, ULONG_PTR ); } if (nr > args->last) args->last = nr; return args->args[nr - 1]; } /********************************************************************** * format_insertA (internal) */ static LPCSTR format_insertA( int insert, LPCSTR format, DWORD flags, struct format_args *args, LPSTR *result ) { char *astring = NULL, *p, fmt[256]; ULONG_PTR arg; int size; if (*format != '!') /* simple string */ { char *str = (char *)get_arg( insert, flags, args ); *result = HeapAlloc( GetProcessHeap(), 0, strlen(str) + 1 ); strcpy( *result, str ); return format; } format++; p = fmt; *p++ = '%'; while (*format == '0' || *format == '+' || *format == '-' || *format == ' ' || *format == '*' || *format == '#') { if (*format == '*') { p += sprintf( p, "%lu", get_arg( insert, flags, args )); insert = -1; format++; } else *p++ = *format++; } while (isdigit(*format)) *p++ = *format++; if (*format == '.') { *p++ = *format++; if (*format == '*') { p += sprintf( p, "%lu", get_arg( insert, flags, args )); insert = -1; format++; } else while (isdigit(*format)) *p++ = *format++; } arg = get_arg( insert, flags, args ); /* check for wide string format */ if ((format[0] == 'l' && format[1] == 's') || (format[0] == 'l' && format[1] == 'S') || (format[0] == 'w' && format[1] == 's') || (format[0] == 'S')) { DWORD len = WideCharToMultiByte( CP_ACP, 0, (WCHAR *)arg, -1, /*FIXME*/ NULL, 0, NULL, NULL ); astring = HeapAlloc( GetProcessHeap(), 0, len ); WideCharToMultiByte( CP_ACP, 0, (WCHAR *)arg, -1, astring, len, NULL, NULL ); arg = (ULONG_PTR)astring; *p++ = 's'; } /* check for wide character format */ else if ((format[0] == 'l' && format[1] == 'c') || (format[0] == 'l' && format[1] == 'C') || (format[0] == 'w' && format[1] == 'c') || (format[0] == 'C')) { WCHAR ch = arg; DWORD len = WideCharToMultiByte( CP_ACP, 0, &ch, 1, NULL, 0, NULL, NULL ); astring = HeapAlloc( GetProcessHeap(), 0, len + 1 ); WideCharToMultiByte( CP_ACP, 0, &ch, 1, astring, len, NULL, NULL ); astring[len] = 0; arg = (ULONG_PTR)astring; *p++ = 's'; } /* check for ascii string format */ else if ((format[0] == 'h' && format[1] == 's') || (format[0] == 'h' && format[1] == 'S')) { *p++ = 's'; } /* check for ascii character format */ else if ((format[0] == 'h' && format[1] == 'c') || (format[0] == 'h' && format[1] == 'C')) { *p++ = 'c'; } /* FIXME: handle I64 etc. */ else while (*format && *format != '!') *p++ = *format++; *p = 0; size = 256; for (;;) { char *ret = HeapAlloc( GetProcessHeap(), 0, size ); int needed = snprintf( ret, size, fmt, arg ); if (needed == -1 || needed >= size) { HeapFree( GetProcessHeap(), 0, ret ); size = max( needed + 1, size * 2 ); } else { *result = ret; break; } } while (*format && *format != '!') format++; if (*format == '!') format++; HeapFree( GetProcessHeap(), 0, astring ); return format; } /********************************************************************** * format_insertW (internal) */ static LPCWSTR format_insertW( int insert, LPCWSTR format, DWORD flags, struct format_args *args, LPWSTR *result ) { static const WCHAR fmt_lu[] = {'%','l','u',0}; WCHAR *wstring = NULL, *p, fmt[256]; ULONG_PTR arg; int size; if (*format != '!') /* simple string */ { WCHAR *str = (WCHAR *)get_arg( insert, flags, args ); *result = HeapAlloc( GetProcessHeap(), 0, (strlenW(str) + 1) * sizeof(WCHAR) ); strcpyW( *result, str ); return format; } format++; p = fmt; *p++ = '%'; while (*format == '0' || *format == '+' || *format == '-' || *format == ' ' || *format == '*' || *format == '#') { if (*format == '*') { p += sprintfW( p, fmt_lu, get_arg( insert, flags, args )); insert = -1; format++; } else *p++ = *format++; } while (isdigitW(*format)) *p++ = *format++; if (*format == '.') { *p++ = *format++; if (*format == '*') { p += sprintfW( p, fmt_lu, get_arg( insert, flags, args )); insert = -1; format++; } else while (isdigitW(*format)) *p++ = *format++; } arg = get_arg( insert, flags, args ); /* check for ascii string format */ if ((format[0] == 'h' && format[1] == 's') || (format[0] == 'h' && format[1] == 'S') || (format[0] == 'S')) { DWORD len = MultiByteToWideChar( CP_ACP, 0, (char *)arg, -1, /*FIXME*/ NULL, 0 ); wstring = HeapAlloc( GetProcessHeap(), 0, len * sizeof(WCHAR) ); MultiByteToWideChar( CP_ACP, 0, (char *)arg, -1, wstring, len ); arg = (ULONG_PTR)wstring; *p++ = 's'; } /* check for ascii character format */ else if ((format[0] == 'h' && format[1] == 'c') || (format[0] == 'h' && format[1] == 'C') || (format[0] == 'C')) { char ch = arg; wstring = HeapAlloc( GetProcessHeap(), 0, 2 ); MultiByteToWideChar( CP_ACP, 0, &ch, 1, wstring, 1 ); wstring[1] = 0; arg = (ULONG_PTR)wstring; *p++ = 's'; } /* check for wide string format */ else if ((format[0] == 'l' && format[1] == 's') || (format[0] == 'l' && format[1] == 'S') || (format[0] == 'w' && format[1] == 's')) { *p++ = 's'; } /* check for wide character format */ else if ((format[0] == 'l' && format[1] == 'c') || (format[0] == 'l' && format[1] == 'C') || (format[0] == 'w' && format[1] == 'c')) { *p++ = 'c'; } /* FIXME: handle I64 etc. */ else while (*format && *format != '!') *p++ = *format++; *p = 0; size = 256; for (;;) { WCHAR *ret = HeapAlloc( GetProcessHeap(), 0, size * sizeof(WCHAR) ); int needed = snprintfW( ret, size, fmt, arg ); if (needed == -1 || needed >= size) { HeapFree( GetProcessHeap(), 0, ret ); size = max( needed + 1, size * 2 ); } else { *result = ret; break; } } while (*format && *format != '!') format++; if (*format == '!') format++; HeapFree( GetProcessHeap(), 0, wstring ); return format; } /*********************************************************************** * FormatMessageA (KERNEL32.@) * FIXME: missing wrap, */ DWORD WINAPI FormatMessageA( DWORD dwFlags, LPCVOID lpSource, DWORD dwMessageId, DWORD dwLanguageId, LPSTR lpBuffer, DWORD nSize, __ms_va_list* args ) { struct format_args format_args; DWORD ret = 0; LPSTR target,t; DWORD talloced; LPSTR from; LPCSTR f; DWORD width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK; BOOL eos = FALSE; CHAR ch; TRACE("(0x%x,%p,%d,0x%x,%p,%d,%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 (!lpBuffer) { SetLastError(ERROR_NOT_ENOUGH_MEMORY); return 0; } if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY) { format_args.args = (ULONG_PTR *)args; format_args.list = NULL; format_args.last = 0; } else { format_args.args = NULL; format_args.list = args; format_args.last = 0; } if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK) FIXME("line wrapping (%u) not supported.\n", width); from = NULL; if (dwFlags & FORMAT_MESSAGE_FROM_STRING) { from = HeapAlloc( GetProcessHeap(), 0, strlen(lpSource) + 1 ); strcpy( from, lpSource ); } else { from = NULL; if (dwFlags & FORMAT_MESSAGE_FROM_HMODULE) from = load_messageA( (HMODULE)lpSource, dwMessageId, dwLanguageId ); if (!from && (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)) from = load_messageA( kernel32_handle, dwMessageId, dwLanguageId ); if (!from) return 0; } target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100); t = target; talloced= 100; #define ADD_TO_T(c) do { \ *t++=c;\ if ((DWORD)(t-target) == talloced) {\ target = HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\ t = target+talloced;\ talloced*=2;\ }\ } while (0) 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 *str,*x; 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; } f = format_insertA( insertnr, f, dwFlags, &format_args, &str ); for (x = str; *x; x++) ADD_TO_T(*x); HeapFree( GetProcessHeap(), 0, str ); 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++; if(width) ADD_TO_T(' '); else { ADD_TO_T('\r'); ADD_TO_T('\n'); } } else { if (ch == '\n') { if(width) ADD_TO_T(' '); else { ADD_TO_T('\r'); ADD_TO_T('\n'); } } else ADD_TO_T(ch); } } } } *t='\0'; } talloced = strlen(target)+1; if (nSize && talloced