using System;

using System.Runtime.InteropServices;

using System.Security;

using System.Text;

using System.Threading;

using System.Collections.Generic;

using Python.Runtime.Platform;

namespace Python.Runtime

/// <summary>

/// Encapsulates the low-level Python C API. Note that it is

/// the responsibility of the caller to have acquired the GIL

/// before calling any of these methods.

/// </summary>

public class Runtime

{

// C# compiler copies constants to the assemblies that references this library.

// We needs to replace all public constants to static readonly fields to allow

// binary substitution of different Python.Runtime.dll builds in a target application.

public static int UCS => _UCS;

#if UCS4

internal const int _UCS = 4;

/// <summary>

/// EntryPoint to be used in DllImport to map to correct Unicode

/// methods prior to PEP393. Only used for PY27.

/// </summary>

private const string PyUnicodeEntryPoint = "PyUnicodeUCS4_";

#elif UCS2

internal const int _UCS = 2;

/// <summary>

/// EntryPoint to be used in DllImport to map to correct Unicode

/// methods prior to PEP393. Only used for PY27.

/// </summary>

private const string PyUnicodeEntryPoint = "PyUnicodeUCS2_";

#else

#error You must define either UCS2 or UCS4!

#endif

// C# compiler copies constants to the assemblies that references this library.

// We needs to replace all public constants to static readonly fields to allow

// binary substitution of different Python.Runtime.dll builds in a target application.

public static string pyversion => _pyversion;

public static string pyver => _pyver;

#if PYTHON27

internal const string _pyversion = "2.7";

internal const string _pyver = "27";

#elif PYTHON34

internal const string _pyversion = "3.4";

internal const string _pyver = "34";

#elif PYTHON35

internal const string _pyversion = "3.5";

internal const string _pyver = "35";

#elif PYTHON36

internal const string _pyversion = "3.6";

internal const string _pyver = "36";

#elif PYTHON37

internal const string _pyversion = "3.7";

internal const string _pyver = "37";

#elif PYTHON38

internal const string _pyversion = "3.8";

internal const string _pyver = "38";

#else

#error You must define one of PYTHON34 to PYTHON38 or PYTHON27

#endif

#if MONO_LINUX || MONO_OSX // Linux/macOS use dotted version string

internal const string dllBase = "python" + _pyversion;

#else // Windows

internal const string dllBase = "python" + _pyver;

#endif

#if PYTHON_WITH_PYDEBUG

internal const string dllWithPyDebug = "d";

#else

internal const string dllWithPyDebug = "";

#endif

#if PYTHON_WITH_PYMALLOC

internal const string dllWithPyMalloc = "m";

#else

internal const string dllWithPyMalloc = "";

#endif

// C# compiler copies constants to the assemblies that references this library.

// We needs to replace all public constants to static readonly fields to allow

// binary substitution of different Python.Runtime.dll builds in a target application.

public static readonly string PythonDLL = _PythonDll;

#if PYTHON_WITHOUT_ENABLE_SHARED && !NETSTANDARD

internal const string _PythonDll = "__Internal";

#else

internal const string _PythonDll = dllBase + dllWithPyDebug + dllWithPyMalloc;

#endif

public static readonly int pyversionnumber = Convert.ToInt32(_pyver);

// set to true when python is finalizing

internal static object IsFinalizingLock = new object();

internal static bool IsFinalizing;

internal static bool Is32Bit = IntPtr.Size == 4;

// .NET core: System.Runtime.InteropServices.RuntimeInformation.IsOSPlatform(OSPlatform.Windows)

internal static bool IsWindows = Environment.OSVersion.Platform == PlatformID.Win32NT;

static readonly Dictionary<string, OperatingSystemType> OperatingSystemTypeMapping = new Dictionary<string, OperatingSystemType>()

{

{ "Windows", OperatingSystemType.Windows },

{ "Darwin", OperatingSystemType.Darwin },

{ "Linux", OperatingSystemType.Linux },

};

/// <summary>

/// Gets the operating system as reported by python's platform.system().

/// </summary>

public static OperatingSystemType OperatingSystem { get; private set; }

/// <summary>

/// Gets the operating system as reported by python's platform.system().

/// </summary>

public static string OperatingSystemName { get; private set; }

/// <summary>

/// Map lower-case version of the python machine name to the processor

/// type. There are aliases, e.g. x86_64 and amd64 are two names for

/// the same thing. Make sure to lower-case the search string, because

/// capitalization can differ.

/// </summary>

static readonly Dictionary<string, MachineType> MachineTypeMapping = new Dictionary<string, MachineType>()

{

["i386"] = MachineType.i386,

["i686"] = MachineType.i386,

["x86"] = MachineType.i386,

["x86_64"] = MachineType.x86_64,

["amd64"] = MachineType.x86_64,

["x64"] = MachineType.x86_64,

["em64t"] = MachineType.x86_64,

["armv7l"] = MachineType.armv7l,

["armv8"] = MachineType.armv8,

["aarch64"] = MachineType.aarch64,

};

/// <summary>

/// Gets the machine architecture as reported by python's platform.machine().

/// </summary>

public static MachineType Machine { get; private set; }/* set in Initialize using python's platform.machine */

/// <summary>

/// Gets the machine architecture as reported by python's platform.machine().

/// </summary>

public static string MachineName { get; private set; }

internal static bool IsPython2 = pyversionnumber < 30;

internal static bool IsPython3 = pyversionnumber >= 30;

public static int MainManagedThreadId { get; private set; }

/// <summary>

/// Encoding to use to convert Unicode to/from Managed to Native

/// </summary>

internal static readonly Encoding PyEncoding = _UCS == 2 ? Encoding.Unicode : Encoding.UTF32;

/// <summary>

/// Initialize the runtime...

/// </summary>

internal static void Initialize(bool initSigs = false)

}

