xwords/palm/palmdict.c

/* -*-mode: C; fill-column: 78; c-basic-offset: 4;-*- */
/* 
 * Copyright 1997-2001 by Eric House (fixin@peak.org).  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#include <PalmTypes.h>
#include <DataMgr.h>
#include <VFSMgr.h>

#include "dictnryp.h"
#include "dawg.h"
#include "palmdict.h"
#include "dictlist.h"
#include "dictui.h"

typedef struct DictStart {
    unsigned long indexStart;
    array_edge* array;
} DictStart;


#define NO_REFCOUNT -2

struct PalmDictionaryCtxt {
    DictionaryCtxt super;
    dawg_header* headerRecP;
    DmOpenRef dbRef;
    XP_U16 nRecords;
    UInt16 cardNo;              /* added to track VFS imported file for */
    LocalID dbID;               /* deletion later */
    XP_UCHAR location;          /* VFS or storage mem */
    XP_S8 refCount;
    PalmDictList* dl;
    DictStart dictStarts[1];
};

static void palm_dictionary_destroy( DictionaryCtxt* dict );
static XP_U16 countSpecials( unsigned char* ptr, UInt16 nChars );
static void setupSpecials( MPFORMAL PalmDictionaryCtxt* ctxt, 
                           Xloc_specialEntry* specialStart, XP_U16 nSpecials );
static void unlockAndRelease( MemPtr p, DmOpenRef dbRef, short recIndex );

