When including 'wine/port.h', include it first.
[wine] / dlls / kernel / format_msg.c
1 /*
2  * FormatMessage implementation
3  *
4  * Copyright 1996 Marcus Meissner
5  */
6
7 #include "config.h"
8
9 #include <stdio.h>
10 #include <string.h>
11
12 #include "windef.h"
13 #include "winbase.h"
14 #include "winerror.h"
15 #include "winuser.h"
16 #include "winnls.h"
17 #include "wine/unicode.h"
18
19 #include "heap.h"
20 #include "debugtools.h"
21
22 DEFAULT_DEBUG_CHANNEL(resource);
23
24
25 /* Messages...used by FormatMessage32* (KERNEL32.something)
26  * 
27  * They can be specified either directly or using a message ID and
28  * loading them from the resource.
29  * 
30  * The resourcedata has following format:
31  * start:
32  * 0: DWORD nrofentries
33  * nrofentries * subentry:
34  *      0: DWORD firstentry
35  *      4: DWORD lastentry
36  *      8: DWORD offset from start to the stringentries
37  *
38  * (lastentry-firstentry) * stringentry:
39  * 0: WORD len (0 marks end)    [ includes the 4 byte header length ]
40  * 2: WORD flags
41  * 4: CHAR[len-4]
42  *      (stringentry i of a subentry refers to the ID 'firstentry+i')
43  *
44  * Yes, ANSI strings in win32 resources. Go figure.
45  */
46
47 /**********************************************************************
48  *      load_messageA           (internal)
49  */
50 static INT load_messageA( HMODULE instance, UINT id, WORD lang,
51                           LPSTR buffer, INT buflen )
52 {
53     HGLOBAL     hmem;
54     HRSRC       hrsrc;
55     PMESSAGE_RESOURCE_DATA      mrd;
56     PMESSAGE_RESOURCE_BLOCK     mrb;
57     PMESSAGE_RESOURCE_ENTRY     mre;
58     int         i,slen;
59
60     TRACE("instance = %08lx, id = %08lx, buffer = %p, length = %ld\n", (DWORD)instance, (DWORD)id, buffer, (DWORD)buflen);
61
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);
64     if (!hrsrc) return 0;
65     hmem = LoadResource( instance, hrsrc );
66     if (!hmem) return 0;
67     
68     mrd = (PMESSAGE_RESOURCE_DATA)LockResource(hmem);
69     mre = NULL;
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);
74             id  -= mrb->LowId;
75             break;
76         }
77         mrb++;
78     }
79     if (!mre)
80         return 0;
81     for (i=id;i--;) {
82         if (!mre->Length)
83                 return 0;
84         mre = (PMESSAGE_RESOURCE_ENTRY)(((char*)mre)+mre->Length);
85     }
86     slen=mre->Length;
87     TRACE("     - strlen=%d\n",slen);
88     i = min(buflen - 1, slen);
89     if (buffer == NULL)
90         return slen;
91     if (i>0) {
92         if (mre->Flags & MESSAGE_RESOURCE_UNICODE)
93             WideCharToMultiByte( CP_ACP, 0, (LPWSTR)mre->Text, -1, buffer, i, NULL, NULL );
94         else
95             lstrcpynA(buffer, (LPSTR)mre->Text, i);
96         buffer[i]=0;
97     } else {
98         if (buflen>1) {
99             buffer[0]=0;
100             return 0;
101         }
102     }
103     if (buffer)
104             TRACE("'%s' copied !\n", buffer);
105     return i;
106 }
107
108 #if 0  /* FIXME */
109 /**********************************************************************
110  *      load_messageW   (internal)
111  */
112 static INT load_messageW( HMODULE instance, UINT id, WORD lang,
113                           LPWSTR buffer, INT buflen )
114 {
115     INT retval;
116     LPSTR buffer2 = NULL;
117     if (buffer && buflen)
118         buffer2 = HeapAlloc( GetProcessHeap(), 0, buflen );
119     retval = load_messageA(instance,id,lang,buffer2,buflen);
120     if (buffer)
121     {
122         if (retval) {
123             lstrcpynAtoW( buffer, buffer2, buflen );
124             retval = strlenW( buffer );
125         }
126         HeapFree( GetProcessHeap(), 0, buffer2 );
127     }
128     return retval;
129 }
130 #endif
131
132
133 /***********************************************************************
134  *           FormatMessageA   (KERNEL32.@)
135  * FIXME: missing wrap,
136  */
137 DWORD WINAPI FormatMessageA(
138         DWORD   dwFlags,
139         LPCVOID lpSource,
140         DWORD   dwMessageId,
141         DWORD   dwLanguageId,
142         LPSTR   lpBuffer,
143         DWORD   nSize,
144         va_list* _args )
145 {
146     LPDWORD args=(LPDWORD)_args;
147 #ifdef __i386__
148 /* This implementation is completely dependant on the format of the va_list on x86 CPUs */
149     LPSTR       target,t;
150     DWORD       talloced;
151     LPSTR       from,f;
152     DWORD       width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
153     BOOL    eos = FALSE;
154     INT bufsize;
155     HMODULE     hmodule = (HMODULE)lpSource;
156     CHAR        ch;
157
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;
165
166     if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK) 
167         FIXME("line wrapping (%lu) not supported.\n", width);
168     from = NULL;
169     if (dwFlags & FORMAT_MESSAGE_FROM_STRING)
170     {
171         from = HeapAlloc( GetProcessHeap(), 0, strlen((LPSTR)lpSource)+1 );
172         strcpy( from, (LPSTR)lpSource );
173     }
174     else {
175         if (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
176             hmodule = GetModuleHandleA("kernel32");
177         bufsize=load_messageA(hmodule,dwMessageId,dwLanguageId,NULL,100);
178         if (!bufsize) {
179             if (dwLanguageId) {
180                 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
181                 return 0;
182             }
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);
193             if (!bufsize) {
194                 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
195                 return 0;
196             }
197         }
198         from = HeapAlloc( GetProcessHeap(), 0, bufsize + 1 );
199         load_messageA(hmodule,dwMessageId,dwLanguageId,from,bufsize+1);
200     }
201     target      = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100);
202     t   = target;
203     talloced= 100;
204
205 #define ADD_TO_T(c) do { \
206         *t++=c;\
207         if (t-target == talloced) {\
208             target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
209             t = target+talloced;\
210             talloced*=2;\
211       }\
212 } while (0)
213
214     if (from) {
215         f=from;
216         if (dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS) {
217             while (*f && !eos)
218                 ADD_TO_T(*f++);
219         }
220         else {
221             while (*f && !eos) {
222                 if (*f=='%') {
223                     int insertnr;
224                     char *fmtstr,*x,*lastf;
225                     DWORD *argliststart;
226
227                     fmtstr = NULL;
228                     lastf = f;
229                     f++;
230                     if (!*f) {
231                         ADD_TO_T('%');
232                         continue;
233                     }
234                     switch (*f) {
235                     case '1':case '2':case '3':case '4':case '5':
236                     case '6':case '7':case '8':case '9':
237                         insertnr=*f-'0';
238                         switch (f[1]) {
239                         case '0':case '1':case '2':case '3':
240                         case '4':case '5':case '6':case '7':
241                         case '8':case '9':
242                             f++;
243                             insertnr=insertnr*10+*f-'0';
244                             f++;
245                             break;
246                         default:
247                             f++;
248                             break;
249                         }
250                         if (*f=='!') {
251                             f++;
252                             if (NULL!=(x=strchr(f,'!'))) {
253                                 *x='\0';
254                                 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
255                                 sprintf(fmtstr,"%%%s",f);
256                                 f=x+1;
257                             } else {
258                                 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f)+2);
259                                 sprintf(fmtstr,"%%%s",f);
260                                 f+=strlen(f); /*at \0*/
261                             }
262                         } else {
263                             if(!args) break;
264                             fmtstr = HeapAlloc(GetProcessHeap(),0,3);
265                             strcpy( fmtstr, "%s" );
266                         }
267                         if (args) {
268                             int sz;
269                             LPSTR b;
270
271                             if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
272                                 argliststart=args+insertnr-1;
273                             else
274                                 argliststart=(*(DWORD**)args)+insertnr-1;
275
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);
281                             } else {
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);
287                                 }
288                             }
289                             for (x=b; *x; x++) ADD_TO_T(*x);
290
291                             HeapFree(GetProcessHeap(),0,b);
292                         } else {
293                                 /* NULL args - copy formatstr 
294                                  * (probably wrong)
295                                  */
296                             while ((lastf<f)&&(*lastf)) {
297                                 ADD_TO_T(*lastf++);
298                             }
299                         }
300                         HeapFree(GetProcessHeap(),0,fmtstr);
301                         break;
302                     case 'n':
303                         ADD_TO_T('\r');
304                         ADD_TO_T('\n');
305                         f++;
306                         break;
307                     case '0':
308                         eos = TRUE;
309                         f++;
310                         break;
311                     default:
312                         ADD_TO_T(*f++);
313                         break;
314                     }
315                 } else {
316                     ch = *f;
317                     f++;
318                     if (ch == '\r') {
319                         if (*f == '\n')
320                             f++;
321                         ADD_TO_T(' ');
322                     } else {
323                         if (ch == '\n')
324                         {
325                             ADD_TO_T('\r');
326                             ADD_TO_T('\n');
327                         }
328                         else
329                             ADD_TO_T(ch);
330                     }
331                 }
332             }
333         }
334         *t='\0';
335     }
336     talloced = strlen(target)+1;
337     if (nSize && talloced<nSize) {
338         target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,nSize);
339     }
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);
344     } else {
345         lstrcpynA(lpBuffer,target,nSize);
346     }
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):
352             strlen(lpBuffer);
353 #else
354     return 0;
355 #endif /* __i386__ */
356 }
357 #undef ADD_TO_T
358
359
360 /***********************************************************************
361  *           FormatMessageW   (KERNEL32.@)
362  */
363 DWORD WINAPI FormatMessageW(
364         DWORD   dwFlags,
365         LPCVOID lpSource,
366         DWORD   dwMessageId,
367         DWORD   dwLanguageId,
368         LPWSTR  lpBuffer,
369         DWORD   nSize,
370         va_list* _args )
371 {
372     LPDWORD args=(LPDWORD)_args;
373 #ifdef __i386__
374 /* This implementation is completely dependant on the format of the va_list on x86 CPUs */
375     LPSTR target,t;
376     DWORD talloced;
377     LPSTR from,f;
378     DWORD width = dwFlags & FORMAT_MESSAGE_MAX_WIDTH_MASK;
379     BOOL eos = FALSE;
380     INT bufsize;
381     HMODULE hmodule = (HMODULE)lpSource;
382     CHAR ch;
383
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;
391
392     if (width && width != FORMAT_MESSAGE_MAX_WIDTH_MASK)
393         FIXME("line wrapping not supported.\n");
394     from = NULL;
395     if (dwFlags & FORMAT_MESSAGE_FROM_STRING) {
396         from = HEAP_strdupWtoA(GetProcessHeap(),0,(LPWSTR)lpSource);
397     }
398     else {
399         if (dwFlags & FORMAT_MESSAGE_FROM_SYSTEM)
400             hmodule = GetModuleHandleA("kernel32");
401         bufsize=load_messageA(hmodule,dwMessageId,dwLanguageId,NULL,100);
402         if (!bufsize) {
403             if (dwLanguageId) {
404                 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
405                 return 0;
406             }
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);
417             if (!bufsize) {
418                 SetLastError (ERROR_RESOURCE_LANG_NOT_FOUND);
419                 return 0;
420             }
421         }
422         from = HeapAlloc( GetProcessHeap(), 0, bufsize + 1 );
423         load_messageA(hmodule,dwMessageId,dwLanguageId,from,bufsize+1);
424     }
425     target = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, 100 );
426     t = target;
427     talloced= 100;
428
429 #define ADD_TO_T(c)  do {\
430     *t++=c;\
431     if (t-target == talloced) {\
432         target = (char*)HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,target,talloced*2);\
433         t = target+talloced;\
434         talloced*=2;\
435     } \
436 } while (0)
437
438     if (from) {
439         f=from;
440         if (dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS) {
441             while (*f && !eos)
442                 ADD_TO_T(*f++);
443         }
444         else {
445             while (*f && !eos) {
446                 if (*f=='%') {
447                     int insertnr;
448                     char *fmtstr,*sprintfbuf,*x;
449                     DWORD *argliststart;
450
451                     fmtstr = NULL;
452                     f++;
453                     if (!*f) {
454                         ADD_TO_T('%');
455                         continue;
456                     }
457
458                     switch (*f) {
459                     case '1':case '2':case '3':case '4':case '5':
460                     case '6':case '7':case '8':case '9':
461                         insertnr=*f-'0';
462                         switch (f[1]) {
463                         case '0':case '1':case '2':case '3':
464                         case '4':case '5':case '6':case '7':
465                         case '8':case '9':
466                             f++;
467                             insertnr=insertnr*10+*f-'0';
468                             f++;
469                             break;
470                         default:
471                             f++;
472                             break;
473                         }
474                         if (*f=='!') {
475                             f++;
476                             if (NULL!=(x=strchr(f,'!'))) {
477                                 *x='\0';
478                                 fmtstr=HeapAlloc( GetProcessHeap(), 0, strlen(f)+2);
479                                 sprintf(fmtstr,"%%%s",f);
480                                 f=x+1;
481                             } else {
482                                 fmtstr=HeapAlloc(GetProcessHeap(),0,strlen(f));
483                                 sprintf(fmtstr,"%%%s",f);
484                                 f+=strlen(f); /*at \0*/
485                             }
486                         } else {
487                             if(!args) break;
488                             fmtstr = HeapAlloc( GetProcessHeap(),0,3);
489                             strcpy( fmtstr, "%s" );
490                         }
491                         if (dwFlags & FORMAT_MESSAGE_ARGUMENT_ARRAY)
492                             argliststart=args+insertnr-1;
493                         else
494                             argliststart=(*(DWORD**)args)+insertnr-1;
495
496                         if (fmtstr[strlen(fmtstr)-1]=='s' && argliststart[0]) {
497                             DWORD xarr[3];
498
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);
504
505                             /* CMF - This makes a BIG assumption about va_list */
506                             vsprintf(sprintfbuf, fmtstr, (va_list) xarr);
507                         } else {
508                             sprintfbuf=HeapAlloc(GetProcessHeap(),0,100);
509
510                             /* CMF - This makes a BIG assumption about va_list */
511                             vsprintf(sprintfbuf, fmtstr, (va_list) argliststart);
512                         }
513                         x=sprintfbuf;
514                         while (*x) {
515                             ADD_TO_T(*x++);
516                         }
517                         HeapFree(GetProcessHeap(),0,sprintfbuf);
518                         HeapFree(GetProcessHeap(),0,fmtstr);
519                         break;
520                     case 'n':
521                         ADD_TO_T('\r');
522                         ADD_TO_T('\n');
523                         f++;
524                         break;
525                     case '0':
526                         eos = TRUE;
527                         f++;
528                         break;
529                     default:
530                         ADD_TO_T(*f++);
531                         break;
532                     }
533                 } else {
534                     ch = *f;
535                     f++;
536                     if (ch == '\r') {
537                         if (*f == '\n')
538                             f++;
539                         ADD_TO_T(' ');
540                     } else {
541                         if (ch == '\n')
542                         {
543                             ADD_TO_T('\r');
544                             ADD_TO_T('\n');
545                         }
546                         else
547                             ADD_TO_T(ch);
548                     }
549                 }
550             }
551         }
552         *t='\0';
553     }
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 );
562     }
563     else
564     {
565         if (nSize > 0 && !MultiByteToWideChar( CP_ACP, 0, target, -1, lpBuffer, nSize ))
566             lpBuffer[nSize-1] = 0;
567     }
568     HeapFree(GetProcessHeap(),0,target);
569     if (from) HeapFree(GetProcessHeap(),0,from);
570     return (dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) ?
571         strlenW(*(LPWSTR*)lpBuffer):
572             strlenW(lpBuffer);
573 #else
574     return 0;
575 #endif /* __i386__ */
576 }
577 #undef ADD_TO_T