hlpfile.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	HLPFILE_WINDOWINFO
struct	tagHlpFileLink
struct	tagHlpFileHotSpotLink
struct	tagHlpFileMacro
struct	tagHlpFilePage
struct	HLPFILE_MAP
struct	HLPFILE_FONT
struct	tagHlpFileFile
struct	RtfData

Macros
#define	HLP_DISPLAY30   0x01 /* version 3.0 displayable information */
#define	HLP_TOPICHDR   0x02 /* topic header information */
#define	HLP_DISPLAY   0x20 /* version 3.1 displayable information */
#define	HLP_TABLE   0x23 /* version 3.1 table */

Typedefs
typedef struct tagHlpFileLink	HLPFILE_LINK
typedef struct tagHlpFileHotSpotLink	HLPFILE_HOTSPOTLINK
typedef struct tagHlpFileMacro	HLPFILE_MACRO
typedef struct tagHlpFilePage	HLPFILE_PAGE
typedef struct tagHlpFileFile	HLPFILE
typedef int(*	HLPFILE_BPTreeCompare) (void *p, const void *key, int leaf, void **next)
typedef void(*	HLPFILE_BPTreeCallback) (void *p, void **next, void *cookie)

Functions
HLPFILE *	HLPFILE_ReadHlpFile (LPCSTR lpszPath)
HLPFILE_PAGE *	HLPFILE_PageByHash (HLPFILE *hlpfile, LONG lHash, ULONG *relative)
HLPFILE_PAGE *	HLPFILE_PageByMap (HLPFILE *hlpfile, LONG lMap, ULONG *relative)
HLPFILE_PAGE *	HLPFILE_PageByOffset (HLPFILE *hlpfile, LONG offset, ULONG *relative)
LONG	HLPFILE_Hash (LPCSTR lpszContext)
void	HLPFILE_FreeHlpFile (HLPFILE *)
void	HLPFILE_BPTreeEnum (BYTE *, HLPFILE_BPTreeCallback cb, void *cookie)
BOOL	HLPFILE_BrowsePage (HLPFILE_PAGE *, struct RtfData *rd, unsigned font_scale, unsigned relative)

Macro Definition Documentation

HLP_DISPLAY

#define HLP_DISPLAY   0x20 /* version 3.1 displayable information */

Definition at line 210 of file hlpfile.h.

Referenced by HLPFILE_BrowsePage(), HLPFILE_BrowseParagraph(), HLPFILE_DoReadHlpFile(), and HLPFILE_SkipParagraph().

HLP_DISPLAY30

#define HLP_DISPLAY30   0x01 /* version 3.0 displayable information */

Definition at line 208 of file hlpfile.h.

Referenced by HLPFILE_BrowsePage(), HLPFILE_BrowseParagraph(), and HLPFILE_DoReadHlpFile().

HLP_TABLE

#define HLP_TABLE   0x23 /* version 3.1 table */

Definition at line 211 of file hlpfile.h.

Referenced by HLPFILE_BrowsePage(), HLPFILE_BrowseParagraph(), HLPFILE_DoReadHlpFile(), and HLPFILE_SkipParagraph().

HLP_TOPICHDR

#define HLP_TOPICHDR   0x02 /* topic header information */

Definition at line 209 of file hlpfile.h.

Referenced by HLPFILE_BrowsePage(), and HLPFILE_DoReadHlpFile().

Typedef Documentation

HLPFILE

typedef struct tagHlpFileFile HLPFILE

HLPFILE_BPTreeCallback

typedef void(* HLPFILE_BPTreeCallback) (void *p, void **next, void *cookie)

Definition at line 179 of file hlpfile.h.

HLPFILE_BPTreeCompare

typedef int(* HLPFILE_BPTreeCompare) (void *p, const void *key, int leaf, void **next)

Definition at line 168 of file hlpfile.h.

HLPFILE_HOTSPOTLINK

typedef struct tagHlpFileHotSpotLink HLPFILE_HOTSPOTLINK