DictionaryCtxt*
palm_dictionary_make( MPFORMAL XP_UCHAR* dictName, PalmDictList* dl )
{
    Boolean found;
    UInt16 cardNo;
    LocalID dbID;
    DmOpenRef dbRef;
    PalmDictionaryCtxt  tDictBuf;
    PalmDictionaryCtxt* ctxt;
    MemHandle tmpH;
    dawg_header* headerRecP;
    unsigned char* charPtr;
    UInt16 nChars, nSpecials;
    unsigned long offset = 0;
    DictListEntry* dle;
    Err err;
    XP_U16 i;

    /* check and see if there's already a dict for this name.  If yes,
       increment its refcount and return. */
    if ( !!dictName && getDictWithName( dl, dictName, &dle ) ) {
        PalmDictionaryCtxt* dict = (PalmDictionaryCtxt*)dle->dict;
        if ( !!dict ) {
            ++dict->refCount;
            return (DictionaryCtxt*)dict;
        }
    }

    if ( !!dictName ) {
        ctxt = &tDictBuf;
    } else {
        /* If the name's NULL, we still need to create a dict, as the server
           may be called to fill it in from the stream later. */
        ctxt = XP_MALLOC( mpool, sizeof(*ctxt) );
    }

    XP_MEMSET( ctxt, 0, sizeof(*ctxt) );
    MPASSIGN( ctxt->super.mpool, mpool );

    if ( !!dictName ) {
        XP_ASSERT( XP_STRLEN((const char*)dictName) > 0 );

        ctxt->super.name = dictName;
        ctxt->super.destructor = palm_dictionary_destroy;

        found = getDictWithName( dl, dictName, &dle );

        if ( !found ) {
            goto errExit;
        }

        if ( dle->location == DL_VFS ) {
            err = VFSImportDatabaseFromFile( dle->u.vfsData.volNum, 
                                             (const char*)dle->path,
                                             &cardNo, &dbID );
            if ( err != errNone ) {
                goto errExit;
            }
        } else {
            cardNo = dle->u.dmData.cardNo;
            dbID = dle->u.dmData.dbID;
        }

        ctxt->refCount = 1;
        ctxt->dl = dl;
        ctxt->dbID = dbID;
        ctxt->cardNo = cardNo;
        ctxt->location = dle->location;

        ctxt->dbRef = dbRef = DmOpenDatabase( cardNo, dbID, dmModeReadOnly );
        tmpH = DmGetRecord( dbRef, 0 ); // <- <eeh> should be a constant
        ctxt->headerRecP = headerRecP = (dawg_header*)MemHandleLock( tmpH );
        XP_ASSERT( MemHandleLockCount(tmpH) == 1 );

        tmpH = DmQueryRecord( dbRef, headerRecP->charTableRecNum );
        XP_ASSERT( !!tmpH );
        charPtr = (unsigned char*)MemHandleLock( tmpH );
        XP_ASSERT( MemHandleLockCount( tmpH ) == 1 );
        ctxt->super.nFaces = nChars = MemPtrSize(charPtr);
        ctxt->super.faces16 = 
            XP_MALLOC( mpool, nChars * sizeof(ctxt->super.faces16[0]));
        XP_ASSERT( !!ctxt->super.faces16 );
        for ( i = 0; i < nChars; ++i ) {
            ctxt->super.faces16[i] = charPtr[i];
        }
        nSpecials = countSpecials( charPtr, nChars );
        unlockAndRelease( charPtr, dbRef, headerRecP->charTableRecNum );

        tmpH = DmGetRecord( dbRef, headerRecP->valTableRecNum );
        charPtr = (unsigned char*)MemHandleLock(tmpH);
        XP_ASSERT( MemHandleLockCount( tmpH ) == 1 );
        ctxt->super.countsAndValues = charPtr + sizeof(Xloc_header);

        /* for those dicts with special chars */
        if ( nSpecials > 0 ) {
            Xloc_specialEntry* specialStart = (Xloc_specialEntry*)
                (ctxt->super.countsAndValues + (ctxt->super.nFaces*2));
            setupSpecials( MPPARM(mpool) ctxt, specialStart, nSpecials );
        }

        if ( headerRecP->firstEdgeRecNum == 0 ) { /* emtpy dict */
            ctxt->super.topEdge = NULL;
            ctxt->nRecords = 0;
        } else {
            short index;
            XP_U16 nRecords;

            nRecords = DmNumRecords(dbRef) - headerRecP->firstEdgeRecNum; 

            /* alloacate now that we know the size. */
            ctxt = XP_MALLOC( mpool, 
                              sizeof(*ctxt) + (nRecords * sizeof(DictStart)));
            XP_MEMCPY( ctxt, &tDictBuf, sizeof(tDictBuf) );
            ctxt->nRecords = nRecords;

            for ( index = 0; index < nRecords; ++index ) {
                MemHandle record = 
                    DmGetRecord( dbRef, index + headerRecP->firstEdgeRecNum );
                ctxt->dictStarts[index].indexStart = offset;

                /* cast to short to avoid libc call */
                XP_ASSERT( MemHandleSize(record) < 0xFFFF );
                XP_ASSERT( ((unsigned short)(MemHandleSize(record)) % 3 ) == 0);
                offset += ((unsigned short)MemHandleSize(record)) / 3;
                ctxt->dictStarts[index].array = 
                    (array_edge*)MemHandleLock( record );
                XP_ASSERT( MemHandleLockCount(record) == 1 );
            }

            XP_ASSERT( index == ctxt->nRecords );
            ctxt->dictStarts[index].indexStart = 0xFFFFFFFFL;

            ctxt->super.topEdge = ctxt->dictStarts[0].array;
        }

        setBlankTile( (DictionaryCtxt*)ctxt );

        cacheDictForName( dl, dictName, (DictionaryCtxt*)ctxt );
    } else {
        ctxt->refCount = NO_REFCOUNT;
    }

    return (DictionaryCtxt*)ctxt;

 errExit:
    if ( !!ctxt ) {
        XP_ASSERT( ctxt == &tDictBuf );
    }
    return NULL;
} /* palm_dictionary_make */

static XP_U16
countSpecials( unsigned char* ptr, UInt16 nChars )
{
    XP_U16 result = 0;

    while ( nChars-- ) {
        unsigned char face = *ptr++;
        if ( IS_SPECIAL(face) ) {
            ++result;
        }
    }
    return result;
} /* countSpecials */

/* We need an array of ptrs to bitmaps plus an array of ptrs to the text
 * equivalents.
 */
