/**
* @file   llmaterialid.h
* @brief  Header file for llmaterialid
* @author Stinson@lindenlab.com
*
* $LicenseInfo:firstyear=2012&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2012, Linden Research, Inc.
*
* This library 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;
* version 2.1 of the License only.
*
* This library 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 library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*
* Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
* $/LicenseInfo$
*/
#ifndef LL_LLMATERIALID_H
#define LL_LLMATERIALID_H

#define MATERIAL_ID_SIZE 16

#include <string>
#include "llsd.h"

class LLMaterialID
{
public:
    LLMaterialID();
    LLMaterialID(const LLSD& pMaterialID);
    LLMaterialID(const LLSD::Binary& pMaterialID);
    LLMaterialID(const void* pMemory);
    LLMaterialID(const LLMaterialID& pOtherMaterialID);
    LLMaterialID(const LLUUID& lluid);
    ~LLMaterialID();

    bool          operator == (const LLMaterialID& pOtherMaterialID) const;
    bool          operator != (const LLMaterialID& pOtherMaterialID) const;

    bool          operator < (const LLMaterialID& pOtherMaterialID) const;
    bool          operator <= (const LLMaterialID& pOtherMaterialID) const;
    bool          operator > (const LLMaterialID& pOtherMaterialID) const;
    bool          operator >= (const LLMaterialID& pOtherMaterialID) const;

    LLMaterialID& operator = (const LLMaterialID& pOtherMaterialID);

    bool          isNull() const;

    const U8*     get() const;
    void          set(const void* pMemory);
    void          clear();

    LLSD          asLLSD() const;
    std::string   asString() const;
    LLUUID        asUUID() const;

    friend std::ostream& operator<<(std::ostream& s, const LLMaterialID &material_id);

    static const LLMaterialID null;

    // Returns a 64 bits digest of the material Id, by XORing its two 64 bits
    // long words. HB
    inline U64 getDigest64() const
    {
        U64* tmp = (U64*)mID;
        return tmp[0] ^ tmp[1];
    }

private:
    void parseFromBinary(const LLSD::Binary& pMaterialID);
    void copyFromOtherMaterialID(const LLMaterialID& pOtherMaterialID);
    int  compareToOtherMaterialID(const LLMaterialID& pOtherMaterialID) const;

    U8 mID[MATERIAL_ID_SIZE];
} ;

// std::hash implementation for LLMaterialID
namespace std
{
    template<> struct hash<LLMaterialID>
    {
        inline size_t operator()(const LLMaterialID& id) const noexcept
        {
            return (size_t)id.getDigest64();
        }
    };
}

// For use with boost containers.
inline size_t hash_value(const LLMaterialID& id) noexcept
{
    return (size_t)id.getDigest64();
}

#endif // LL_LLMATERIALID_H