winhelp: Move the check about correct RLE decoding inside the decoding routine itself.
[wine] / programs / winhlp32 / hlpfile.c
1 /*
2  * Help Viewer
3  *
4  * Copyright    1996 Ulrich Schmid
5  *              2002, 2008 Eric Pouech
6  *              2007 Kirill K. Smirnov
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21  */
22
23 #include <stdarg.h>
24 #include <stdio.h>
25 #include <string.h>
26
27 #include "windef.h"
28 #include "winbase.h"
29 #include "wingdi.h"
30 #include "winuser.h"
31 #include "winhelp.h"
32
33 #include "wine/debug.h"
34
35 WINE_DEFAULT_DEBUG_CHANNEL(winhelp);
36
37 static inline unsigned short GET_USHORT(const BYTE* buffer, unsigned i)
38 {
39     return (BYTE)buffer[i] + 0x100 * (BYTE)buffer[i + 1];
40 }
41
42 static inline short GET_SHORT(const BYTE* buffer, unsigned i)
43 {
44     return (BYTE)buffer[i] + 0x100 * (signed char)buffer[i+1];
45 }
46
47 static inline unsigned GET_UINT(const BYTE* buffer, unsigned i)
48 {
49     return GET_USHORT(buffer, i) + 0x10000 * GET_USHORT(buffer, i + 2);
50 }
51
52 static HLPFILE *first_hlpfile = 0;
53
54 static BOOL  HLPFILE_DoReadHlpFile(HLPFILE*, LPCSTR);
55 static BOOL  HLPFILE_ReadFileToBuffer(HLPFILE*, HFILE);
56 static BOOL  HLPFILE_FindSubFile(HLPFILE*, LPCSTR, BYTE**, BYTE**);
57 static BOOL  HLPFILE_SystemCommands(HLPFILE*);
58 static INT   HLPFILE_UncompressedLZ77_Size(BYTE *ptr, BYTE *end);
59 static BYTE* HLPFILE_UncompressLZ77(BYTE *ptr, BYTE *end, BYTE *newptr);
60 static BOOL  HLPFILE_UncompressLZ77_Phrases(HLPFILE*);
61 static BOOL  HLPFILE_Uncompress_Phrases40(HLPFILE*);
62 static BOOL  HLPFILE_Uncompress_Topic(HLPFILE*);
63 static BOOL  HLPFILE_GetContext(HLPFILE*);
64 static BOOL  HLPFILE_GetKeywords(HLPFILE*);
65 static BOOL  HLPFILE_GetMap(HLPFILE*);
66 static BOOL  HLPFILE_AddPage(HLPFILE*, BYTE*, BYTE*, unsigned, unsigned);
67 static BOOL  HLPFILE_SkipParagraph(HLPFILE*, BYTE *, BYTE*, unsigned*);
68 static void  HLPFILE_Uncompress2(HLPFILE*, const BYTE*, const BYTE*, BYTE*, const BYTE*);
69 static BOOL  HLPFILE_Uncompress3(HLPFILE*, char*, const char*, const BYTE*, const BYTE*);
70 static void  HLPFILE_UncompressRLE(const BYTE* src, const BYTE* end, BYTE* dst, unsigned dstsz);
71 static BOOL  HLPFILE_ReadFont(HLPFILE* hlpfile);
72
73 /***********************************************************************
74  *
75  *           HLPFILE_PageByNumber
76  */
77 static HLPFILE_PAGE *HLPFILE_PageByNumber(HLPFILE* hlpfile, UINT wNum)
78 {
79     HLPFILE_PAGE *page;
80     UINT          temp = wNum;
81
82     WINE_TRACE("<%s>[%u]\n", hlpfile->lpszPath, wNum);
83
84     for (page = hlpfile->first_page; page && temp; page = page->next) temp--;
85     if (!page)
86         WINE_ERR("Page of number %u not found in file %s\n", wNum, hlpfile->lpszPath);
87     return page;
88 }
89
90 /******************************************************************
91  *              HLPFILE_PageByOffset
92  *
93  *
94  */
95 HLPFILE_PAGE *HLPFILE_PageByOffset(HLPFILE* hlpfile, LONG offset, ULONG* relative)
96 {
97     HLPFILE_PAGE*       page;
98     HLPFILE_PAGE*       found;
99
100     if (!hlpfile) return 0;
101
102     WINE_TRACE("<%s>[%x]\n", hlpfile->lpszPath, offset);
103
104     if (offset == 0xFFFFFFFF) return NULL;
105     page = NULL;
106
107     for (found = NULL, page = hlpfile->first_page; page; page = page->next)
108     {
109         if (page->offset <= offset && (!found || found->offset < page->offset))
110         {
111             *relative = offset - page->offset;
112             found = page;
113         }
114     }
115     if (!found)
116         WINE_ERR("Page of offset %u not found in file %s\n",
117                  offset, hlpfile->lpszPath);
118     return found;
119 }
120
121 /**************************************************************************
122  * comp_PageByHash
123  *
124  * HLPFILE_BPTreeCompare function for '|CONTEXT' B+ tree file
125  *
126  */
127 static int comp_PageByHash(void *p, const void *key,
128                            int leaf, void** next)
129 {
130     LONG lKey = (LONG_PTR)key;
131     LONG lTest = (INT)GET_UINT(p, 0);
132
133     *next = (char *)p+(leaf?8:6);
134     WINE_TRACE("Comparing '%d' with '%d'\n", lKey, lTest);
135     if (lTest < lKey) return -1;
136     if (lTest > lKey) return 1;
137     return 0;
138 }
139
140 /***********************************************************************
141  *
142  *           HLPFILE_PageByHash
143  */
144 HLPFILE_PAGE *HLPFILE_PageByHash(HLPFILE* hlpfile, LONG lHash, ULONG* relative)
145 {
146     BYTE *ptr;
147
148     if (!hlpfile) return NULL;
149     if (!lHash) return HLPFILE_Contents(hlpfile, relative);
150
151     WINE_TRACE("<%s>[%x]\n", hlpfile->lpszPath, lHash);
152
153     /* For win 3.0 files hash values are really page numbers */
154     if (hlpfile->version <= 16)
155     {
156         *relative = 0;
157         return HLPFILE_PageByNumber(hlpfile, lHash);
158     }
159
160     ptr = HLPFILE_BPTreeSearch(hlpfile->Context, LongToPtr(lHash), comp_PageByHash);
161     if (!ptr)
162     {
163         WINE_ERR("Page of hash %x not found in file %s\n", lHash, hlpfile->lpszPath);
164         return NULL;
165     }
166
167     return HLPFILE_PageByOffset(hlpfile, GET_UINT(ptr, 4), relative);
168 }
169
170 /***********************************************************************
171  *
172  *           HLPFILE_PageByMap
173  */
174 HLPFILE_PAGE *HLPFILE_PageByMap(HLPFILE* hlpfile, LONG lMap, ULONG* relative)
175 {
176     unsigned int i;
177
178     if (!hlpfile) return 0;
179
180     WINE_TRACE("<%s>[%x]\n", hlpfile->lpszPath, lMap);
181
182     for (i = 0; i < hlpfile->wMapLen; i++)
183     {
184         if (hlpfile->Map[i].lMap == lMap)
185             return HLPFILE_PageByOffset(hlpfile, hlpfile->Map[i].offset, relative);
186     }
187
188     WINE_ERR("Page of Map %x not found in file %s\n", lMap, hlpfile->lpszPath);
189     return NULL;
190 }
191
192 /***********************************************************************
193  *
194  *           HLPFILE_Contents
195  */
196 HLPFILE_PAGE* HLPFILE_Contents(HLPFILE *hlpfile, ULONG* relative)
197 {
198     HLPFILE_PAGE*       page = NULL;
199
200     if (!hlpfile) return NULL;
201
202     page = HLPFILE_PageByOffset(hlpfile, hlpfile->contents_start, relative);
203     if (!page)
204     {
205         page = hlpfile->first_page;
206         *relative = 0;
207     }
208     return page;
209 }
210
211 /***********************************************************************
212  *
213  *           HLPFILE_Hash
214  */
215 LONG HLPFILE_Hash(LPCSTR lpszContext)
216 {
217     LONG lHash = 0;
218     CHAR c;
219
220     while ((c = *lpszContext++))
221     {
222         CHAR x = 0;
223         if (c >= 'A' && c <= 'Z') x = c - 'A' + 17;
224         if (c >= 'a' && c <= 'z') x = c - 'a' + 17;
225         if (c >= '1' && c <= '9') x = c - '0';
226         if (c == '0') x = 10;
227         if (c == '.') x = 12;
228         if (c == '_') x = 13;
229         if (x) lHash = lHash * 43 + x;
230     }
231     return lHash;
232 }
233
234 /***********************************************************************
235  *
236  *           HLPFILE_ReadHlpFile
237  */
238 HLPFILE *HLPFILE_ReadHlpFile(LPCSTR lpszPath)
239 {
240     HLPFILE*      hlpfile;
241
242     for (hlpfile = first_hlpfile; hlpfile; hlpfile = hlpfile->next)
243     {
244         if (!strcmp(lpszPath, hlpfile->lpszPath))
245         {
246             hlpfile->wRefCount++;
247             return hlpfile;
248         }
249     }
250
251     hlpfile = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
252                         sizeof(HLPFILE) + lstrlen(lpszPath) + 1);
253     if (!hlpfile) return 0;
254
255     hlpfile->lpszPath           = (char*)hlpfile + sizeof(HLPFILE);
256     hlpfile->contents_start     = 0xFFFFFFFF;
257     hlpfile->next               = first_hlpfile;
258     hlpfile->wRefCount          = 1;
259
260     strcpy(hlpfile->lpszPath, lpszPath);
261
262     first_hlpfile = hlpfile;
263     if (hlpfile->next) hlpfile->next->prev = hlpfile;
264
265     if (!HLPFILE_DoReadHlpFile(hlpfile, lpszPath))
266     {
267         HLPFILE_FreeHlpFile(hlpfile);
268         hlpfile = 0;
269     }
270
271     return hlpfile;
272 }
273
274 /***********************************************************************
275  *
276  *           HLPFILE_DoReadHlpFile
277  */
278 static BOOL HLPFILE_DoReadHlpFile(HLPFILE *hlpfile, LPCSTR lpszPath)
279 {
280     BOOL        ret;
281     HFILE       hFile;
282     OFSTRUCT    ofs;
283     BYTE*       buf;
284     DWORD       ref = 0x0C;
285     unsigned    index, old_index, offset, len, offs;
286
287     hFile = OpenFile(lpszPath, &ofs, OF_READ);
288     if (hFile == HFILE_ERROR) return FALSE;
289
290     ret = HLPFILE_ReadFileToBuffer(hlpfile, hFile);
291     _lclose(hFile);
292     if (!ret) return FALSE;
293
294     if (!HLPFILE_SystemCommands(hlpfile)) return FALSE;
295
296     /* load phrases support */
297     if (!HLPFILE_UncompressLZ77_Phrases(hlpfile))
298         HLPFILE_Uncompress_Phrases40(hlpfile);
299
300     if (!HLPFILE_Uncompress_Topic(hlpfile)) return FALSE;
301     if (!HLPFILE_ReadFont(hlpfile)) return FALSE;
302
303     buf = hlpfile->topic_map[0];
304     old_index = -1;
305     offs = 0;
306     do
307     {
308         BYTE*   end;
309
310         if (hlpfile->version <= 16)
311         {
312             index  = (ref - 0x0C) / hlpfile->dsize;
313             offset = (ref - 0x0C) % hlpfile->dsize;
314         }
315         else
316         {
317             index  = (ref - 0x0C) >> 14;
318             offset = (ref - 0x0C) & 0x3FFF;
319         }
320
321         if (hlpfile->version <= 16 && index != old_index && old_index != -1)
322         {
323             /* we jumped to the next block, adjust pointers */
324             ref -= 12;
325             offset -= 12;
326         }
327
328         WINE_TRACE("ref=%08x => [%u/%u]\n", ref, index, offset);
329
330         if (index >= hlpfile->topic_maplen) {WINE_WARN("maplen\n"); break;}
331         buf = hlpfile->topic_map[index] + offset;
332         if (buf + 0x15 >= hlpfile->topic_end) {WINE_WARN("extra\n"); break;}
333         end = min(buf + GET_UINT(buf, 0), hlpfile->topic_end);
334         if (index != old_index) {offs = 0; old_index = index;}
335
336         switch (buf[0x14])
337         {
338         case 0x02:
339             if (!HLPFILE_AddPage(hlpfile, buf, end, ref, index * 0x8000L + offs)) return FALSE;
340             break;
341
342         case 0x01:
343         case 0x20:
344         case 0x23:
345             if (!HLPFILE_SkipParagraph(hlpfile, buf, end, &len)) return FALSE;
346             offs += len;
347             break;
348
349         default:
350             WINE_ERR("buf[0x14] = %x\n", buf[0x14]);
351         }
352
353         if (hlpfile->version <= 16)
354         {
355             ref += GET_UINT(buf, 0xc);
356             if (GET_UINT(buf, 0xc) == 0)
357                 break;
358         }
359         else
360             ref = GET_UINT(buf, 0xc);
361     } while (ref != 0xffffffff);
362
363     HLPFILE_GetKeywords(hlpfile);
364     HLPFILE_GetMap(hlpfile);
365     if (hlpfile->version <= 16) return TRUE;
366     return HLPFILE_GetContext(hlpfile);
367 }
368
369 /***********************************************************************
370  *
371  *           HLPFILE_AddPage
372  */
373 static BOOL HLPFILE_AddPage(HLPFILE *hlpfile, BYTE *buf, BYTE *end, unsigned ref, unsigned offset)
374 {
375     HLPFILE_PAGE* page;
376     BYTE*         title;
377     UINT          titlesize, blocksize, datalen;
378     char*         ptr;
379     HLPFILE_MACRO*macro;
380
381     blocksize = GET_UINT(buf, 0);
382     datalen = GET_UINT(buf, 0x10);
383     title = buf + datalen;
384     if (title > end) {WINE_WARN("page2\n"); return FALSE;};
385
386     titlesize = GET_UINT(buf, 4);
387     page = HeapAlloc(GetProcessHeap(), 0, sizeof(HLPFILE_PAGE) + titlesize + 1);
388     if (!page) return FALSE;
389     page->lpszTitle = (char*)page + sizeof(HLPFILE_PAGE);
390
391     if (titlesize > blocksize - datalen)
392     {
393         /* need to decompress */
394         if (hlpfile->hasPhrases)
395             HLPFILE_Uncompress2(hlpfile, title, end, (BYTE*)page->lpszTitle, (BYTE*)page->lpszTitle + titlesize);
396         else if (hlpfile->hasPhrases40)
397             HLPFILE_Uncompress3(hlpfile, page->lpszTitle, page->lpszTitle + titlesize, title, end);
398         else
399         {
400             WINE_FIXME("Text size is too long, splitting\n");
401             titlesize = blocksize - datalen;
402             memcpy(page->lpszTitle, title, titlesize);
403         }
404     }
405     else
406         memcpy(page->lpszTitle, title, titlesize);
407
408     page->lpszTitle[titlesize] = '\0';
409
410     if (hlpfile->first_page)
411     {
412         hlpfile->last_page->next = page;
413         page->prev = hlpfile->last_page;
414         hlpfile->last_page = page;
415     }
416     else
417     {
418         hlpfile->first_page = page;
419         hlpfile->last_page = page;
420         page->prev = NULL;
421     }
422
423     page->file            = hlpfile;
424     page->next            = NULL;
425     page->first_macro     = NULL;
426     page->first_link      = NULL;
427     page->wNumber         = GET_UINT(buf, 0x21);
428     page->offset          = offset;
429     page->reference       = ref;
430
431     page->browse_bwd = GET_UINT(buf, 0x19);
432     page->browse_fwd = GET_UINT(buf, 0x1D);
433
434     WINE_TRACE("Added page[%d]: title='%s' %08x << %08x >> %08x\n",
435                page->wNumber, page->lpszTitle, 
436                page->browse_bwd, page->offset, page->browse_fwd);
437
438     /* now load macros */
439     ptr = page->lpszTitle + strlen(page->lpszTitle) + 1;
440     while (ptr < page->lpszTitle + titlesize)
441     {
442         unsigned len = strlen(ptr);
443         char*    macro_str;
444
445         WINE_TRACE("macro: %s\n", ptr);
446         macro = HeapAlloc(GetProcessHeap(), 0, sizeof(HLPFILE_MACRO) + len + 1);
447         macro->lpszMacro = macro_str = (char*)(macro + 1);
448         memcpy(macro_str, ptr, len + 1);
449         /* FIXME: shall we really link macro in reverse order ??
450          * may produce strange results when played at page opening
451          */
452         macro->next = page->first_macro;
453         page->first_macro = macro;
454         ptr += len + 1;
455     }
456
457     return TRUE;
458 }
459
460 static long fetch_long(BYTE** ptr)
461 {
462     long        ret;
463
464     if (*(*ptr) & 1)
465     {
466         ret = (*(unsigned long*)(*ptr) - 0x80000000L) / 2;
467         (*ptr) += 4;
468     }
469     else
470     {
471         ret = (*(unsigned short*)(*ptr) - 0x8000) / 2;
472         (*ptr) += 2;
473     }
474
475     return ret;
476 }
477
478 static unsigned long fetch_ulong(BYTE** ptr)
479 {
480     unsigned long        ret;
481
482     if (*(*ptr) & 1)
483     {
484         ret = *(unsigned long*)(*ptr) / 2;
485         (*ptr) += 4;
486     }
487     else
488     {
489         ret = *(unsigned short*)(*ptr) / 2;
490         (*ptr) += 2;
491     }
492     return ret;
493 }    
494
495 static short fetch_short(BYTE** ptr)
496 {
497     short       ret;
498
499     if (*(*ptr) & 1)
500     {
501         ret = (*(unsigned short*)(*ptr) - 0x8000) / 2;
502         (*ptr) += 2;
503     }
504     else
505     {
506         ret = (*(unsigned char*)(*ptr) - 0x80) / 2;
507         (*ptr)++;
508     }
509     return ret;
510 }
511
512 static unsigned short fetch_ushort(BYTE** ptr)
513 {
514     unsigned short ret;
515
516     if (*(*ptr) & 1)
517     {
518         ret = *(unsigned short*)(*ptr) / 2;
519         (*ptr) += 2;
520     }
521     else
522     {
523         ret = *(unsigned char*)(*ptr) / 2;
524         (*ptr)++;
525     }
526     return ret;
527 }
528
529 /***********************************************************************
530  *
531  *           HLPFILE_SkipParagraph
532  */
533 static BOOL HLPFILE_SkipParagraph(HLPFILE *hlpfile, BYTE *buf, BYTE *end, unsigned* len)
534 {
535     BYTE              *tmp;
536
537     if (!hlpfile->first_page) {WINE_WARN("no page\n"); return FALSE;};
538     if (buf + 0x19 > end) {WINE_WARN("header too small\n"); return FALSE;};
539
540     tmp = buf + 0x15;
541     if (buf[0x14] == 0x20 || buf[0x14] == 0x23)
542     {
543         fetch_long(&tmp);
544         *len = fetch_ushort(&tmp);
545     }
546     else *len = end-buf-15;
547
548     return TRUE;
549 }
550
551 /******************************************************************
552  *              HLPFILE_DecompressGfx
553  *
554  * Decompress the data part of a bitmap or a metafile
555  */
556 static BYTE*    HLPFILE_DecompressGfx(BYTE* src, unsigned csz, unsigned sz, BYTE packing)
557 {
558     BYTE*       dst;
559     BYTE*       tmp;
560     unsigned    sz77;
561
562     WINE_TRACE("Unpacking (%d) from %u bytes to %u bytes\n", packing, csz, sz);
563
564     switch (packing)
565     {
566     case 0: /* uncompressed */
567         if (sz != csz)
568             WINE_WARN("Bogus gfx sizes (uncompressed): %u / %u\n", sz, csz);
569         dst = src;
570         break;
571     case 1: /* RunLen */
572         dst = HeapAlloc(GetProcessHeap(), 0, sz);
573         if (!dst) return NULL;
574         HLPFILE_UncompressRLE(src, src + csz, dst, sz);
575         break;
576     case 2: /* LZ77 */
577         sz77 = HLPFILE_UncompressedLZ77_Size(src, src + csz);
578         dst = HeapAlloc(GetProcessHeap(), 0, sz77);
579         if (!dst) return NULL;
580         HLPFILE_UncompressLZ77(src, src + csz, dst);
581         if (sz77 != sz)
582             WINE_WARN("Bogus gfx sizes (LZ77): %u / %u\n", sz77, sz);
583         break;
584     case 3: /* LZ77 then RLE */
585         sz77 = HLPFILE_UncompressedLZ77_Size(src, src + csz);
586         tmp = HeapAlloc(GetProcessHeap(), 0, sz77);
587         if (!tmp) return FALSE;
588         HLPFILE_UncompressLZ77(src, src + csz, tmp);
589         dst = HeapAlloc(GetProcessHeap(), 0, sz);
590         if (!dst)
591         {
592             HeapFree(GetProcessHeap(), 0, tmp);
593             return FALSE;
594         }
595         HLPFILE_UncompressRLE(tmp, tmp + sz77, dst, sz);
596         HeapFree(GetProcessHeap(), 0, tmp);
597         break;
598     default:
599         WINE_FIXME("Unsupported packing %u\n", packing);
600         return NULL;
601     }
602     return dst;
603 }
604
605 static BOOL HLPFILE_RtfAddRawString(struct RtfData* rd, const char* str, size_t sz)
606 {
607     if (rd->ptr + sz >= rd->data + rd->allocated)
608     {
609         char*   new = HeapReAlloc(GetProcessHeap(), 0, rd->data, rd->allocated *= 2);
610         if (!new) return FALSE;
611         rd->ptr = new + (rd->ptr - rd->data);
612         rd->data = new;
613     }
614     memcpy(rd->ptr, str, sz);
615     rd->ptr += sz;
616
617     return TRUE;
618 }
619
620 static BOOL HLPFILE_RtfAddControl(struct RtfData* rd, const char* str)
621 {
622     if (*str == '\\' || *str == '{') rd->in_text = FALSE;
623     else if (*str == '}') rd->in_text = TRUE;
624     return HLPFILE_RtfAddRawString(rd, str, strlen(str));
625 }
626
627 static BOOL HLPFILE_RtfAddText(struct RtfData* rd, const char* str)
628 {
629     const char* p;
630     const char* last;
631     const char* replace;
632     unsigned    rlen;
633
634     if (!rd->in_text)
635     {
636         if (!HLPFILE_RtfAddRawString(rd, " ", 1)) return FALSE;
637         rd->in_text = TRUE;
638     }
639     for (last = p = str; *p; p++)
640     {
641         if (*p < 0) /* escape non ASCII chars */
642         {
643             static char         xx[8];
644             rlen = sprintf(xx, "\\'%x", *(const BYTE*)p);
645             replace = xx;
646         }
647         else switch (*p)
648         {
649         case '{':  rlen = 2; replace = "\\{";  break;
650         case '}':  rlen = 2; replace = "\\}";  break;
651         case '\\': rlen = 2; replace = "\\\\"; break;
652         default:   continue;
653         }
654         if ((p != last && !HLPFILE_RtfAddRawString(rd, last, p - last)) ||
655             !HLPFILE_RtfAddRawString(rd, replace, rlen)) return FALSE;
656         last = p + 1;
657     }
658     return HLPFILE_RtfAddRawString(rd, last, p - last);
659 }
660
661 /******************************************************************
662  *              RtfAddHexBytes
663  *
664  */
665 static BOOL HLPFILE_RtfAddHexBytes(struct RtfData* rd, const void* _ptr, unsigned sz)
666 {
667     char        tmp[512];
668     unsigned    i, step;
669     const BYTE* ptr = _ptr;
670     static const char* _2hex = "0123456789abcdef";
671
672     if (!rd->in_text)
673     {
674         if (!HLPFILE_RtfAddRawString(rd, " ", 1)) return FALSE;
675         rd->in_text = TRUE;
676     }
677     for (; sz; sz -= step)
678     {
679         step = min(256, sz);
680         for (i = 0; i < step; i++)
681         {
682             tmp[2 * i + 0] = _2hex[*ptr >> 4];
683             tmp[2 * i + 1] = _2hex[*ptr++ & 0xF];
684         }
685         if (!HLPFILE_RtfAddRawString(rd, tmp, 2 * step)) return FALSE;
686     }
687     return TRUE;
688 }
689
690 /******************************************************************
691  *             HLPFILE_RtfAddTransparentBitmap
692  *
693  * We'll transform a transparent bitmap into an metafile that
694  * we then transform into RTF
695  */
696 static BOOL HLPFILE_RtfAddTransparentBitmap(struct RtfData* rd, const BITMAPINFO* bi,
697                                             const void* pict, unsigned nc)
698 {
699     HDC                 hdc, hdcMask, hdcMem, hdcEMF;
700     HBITMAP             hbm, hbmMask, hbmOldMask, hbmOldMem;
701     HENHMETAFILE        hEMF;
702     BOOL                ret = FALSE;
703     void*               data;
704     UINT                sz;
705
706     hbm = CreateDIBitmap(hdc = GetDC(0), &bi->bmiHeader,
707                          CBM_INIT, pict, bi, DIB_RGB_COLORS);
708
709     hdcMem = CreateCompatibleDC(hdc);
710     hbmOldMem = SelectObject(hdcMem, hbm);
711
712     /* create the mask bitmap from the main bitmap */
713     hdcMask = CreateCompatibleDC(hdc);
714     hbmMask = CreateBitmap(bi->bmiHeader.biWidth, bi->bmiHeader.biHeight, 1, 1, NULL);
715     hbmOldMask = SelectObject(hdcMask, hbmMask);
716     SetBkColor(hdcMem,
717                RGB(bi->bmiColors[nc - 1].rgbRed,
718                    bi->bmiColors[nc - 1].rgbGreen,
719                    bi->bmiColors[nc - 1].rgbBlue));
720     BitBlt(hdcMask, 0, 0, bi->bmiHeader.biWidth, bi->bmiHeader.biHeight, hdcMem, 0, 0, SRCCOPY);
721
722     /* sets to RGB(0,0,0) the transparent bits in main bitmap */
723     SetBkColor(hdcMem, RGB(0,0,0));
724     SetTextColor(hdcMem, RGB(255,255,255));
725     BitBlt(hdcMem, 0, 0, bi->bmiHeader.biWidth, bi->bmiHeader.biHeight, hdcMask, 0, 0, SRCAND);
726
727     SelectObject(hdcMask, hbmOldMask);
728     DeleteDC(hdcMask);
729
730     SelectObject(hdcMem, hbmOldMem);
731     DeleteDC(hdcMem);
732
733     /* we create the bitmap on the fly */
734     hdcEMF = CreateEnhMetaFile(NULL, NULL, NULL, NULL);
735     hdcMem = CreateCompatibleDC(hdcEMF);
736
737     /* sets to RGB(0,0,0) the transparent bits in final bitmap */
738     hbmOldMem = SelectObject(hdcMem, hbmMask);
739     SetBkColor(hdcEMF, RGB(255, 255, 255));
740     SetTextColor(hdcEMF, RGB(0, 0, 0));
741     BitBlt(hdcEMF, 0, 0, bi->bmiHeader.biWidth, bi->bmiHeader.biHeight, hdcMem, 0, 0, SRCAND);
742
743     /* and copy the remaining bits of main bitmap */
744     SelectObject(hdcMem, hbm);
745     BitBlt(hdcEMF, 0, 0, bi->bmiHeader.biWidth, bi->bmiHeader.biHeight, hdcMem, 0, 0, SRCPAINT);
746     SelectObject(hdcMem, hbmOldMem);
747     DeleteDC(hdcMem);
748
749     /* do the cleanup */
750     ReleaseDC(0, hdc);
751     DeleteObject(hbmMask);
752     DeleteObject(hbm);
753
754     hEMF = CloseEnhMetaFile(hdcEMF);
755
756     /* generate rtf stream */
757     sz = GetEnhMetaFileBits(hEMF, 0, NULL);
758     if (sz && (data = HeapAlloc(GetProcessHeap(), 0, sz)))
759     {
760         if (sz == GetEnhMetaFileBits(hEMF, sz, data))
761         {
762             ret = HLPFILE_RtfAddControl(rd, "{\\pict\\emfblip") &&
763                 HLPFILE_RtfAddHexBytes(rd, data, sz) &&
764                 HLPFILE_RtfAddControl(rd, "}");
765         }
766         HeapFree(GetProcessHeap(), 0, data);
767     }
768     DeleteEnhMetaFile(hEMF);
769
770     return ret;
771 }
772
773 /******************************************************************
774  *              HLPFILE_RtfAddBitmap
775  *
776  */
777 static BOOL HLPFILE_RtfAddBitmap(struct RtfData* rd, BYTE* beg, BYTE type, BYTE pack)
778 {
779     BYTE*               ptr;
780     BYTE*               pict_beg;
781     BITMAPINFO*         bi;
782     unsigned long       off, csz;
783     unsigned            nc = 0;
784     BOOL                clrImportant = FALSE;
785     BOOL                ret = FALSE;
786     char                tmp[256];
787
788     bi = HeapAlloc(GetProcessHeap(), 0, sizeof(*bi));
789     if (!bi) return FALSE;
790
791     ptr = beg + 2; /* for type and pack */
792
793     bi->bmiHeader.biSize          = sizeof(bi->bmiHeader);
794     bi->bmiHeader.biXPelsPerMeter = fetch_ulong(&ptr);
795     bi->bmiHeader.biYPelsPerMeter = fetch_ulong(&ptr);
796     bi->bmiHeader.biPlanes        = fetch_ushort(&ptr);
797     bi->bmiHeader.biBitCount      = fetch_ushort(&ptr);
798     bi->bmiHeader.biWidth         = fetch_ulong(&ptr);
799     bi->bmiHeader.biHeight        = fetch_ulong(&ptr);
800     bi->bmiHeader.biClrUsed       = fetch_ulong(&ptr);
801     clrImportant  = fetch_ulong(&ptr);
802     bi->bmiHeader.biClrImportant  = (clrImportant > 1) ? clrImportant : 0;
803     bi->bmiHeader.biCompression   = BI_RGB;
804     if (bi->bmiHeader.biBitCount > 32) WINE_FIXME("Unknown bit count %u\n", bi->bmiHeader.biBitCount);
805     if (bi->bmiHeader.biPlanes != 1) WINE_FIXME("Unsupported planes %u\n", bi->bmiHeader.biPlanes);
806     bi->bmiHeader.biSizeImage = (((bi->bmiHeader.biWidth * bi->bmiHeader.biBitCount + 31) & ~31) / 8) * bi->bmiHeader.biHeight;
807     WINE_TRACE("planes=%d bc=%d size=(%d,%d)\n",
808                bi->bmiHeader.biPlanes, bi->bmiHeader.biBitCount,
809                bi->bmiHeader.biWidth, bi->bmiHeader.biHeight);
810
811     csz = fetch_ulong(&ptr);
812     fetch_ulong(&ptr); /* hotspot size */
813
814     off = GET_UINT(ptr, 0);     ptr += 4;
815     /* GET_UINT(ptr, 0); hotspot offset */ ptr += 4;
816
817     /* now read palette info */
818     if (type == 0x06)
819     {
820         unsigned i;
821
822         nc = bi->bmiHeader.biClrUsed;
823         /* not quite right, especially for bitfields type of compression */
824         if (!nc && bi->bmiHeader.biBitCount <= 8)
825             nc = 1 << bi->bmiHeader.biBitCount;
826
827         bi = HeapReAlloc(GetProcessHeap(), 0, bi, sizeof(*bi) + nc * sizeof(RGBQUAD));
828         if (!bi) return FALSE;
829         for (i = 0; i < nc; i++)
830         {
831             bi->bmiColors[i].rgbBlue     = ptr[0];
832             bi->bmiColors[i].rgbGreen    = ptr[1];
833             bi->bmiColors[i].rgbRed      = ptr[2];
834             bi->bmiColors[i].rgbReserved = 0;
835             ptr += 4;
836         }
837     }
838     pict_beg = HLPFILE_DecompressGfx(beg + off, csz, bi->bmiHeader.biSizeImage, pack);
839
840     if (clrImportant == 1 && nc > 0)
841     {
842         ret = HLPFILE_RtfAddTransparentBitmap(rd, bi, pict_beg, nc);
843         goto done;
844     }
845     if (!HLPFILE_RtfAddControl(rd, "{\\pict")) goto done;
846     if (type == 0x06)
847     {
848         sprintf(tmp, "\\dibitmap0\\picw%d\\pich%d",
849                 bi->bmiHeader.biWidth, bi->bmiHeader.biHeight);
850         if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
851         if (!HLPFILE_RtfAddHexBytes(rd, bi, sizeof(*bi) + nc * sizeof(RGBQUAD))) goto done;
852     }
853     else
854     {
855         sprintf(tmp, "\\wbitmap0\\wbmbitspixel%d\\wbmplanes%d\\picw%d\\pich%d",
856                 bi->bmiHeader.biBitCount, bi->bmiHeader.biPlanes,
857                 bi->bmiHeader.biWidth, bi->bmiHeader.biHeight);
858         if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
859     }
860     if (!HLPFILE_RtfAddHexBytes(rd, pict_beg, bi->bmiHeader.biSizeImage)) goto done;
861     if (!HLPFILE_RtfAddControl(rd, "}")) goto done;
862
863     ret = TRUE;
864 done:
865     HeapFree(GetProcessHeap(), 0, bi);
866     if (pict_beg != beg + off) HeapFree(GetProcessHeap(), 0, pict_beg);
867
868     return ret;
869 }
870
871 /******************************************************************
872  *              HLPFILE_RtfAddMetaFile
873  *
874  */
875 static BOOL     HLPFILE_RtfAddMetaFile(struct RtfData* rd, BYTE* beg, BYTE pack)
876 {
877     BYTE*               ptr;
878     unsigned long       size, csize;
879     unsigned long       off, hsoff;
880     BYTE*               bits;
881     char                tmp[256];
882     unsigned            mm;
883     BOOL                ret;
884
885     WINE_TRACE("Loading metafile\n");
886
887     ptr = beg + 2; /* for type and pack */
888
889     mm = fetch_ushort(&ptr); /* mapping mode */
890     sprintf(tmp, "{\\pict\\wmetafile%d\\picw%d\\pich%d",
891             mm, GET_USHORT(ptr, 0), GET_USHORT(ptr, 2));
892     if (!HLPFILE_RtfAddControl(rd, tmp)) return FALSE;
893     ptr += 4;
894
895     size = fetch_ulong(&ptr); /* decompressed size */
896     csize = fetch_ulong(&ptr); /* compressed size */
897     fetch_ulong(&ptr); /* hotspot size */
898     off = GET_UINT(ptr, 0);
899     hsoff = GET_UINT(ptr, 4);
900     ptr += 8;
901
902     WINE_TRACE("sz=%lu csz=%lu offs=%lu/%u,%lu\n",
903                size, csize, off, ptr - beg, hsoff);
904
905     bits = HLPFILE_DecompressGfx(beg + off, csize, size, pack);
906     if (!bits) return FALSE;
907
908     ret = HLPFILE_RtfAddHexBytes(rd, bits, size) &&
909         HLPFILE_RtfAddControl(rd, "}");
910
911     if (bits != beg + off) HeapFree(GetProcessHeap(), 0, bits);
912
913     return ret;
914 }
915
916 /******************************************************************
917  *              HLPFILE_RtfAddGfxByAddr
918  *
919  */
920 static  BOOL    HLPFILE_RtfAddGfxByAddr(struct RtfData* rd, HLPFILE *hlpfile,
921                                         BYTE* ref, unsigned long size)
922 {
923     unsigned    i, numpict;
924
925     numpict = GET_USHORT(ref, 2);
926     WINE_TRACE("Got picture magic=%04x #=%d\n", GET_USHORT(ref, 0), numpict);
927
928     for (i = 0; i < numpict; i++)
929     {
930         BYTE*   beg;
931         BYTE*   ptr;
932         BYTE    type, pack;
933
934         WINE_TRACE("Offset[%d] = %x\n", i, GET_UINT(ref, (1 + i) * 4));
935         beg = ptr = ref + GET_UINT(ref, (1 + i) * 4);
936
937         type = *ptr++;
938         pack = *ptr++;
939
940         switch (type)
941         {
942         case 5: /* device dependent bmp */
943         case 6: /* device independent bmp */
944             HLPFILE_RtfAddBitmap(rd, beg, type, pack);
945             break;
946         case 8:
947             HLPFILE_RtfAddMetaFile(rd, beg, pack);
948             break;
949         default: WINE_FIXME("Unknown type %u\n", type); return FALSE;
950         }
951
952         /* FIXME: hotspots */
953
954         /* FIXME: implement support for multiple picture format */
955         if (numpict != 1) WINE_FIXME("Supporting only one bitmap format per logical bitmap (for now). Using first format\n");
956         break;
957     }
958     return TRUE;
959 }
960
961 /******************************************************************
962  *              HLPFILE_RtfAddGfxByIndex
963  *
964  *
965  */
966 static  BOOL    HLPFILE_RtfAddGfxByIndex(struct RtfData* rd, HLPFILE *hlpfile,
967                                          unsigned index)
968 {
969     char        tmp[16];
970     BYTE        *ref, *end;
971
972     WINE_TRACE("Loading picture #%d\n", index);
973
974     sprintf(tmp, "|bm%u", index);
975
976     if (!HLPFILE_FindSubFile(hlpfile, tmp, &ref, &end)) {WINE_WARN("no sub file\n"); return FALSE;}
977
978     ref += 9;
979     return HLPFILE_RtfAddGfxByAddr(rd, hlpfile, ref, end - ref);
980 }
981
982 /******************************************************************
983  *              HLPFILE_AllocLink
984  *
985  *
986  */
987 static HLPFILE_LINK*       HLPFILE_AllocLink(struct RtfData* rd, int cookie,
988                                              const char* str, unsigned len, LONG hash,
989                                              unsigned clrChange, unsigned wnd)
990 {
991     HLPFILE_LINK*  link;
992     char*          link_str;
993
994     /* FIXME: should build a string table for the attributes.link.lpszPath
995      * they are reallocated for each link
996      */
997     if (len == -1) len = strlen(str);
998     link = HeapAlloc(GetProcessHeap(), 0, sizeof(HLPFILE_LINK) + len + 1);
999     if (!link) return NULL;
1000
1001     link->cookie     = cookie;
1002     link->string     = link_str = (char*)(link + 1);
1003     memcpy(link_str, str, len);
1004     link_str[len] = '\0';
1005     link->hash       = hash;
1006     link->bClrChange = clrChange ? 1 : 0;
1007     link->window     = wnd;
1008     link->next       = rd->first_link;
1009     rd->first_link   = link;
1010     link->cpMin      = rd->char_pos;
1011     link->cpMax      = 0;
1012     rd->force_color  = clrChange;
1013     if (rd->current_link) WINE_FIXME("Pending link\n");
1014     rd->current_link = link;
1015
1016     WINE_TRACE("Link[%d] to %s@%08x:%d\n",
1017                link->cookie, link->string, link->hash, link->window);
1018     return link;
1019 }
1020
1021 unsigned HLPFILE_HalfPointsToTwips(unsigned pts)
1022 {
1023     static unsigned logPxY;
1024     if (!logPxY)
1025     {
1026         HDC hdc = GetDC(NULL);
1027         logPxY = GetDeviceCaps(hdc, LOGPIXELSY);
1028         ReleaseDC(NULL, hdc);
1029     }
1030     return MulDiv(pts, 72 * 10, logPxY);
1031 }
1032
1033 /***********************************************************************
1034  *
1035  *           HLPFILE_BrowseParagraph
1036  */
1037 static BOOL HLPFILE_BrowseParagraph(HLPFILE_PAGE* page, struct RtfData* rd,
1038                                     BYTE *buf, BYTE* end, unsigned* parlen)
1039 {
1040     UINT               textsize;
1041     BYTE              *format, *format_end;
1042     char              *text, *text_base, *text_end;
1043     long               size, blocksize, datalen;
1044     unsigned short     bits;
1045     unsigned           nc, ncol = 1;
1046     short              table_width;
1047     BOOL               in_table = FALSE;
1048     char               tmp[256];
1049     BOOL               ret = FALSE;
1050
1051     if (buf + 0x19 > end) {WINE_WARN("header too small\n"); return FALSE;};
1052
1053     *parlen = 0;
1054     blocksize = GET_UINT(buf, 0);
1055     size = GET_UINT(buf, 0x4);
1056     datalen = GET_UINT(buf, 0x10);
1057     text = text_base = HeapAlloc(GetProcessHeap(), 0, size);
1058     if (!text) return FALSE;
1059     if (size > blocksize - datalen)
1060     {
1061         /* need to decompress */
1062         if (page->file->hasPhrases)
1063             HLPFILE_Uncompress2(page->file, buf + datalen, end, (BYTE*)text, (BYTE*)text + size);
1064         else if (page->file->hasPhrases40)
1065             HLPFILE_Uncompress3(page->file, text, text + size, buf + datalen, end);
1066         else
1067         {
1068             WINE_FIXME("Text size is too long, splitting\n");
1069             size = blocksize - datalen;
1070             memcpy(text, buf + datalen, size);
1071         }
1072     }
1073     else
1074         memcpy(text, buf + datalen, size);
1075
1076     text_end = text + size;
1077
1078     format = buf + 0x15;
1079     format_end = buf + GET_UINT(buf, 0x10);
1080
1081     if (buf[0x14] == 0x20 || buf[0x14] == 0x23)
1082     {
1083         fetch_long(&format);
1084         *parlen = fetch_ushort(&format);
1085     }
1086
1087     if (buf[0x14] == 0x23)
1088     {
1089         char    type;
1090
1091         in_table = TRUE;
1092         ncol = *format++;
1093
1094         if (!HLPFILE_RtfAddControl(rd, "\\trowd")) goto done;
1095         type = *format++;
1096         if (type == 0 || type == 2)
1097         {
1098             table_width = GET_SHORT(format, 0);
1099             format += 2;
1100         }
1101         else
1102             table_width = 32767;
1103         WINE_TRACE("New table: cols=%d type=%x width=%d\n",
1104                    ncol, type, table_width);
1105         if (ncol > 1)
1106         {
1107             int     pos;
1108             sprintf(tmp, "\\trgaph%d\\trleft%d",
1109                     HLPFILE_HalfPointsToTwips(MulDiv(GET_SHORT(format, 6), table_width, 32767)),
1110                     HLPFILE_HalfPointsToTwips(MulDiv(GET_SHORT(format, 0), table_width, 32767)));
1111             if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
1112             pos = HLPFILE_HalfPointsToTwips(MulDiv(GET_SHORT(format, 6) / 2, table_width, 32767));
1113             for (nc = 0; nc < ncol; nc++)
1114             {
1115                 WINE_TRACE("column(%d/%d) gap=%d width=%d\n",
1116                            nc, ncol, GET_SHORT(format, nc*4),
1117                            GET_SHORT(format, nc*4+2));
1118                 pos += GET_SHORT(format, nc * 4) + GET_SHORT(format, nc * 4 + 2);
1119                 sprintf(tmp, "\\cellx%d",
1120                         HLPFILE_HalfPointsToTwips(MulDiv(pos, table_width, 32767)));
1121                 if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
1122             }
1123         }
1124         else
1125         {
1126             WINE_TRACE("column(0/%d) gap=%d width=%d\n",
1127                        ncol, GET_SHORT(format, 0), GET_SHORT(format, 2));
1128             sprintf(tmp, "\\trleft%d\\cellx%d ",
1129                     HLPFILE_HalfPointsToTwips(MulDiv(GET_SHORT(format, 0), table_width, 32767)),
1130                     HLPFILE_HalfPointsToTwips(MulDiv(GET_SHORT(format, 0) + GET_SHORT(format, 2),
1131                                       table_width, 32767)));
1132             if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
1133         }
1134         format += ncol * 4;
1135     }
1136
1137     for (nc = 0; nc < ncol; /**/)
1138     {
1139         WINE_TRACE("looking for format at offset %lu in column %d\n", (SIZE_T)(format - (buf + 0x15)), nc);
1140         if (!HLPFILE_RtfAddControl(rd, "\\pard")) goto done;
1141         if (in_table)
1142         {
1143             nc = GET_SHORT(format, 0);
1144             if (nc == -1) break;
1145             format += 5;
1146             if (!HLPFILE_RtfAddControl(rd, "\\intbl")) goto done;
1147         }
1148         else nc++;
1149         if (buf[0x14] == 0x01)
1150             format += 6;
1151         else
1152             format += 4;
1153         bits = GET_USHORT(format, 0); format += 2;
1154         if (bits & 0x0001) fetch_long(&format);
1155         if (bits & 0x0002)
1156         {
1157             sprintf(tmp, "\\sb%d", HLPFILE_HalfPointsToTwips(fetch_short(&format)));
1158             if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
1159         }
1160         if (bits & 0x0004)
1161         {
1162             sprintf(tmp, "\\sa%d", HLPFILE_HalfPointsToTwips(fetch_short(&format)));
1163             if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
1164         }
1165         if (bits & 0x0008)
1166         {
1167             sprintf(tmp, "\\sl%d", HLPFILE_HalfPointsToTwips(fetch_short(&format)));
1168             if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
1169         }
1170         if (bits & 0x0010)
1171         {
1172             sprintf(tmp, "\\li%d", HLPFILE_HalfPointsToTwips(fetch_short(&format)));
1173             if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
1174         }
1175         if (bits & 0x0020)
1176         {
1177             sprintf(tmp, "\\ri%d", HLPFILE_HalfPointsToTwips(fetch_short(&format)));
1178             if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
1179         }
1180         if (bits & 0x0040)
1181         {
1182             sprintf(tmp, "\\fi%d", HLPFILE_HalfPointsToTwips(fetch_short(&format)));
1183             if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
1184         }
1185         if (bits & 0x0100)
1186         {
1187             BYTE        brdr = *format++;
1188             short       w;
1189
1190             if (brdr & 0x01 && !HLPFILE_RtfAddControl(rd, "\\box")) goto done;
1191             if (brdr & 0x02 && !HLPFILE_RtfAddControl(rd, "\\brdrt")) goto done;
1192             if (brdr & 0x04 && !HLPFILE_RtfAddControl(rd, "\\brdrl")) goto done;
1193             if (brdr & 0x08 && !HLPFILE_RtfAddControl(rd, "\\brdrb")) goto done;
1194             if (brdr & 0x10 && !HLPFILE_RtfAddControl(rd, "\\brdrr")) goto done;
1195             if (brdr & 0x20 && !HLPFILE_RtfAddControl(rd, "\\brdrth")) goto done;
1196             if (!(brdr & 0x20) && !HLPFILE_RtfAddControl(rd, "\\brdrs")) goto done;
1197             if (brdr & 0x40 && !HLPFILE_RtfAddControl(rd, "\\brdrdb")) goto done;
1198             /* 0x80: unknown */
1199
1200             w = GET_SHORT(format, 0); format += 2;
1201             if (w)
1202             {
1203                 sprintf(tmp, "\\brdrw%d", HLPFILE_HalfPointsToTwips(w));
1204                 if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
1205             }
1206         }
1207         if (bits & 0x0200)
1208         {
1209             int                 i, ntab = fetch_short(&format);
1210             unsigned            tab, ts;
1211             const char*         kind;
1212
1213             for (i = 0; i < ntab; i++)
1214             {
1215                 tab = fetch_ushort(&format);
1216                 ts = (tab & 0x4000) ? fetch_ushort(&format) : 0 /* left */;
1217                 switch (ts)
1218                 {
1219                 default: WINE_FIXME("Unknown tab style %x\n", ts);
1220                 /* fall through */
1221                 case 0: kind = ""; break;
1222                 case 1: kind = "\\tqr"; break;
1223                 case 2: kind = "\\tqc"; break;
1224                 }
1225                 /* FIXME: do kind */
1226                 sprintf(tmp, "%s\\tx%d",
1227                         kind, HLPFILE_HalfPointsToTwips(tab & 0x3FFF));
1228                 if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
1229             }
1230         }
1231         switch (bits & 0xc00)
1232         {
1233         default: WINE_FIXME("Unsupported alignment 0xC00\n"); break;
1234         case 0: if (!HLPFILE_RtfAddControl(rd, "\\ql")) goto done; break;
1235         case 0x400: if (!HLPFILE_RtfAddControl(rd, "\\qr")) goto done; break;
1236         case 0x800: if (!HLPFILE_RtfAddControl(rd, "\\qc")) goto done; break;
1237         }
1238
1239         /* 0x1000 doesn't need space */
1240         if ((bits & 0x1000) && !HLPFILE_RtfAddControl(rd, "\\keep")) goto done;
1241         if ((bits & 0xE080) != 0) 
1242             WINE_FIXME("Unsupported bits %04x, potential trouble ahead\n", bits);
1243
1244         while (text < text_end && format < format_end)
1245         {
1246             WINE_TRACE("Got text: %s (%p/%p - %p/%p)\n", wine_dbgstr_a(text), text, text_end, format, format_end);
1247             textsize = strlen(text);
1248             if (textsize)
1249             {
1250                 if (rd->force_color)
1251                 {
1252                     if ((rd->current_link->cookie == hlp_link_popup) ?
1253                         !HLPFILE_RtfAddControl(rd, "{\\uld\\cf1") :
1254                         !HLPFILE_RtfAddControl(rd, "{\\ul\\cf1")) goto done;
1255                 }
1256                 if (!HLPFILE_RtfAddText(rd, text)) goto done;
1257                 if (rd->force_color && !HLPFILE_RtfAddControl(rd, "}")) goto done;
1258                 rd->char_pos += textsize;
1259             }
1260             /* else: null text, keep on storing attributes */
1261             text += textsize + 1;
1262
1263             if (*format == 0xff)
1264             {
1265                 format++;
1266                 break;
1267             }
1268
1269             WINE_TRACE("format=%02x\n", *format);
1270             switch (*format)
1271             {
1272             case 0x20:
1273                 WINE_FIXME("NIY20\n");
1274                 format += 5;
1275                 break;
1276
1277             case 0x21:
1278                 WINE_FIXME("NIY21\n");
1279                 format += 3;
1280                 break;
1281
1282             case 0x80:
1283                 {
1284                     unsigned    font = GET_USHORT(format, 1);
1285                     unsigned    fs;
1286
1287                     WINE_TRACE("Changing font to %d\n", font);
1288                     format += 3;
1289                     switch (rd->font_scale)
1290                     {
1291                     case 0: fs = (4 * page->file->fonts[font].LogFont.lfHeight - 13) / 5; break;
1292                     default:
1293                     case 1: fs = (4 * page->file->fonts[font].LogFont.lfHeight - 3) / 5; break;
1294                     case 2: fs = (4 * page->file->fonts[font].LogFont.lfHeight + 17) / 5; break;
1295                     }
1296                     /* FIXME: missing at least colors, also bold attribute looses information */
1297
1298                     sprintf(tmp, "\\f%d\\cf%d\\fs%d%s%s%s%s",
1299                             font, font + 2, fs,
1300                             page->file->fonts[font].LogFont.lfWeight > 400 ? "\\b" : "\\b0",
1301                             page->file->fonts[font].LogFont.lfItalic ? "\\i" : "\\i0",
1302                             page->file->fonts[font].LogFont.lfUnderline ? "\\ul" : "\\ul0",
1303                             page->file->fonts[font].LogFont.lfStrikeOut ? "\\strike" : "\\strike0");
1304                     if (!HLPFILE_RtfAddControl(rd, tmp)) goto done;
1305                 }
1306                break;
1307
1308             case 0x81:
1309                 if (!HLPFILE_RtfAddControl(rd, "\\line")) goto done;
1310                 format += 1;
1311                 rd->char_pos++;
1312                 break;
1313
1314             case 0x82:
1315                 if (in_table)
1316                 {
1317                     if (format[1] != 0xFF)
1318                     {
1319                         if (!HLPFILE_RtfAddControl(rd, "\\par\\intbl")) goto done;
1320                     }
1321                     else
1322                     {
1323                         if (!HLPFILE_RtfAddControl(rd, "\\cell\\pard\\intbl")) goto done;
1324                     }
1325                 }
1326                 else if (!HLPFILE_RtfAddControl(rd, "\\par")) goto done;
1327                 format += 1;
1328                 rd->char_pos++;
1329                 break;
1330
1331             case 0x83:
1332                 if (!HLPFILE_RtfAddControl(rd, "\\tab")) goto done;
1333                 format += 1;
1334                 rd->char_pos++;
1335                 break;
1336
1337 #if 0
1338             case 0x84:
1339                 format += 3;
1340                 break;
1341 #endif
1342
1343             case 0x86:
1344             case 0x87:
1345             case 0x88:
1346                 {
1347                     BYTE    type = format[1];
1348                     long    size;
1349
1350                     /* FIXME: we don't use 'BYTE    pos = (*format - 0x86);' for the image position */
1351                     format += 2;
1352                     size = fetch_long(&format);
1353
1354                     switch (type)
1355                     {
1356                     case 0x22:
1357                         fetch_ushort(&format); /* hot spot */
1358                         /* fall thru */
1359                     case 0x03:
1360                         switch (GET_SHORT(format, 0))
1361                         {
1362                         case 0:
1363                             HLPFILE_RtfAddGfxByIndex(rd, page->file, GET_SHORT(format, 2));
1364                             rd->char_pos++;
1365                             break;
1366                         case 1:
1367                             WINE_FIXME("does it work ??? %x<%lu>#%u\n",
1368                                        GET_SHORT(format, 0),
1369                                        size, GET_SHORT(format, 2));
1370                             HLPFILE_RtfAddGfxByAddr(rd, page->file, format + 2, size - 4);
1371                             rd->char_pos++;
1372                            break;
1373                         default:
1374                             WINE_FIXME("??? %u\n", GET_SHORT(format, 0));
1375                             break;
1376                         }
1377                         break;
1378                     case 0x05:
1379                         WINE_FIXME("Got an embedded element %s\n", format + 6);
1380                         break;
1381                     default:
1382                         WINE_FIXME("Got a type %d picture\n", type);
1383                         break;
1384                     }
1385                     format += size;
1386                 }
1387                 break;
1388
1389             case 0x89:
1390                 format += 1;
1391                 if (!rd->current_link)
1392                     WINE_FIXME("No existing link\n");
1393                 rd->current_link->cpMax = rd->char_pos;
1394                 rd->current_link = NULL;
1395                 rd->force_color = FALSE;
1396                 break;
1397
1398             case 0x8B:
1399                 if (!HLPFILE_RtfAddControl(rd, "\\~")) goto done;
1400                 format += 1;
1401                 rd->char_pos++;
1402                 break;
1403
1404             case 0x8C:
1405                 if (!HLPFILE_RtfAddControl(rd, "\\_")) goto done;
1406                 /* FIXME: it could be that hypen is also in input stream !! */
1407                 format += 1;
1408                 rd->char_pos++;
1409                 break;
1410
1411 #if 0
1412             case 0xA9:
1413                 format += 2;
1414                 break;
1415 #endif
1416
1417             case 0xC8:
1418             case 0xCC:
1419                 WINE_TRACE("macro => %s\n", format + 3);
1420                 HLPFILE_AllocLink(rd, hlp_link_macro, (const char*)format + 3,
1421                                   GET_USHORT(format, 1), 0, !(*format & 4), -1);
1422                 format += 3 + GET_USHORT(format, 1);
1423                 break;
1424
1425             case 0xE0:
1426             case 0xE1:
1427                 WINE_WARN("jump topic 1 => %u\n", GET_UINT(format, 1));
1428                 HLPFILE_AllocLink(rd, (*format & 1) ? hlp_link_link : hlp_link_popup,
1429                                   page->file->lpszPath, -1, GET_UINT(format, 1)-16, 1, -1);
1430
1431
1432                 format += 5;
1433                 break;
1434
1435             case 0xE2:
1436             case 0xE3:
1437             case 0xE6:
1438             case 0xE7:
1439                 HLPFILE_AllocLink(rd, (*format & 1) ? hlp_link_link : hlp_link_popup,
1440                                   page->file->lpszPath, -1, GET_UINT(format, 1),
1441                                   !(*format & 4), -1);
1442                 format += 5;
1443                 break;
1444
1445             case 0xEA:
1446             case 0xEB:
1447             case 0xEE:
1448             case 0xEF:
1449                 {
1450                     char*       ptr = (char*) format + 8;
1451                     BYTE        type = format[3];
1452                     int         wnd = -1;
1453
1454                     switch (type)
1455                     {
1456                     case 1:
1457                         wnd = *ptr;
1458                         /* fall through */
1459                     case 0:
1460                         ptr = page->file->lpszPath;
1461                         break;
1462                     case 6:
1463                         for (wnd = page->file->numWindows - 1; wnd >= 0; wnd--)
1464                         {
1465                             if (!strcmp(ptr, page->file->windows[wnd].name)) break;
1466                         }
1467                         if (wnd == -1)
1468                             WINE_WARN("Couldn't find window info for %s\n", ptr);
1469                         ptr += strlen(ptr) + 1;
1470                         /* fall through */
1471                     case 4:
1472                         break;
1473                     default:
1474                         WINE_WARN("Unknown link type %d\n", type);
1475                         break;
1476                     }
1477                     HLPFILE_AllocLink(rd, (*format & 1) ? hlp_link_link : hlp_link_popup,
1478                                       ptr, -1, GET_UINT(format, 4), !(*format & 4), wnd);
1479                 }
1480                 format += 3 + GET_USHORT(format, 1);
1481                 break;
1482
1483             default:
1484                 WINE_WARN("format %02x\n", *format);
1485                 format++;
1486             }
1487         }
1488     }
1489     if (in_table)
1490     {
1491         if (!HLPFILE_RtfAddControl(rd, "\\row\\par\\pard\\plain")) goto done;
1492         rd->char_pos += 2;
1493     }
1494     ret = TRUE;
1495 done:
1496
1497     HeapFree(GetProcessHeap(), 0, text_base);
1498     return ret;
1499 }
1500
1501 /******************************************************************
1502  *              HLPFILE_BrowsePage
1503  *
1504  */
1505 BOOL    HLPFILE_BrowsePage(HLPFILE_PAGE* page, struct RtfData* rd,
1506                            unsigned font_scale, unsigned relative)
1507 {
1508     HLPFILE     *hlpfile = page->file;
1509     BYTE        *buf, *end;
1510     DWORD       ref = page->reference;
1511     unsigned    index, old_index = -1, offset, count = 0, offs = 0;
1512     unsigned    cpg, parlen;
1513     char        tmp[1024];
1514     const char* ck = NULL;
1515
1516     rd->in_text = TRUE;
1517     rd->data = rd->ptr = HeapAlloc(GetProcessHeap(), 0, rd->allocated = 32768);
1518     rd->char_pos = 0;
1519     rd->first_link = rd->current_link = NULL;
1520     rd->force_color = FALSE;
1521     rd->font_scale = font_scale;
1522     rd->relative = relative;
1523     rd->char_pos_rel = 0;
1524
1525     switch (hlpfile->charset)
1526     {
1527     case DEFAULT_CHARSET:
1528     case ANSI_CHARSET:          cpg = 1252; break;
1529     case SHIFTJIS_CHARSET:      cpg = 932; break;
1530     case HANGEUL_CHARSET:       cpg = 949; break;
1531     case GB2312_CHARSET:        cpg = 936; break;
1532     case CHINESEBIG5_CHARSET:   cpg = 950; break;
1533     case GREEK_CHARSET:         cpg = 1253; break;
1534     case TURKISH_CHARSET:       cpg = 1254; break;
1535     case HEBREW_CHARSET:        cpg = 1255; break;
1536     case ARABIC_CHARSET:        cpg = 1256; break;
1537     case BALTIC_CHARSET:        cpg = 1257; break;
1538     case VIETNAMESE_CHARSET:    cpg = 1258; break;
1539     case RUSSIAN_CHARSET:       cpg = 1251; break;
1540     case EE_CHARSET:            cpg = 1250; break;
1541     case THAI_CHARSET:          cpg = 874; break;
1542     case JOHAB_CHARSET:         cpg = 1361; break;
1543     case MAC_CHARSET:           ck = "mac"; break;
1544     default:
1545         WINE_FIXME("Unsupported charset %u\n", hlpfile->charset);
1546         cpg = 1252;
1547     }
1548     if (ck)
1549     {
1550         sprintf(tmp, "{\\rtf1\\%s\\deff0", ck);
1551         if (!HLPFILE_RtfAddControl(rd, tmp)) return FALSE;
1552     }
1553     else
1554     {
1555         sprintf(tmp, "{\\rtf1\\ansi\\ansicpg%d\\deff0", cpg);
1556         if (!HLPFILE_RtfAddControl(rd, tmp)) return FALSE;
1557     }
1558
1559     /* generate font table */
1560     if (!HLPFILE_RtfAddControl(rd, "{\\fonttbl")) return FALSE;
1561     for (index = 0; index < hlpfile->numFonts; index++)
1562     {
1563         const char* family;
1564         switch (hlpfile->fonts[index].LogFont.lfPitchAndFamily & 0xF0)
1565         {
1566         case FF_MODERN:     family = "modern";  break;
1567         case FF_ROMAN:      family = "roman";   break;
1568         case FF_SWISS:      family = "swiss";   break;
1569         case FF_SCRIPT:     family = "script";  break;
1570         case FF_DECORATIVE: family = "decor";   break;
1571         default:            family = "nil";     break;
1572         }
1573         sprintf(tmp, "{\\f%d\\f%s\\fprq%d\\fcharset%d %s;}",
1574                 index, family,
1575                 hlpfile->fonts[index].LogFont.lfPitchAndFamily & 0x0F,
1576                 hlpfile->fonts[index].LogFont.lfCharSet,
1577                 hlpfile->fonts[index].LogFont.lfFaceName);
1578         if (!HLPFILE_RtfAddControl(rd, tmp)) return FALSE;
1579     }
1580     if (!HLPFILE_RtfAddControl(rd, "}")) return FALSE;
1581     /* generate color table */
1582     if (!HLPFILE_RtfAddControl(rd, "{\\colortbl ;\\red0\\green128\\blue0;")) return FALSE;
1583     for (index = 0; index < hlpfile->numFonts; index++)
1584     {
1585         const char* family;
1586         switch (hlpfile->fonts[index].LogFont.lfPitchAndFamily & 0xF0)
1587         {
1588         case FF_MODERN:     family = "modern";  break;
1589         case FF_ROMAN:      family = "roman";   break;
1590         case FF_SWISS:      family = "swiss";   break;
1591         case FF_SCRIPT:     family = "script";  break;
1592         case FF_DECORATIVE: family = "decor";   break;
1593         default:            family = "nil";     break;
1594         }
1595         sprintf(tmp, "\\red%d\\green%d\\blue%d;",
1596                 GetRValue(hlpfile->fonts[index].color),
1597                 GetGValue(hlpfile->fonts[index].color),
1598                 GetBValue(hlpfile->fonts[index].color));
1599         if (!HLPFILE_RtfAddControl(rd, tmp)) return FALSE;
1600     }
1601     if (!HLPFILE_RtfAddControl(rd, "}")) return FALSE;
1602
1603     do
1604     {
1605         if (hlpfile->version <= 16)
1606         {
1607             index  = (ref - 0x0C) / hlpfile->dsize;
1608             offset = (ref - 0x0C) % hlpfile->dsize;
1609         }
1610         else
1611         {
1612             index  = (ref - 0x0C) >> 14;
1613             offset = (ref - 0x0C) & 0x3FFF;
1614         }
1615
1616         if (hlpfile->version <= 16 && index != old_index && old_index != -1)
1617         {
1618             /* we jumped to the next block, adjust pointers */
1619             ref -= 12;
1620             offset -= 12;
1621         }
1622
1623         if (index >= hlpfile->topic_maplen) {WINE_WARN("maplen\n"); break;}
1624         buf = hlpfile->topic_map[index] + offset;
1625         if (buf + 0x15 >= hlpfile->topic_end) {WINE_WARN("extra\n"); break;}
1626         end = min(buf + GET_UINT(buf, 0), hlpfile->topic_end);
1627         if (index != old_index) {offs = 0; old_index = index;}
1628
1629         switch (buf[0x14])
1630         {
1631         case 0x02:
1632             if (count++) goto done;
1633             break;
1634         case 0x01:
1635         case 0x20:
1636         case 0x23:
1637             if (!HLPFILE_BrowseParagraph(page, rd, buf, end, &parlen)) return FALSE;
1638             if (relative >= index * 0x8000 + offs)
1639                 rd->char_pos_rel = rd->char_pos;
1640             offs += parlen;
1641             break;
1642         default:
1643             WINE_ERR("buf[0x14] = %x\n", buf[0x14]);
1644         }
1645         if (hlpfile->version <= 16)
1646         {
1647             ref += GET_UINT(buf, 0xc);
1648             if (GET_UINT(buf, 0xc) == 0)
1649                 break;
1650         }
1651         else
1652             ref = GET_UINT(buf, 0xc);
1653     } while (ref != 0xffffffff);
1654 done:
1655     page->first_link = rd->first_link;
1656     return HLPFILE_RtfAddControl(rd, "}");
1657 }
1658
1659 /******************************************************************
1660  *              HLPFILE_ReadFont
1661  *
1662  *
1663  */
1664 static BOOL HLPFILE_ReadFont(HLPFILE* hlpfile)
1665 {
1666     BYTE        *ref, *end;
1667     unsigned    i, len, idx;
1668     unsigned    face_num, dscr_num, face_offset, dscr_offset;
1669     BYTE        flag, family;
1670
1671     if (!HLPFILE_FindSubFile(hlpfile, "|FONT", &ref, &end))
1672     {
1673         WINE_WARN("no subfile FONT\n");
1674         hlpfile->numFonts = 0;
1675         hlpfile->fonts = NULL;
1676         return FALSE;
1677     }
1678
1679     ref += 9;
1680
1681     face_num    = GET_USHORT(ref, 0);
1682     dscr_num    = GET_USHORT(ref, 2);
1683     face_offset = GET_USHORT(ref, 4);
1684     dscr_offset = GET_USHORT(ref, 6);
1685
1686     WINE_TRACE("Got NumFacenames=%u@%u NumDesc=%u@%u\n",
1687                face_num, face_offset, dscr_num, dscr_offset);
1688
1689     hlpfile->numFonts = dscr_num;
1690     hlpfile->fonts = HeapAlloc(GetProcessHeap(), 0, sizeof(HLPFILE_FONT) * dscr_num);
1691
1692     len = (dscr_offset - face_offset) / face_num;
1693 /* EPP     for (i = face_offset; i < dscr_offset; i += len) */
1694 /* EPP         WINE_FIXME("[%d]: %*s\n", i / len, len, ref + i); */
1695     for (i = 0; i < dscr_num; i++)
1696     {
1697         flag = ref[dscr_offset + i * 11 + 0];
1698         family = ref[dscr_offset + i * 11 + 2];
1699
1700         hlpfile->fonts[i].LogFont.lfHeight = ref[dscr_offset + i * 11 + 1];
1701         hlpfile->fonts[i].LogFont.lfWidth = 0;
1702         hlpfile->fonts[i].LogFont.lfEscapement = 0;
1703         hlpfile->fonts[i].LogFont.lfOrientation = 0;
1704         hlpfile->fonts[i].LogFont.lfWeight = (flag & 1) ? 700 : 400;
1705         hlpfile->fonts[i].LogFont.lfItalic = (flag & 2) ? TRUE : FALSE;
1706         hlpfile->fonts[i].LogFont.lfUnderline = (flag & 4) ? TRUE : FALSE;
1707         hlpfile->fonts[i].LogFont.lfStrikeOut = (flag & 8) ? TRUE : FALSE;
1708         hlpfile->fonts[i].LogFont.lfCharSet = hlpfile->charset;
1709         hlpfile->fonts[i].LogFont.lfOutPrecision = OUT_DEFAULT_PRECIS;
1710         hlpfile->fonts[i].LogFont.lfClipPrecision = CLIP_DEFAULT_PRECIS;
1711         hlpfile->fonts[i].LogFont.lfQuality = DEFAULT_QUALITY;
1712         hlpfile->fonts[i].LogFont.lfPitchAndFamily = DEFAULT_PITCH;
1713
1714         switch (family)
1715         {
1716         case 0x01: hlpfile->fonts[i].LogFont.lfPitchAndFamily |= FF_MODERN;     break;
1717         case 0x02: hlpfile->fonts[i].LogFont.lfPitchAndFamily |= FF_ROMAN;      break;
1718         case 0x03: hlpfile->fonts[i].LogFont.lfPitchAndFamily |= FF_SWISS;      break;
1719         case 0x04: hlpfile->fonts[i].LogFont.lfPitchAndFamily |= FF_SCRIPT;     break;
1720         case 0x05: hlpfile->fonts[i].LogFont.lfPitchAndFamily |= FF_DECORATIVE; break;
1721         default: WINE_FIXME("Unknown family %u\n", family);
1722         }
1723         idx = GET_USHORT(ref, dscr_offset + i * 11 + 3);
1724
1725         if (idx < face_num)
1726         {
1727             memcpy(hlpfile->fonts[i].LogFont.lfFaceName, ref + face_offset + idx * len, min(len, LF_FACESIZE - 1));
1728             hlpfile->fonts[i].LogFont.lfFaceName[min(len, LF_FACESIZE - 1)] = '\0';
1729         }
1730         else
1731         {
1732             WINE_FIXME("Too high face ref (%u/%u)\n", idx, face_num);
1733             strcpy(hlpfile->fonts[i].LogFont.lfFaceName, "Helv");
1734         }
1735         hlpfile->fonts[i].hFont = 0;
1736         hlpfile->fonts[i].color = RGB(ref[dscr_offset + i * 11 + 5],
1737                                       ref[dscr_offset + i * 11 + 6],
1738                                       ref[dscr_offset + i * 11 + 7]);
1739 #define X(b,s) ((flag & (1 << b)) ? "-"s: "")
1740         WINE_TRACE("Font[%d]: flags=%02x%s%s%s%s%s%s pSize=%u family=%u face=%s[%u] color=%08x\n",
1741                    i, flag,
1742                    X(0, "bold"),
1743                    X(1, "italic"),
1744                    X(2, "underline"),
1745                    X(3, "strikeOut"),
1746                    X(4, "dblUnderline"),
1747                    X(5, "smallCaps"),
1748                    ref[dscr_offset + i * 11 + 1],
1749                    family,
1750                    hlpfile->fonts[i].LogFont.lfFaceName, idx,
1751                    GET_UINT(ref, dscr_offset + i * 11 + 5) & 0x00FFFFFF);
1752     }
1753     return TRUE;
1754 }
1755
1756 /***********************************************************************
1757  *
1758  *           HLPFILE_ReadFileToBuffer
1759  */
1760 static BOOL HLPFILE_ReadFileToBuffer(HLPFILE* hlpfile, HFILE hFile)
1761 {
1762     BYTE  header[16], dummy[1];
1763
1764     if (_hread(hFile, header, 16) != 16) {WINE_WARN("header\n"); return FALSE;};
1765
1766     /* sanity checks */
1767     if (GET_UINT(header, 0) != 0x00035F3F)
1768     {WINE_WARN("wrong header\n"); return FALSE;};
1769
1770     hlpfile->file_buffer_size = GET_UINT(header, 12);
1771     hlpfile->file_buffer = HeapAlloc(GetProcessHeap(), 0, hlpfile->file_buffer_size + 1);
1772     if (!hlpfile->file_buffer) return FALSE;
1773
1774     memcpy(hlpfile->file_buffer, header, 16);
1775     if (_hread(hFile, hlpfile->file_buffer + 16, hlpfile->file_buffer_size - 16) !=hlpfile->file_buffer_size - 16)
1776     {WINE_WARN("filesize1\n"); return FALSE;};
1777
1778     if (_hread(hFile, dummy, 1) != 0) WINE_WARN("filesize2\n");
1779
1780     hlpfile->file_buffer[hlpfile->file_buffer_size] = '\0'; /* FIXME: was '0', sounds backwards to me */
1781
1782     return TRUE;
1783 }
1784
1785 /**************************************************************************
1786  * comp_FindSubFile
1787  *
1788  * HLPFILE_BPTreeCompare function for HLPFILE directory.
1789  *
1790  */
1791 static int comp_FindSubFile(void *p, const void *key,
1792                             int leaf, void** next)
1793 {
1794     *next = (char *)p+strlen(p)+(leaf?5:3);
1795     WINE_TRACE("Comparing '%s' with '%s'\n", (char *)p, (char *)key);
1796     return strcmp(p, key);
1797 }
1798
1799 /***********************************************************************
1800  *
1801  *           HLPFILE_FindSubFile
1802  */
1803 static BOOL HLPFILE_FindSubFile(HLPFILE* hlpfile, LPCSTR name, BYTE **subbuf, BYTE **subend)
1804 {
1805     BYTE *ptr;
1806
1807     WINE_TRACE("looking for file '%s'\n", name);
1808     ptr = HLPFILE_BPTreeSearch(hlpfile->file_buffer + GET_UINT(hlpfile->file_buffer, 4),
1809                                name, comp_FindSubFile);
1810     if (!ptr) return FALSE;
1811     *subbuf = hlpfile->file_buffer + GET_UINT(ptr, strlen(name)+1);
1812     if (*subbuf >= hlpfile->file_buffer + hlpfile->file_buffer_size)
1813     {
1814         WINE_ERR("internal file %s does not fit\n", name);
1815         return FALSE;
1816     }
1817     *subend = *subbuf + GET_UINT(*subbuf, 0);
1818     if (*subend > hlpfile->file_buffer + hlpfile->file_buffer_size)
1819     {
1820         WINE_ERR("internal file %s does not fit\n", name);
1821         return FALSE;
1822     }
1823     if (GET_UINT(*subbuf, 0) < GET_UINT(*subbuf, 4) + 9)
1824     {
1825         WINE_ERR("invalid size provided for internal file %s\n", name);
1826         return FALSE;
1827     }
1828     return TRUE;
1829 }
1830
1831 /***********************************************************************
1832  *
1833  *           HLPFILE_SystemCommands
1834  */
1835 static BOOL HLPFILE_SystemCommands(HLPFILE* hlpfile)
1836 {
1837     BYTE *buf, *ptr, *end;
1838     HLPFILE_MACRO *macro, **m;
1839     LPSTR p;
1840     unsigned short magic, minor, major, flags;
1841
1842     hlpfile->lpszTitle = NULL;
1843
1844     if (!HLPFILE_FindSubFile(hlpfile, "|SYSTEM", &buf, &end)) return FALSE;
1845
1846     magic = GET_USHORT(buf + 9, 0);
1847     minor = GET_USHORT(buf + 9, 2);
1848     major = GET_USHORT(buf + 9, 4);
1849     /* gen date on 4 bytes */
1850     flags = GET_USHORT(buf + 9, 10);
1851     WINE_TRACE("Got system header: magic=%04x version=%d.%d flags=%04x\n",
1852                magic, major, minor, flags);
1853     if (magic != 0x036C || major != 1)
1854     {WINE_WARN("Wrong system header\n"); return FALSE;}
1855     if (minor <= 16)
1856     {
1857         hlpfile->tbsize = 0x800;
1858         hlpfile->compressed = 0;
1859     }
1860     else if (flags == 0)
1861     {
1862         hlpfile->tbsize = 0x1000;
1863         hlpfile->compressed = 0;
1864     }
1865     else if (flags == 4)
1866     {
1867         hlpfile->tbsize = 0x1000;
1868         hlpfile->compressed = 1;
1869     }
1870     else
1871     {
1872         hlpfile->tbsize = 0x800;
1873         hlpfile->compressed = 1;
1874     }
1875
1876     if (hlpfile->compressed)
1877         hlpfile->dsize = 0x4000;
1878     else
1879         hlpfile->dsize = hlpfile->tbsize - 0x0C;
1880
1881     hlpfile->version = minor;
1882     hlpfile->flags = flags;
1883     hlpfile->charset = DEFAULT_CHARSET;
1884
1885     for (ptr = buf + 0x15; ptr + 4 <= end; ptr += GET_USHORT(ptr, 2) + 4)
1886     {
1887         char *str = (char*) ptr + 4;
1888         switch (GET_USHORT(ptr, 0))
1889         {
1890         case 1:
1891             if (hlpfile->lpszTitle) {WINE_WARN("title\n"); break;}
1892             hlpfile->lpszTitle = HeapAlloc(GetProcessHeap(), 0, strlen(str) + 1);
1893             if (!hlpfile->lpszTitle) return FALSE;
1894             lstrcpy(hlpfile->lpszTitle, str);
1895             WINE_TRACE("Title: %s\n", hlpfile->lpszTitle);
1896             break;
1897
1898         case 2:
1899             if (hlpfile->lpszCopyright) {WINE_WARN("copyright\n"); break;}
1900             hlpfile->lpszCopyright = HeapAlloc(GetProcessHeap(), 0, strlen(str) + 1);
1901             if (!hlpfile->lpszCopyright) return FALSE;
1902             lstrcpy(hlpfile->lpszCopyright, str);
1903             WINE_TRACE("Copyright: %s\n", hlpfile->lpszCopyright);
1904             break;
1905
1906         case 3:
1907             if (GET_USHORT(ptr, 2) != 4) {WINE_WARN("system3\n");break;}
1908             hlpfile->contents_start = GET_UINT(ptr, 4);
1909             WINE_TRACE("Setting contents start at %08lx\n", hlpfile->contents_start);
1910             break;
1911
1912         case 4:
1913             macro = HeapAlloc(GetProcessHeap(), 0, sizeof(HLPFILE_MACRO) + lstrlen(str) + 1);
1914             if (!macro) break;
1915             p = (char*)macro + sizeof(HLPFILE_MACRO);
1916             lstrcpy(p, str);
1917             macro->lpszMacro = p;
1918             macro->next = 0;
1919             for (m = &hlpfile->first_macro; *m; m = &(*m)->next);
1920             *m = macro;
1921             break;
1922
1923         case 5:
1924             if (GET_USHORT(ptr, 4 + 4) != 1)
1925                 WINE_FIXME("More than one icon, picking up first\n");
1926             /* 0x16 is sizeof(CURSORICONDIR), see user32/user_private.h */
1927             hlpfile->hIcon = CreateIconFromResourceEx(ptr + 4 + 0x16,
1928                                                       GET_USHORT(ptr, 2) - 0x16, TRUE,
1929                                                       0x30000, 0, 0, 0);
1930             break;
1931
1932         case 6:
1933             if (GET_USHORT(ptr, 2) != 90) {WINE_WARN("system6\n");break;}
1934
1935             if (hlpfile->windows) 
1936                 hlpfile->windows = HeapReAlloc(GetProcessHeap(), 0, hlpfile->windows, 
1937                                            sizeof(HLPFILE_WINDOWINFO) * ++hlpfile->numWindows);
1938             else 
1939                 hlpfile->windows = HeapAlloc(GetProcessHeap(), 0, 
1940                                            sizeof(HLPFILE_WINDOWINFO) * ++hlpfile->numWindows);
1941             
1942             if (hlpfile->windows)
1943             {
1944                 unsigned flags = GET_USHORT(ptr, 4);
1945                 HLPFILE_WINDOWINFO* wi = &hlpfile->windows[hlpfile->numWindows - 1];
1946
1947                 if (flags & 0x0001) strcpy(wi->type, &str[2]);
1948                 else wi->type[0] = '\0';
1949                 if (flags & 0x0002) strcpy(wi->name, &str[12]);
1950                 else wi->name[0] = '\0';
1951                 if (flags & 0x0004) strcpy(wi->caption, &str[21]);
1952                 else lstrcpynA(wi->caption, hlpfile->lpszTitle, sizeof(wi->caption));
1953                 wi->origin.x = (flags & 0x0008) ? GET_USHORT(ptr, 76) : CW_USEDEFAULT;
1954                 wi->origin.y = (flags & 0x0010) ? GET_USHORT(ptr, 78) : CW_USEDEFAULT;
1955                 wi->size.cx = (flags & 0x0020) ? GET_USHORT(ptr, 80) : CW_USEDEFAULT;
1956                 wi->size.cy = (flags & 0x0040) ? GET_USHORT(ptr, 82) : CW_USEDEFAULT;
1957                 wi->style = (flags & 0x0080) ? GET_USHORT(ptr, 84) : SW_SHOW;
1958                 wi->win_style = WS_OVERLAPPEDWINDOW;
1959                 wi->sr_color = (flags & 0x0100) ? GET_UINT(ptr, 86) : 0xFFFFFF;
1960                 wi->nsr_color = (flags & 0x0200) ? GET_UINT(ptr, 90) : 0xFFFFFF;
1961                 WINE_TRACE("System-Window: flags=%c%c%c%c%c%c%c%c type=%s name=%s caption=%s (%d,%d)x(%d,%d)\n",
1962                            flags & 0x0001 ? 'T' : 't',
1963                            flags & 0x0002 ? 'N' : 'n',
1964                            flags & 0x0004 ? 'C' : 'c',
1965                            flags & 0x0008 ? 'X' : 'x',
1966                            flags & 0x0010 ? 'Y' : 'y',
1967                            flags & 0x0020 ? 'W' : 'w',
1968                            flags & 0x0040 ? 'H' : 'h',
1969                            flags & 0x0080 ? 'S' : 's',
1970                            wi->type, wi->name, wi->caption, wi->origin.x, wi->origin.y,
1971                            wi->size.cx, wi->size.cy);
1972             }
1973             break;
1974         case 8:
1975             WINE_WARN("Citation: '%s'\n", ptr + 4);
1976             break;
1977         case 11:
1978             hlpfile->charset = ptr[4];
1979             WINE_TRACE("Charset: %d\n", hlpfile->charset);
1980             break;
1981         default:
1982             WINE_WARN("Unsupported SystemRecord[%d]\n", GET_USHORT(ptr, 0));
1983         }
1984     }
1985     if (!hlpfile->lpszTitle)
1986         hlpfile->lpszTitle = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, 1);
1987     return TRUE;
1988 }
1989
1990 /***********************************************************************
1991  *
1992  *           HLPFILE_UncompressedLZ77_Size
1993  */
1994 static INT HLPFILE_UncompressedLZ77_Size(BYTE *ptr, BYTE *end)
1995 {
1996     int  i, newsize = 0;
1997
1998     while (ptr < end)
1999     {
2000         int mask = *ptr++;
2001         for (i = 0; i < 8 && ptr < end; i++, mask >>= 1)
2002         {
2003             if (mask & 1)
2004             {
2005                 int code = GET_USHORT(ptr, 0);
2006                 int len  = 3 + (code >> 12);
2007                 newsize += len;
2008                 ptr     += 2;
2009             }
2010             else newsize++, ptr++;
2011         }
2012     }
2013
2014     return newsize;
2015 }
2016
2017 /***********************************************************************
2018  *
2019  *           HLPFILE_UncompressLZ77
2020  */
2021 static BYTE *HLPFILE_UncompressLZ77(BYTE *ptr, BYTE *end, BYTE *newptr)
2022 {
2023     int i;
2024
2025     while (ptr < end)
2026     {
2027         int mask = *ptr++;
2028         for (i = 0; i < 8 && ptr < end; i++, mask >>= 1)
2029         {
2030             if (mask & 1)
2031             {
2032                 int code   = GET_USHORT(ptr, 0);
2033                 int len    = 3 + (code >> 12);
2034                 int offset = code & 0xfff;
2035                 /*
2036                  * We must copy byte-by-byte here. We cannot use memcpy nor
2037                  * memmove here. Just example:
2038                  * a[]={1,2,3,4,5,6,7,8,9,10}
2039                  * newptr=a+2;
2040                  * offset=1;
2041                  * We expect:
2042                  * {1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 11, 12}
2043                  */
2044                 for (; len>0; len--, newptr++) *newptr = *(newptr-offset-1);
2045                 ptr    += 2;
2046             }
2047             else *newptr++ = *ptr++;
2048         }
2049     }
2050
2051     return newptr;
2052 }
2053
2054 /***********************************************************************
2055  *
2056  *           HLPFILE_UncompressLZ77_Phrases
2057  */
2058 static BOOL HLPFILE_UncompressLZ77_Phrases(HLPFILE* hlpfile)
2059 {
2060     UINT i, num, dec_size, head_size;
2061     BYTE *buf, *end;
2062
2063     if (!HLPFILE_FindSubFile(hlpfile, "|Phrases", &buf, &end)) return FALSE;
2064
2065     if (hlpfile->version <= 16)
2066         head_size = 13;
2067     else
2068         head_size = 17;
2069
2070     num = hlpfile->num_phrases = GET_USHORT(buf, 9);
2071     if (buf + 2 * num + 0x13 >= end) {WINE_WARN("1a\n"); return FALSE;};
2072
2073     if (hlpfile->version <= 16)
2074         dec_size = end - buf - 15 - 2 * num;
2075     else
2076         dec_size = HLPFILE_UncompressedLZ77_Size(buf + 0x13 + 2 * num, end);
2077
2078     hlpfile->phrases_offsets = HeapAlloc(GetProcessHeap(), 0, sizeof(unsigned) * (num + 1));
2079     hlpfile->phrases_buffer  = HeapAlloc(GetProcessHeap(), 0, dec_size);
2080     if (!hlpfile->phrases_offsets || !hlpfile->phrases_buffer)
2081     {
2082         HeapFree(GetProcessHeap(), 0, hlpfile->phrases_offsets);
2083         HeapFree(GetProcessHeap(), 0, hlpfile->phrases_buffer);
2084         return FALSE;
2085     }
2086
2087     for (i = 0; i <= num; i++)
2088         hlpfile->phrases_offsets[i] = GET_USHORT(buf, head_size + 2 * i) - 2 * num - 2;
2089
2090     if (hlpfile->version <= 16)
2091         memcpy(hlpfile->phrases_buffer, buf + 15 + 2*num, dec_size);
2092     else
2093         HLPFILE_UncompressLZ77(buf + 0x13 + 2 * num, end, (BYTE*)hlpfile->phrases_buffer);
2094
2095     hlpfile->hasPhrases = TRUE;
2096     return TRUE;
2097 }
2098
2099 /***********************************************************************
2100  *
2101  *           HLPFILE_Uncompress_Phrases40
2102  */
2103 static BOOL HLPFILE_Uncompress_Phrases40(HLPFILE* hlpfile)
2104 {
2105     UINT num;
2106     INT dec_size, cpr_size;
2107     BYTE *buf_idx, *end_idx;
2108     BYTE *buf_phs, *end_phs;
2109     long* ptr, mask = 0;
2110     unsigned int i;
2111     unsigned short bc, n;
2112
2113     if (!HLPFILE_FindSubFile(hlpfile, "|PhrIndex", &buf_idx, &end_idx) ||
2114         !HLPFILE_FindSubFile(hlpfile, "|PhrImage", &buf_phs, &end_phs)) return FALSE;
2115
2116     ptr = (long*)(buf_idx + 9 + 28);
2117     bc = GET_USHORT(buf_idx, 9 + 24) & 0x0F;
2118     num = hlpfile->num_phrases = GET_USHORT(buf_idx, 9 + 4);
2119
2120     WINE_TRACE("Index: Magic=%08x #entries=%u CpsdSize=%u PhrImgSize=%u\n"
2121                "\tPhrImgCprsdSize=%u 0=%u bc=%x ukn=%x\n",
2122                GET_UINT(buf_idx, 9 + 0),
2123                GET_UINT(buf_idx, 9 + 4),
2124                GET_UINT(buf_idx, 9 + 8),
2125                GET_UINT(buf_idx, 9 + 12),
2126                GET_UINT(buf_idx, 9 + 16),
2127                GET_UINT(buf_idx, 9 + 20),
2128                GET_USHORT(buf_idx, 9 + 24),
2129                GET_USHORT(buf_idx, 9 + 26));
2130
2131     dec_size = GET_UINT(buf_idx, 9 + 12);
2132     cpr_size = GET_UINT(buf_idx, 9 + 16);
2133
2134     if (dec_size != cpr_size &&
2135         dec_size != HLPFILE_UncompressedLZ77_Size(buf_phs + 9, end_phs))
2136     {
2137         WINE_WARN("size mismatch %u %u\n",
2138                   dec_size, HLPFILE_UncompressedLZ77_Size(buf_phs + 9, end_phs));
2139         dec_size = max(dec_size, HLPFILE_UncompressedLZ77_Size(buf_phs + 9, end_phs));
2140     }
2141
2142     hlpfile->phrases_offsets = HeapAlloc(GetProcessHeap(), 0, sizeof(unsigned) * (num + 1));
2143     hlpfile->phrases_buffer  = HeapAlloc(GetProcessHeap(), 0, dec_size);
2144     if (!hlpfile->phrases_offsets || !hlpfile->phrases_buffer)
2145     {
2146         HeapFree(GetProcessHeap(), 0, hlpfile->phrases_offsets);
2147         HeapFree(GetProcessHeap(), 0, hlpfile->phrases_buffer);
2148         return FALSE;
2149     }
2150
2151 #define getbit() (ptr += (mask < 0), mask = mask*2 + (mask<=0), (*ptr & mask) != 0)
2152
2153     hlpfile->phrases_offsets[0] = 0;
2154     for (i = 0; i < num; i++)
2155     {
2156         for (n = 1; getbit(); n += 1 << bc);
2157         if (getbit()) n++;
2158         if (bc > 1 && getbit()) n += 2;
2159         if (bc > 2 && getbit()) n += 4;
2160         if (bc > 3 && getbit()) n += 8;
2161         if (bc > 4 && getbit()) n += 16;
2162         hlpfile->phrases_offsets[i + 1] = hlpfile->phrases_offsets[i] + n;
2163     }
2164 #undef getbit
2165
2166     if (dec_size == cpr_size)
2167         memcpy(hlpfile->phrases_buffer, buf_phs + 9, dec_size);
2168     else
2169         HLPFILE_UncompressLZ77(buf_phs + 9, end_phs, (BYTE*)hlpfile->phrases_buffer);
2170
2171     hlpfile->hasPhrases40 = TRUE;
2172     return TRUE;
2173 }
2174
2175 /***********************************************************************
2176  *
2177  *           HLPFILE_Uncompress_Topic
2178  */
2179 static BOOL HLPFILE_Uncompress_Topic(HLPFILE* hlpfile)
2180 {
2181     BYTE *buf, *ptr, *end, *newptr;
2182     unsigned int i, newsize = 0;
2183     unsigned int topic_size;
2184
2185     if (!HLPFILE_FindSubFile(hlpfile, "|TOPIC", &buf, &end))
2186     {WINE_WARN("topic0\n"); return FALSE;}
2187
2188     buf += 9; /* Skip file header */
2189     topic_size = end - buf;
2190     if (hlpfile->compressed)
2191     {
2192         hlpfile->topic_maplen = (topic_size - 1) / hlpfile->tbsize + 1;
2193
2194         for (i = 0; i < hlpfile->topic_maplen; i++)
2195         {
2196             ptr = buf + i * hlpfile->tbsize;
2197
2198             /* I don't know why, it's necessary for printman.hlp */
2199             if (ptr + 0x44 > end) ptr = end - 0x44;
2200
2201             newsize += HLPFILE_UncompressedLZ77_Size(ptr + 0xc, min(end, ptr + hlpfile->tbsize));
2202         }
2203
2204         hlpfile->topic_map = HeapAlloc(GetProcessHeap(), 0,
2205                                        hlpfile->topic_maplen * sizeof(hlpfile->topic_map[0]) + newsize);
2206         if (!hlpfile->topic_map) return FALSE;
2207         newptr = (BYTE*)(hlpfile->topic_map + hlpfile->topic_maplen);
2208         hlpfile->topic_end = newptr + newsize;
2209
2210         for (i = 0; i < hlpfile->topic_maplen; i++)
2211         {
2212             ptr = buf + i * hlpfile->tbsize;
2213             if (ptr + 0x44 > end) ptr = end - 0x44;
2214
2215             hlpfile->topic_map[i] = newptr;
2216             newptr = HLPFILE_UncompressLZ77(ptr + 0xc, min(end, ptr + hlpfile->tbsize), newptr);
2217         }
2218     }
2219     else
2220     {
2221         /* basically, we need to copy the TopicBlockSize byte pages
2222          * (removing the first 0x0C) in one single area in memory
2223          */
2224         hlpfile->topic_maplen = (topic_size - 1) / hlpfile->tbsize + 1;
2225         hlpfile->topic_map = HeapAlloc(GetProcessHeap(), 0,
2226                                        hlpfile->topic_maplen * (sizeof(hlpfile->topic_map[0]) + hlpfile->dsize));
2227         if (!hlpfile->topic_map) return FALSE;
2228         newptr = (BYTE*)(hlpfile->topic_map + hlpfile->topic_maplen);
2229         hlpfile->topic_end = newptr + topic_size;
2230
2231         for (i = 0; i < hlpfile->topic_maplen; i++)
2232         {
2233             hlpfile->topic_map[i] = newptr + i * hlpfile->dsize;
2234             memcpy(hlpfile->topic_map[i], buf + i * hlpfile->tbsize + 0x0C, hlpfile->dsize);
2235         }
2236     }
2237     return TRUE;
2238 }
2239
2240 /***********************************************************************
2241  *
2242  *           HLPFILE_Uncompress2
2243  */
2244
2245 static void HLPFILE_Uncompress2(HLPFILE* hlpfile, const BYTE *ptr, const BYTE *end, BYTE *newptr, const BYTE *newend)
2246 {
2247     BYTE *phptr, *phend;
2248     UINT code;
2249     UINT index;
2250
2251     while (ptr < end && newptr < newend)
2252     {
2253         if (!*ptr || *ptr >= 0x10)
2254             *newptr++ = *ptr++;
2255         else
2256         {
2257             code  = 0x100 * ptr[0] + ptr[1];
2258             index = (code - 0x100) / 2;
2259
2260             phptr = (BYTE*)hlpfile->phrases_buffer + hlpfile->phrases_offsets[index];
2261             phend = (BYTE*)hlpfile->phrases_buffer + hlpfile->phrases_offsets[index + 1];
2262
2263             if (newptr + (phend - phptr) > newend)
2264             {
2265                 WINE_FIXME("buffer overflow %p > %p for %lu bytes\n",
2266                            newptr, newend, (SIZE_T)(phend - phptr));
2267                 return;
2268             }
2269             memcpy(newptr, phptr, phend - phptr);
2270             newptr += phend - phptr;
2271             if (code & 1) *newptr++ = ' ';
2272
2273             ptr += 2;
2274         }
2275     }
2276     if (newptr > newend) WINE_FIXME("buffer overflow %p > %p\n", newptr, newend);
2277 }
2278
2279 /******************************************************************
2280  *              HLPFILE_Uncompress3
2281  *
2282  *
2283  */
2284 static BOOL HLPFILE_Uncompress3(HLPFILE* hlpfile, char* dst, const char* dst_end,
2285                                 const BYTE* src, const BYTE* src_end)
2286 {
2287     unsigned int idx, len;
2288
2289     for (; src < src_end; src++)
2290     {
2291         if ((*src & 1) == 0)
2292         {
2293             idx = *src / 2;
2294             if (idx > hlpfile->num_phrases)
2295             {
2296                 WINE_ERR("index in phrases %d/%d\n", idx, hlpfile->num_phrases);
2297                 len = 0;
2298             }
2299             else 
2300             {
2301                 len = hlpfile->phrases_offsets[idx + 1] - hlpfile->phrases_offsets[idx];
2302                 if (dst + len <= dst_end)
2303                     memcpy(dst, &hlpfile->phrases_buffer[hlpfile->phrases_offsets[idx]], len);
2304             }
2305         }
2306         else if ((*src & 0x03) == 0x01)
2307         {
2308             idx = (*src + 1) * 64;
2309             idx += *++src;
2310             if (idx > hlpfile->num_phrases)
2311             {
2312                 WINE_ERR("index in phrases %d/%d\n", idx, hlpfile->num_phrases);
2313                 len = 0;
2314             }
2315             else
2316             {
2317                 len = hlpfile->phrases_offsets[idx + 1] - hlpfile->phrases_offsets[idx];
2318                 if (dst + len <= dst_end)
2319                     memcpy(dst, &hlpfile->phrases_buffer[hlpfile->phrases_offsets[idx]], len);
2320             }
2321         }
2322         else if ((*src & 0x07) == 0x03)
2323         {
2324             len = (*src / 8) + 1;
2325             if (dst + len <= dst_end)
2326                 memcpy(dst, src + 1, len);
2327             src += len;
2328         }
2329         else
2330         {
2331             len = (*src / 16) + 1;
2332             if (dst + len <= dst_end)
2333                 memset(dst, ((*src & 0x0F) == 0x07) ? ' ' : 0, len);
2334         }
2335         dst += len;
2336     }
2337
2338     if (dst > dst_end) WINE_ERR("buffer overflow (%p > %p)\n", dst, dst_end);
2339     return TRUE;
2340 }
2341
2342 /******************************************************************
2343  *              HLPFILE_UncompressRLE
2344  *
2345  *
2346  */
2347 static void HLPFILE_UncompressRLE(const BYTE* src, const BYTE* end, BYTE* dst, unsigned dstsz)
2348 {
2349     BYTE        ch;
2350     BYTE*       sdst = dst + dstsz;
2351
2352     while (src < end)
2353     {
2354         ch = *src++;
2355         if (ch & 0x80)
2356         {
2357             ch &= 0x7F;
2358             if (dst + ch <= sdst)
2359                 memcpy(dst, src, ch);
2360             src += ch;
2361         }
2362         else
2363         {
2364             if (dst + ch <= sdst)
2365                 memset(dst, (char)*src, ch);
2366             src++;
2367         }
2368         dst += ch;
2369     }
2370     if (dst != sdst)
2371         WINE_WARN("Buffer X-flow: d(%lu) instead of d(%u)\n",
2372                   (SIZE_T)(dst - (sdst - dstsz)), dstsz);
2373 }
2374
2375 /**************************************************************************
2376  * HLPFILE_BPTreeSearch
2377  *
2378  * Searches for an element in B+ tree
2379  *
2380  * PARAMS
2381  *     buf        [I] pointer to the embedded file structured as a B+ tree
2382  *     key        [I] pointer to data to find
2383  *     comp       [I] compare function
2384  *
2385  * RETURNS
2386  *     Pointer to block identified by key, or NULL if failure.
2387  *
2388  */
2389 void* HLPFILE_BPTreeSearch(BYTE* buf, const void* key,
2390                            HLPFILE_BPTreeCompare comp)
2391 {
2392     unsigned magic;
2393     unsigned page_size;
2394     unsigned cur_page;
2395     unsigned level;
2396     BYTE *pages, *ptr, *newptr;
2397     int i, entries;
2398     int ret;
2399
2400     magic = GET_USHORT(buf, 9);
2401     if (magic != 0x293B)
2402     {
2403         WINE_ERR("Invalid magic in B+ tree: 0x%x\n", magic);
2404         return NULL;
2405     }
2406     page_size = GET_USHORT(buf, 9+4);
2407     cur_page  = GET_USHORT(buf, 9+26);
2408     level     = GET_USHORT(buf, 9+32);
2409     pages     = buf + 9 + 38;
2410     while (--level > 0)
2411     {
2412         ptr = pages + cur_page*page_size;
2413         entries = GET_SHORT(ptr, 2);
2414         ptr += 6;
2415         for (i = 0; i < entries; i++)
2416         {
2417             if (comp(ptr, key, 0, (void **)&newptr) > 0) break;
2418             ptr = newptr;
2419         }
2420         cur_page = GET_USHORT(ptr-2, 0);
2421     }
2422     ptr = pages + cur_page*page_size;
2423     entries = GET_SHORT(ptr, 2);
2424     ptr += 8;
2425     for (i = 0; i < entries; i++)
2426     {
2427         ret = comp(ptr, key, 1, (void **)&newptr);
2428         if (ret == 0) return ptr;
2429         if (ret > 0) return NULL;
2430         ptr = newptr;
2431     }
2432     return NULL;
2433 }
2434
2435 /**************************************************************************
2436  * HLPFILE_BPTreeEnum
2437  *
2438  * Enumerates elements in B+ tree.
2439  *
2440  * PARAMS
2441  *     buf        [I]  pointer to the embedded file structured as a B+ tree
2442  *     cb         [I]  compare function
2443  *     cookie     [IO] cookie for cb function
2444  */
2445 void HLPFILE_BPTreeEnum(BYTE* buf, HLPFILE_BPTreeCallback cb, void* cookie)
2446 {
2447     unsigned magic;
2448     unsigned page_size;
2449     unsigned cur_page;
2450     unsigned level;
2451     BYTE *pages, *ptr, *newptr;
2452     int i, entries;
2453
2454     magic = GET_USHORT(buf, 9);
2455     if (magic != 0x293B)
2456     {
2457         WINE_ERR("Invalid magic in B+ tree: 0x%x\n", magic);
2458         return;
2459     }
2460     page_size = GET_USHORT(buf, 9+4);
2461     cur_page  = GET_USHORT(buf, 9+26);
2462     level     = GET_USHORT(buf, 9+32);
2463     pages     = buf + 9 + 38;
2464     while (--level > 0)
2465     {
2466         ptr = pages + cur_page*page_size;
2467         cur_page = GET_USHORT(ptr, 4);
2468     }
2469     while (cur_page != 0xFFFF)
2470     {
2471         ptr = pages + cur_page*page_size;
2472         entries = GET_SHORT(ptr, 2);
2473         ptr += 8;
2474         for (i = 0; i < entries; i++)
2475         {
2476             cb(ptr, (void **)&newptr, cookie);
2477             ptr = newptr;
2478         }
2479         cur_page = GET_USHORT(pages+cur_page*page_size, 6);
2480     }
2481 }
2482
2483
2484 /***********************************************************************
2485  *
2486  *           HLPFILE_GetContext
2487  */
2488 static BOOL HLPFILE_GetContext(HLPFILE *hlpfile)
2489 {
2490     BYTE                *cbuf, *cend;
2491     unsigned            clen;
2492
2493     if (!HLPFILE_FindSubFile(hlpfile, "|CONTEXT",  &cbuf, &cend))
2494     {WINE_WARN("context0\n"); return FALSE;}
2495
2496     clen = cend - cbuf;
2497     hlpfile->Context = HeapAlloc(GetProcessHeap(), 0, clen);
2498     if (!hlpfile->Context) return FALSE;
2499     memcpy(hlpfile->Context, cbuf, clen);
2500
2501     return TRUE;
2502 }
2503
2504 /***********************************************************************
2505  *
2506  *           HLPFILE_GetKeywords
2507  */
2508 static BOOL HLPFILE_GetKeywords(HLPFILE *hlpfile)
2509 {
2510     BYTE                *cbuf, *cend;
2511     unsigned            clen;
2512
2513     if (!HLPFILE_FindSubFile(hlpfile, "|KWBTREE", &cbuf, &cend)) return FALSE;
2514     clen = cend - cbuf;
2515     hlpfile->kwbtree = HeapAlloc(GetProcessHeap(), 0, clen);
2516     if (!hlpfile->kwbtree) return FALSE;
2517     memcpy(hlpfile->kwbtree, cbuf, clen);
2518
2519     if (!HLPFILE_FindSubFile(hlpfile, "|KWDATA", &cbuf, &cend))
2520     {
2521         WINE_ERR("corrupted help file: kwbtree present but kwdata absent\n");
2522         HeapFree(GetProcessHeap(), 0, hlpfile->kwbtree);
2523         return FALSE;
2524     }
2525     clen = cend - cbuf;
2526     hlpfile->kwdata = HeapAlloc(GetProcessHeap(), 0, clen);
2527     if (!hlpfile->kwdata)
2528     {
2529         HeapFree(GetProcessHeap(), 0, hlpfile->kwdata);
2530         return FALSE;
2531     }
2532     memcpy(hlpfile->kwdata, cbuf, clen);
2533
2534     return TRUE;
2535 }
2536
2537 /***********************************************************************
2538  *
2539  *           HLPFILE_GetMap
2540  */
2541 static BOOL HLPFILE_GetMap(HLPFILE *hlpfile)
2542 {
2543     BYTE                *cbuf, *cend;
2544     unsigned            entries, i;
2545
2546     if (!HLPFILE_FindSubFile(hlpfile, "|CTXOMAP",  &cbuf, &cend))
2547     {WINE_WARN("no map section\n"); return FALSE;}
2548
2549     entries = GET_USHORT(cbuf, 9);
2550     hlpfile->Map = HeapAlloc(GetProcessHeap(), 0, entries * sizeof(HLPFILE_MAP));
2551     if (!hlpfile->Map) return FALSE;
2552     hlpfile->wMapLen = entries;
2553     for (i = 0; i < entries; i++)
2554     {
2555         hlpfile->Map[i].lMap = GET_UINT(cbuf+11,i*8);
2556         hlpfile->Map[i].offset = GET_UINT(cbuf+11,i*8+4);
2557     }
2558     return TRUE;
2559 }
2560
2561 /***********************************************************************
2562  *
2563  *           DeleteMacro
2564  */
2565 static void HLPFILE_DeleteMacro(HLPFILE_MACRO* macro)
2566 {
2567     HLPFILE_MACRO*      next;
2568
2569     while (macro)
2570     {
2571         next = macro->next;
2572         HeapFree(GetProcessHeap(), 0, macro);
2573         macro = next;
2574     }
2575 }
2576
2577 /***********************************************************************
2578  *
2579  *           DeletePage
2580  */
2581 static void HLPFILE_DeletePage(HLPFILE_PAGE* page)
2582 {
2583     HLPFILE_PAGE* next;
2584
2585     while (page)
2586     {
2587         next = page->next;
2588         HLPFILE_DeleteMacro(page->first_macro);
2589         HeapFree(GetProcessHeap(), 0, page);
2590         page = next;
2591     }
2592 }
2593
2594 /***********************************************************************
2595  *
2596  *           HLPFILE_FreeHlpFile
2597  */
2598 void HLPFILE_FreeHlpFile(HLPFILE* hlpfile)
2599 {
2600     unsigned i;
2601
2602     if (!hlpfile || --hlpfile->wRefCount > 0) return;
2603
2604     if (hlpfile->next) hlpfile->next->prev = hlpfile->prev;
2605     if (hlpfile->prev) hlpfile->prev->next = hlpfile->next;
2606     else first_hlpfile = hlpfile->next;
2607
2608     if (hlpfile->numFonts)
2609     {
2610         for (i = 0; i < hlpfile->numFonts; i++)
2611         {
2612             DeleteObject(hlpfile->fonts[i].hFont);
2613         }
2614         HeapFree(GetProcessHeap(), 0, hlpfile->fonts);
2615     }
2616
2617     if (hlpfile->numBmps)
2618     {
2619         for (i = 0; i < hlpfile->numBmps; i++)
2620         {
2621             DeleteObject(hlpfile->bmps[i]);
2622         }
2623         HeapFree(GetProcessHeap(), 0, hlpfile->bmps);
2624     }
2625
2626     HLPFILE_DeletePage(hlpfile->first_page);
2627     HLPFILE_DeleteMacro(hlpfile->first_macro);
2628
2629     DestroyIcon(hlpfile->hIcon);
2630     if (hlpfile->numWindows)    HeapFree(GetProcessHeap(), 0, hlpfile->windows);
2631     HeapFree(GetProcessHeap(), 0, hlpfile->Context);
2632     HeapFree(GetProcessHeap(), 0, hlpfile->Map);
2633     HeapFree(GetProcessHeap(), 0, hlpfile->lpszTitle);
2634     HeapFree(GetProcessHeap(), 0, hlpfile->lpszCopyright);
2635     HeapFree(GetProcessHeap(), 0, hlpfile->file_buffer);
2636     HeapFree(GetProcessHeap(), 0, hlpfile->phrases_offsets);
2637     HeapFree(GetProcessHeap(), 0, hlpfile->phrases_buffer);
2638     HeapFree(GetProcessHeap(), 0, hlpfile->topic_map);
2639     HeapFree(GetProcessHeap(), 0, hlpfile->help_on_file);
2640     HeapFree(GetProcessHeap(), 0, hlpfile);
2641 }