HLPFILE_LINK

typedef struct tagHlpFileLink HLPFILE_LINK

HLPFILE_MACRO

typedef struct tagHlpFileMacro HLPFILE_MACRO

HLPFILE_PAGE

typedef struct tagHlpFilePage HLPFILE_PAGE

Function Documentation

HLPFILE_BPTreeEnum()

void HLPFILE_BPTreeEnum	(	BYTE *	,
		HLPFILE_BPTreeCallback	cb,
		void *	cookie
	)

Definition at line 125 of file hlpfile.c.

Referenced by WINHELP_IndexDlgProc().

{
    unsigned magic;
    unsigned page_size;
    unsigned cur_page;
    unsigned level;
    BYTE *pages, *ptr, *newptr;
    int i, entries;

    magic = GET_USHORT(buf, 9);
    if (magic != 0x293B)
    {
        WINE_ERR("Invalid magic in B+ tree: 0x%x\n", magic);
        return;
    }
    page_size = GET_USHORT(buf, 9+4);
    cur_page  = GET_USHORT(buf, 9+26);
    level     = GET_USHORT(buf, 9+32);
    pages     = buf + 9 + 38;
    while (--level > 0)
    {
        ptr = pages + cur_page*page_size;
        cur_page = GET_USHORT(ptr, 4);
    }
    while (cur_page != 0xFFFF)
    {
        ptr = pages + cur_page*page_size;
        entries = GET_SHORT(ptr, 2);
        ptr += 8;
        for (i = 0; i < entries; i++)
        {
            cb(ptr, (void **)&newptr, cookie);
            ptr = newptr;
        }
        cur_page = GET_USHORT(pages+cur_page*page_size, 6);
    }
}

HLPFILE_BrowsePage()

BOOL HLPFILE_BrowsePage	(	HLPFILE_PAGE *	,
		struct RtfData *	rd,
		unsigned	font_scale,
		unsigned	relative
	)

Definition at line 1703 of file hlpfile.c.

Referenced by WINHELP_SetupText().

