ncbires.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: ncbires.hpp,v $
 * PRODUCTION Revision 1000.1  2003/11/18 15:42:49  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [ORIGINAL] Dev-tree R1.31
 * PRODUCTION
 * ===========================================================================
 */

#ifndef NCBI_RES__HPP
#define NCBI_RES__HPP

/*  $Id: ncbires.hpp,v 1000.1 2003/11/18 15:42:49 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: 
*	Vsevolod Sandomirskiy
*
* File Description:
*   Basic Resource class
*
* ---------------------------------------------------------------------------
* $Log: ncbires.hpp,v $
* Revision 1000.1  2003/11/18 15:42:49  gouriano
* PRODUCTION: UPGRADED [ORIGINAL] Dev-tree R1.31
*
* Revision 1.31  2003/11/05 18:40:55  dicuccio
* Added export specifiers
*
* Revision 1.30  2003/04/10 19:01:46  siyan
* Added doxygen support
*
* Revision 1.29  1999/08/11 18:33:03  sandomir
* class CNcbiResource more logical (some functionality from CNcbiDbResource moved in CNcbiResource; CNcbiCommand get CNcbiResource in ctor
*
* Revision 1.28  1999/05/11 03:11:47  vakatov
* Moved the CGI API(along with the relevant tests) from "corelib/" to "cgi/"
*
* Revision 1.27  1999/05/06 20:32:51  pubmed
* CNcbiResource -> CNcbiDbResource; utils from query; few more context methods
*
*
* ===========================================================================
*/

#include <cgi/ncbicgi.hpp>
#include <cgi/ncbicgir.hpp>

#include <functional>


/** @addtogroup CGICmd
 *
 * @{
 */


BEGIN_NCBI_SCOPE

class CNcbiCommand;
class CNcbiResPresentation;
class CNcbiRegistry;
class CCgiContext;

class CNCBINode;

//
// class CNcbiResource
//

typedef list<CNcbiCommand*> TCmdList;

class NCBI_XCGI_EXPORT CNcbiResource
{
public:

    CNcbiResource(CNcbiRegistry& config);
    virtual ~CNcbiResource( void );

    const CNcbiRegistry& GetConfig(void) const;
    CNcbiRegistry& GetConfig(void);

    virtual const CNcbiResPresentation* GetPresentation( void ) const;

    const TCmdList& GetCmdList( void ) const;
    virtual CNcbiCommand* GetDefaultCommand( void ) const = 0;

    void AddCommand( CNcbiCommand* command );

    virtual void HandleRequest( CCgiContext& ctx );

protected:   

    CNcbiRegistry& m_config;  
    TCmdList m_cmd;

private:

    // hide copy-ctor and operator=
    CNcbiResource( const CNcbiResource& ); 
    CNcbiResource& operator=( const CNcbiResource& );
};

//
// class CNcbiCommand
//

class NCBI_XCGI_EXPORT CNcbiCommand
{
public:

    CNcbiCommand( CNcbiResource& resource );
    virtual ~CNcbiCommand( void );

    virtual CNcbiCommand* Clone( void ) const = 0;

    virtual CNCBINode* GetLogo( const CCgiContext& ) const { return 0; }
    virtual string GetName( void ) const = 0;
    virtual string GetLink( CCgiContext& ctx ) const = 0;

    virtual void Execute( CCgiContext& ctx ) = 0;

    virtual bool IsRequested( const CCgiContext& ctx ) const;

protected:

    virtual string GetEntry() const = 0;

    CNcbiResource& GetResource() const
        { return m_resource; }

private:

    CNcbiResource& m_resource;
};

//
// class CNcbiRelocateCommand
//

class NCBI_XCGI_EXPORT CNcbiRelocateCommand :  public CNcbiCommand
{
public:

    CNcbiRelocateCommand( CNcbiResource& resource );

    virtual ~CNcbiRelocateCommand( void );

    virtual void Execute( CCgiContext& ctx );
};

//
// class CNcbiResPresentation
//

class NCBI_XCGI_EXPORT CNcbiResPresentation
{
public:

    virtual ~CNcbiResPresentation() {}

    virtual CNCBINode* GetLogo( void ) const { return 0; }
    virtual string GetName( void ) const = 0;
    virtual string GetLink( void ) const = 0;
};

//
// PRequested
//

template<class T>
class PRequested : public unary_function<T,bool>
{  
    const CCgiContext& m_ctx;
  
public:
  
    explicit PRequested( const CCgiContext& ctx ) 
        : m_ctx( ctx ) {}

    bool operator() ( const T* t ) const 
        { return t->IsRequested( m_ctx ); }

}; // class PRequested

//
// PFindByName
//

template<class T>
class PFindByName : public unary_function<T,bool>
{  
    const string& m_name;
  
public:
    
    explicit PFindByName( const string& name ) 
        : m_name( name ) {}
    
    bool operator() ( const T* t ) const 
        { return AStrEquiv( m_name, t->GetName(), PNocase() ); }
    
}; // class PFindByName

END_NCBI_SCOPE

#endif /* NCBI_RES__HPP */


/* @} */