GtkSharp/generator/Parameters.cs

760 lines
18 KiB
C#
Raw Normal View History

// GtkSharp.Generation.Parameters.cs - The Parameters Generation Class.
//
// Author: Mike Kestner <mkestner@speakeasy.net>
//
// Copyright (c) 2001-2003 Mike Kestner
// Copyright (c) 2004 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.Collections;
using System.IO;
using System.Xml;
public class Parameter {
private XmlElement elem;
public Parameter (XmlElement e)
{
elem = e;
}
string call_name;
public string CallName {
get {
if (call_name == null)
return Name;
else
return call_name;
}
set {
call_name = value;
}
}
public string CType {
get {
string type = elem.GetAttribute("type");
if (type == "void*")
type = "gpointer";
return type;
}
}
public string CSType {
get {
string cstype = SymbolTable.Table.GetCSType( elem.GetAttribute("type"));
if (cstype == "void")
cstype = "System.IntPtr";
if (IsArray) {
if (IsParams)
cstype = "params " + cstype;
cstype += "[]";
cstype = cstype.Replace ("ref ", "");
}
return cstype;
}
}
public IGeneratable Generatable {
get {
return SymbolTable.Table[CType];
}
}
public bool IsArray {
get {
return elem.HasAttribute("array") || elem.HasAttribute("null_term_array");
}
}
public bool IsEllipsis {
get {
return elem.HasAttribute("ellipsis");
}
}
bool is_count;
bool is_count_set;
public bool IsCount {
get {
if (is_count_set)
return is_count;
if (Name.StartsWith("n_"))
switch (CSType) {
case "int":
case "uint":
case "long":
case "ulong":
case "short":
case "ushort":
return true;
default:
return false;
}
else
return false;
}
set {
is_count_set = true;
is_count = value;
}
}
* generator/Parameters.cs (Parameters.Validate): If the parameters end with "callback, gpointer, GDestroyNotify", then mark the callback as having "notified" Scope. (Parameters.IsHidden): Hide user_data and GDestroyNotify after a callback. (Parameter.Scope): make this settable (Parameter.IsDestroyNotify): new test * generator/MethodBody.cs (Initialize): Handle "notified" callback scope (using a GCHandle and GLib.DestroyHelper.NotifyHandler) * generator/CallbackGen.cs (GenWrapper): Add a static "GetManagedDelegate" method to the wrapper type, to translate a native delegate back to its corresponding managed delegate. (FromNative): use GetManagedDelegate. * generator/ReturnValue.cs (Validate): We handle callback return values now * generator/SymbolTable.cs: marshal GDestroyNotify as GLib.DestroyNotify * glib/DestroyNotify.cs: Moved from gtk * gtk/Gtk.metadata: globally change GtkDestroyNotify to GDestroyNotify, but then change back the ones that are exposed in the API. Un-hide lots of methods we can correctly autogenerate now. * gtk/DestroyHelper.cs: moved to glib * gtk/*.custom: remove methods that are autogenerated now, add Obsolete wrappers where needed, replace Gtk.DestroyHelper usage with GLib.DestroyHelper. * gdk/Gdk.metadata: * gnome/Gnome.metadata: Turn Gdk.Drawable.SetData and Gnome.IconList.SetIconDataFull's GDestroyNotify args into gpointers so the generated API stays the same as it used to be. * rsvg/Handle.custom: implement deprecated SetSizeCallback * sample/GtkDemo/DemoIconView.cs (CreateSort): update for API changes svn path=/trunk/gtk-sharp/; revision=44020
2005-05-04 11:47:25 +00:00
public bool IsDestroyNotify {
get {
return CType == "GDestroyNotify";
}
}
public bool IsLength {
get {
if (Name.EndsWith("len") || Name.EndsWith("length"))
switch (CSType) {
case "int":
case "uint":
case "long":
case "ulong":
case "short":
case "ushort":
return true;
default:
return false;
}
else
return false;
}
}
public bool IsParams {
get {
return elem.HasAttribute("params");
}
}
public bool IsString {
get {
return (CSType == "string");
}
}
public bool IsUserData {
get {
return CSType == "IntPtr" && (Name.EndsWith ("data") || Name.EndsWith ("data_or_owner"));
}
}
public virtual string MarshalType {
get {
string type = SymbolTable.Table.GetMarshalType( elem.GetAttribute("type"));
if (type == "void" || Generatable is IManualMarshaler)
type = "IntPtr";
if (IsArray) {
type += "[]";
type = type.Replace ("ref ", "");
}
return type;
}
}
public string Name {
get {
return SymbolTable.Table.MangleName (elem.GetAttribute("name"));
}
}
Automatic memory management for opaque types [#49565] * glib/Opaque.cs (Owned): new property saying whether or not gtk# owns the memory. (Opaque): Set Owned to true in the void ctor and false in the IntPtr one. (GetOpaque): add a new overload that can also create opaques, a la GLib.Object.GetObject. (Ref, Unref, Free): empty virtual methods to be overridden by subclasses. (set_Raw): Unref() and possibly Free() the old value, Ref() the new one. (~Opaque, Dispose): set Raw to IntPtr.Zero (triggering Free/Unref if needed) * parser/gapi2xml.pl (addReturnElem): if the method is named Copy and returns a pointer, set the "owned" attribute on the return-type. * */*-api.raw: Regen * generator/HandleBase.cs (FromNative): Add new FromNative/FromNativeReturn overloads that takes a "bool owned" param. Implement the 1-arg FromNative and FromNativeReturn in terms of that. * generator/ObjectBase.cs (FromNative): Implement HandleBase's new overload. Use the two-arg version of GLib.Object.GetObject when "owned" is true. * generator/OpaqueGen.cs (Generate): Pull out Ref, Unref, and Free/Destroy/Dispose methods and handle them specially by overriding Opaque.Ref, .Unref, and .Free appropriately. (If any of the methods are marked deprecated, output a deprecated do-nothing method as well, to save us from having to write all those deprecated methods by hand.) (FromNative): use GetOpaque, passing "owned". * generator/ReturnValue.cs (FromNative): if the value is a HandleBase, pass Owned to its FromNative(). * generator/Parameters.cs (Owned): new property (for use on out params) (FromNative): Call FromNative() on the generatable, handling Owned in the case of HandleBase. * generator/ManagedCallString.cs: * generator/MethodBody.cs: * generator/Signal.cs: use param.FromNative() rather than param.Generatable.FromNative(), to get ownership right. * */*.metadata: Mark opaque ref/unref/free methods deprecated (except where we were hiding them before). Add "owned" attributes to return values and out params as needed. * pango/AttrIterator.custom (GetFont): work around a memory-management oddity of the underlying method. * pango/AttrFontDesc.cs (AttrFontDesc): copy the passed-in FontDescriptor, since the attribute will assume ownership of it. * gtk/TreeView.custom (GetPathAtPos): set the "owned" flag on the returned TreePaths. * gtk/TargetList.custom: Remove refcounting stuff, which is now handled automatically * gtk/NodeStore.cs (GetPath): clear the Owned flag on the created TreePath so that the underlying structure doesn't get freed when the function returns * gtkhtml/HTMLStream.custom (Destroy): hide this and then reimplement it by hand to keep OpaqueGen from using it in Dispose(), since calling it after an HTMLStream.Close() will result in a crash. svn path=/trunk/gtk-sharp/; revision=47928
2005-08-02 18:45:21 +00:00
public bool Owned {
get {
return elem.GetAttribute ("owned") == "true";
}
}
public virtual string NativeSignature {
get {
string sig = MarshalType + " " + Name;
if (PassAs != String.Empty)
sig = PassAs + " " + sig;
return sig;
}
}
public string PropertyName {
get {
return elem.GetAttribute("property_name");
}
}
string pass_as;
public string PassAs {
get {
if (pass_as != null)
return pass_as;
if (elem.HasAttribute ("pass_as"))
return elem.GetAttribute ("pass_as");
if (IsArray || CSType.EndsWith ("IntPtr"))
return "";
if (CType.EndsWith ("*") && (Generatable is SimpleGen || Generatable is EnumGen))
return "out";
return "";
}
set {
pass_as = value;
}
}
* generator/Parameters.cs (Parameters.Validate): If the parameters end with "callback, gpointer, GDestroyNotify", then mark the callback as having "notified" Scope. (Parameters.IsHidden): Hide user_data and GDestroyNotify after a callback. (Parameter.Scope): make this settable (Parameter.IsDestroyNotify): new test * generator/MethodBody.cs (Initialize): Handle "notified" callback scope (using a GCHandle and GLib.DestroyHelper.NotifyHandler) * generator/CallbackGen.cs (GenWrapper): Add a static "GetManagedDelegate" method to the wrapper type, to translate a native delegate back to its corresponding managed delegate. (FromNative): use GetManagedDelegate. * generator/ReturnValue.cs (Validate): We handle callback return values now * generator/SymbolTable.cs: marshal GDestroyNotify as GLib.DestroyNotify * glib/DestroyNotify.cs: Moved from gtk * gtk/Gtk.metadata: globally change GtkDestroyNotify to GDestroyNotify, but then change back the ones that are exposed in the API. Un-hide lots of methods we can correctly autogenerate now. * gtk/DestroyHelper.cs: moved to glib * gtk/*.custom: remove methods that are autogenerated now, add Obsolete wrappers where needed, replace Gtk.DestroyHelper usage with GLib.DestroyHelper. * gdk/Gdk.metadata: * gnome/Gnome.metadata: Turn Gdk.Drawable.SetData and Gnome.IconList.SetIconDataFull's GDestroyNotify args into gpointers so the generated API stays the same as it used to be. * rsvg/Handle.custom: implement deprecated SetSizeCallback * sample/GtkDemo/DemoIconView.cs (CreateSort): update for API changes svn path=/trunk/gtk-sharp/; revision=44020
2005-05-04 11:47:25 +00:00
string scope;
public string Scope {
get {
* generator/Parameters.cs (Parameters.Validate): If the parameters end with "callback, gpointer, GDestroyNotify", then mark the callback as having "notified" Scope. (Parameters.IsHidden): Hide user_data and GDestroyNotify after a callback. (Parameter.Scope): make this settable (Parameter.IsDestroyNotify): new test * generator/MethodBody.cs (Initialize): Handle "notified" callback scope (using a GCHandle and GLib.DestroyHelper.NotifyHandler) * generator/CallbackGen.cs (GenWrapper): Add a static "GetManagedDelegate" method to the wrapper type, to translate a native delegate back to its corresponding managed delegate. (FromNative): use GetManagedDelegate. * generator/ReturnValue.cs (Validate): We handle callback return values now * generator/SymbolTable.cs: marshal GDestroyNotify as GLib.DestroyNotify * glib/DestroyNotify.cs: Moved from gtk * gtk/Gtk.metadata: globally change GtkDestroyNotify to GDestroyNotify, but then change back the ones that are exposed in the API. Un-hide lots of methods we can correctly autogenerate now. * gtk/DestroyHelper.cs: moved to glib * gtk/*.custom: remove methods that are autogenerated now, add Obsolete wrappers where needed, replace Gtk.DestroyHelper usage with GLib.DestroyHelper. * gdk/Gdk.metadata: * gnome/Gnome.metadata: Turn Gdk.Drawable.SetData and Gnome.IconList.SetIconDataFull's GDestroyNotify args into gpointers so the generated API stays the same as it used to be. * rsvg/Handle.custom: implement deprecated SetSizeCallback * sample/GtkDemo/DemoIconView.cs (CreateSort): update for API changes svn path=/trunk/gtk-sharp/; revision=44020
2005-05-04 11:47:25 +00:00
if (scope == null)
scope = elem.GetAttribute ("scope");
return scope;
}
set {
scope = value;
}
}
public virtual string[] Prepare {
get {
IGeneratable gen = Generatable;
if (gen is IManualMarshaler) {
string result = "IntPtr native_" + CallName;
if (PassAs != "out")
result += " = " + (gen as IManualMarshaler).AllocNative (CallName);
return new string [] { result + ";" };
} else if (PassAs == "out" && CSType != MarshalType) {
return new string [] { gen.MarshalType + " native_" + CallName + ";" };
} else if (PassAs == "ref" && CSType != MarshalType) {
return new string [] { gen.MarshalType + " native_" + CallName + " = (" + gen.MarshalType + ") " + CallName + ";" };
}
return new string [0];
}
}
public virtual string CallString {
get {
string call_parm;
IGeneratable gen = Generatable;
if (gen is CallbackGen)
return SymbolTable.Table.CallByName (CType, CallName + "_wrapper");
else if (PassAs != String.Empty) {
call_parm = PassAs + " ";
if (CSType != MarshalType)
call_parm += "native_";
call_parm += CallName;
} else if (gen is IManualMarshaler)
call_parm = "native_" + CallName;
else if (gen is ObjectBase)
call_parm = (gen as ObjectBase).CallByName (CallName, Owned);
else
call_parm = gen.CallByName (CallName);
return call_parm;
}
Automatic memory management for opaque types [#49565] * glib/Opaque.cs (Owned): new property saying whether or not gtk# owns the memory. (Opaque): Set Owned to true in the void ctor and false in the IntPtr one. (GetOpaque): add a new overload that can also create opaques, a la GLib.Object.GetObject. (Ref, Unref, Free): empty virtual methods to be overridden by subclasses. (set_Raw): Unref() and possibly Free() the old value, Ref() the new one. (~Opaque, Dispose): set Raw to IntPtr.Zero (triggering Free/Unref if needed) * parser/gapi2xml.pl (addReturnElem): if the method is named Copy and returns a pointer, set the "owned" attribute on the return-type. * */*-api.raw: Regen * generator/HandleBase.cs (FromNative): Add new FromNative/FromNativeReturn overloads that takes a "bool owned" param. Implement the 1-arg FromNative and FromNativeReturn in terms of that. * generator/ObjectBase.cs (FromNative): Implement HandleBase's new overload. Use the two-arg version of GLib.Object.GetObject when "owned" is true. * generator/OpaqueGen.cs (Generate): Pull out Ref, Unref, and Free/Destroy/Dispose methods and handle them specially by overriding Opaque.Ref, .Unref, and .Free appropriately. (If any of the methods are marked deprecated, output a deprecated do-nothing method as well, to save us from having to write all those deprecated methods by hand.) (FromNative): use GetOpaque, passing "owned". * generator/ReturnValue.cs (FromNative): if the value is a HandleBase, pass Owned to its FromNative(). * generator/Parameters.cs (Owned): new property (for use on out params) (FromNative): Call FromNative() on the generatable, handling Owned in the case of HandleBase. * generator/ManagedCallString.cs: * generator/MethodBody.cs: * generator/Signal.cs: use param.FromNative() rather than param.Generatable.FromNative(), to get ownership right. * */*.metadata: Mark opaque ref/unref/free methods deprecated (except where we were hiding them before). Add "owned" attributes to return values and out params as needed. * pango/AttrIterator.custom (GetFont): work around a memory-management oddity of the underlying method. * pango/AttrFontDesc.cs (AttrFontDesc): copy the passed-in FontDescriptor, since the attribute will assume ownership of it. * gtk/TreeView.custom (GetPathAtPos): set the "owned" flag on the returned TreePaths. * gtk/TargetList.custom: Remove refcounting stuff, which is now handled automatically * gtk/NodeStore.cs (GetPath): clear the Owned flag on the created TreePath so that the underlying structure doesn't get freed when the function returns * gtkhtml/HTMLStream.custom (Destroy): hide this and then reimplement it by hand to keep OpaqueGen from using it in Dispose(), since calling it after an HTMLStream.Close() will result in a crash. svn path=/trunk/gtk-sharp/; revision=47928
2005-08-02 18:45:21 +00:00
}
public virtual string[] Finish {
get {
IGeneratable gen = Generatable;
if (gen is IManualMarshaler) {
string[] result = new string [PassAs == "ref" ? 2 : 1];
int i = 0;
if (PassAs != String.Empty)
result [i++] = CallName + " = " + Generatable.FromNative ("native_" + CallName) + ";";
if (PassAs != "out")
result [i] = (gen as IManualMarshaler).ReleaseNative ("native_" + CallName) + ";";
return result;
} else if (PassAs != String.Empty && MarshalType != CSType)
if (gen is IOwnable)
return new string [] { CallName + " = " + (gen as IOwnable).FromNative ("native_" + CallName, Owned) + ";" };
else
return new string [] { CallName + " = " + gen.FromNative ("native_" + CallName) + ";" };
return new string [0];
}
}
Automatic memory management for opaque types [#49565] * glib/Opaque.cs (Owned): new property saying whether or not gtk# owns the memory. (Opaque): Set Owned to true in the void ctor and false in the IntPtr one. (GetOpaque): add a new overload that can also create opaques, a la GLib.Object.GetObject. (Ref, Unref, Free): empty virtual methods to be overridden by subclasses. (set_Raw): Unref() and possibly Free() the old value, Ref() the new one. (~Opaque, Dispose): set Raw to IntPtr.Zero (triggering Free/Unref if needed) * parser/gapi2xml.pl (addReturnElem): if the method is named Copy and returns a pointer, set the "owned" attribute on the return-type. * */*-api.raw: Regen * generator/HandleBase.cs (FromNative): Add new FromNative/FromNativeReturn overloads that takes a "bool owned" param. Implement the 1-arg FromNative and FromNativeReturn in terms of that. * generator/ObjectBase.cs (FromNative): Implement HandleBase's new overload. Use the two-arg version of GLib.Object.GetObject when "owned" is true. * generator/OpaqueGen.cs (Generate): Pull out Ref, Unref, and Free/Destroy/Dispose methods and handle them specially by overriding Opaque.Ref, .Unref, and .Free appropriately. (If any of the methods are marked deprecated, output a deprecated do-nothing method as well, to save us from having to write all those deprecated methods by hand.) (FromNative): use GetOpaque, passing "owned". * generator/ReturnValue.cs (FromNative): if the value is a HandleBase, pass Owned to its FromNative(). * generator/Parameters.cs (Owned): new property (for use on out params) (FromNative): Call FromNative() on the generatable, handling Owned in the case of HandleBase. * generator/ManagedCallString.cs: * generator/MethodBody.cs: * generator/Signal.cs: use param.FromNative() rather than param.Generatable.FromNative(), to get ownership right. * */*.metadata: Mark opaque ref/unref/free methods deprecated (except where we were hiding them before). Add "owned" attributes to return values and out params as needed. * pango/AttrIterator.custom (GetFont): work around a memory-management oddity of the underlying method. * pango/AttrFontDesc.cs (AttrFontDesc): copy the passed-in FontDescriptor, since the attribute will assume ownership of it. * gtk/TreeView.custom (GetPathAtPos): set the "owned" flag on the returned TreePaths. * gtk/TargetList.custom: Remove refcounting stuff, which is now handled automatically * gtk/NodeStore.cs (GetPath): clear the Owned flag on the created TreePath so that the underlying structure doesn't get freed when the function returns * gtkhtml/HTMLStream.custom (Destroy): hide this and then reimplement it by hand to keep OpaqueGen from using it in Dispose(), since calling it after an HTMLStream.Close() will result in a crash. svn path=/trunk/gtk-sharp/; revision=47928
2005-08-02 18:45:21 +00:00
public string FromNative (string var)
{
if (Generatable == null)
return String.Empty;
else if (Generatable is IOwnable)
return ((IOwnable)Generatable).FromNative (var, Owned);
Automatic memory management for opaque types [#49565] * glib/Opaque.cs (Owned): new property saying whether or not gtk# owns the memory. (Opaque): Set Owned to true in the void ctor and false in the IntPtr one. (GetOpaque): add a new overload that can also create opaques, a la GLib.Object.GetObject. (Ref, Unref, Free): empty virtual methods to be overridden by subclasses. (set_Raw): Unref() and possibly Free() the old value, Ref() the new one. (~Opaque, Dispose): set Raw to IntPtr.Zero (triggering Free/Unref if needed) * parser/gapi2xml.pl (addReturnElem): if the method is named Copy and returns a pointer, set the "owned" attribute on the return-type. * */*-api.raw: Regen * generator/HandleBase.cs (FromNative): Add new FromNative/FromNativeReturn overloads that takes a "bool owned" param. Implement the 1-arg FromNative and FromNativeReturn in terms of that. * generator/ObjectBase.cs (FromNative): Implement HandleBase's new overload. Use the two-arg version of GLib.Object.GetObject when "owned" is true. * generator/OpaqueGen.cs (Generate): Pull out Ref, Unref, and Free/Destroy/Dispose methods and handle them specially by overriding Opaque.Ref, .Unref, and .Free appropriately. (If any of the methods are marked deprecated, output a deprecated do-nothing method as well, to save us from having to write all those deprecated methods by hand.) (FromNative): use GetOpaque, passing "owned". * generator/ReturnValue.cs (FromNative): if the value is a HandleBase, pass Owned to its FromNative(). * generator/Parameters.cs (Owned): new property (for use on out params) (FromNative): Call FromNative() on the generatable, handling Owned in the case of HandleBase. * generator/ManagedCallString.cs: * generator/MethodBody.cs: * generator/Signal.cs: use param.FromNative() rather than param.Generatable.FromNative(), to get ownership right. * */*.metadata: Mark opaque ref/unref/free methods deprecated (except where we were hiding them before). Add "owned" attributes to return values and out params as needed. * pango/AttrIterator.custom (GetFont): work around a memory-management oddity of the underlying method. * pango/AttrFontDesc.cs (AttrFontDesc): copy the passed-in FontDescriptor, since the attribute will assume ownership of it. * gtk/TreeView.custom (GetPathAtPos): set the "owned" flag on the returned TreePaths. * gtk/TargetList.custom: Remove refcounting stuff, which is now handled automatically * gtk/NodeStore.cs (GetPath): clear the Owned flag on the created TreePath so that the underlying structure doesn't get freed when the function returns * gtkhtml/HTMLStream.custom (Destroy): hide this and then reimplement it by hand to keep OpaqueGen from using it in Dispose(), since calling it after an HTMLStream.Close() will result in a crash. svn path=/trunk/gtk-sharp/; revision=47928
2005-08-02 18:45:21 +00:00
else
return Generatable.FromNative (var);
}
public string StudlyName {
get {
string name = elem.GetAttribute("name");
string[] segs = name.Split('_');
string studly = "";
foreach (string s in segs) {
if (s.Trim () == "")
continue;
studly += (s.Substring(0,1).ToUpper() + s.Substring(1));
}
return studly;
}
}
}
public class ArrayParameter : Parameter {
bool null_terminated;
public ArrayParameter (XmlElement elem) : base (elem)
{
null_terminated = elem.HasAttribute ("null_term_array");
}
public override string MarshalType {
get {
if (Generatable is StructBase)
return CSType;
else
return base.MarshalType;
}
}
bool NullTerminated {
get {
return null_terminated;
}
}
public override string[] Prepare {
get {
if (CSType == MarshalType)
return new string [0];
ArrayList result = new ArrayList ();
result.Add (String.Format ("int cnt_{0} = {0} == null ? 0 : {0}.Length;", CallName));
result.Add (String.Format ("{0}[] native_{1} = new {0} [cnt_{1}" + (NullTerminated ? " + 1" : "") + "];", MarshalType.TrimEnd('[', ']'), CallName));
result.Add (String.Format ("for (int i = 0; i < cnt_{0}; i++)", CallName));
IGeneratable gen = Generatable;
if (gen is IManualMarshaler)
result.Add (String.Format ("\tnative_{0} [i] = {1};", CallName, (gen as IManualMarshaler).AllocNative (CallName + "[i]")));
else
result.Add (String.Format ("\tnative_{0} [i] = {1};", CallName, gen.CallByName (CallName + "[i]")));
if (NullTerminated)
result.Add (String.Format ("native_{0} [cnt_{0}] = IntPtr.Zero;", CallName));
return (string[]) result.ToArray (typeof (string));
}
}
public override string CallString {
get {
if (CSType != MarshalType)
return "native_" + CallName;
else
return CallName;
}
}
public override string[] Finish {
get {
if (CSType == MarshalType)
return new string [0];
IGeneratable gen = Generatable;
if (gen is IManualMarshaler) {
string [] result = new string [4];
result [0] = "for (int i = 0; i < native_" + CallName + ".Length" + (NullTerminated ? " - 1" : "") + "; i++) {";
result [1] = "\t" + CallName + " [i] = " + Generatable.FromNative ("native_" + CallName + "[i]") + ";";
result [2] = "\t" + (gen as IManualMarshaler).ReleaseNative ("native_" + CallName + "[i]") + ";";
result [3] = "}";
return result;
}
return new string [0];
}
}
}
public class ArrayCountPair : ArrayParameter {
XmlElement count_elem;
bool invert;
public ArrayCountPair (XmlElement array_elem, XmlElement count_elem, bool invert) : base (array_elem)
{
this.count_elem = count_elem;
this.invert = invert;
}
string CountNativeType {
get {
return SymbolTable.Table.GetMarshalType(count_elem.GetAttribute("type"));
}
}
string CountType {
get {
return SymbolTable.Table.GetCSType(count_elem.GetAttribute("type"));
}
}
string CountCast {
get {
if (CountType == "int")
return String.Empty;
else
return "(" + CountType + ") ";
}
}
string CountName {
get {
return SymbolTable.Table.MangleName (count_elem.GetAttribute("name"));
}
}
string CallCount (string name)
{
string result = CountCast + "(" + name + " == null ? 0 : " + name + ".Length)";
IGeneratable gen = SymbolTable.Table[count_elem.GetAttribute("type")];
return gen.CallByName (result);
}
public override string CallString {
get {
if (invert)
return CallCount (CallName) + ", " + base.CallString;
else
return base.CallString + ", " + CallCount (CallName);
}
}
public override string NativeSignature {
get {
if (invert)
return CountNativeType + " " + CountName + ", " + MarshalType + " " + Name;
else
return MarshalType + " " + Name + ", " + CountNativeType + " " + CountName;
}
}
}
public class ErrorParameter : Parameter {
public ErrorParameter (XmlElement elem) : base (elem)
{
PassAs = "out";
}
public override string CallString {
get {
return "out error";
}
}
}
public class StructParameter : Parameter {
public StructParameter (XmlElement elem) : base (elem) {}
public override string MarshalType {
get {
return "IntPtr";
}
}
public override string[] Prepare {
get {
if (PassAs == "out")
return new string [] { "IntPtr native_" + CallName + " = Marshal.AllocHGlobal (Marshal.SizeOf (typeof (" + Generatable.QualifiedName + ")));"};
else
return new string [] { "IntPtr native_" + CallName + " = " + (Generatable as IManualMarshaler).AllocNative (CallName) + ";"};
}
}
public override string CallString {
get {
return "native_" + CallName;
}
}
public override string[] Finish {
get {
string[] result = new string [2];
result [0] = CallName + " = " + FromNative ("native_" + CallName) + ";";
result [1] = (Generatable as IManualMarshaler).ReleaseNative ("native_" + CallName) + ";";
return result;
}
}
public override string NativeSignature {
get {
return "IntPtr " + CallName;
}
}
}
public class Parameters : IEnumerable {
ArrayList param_list = new ArrayList ();
XmlElement elem;
bool first_is_instance;
public Parameters (XmlElement elem) : this (elem, false) { }
public Parameters (XmlElement elem, bool first_is_instance)
{
if (elem == null)
valid = true;
this.elem = elem;
this.first_is_instance = first_is_instance;
if (first_is_instance)
is_static = false;
}
public int Count {
get { return param_list.Count; }
}
2005-05-02 20:10:03 +00:00
public int VisibleCount {
get {
int visible = 0;
foreach (Parameter p in this) {
if (!IsHidden (p))
visible++;
}
return visible;
}
}
public Parameter this [int idx] {
get {
return param_list [idx] as Parameter;
}
}
2005-05-02 20:10:03 +00:00
public bool IsHidden (Parameter p)
{
int idx = param_list.IndexOf (p);
if (idx > 0 && p.IsLength && p.PassAs == String.Empty && this [idx - 1].IsString)
2005-05-02 20:10:03 +00:00
return true;
if (p.IsCount)
2005-05-02 20:10:03 +00:00
return true;
if (p.CType == "GError**")
return true;
if (HasCB || HideData) {
if (p.IsUserData && (idx == Count - 1))
* parser/gapi2xml.pl (addParamsElem): change the handling of anonymous function pointer types in method signatures. Before, we added a <callback> child to the <parameters> node, but the generator just ignored it. Now we add the callback (with a made-up name) to the toplevel node, and add an ordinary <param> node referencing it to the <parameters> node. Also, if the last param of the callback is a gpointer, rename it from "arg#" to "data" so it will be treated correctly (as the user data passed from the calling method). [Fixes #66241] * art/art-api.raw: * gdk/gdk-api-2.4.raw: * gdk/gdk-api-2.6.raw: Regen * generator/Parameters.cs (IsHidden): loosen the definition of hideable user_data; it doesn't have to occur at the end of the parameter list, as long as there's a callback arg before it. * generator/MethodBody.cs (GetCallString): Use Parameters.IsHidden to decide whether or not to squash user_data params, rather than trying to duplicate its logic. As a side effect, this also causes a handful of methods that take non-hidden IntPtr arguments to start actually passing those arguments to C rather than always passing IntPtr.Zero. * generator/Method.cs (Equals, GetHashCode): Remove unnecessary and possibly erroneous hashing overrides. * gtk/Gtk.metadata: Hide Gtk.Container.ForeachFull, since it's useless and wasn't in gtk# 1.0 * gtk/Menu.custom (Popup): * gtk/TextIter.custom (ForwardFindChar, BackwardFindChar): * gnome/App.custom (CreateMenusInterp, InsertMenusInterp, CreateToolbarInterp): * gnome/Client.custom (RequestInteractionInterp): * gnome/Popup.custom (MenuDoPopupModal, MenuDoPopup): Add [Obsolete] compat overloads for methods that have now lost a useless IntPtr. svn path=/trunk/gtk-sharp/; revision=47566
2005-07-22 19:10:04 +00:00
return true;
if (p.IsUserData && (idx == Count - 2) && this [Count - 1] is ErrorParameter)
return true;
* parser/gapi2xml.pl (addParamsElem): change the handling of anonymous function pointer types in method signatures. Before, we added a <callback> child to the <parameters> node, but the generator just ignored it. Now we add the callback (with a made-up name) to the toplevel node, and add an ordinary <param> node referencing it to the <parameters> node. Also, if the last param of the callback is a gpointer, rename it from "arg#" to "data" so it will be treated correctly (as the user data passed from the calling method). [Fixes #66241] * art/art-api.raw: * gdk/gdk-api-2.4.raw: * gdk/gdk-api-2.6.raw: Regen * generator/Parameters.cs (IsHidden): loosen the definition of hideable user_data; it doesn't have to occur at the end of the parameter list, as long as there's a callback arg before it. * generator/MethodBody.cs (GetCallString): Use Parameters.IsHidden to decide whether or not to squash user_data params, rather than trying to duplicate its logic. As a side effect, this also causes a handful of methods that take non-hidden IntPtr arguments to start actually passing those arguments to C rather than always passing IntPtr.Zero. * generator/Method.cs (Equals, GetHashCode): Remove unnecessary and possibly erroneous hashing overrides. * gtk/Gtk.metadata: Hide Gtk.Container.ForeachFull, since it's useless and wasn't in gtk# 1.0 * gtk/Menu.custom (Popup): * gtk/TextIter.custom (ForwardFindChar, BackwardFindChar): * gnome/App.custom (CreateMenusInterp, InsertMenusInterp, CreateToolbarInterp): * gnome/Client.custom (RequestInteractionInterp): * gnome/Popup.custom (MenuDoPopupModal, MenuDoPopup): Add [Obsolete] compat overloads for methods that have now lost a useless IntPtr. svn path=/trunk/gtk-sharp/; revision=47566
2005-07-22 19:10:04 +00:00
if (p.IsUserData && idx > 0 &&
this [idx - 1].Generatable is CallbackGen)
* generator/Parameters.cs (Parameters.Validate): If the parameters end with "callback, gpointer, GDestroyNotify", then mark the callback as having "notified" Scope. (Parameters.IsHidden): Hide user_data and GDestroyNotify after a callback. (Parameter.Scope): make this settable (Parameter.IsDestroyNotify): new test * generator/MethodBody.cs (Initialize): Handle "notified" callback scope (using a GCHandle and GLib.DestroyHelper.NotifyHandler) * generator/CallbackGen.cs (GenWrapper): Add a static "GetManagedDelegate" method to the wrapper type, to translate a native delegate back to its corresponding managed delegate. (FromNative): use GetManagedDelegate. * generator/ReturnValue.cs (Validate): We handle callback return values now * generator/SymbolTable.cs: marshal GDestroyNotify as GLib.DestroyNotify * glib/DestroyNotify.cs: Moved from gtk * gtk/Gtk.metadata: globally change GtkDestroyNotify to GDestroyNotify, but then change back the ones that are exposed in the API. Un-hide lots of methods we can correctly autogenerate now. * gtk/DestroyHelper.cs: moved to glib * gtk/*.custom: remove methods that are autogenerated now, add Obsolete wrappers where needed, replace Gtk.DestroyHelper usage with GLib.DestroyHelper. * gdk/Gdk.metadata: * gnome/Gnome.metadata: Turn Gdk.Drawable.SetData and Gnome.IconList.SetIconDataFull's GDestroyNotify args into gpointers so the generated API stays the same as it used to be. * rsvg/Handle.custom: implement deprecated SetSizeCallback * sample/GtkDemo/DemoIconView.cs (CreateSort): update for API changes svn path=/trunk/gtk-sharp/; revision=44020
2005-05-04 11:47:25 +00:00
return true;
if (p.IsDestroyNotify && (idx == Count - 1) &&
this [idx - 1].IsUserData)
return true;
2005-05-02 20:10:03 +00:00
}
return false;
}
bool has_cb;
public bool HasCB {
get { return has_cb; }
set { has_cb = value; }
}
public bool HasOutParam {
get {
foreach (Parameter p in this)
if (p.PassAs == "out")
return true;
return false;
}
}
bool hide_data;
public bool HideData {
get { return hide_data; }
set { hide_data = value; }
}
bool is_static;
public bool Static {
get { return is_static; }
set { is_static = value; }
}
public Parameter GetCountParameter (string param_name)
{
foreach (Parameter p in this)
if (p.Name == param_name) {
p.IsCount = true;
return p;
}
return null;
}
void Clear ()
{
elem = null;
param_list.Clear ();
param_list = null;
}
public IEnumerator GetEnumerator ()
{
return param_list.GetEnumerator ();
}
bool valid = false;
public bool Validate (LogWriter log)
{
if (valid)
return true;
if (elem == null)
return false;
for (int i = first_is_instance ? 1 : 0; i < elem.ChildNodes.Count; i++) {
XmlElement parm = elem.ChildNodes [i] as XmlElement;
if (parm == null || parm.Name != "parameter")
continue;
Parameter p = new Parameter (parm);
if (p.IsEllipsis) {
log.Warn ("Ellipsis parameter: hide and bind manually if no alternative exists. ");
Clear ();
return false;
}
if ((p.CSType == "") || (p.Name == "") ||
(p.MarshalType == "") || (SymbolTable.Table.CallByName(p.CType, p.Name) == "")) {
log.Warn ("Unknown type {1} on parameter {0}", p.Name, p.CType);
Clear ();
return false;
}
2005-05-02 20:10:03 +00:00
IGeneratable gen = p.Generatable;
if (p.IsArray) {
p = new ArrayParameter (parm);
if (i < elem.ChildNodes.Count - 1) {
XmlElement next = elem.ChildNodes [i + 1] as XmlElement;
if (next != null || next.Name == "parameter") {
Parameter c = new Parameter (next);
if (c.IsCount) {
p = new ArrayCountPair (parm, next, false);
i++;
}
}
}
} else if (p.IsCount) {
p.IsCount = false;
if (i < elem.ChildNodes.Count - 1) {
XmlElement next = elem.ChildNodes [i + 1] as XmlElement;
if (next != null || next.Name == "parameter") {
Parameter a = new Parameter (next);
if (a.IsArray) {
p = new ArrayCountPair (next, parm, true);
i++;
}
}
}
} else if (p.CType == "GError**")
p = new ErrorParameter (parm);
else if (gen is StructBase || gen is ByRefGen) {
p = new StructParameter (parm);
} else if (gen is CallbackGen) {
2005-05-02 20:10:03 +00:00
has_cb = true;
* generator/Parameters.cs (Parameters.Validate): If the parameters end with "callback, gpointer, GDestroyNotify", then mark the callback as having "notified" Scope. (Parameters.IsHidden): Hide user_data and GDestroyNotify after a callback. (Parameter.Scope): make this settable (Parameter.IsDestroyNotify): new test * generator/MethodBody.cs (Initialize): Handle "notified" callback scope (using a GCHandle and GLib.DestroyHelper.NotifyHandler) * generator/CallbackGen.cs (GenWrapper): Add a static "GetManagedDelegate" method to the wrapper type, to translate a native delegate back to its corresponding managed delegate. (FromNative): use GetManagedDelegate. * generator/ReturnValue.cs (Validate): We handle callback return values now * generator/SymbolTable.cs: marshal GDestroyNotify as GLib.DestroyNotify * glib/DestroyNotify.cs: Moved from gtk * gtk/Gtk.metadata: globally change GtkDestroyNotify to GDestroyNotify, but then change back the ones that are exposed in the API. Un-hide lots of methods we can correctly autogenerate now. * gtk/DestroyHelper.cs: moved to glib * gtk/*.custom: remove methods that are autogenerated now, add Obsolete wrappers where needed, replace Gtk.DestroyHelper usage with GLib.DestroyHelper. * gdk/Gdk.metadata: * gnome/Gnome.metadata: Turn Gdk.Drawable.SetData and Gnome.IconList.SetIconDataFull's GDestroyNotify args into gpointers so the generated API stays the same as it used to be. * rsvg/Handle.custom: implement deprecated SetSizeCallback * sample/GtkDemo/DemoIconView.cs (CreateSort): update for API changes svn path=/trunk/gtk-sharp/; revision=44020
2005-05-04 11:47:25 +00:00
}
param_list.Add (p);
2002-06-21 Rachel Hestilow <hestilow@ximian.com> * generator/ClassBase.cs: New base class for classes and interfaces. * generator/InterfaceGen.cs: Inherit from ClassBase, generate declarations. * generator/ObjectGen.cs: Move half of this into ClassBase. * generator/Method.cs: Turn all applicable Get/Set functions into .NET accessors. Remove redundant == overload and move into Equals, as it was confusing "!= null". * generator/Parameters.cs: Alter signature creation to accept "is_set" option, add support for variable arguments. Add properties "Count", "IsVarArgs", "VAType". * generator/Ctor.cs: Fixup for changes in Parameters (indenting, signature creation). * generator/Signal.cs: Support generating declarations. * generator/SymbolTable: Change GetObjectGen to GetClassGen. * glib/IWrapper.cs: Move "Handle" declaration to here, so both classes and interfaces can benefit from it. * glib/Object.cs: Inherit from IWrapper.cs * parser/Metadata.pm: Support attribute changes on constructors, methods, signals, and paramater lists. * parser/gapi2xml.pl: Parse init funcs for interfaces. Ignore "_" functions here. * parser/gapi_pp.pl: Remove boxed_type_register check, as it will be caught in the init funcs. * parser/Atk.metadata: Added. * parser/Gtk.metadata: Add all needed signal/method collision renames. Rename GtkEditable.Editable accessors to IsEditable, as .NET does not like accessors with the same name as their declaring type. Tag TreeStore constructor as varargs. * samples/ButtonApp.cs: s/EmitAdd/Add. * samples/Menu.cs: s/EmitAdd/Add, s/Activate/Activated. svn path=/trunk/gtk-sharp/; revision=5394
2002-06-21 17:15:19 +00:00
}
if (has_cb && Count > 2 && this [Count - 3].Generatable is CallbackGen && this [Count - 2].IsUserData && this [Count - 1].IsDestroyNotify)
this [Count - 3].Scope = "notified";
valid = true;
2002-06-21 Rachel Hestilow <hestilow@ximian.com> * generator/ClassBase.cs: New base class for classes and interfaces. * generator/InterfaceGen.cs: Inherit from ClassBase, generate declarations. * generator/ObjectGen.cs: Move half of this into ClassBase. * generator/Method.cs: Turn all applicable Get/Set functions into .NET accessors. Remove redundant == overload and move into Equals, as it was confusing "!= null". * generator/Parameters.cs: Alter signature creation to accept "is_set" option, add support for variable arguments. Add properties "Count", "IsVarArgs", "VAType". * generator/Ctor.cs: Fixup for changes in Parameters (indenting, signature creation). * generator/Signal.cs: Support generating declarations. * generator/SymbolTable: Change GetObjectGen to GetClassGen. * glib/IWrapper.cs: Move "Handle" declaration to here, so both classes and interfaces can benefit from it. * glib/Object.cs: Inherit from IWrapper.cs * parser/Metadata.pm: Support attribute changes on constructors, methods, signals, and paramater lists. * parser/gapi2xml.pl: Parse init funcs for interfaces. Ignore "_" functions here. * parser/gapi_pp.pl: Remove boxed_type_register check, as it will be caught in the init funcs. * parser/Atk.metadata: Added. * parser/Gtk.metadata: Add all needed signal/method collision renames. Rename GtkEditable.Editable accessors to IsEditable, as .NET does not like accessors with the same name as their declaring type. Tag TreeStore constructor as varargs. * samples/ButtonApp.cs: s/EmitAdd/Add. * samples/Menu.cs: s/EmitAdd/Add, s/Activate/Activated. svn path=/trunk/gtk-sharp/; revision=5394
2002-06-21 17:15:19 +00:00
return true;
}
public bool IsAccessor {
get {
2005-05-02 20:10:03 +00:00
return VisibleCount == 1 && AccessorParam.PassAs == "out";
}
}
public Parameter AccessorParam {
get {
foreach (Parameter p in this) {
if (!IsHidden (p))
return p;
}
return null;
}
}
public string AccessorReturnType {
get {
2005-05-02 20:10:03 +00:00
Parameter p = AccessorParam;
if (p != null)
return p.CSType;
else
return null;
}
}
public string AccessorName {
get {
2005-05-02 20:10:03 +00:00
Parameter p = AccessorParam;
if (p != null)
return p.Name;
else
return null;
}
}
public string ImportSignature {
get {
if (Count == 0)
return String.Empty;
string[] result = new string [Count];
for (int i = 0; i < Count; i++)
result [i] = this [i].NativeSignature;
return String.Join (", ", result);
}
}
}
}