git.oblomov.eu Git - wine/blob - dlls/hhctrl.ocx/index.c

   1 /*
   2  * Copyright 2007 Jacek Caban for CodeWeavers
   3  * Copyright 2010 Erich Hoover
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  18  */
  19
  20 #define NONAMELESSUNION
  21 #define NONAMELESSSTRUCT
  22
  23 #include "hhctrl.h"
  24 #include "stream.h"
  25
  26 #include "wine/debug.h"
  27
  28 WINE_DEFAULT_DEBUG_CHANNEL(htmlhelp);
  29
  30 /* Fill the TreeView object corresponding to the Index items */
  31 static void fill_index_tree(HWND hwnd, IndexItem *item)
  32 {
  33     int index = 0;
  34     LVITEMW lvi;
  35
  36     while(item) {
  37         TRACE("tree debug: %s\n", debugstr_w(item->keyword));
  38
  39         if(!item->keyword)
  40         {
  41             FIXME("HTML Help index item has no keyword.\n");
  42             item = item->next;
  43             continue;
  44         }
  45         memset(&lvi, 0, sizeof(lvi));
  46         lvi.iItem = index++;
  47         lvi.mask = LVIF_TEXT|LVIF_PARAM|LVIF_INDENT;
  48         lvi.iIndent = item->indentLevel;
  49         lvi.cchTextMax = strlenW(item->keyword)+1;
  50         lvi.pszText = item->keyword;
  51         lvi.lParam = (LPARAM)item;
  52         item->id = (HTREEITEM)SendMessageW(hwnd, LVM_INSERTITEMW, 0, (LPARAM)&lvi);
  53         item = item->next;
  54     }
  55 }
  56
  57 /* Parse the attributes correspond to a list item, including sub-topics.
  58  *
  59  * Each list item has, at minimum, a param of type "keyword" and two
  60  * parameters corresponding to a "sub-topic."  For each sub-topic there
  61  * must be a "name" param and a "local" param, if there is only one
  62  * sub-topic then there isn't really a sub-topic, the index will jump
  63  * directly to the requested item.
  64  */
  65 static void parse_index_obj_node_param(IndexItem *item, const char *text, UINT code_page)
  66 {
  67     const char *ptr;
  68     LPWSTR *param;
  69     int len;
  70
  71     ptr = get_attr(text, "name", &len);
  72     if(!ptr) {
  73         WARN("name attr not found\n");
  74         return;
  75     }
  76
  77     /* Allocate a new sub-item, either on the first run or whenever a
  78      * sub-topic has filled out both the "name" and "local" params.
  79      */
  80     if(item->itemFlags == 0x11 && (!strncasecmp("name", ptr, len) || !strncasecmp("local", ptr, len))) {
  81         item->nItems++;
  82         item->items = heap_realloc(item->items, sizeof(IndexSubItem)*item->nItems);
  83         item->items[item->nItems-1].name = NULL;
  84         item->items[item->nItems-1].local = NULL;
  85         item->itemFlags = 0x00;
  86     }
  87     if(!strncasecmp("keyword", ptr, len)) {
  88         param = &item->keyword;
  89     }else if(!item->keyword && !strncasecmp("name", ptr, len)) {
  90         /* Some HTML Help index files use an additional "name" parameter
  91          * rather than the "keyword" parameter.  In this case, the first
  92          * occurrence of the "name" parameter is the keyword.
  93          */
  94         param = &item->keyword;
  95     }else if(!strncasecmp("name", ptr, len)) {
  96         item->itemFlags |= 0x01;
  97         param = &item->items[item->nItems-1].name;
  98     }else if(!strncasecmp("local", ptr, len)) {
  99         item->itemFlags |= 0x10;
 100         param = &item->items[item->nItems-1].local;
 101     }else {
 102         WARN("unhandled param %s\n", debugstr_an(ptr, len));
 103         return;
 104     }
 105
 106     ptr = get_attr(text, "value", &len);
 107     if(!ptr) {
 108         WARN("value attr not found\n");
 109         return;
 110     }
 111
 112     *param = decode_html(ptr, len, code_page);
 113 }
 114
 115 /* Parse the object tag corresponding to a list item.
 116  *
 117  * At this step we look for all of the "param" child tags, using this information
 118  * to build up the information about the list item.  When we reach the </object>
 119  * tag we know that we've finished parsing this list item.
 120  */
 121 static IndexItem *parse_index_sitemap_object(HHInfo *info, stream_t *stream)
 122 {
 123     strbuf_t node, node_name;
 124     IndexItem *item;
 125
 126     strbuf_init(&node);
 127     strbuf_init(&node_name);
 128
 129     item = heap_alloc_zero(sizeof(IndexItem));
 130     item->nItems = 0;
 131     item->items = heap_alloc_zero(0);
 132     item->itemFlags = 0x11;
 133
 134     while(next_node(stream, &node)) {
 135         get_node_name(&node, &node_name);
 136
 137         TRACE("%s\n", node.buf);
 138
 139         if(!strcasecmp(node_name.buf, "param")) {
 140             parse_index_obj_node_param(item, node.buf, info->pCHMInfo->codePage);
 141         }else if(!strcasecmp(node_name.buf, "/object")) {
 142             break;
 143         }else {
 144             WARN("Unhandled tag! %s\n", node_name.buf);
 145         }
 146
 147         strbuf_zero(&node);
 148     }
 149
 150     strbuf_free(&node);
 151     strbuf_free(&node_name);
 152
 153     return item;
 154 }
 155
 156 /* Parse the HTML list item node corresponding to a specific help entry.
 157  *
 158  * At this stage we look for the only child tag we expect to find under
 159  * the list item: the <OBJECT> tag.  We also only expect to find object
 160  * tags with the "type" attribute set to "text/sitemap".
 161  */
 162 static IndexItem *parse_li(HHInfo *info, stream_t *stream)
 163 {
 164     strbuf_t node, node_name;
 165     IndexItem *ret = NULL;
 166
 167     strbuf_init(&node);
 168     strbuf_init(&node_name);
 169
 170     while(next_node(stream, &node)) {
 171         get_node_name(&node, &node_name);
 172
 173         TRACE("%s\n", node.buf);
 174
 175         if(!strcasecmp(node_name.buf, "object")) {
 176             const char *ptr;
 177             int len;
 178
 179             static const char sz_text_sitemap[] = "text/sitemap";
 180
 181             ptr = get_attr(node.buf, "type", &len);
 182
 183             if(ptr && len == sizeof(sz_text_sitemap)-1
 184                && !memcmp(ptr, sz_text_sitemap, len)) {
 185                 ret = parse_index_sitemap_object(info, stream);
 186                 break;
 187             }
 188         }else {
 189             WARN("Unhandled tag! %s\n", node_name.buf);
 190         }
 191
 192         strbuf_zero(&node);
 193     }
 194
 195     strbuf_free(&node);
 196     strbuf_free(&node_name);
 197
 198     return ret;
 199 }
 200
 201 /* Parse the HTML Help page corresponding to all of the Index items.
 202  *
 203  * At this high-level stage we locate out each HTML list item tag.
 204  * Since there is no end-tag for the <LI> item, we must hope that
 205  * the <LI> entry is parsed correctly or tags might get lost.
 206  *
 207  * Within each entry it is also possible to encounter an additional
 208  * <UL> tag.  When this occurs the tag indicates that the topics
 209  * contained within it are related to the parent <LI> topic and
 210  * should be inset by an indent.
 211  */
 212 static void parse_hhindex(HHInfo *info, IStream *str, IndexItem *item)
 213 {
 214     stream_t stream;
 215     strbuf_t node, node_name;
 216     int indent_level = -1;
 217
 218     strbuf_init(&node);
 219     strbuf_init(&node_name);
 220
 221     stream_init(&stream, str);
 222
 223     while(next_node(&stream, &node)) {
 224         get_node_name(&node, &node_name);
 225
 226         TRACE("%s\n", node.buf);
 227
 228         if(!strcasecmp(node_name.buf, "li")) {
 229             item->next = parse_li(info, &stream);
 230             item->next->merge = item->merge;
 231             item = item->next;
 232             item->indentLevel = indent_level;
 233         }else if(!strcasecmp(node_name.buf, "ul")) {
 234             indent_level++;
 235         }else if(!strcasecmp(node_name.buf, "/ul")) {
 236             indent_level--;
 237         }else {
 238             WARN("Unhandled tag! %s\n", node_name.buf);
 239         }
 240
 241         strbuf_zero(&node);
 242     }
 243
 244     strbuf_free(&node);
 245     strbuf_free(&node_name);
 246 }
 247
 248 /* Initialize the HTML Help Index tab */
 249 void InitIndex(HHInfo *info)
 250 {
 251     IStream *stream;
 252
 253     info->index = heap_alloc_zero(sizeof(IndexItem));
 254     info->index->nItems = 0;
 255     SetChmPath(&info->index->merge, info->pCHMInfo->szFile, info->WinType.pszIndex);
 256
 257     stream = GetChmStream(info->pCHMInfo, info->pCHMInfo->szFile, &info->index->merge);
 258     if(!stream) {
 259         TRACE("Could not get index stream\n");
 260         return;
 261     }
 262
 263     parse_hhindex(info, stream, info->index);
 264     IStream_Release(stream);
 265
 266     fill_index_tree(info->tabs[TAB_INDEX].hwnd, info->index->next);
 267 }
 268
 269 /* Free all of the Index items, including all of the "sub-items" that
 270  * correspond to different sub-topics.
 271  */
 272 void ReleaseIndex(HHInfo *info)
 273 {
 274     IndexItem *item = info->index, *next;
 275     int i;
 276
 277     if(!item) return;
 278     /* Note: item->merge is identical for all items, only free once */
 279     heap_free(item->merge.chm_file);
 280     heap_free(item->merge.chm_index);
 281     while(item) {
 282         next = item->next;
 283
 284         heap_free(item->keyword);
 285         for(i=0;i<item->nItems;i++) {
 286             heap_free(item->items[i].name);
 287             heap_free(item->items[i].local);
 288         }
 289         heap_free(item->items);
 290
 291         item = next;
 292     }
 293 }