chmc.h File Reference

#include <stdlib.h>
#include <limits.h>
#include "chm.h"
#include "list.h"

Include dependency graph for chmc.h:

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

Go to the source code of this file.

Classes
struct	chmcIndexHeader
struct	chmcSystemEntry
struct	chmcSystemEntryNode
struct	chmcSystemInfo
struct	chmcSystem
struct	chmcPmglChunk
struct	chmcPmglChunkNode
struct	chmcPmgiChunk
struct	chmcPmgiChunkNode
struct	chmcTreeNode
struct	chmcStringChunk
struct	chmcConfig
struct	chmcFile
struct	chmcSection
struct	chmcResetTableMark
struct	chmcUrlStrEntry
struct	chmcUtlTblEntry
struct	chmcTopicEntry

Macros
#define	PATH_MAX   260
#define	CHMC_DIR_UUID   "\x10\xfd\x01\x7c\xaa\x7b\xd0\x11\x9e\x0c\x00\xa0\xc9\x22\xe6\xec"
#define	CHMC_STREAM_UUID   "\x11\xfd\x01\x7c\xaa\x7b\xd0\x11\x9e\x0c\x00\xa0\xc9\x22\xe6\xec"
#define	CHMC_SYSTEM_UUID   "\x6a\x92\x02\x5d\x2e\x21\xd0\x11\x9d\xf9\x00\xa0\xc9\x22\xe6\xec"
#define	SIEC_DEFTOPIC   2
#define	SIEC_TITLE   3
#define	SIEC_LCASEFILE   6
#define	SIEC_DEFWINDOW   5
#define	SIEC_HAVE_BINDX   7
#define	SIEC_NUMOFINFOT   12
#define	SIEC_IDXHDR   13
#define	SIEC_INFOCHKSUM   15
#define	SIEC_DEFFONT   16
#define	SIEC_TIMESTAMP   10
#define	SIEC_COMPVER   9
#define	SIEC_SYSINFO   4
#define	_CHMC_SYS_ENTRY_HDR_LEN   (sizeof(UInt16)*2)
#define	_CHMC_SYS_ENTRY_NODE_HDR_LEN   (sizeof(struct chmcSystemEntryNode *)+_CHMC_SYS_ENTRY_HDR_LEN)
#define	_CHMC_SYS_INFO_V4_72_7294_LEN   (28)
#define	_CHMC_SYS_INFO_V4_72_8086_LEN   (36)
#define	CHMC_MS_LCID_EN_US   (0x0409)
#define	_CHMC_SYSTEM_HDR_LEN   (sizeof(Int32)+sizeof(struct chmcSystemInfo))
#define	_CHMC_CHUNK_LEN   (4096)
#define	CHMC_PMGL_DATA_LEN   (_CHMC_CHUNK_LEN - _CHMC_PMGL_LEN - 2)
#define	CHMC_PMGI_DATA_LEN   (_CHMC_CHUNK_LEN - _CHMC_PMGI_LEN - 2)
#define	CHMC_TNFL_STATIC   (1 << 0) /* don't free() */
#define	CHMC_SECTNAME_MAXLEN   (64)
#define	_CHMC_RSTTBL_MARK   (sizeof(struct chmcResetTableMark))
#define	chmc_dump(fmt, ...)   fprintf(stderr, fmt , ## __VA_ARGS__)

Functions
int	chmc_init (struct chmcFile *chm, const char *filename, struct chmcConfig *config)
void	chmc_sections_done (struct chmcFile *chm)
void	chmc_term (struct chmcFile *chm)
int	chmc_tree_done (struct chmcFile *chm)

Macro Definition Documentation

_CHMC_CHUNK_LEN

#define _CHMC_CHUNK_LEN   (4096)

Definition at line 133 of file chmc.h.

_CHMC_RSTTBL_MARK

#define _CHMC_RSTTBL_MARK   (sizeof(struct chmcResetTableMark))

Definition at line 230 of file chmc.h.

_CHMC_SYS_ENTRY_HDR_LEN

#define _CHMC_SYS_ENTRY_HDR_LEN   (sizeof(UInt16)*2)

Definition at line 88 of file chmc.h.