/// <summary>

/// Initializes the data about platforms.

///

/// This must be the last step when initializing the runtime:

/// GetManagedString needs to have the cached values for types.

/// But it must run before initializing anything outside the runtime

/// because those rely on the platform data.

/// </summary>

private static void InitializePlatformData()

}

internal static void Shutdown()

}

// called *without* the GIL acquired by clr._AtExit

internal static int AtExit()

}

internal static IntPtr Py_single_input = (IntPtr)256;

internal static IntPtr Py_file_input = (IntPtr)257;

internal static IntPtr Py_eval_input = (IntPtr)258;

internal static IntPtr PyBaseObjectType;

internal static IntPtr PyModuleType;

internal static IntPtr PyClassType;

internal static IntPtr PyInstanceType;

internal static IntPtr PyCLRMetaType;

internal static IntPtr PyMethodType;

internal static IntPtr PyWrapperDescriptorType;

internal static IntPtr PyUnicodeType;

internal static IntPtr PyStringType;

internal static IntPtr PyTupleType;

internal static IntPtr PyListType;

internal static IntPtr PyDictType;

internal static IntPtr PyIntType;

internal static IntPtr PyLongType;

internal static IntPtr PyFloatType;

internal static IntPtr PyBoolType;

internal static IntPtr PyNoneType;

internal static IntPtr PyTypeType;

internal static IntPtr Py_NoSiteFlag;

#if PYTHON3

internal static IntPtr PyBytesType;

#endif

internal static IntPtr _PyObject_NextNotImplemented;

internal static IntPtr PyNotImplemented;

internal const int Py_LT = 0;

internal const int Py_LE = 1;

internal const int Py_EQ = 2;

internal const int Py_NE = 3;

internal const int Py_GT = 4;

internal const int Py_GE = 5;

internal static IntPtr PyTrue;

internal static IntPtr PyFalse;

internal static IntPtr PyNone;

internal static IntPtr Error;

/// <summary>

/// Check if any Python Exceptions occurred.

/// If any exist throw new PythonException.

/// </summary>

/// <remarks>

/// Can be used instead of `obj == IntPtr.Zero` for example.

/// </remarks>