static void
setupSpecials( MPFORMAL PalmDictionaryCtxt* ctxt, 
               Xloc_specialEntry* specialStart, XP_U16 nSpecials )
{
    XP_U16 i;
    char* base = (char*)specialStart;
    XP_UCHAR** chars = XP_MALLOC( mpool, nSpecials * sizeof(*chars) );
    SpecialBitmaps* bitmaps = XP_MALLOC( mpool, nSpecials * sizeof(*bitmaps) );

    XP_MEMSET( bitmaps, 0, nSpecials * sizeof(*bitmaps ) );

    for ( i = 0; i < nSpecials; ++i ) {
        chars[i] = specialStart->textVersion;
        if ( specialStart->hasLarge ) {
            bitmaps[i].largeBM = base + specialStart->hasLarge;
        }
        if ( specialStart->hasSmall ) {
            bitmaps[i].smallBM = base + specialStart->hasSmall;
        }
        ++specialStart;
    }

    ctxt->super.bitmaps = bitmaps;
    ctxt->super.chars = chars;
} /* setupSpecials */

static void
unlockAndRelease( MemPtr p, DmOpenRef dbRef, short recIndex )
{
    MemPtrUnlock( p );
    DmReleaseRecord( dbRef, recIndex, false );
} /* unlockAndRelease */

static void
palm_dictionary_destroy( DictionaryCtxt* dict )
{
    PalmDictionaryCtxt* ctxt = (PalmDictionaryCtxt*)dict;

    if ( ctxt->refCount != NO_REFCOUNT && --ctxt->refCount == 0 ) {
        short i;
        DmOpenRef dbRef;
        dawg_header* headerRecP;

        if ( !!ctxt->super.name ) {
            /* Remove from dict list */
            removeFromDictCache( ctxt->dl, ctxt->super.name, dict );
        }

        dbRef = ctxt->dbRef;
        headerRecP = ctxt->headerRecP;

        XP_ASSERT( !!dbRef );
    
        unlockAndRelease( ctxt->super.countsAndValues - sizeof(Xloc_header), 
                          dbRef, headerRecP->valTableRecNum );

        XP_FREE( dict->mpool, ctxt->super.faces16 );

        for ( i = 0; i < ctxt->nRecords; ++i ) {
            unlockAndRelease( ctxt->dictStarts[i].array, 
                              dbRef, i + headerRecP->firstEdgeRecNum );
        }

        unlockAndRelease( headerRecP, dbRef, 0 );

        DmCloseDatabase( dbRef );

        if ( !!ctxt->super.name ) {
            XP_FREE( dict->mpool, ctxt->super.name );
        }
        if ( !!ctxt->super.bitmaps ) {
            XP_FREE( dict->mpool, ctxt->super.bitmaps );
        }
        if ( !!ctxt->super.chars ) {
            XP_FREE( dict->mpool, ctxt->super.chars );
        }

        /* if we copied the db to memory we should nuke it, since user would
           have copied it himself if he wanted it here permanently */
        if ( ctxt->location == DL_VFS ) {
            DmDeleteDatabase( ctxt->cardNo, ctxt->dbID );
        }

        XP_FREE( dict->mpool, dict );
    }
} /* palm_dictionary_destroy */

#ifdef OVERRIDE_EDGE_FOR_INDEX
array_edge* 
dict_edge_for_index( DictionaryCtxt* dict, XP_U32 index )
{
    PalmDictionaryCtxt* ctxt = (PalmDictionaryCtxt*)dict;
    array_edge* result;

    if ( index == 0 ) {
        result = NULL;
    } else {
        DictStart* headerP;
        for ( headerP = &ctxt->dictStarts[1];
              index >= headerP->indexStart;
              ++headerP ) {
            /* do nothing */
        }
        --headerP;
        index -= headerP->indexStart;
#ifdef NODE_CAN_4
        index *= dict->nodeSize;
#else
        index *= 3;
#endif
        result = headerP->array + index;
    }

    return result;
} /* dict_edge_for_index */
#endif