{
    HLPFILE     *hlpfile = page->file;
    BYTE        *buf, *end;
    DWORD       ref = page->reference;
    unsigned    index, old_index = -1, offset, count = 0, offs = 0;
    unsigned    cpg, parlen;
    char        tmp[1024];
    const char* ck = NULL;

    rd->in_text = TRUE;
    rd->data = rd->ptr = HeapAlloc(GetProcessHeap(), 0, rd->allocated = 32768);
    rd->char_pos = 0;
    rd->first_link = rd->current_link = NULL;
    rd->force_color = FALSE;
    rd->font_scale = font_scale;
    rd->relative = relative;
    rd->char_pos_rel = 0;

    switch (hlpfile->charset)
    {
    case DEFAULT_CHARSET:
    case ANSI_CHARSET:          cpg = 1252; break;
    case SHIFTJIS_CHARSET:      cpg = 932; break;
    case HANGEUL_CHARSET:       cpg = 949; break;
    case GB2312_CHARSET:        cpg = 936; break;
    case CHINESEBIG5_CHARSET:   cpg = 950; break;
    case GREEK_CHARSET:         cpg = 1253; break;
    case TURKISH_CHARSET:       cpg = 1254; break;
    case HEBREW_CHARSET:        cpg = 1255; break;
    case ARABIC_CHARSET:        cpg = 1256; break;
    case BALTIC_CHARSET:        cpg = 1257; break;
    case VIETNAMESE_CHARSET:    cpg = 1258; break;
    case RUSSIAN_CHARSET:       cpg = 1251; break;
    case EE_CHARSET:            cpg = 1250; break;
    case THAI_CHARSET:          cpg = 874; break;
    case JOHAB_CHARSET:         cpg = 1361; break;
    case MAC_CHARSET:           ck = "mac"; break;
    default:
        WINE_FIXME("Unsupported charset %u\n", hlpfile->charset);
        cpg = 1252;
    }
    if (ck)
    {
        sprintf(tmp, "{\\rtf1\\%s\\deff0", ck);
        if (!HLPFILE_RtfAddControl(rd, tmp)) return FALSE;
    }
    else
    {
        sprintf(tmp, "{\\rtf1\\ansi\\ansicpg%d\\deff0", cpg);
        if (!HLPFILE_RtfAddControl(rd, tmp)) return FALSE;
    }

    /* generate font table */
    if (!HLPFILE_RtfAddControl(rd, "{\\fonttbl")) return FALSE;
    for (index = 0; index < hlpfile->numFonts; index++)
    {
        const char* family;
        switch (hlpfile->fonts[index].LogFont.lfPitchAndFamily & 0xF0)
        {
        case FF_MODERN:     family = "modern";  break;
        case FF_ROMAN:      family = "roman";   break;
        case FF_SWISS:      family = "swiss";   break;
        case FF_SCRIPT:     family = "script";  break;
        case FF_DECORATIVE: family = "decor";   break;
        default:            family = "nil";     break;
        }
        sprintf(tmp, "{\\f%d\\f%s\\fprq%d\\fcharset%d %s;}",
                index, family,
                hlpfile->fonts[index].LogFont.lfPitchAndFamily & 0x0F,
                hlpfile->fonts[index].LogFont.lfCharSet,
                hlpfile->fonts[index].LogFont.lfFaceName);
        if (!HLPFILE_RtfAddControl(rd, tmp)) return FALSE;
    }
    if (!HLPFILE_RtfAddControl(rd, "}")) return FALSE;
    /* generate color table */
    if (!HLPFILE_RtfAddControl(rd, "{\\colortbl ;\\red0\\green128\\blue0;")) return FALSE;
    for (index = 0; index < hlpfile->numFonts; index++)
    {
        sprintf(tmp, "\\red%d\\green%d\\blue%d;",
                GetRValue(hlpfile->fonts[index].color),
                GetGValue(hlpfile->fonts[index].color),
                GetBValue(hlpfile->fonts[index].color));
        if (!HLPFILE_RtfAddControl(rd, tmp)) return FALSE;
    }
    if (!HLPFILE_RtfAddControl(rd, "}")) return FALSE;

    do
    {
        if (hlpfile->version <= 16)
        {
            index  = (ref - 0x0C) / hlpfile->dsize;
            offset = (ref - 0x0C) % hlpfile->dsize;
        }
        else
        {
            index  = (ref - 0x0C) >> 14;
            offset = (ref - 0x0C) & 0x3FFF;
        }

        if (hlpfile->version <= 16 && index != old_index && old_index != -1)
        {
            /* we jumped to the next block, adjust pointers */
            ref -= 12;
            offset -= 12;
        }

        if (index >= hlpfile->topic_maplen) {WINE_WARN("maplen\n"); break;}
        buf = hlpfile->topic_map[index] + offset;
        if (buf + 0x15 >= hlpfile->topic_end) {WINE_WARN("extra\n"); break;}
        end = min(buf + GET_UINT(buf, 0), hlpfile->topic_end);
        if (index != old_index) {offs = 0; old_index = index;}

        switch (buf[0x14])
        {
        case HLP_TOPICHDR:
            if (count++) goto done;
            break;
        case HLP_DISPLAY30:
        case HLP_DISPLAY:
        case HLP_TABLE:
            if (!HLPFILE_BrowseParagraph(page, rd, buf, end, &parlen)) return FALSE;
            if (relative > index * 0x8000 + offs)
                rd->char_pos_rel = rd->char_pos;
            offs += parlen;
            break;
        default:
            WINE_ERR("buf[0x14] = %x\n", buf[0x14]);
        }
        if (hlpfile->version <= 16)
        {
            ref += GET_UINT(buf, 0xc);
            if (GET_UINT(buf, 0xc) == 0)
                break;
        }
        else
            ref = GET_UINT(buf, 0xc);
    } while (ref != 0xffffffff);
done:
    page->first_link = rd->first_link;
    return HLPFILE_RtfAddControl(rd, "}");
}

