/*
* Copyright (c) <2017> Side Effects Software Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/

#pragma once

class FText;
class FString;
class FName;

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

class HOUDINIENGINERUNTIME_API FHoudiniEngineString
{
    public:

        FHoudiniEngineString();
        FHoudiniEngineString( int32 InStringId );
        FHoudiniEngineString( const FHoudiniEngineString & Other );

    public:

        FHoudiniEngineString & operator=( const FHoudiniEngineString & Other );

    public:

        bool operator==( const FHoudiniEngineString & Other ) const;
        bool operator!=( const FHoudiniEngineString & Other ) const;

    public:

        bool ToStdString( std::string & String ) const;
        bool ToFName( FName & Name ) const;
        bool ToFString( FString & String ) const;
        bool ToFText( FText & Text ) const;

    public:

        /** Return id of this string. **/
        int32 GetId() const;

        /** Return true if this string has a valid id. **/
        bool HasValidId() const;

    protected:

        /** Id of the underlying Houdini Engine string. **/
        int32 StringId;
};