internal static void CheckExceptionOccurred()

}

internal static IntPtr ExtendTuple(IntPtr t, params IntPtr[] args)

}

internal static Type[] PythonArgsToTypeArray(IntPtr arg)

{

return PythonArgsToTypeArray(arg, false);

}

internal static Type[] PythonArgsToTypeArray(IntPtr arg, bool mangleObjects)

}

/// <summary>

/// Managed exports of the Python C API. Where appropriate, we do

/// some optimization to avoid managed &lt;--&gt; unmanaged transitions

/// (mostly for heavily used methods).

/// </summary>

internal static unsafe void XIncref(IntPtr op)

}

internal static unsafe void XDecref(IntPtr op)

{

#if PYTHON_WITH_PYDEBUG || NETSTANDARD

Py_DecRef(op);

return;

#else

var p = (void*)op;

if ((void*)0 != p)

{

if (Is32Bit)

{

--(*(int*)p);

}

else

{

--(*(long*)p);

}

if ((*(int*)p) == 0)

{

// PyObject_HEAD: struct _typeobject *ob_type

void* t = Is32Bit

? (void*)(*((uint*)p + 1))

: (void*)(*((ulong*)p + 1));

// PyTypeObject: destructor tp_dealloc

void* f = Is32Bit

? (void*)(*((uint*)t + 6))

: (void*)(*((ulong*)t + 6));

if ((void*)0 == f)

{

return;

}

NativeCall.Impl.Void_Call_1(new IntPtr(f), op);

}

}

#endif

}

internal static unsafe long Refcount(IntPtr op)

{

var p = (void*)op;

if ((void*)0 == p)

{

return 0;

}

return Is32Bit ? (*(int*)p) : (*(long*)p);

}

/// <summary>

/// Export of Macro Py_XIncRef. Use XIncref instead.

/// Limit this function usage for Testing and Py_Debug builds

/// </summary>

/// <param name="ob">PyObject Ptr</param>

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void Py_IncRef(IntPtr ob);

/// <summary>

/// Export of Macro Py_XDecRef. Use XDecref instead.

/// Limit this function usage for Testing and Py_Debug builds

/// </summary>

/// <param name="ob">PyObject Ptr</param>

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void Py_DecRef(IntPtr ob);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void Py_Initialize();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void Py_InitializeEx(int initsigs);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern int Py_IsInitialized();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void Py_Finalize();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr Py_NewInterpreter();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void Py_EndInterpreter(IntPtr threadState);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyThreadState_New(IntPtr istate);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyThreadState_Get();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyThread_get_key_value(IntPtr key);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern int PyThread_get_thread_ident();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern int PyThread_set_key_value(IntPtr key, IntPtr value);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyThreadState_Swap(IntPtr key);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyGILState_Ensure();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void PyGILState_Release(IntPtr gs);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyGILState_GetThisThreadState();

#if PYTHON3

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

public static extern int Py_Main(

int argc,

[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(StrArrayMarshaler))] string[] argv

);

#elif PYTHON2

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

public static extern int Py_Main(int argc, string[] argv);

#endif

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void PyEval_InitThreads();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern int PyEval_ThreadsInitialized();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void PyEval_AcquireLock();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void PyEval_ReleaseLock();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void PyEval_AcquireThread(IntPtr tstate);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void PyEval_ReleaseThread(IntPtr tstate);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyEval_SaveThread();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void PyEval_RestoreThread(IntPtr tstate);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyEval_GetBuiltins();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyEval_GetGlobals();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyEval_GetLocals();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr Py_GetProgramName();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void Py_SetProgramName(IntPtr name);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr Py_GetPythonHome();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void Py_SetPythonHome(IntPtr home);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr Py_GetPath();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern void Py_SetPath(IntPtr home);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr Py_GetVersion();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr Py_GetPlatform();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr Py_GetCopyright();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr Py_GetCompiler();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr Py_GetBuildInfo();

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern int PyRun_SimpleString(string code);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyRun_String(string code, IntPtr st, IntPtr globals, IntPtr locals);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyEval_EvalCode(IntPtr co, IntPtr globals, IntPtr locals);

