o3de/Gems/ScriptEvents/Code/Include/ScriptEvents/ScriptEventParameter.h

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#pragma once

#include <ScriptEvents/Internal/VersionedProperty.h>
#include <AzCore/Serialization/SerializeContext.h>
#include <ScriptEvents/ScriptEventTypes.h>
#include <AzCore/Serialization/EditContext.h>
#include <AzCore/std/string/regex.h>

namespace ScriptEvents
{
    //! An event's parameter definition, see (ScriptEventMethod)
    class Parameter
    {
    public:

        AZ_TYPE_INFO(Parameter, "{0DA4809B-08A6-49DC-9024-F81645D97FAC}");

        Parameter()
            : m_name("Name")
            , m_tooltip("Tooltip")
            , m_type("Type")
        {
            m_tooltip.Set("");
            m_name.Set("ParameterName");
            m_type.Set(azrtti_typeid<bool>());
        }

        Parameter(const Parameter& rhs)
        {
            m_name = rhs.m_name;
            m_tooltip = rhs.m_tooltip;
            m_type = rhs.m_type;
        }

        Parameter(AZ::ScriptDataContext& dc)
        {
            FromScript(dc);
        }

        void FromScript(AZ::ScriptDataContext& dc)
        {
            if (dc.GetNumArguments() > 0)
            {
                AZStd::string name;
                if (dc.ReadArg(0, name))
                {
                    m_name.Set(name.c_str());
                }

                if (dc.GetNumArguments() > 1)
                {
                    AZ::Uuid parameterType;
                    if (dc.ReadArg(1, parameterType))
                    {
                        m_type.Set(parameterType);
                    }
                }
            }

            //AZ_TracePrintf("Script Events", "Added Parameter: %s (type: %s)\n", GetName().c_str(), GetType().ToString<AZStd::string>() .c_str());

        }

        static void Reflect(AZ::ReflectContext* context)
        {
            if (AZ::SerializeContext* serializeContext = azrtti_cast<AZ::SerializeContext*>(context))
            {
                serializeContext->Class<Parameter>()
                    ->Field("m_name", &Parameter::m_name)
                    ->Field("m_tooltip", &Parameter::m_tooltip)
                    ->Field("m_type", &Parameter::m_type)
                    ;

                if (AZ::EditContext* editContext = serializeContext->GetEditContext())
                {
                    editContext->Class<Parameter>("A Script Event's method parameter", "A parameter to a Script Event's event definition")
                        ->DataElement(AZ::Edit::UIHandlers::Default, &Parameter::m_name, "Name", "Name of the parameter, ex. void foo(int thisIsTheParameterName)")
                        ->DataElement(AZ::Edit::UIHandlers::Default, &Parameter::m_tooltip, "Tooltip", "A description of this parameter")
                        ->DataElement(AZ::Edit::UIHandlers::ComboBox, &Parameter::m_type, "Type", "The typeid of the parameter, ex. void foo(AZ::type_info<int>::Uuid())")
                            ->Attribute(AZ::Edit::Attributes::GenericValueList, &Types::GetValidParameterTypes)
                        ;
                }
            }

            if (AZ::BehaviorContext* behaviorContext = azrtti_cast<AZ::BehaviorContext*>(context))
            {
                behaviorContext->Class<Parameter>("Parameter")
                    ->Attribute(AZ::Script::Attributes::ExcludeFrom, AZ::Script::Attributes::ExcludeFlags::All)
                    ->Property("Name", BehaviorValueProperty(&Parameter::m_name))
                    ->Property("Type", BehaviorValueProperty(&Parameter::m_type))
                    ;
            }
        }

        AZ::Outcome<bool, AZStd::string> Validate() const
        {
            const AZStd::string& name = GetName();
            const AZ::Uuid* parameterType = m_type.Get<const AZ::Uuid>();

            AZ_Assert(parameterType && !parameterType->IsNull(), "The Parameter type should not be null");

            // Validate address type
            if (!Types::IsValidParameterType(*parameterType))
            {
                return AZ::Failure(AZStd::string::format("The specified type %s is not valid as parameter type for Script Event: %s", (*parameterType).ToString<AZStd::string>().c_str(), name.c_str()));
            }

            // Definition name cannot be empty
            if (name.empty())
            {
                return AZ::Failure(AZStd::string("Definition name cannot be empty"));
            }

            // Name cannot start with a number
            if (isdigit(name.at(0)))
            {
                return AZ::Failure(AZStd::string::format("%s, names cannot start with a number", name.c_str()));
            }

            // Conform to valid function names
            AZStd::smatch match;

            // Ascii-only
            AZStd::regex asciionly_regex("[^\x0A\x0D\x20-\x7E]");
            AZStd::regex_match(name, match, asciionly_regex);
            if (match.size() > 0)
            {
                return AZ::Failure(AZStd::string::format("%s, invalid name, names may only contain ASCII characters", name.c_str()));
            }

            // Function name syntax
            AZStd::regex validate_regex("[_[:alpha:]][_[:alnum:]]*");
            AZStd::regex_match(name, match, validate_regex);
            if (match.size() == 0)
            {
                return AZ::Failure(AZStd::string::format("%s, invalid name specified", name.c_str()));
            }

            return AZ::Success(true);

        }

        AZStd::string GetName() const { return m_name.Get<AZStd::string>() ? *m_name.Get<AZStd::string>() : ""; }
        AZStd::string GetTooltip() const { return m_tooltip.Get<AZStd::string>() ? *m_tooltip.Get<AZStd::string>() : ""; }
        AZ::Uuid GetType() const { return m_type.Get<AZ::Uuid>() ? *m_type.Get<AZ::Uuid>() : AZ::Uuid::CreateNull(); }

        ScriptEventData::VersionedProperty& GetNameProperty() { return m_name; }
        ScriptEventData::VersionedProperty& GetTooltipProperty() { return m_tooltip; }
        ScriptEventData::VersionedProperty& GetTypeProperty() { return m_type; }

        const ScriptEventData::VersionedProperty& GetNameProperty() const { return m_name; }
        const ScriptEventData::VersionedProperty& GetTooltipProperty() const { return m_tooltip; }
        const ScriptEventData::VersionedProperty& GetTypeProperty() const { return m_type; }

        void PreSave()
        {
            m_name.PreSave();
            m_tooltip.PreSave();
            m_type.PreSave();
        }

        void Flatten()
        {
            m_name.Flatten();
            m_tooltip.Flatten();
            m_type.Flatten();
        }

    private:

        ScriptEventData::VersionedProperty m_name;
        ScriptEventData::VersionedProperty m_tooltip;
        ScriptEventData::VersionedProperty m_type;

    };

}