HLPFILE_FreeHlpFile()

void HLPFILE_FreeHlpFile

(

HLPFILE *

)

Definition at line 2297 of file hlpfile.c.

Referenced by HLPFILE_ReadHlpFile(), WINHELP_DeleteBackSet(), WINHELP_DeleteWindow(), and WINHELP_RememberPage().

{
    unsigned i;

    if (!hlpfile || --hlpfile->wRefCount > 0) return;

    if (hlpfile->next) hlpfile->next->prev = hlpfile->prev;
    if (hlpfile->prev) hlpfile->prev->next = hlpfile->next;
    else first_hlpfile = hlpfile->next;

    if (hlpfile->numFonts)
    {
        for (i = 0; i < hlpfile->numFonts; i++)
        {
            DeleteObject(hlpfile->fonts[i].hFont);
        }
        HeapFree(GetProcessHeap(), 0, hlpfile->fonts);
    }

    if (hlpfile->numBmps)
    {
        for (i = 0; i < hlpfile->numBmps; i++)
        {
            DeleteObject(hlpfile->bmps[i]);
        }
        HeapFree(GetProcessHeap(), 0, hlpfile->bmps);
    }

    HLPFILE_DeletePage(hlpfile->first_page);
    HLPFILE_DeleteMacro(hlpfile->first_macro);

    DestroyIcon(hlpfile->hIcon);
    if (hlpfile->numWindows)    HeapFree(GetProcessHeap(), 0, hlpfile->windows);
    HeapFree(GetProcessHeap(), 0, hlpfile->Context);
    HeapFree(GetProcessHeap(), 0, hlpfile->Map);
    HeapFree(GetProcessHeap(), 0, hlpfile->lpszTitle);
    HeapFree(GetProcessHeap(), 0, hlpfile->lpszCopyright);
    HeapFree(GetProcessHeap(), 0, hlpfile->file_buffer);
    HeapFree(GetProcessHeap(), 0, hlpfile->phrases_offsets);
    HeapFree(GetProcessHeap(), 0, hlpfile->phrases_buffer);
    HeapFree(GetProcessHeap(), 0, hlpfile->topic_map);
    HeapFree(GetProcessHeap(), 0, hlpfile->help_on_file);
    HeapFree(GetProcessHeap(), 0, hlpfile);
}

HLPFILE_Hash()

LONG HLPFILE_Hash

(

LPCSTR

lpszContext

)

Definition at line 547 of file hlpfile.c.

Referenced by HLPFILE_AddHotSpotLinks(), MACRO_JumpID(), and WinMain().

{
    LONG lHash = 0;
    CHAR c;

    while ((c = *lpszContext++))
    {
        CHAR x = 0;
        if (c >= 'A' && c <= 'Z') x = c - 'A' + 17;
        if (c >= 'a' && c <= 'z') x = c - 'a' + 17;
        if (c >= '1' && c <= '9') x = c - '0';
        if (c == '0') x = 10;
        if (c == '.') x = 12;
        if (c == '_') x = 13;
        if (x) lHash = lHash * 43 + x;
    }
    return lHash;
}

HLPFILE_PageByHash()

HLPFILE_PAGE* HLPFILE_PageByHash	(	HLPFILE *	hlpfile,
		LONG	lHash,
		ULONG *	relative
	)

Definition at line 437 of file hlpfile.c.

Referenced by MACRO_JumpContents(), MACRO_JumpHash(), WINHELP_HandleTextMouse(), and WinMain().

