生物技术

开发平台：
C/C++

ncbimisc.hpp：源码内容
							/*
 * ===========================================================================
 * PRODUCTION $Log: ncbimisc.hpp,v $
 * PRODUCTION Revision 1000.2  2004/02/12 21:45:03  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [CORE_001] Dev-tree R1.71
 * PRODUCTION
 * ===========================================================================
 */
#ifndef CORELIB___NCBIMISC__HPP
#define CORELIB___NCBIMISC__HPP
/*  $Id: ncbimisc.hpp,v 1000.2 2004/02/12 21:45:03 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:  Denis Vakatov, Eugene Vasilchenko
 *
 *
 */
/// @file ncbistd.hpp
/// Miscellaneous common-use basic types and functionality
#include <corelib/ncbistl.hpp>
#ifdef NCBI_OS_UNIX
#  include <sys/types.h>
#endif
/** @addtogroup AppFramework
 *
 * @{
 */
BEGIN_NCBI_SCOPE
/// Which type of ownership between objects.
///
/// Can be used to specify ownership relationship between objects.
/// For example, specify if a CSocket object owns the underlying
/// SOCK object. 
enum EOwnership {
    eNoOwnership,       ///< No ownership relationship
    eTakeOwnership      ///< An object can take ownership of another
};
/// Whether a value is nullable.
enum ENullable
{
    eNullable,          ///< Value can be null
    eNotNullable        ///< Value cannot be null
};
#if defined(HAVE_NO_AUTO_PTR)
/////////////////////////////////////////////////////////////////////////////
///
/// auto_ptr --
///
/// Define auto_ptr if needed.
///
/// Replacement of STL's std::auto_ptr for compilers with poor "auto_ptr"
/// implementation.
/// 
/// See C++ Toolkit documentation for limiatations and use of auto_ptr.
template <class X>
class auto_ptr
{
public:
    typedef X element_type;         ///< Define element_type
    /// Explicit conversion to auto_ptr.
    explicit auto_ptr(X* p = 0) : m_Ptr(p) {}
    /// Copy constructor with implicit conversion.
    ///
    /// Note that the copy constructor parameter is not a const
    /// because it is modified -- ownership is transferred.
    auto_ptr(auto_ptr<X>& a) : m_Ptr(a.release()) {}
    /// Assignment operator.
    auto_ptr<X>& operator=(auto_ptr<X>& a) {
        if (this != &a) {
            if (m_Ptr  &&  m_Ptr != a.m_Ptr) {
                delete m_Ptr;
            }
            m_Ptr = a.release();
        }
        return *this;
    }
    /// Destructor.
    ~auto_ptr(void) {
        if ( m_Ptr )
            delete m_Ptr;
    }
    /// Deference operator.
    X&  operator*(void) const { return *m_Ptr; }
    /// Reference operator.
    X*  operator->(void) const { return m_Ptr; }
    /// Equality operator.
    int operator==(const X* p) const { return (m_Ptr == p); }
    /// Get pointer value.
    X*  get(void) const { return m_Ptr; }
    /// Release pointer.
    X* release(void) {
        X* x_Ptr = m_Ptr;  m_Ptr = 0;  return x_Ptr;
    }
    /// Reset pointer.
    void reset(X* p = 0) {
        if (m_Ptr != p) {
            delete m_Ptr;
            m_Ptr = p;
        }
    }
private:
    X* m_Ptr;               ///< Internal pointer implementation.
};
#endif /* HAVE_NO_AUTO_PTR */
/// Functor template for allocating object.
template<class X>
struct Creater
{
    /// Default create function.
    static X* Create(void)
    { return new X; }
};
/// Functor tempate for deleting object.
template<class X>
struct Deleter
{
    /// Default delete function.
    static void Delete(X* object)
    { delete object; }
};
/// Functor template for deleting array of objects.
template<class X>
struct ArrayDeleter
{
    /// Array delete function.
    static void Delete(X* object)
    { delete[] object; }
};
/// Functor template for the C language deallocation function, free().
template<class X>
struct CDeleter
{
    /// C Language deallocation function.
    static void Delete(X* object)
    { free(object); }
};
/////////////////////////////////////////////////////////////////////////////
///
/// AutoPtr --
///
/// Define an "auto_ptr" like class that can be used inside STL containers.
///
/// The Standard auto_ptr template from STL doesn't allow the auto_ptr to be
/// put in STL containers (list, vector, map etc.). The reason for this is
/// the absence of copy constructor and assignment operator.
/// We decided that it would be useful to have an analog of STL's auto_ptr
/// without this restriction - AutoPtr.
///
/// Due to nature of AutoPtr its copy constructor and assignment operator
/// modify the state of the source AutoPtr object as it transfers ownership
/// to the target AutoPtr object. Also, we added possibility to redefine the
/// way pointer will be deleted: the second argument of template allows
/// pointers from "malloc" in AutoPtr, or you can use "ArrayDeleter" (see
/// above) to properly delete an array of objects using "delete[]" instead
/// of "delete". By default, the internal pointer will be deleted by C++
/// "delete" operator.
///
/// @sa
///   Deleter(), ArrayDeleter(), CDeleter()
template< class X, class Del = Deleter<X> >
class AutoPtr
{
public:
    typedef X element_type;         ///< Define element type.
    /// Constructor.
    AutoPtr(X* p = 0)
        : m_Ptr(p), m_Owner(true)
    {
    }
    /// Copy constructor.
    AutoPtr(const AutoPtr<X, Del>& p)
        : m_Ptr(0), m_Owner(p.m_Owner)
    {
        m_Ptr = p.x_Release();
    }
    /// Destructor.
    ~AutoPtr(void)
    {
        reset();
    }
    /// Assignment operator.
    AutoPtr<X, Del>& operator=(const AutoPtr<X, Del>& p)
    {
        if (this != &p) {
            bool owner = p.m_Owner;
            reset(p.x_Release());
            m_Owner = owner;
        }
        return *this;
    }
    /// Assignment operator.
    AutoPtr<X, Del>& operator=(X* p)
    {
        reset(p);
        return *this;
    }
    /// Bool operator for use in if() clause.
    operator bool(void) const
    {
        return m_Ptr != 0;
    }
    // Standard getters.
    /// Dereference operator.
    X& operator* (void) const { return *m_Ptr; }
    /// Reference operator.
    X* operator->(void) const { return  m_Ptr; }
    /// Get pointer.
    X* get       (void) const { return  m_Ptr; }
    /// Release will release ownership of pointer to caller.
    X* release(void)
    {
        m_Owner = false;
        return m_Ptr;
    }
    /// Reset will delete old pointer, set content to new value,
    /// and accept ownership upon the new pointer.
    void reset(X* p = 0)
    {
        if (m_Ptr  &&  m_Owner) {
            Del::Delete(release());
        }
        m_Ptr   = p;
        m_Owner = true;
    }
private:
    X* m_Ptr;                       ///< Internal pointer representation.
    mutable bool m_Owner;
    /// Release for const object.
    X* x_Release(void) const
    {
        return const_cast<AutoPtr<X, Del>*>(this)->release();
    }
};
// "min" and "max" templates
//
#if defined(HAVE_NO_MINMAX_TEMPLATE)
#  define NOMINMAX
#  ifdef min
#    undef min
#  endif
#  ifdef max
#    undef max
#  endif
/// Min function template.
template <class T>
inline
const T& min(const T& a, const T& b) {
    return b < a ? b : a;
}
/// Max function template.
template <class T>
inline
const T& max(const T& a, const T& b) {
    return  a < b ? b : a;
}
#endif /* HAVE_NO_MINMAX_TEMPLATE */
// strdup()
//
#if !defined(HAVE_STRDUP)
/// Supply string duplicate function, if one is not defined.
extern char* strdup(const char* str);
#endif
//  ITERATE
//  NON_CONST_ITERATE
//
// Useful macro to write 'for' statements with the STL container iterator as
// a variable.
//
/// iterate macro to sequence through container elements.
///
/// This version is deprecated. Use equivalent ITERATE instead.
/// @sa
///   ITERATE
#define iterate(Type, Var, Cont) 
    for ( Type::const_iterator Var = (Cont).begin(), NCBI_NAME2(Var,_end) = (Cont).end();  Var != NCBI_NAME2(Var,_end);  ++Var )
