2ba496479f
* generator/*.cs: Add a LogWriter class which formats warnings consistently on the console. Supports the concept of non-fatal validation warnings, since it doesn't rely on the unrolling of the validation stack to associate a warning to a given type. Main purpose was to add a non-fatal warning for missing element_type attributes on list return values, though it results in cleaner log output, and also updates some warning messages to be more helpful in how to resolve them.
338 lines
10 KiB
C#
338 lines
10 KiB
C#
// GtkSharp.Generation.Method.cs - The Method Generatable.
|
|
//
|
|
// Author: Mike Kestner <mkestner@speakeasy.net>
|
|
//
|
|
// Copyright (c) 2001-2003 Mike Kestner
|
|
// Copyright (c) 2003-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 Method : MethodBase {
|
|
|
|
private ReturnValue retval;
|
|
|
|
private string call;
|
|
private bool is_get, is_set;
|
|
private bool deprecated = false;
|
|
private bool win32_utf8_variant = false;
|
|
|
|
public Method (XmlElement elem, ClassBase container_type) : base (elem, container_type)
|
|
{
|
|
this.retval = new ReturnValue (elem["return-type"]);
|
|
|
|
if (!container_type.IsDeprecated && elem.HasAttribute ("deprecated")) {
|
|
string attr = elem.GetAttribute ("deprecated");
|
|
deprecated = attr == "1" || attr == "true";
|
|
}
|
|
|
|
if (elem.HasAttribute ("win32_utf8_variant")) {
|
|
string attr = elem.GetAttribute ("win32_utf8_variant");
|
|
win32_utf8_variant = attr == "1" || attr.ToLower () == "true";
|
|
}
|
|
|
|
if (Name == "GetType")
|
|
Name = "GetGType";
|
|
}
|
|
|
|
public bool HasWin32Utf8Variant {
|
|
get { return win32_utf8_variant; }
|
|
}
|
|
|
|
public bool IsDeprecated {
|
|
get {
|
|
return deprecated;
|
|
}
|
|
}
|
|
|
|
public bool IsGetter {
|
|
get {
|
|
return is_get;
|
|
}
|
|
}
|
|
|
|
public bool IsSetter {
|
|
get {
|
|
return is_set;
|
|
}
|
|
}
|
|
|
|
public string ReturnType {
|
|
get {
|
|
return retval.CSType;
|
|
}
|
|
}
|
|
|
|
public override bool Validate (LogWriter log)
|
|
{
|
|
log.Member = Name;
|
|
if (!retval.Validate (log) || !base.Validate (log))
|
|
return false;
|
|
|
|
Parameters parms = Parameters;
|
|
is_get = ((((parms.IsAccessor && retval.IsVoid) || (parms.Count == 0 && !retval.IsVoid)) || (parms.Count == 0 && !retval.IsVoid)) && HasGetterName);
|
|
is_set = ((parms.IsAccessor || (parms.VisibleCount == 1 && retval.IsVoid)) && HasSetterName);
|
|
|
|
call = "(" + (IsStatic ? "" : container_type.CallByName () + (parms.Count > 0 ? ", " : "")) + Body.GetCallString (is_set) + ")";
|
|
|
|
return true;
|
|
}
|
|
|
|
private Method GetComplement ()
|
|
{
|
|
char complement;
|
|
if (is_get)
|
|
complement = 'S';
|
|
else
|
|
complement = 'G';
|
|
|
|
return container_type.GetMethod (complement + BaseName.Substring (1));
|
|
}
|
|
|
|
public string Declaration {
|
|
get {
|
|
return retval.CSType + " " + Name + " (" + (Signature != null ? Signature.ToString() : "") + ");";
|
|
}
|
|
}
|
|
|
|
private void GenerateDeclCommon (StreamWriter sw, ClassBase implementor)
|
|
{
|
|
if (IsStatic)
|
|
sw.Write("static ");
|
|
sw.Write (Safety);
|
|
Method dup = null;
|
|
if (container_type != null)
|
|
dup = container_type.GetMethodRecursively (Name);
|
|
if (implementor != null)
|
|
dup = implementor.GetMethodRecursively (Name);
|
|
|
|
if (Name == "ToString" && Parameters.Count == 0 && (!(container_type is InterfaceGen)|| implementor != null))
|
|
sw.Write("override ");
|
|
else if (Name == "GetGType" && container_type is ObjectGen)
|
|
sw.Write("new ");
|
|
else if (Modifiers == "new " || (dup != null && ((dup.Signature != null && Signature != null && dup.Signature.ToString() == Signature.ToString()) || (dup.Signature == null && Signature == null))))
|
|
sw.Write("new ");
|
|
|
|
if (is_get || is_set) {
|
|
if (retval.IsVoid)
|
|
sw.Write (Parameters.AccessorReturnType);
|
|
else
|
|
sw.Write(retval.CSType);
|
|
sw.Write(" ");
|
|
if (Name.StartsWith ("Get") || Name.StartsWith ("Set"))
|
|
sw.Write (Name.Substring (3));
|
|
else {
|
|
int dot = Name.LastIndexOf ('.');
|
|
if (dot != -1 && (Name.Substring (dot + 1, 3) == "Get" || Name.Substring (dot + 1, 3) == "Set"))
|
|
sw.Write (Name.Substring (0, dot + 1) + Name.Substring (dot + 4));
|
|
else
|
|
sw.Write (Name);
|
|
}
|
|
sw.WriteLine(" { ");
|
|
} else if (IsAccessor) {
|
|
sw.Write (Signature.AccessorType + " " + Name + "(" + Signature.AsAccessor + ")");
|
|
} else {
|
|
sw.Write(retval.CSType + " " + Name + "(" + (Signature != null ? Signature.ToString() : "") + ")");
|
|
}
|
|
}
|
|
|
|
public void GenerateDecl (StreamWriter sw)
|
|
{
|
|
if (IsStatic)
|
|
return;
|
|
|
|
if (is_get || is_set)
|
|
{
|
|
Method comp = GetComplement ();
|
|
if (comp != null && is_set)
|
|
return;
|
|
|
|
sw.Write("\t\t");
|
|
GenerateDeclCommon (sw, null);
|
|
|
|
sw.Write("\t\t\t");
|
|
sw.Write ((is_get) ? "get;" : "set;");
|
|
|
|
if (comp != null && comp.is_set)
|
|
sw.WriteLine (" set;");
|
|
else
|
|
sw.WriteLine ();
|
|
|
|
sw.WriteLine ("\t\t}");
|
|
}
|
|
else
|
|
{
|
|
sw.Write("\t\t");
|
|
GenerateDeclCommon (sw, null);
|
|
sw.WriteLine (";");
|
|
}
|
|
|
|
Statistics.MethodCount++;
|
|
}
|
|
|
|
public void GenerateImport (StreamWriter sw)
|
|
{
|
|
string import_sig = IsStatic ? "" : container_type.MarshalType + " raw";
|
|
import_sig += !IsStatic && Parameters.Count > 0 ? ", " : "";
|
|
import_sig += Parameters.ImportSignature.ToString();
|
|
sw.WriteLine("\t\t[DllImport(\"" + LibraryName + "\", CallingConvention = CallingConvention.Cdecl)]");
|
|
if (retval.MarshalType.StartsWith ("[return:"))
|
|
sw.WriteLine("\t\t" + retval.MarshalType + " static extern " + Safety + retval.CSType + " " + CName + "(" + import_sig + ");");
|
|
else
|
|
sw.WriteLine("\t\tstatic extern " + Safety + retval.MarshalType + " " + CName + "(" + import_sig + ");");
|
|
sw.WriteLine();
|
|
|
|
if (HasWin32Utf8Variant) {
|
|
sw.WriteLine("\t\t[DllImport(\"" + LibraryName + "\")]");
|
|
if (retval.MarshalType.StartsWith ("[return:"))
|
|
sw.WriteLine("\t\t" + retval.MarshalType + " static extern " + Safety + retval.CSType + " " + CName + "_utf8(" + import_sig + ");");
|
|
else
|
|
sw.WriteLine("\t\tstatic extern " + Safety + retval.MarshalType + " " + CName + "_utf8(" + import_sig + ");");
|
|
sw.WriteLine();
|
|
}
|
|
}
|
|
|
|
public void Generate (GenerationInfo gen_info, ClassBase implementor)
|
|
{
|
|
Method comp = null;
|
|
|
|
gen_info.CurrentMember = Name;
|
|
|
|
/* we are generated by the get Method, if there is one */
|
|
if (is_set || is_get)
|
|
{
|
|
if (Modifiers != "new " && container_type.GetPropertyRecursively (Name.Substring (3)) != null)
|
|
return;
|
|
comp = GetComplement ();
|
|
if (comp != null && is_set) {
|
|
if (Parameters.AccessorReturnType == comp.ReturnType)
|
|
return;
|
|
else {
|
|
is_set = false;
|
|
call = "(Handle, " + Body.GetCallString (false) + ")";
|
|
comp = null;
|
|
}
|
|
}
|
|
/* some setters take more than one arg */
|
|
if (comp != null && !comp.is_set)
|
|
comp = null;
|
|
}
|
|
|
|
GenerateImport (gen_info.Writer);
|
|
if (comp != null && retval.CSType == comp.Parameters.AccessorReturnType)
|
|
comp.GenerateImport (gen_info.Writer);
|
|
|
|
if (IsDeprecated)
|
|
gen_info.Writer.WriteLine("\t\t[Obsolete]");
|
|
gen_info.Writer.Write("\t\t");
|
|
if (Protection != "")
|
|
gen_info.Writer.Write("{0} ", Protection);
|
|
GenerateDeclCommon (gen_info.Writer, implementor);
|
|
|
|
if (is_get || is_set)
|
|
{
|
|
gen_info.Writer.Write ("\t\t\t");
|
|
gen_info.Writer.Write ((is_get) ? "get" : "set");
|
|
GenerateBody (gen_info, implementor, "\t");
|
|
}
|
|
else
|
|
GenerateBody (gen_info, implementor, "");
|
|
|
|
if (is_get || is_set)
|
|
{
|
|
if (comp != null && retval.CSType == comp.Parameters.AccessorReturnType)
|
|
{
|
|
gen_info.Writer.WriteLine ();
|
|
gen_info.Writer.Write ("\t\t\tset");
|
|
comp.GenerateBody (gen_info, implementor, "\t");
|
|
}
|
|
gen_info.Writer.WriteLine ();
|
|
gen_info.Writer.WriteLine ("\t\t}");
|
|
}
|
|
else
|
|
gen_info.Writer.WriteLine();
|
|
|
|
gen_info.Writer.WriteLine();
|
|
|
|
Statistics.MethodCount++;
|
|
}
|
|
|
|
public void GenerateBody (GenerationInfo gen_info, ClassBase implementor, string indent)
|
|
{
|
|
StreamWriter sw = gen_info.Writer;
|
|
sw.WriteLine(" {");
|
|
if (!IsStatic && implementor != null)
|
|
implementor.Prepare (sw, indent + "\t\t\t");
|
|
if (IsAccessor)
|
|
Body.InitAccessor (sw, Signature, indent);
|
|
Body.Initialize(gen_info, is_get, is_set, indent);
|
|
|
|
if (HasWin32Utf8Variant) {
|
|
if (!retval.IsVoid)
|
|
sw.WriteLine(indent + "\t\t\t" + retval.MarshalType + " raw_ret;");
|
|
sw.WriteLine(indent + "\t\t\t" + "if (Environment.OSVersion.Platform == PlatformID.Win32NT ||");
|
|
sw.WriteLine(indent + "\t\t\t" + " Environment.OSVersion.Platform == PlatformID.Win32S ||");
|
|
sw.WriteLine(indent + "\t\t\t" + " Environment.OSVersion.Platform == PlatformID.Win32Windows ||");
|
|
sw.WriteLine(indent + "\t\t\t" + " Environment.OSVersion.Platform == PlatformID.WinCE)");
|
|
if (retval.IsVoid) {
|
|
sw.WriteLine(indent + "\t\t\t\t" + CName + "_utf8" + call + ";");
|
|
sw.WriteLine(indent + "\t\t\t" + "else");
|
|
sw.WriteLine(indent + "\t\t\t\t" + CName + call + ";");
|
|
} else {
|
|
sw.WriteLine(indent + "\t\t\t\traw_ret = " + CName + "_utf8" + call + ";");
|
|
sw.WriteLine(indent + "\t\t\t" + "else");
|
|
sw.WriteLine(indent + "\t\t\t\traw_ret = " + CName + call + ";");
|
|
sw.WriteLine(indent + "\t\t\t" + retval.CSType + " ret = " + retval.FromNative ("raw_ret") + ";");
|
|
}
|
|
} else {
|
|
sw.Write(indent + "\t\t\t");
|
|
if (retval.IsVoid)
|
|
sw.WriteLine(CName + call + ";");
|
|
else {
|
|
sw.WriteLine(retval.MarshalType + " raw_ret = " + CName + call + ";");
|
|
sw.WriteLine(indent + "\t\t\t" + retval.CSType + " ret = " + retval.FromNative ("raw_ret") + ";");
|
|
}
|
|
}
|
|
|
|
if (!IsStatic && implementor != null)
|
|
implementor.Finish (sw, indent + "\t\t\t");
|
|
Body.Finish (sw, indent);
|
|
Body.HandleException (sw, indent);
|
|
|
|
if (is_get && Parameters.Count > 0)
|
|
sw.WriteLine (indent + "\t\t\treturn " + Parameters.AccessorName + ";");
|
|
else if (!retval.IsVoid)
|
|
sw.WriteLine (indent + "\t\t\treturn ret;");
|
|
else if (IsAccessor)
|
|
Body.FinishAccessor (sw, Signature, indent);
|
|
|
|
sw.Write(indent + "\t\t}");
|
|
}
|
|
|
|
bool IsAccessor {
|
|
get {
|
|
return retval.IsVoid && Signature.IsAccessor;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|