NativeFunctionBase.h

Go to the documentation of this file.

#pragma once
 
#include "RE/B/BSFixedString.h"
#include "RE/I/IFunction.h"
#include "RE/T/TypeInfo.h"
#include "RE/V/VDescTable.h"
 
namespace RE
{
    namespace BSScript
    {
        namespace Internal
        {
            class VirtualMachine;
        }
 
        class StackFrame;
        class Variable;
 
        namespace NF_util
        {
            class NativeFunctionBase : public IFunction
            {
            public:
                inline static constexpr auto RTTI = RTTI_BSScript__NF_util__NativeFunctionBase;
                inline static constexpr auto VTABLE = VTABLE_BSScript__NF_util__NativeFunctionBase;
 
                NativeFunctionBase() = delete;
                explicit NativeFunctionBase(std::string_view a_fnName, std::string_view a_className, bool a_isStatic, std::uint16_t a_numParams);
                ~NativeFunctionBase() override = default;  // 00
 
                // override (IFunction)
                const BSFixedString& GetName() const override;                                                                                                  // 01
                const BSFixedString& GetObjectTypeName() const override;                                                                                        // 02
                const BSFixedString& GetStateName() const override;                                                                                             // 03
                TypeInfo             GetReturnType() const override;                                                                                            // 04
                std::uint32_t        GetParamCount() const override;                                                                                            // 05
                void                 GetParam(std::uint32_t a_idx, BSFixedString& a_nameOut, TypeInfo& a_typeOut) const override;                               // 06
                std::uint32_t        GetStackFrameSize() const override;                                                                                        // 07
                bool                 GetIsNative() const override;                                                                                              // 08
                bool                 GetIsStatic() const override;                                                                                              // 09
                bool                 GetIsEmpty() const override;                                                                                               // 0A
                FunctionType         GetFunctionType() const override;                                                                                          // 0B
                std::uint32_t        GetUserFlags() const override;                                                                                             // 0C
                const BSFixedString& GetDocString() const override;                                                                                             // 0D
                void                 InsertLocals(StackFrame* a_frame) override;                                                                                // 0E
                CallResult           Call(const BSTSmartPointer<Stack>& a_stack, ErrorLogger* a_logger, Internal::VirtualMachine* a_vm, bool a_arg4) override;  // 0F
                const BSFixedString& GetSourceFilename() const override;                                                                                        // 10
                bool                 TranslateIPToLineNumber(std::uint32_t a_taskletExecutionOffset, std::uint32_t& a_lineNumberOut) const override;            // 11
                bool                 GetVarNameForStackIndex(std::uint32_t a_idx, BSFixedString& a_nameOut) const override;                                     // 12
                bool                 CanBeCalledFromTasklets() const override;                                                                                  // 13
                void                 SetCallableFromTasklets(bool a_callable) override;                                                                         // 14
 
                // add
                virtual bool HasStub() const = 0;                                                                                                                                            // 15
                virtual bool MarshallAndDispatch(Variable& a_baseValue, Internal::VirtualMachine& a_vm, VMStackID a_stackID, Variable& a_resultValue, const StackFrame& a_frame) const = 0;  // 16
 
                bool GetIsLatent() const;
 
            protected:
                // members
                BSFixedString        _name;                            // 10
                BSFixedString        _objName;                         // 18
                BSFixedString        _stateName{ "" };                 // 20
                TypeInfo             _retType;                         // 28
                Internal::VDescTable _descTable;                       // 30
                bool                 _isStatic;                        // 40
                bool                 _isCallableFromTasklet{ false };  // 41
                bool                 _isLatent{ false };               // 42
                std::uint8_t         _pad43{ 0 };                      // 43
                std::uint32_t        _userFlags{ 0 };                  // 44
                BSFixedString        _docString;                       // 48
            };
            static_assert(sizeof(NativeFunctionBase) == 0x50);
        }
    }
}