_CHMC_SYS_ENTRY_NODE_HDR_LEN

#define _CHMC_SYS_ENTRY_NODE_HDR_LEN   (sizeof(struct chmcSystemEntryNode *)+_CHMC_SYS_ENTRY_HDR_LEN)

Definition at line 96 of file chmc.h.

_CHMC_SYS_INFO_V4_72_7294_LEN

#define _CHMC_SYS_INFO_V4_72_7294_LEN   (28)

Definition at line 105 of file chmc.h.

_CHMC_SYS_INFO_V4_72_8086_LEN

#define _CHMC_SYS_INFO_V4_72_8086_LEN   (36)

Definition at line 107 of file chmc.h.

_CHMC_SYSTEM_HDR_LEN

#define _CHMC_SYSTEM_HDR_LEN   (sizeof(Int32)+sizeof(struct chmcSystemInfo))

Definition at line 123 of file chmc.h.

CHMC_DIR_UUID

#define CHMC_DIR_UUID   "\x10\xfd\x01\x7c\xaa\x7b\xd0\x11\x9e\x0c\x00\xa0\xc9\x22\xe6\xec"

Definition at line 34 of file chmc.h.

chmc_dump

#define chmc_dump	(		fmt,
			...
	)		fprintf(stderr, fmt , ## __VA_ARGS__)

Definition at line 263 of file chmc.h.

CHMC_MS_LCID_EN_US

#define CHMC_MS_LCID_EN_US   (0x0409)

Definition at line 121 of file chmc.h.

CHMC_PMGI_DATA_LEN

#define CHMC_PMGI_DATA_LEN   (_CHMC_CHUNK_LEN - _CHMC_PMGI_LEN - 2)

Definition at line 149 of file chmc.h.

CHMC_PMGL_DATA_LEN

#define CHMC_PMGL_DATA_LEN   (_CHMC_CHUNK_LEN - _CHMC_PMGL_LEN - 2)

Definition at line 134 of file chmc.h.

CHMC_SECTNAME_MAXLEN

#define CHMC_SECTNAME_MAXLEN   (64)

Definition at line 215 of file chmc.h.

CHMC_STREAM_UUID

#define CHMC_STREAM_UUID   "\x11\xfd\x01\x7c\xaa\x7b\xd0\x11\x9e\x0c\x00\xa0\xc9\x22\xe6\xec"

Definition at line 36 of file chmc.h.

CHMC_SYSTEM_UUID

#define CHMC_SYSTEM_UUID   "\x6a\x92\x02\x5d\x2e\x21\xd0\x11\x9d\xf9\x00\xa0\xc9\x22\xe6\xec"

Definition at line 38 of file chmc.h.

CHMC_TNFL_STATIC

#define CHMC_TNFL_STATIC   (1 << 0) /* don't free() */

Definition at line 164 of file chmc.h.

PATH_MAX

#define PATH_MAX   260

Definition at line 31 of file chmc.h.

SIEC_COMPVER

#define SIEC_COMPVER   9

Definition at line 84 of file chmc.h.

SIEC_DEFFONT

#define SIEC_DEFFONT   16

Definition at line 81 of file chmc.h.

SIEC_DEFTOPIC

#define SIEC_DEFTOPIC   2

Definition at line 66 of file chmc.h.

SIEC_DEFWINDOW

#define SIEC_DEFWINDOW   5

Definition at line 69 of file chmc.h.

SIEC_HAVE_BINDX

#define SIEC_HAVE_BINDX   7

Definition at line 74 of file chmc.h.

SIEC_IDXHDR

#define SIEC_IDXHDR   13

Definition at line 78 of file chmc.h.

SIEC_INFOCHKSUM

#define SIEC_INFOCHKSUM   15

Definition at line 80 of file chmc.h.

SIEC_LCASEFILE

#define SIEC_LCASEFILE   6

Definition at line 68 of file chmc.h.

SIEC_NUMOFINFOT

#define SIEC_NUMOFINFOT   12

Definition at line 75 of file chmc.h.

SIEC_SYSINFO

#define SIEC_SYSINFO   4

Definition at line 85 of file chmc.h.

SIEC_TIMESTAMP

#define SIEC_TIMESTAMP   10

Definition at line 83 of file chmc.h.

SIEC_TITLE

#define SIEC_TITLE   3

Definition at line 67 of file chmc.h.

Function Documentation

chmc_init()

int chmc_init	(	struct chmcFile *	chm,
		const char *	filename,
		struct chmcConfig *	config
	)

Definition at line 133 of file chmc.c.

{
    struct chmcItsfHeader *itsf = &chm->itsf;
    struct chmcSect0 *sect0 = &chm->sect0;
    struct chmcItspHeader *itsp = &chm->itsp;
    struct chmcSystem *system = &chm->system;
    struct chmcSystemInfo *sysinfo = &chm->system.info;
    struct chmcIndexHeader *idxhdr = &chm->idxhdr;

    assert(chm);
    assert(filename);

    chmcerr_clean();

    memset(chm, 0, sizeof(struct chmcFile));

    chm->config = config;

    if (strcmp(filename, "-") != 0) {
        chm->fd = open(filename, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0644);
        if (chm->fd < 0) {
            chmcerr_set(errno, strerror(errno));
            chmcerr_return_msg("creat file '%s'", filename);
        }
    } else {
        chm->fd = fileno(stdout);
    }

    memcpy(itsf->signature, "ITSF", 4);
    itsf->version = 3;
    itsf->header_len = _CHMC_ITSF_V3_LEN;
    itsf->unknown_000c = 1;

    itsf->lang_id = chm->config->language;
    memcpy(itsf->dir_uuid, CHMC_DIR_UUID, 16);
    memcpy(itsf->stream_uuid, CHMC_STREAM_UUID, 16);
    itsf->dir_offset = _CHMC_ITSF_V3_LEN + _CHMC_SECT0_LEN;

    itsf->sect0_offset = _CHMC_ITSF_V3_LEN;
    itsf->sect0_len = _CHMC_SECT0_LEN;

    sect0->file_len = _CHMC_ITSF_V3_LEN
        + _CHMC_SECT0_LEN
        + _CHMC_ITSP_V1_LEN;

    sect0->unknown_0000 = 510;

    memcpy(itsp->signature, "ITSP", 4);
    itsp->version = 1;
    itsp->header_len = _CHMC_ITSP_V1_LEN;
    itsp->unknown_000c = 10;
    itsp->block_len = _CHMC_CHUNK_LEN;
    itsp->blockidx_intvl = CHM_IDX_INTVL;
    itsp->index_depth = 2;

    itsp->unknown_0028 = -1;
    itsp->lang_id = CHMC_MS_LCID_EN_US;
    memcpy(itsp->system_uuid, CHMC_SYSTEM_UUID, 16);
    itsp->header_len2 = _CHMC_ITSP_V1_LEN;
    memset(itsp->unknown_0048, -1, 12);

    system->version = 3;
    system->_size = _CHMC_SYSTEM_HDR_LEN + sizeof(struct chmcIndexHeader);

    sysinfo->lcid = CHMC_MS_LCID_EN_US;

    memcpy(idxhdr->signature, "T#SM", 4);
    idxhdr->unknown_4 = 28582569; // FIXME got from some chm
    idxhdr->unknown_8 = 1;
    //   idxhdr->full_search = 1;
    //   idxhdr->klinks = 1;
    //   idxhdr->alinks = 0;
    //   idxhdr->timestamp = ???;

    //   idxhdr->num_of_topic = 2; // sorry??
    idxhdr->off_img_list = -1;
    //   idxhdr->img_type_folder;
    idxhdr->background = -1;
    idxhdr->foreground = -1;
    idxhdr->off_font = -1;
    idxhdr->win_style = -1;
    idxhdr->ex_win_style = -1;
    idxhdr->unknown_34 = -1;
    idxhdr->off_frame_name = -1;
    idxhdr->off_win_name = -1;
    //   idxhdr->num_of_info;
    idxhdr->unknown_44 = 1;
    //   idxhdr->num_of_merge_files;
    //   idxhdr->unknown_4c;

    INIT_LIST_HEAD(&chm->sections_list);
    INIT_LIST_HEAD(&chm->pmgl_list);
    INIT_LIST_HEAD(&chm->entries_list);
    INIT_LIST_HEAD(&chm->pmgi_list);

    chm->strings = malloc(4096);
    memset(chm->strings, 0, 4096);
    chm->strings_len = 4096;
    chm->strings_offset = 1;

    if (chmc_section_add(chm, "Uncompressed") != CHMC_NOERR)
        chmcerr_return_msg("adding section: Uncompressed");

    if (chmc_section_add(chm, "MSCompressed") != CHMC_NOERR)
        chmcerr_return_msg("adding section: MSCompressed");

    chmc_sections_done(chm);

    return CHMC_NOERR;
}

Referenced by main().

chmc_sections_done()

void chmc_sections_done

(

struct chmcFile *

chm

)

Definition at line 348 of file chmc.c.

{
    int len;
    int i;

    assert(chm);

    chm->sections = malloc(sizeof(struct chmcSection *) * chm->sections_num);
    if (chm->sections) {
        struct chmcSection *section;
        struct list_head *pos;

        i = 0;
        len = 4;
        list_for_each(pos, &chm->sections_list) {
            section = list_entry(pos, struct chmcSection, list);
            len += 4 + strlen(section->name) * 2;
            chm->sections[i++] = section;
        }
        chmc_namelist_create(chm, len);
    } else
        BUG_ON("FIXME: %s: %d\n", __FILE__, __LINE__);
}

Referenced by chmc_init().

chmc_term()

void chmc_term

(

struct chmcFile *

chm

)

Definition at line 461 of file chmc.c.

{
    assert(chm);
    assert(chm->fd > -1);

    free(chm->strings);

    chmc_entries_free(chm);
    chmc_pmgl_free(chm);
    chmc_pmgi_free(chm);
    if (chm->sections)
        free(chm->sections);
    chmc_sections_free(chm);

    if (chm->fd != fileno(stdout))
        close(chm->fd);
}

Referenced by main().

chmc_tree_done()

int chmc_tree_done

(

struct chmcFile *

chm

)

Definition at line 728 of file chmc.c.

{
    struct chmcItsfHeader *itsf;
    struct chmcSect0 *sect0;
    struct chmcItspHeader *itsp;
    struct chmcTreeNode *ctrl;
    UInt32 str_index;
    const char *val;

    assert(chm);

    itsf = &chm->itsf;
    sect0 = &chm->sect0;
    itsp = &chm->itsp;

    chmc_add_dir(chm, "/");

    ctrl = chmc_add_meta(chm, "::DataSpace/Storage/MSCompressed/Transform/List",
                         0, (UChar *)chmc_transform_list,
                         sizeof(chmc_transform_list));
    if (ctrl)
        ctrl->flags |= CHMC_TNFL_STATIC;

    chmc_system_done(chm);

    if (chm->config != NULL && chm->config->deftopic != NULL)
        val = chm->config->deftopic;
    else
        val = "index.htm";

    str_index = chmc_strings_add(chm, val);

#if 0
    // FIXME just a test
    {
        UChar *p;
        int len;
        struct chmcTopicEntry topicEntry;
        //     struct chmcUrlStrEntry urlStrEntry;

        p = malloc(4096);
        if (p) {
            memset(p, 0, 4096);
            len = 0;

            topicEntry.tocidx_offset = 4096;
            topicEntry.strings_offset = -1;
            topicEntry.urltbl_offset = 0;
            topicEntry.in_content = 6;
            topicEntry.unknown = 0;

            memcpy(p, &topicEntry, sizeof(struct chmcTopicEntry));
            len += sizeof(struct chmcTopicEntry);

            chm->idxhdr.num_of_topic++;

            chmc_add_meta(chm, "/#TOPICS", 1, (UChar *)p, len);
        } else
            BUG_ON("FIXME: %s: %d\n", __FILE__, __LINE__);
    }
#endif

    ctrl = chmc_add_meta(chm, "/#IDXHDR", 1, (void *)&chm->idxhdr,
                         sizeof(struct chmcIndexHeader));
    if (ctrl)
        ctrl->flags |= CHMC_TNFL_STATIC;

    {
        UInt32 *p;
        p = malloc(8+196);
        if (p) {
            const char *val;
            memset(p+2, 0, 196);

            p[0] = 1;
            p[1] = 196;

            p[2+0] = 196;
            //       p[2+2] = 1;
            //       p[2+3] = 0x00000532;
            //       p[2+4] = 0x00062520;

            //       p[2+8] = 86;
            //       p[2+9] = 51;
            //       p[2+10] = 872;
            //       p[2+11] = 558;

            //       p[2+19] = 220;

            //       p[2+27] = 0x00000041;
            //       p[2+28] = 14462;

            if (chm->config != NULL && chm->config->title != NULL)
                val = chm->config->title;
            else
                val = "untitled";
            p[2+5] = chmc_strings_add(chm, val);

            if (chm->config != NULL && chm->config->hhc != NULL)
                val = chm->config->hhc;
            else
                val = "toc.hhc";
            p[2+24] = chmc_strings_add(chm, val);

            if (chm->config != NULL && chm->config->hhk != NULL)
                val = chm->config->hhc;
            else
                val = "toc.hhk";
            p[2+25] = chmc_strings_add(chm, val);
            p[2+26] = str_index;

            chmc_add_meta(chm, "/#WINDOWS", 1, (UChar *)p, 8+196);
        } else
            BUG_ON("FIXME: %s: %d\n", __FILE__, __LINE__);
    }

    ctrl = chmc_add_meta(chm, "/#STRINGS", 1, (void *)chm->strings,
                         chm->strings_len);
    if (ctrl)
        ctrl->flags |= CHMC_TNFL_STATIC;

#if 0
    // FIXME just a test
    {
        UChar *p;
        int len;
        struct chmcUrlStrEntry urlStrEntry;

        urlStrEntry.url_offset = 0;
        urlStrEntry.framename_offset = 0;

        p = malloc(4096);
        if (p) {
            memset(p, 0, 4096);
            *p = 0x42;
            len = 1;

            memcpy(p + len, &urlStrEntry, sizeof(struct chmcUrlStrEntry));
            len += sizeof(struct chmcUrlStrEntry);
            len += sprintf(p + len, "index.htm" ) + 1;

            memcpy(p + len, &urlStrEntry, sizeof(struct chmcUrlStrEntry));
            len += sizeof(struct chmcUrlStrEntry);
            len += sprintf(p + len, "test.htm" ) + 1;

            chmc_add_meta(chm, "/#URLSTR", 1, (UChar *)p, len);
        } else
            BUG_ON("FIXME: %s: %d\n", __FILE__, __LINE__);
    }
#endif

    //   chmc_add_entry(chm, "/#URLTBL", 0, 1, NULL, 0, 0);
    //   chmc_add_entry(chm, "/#TOPICS", 0, 1, NULL, 0, 0);

    // NOTE NOTE NOTE add any meta compressed before crunch ;-)

    chmc_crunch_lzx(chm, 1);

    chmc_control_data_done(chm);
    chmc_reset_table_done(chm);

    chmc_add_empty(chm, "/#ITBITS");

    // NOTE in this implementation compressed Content should be the last file
    //      added to section 0

    chmc_add_meta(chm, "::DataSpace/Storage/MSCompressed/Content", 0, NULL,
                  chm->sections[1]->offset);

    chmc_entries_qsort(chm);
    chmc_uncompressed_done(chm);
    chmc_pmgl_done(chm);

    chmc_pmgi_done(chm);

    itsf->dir_len =     _CHMC_ITSP_V1_LEN
        + (_CHMC_CHUNK_LEN * itsp->num_blocks);

    itsf->data_offset = _CHMC_ITSF_V3_LEN
        + _CHMC_SECT0_LEN
        + _CHMC_ITSP_V1_LEN
        + (_CHMC_CHUNK_LEN * itsp->num_blocks);

    sect0->file_len +=  _CHMC_CHUNK_LEN * itsp->num_blocks;

    chmc_write(chm);

    {
        struct chmcSection *section;
        struct list_head *pos;
        UChar buf[4096];

        list_for_each(pos, &chm->sections_list) {
            section = list_entry(pos, struct chmcSection, list);
            chmc_appendfile(chm, section->filename, buf, 4096);
        }
    }

    return CHMC_NOERR;
}

Referenced by main().