GtkSharp/generator/ReturnValue.cs

176 lines
4 KiB
C#
Raw Normal View History

// 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 {
private XmlElement elem;
public ReturnValue (XmlElement elem)
{
this.elem = elem;
}
public string CType {
get {
return elem == null ? String.Empty : elem.GetAttribute("type");
}
}
public string CSType {
get {
if (IGen == null)
return String.Empty;
if (ElementType != String.Empty)
return ElementType + "[]";
return IGen.QualifiedName + (IsArray ? "[]" : String.Empty);
}
}
public string DefaultValue {
get {
if (IGen == null)
return String.Empty;
return IGen.DefaultValue;
}
}
string ElementCType {
get {
if (elem != null && elem.HasAttribute ("element_type"))
return elem.GetAttribute ("element_type");
return String.Empty;
}
}
bool ElementsOwned {
get {
if (elem != null && elem.GetAttribute ("elements_owned") == "true")
return true;
return false;
}
}
string ElementType {
get {
if (ElementCType.Length > 0)
return SymbolTable.Table.GetCSType (ElementCType);
return String.Empty;
}
}
IGeneratable igen;
IGeneratable IGen {
get {
if (igen == null)
igen = SymbolTable.Table [CType];
return igen;
}
}
bool IsArray {
get {
return elem == null ? false : elem.HasAttribute ("array");
}
}
public bool IsVoid {
get {
return CSType == "void";
}
}
public string MarshalType {
get {
if (IGen == null)
return String.Empty;
return IGen.MarshalReturnType + (IsArray ? "[]" : String.Empty);
}
}
bool Owned {
get {
return elem.GetAttribute ("owned") == "true";
}
}
public string ToNativeType {
get {
if (IGen == null)
return String.Empty;
return IGen.ToNativeReturnType + (IsArray ? "[]" : String.Empty);
}
}
public string FromNative (string var)
{
if (IGen == null)
return String.Empty;
if (ElementType != String.Empty) {
string type_str = "typeof (" + ElementType + ")";
string args = type_str + ", " + (Owned ? "true" : "false") + ", " + (ElementsOwned ? "true" : "false");
return String.Format ("({0}[]) GLib.Marshaller.ListToArray ({1}, {2})", ElementType, IGen.FromNativeReturn (var + ", " + args), type_str);
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 if (IGen is HandleBase)
return ((HandleBase)IGen).FromNative (var, Owned);
else
return IGen.FromNativeReturn (var);
}
public string ToNative (string var)
{
if (IGen == null)
return String.Empty;
if (ElementType.Length > 0) {
string args = ", typeof (" + ElementType + "), " + (Owned ? "true" : "false") + ", " + (ElementsOwned ? "true" : "false");
var = "new " + IGen.QualifiedName + "(" + var + args + ")";
}
if (IGen is IManualMarshaler)
return (IGen as IManualMarshaler).AllocNative (var);
else
return IGen.ToNativeReturn (var);
}
public bool Validate ()
{
if (MarshalType == "" || CSType == "") {
Console.Write("rettype: " + CType);
return false;
}
return true;
}
}
}