// @(#)root/reflex:$Id: ScopeName.h 32228 2010-02-05 16:13:09Z axel $
// Author: Stefan Roiser 2004

// Copyright CERN, CH-1211 Geneva 23, 2004-2010, All rights reserved.
//
// Permission to use, copy, modify, and distribute this software for any
// purpose is hereby granted without fee, provided that this copyright and
// permissions notice appear in all copies and derivatives.
//
// This software is provided "as is" without express or implied warranty.

#ifndef Reflex_ScopeName
#define Reflex_ScopeName

// Include files
#include "Reflex/Kernel.h"
#include "Reflex/internal/LiteralString.h"

namespace Reflex {
// forward declarations
class ScopeBase;
class Scope;

/**
 * @class ScopeName ScopeName.h Reflex/ScopeName.h
 * @author Stefan Roiser
 * @date 24/11/2003
 * @ingroup Ref
 */
class RFLX_API ScopeName {
   friend class Scope;
   friend class ScopeBase;

public:
   /** constructor */
   ScopeName(const char* name,
             ScopeBase * scopeBase);


   /**
    * ByName will return a pointer to a At which is given as an argument
    * or 0 if none is found
    * @param  Name fully qualified Name of At
    * @return pointer to At or 0 if none is found
    */
   static Scope ByName(const std::string& name);


   static void CleanUp();


   /**
    * DeleteScope will call the destructor of the ScopeBase this ScopeName is
    * pointing to and aremove it's information from the data structures. The
    * ScopeName information will remain.
    */
   void DeleteScope() const;


   /**
    * Hide this scope from any lookup by appending the string " @HIDDEN@" to its name.
    */
   void HideName();

   /**
    * Un-Hide this scope from any lookup by removing the string " @HIDDEN@" to its name.
    */
   void UnhideName();


   /**
    * Name will return a string representation of Name of the Scope
    * @return string representation of the Scope
    */
   const char* Name() const;


   /**
    * Name will return a string representation of Name of the Scope
    * @return string representation of the Scope
    */
   const LiteralString& LiteralName() const { return fName; }


   /**
    * Name will return a string representation of Name of the Scope
    * @return string representation of the Scope
    */
   LiteralString& LiteralName() { return fName; }


   /**
    * ThisScope will return the unqualified Scope object of this ScopeName
    * @return corresponding Scope
    */
   Scope ThisScope() const;


   /**
    * Unload reflection information for this scope.
    */
   void Unload();

   /**
    * ScopeAt will return the nth defined scope
    * @param  nth scope defined in the system
    * @return nth scope defined in the system
    */
   static Scope ScopeAt(size_t nth);


   /**
    * ScopeSize will return the number of currently defined scopes
    * (resolved and unresolved ones)
    * @return number of currently defined scopes
    */
   static size_t ScopeSize();


   static Scope_Iterator Scope_Begin();
   static Scope_Iterator Scope_End();
   static Reverse_Scope_Iterator Scope_RBegin();
   static Reverse_Scope_Iterator Scope_REnd();

private:
   /** destructor */
   ~ScopeName();

private:
   /** pointer to the Name of the At in the static map */
   LiteralString fName;

   /**
    * pointer to the resolved Scope
    * @label scope base
    * @link aggregation
    * @supplierCardinality 0..1
    * @clientCardinality 1
    */
   mutable
   ScopeBase * fScopeBase;

   /**
    * This scope
    */
   Scope* fThisScope;

};    // class ScopeName
} // namespace Reflex


//-------------------------------------------------------------------------------
inline const char*
Reflex::ScopeName::Name() const {
//-------------------------------------------------------------------------------
   return fName.c_str();
}


#endif //Reflex_ScopeName
