Identifier.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2011, SRI International (R)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#ifndef __OpenKarto_Name_h__
#define __OpenKarto_Name_h__

#include <OpenKarto/String.h>

namespace karto
{



  class KARTO_EXPORT Identifier
  {
  public:
    Identifier();

    Identifier(const char* pString);

    Identifier(const String& rString);

    Identifier(const Identifier& rOther);

    virtual ~Identifier();

  public:
    const String& GetName() const;

    void SetName(const String& pName);

    const String& GetScope() const;

    void SetScope(const String& rScope);

    kt_size_t Size() const;

    void Clear();

    const String& ToString() const;

  public:
    Identifier& operator=(const Identifier& rOther);

    kt_bool operator==(const Identifier& rOther) const;

    kt_bool operator!=(const Identifier& rOther) const
    {
      return !(*this == rOther);
    }

    kt_bool operator<(const Identifier& rOther) const;

    friend KARTO_FORCEINLINE std::ostream& operator << (std::ostream& rStream, const Identifier& rIdentifier)
    {
      rStream << rIdentifier.ToString();
      return rStream;
    }
    
  private:
    void Parse(const String& rString);

    void Validate(const String& rString);

    void Update();

    inline kt_bool IsValidFirst(char c)
    {
      return (isalpha(c) || c == '/');
    }

    inline kt_bool IsValid(char c)
    {
      return (isalnum(c) || c == '/' || c == '_' || c == '-');
    }

  private:
    String m_Name;
    String m_Scope;
    String m_FullName;
  };


}

#endif // __OpenKarto_Name_h__