namespace.hpp

Go to the documentation of this file.

Go to the SVN repository for this file.

#ifndef NAMESPACE__HPP
#define NAMESPACE__HPP
 
/*  $Id: namespace.hpp 55304 2012-08-07 13:34:40Z gouriano $
* ===========================================================================
*
*                            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: Eugene Vasilchenko
*
* File Description:
*   !!! PUT YOUR DESCRIPTION HERE !!!
*
*/
 
#include <corelib/ncbistd.hpp>
#include <vector>
 
BEGIN_NCBI_SCOPE
 
class CNamespace
{
public:
    typedef vector<string> TNamespaces;
 
    CNamespace(void);
    CNamespace(const string& s);
 
    void Set(const CNamespace& ns, CNcbiOstream& out, bool mainHeader = true);
 
    string GetNamespaceRef(const CNamespace& ns) const;
    void UseFullname(bool full)
    {
        m_UseFullname = full;
    }
    bool UseFullname(void) const
    {
        return m_UseFullname;
    }
 
    void Reset(void)
        {
            m_Namespaces.clear();
            m_UseFullname = false;
        }
    void Reset(CNcbiOstream& out)
        {
            CloseAllAbove(0, out);
        }
 
    CNcbiOstream& PrintFullName(CNcbiOstream& out) const;
 
    operator string(void) const
        {
            string s;
            ToStringTo(s);
            return s;
        }
 
    string ToString(void) const
        {
            string s;
            ToStringTo(s);
            return s;
        }
 
    bool IsEmpty(void) const
        {
            return m_Namespaces.empty();
        }
    DECLARE_OPERATOR_BOOL(!IsEmpty());
 
    bool operator==(const CNamespace& ns) const
        {
            size_t myLevel = GetNamespaceLevel();
            return ns.GetNamespaceLevel() == myLevel &&
                EqualLevels(ns) == myLevel;
        }
    bool operator!=(const CNamespace& ns) const
        {
            return !(*this == ns);
        }
 
    static const CNamespace KEmptyNamespace;
    static const CNamespace KNCBINamespace;
    static const CNamespace KSTDNamespace;
    static const string KNCBINamespaceName;
    static const string KSTDNamespaceName;
    static const string KNCBINamespaceDefine;
    static const string KSTDNamespaceDefine;
 
    bool InNCBI(void) const
        {
            return m_Namespaces.size() > 0 &&
                m_Namespaces[0] == KNCBINamespaceName;
        }
    bool InSTD(void) const
        {
            return m_Namespaces.size() > 0 &&
                m_Namespaces[0] == KSTDNamespaceName;
        }
    bool IsNCBI(void) const
        {
            return m_Namespaces.size() == 1 &&
                m_Namespaces[0] == KNCBINamespaceName;
        }
    bool IsSTD(void) const
        {
            return m_Namespaces.size() == 1 &&
                m_Namespaces[0] == KSTDNamespaceName;
        }
 
protected:
    const TNamespaces& GetNamespaces(void) const
        {
            return m_Namespaces;
        }
    size_t GetNamespaceLevel(void) const
        {
            return m_Namespaces.size();
        }
 
    void Open(const string& s, CNcbiOstream& out, bool mainHeader = true);
    void Close(CNcbiOstream& out);
    void CloseAllAbove(size_t level, CNcbiOstream& out);
 
    size_t EqualLevels(const CNamespace& ns) const;
 
    void ToStringTo(string& s) const;
 
    TNamespaces m_Namespaces;
    bool m_UseFullname;
};
 
inline
CNcbiOstream& operator<<(CNcbiOstream& out, const CNamespace& ns)
{
    return ns.PrintFullName(out);
}
 
END_NCBI_SCOPE
 
#endif  /* NAMESPACE__HPP */