#if PYTHON2

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr Py_CompileString(string code, string file, int start);

#else

/// <summary>

/// Return value: New reference.

/// This is a simplified interface to Py_CompileStringFlags() below, leaving flags set to NULL.

/// </summary>

internal static IntPtr Py_CompileString(string str, string file, int start)

{

return Py_CompileStringFlags(str, file, start, IntPtr.Zero);

}

/// <summary>

/// Return value: New reference.

/// This is a simplified interface to Py_CompileStringExFlags() below, with optimize set to -1.

/// </summary>

internal static IntPtr Py_CompileStringFlags(string str, string file, int start, IntPtr flags)

{

return Py_CompileStringExFlags(str, file, start, flags, -1);

}

/// <summary>

/// Return value: New reference.

/// Like Py_CompileStringObject(), but filename is a byte string decoded from the filesystem encoding(os.fsdecode()).

/// </summary>

/// <returns></returns>

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr Py_CompileStringExFlags(string str, string file, int start, IntPtr flags, int optimize);

#endif

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyImport_ExecCodeModule(string name, IntPtr code);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyCFunction_NewEx(IntPtr ml, IntPtr self, IntPtr mod);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyCFunction_Call(IntPtr func, IntPtr args, IntPtr kw);

#if PYTHON2

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyClass_New(IntPtr bases, IntPtr dict, IntPtr name);

#endif

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyInstance_New(IntPtr cls, IntPtr args, IntPtr kw);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyInstance_NewRaw(IntPtr cls, IntPtr dict);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyMethod_New(IntPtr func, IntPtr self, IntPtr cls);

//====================================================================

// Python abstract object API

//====================================================================

/// <summary>

/// A macro-like method to get the type of a Python object. This is

/// designed to be lean and mean in IL &amp; avoid managed &lt;-&gt; unmanaged

/// transitions. Note that this does not incref the type object.

/// </summary>

internal static unsafe IntPtr PyObject_TYPE(IntPtr op)

{

var p = (void*)op;

if ((void*)0 == p)

{

return IntPtr.Zero;

}

#if PYTHON_WITH_PYDEBUG

var n = 3;

#else

var n = 1;

#endif

return Is32Bit

? new IntPtr((void*)(*((uint*)p + n)))

: new IntPtr((void*)(*((ulong*)p + n)));

}

/// <summary>

/// Managed version of the standard Python C API PyObject_Type call.

/// This version avoids a managed &lt;-&gt; unmanaged transition.

/// This one does incref the returned type object.

/// </summary>

internal static IntPtr PyObject_Type(IntPtr op)

{

IntPtr tp = PyObject_TYPE(op);

XIncref(tp);

return tp;

}

internal static string PyObject_GetTypeName(IntPtr op)

{

IntPtr pyType = Marshal.ReadIntPtr(op, ObjectOffset.ob_type);

IntPtr ppName = Marshal.ReadIntPtr(pyType, TypeOffset.tp_name);

return Marshal.PtrToStringAnsi(ppName);

}

/// <summary>

/// Test whether the Python object is an iterable.

/// </summary>

internal static bool PyObject_IsIterable(IntPtr pointer)

{

var ob_type = Marshal.ReadIntPtr(pointer, ObjectOffset.ob_type);

#if PYTHON2

long tp_flags = Util.ReadCLong(ob_type, TypeOffset.tp_flags);

if ((tp_flags & TypeFlags.HaveIter) == 0)

return false;

#endif

IntPtr tp_iter = Marshal.ReadIntPtr(ob_type, TypeOffset.tp_iter);

return tp_iter != IntPtr.Zero;

}

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern int PyObject_HasAttrString(IntPtr pointer, string name);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern IntPtr PyObject_GetAttrString(IntPtr pointer, string name);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]

internal static extern int PyObject_SetAttrString(IntPtr pointer, string name, IntPtr value);

[DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]