/// Non constant version of iterate macro.
#define non_const_iterate(Type, Var, Cont) 
    for ( Type::iterator Var = (Cont).begin();  Var != (Cont).end();  ++Var )
/// ITERATE macro to sequence through container elements.
///
/// This upper case style is prefered over the "iterate" macro.
/// @sa
///   iterate
#define ITERATE(Type, Var, Cont) 
    for ( Type::const_iterator Var = (Cont).begin(), NCBI_NAME2(Var,_end) = (Cont).end();  Var != NCBI_NAME2(Var,_end);  ++Var )
/// Non constant version of iterate macro.
///
/// This upper case style is prefered over the "non_const_iterate" macro.
/// @sa
///   non_const_iterate
#define NON_CONST_ITERATE(Type, Var, Cont) 
    for ( Type::iterator Var = (Cont).begin();  Var != (Cont).end();  ++Var )
#if defined(NCBI_OS_MSWIN)  &&  !defined(Beep)
/// Avoid a silly name clash between MS-Win and C Toolkit headers.
#  define Beep Beep
#endif
/// Type for sequence locations and lengths.
///
/// Use this typedef rather than its expansion, which may change.
typedef unsigned int TSeqPos;
/// Define special value for invalid sequence position.
const TSeqPos kInvalidSeqPos = ((TSeqPos) (-1));
/// Type for signed sequence position.
///
/// Use this type when and only when negative values are a possibility
/// for reporting differences between positions, or for error reporting --
/// though exceptions are generally better for error reporting.
/// Use this typedef rather than its expansion, which may change.
typedef int TSignedSeqPos;
/// Helper address class
class CRawPointer
{
public:
    /// add offset to object reference (to get object's member)
    static void* Add(void* object, ssize_t offset);
    static const void* Add(const void* object, ssize_t offset);
    /// calculate offset inside object
    static ssize_t Sub(const void* first, const void* second);
};
inline
void* CRawPointer::Add(void* object, ssize_t offset)
{
    return static_cast<char*> (object) + offset;
}
inline
const void* CRawPointer::Add(const void* object, ssize_t offset)
{
    return static_cast<const char*> (object) + offset;
}
inline
ssize_t CRawPointer::Sub(const void* first, const void* second)
{
    return
        static_cast<const char*> (first) - static_cast<const char*> (second);
}
END_NCBI_SCOPE
/* @} */
/*
 * ===========================================================================
 * $Log: ncbimisc.hpp,v $
 * Revision 1000.2  2004/02/12 21:45:03  gouriano
 * PRODUCTION: UPGRADED [CORE_001] Dev-tree R1.71
 *
 * Revision 1.71  2004/01/20 17:10:08  ivanov
 * Rollback previous commit
 *
 * Revision 1.70  2004/01/20 17:06:42  ivanov
 * Added #include <ncbiconf.h>
 *
 * Revision 1.69  2003/12/01 20:44:46  ucko
 * +<sys/types.h> on Unix for ssize_t
 *
 * Revision 1.68  2003/12/01 19:04:20  grichenk
 * Moved Add and Sub from serialutil to ncbimisc, made them methods
 * of CRawPointer class.
 *
 * Revision 1.67  2003/10/02 17:43:43  vakatov
 * The code extracted from NCBISTD.HPP. -- The latter is a "pure virtual"
 * header now.
 *
 * Revision 1.66  2003/09/17 15:17:30  vasilche
 * Fixed self references in template class AutoPtr.
 *
 * Revision 1.65  2003/08/14 12:48:18  siyan
 * Documentation changes.
 *
 * Revision 1.64  2003/04/21 14:31:12  kuznets
 * lower case iterate returned back to the header
 *
 * Revision 1.63  2003/04/18 18:10:08  kuznets
 * + enum ENullable
 *
 * Revision 1.62  2003/03/10 17:43:45  kuznets
 * iterate -> ITERATE cleanup
 *
 * Revision 1.61  2003/02/04 18:15:54  gouriano
 * removed reference to ncbifloat.h
 *
 * Revision 1.60  2003/02/04 17:02:53  gouriano
 * added reference to ncbifloat.h
 *
 * Revision 1.59  2002/09/19 22:17:11  vakatov
 * + kInvalidSeqPos
 *
 * Revision 1.58  2002/08/12 14:57:52  lavr
 * +EOwnership
 *
 * Revision 1.57  2002/07/11 14:17:55  gouriano
 * exceptions replaced by CNcbiException-type ones
 *
 * Revision 1.56  2002/05/03 21:27:59  ucko
 * Introduce T(Signed)SeqPos.
 *
 * Revision 1.55  2002/04/11 20:39:19  ivanov
 * CVS log moved to end of the file
 *
 * Revision 1.54  2001/05/30 16:04:22  vakatov
 * AutoPtr::  -- do not make it owner if the source AutoPtr object was not
 * an owner (for copy-constructor and operator=).
 *
 * Revision 1.53  2001/05/17 14:54:12  lavr
 * Typos corrected
 *
 * Revision 1.52  2001/04/13 02:52:34  vakatov
 * Rollback to R1.50.  It is premature to check for #HAVE_NCBI_C until
 * we can configure it on MS-Windows...
 *
 * Revision 1.51  2001/04/12 22:53:00  vakatov
 * Apply fix R1.50 only #if HAVE_NCBI_C
 *
 * Revision 1.50  2001/03/16 02:20:40  vakatov
 * [MSWIN]  Avoid the "Beep()" clash between MS-Win and C Toolkit headers
 *
 * Revision 1.49  2001/02/22 00:09:28  vakatov
 * non_const_iterate() -- added parenthesis around the "Cont" arg
 *
 * Revision 1.48  2000/12/24 00:01:48  vakatov
 * Moved some code from NCBIUTIL to NCBISTD.
 * Fixed AutoPtr to always work with assoc.containers
 *
 * Revision 1.46  2000/12/15 15:36:30  vasilche
 * Added header corelib/ncbistr.hpp for all string utility functions.
 * Optimized string utility functions.
 * Added assignment operator to CRef<> and CConstRef<>.
 * Add Upcase() and Locase() methods for automatic conversion.
 *
 * Revision 1.45  2000/12/12 14:20:14  vasilche
 * Added operator bool to CArgValue.
 * Added standard typedef element_type to CRef<> and CConstRef<>.
 * Macro iterate() now calls method end() only once and uses temporary variable
 * Various NStr::Compare() methods made faster.
 * Added class Upcase for printing strings to ostream with automatic conversion
 *
 * Revision 1.44  2000/12/11 20:42:48  vakatov
 * + NStr::PrintableString()
 *
 * Revision 1.43  2000/11/07 04:07:19  vakatov
 * kEmptyCStr, kEmptyStr (equiv. to NcbiEmptyCStr,NcbiEmptyString)
 *
 * Revision 1.42  2000/10/05 20:01:10  vakatov
 * auto_ptr -- no "const" in constructor and assignment
 *
 * Revision 1.41  2000/08/03 20:21:10  golikov
 * Added predicate PCase for AStrEquiv
 * PNocase, PCase goes through NStr::Compare now
 *
 * Revision 1.40  2000/07/19 19:03:52  vakatov
 * StringToBool() -- short and case-insensitive versions of "true"/"false"
 * ToUpper/ToLower(string&) -- fixed
 *
 * Revision 1.39  2000/04/17 19:30:12  vakatov
 * Allowed case-insensitive comparison for StartsWith() and EndsWith()
 *
 * Revision 1.38  2000/04/17 04:14:20  vakatov
 * NStr::  extended Compare(), and allow case-insensitive string comparison
 * NStr::  added ToLower() and ToUpper()
 *
 * Revision 1.37  2000/04/04 22:28:06  vakatov
 * NStr::  added conversions for "long"
 *
 * Revision 1.36  2000/02/17 20:00:24  vasilche
 * Added EResetVariant enum for serialization package.
 *
 * Revision 1.35  2000/01/20 16:24:20  vakatov
 * Kludging around the "NcbiEmptyString" to ensure its initialization when
 * it is used by the constructor of a statically allocated object
 * (I believe that it is actually just another Sun WorkShop compiler "feature")
 *
 * Revision 1.34  1999/12/28 19:04:22  vakatov
 * #HAVE_NO_MINMAX_TEMPLATE
 *
 * Revision 1.33  1999/12/28 18:55:25  vasilche
 * Reduced size of compiled object files:
 * 1. avoid inline or implicit virtual methods (especially destructors).
 * 2. avoid std::string's methods usage in inline methods.
 * 3. avoid string literals ("xxx") in inline methods.
 *
 * Revision 1.32  1999/12/17 19:04:06  vasilche
 * NcbiEmptyString made extern.
 *
 * Revision 1.31  1999/12/03 21:36:45  vasilche
 * Added forward decaration of CEnumeratedTypeValues
 *
 * Revision 1.30  1999/11/26 18:45:08  golikov
 * NStr::Replace added
 *
 * Revision 1.29  1999/11/17 22:05:02  vakatov
 * [!HAVE_STRDUP]  Emulate "strdup()" -- it's missing on some platforms
 *
 * Revision 1.28  1999/10/26 18:10:24  vakatov
 * [auto_ptr] -- simpler and more standard
 *
 * Revision 1.27  1999/09/29 22:22:37  vakatov
 * [auto_ptr] Use "mutable" rather than "static_cast" on m_Owns; fixed a
 *            double "delete" bug in reset().
 *
 * Revision 1.26  1999/09/14 18:49:40  vasilche
 * Added forward declaration of CTypeInfo class.
 *
 * Revision 1.25  1999/07/08 14:44:52  vakatov
 * Tiny fix in EndsWith()
 *
 * Revision 1.24  1999/07/06 15:21:04  vakatov
 * + NStr::TruncateSpaces(const string& str, ETrunc where=eTrunc_Both)
 *
 * Revision 1.23  1999/06/21 15:59:40  vakatov
 * [auto_ptr] -- closer to standard:  added an ownership and
 * initialization/assignment with "auto_ptr<>&", made "release()" be "const"
 *
 * Revision 1.22  1999/06/15 20:50:03  vakatov
 * NStr::  +BoolToString, +StringToBool
 *
 * Revision 1.21  1999/05/28 20:12:29  vakatov
 * [HAVE_NO_AUTO_PTR]  Prohibit "operator=" in the home-made "auto_ptr::"
 *
 * Revision 1.20  1999/04/16 17:45:31  vakatov
 * [MSVC++] Replace the <windef.h>'s min/max macros by the hand-made templates.
 *
 * Revision 1.19  1999/04/15 21:56:47  vakatov
 * Introduced NcbiMin/NcbiMax to workaround some portability issues with
 * the standard "min/max"
 *
 * Revision 1.18  1999/04/14 21:20:31  vakatov
 * Dont use "snprintf()" as it is not quite portable yet
 *
 * Revision 1.17  1999/04/14 19:46:01  vakatov
 * Fixed for the features:
 *    { NCBI_OBSOLETE_STR_COMPARE, HAVE_NO_AUTO_PTR, HAVE_NO_SNPRINTF }
 *
 * Revision 1.16  1999/04/09 19:51:36  sandomir
 * minor changes in NStr::StringToXXX - base added
 *
 * Revision 1.15  1999/01/21 16:18:04  sandomir
 * minor changes due to NStr namespace to contain string utility functions
 *
 * Revision 1.14  1999/01/11 22:05:45  vasilche
 * Fixed CHTML_font size.
 * Added CHTML_image input element.
 *
 * Revision 1.13  1998/12/28 17:56:29  vakatov
 * New CVS and development tree structure for the NCBI C++ projects
 *
 * Revision 1.12  1998/12/21 17:19:36  sandomir
 * VC++ fixes in ncbistd; minor fixes in Resource
 *
 * Revision 1.11  1998/12/17 21:50:43  sandomir
 * CNCBINode fixed in Resource; case insensitive string comparison predicate
 * added
 *
 * Revision 1.10  1998/12/15 17:38:16  vasilche
 * Added conversion functions string <> int.
 *
 * Revision 1.9  1998/12/04 23:36:30  vakatov
 * + NcbiEmptyCStr and NcbiEmptyString (const)
 *
 * Revision 1.8  1998/11/06 22:42:38  vakatov
 * Introduced BEGIN_, END_ and USING_ NCBI_SCOPE macros to put NCBI C++
 * API to namespace "ncbi::" and to use it by default, respectively
 * Introduced THROWS_NONE and THROWS(x) macros for the exception
 * specifications
 * Other fixes and rearrangements throughout the most of "corelib" code
 *
 * ==========================================================================
 */
#endif  /* CORELIB___NCBIMISC__HPP */

						