Refactor PY2/PY3 Marshal in/out String/Unicode

vmuriart · vmuriart · commit 85c85f2f7152 · 2017-03-03T20:14:41.000-07:00
diff --git a/src/runtime/CustomMarshaler.cs b/src/runtime/CustomMarshaler.cs
@@ -95,10 +95,52 @@ public static int GetUnicodeByteLength(IntPtr p)
                     ? Marshal.ReadInt16(p, len * 2)
                     : Marshal.ReadInt32(p, len * 4);
 
-                if (c == 0) return len* Runtime.UCS;
-                checked{ ++len; }
+                if (c == 0)
+                {
+                    return len * Runtime.UCS;
+                }
+                checked
+                {
+                    ++len;
+                }
             }
         }
+
+        /// <summary>
+        /// Utility function for Marshaling Unicode on PY3 and AnsiStr on PY2.
+        /// Use on functions whose Input signatures changed between PY2/PY3.
+        /// Ex. Py_SetPythonHome
+        /// </summary>
+        /// <param name="s">Managed String</param>
+        /// <returns>
+        /// Ptr to Native String ANSI(PY2)/Unicode(PY3/UCS2)/UTF32(PY3/UCS4.
+        /// </returns>
+        /// <remarks>
+        /// You MUST deallocate the IntPtr of the Return when done with it.
+        /// </remarks>
+        public static IntPtr Py3UnicodePy2StringtoPtr(string s)
+        {
+            return Runtime.IsPython3
+                ? Instance.MarshalManagedToNative(s)
+                : Marshal.StringToHGlobalAnsi(s);
+        }
+
+        /// <summary>
+        /// Utility function for Marshaling Unicode IntPtr on PY3 and
+        /// AnsiStr IntPtr on PY2 to Managed Strings. Use on Python functions
+        /// whose return type changed between PY2/PY3.
+        /// Ex. Py_GetPythonHome
+        /// </summary>
+        /// <param name="p">Native Ansi/Unicode/UTF32 String</param>
+        /// <returns>
+        /// Managed String
+        /// </returns>
+        public static string PtrToPy3UnicodePy2String(IntPtr p)
+        {
+            return Runtime.IsPython3
+                ? PtrToStringUni(p)
+                : Marshal.PtrToStringAnsi(p);
+        }
     }
 
 
diff --git a/src/runtime/pythonengine.cs b/src/runtime/pythonengine.cs
@@ -61,18 +61,12 @@ public static string ProgramName
             get
             {
                 IntPtr p = Runtime.Py_GetProgramName();
-                string result = Runtime.IsPython3
-                    ? UcsMarshaler.PtrToStringUni(p)
-                    : Marshal.PtrToStringAnsi(p);
-
-                return result ?? "";
+                return UcsMarshaler.PtrToPy3UnicodePy2String(p) ?? "";
             }
             set
             {
                 Marshal.FreeHGlobal(_programName);
-                _programName = Runtime.IsPython3
-                    ? UcsMarshaler.GetInstance("").MarshalManagedToNative(value)
-                    : Marshal.StringToHGlobalAnsi(value);
+                _programName = UcsMarshaler.Py3UnicodePy2StringtoPtr(value);
                 Runtime.Py_SetProgramName(_programName);
             }
         }
@@ -82,18 +76,12 @@ public static string PythonHome
             get
             {
                 IntPtr p = Runtime.Py_GetPythonHome();
-                string result = Runtime.IsPython3
-                    ? UcsMarshaler.PtrToStringUni(p)
-                    : Marshal.PtrToStringAnsi(p);
-
-                return result ?? "";
+                return UcsMarshaler.PtrToPy3UnicodePy2String(p) ?? "";
             }
             set
             {
                 Marshal.FreeHGlobal(_pythonHome);
-                _pythonHome = Runtime.IsPython3
-                    ? UcsMarshaler.GetInstance("").MarshalManagedToNative(value)
-                    : Marshal.StringToHGlobalAnsi(value);
+                _pythonHome = UcsMarshaler.Py3UnicodePy2StringtoPtr(value);
                 Runtime.Py_SetPythonHome(_pythonHome);
             }
         }