{
    BYTE *ptr;

    if (!hlpfile) return NULL;
    if (!lHash) return HLPFILE_Contents(hlpfile, relative);

    WINE_TRACE("<%s>[%x]\n", debugstr_a(hlpfile->lpszPath), lHash);

    /* For win 3.0 files hash values are really page numbers */
    if (hlpfile->version <= 16)
    {
        if (lHash >= hlpfile->wTOMapLen) return NULL;
        return HLPFILE_PageByOffset(hlpfile, hlpfile->TOMap[lHash], relative);
    }

    ptr = HLPFILE_BPTreeSearch(hlpfile->Context, LongToPtr(lHash), comp_PageByHash);
    if (!ptr)
    {
        WINE_ERR("Page of hash %x not found in file %s\n", lHash, debugstr_a(hlpfile->lpszPath));
        return NULL;
    }

    return HLPFILE_PageByOffset(hlpfile, GET_UINT(ptr, 4), relative);
}

HLPFILE_PageByMap()

HLPFILE_PAGE* HLPFILE_PageByMap	(	HLPFILE *	hlpfile,
		LONG	lMap,
		ULONG *	relative
	)

Definition at line 467 of file hlpfile.c.

Referenced by MACRO_JumpContext().

{
    unsigned int i;

    if (!hlpfile) return 0;

    WINE_TRACE("<%s>[%x]\n", debugstr_a(hlpfile->lpszPath), lMap);

    for (i = 0; i < hlpfile->wMapLen; i++)
    {
        if (hlpfile->Map[i].lMap == lMap)
            return HLPFILE_PageByOffset(hlpfile, hlpfile->Map[i].offset, relative);
    }

    WINE_ERR("Page of Map %x not found in file %s\n", lMap, debugstr_a(hlpfile->lpszPath));
    return NULL;
}

HLPFILE_PageByOffset()

HLPFILE_PAGE* HLPFILE_PageByOffset	(	HLPFILE *	hlpfile,
		LONG	offset,
		ULONG *	relative
	)

Definition at line 369 of file hlpfile.c.

Referenced by HLPFILE_Contents(), HLPFILE_PageByHash(), HLPFILE_PageByMap(), MACRO_BrowseButtons(), MACRO_Next(), MACRO_Prev(), and WINHELP_CreateIndexWindow().

{
    HLPFILE_PAGE*       page;
    HLPFILE_PAGE*       found;

    if (!hlpfile) return 0;

    WINE_TRACE("<%s>[%x]\n", debugstr_a(hlpfile->lpszPath), offset);

    if (offset == 0xFFFFFFFF) return NULL;
    page = NULL;

    for (found = NULL, page = hlpfile->first_page; page; page = page->next)
    {
        if (page->offset <= offset && (!found || found->offset < page->offset))
        {
            *relative = offset - page->offset;
            found = page;
        }
    }
    if (!found)
        WINE_ERR("Page of offset %u not found in file %s\n",
                 offset, debugstr_a(hlpfile->lpszPath));
    return found;
}

HLPFILE_ReadHlpFile()

HLPFILE* HLPFILE_ReadHlpFile

(

LPCSTR

lpszPath

)

Definition at line 2759 of file hlpfile.c.

Referenced by WINHELP_LookupHelpFile().

{
    HLPFILE*      hlpfile;

    for (hlpfile = first_hlpfile; hlpfile; hlpfile = hlpfile->next)
    {
        if (!strcmp(lpszPath, hlpfile->lpszPath))
        {
            hlpfile->wRefCount++;
            return hlpfile;
        }
    }

    hlpfile = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
                        sizeof(HLPFILE) + strlen(lpszPath) + 1);
    if (!hlpfile) return 0;

    hlpfile->lpszPath           = (char*)hlpfile + sizeof(HLPFILE);
    hlpfile->contents_start     = 0xFFFFFFFF;
    hlpfile->next               = first_hlpfile;
    hlpfile->wRefCount          = 1;

    strcpy(hlpfile->lpszPath, lpszPath);

    first_hlpfile = hlpfile;
    if (hlpfile->next) hlpfile->next->prev = hlpfile;

    if (!HLPFILE_DoReadHlpFile(hlpfile, lpszPath))
    {
        HLPFILE_FreeHlpFile(hlpfile);
        hlpfile = 0;
    }

    return hlpfile;
}