mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-09-09 00:13:20 +02:00
![Bertrand Lorentz](/assets/img/avatar_default.png)
When a C function returns an array, we need to be able to determine its length. This is done either through a parameter to that function, or because the array is null-terminated. If we don't know about either of those, we print out a warning and fail the validation for the return value. This means the corresponding method will not be generated. This fixes a crash when trying to generate a method for which this information is missing. This wasn't a problem until now because the parser doesn't handle array return values, so they were always handled through fix-ups. But now we can get a GAPI XML converted from GIR which contains the "array" attribute for a return value but no other information.
195 lines
5.9 KiB
C#
195 lines
5.9 KiB
C#
// GtkSharp.Generation.ReturnValue.cs - The ReturnValue Generatable.
|
|
//
|
|
// Author: Mike Kestner <mkestner@novell.com>
|
|
//
|
|
// Copyright (c) 2004-2005 Novell, Inc.
|
|
//
|
|
// This program is free software; you can redistribute it and/or
|
|
// modify it under the terms of version 2 of the GNU General Public
|
|
// License as published by the Free Software Foundation.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
// General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public
|
|
// License along with this program; if not, write to the
|
|
// Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
// Boston, MA 02111-1307, USA.
|
|
|
|
|
|
namespace GtkSharp.Generation {
|
|
|
|
using System;
|
|
using System.Xml;
|
|
|
|
public class ReturnValue {
|
|
|
|
|
|
bool is_null_term;
|
|
bool is_array;
|
|
bool elements_owned;
|
|
bool owned;
|
|
string array_length_param = String.Empty;
|
|
string ctype = String.Empty;
|
|
string default_value = String.Empty;
|
|
string element_ctype = String.Empty;
|
|
Parameter count_param;
|
|
|
|
public ReturnValue (XmlElement elem)
|
|
{
|
|
if (elem != null) {
|
|
is_null_term = elem.GetAttributeAsBoolean ("null_term_array");
|
|
is_array = elem.GetAttributeAsBoolean ("array") || elem.HasAttribute ("array_length_param");
|
|
array_length_param = elem.GetAttribute ("array_length_param");
|
|
elements_owned = elem.GetAttributeAsBoolean ("elements_owned");
|
|
owned = elem.GetAttributeAsBoolean ("owned");
|
|
ctype = elem.GetAttribute("type");
|
|
default_value = elem.GetAttribute ("default_value");
|
|
element_ctype = elem.GetAttribute ("element_type");
|
|
}
|
|
}
|
|
|
|
public Parameter CountParameter {
|
|
get { return count_param; }
|
|
set { count_param = value; }
|
|
}
|
|
|
|
public string CountParameterName {
|
|
get { return array_length_param; }
|
|
}
|
|
|
|
public string CType {
|
|
get {
|
|
return ctype;
|
|
}
|
|
}
|
|
|
|
public string CSType {
|
|
get {
|
|
if (IGen == null)
|
|
return String.Empty;
|
|
|
|
if (ElementType != String.Empty)
|
|
return ElementType + "[]";
|
|
|
|
return IGen.QualifiedName + (is_array || is_null_term ? "[]" : String.Empty);
|
|
}
|
|
}
|
|
|
|
public string DefaultValue {
|
|
get {
|
|
if (default_value != null && default_value.Length > 0)
|
|
return default_value;
|
|
if (IGen == null)
|
|
return String.Empty;
|
|
return IGen.DefaultValue;
|
|
}
|
|
}
|
|
|
|
string ElementType {
|
|
get {
|
|
if (element_ctype.Length > 0)
|
|
return SymbolTable.Table.GetCSType (element_ctype);
|
|
|
|
return String.Empty;
|
|
}
|
|
}
|
|
|
|
IGeneratable igen;
|
|
public IGeneratable IGen {
|
|
get {
|
|
if (igen == null)
|
|
igen = SymbolTable.Table [CType];
|
|
return igen;
|
|
}
|
|
}
|
|
|
|
public bool IsVoid {
|
|
get {
|
|
return CSType == "void";
|
|
}
|
|
}
|
|
|
|
public string MarshalType {
|
|
get {
|
|
if (IGen == null)
|
|
return String.Empty;
|
|
else if (is_array || is_null_term)
|
|
return "IntPtr";
|
|
return IGen.MarshalType;
|
|
}
|
|
}
|
|
|
|
public string ToNativeType {
|
|
get {
|
|
if (IGen == null)
|
|
return String.Empty;
|
|
return IGen.MarshalType + (is_array || is_null_term ? "[]" : String.Empty);
|
|
}
|
|
}
|
|
|
|
public string FromNative (string var)
|
|
{
|
|
if (IGen == null)
|
|
return String.Empty;
|
|
|
|
if (ElementType != String.Empty) {
|
|
string args = (owned ? "true" : "false") + ", " + (elements_owned ? "true" : "false");
|
|
if (IGen.QualifiedName == "GLib.PtrArray")
|
|
return String.Format ("({0}[]) GLib.Marshaller.PtrArrayToArray ({1}, {2}, typeof({0}))", ElementType, var, args);
|
|
else
|
|
return String.Format ("({0}[]) GLib.Marshaller.ListPtrToArray ({1}, typeof({2}), {3}, typeof({4}))", ElementType, var, IGen.QualifiedName, args, element_ctype == "gfilename*" ? "GLib.ListBase.FilenameString" : ElementType);
|
|
} else if (IGen is IOwnable)
|
|
return ((IOwnable)IGen).FromNative (var, owned);
|
|
else if (is_null_term)
|
|
return String.Format ("GLib.Marshaller.NullTermPtrToStringArray ({0}, {1})", var, owned ? "true" : "false");
|
|
else if (is_array)
|
|
return String.Format ("({0}) GLib.Marshaller.ArrayPtrToArray ({1}, typeof ({2}), (int){3}native_{4}, true)", CSType, var, IGen.QualifiedName, CountParameter.CSType == "int" ? String.Empty : "(" + CountParameter.CSType + ")", CountParameter.Name);
|
|
else
|
|
return IGen.FromNative (var);
|
|
}
|
|
|
|
public string ToNative (string var)
|
|
{
|
|
if (IGen == null)
|
|
return String.Empty;
|
|
|
|
if (ElementType.Length > 0) {
|
|
string args = ", typeof (" + ElementType + "), " + (owned ? "true" : "false") + ", " + (elements_owned ? "true" : "false");
|
|
var = "new " + IGen.QualifiedName + "(" + var + args + ")";
|
|
} else if (is_null_term)
|
|
return String.Format ("GLib.Marshaller.StringArrayToNullTermPointer ({0})", var);
|
|
else if (is_array)
|
|
return String.Format ("GLib.Marshaller.ArrayToArrayPtr ({0})", var);
|
|
|
|
if (IGen is IManualMarshaler)
|
|
return (IGen as IManualMarshaler).AllocNative (var);
|
|
else if (IGen is ObjectGen && owned)
|
|
return var + " == null ? IntPtr.Zero : " + var + ".OwnedHandle";
|
|
else if (IGen is OpaqueGen && owned)
|
|
return var + " == null ? IntPtr.Zero : " + var + ".OwnedCopy";
|
|
else
|
|
return IGen.CallByName (var);
|
|
}
|
|
|
|
public bool Validate (LogWriter log)
|
|
{
|
|
if (MarshalType == "" || CSType == "") {
|
|
log.Warn ("Unknown return type: {0}", CType);
|
|
return false;
|
|
} else if ((CSType == "GLib.List" || CSType == "GLib.SList") && String.IsNullOrEmpty (ElementType))
|
|
log.Warn ("Returns {0} with unknown element type. Add element_type attribute with gapi-fixup.", CType);
|
|
|
|
if (is_array && !is_null_term && String.IsNullOrEmpty (array_length_param)) {
|
|
log.Warn ("Returns an array with undeterminable length. Add null_term_array or array_length_param attribute with gapi-fixup.");
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|