@@ -103,18 +91,12 @@ public static string PythonPath
             get
             {
                 IntPtr p = Runtime.Py_GetPath();
-                string result = Runtime.IsPython3
-                    ? UcsMarshaler.PtrToStringUni(p)
-                    : Marshal.PtrToStringAnsi(p);
-
-                return result ?? "";
+                return UcsMarshaler.PtrToPy3UnicodePy2String(p) ?? "";
             }
             set
             {
                 Marshal.FreeHGlobal(_pythonPath);
-                _pythonPath = Runtime.IsPython3
-                    ? UcsMarshaler.GetInstance("").MarshalManagedToNative(value)
-                    : Marshal.StringToHGlobalAnsi(value);
+                _pythonPath = UcsMarshaler.Py3UnicodePy2StringtoPtr(value);
                 Runtime.Py_SetPath(_pythonPath);
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -61,18 +61,12 @@ public static string ProgramName`
`61`	`61`	`get`
`62`	`62`	`{`
`63`	`63`	`IntPtr p = Runtime.Py_GetProgramName();`
`64`		`- string result = Runtime.IsPython3`
`65`		`- ? UcsMarshaler.PtrToStringUni(p)`
`66`		`- : Marshal.PtrToStringAnsi(p);`
`67`		`-`
`68`		`- return result ?? "";`
	`64`	`+ return UcsMarshaler.PtrToPy3UnicodePy2String(p) ?? "";`
`69`	`65`	`}`
`70`	`66`	`set`
`71`	`67`	`{`
`72`	`68`	`Marshal.FreeHGlobal(_programName);`
`73`		`- _programName = Runtime.IsPython3`
`74`		`- ? UcsMarshaler.GetInstance("").MarshalManagedToNative(value)`
`75`		`- : Marshal.StringToHGlobalAnsi(value);`
	`69`	`+ _programName = UcsMarshaler.Py3UnicodePy2StringtoPtr(value);`
`76`	`70`	`Runtime.Py_SetProgramName(_programName);`
`77`	`71`	`}`
`78`	`72`	`}`
`@@ -82,18 +76,12 @@ public static string PythonHome`
`82`	`76`	`get`
`83`	`77`	`{`
`84`	`78`	`IntPtr p = Runtime.Py_GetPythonHome();`
`85`		`- string result = Runtime.IsPython3`
`86`		`- ? UcsMarshaler.PtrToStringUni(p)`
`87`		`- : Marshal.PtrToStringAnsi(p);`
`88`		`-`
`89`		`- return result ?? "";`
	`79`	`+ return UcsMarshaler.PtrToPy3UnicodePy2String(p) ?? "";`
`90`	`80`	`}`
`91`	`81`	`set`
`92`	`82`	`{`
`93`	`83`	`Marshal.FreeHGlobal(_pythonHome);`
`94`		`- _pythonHome = Runtime.IsPython3`
`95`		`- ? UcsMarshaler.GetInstance("").MarshalManagedToNative(value)`
`96`		`- : Marshal.StringToHGlobalAnsi(value);`
	`84`	`+ _pythonHome = UcsMarshaler.Py3UnicodePy2StringtoPtr(value);`
`97`	`85`	`Runtime.Py_SetPythonHome(_pythonHome);`
`98`	`86`	`}`
`99`	`87`	`}`
`@@ -103,18 +91,12 @@ public static string PythonPath`
`103`	`91`	`get`
`104`	`92`	`{`
`105`	`93`	`IntPtr p = Runtime.Py_GetPath();`
`106`		`- string result = Runtime.IsPython3`
`107`		`- ? UcsMarshaler.PtrToStringUni(p)`
`108`		`- : Marshal.PtrToStringAnsi(p);`
`109`		`-`
`110`		`- return result ?? "";`
	`94`	`+ return UcsMarshaler.PtrToPy3UnicodePy2String(p) ?? "";`
`111`	`95`	`}`
`112`	`96`	`set`
`113`	`97`	`{`
`114`	`98`	`Marshal.FreeHGlobal(_pythonPath);`
`115`		`- _pythonPath = Runtime.IsPython3`
`116`		`- ? UcsMarshaler.GetInstance("").MarshalManagedToNative(value)`
`117`		`- : Marshal.StringToHGlobalAnsi(value);`
	`99`	`+ _pythonPath = UcsMarshaler.Py3UnicodePy2StringtoPtr(value);`
`118`	`100`	`Runtime.Py_SetPath(_pythonPath);`
`119`	`101`	`}`
`120`	`102`	`}`