blast_hspstream.c

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: blast_hspstream.c,v $
 * PRODUCTION Revision 1000.0  2004/06/01 18:13:38  gouriano
 * PRODUCTION PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.2
 * PRODUCTION
 * ===========================================================================
 */

/*  $Id: blast_hspstream.c,v 1000.0 2004/06/01 18:13:38 gouriano Exp $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Author:  Christiam Camacho
 *
 */

/** @file blast_hspstream.c
 * Definition of ADT to save and retrieve lists of HSPs in the BLAST engine.
 */

static char const rcsid[] = 
    "$Id: blast_hspstream.c,v 1000.0 2004/06/01 18:13:38 gouriano Exp $";

#include <algo/blast/core/blast_hspstream.h>
#include <algo/blast/core/blast_def.h>      /* needed for sfree */

/** Complete type definition of Blast Hsp Stream ADT */
struct BlastHSPStream {

    BlastHSPStreamConstructor NewFnPtr;       /**< Constructor */
    BlastHSPStreamDestructor  DeleteFnPtr;    /**< Destructor */

    /* The operational interface */

    BlastHSPStreamMethod      WriteFnPtr;     /**< Write to BlastHSPStream */
    BlastHSPStreamMethod      ReadFnPtr;      /**< Read from BlastHSPStream */

    void* DataStructure;  /**< ADT holding HSPStream */
};

BlastHSPStream* BlastHSPStreamNew(const BlastHSPStreamNewInfo* bhsn_info)
{
    BlastHSPStream* retval = NULL;
    BlastHSPStreamFunctionPointerTypes fnptr;

    if ( bhsn_info == NULL ) {
        return NULL;
    }

    if ( !(retval = (BlastHSPStream*) calloc(1, sizeof(BlastHSPStream)))) {
        return NULL;
    }

    /* Save the constructor and invoke it */
    fnptr.ctor = bhsn_info->constructor;
    SetMethod(retval, eConstructor, fnptr);
    if (retval->NewFnPtr) {
        retval = (*retval->NewFnPtr)(retval, bhsn_info->ctor_argument);
    } else {
        sfree(retval);
    }

    ASSERT(retval->DeleteFnPtr);
    ASSERT(retval->WriteFnPtr);
    ASSERT(retval->ReadFnPtr);

    return retval;
}

BlastHSPStream* BlastHSPStreamFree(BlastHSPStream* hsp_stream)
{
    BlastHSPStreamDestructor destructor_fnptr = NULL;

    if (!hsp_stream) {
        return (BlastHSPStream*) NULL;
    }

    if ( !(destructor_fnptr = (*hsp_stream->DeleteFnPtr))) {
        sfree(hsp_stream);
        return NULL;
    }

    return (BlastHSPStream*) (*destructor_fnptr)(hsp_stream);
}

const int kBlastHSPStream_Error = -1;
const int kBlastHSPStream_Success = 0;
const int kBlastHSPStream_Eof = 1;

/** This method is akin to a vtable dispatcher, invoking the method registered
 * upon creation of the implementation of the BlastHSPStream interface 
 * @param hsp_stream The BlastHSPStream object [in]
 * @param name Name of the method to invoke on hsp_stream [in]
 * @param arg Arbitrary argument passed to the method name [in]
 * @return kBlastHSPStream_Error on NULL hsp_stream or NULL method pointer 
 * (i.e.: unimplemented or uninitialized method on the BlastHSPStream 
 * interface) or return value of the implementation.
 */
static int 
_MethodDispatcher(BlastHSPStream* hsp_stream, EMethodName name, 
                  BlastHSPList** hsp_list)
{
    BlastHSPStreamMethod method_fnptr = NULL;

    if (!hsp_stream) {
        return kBlastHSPStream_Error;
    }

    ASSERT(name < eMethodBoundary); 

    switch (name) {
    case eRead:
        method_fnptr = (*hsp_stream->ReadFnPtr);
        break;

    case eWrite:
        method_fnptr = (*hsp_stream->WriteFnPtr);
        break;

    default:
        abort();    /* should never happen */
    }

    if (!method_fnptr) {
        return kBlastHSPStream_Error;
    }

    return (*method_fnptr)(hsp_stream, hsp_list);
}

int BlastHSPStreamRead(BlastHSPStream* hsp_stream, BlastHSPList** hsp_list)
{
    return _MethodDispatcher(hsp_stream, eRead, hsp_list);
}

int BlastHSPStreamWrite(BlastHSPStream* hsp_stream, BlastHSPList** hsp_list)
{
    return _MethodDispatcher(hsp_stream, eWrite, hsp_list);
}

/*****************************************************************************/

void* GetData(BlastHSPStream* hsp_stream)
{
    if ( !hsp_stream ) {
        return NULL;
    }

    return hsp_stream->DataStructure;
}

int SetData(BlastHSPStream* hsp_stream, void* data)
{
    if ( !hsp_stream ) {
        return kBlastHSPStream_Error;
    }

    hsp_stream->DataStructure = data;

    return kBlastHSPStream_Success;
}

int SetMethod(BlastHSPStream* hsp_stream, 
              EMethodName name,
              BlastHSPStreamFunctionPointerTypes fnptr_type)
{
    if ( !hsp_stream ) {
        return kBlastHSPStream_Error;
    }

    ASSERT(name < eMethodBoundary); 

    switch (name) {
    case eConstructor:
        hsp_stream->NewFnPtr = fnptr_type.ctor;
        break;

    case eDestructor:
        hsp_stream->DeleteFnPtr = fnptr_type.dtor;
        break;

    case eRead:
        hsp_stream->ReadFnPtr = fnptr_type.method;
        break;

    case eWrite:
        hsp_stream->WriteFnPtr = fnptr_type.method;
        break;

    default:
        abort();    /* should never happen */
    }

    return kBlastHSPStream_Success;
}