// GtkSharp.Generation.Parameters.cs - The Parameters Generation Class. // // Author: Mike Kestner // // 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"); } } public bool IsEllipsis { get { return elem.HasAttribute("ellipsis"); } } public bool IsCount { get { 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; } } 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 string MarshalType { get { string type = SymbolTable.Table.GetMarshalType( elem.GetAttribute("type")); if (type == "void") type = "System.IntPtr"; if (IsArray) { type += "[]"; type = type.Replace ("ref ", ""); } return type; } } public string NativeCallbackType { get { string type = Generatable.NativeCallbackType; if (type == "void") type = "System.IntPtr"; if (IsArray) { type += "[]"; type = type.Replace ("ref ", ""); } return type; } } public string Name { get { return SymbolTable.Table.MangleName (elem.GetAttribute("name")); } } public bool Owned { get { return elem.GetAttribute ("owned") == "true"; } } public virtual string NativeSignature { get { return MarshalType + " " + Name; } } 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; } } string scope; public string Scope { get { if (scope == null) scope = elem.GetAttribute ("scope"); return scope; } set { scope = value; } } public virtual string[] CallPreparation { get { IGeneratable gen = Generatable; if (PassAs == "out" && CSType != MarshalType && !(gen is StructBase || gen is ByRefGen)) return new string [] { gen.MarshalType + " " + CallName + "_as_native;" }; else if (gen is IManualMarshaler) return new string [] { gen.MarshalType + " " + CallName + "_as_native = " + (gen as IManualMarshaler).AllocNative (CallName) + ";" }; return new string [0]; } } public virtual string CallString { get { if (IsArray && MarshalType != CSType) return "native_" + CallName; string call_parm; IGeneratable gen = Generatable; if (gen is CallbackGen) call_parm = SymbolTable.Table.CallByName (CType, CallName + "_wrapper"); else if (PassAs != String.Empty) { call_parm = PassAs + " " + CallName; if (CSType != MarshalType && !(gen is StructBase || gen is ByRefGen)) call_parm += "_as_native"; } else if (gen is IManualMarshaler) call_parm = CallName + "_as_native"; else call_parm = SymbolTable.Table.CallByName(CType, CallName); if (IsArray) call_parm = call_parm.Replace ("ref ", ""); return call_parm; } } public string FromNative (string var) { if (Generatable is HandleBase) return ((HandleBase)Generatable).FromNative (var, Owned); 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 { public ArrayParameter (XmlElement elem) : base (elem) {} public override string[] CallPreparation { get { if (CSType == MarshalType) return new string [0]; string[] result = new string [4]; result [0] = String.Format ("int cnt_{0} = {0} == null ? 0 : {0}.Length;", CallName); result [1] = String.Format ("{0}[] native_{1} = new {0} [cnt_{1}];", MarshalType.TrimEnd('[', ']'), CallName); result [2] = String.Format ("for (int i = 0; i < cnt_{0}; i++)", CallName); IGeneratable gen = Generatable; if (gen is IManualMarshaler) result [3] = String.Format ("\tnative_{0} [i] = {1};", CallName, (gen as IManualMarshaler).AllocNative (CallName + "[i]")); else result [3] = String.Format ("\tnative_{0} [i] = {1};", CallName, gen.CallByName (CallName + "[i]")); return result; } } public override string CallString { get { if (CSType != MarshalType) return "native_" + CallName; else return CallName; } } } public class ArrayCountPair : ArrayParameter { XmlElement array_elem; XmlElement count_elem; bool invert; public ArrayCountPair (XmlElement array_elem, XmlElement count_elem, bool invert) : base (array_elem) { this.array_elem = array_elem; this.count_elem = count_elem; this.invert = invert; } 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 = name + " == null ? 0 : "; result += CountCast + 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 CountType + " " + CountName + ", " + MarshalType + " " + Name; else return MarshalType + " " + Name + ", " + CountType + " " + CountName; } } } public class ErrorParameter : Parameter { public ErrorParameter (XmlElement elem) : base (elem) { PassAs = "out"; } public override string CallString { get { return "out error"; } } } public class Parameters : IEnumerable { ArrayList param_list = new ArrayList (); public Parameters (XmlElement elem) { if (elem == null) return; for (int i = 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.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 && i < elem.ChildNodes.Count - 1) { Console.WriteLine (elem.GetAttribute ("name")); 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); param_list.Add (p); } } public int Count { get { return param_list.Count; } } 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; } } public bool IsHidden (Parameter p) { int idx = param_list.IndexOf (p); if (idx > 0 && p.IsLength && this [idx - 1].IsString) return true; if (p.IsCount && ((idx > 0 && this [idx - 1].IsArray) || (idx < Count - 1 && this [idx + 1].IsArray))) return true; if (p.CType == "GError**") return true; if (HasCB || HideData) { if (p.IsUserData && (idx == Count - 1)) return true; if (p.IsUserData && idx > 0 && this [idx - 1].Generatable is CallbackGen) return true; if (p.IsDestroyNotify && (idx == Count - 1) && this [idx - 1].IsUserData) return true; } return false; } bool has_cb; public bool HasCB { get { return has_cb; } set { has_cb = value; } } 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; } } bool cleared = false; void Clear () { cleared = true; param_list.Clear (); } public IEnumerator GetEnumerator () { return param_list.GetEnumerator (); } public bool Validate () { if (cleared) return false; for (int i = 0; i < param_list.Count; i++) { Parameter p = this [i]; if (p.IsEllipsis) { Console.Write("Ellipsis parameter "); Clear (); return false; } if ((p.CSType == "") || (p.Name == "") || (p.MarshalType == "") || (SymbolTable.Table.CallByName(p.CType, p.Name) == "")) { Console.Write("Name: " + p.Name + " Type: " + p.CType + " "); Clear (); return false; } if (p.Generatable is CallbackGen) { has_cb = true; if (i == Count - 3 && this [i + 1].IsUserData && this [i + 2].IsDestroyNotify) p.Scope = "notified"; } } return true; } public bool IsAccessor { get { 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 { Parameter p = AccessorParam; if (p != null) return p.CSType; else return null; } } public string AccessorName { get { Parameter p = AccessorParam; if (p != null) return p.Name; else return null; } } } }