2004-11-17 17:00:00 +01:00
|
|
|
// GtkSharp.Generation.ReturnValue.cs - The ReturnValue Generatable.
|
|
|
|
//
|
|
|
|
// Author: Mike Kestner <mkestner@novell.com>
|
|
|
|
//
|
2005-06-24 00:28:06 +02:00
|
|
|
// Copyright (c) 2004-2005 Novell, Inc.
|
2004-11-17 17:00:00 +01:00
|
|
|
//
|
|
|
|
// 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 {
|
2005-06-24 00:28:06 +02:00
|
|
|
|
2004-11-17 17:00:00 +01:00
|
|
|
|
2008-03-01 00:42:27 +01:00
|
|
|
bool is_null_term;
|
|
|
|
bool is_array;
|
|
|
|
bool elements_owned;
|
|
|
|
bool owned;
|
|
|
|
string ctype = String.Empty;
|
|
|
|
string element_ctype = String.Empty;
|
2004-11-17 17:00:00 +01:00
|
|
|
|
|
|
|
public ReturnValue (XmlElement elem)
|
|
|
|
{
|
2008-03-01 00:42:27 +01:00
|
|
|
if (elem != null) {
|
|
|
|
is_null_term = elem.HasAttribute ("null_term_array");
|
|
|
|
is_array = elem.HasAttribute ("array");
|
|
|
|
elements_owned = elem.GetAttribute ("elements_owned") == "true";
|
|
|
|
owned = elem.GetAttribute ("owned") == "true";
|
|
|
|
ctype = elem.GetAttribute("type");
|
|
|
|
element_ctype = elem.GetAttribute ("element_type");
|
|
|
|
}
|
2004-11-17 17:00:00 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
public string CType {
|
|
|
|
get {
|
2008-03-01 00:42:27 +01:00
|
|
|
return ctype;
|
2004-11-17 17:00:00 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
public string CSType {
|
|
|
|
get {
|
2005-03-07 16:54:49 +01:00
|
|
|
if (IGen == null)
|
|
|
|
return String.Empty;
|
2005-06-08 18:53:12 +02:00
|
|
|
|
|
|
|
if (ElementType != String.Empty)
|
|
|
|
return ElementType + "[]";
|
|
|
|
|
2008-03-01 00:42:27 +01:00
|
|
|
return IGen.QualifiedName + (is_array || is_null_term ? "[]" : String.Empty);
|
2004-11-17 17:00:00 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2007-10-02 17:57:45 +02:00
|
|
|
public string DefaultValue {
|
|
|
|
get {
|
|
|
|
if (IGen == null)
|
|
|
|
return String.Empty;
|
|
|
|
return IGen.DefaultValue;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2005-03-07 16:54:49 +01:00
|
|
|
string ElementType {
|
2004-11-17 17:00:00 +01:00
|
|
|
get {
|
2008-03-01 00:42:27 +01:00
|
|
|
if (element_ctype.Length > 0)
|
|
|
|
return SymbolTable.Table.GetCSType (element_ctype);
|
2005-06-24 00:28:06 +02:00
|
|
|
|
|
|
|
return String.Empty;
|
2004-11-17 17:00:00 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2005-03-07 16:54:49 +01:00
|
|
|
IGeneratable igen;
|
|
|
|
IGeneratable IGen {
|
|
|
|
get {
|
|
|
|
if (igen == null)
|
|
|
|
igen = SymbolTable.Table [CType];
|
|
|
|
return igen;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2005-03-04 17:02:44 +01:00
|
|
|
public bool IsVoid {
|
|
|
|
get {
|
|
|
|
return CSType == "void";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2004-11-17 17:00:00 +01:00
|
|
|
public string MarshalType {
|
|
|
|
get {
|
2005-03-07 16:54:49 +01:00
|
|
|
if (IGen == null)
|
|
|
|
return String.Empty;
|
2008-03-01 00:42:27 +01:00
|
|
|
else if (is_null_term)
|
|
|
|
return "IntPtr";
|
|
|
|
return IGen.MarshalReturnType + (is_array ? "[]" : String.Empty);
|
2005-01-19 03:58:42 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2004-11-17 17:00:00 +01:00
|
|
|
public string ToNativeType {
|
|
|
|
get {
|
2005-03-07 16:54:49 +01:00
|
|
|
if (IGen == null)
|
|
|
|
return String.Empty;
|
2008-03-01 00:42:27 +01:00
|
|
|
else if (is_null_term)
|
|
|
|
return "IntPtr"; //FIXME
|
|
|
|
return IGen.ToNativeReturnType + (is_array ? "[]" : String.Empty);
|
2004-11-17 17:00:00 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2005-03-04 17:02:44 +01:00
|
|
|
public string FromNative (string var)
|
|
|
|
{
|
2005-03-07 16:54:49 +01:00
|
|
|
if (IGen == null)
|
|
|
|
return String.Empty;
|
2005-06-24 00:28:06 +02:00
|
|
|
|
|
|
|
if (ElementType != String.Empty) {
|
2008-08-20 21:48:26 +02:00
|
|
|
string args = (owned ? "true" : "false") + ", " + (elements_owned ? "true" : "false");
|
|
|
|
return String.Format ("({0}[]) GLib.Marshaller.ListPtrToArray ({1}, typeof({2}), {3}, typeof({0}))", ElementType, var, IGen.QualifiedName, args);
|
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 20:45:21 +02:00
|
|
|
} else if (IGen is HandleBase)
|
2008-03-01 00:42:27 +01:00
|
|
|
return ((HandleBase)IGen).FromNative (var, owned);
|
|
|
|
else if (is_null_term)
|
|
|
|
return String.Format ("GLib.Marshaller.NullTermPtrToStringArray ({0}, {1})", var, owned ? "true" : "false");
|
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 20:45:21 +02:00
|
|
|
else
|
|
|
|
return IGen.FromNativeReturn (var);
|
2005-03-04 17:02:44 +01:00
|
|
|
}
|
|
|
|
|
2007-09-11 22:34:24 +02:00
|
|
|
public string ToNative (string var)
|
|
|
|
{
|
|
|
|
if (IGen == null)
|
|
|
|
return String.Empty;
|
|
|
|
|
|
|
|
if (ElementType.Length > 0) {
|
2008-03-01 00:42:27 +01:00
|
|
|
string args = ", typeof (" + ElementType + "), " + (owned ? "true" : "false") + ", " + (elements_owned ? "true" : "false");
|
2007-09-11 22:34:24 +02:00
|
|
|
var = "new " + IGen.QualifiedName + "(" + var + args + ")";
|
2008-03-01 00:42:27 +01:00
|
|
|
} else if (is_null_term)
|
|
|
|
return String.Format ("GLib.Marshaller.StringArrayToNullTermPtr ({0})", var);
|
2007-09-11 22:34:24 +02:00
|
|
|
|
|
|
|
if (IGen is IManualMarshaler)
|
|
|
|
return (IGen as IManualMarshaler).AllocNative (var);
|
2008-04-04 18:10:08 +02:00
|
|
|
else if (IGen is ObjectGen && owned)
|
|
|
|
return var + " == null ? IntPtr.Zero : " + var + ".OwnedHandle";
|
2008-04-15 21:43:16 +02:00
|
|
|
else if (IGen is OpaqueGen && owned)
|
|
|
|
return var + " == null ? IntPtr.Zero : " + var + ".OwnedCopy";
|
2007-09-11 22:34:24 +02:00
|
|
|
else
|
|
|
|
return IGen.ToNativeReturn (var);
|
|
|
|
}
|
|
|
|
|
2004-11-17 17:00:00 +01:00
|
|
|
public bool Validate ()
|
|
|
|
{
|
|
|
|
if (MarshalType == "" || CSType == "") {
|
|
|
|
Console.Write("rettype: " + CType);
|
|
|
|
return false;
|
|
|
|
}
|
2005-06-08 18:53:12 +02:00
|
|
|
|
2004-11-17 17:00:00 +01:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|