linux-packaging-mono/mcs/tools/mono-api-html/Helpers.cs

// 
// Authors
//    Sebastien Pouliot  <sebastien@xamarin.com>
//
// Copyright 2013-2014 Xamarin Inc. http://www.xamarin.com
// 
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//

using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Xml.Linq;

namespace Xamarin.ApiDiff {

	public static class Helper {
		public static bool IsTrue (this XElement self, string name)
		{
			return (self.GetAttribute (name) == "true");
		}

		public static string GetAttribute (this XElement self, string name)
		{
			var n = self.Attribute (name);
			if (n == null)
				return null;
			return n.Value;
		}

		// null == no obsolete, String.Empty == no description
		public static string GetObsoleteMessage (this XElement self)
		{
			var cattrs = self.Element ("attributes");
			if (cattrs == null)
				return null;

			foreach (var ca in cattrs.Elements ("attribute")) {
				if (ca.GetAttribute ("name") != "System.ObsoleteAttribute")
					continue;
				var props = ca.Element ("properties");
				if (props == null)
					return String.Empty; // no description
				foreach (var p in props.Elements ("property")) {
					if (p.GetAttribute ("name") != "Message")
						continue;
					return p.GetAttribute ("value");
				}
			}
			return null;
		}

		public static IEnumerable<XElement> Descendants (this XElement self, params string[] names)
		{
			XElement el = self;
			if (el == null)
				return null;

			for (int i = 0; i < names.Length - 1; i++) {
				el = el.Element (names [i]);
				if (el == null)
					return null;
			}
			return el.Elements (names [names.Length - 1]);
		}

		public static List<XElement> DescendantList (this XElement self, params string[] names)
		{
			var descendants = self.Descendants (names);
			if (descendants == null)
				return null;
			return descendants.ToList ();
		}

		// make it beautiful (.NET -> C#)
		public static string GetTypeName (this XElement self, string name)
		{
			string type = self.GetAttribute (name);
			if (type == null)
				return null;

			StringBuilder sb = null;
			bool is_nullable = false;
			if (type.StartsWith ("System.Nullable`1[", StringComparison.Ordinal)) {
				is_nullable = true;
				sb = new StringBuilder (type, 18, type.Length - 19, 1024);
			} else {
				sb = new StringBuilder (type);
			}

			bool is_ref = (sb [sb.Length - 1] == '&');
			if (is_ref)
				sb.Remove (sb.Length - 1, 1);

			int array = 0;
			while ((sb [sb.Length - 1] == ']') && (sb [sb.Length - 2] == '[')) {
				sb.Remove (sb.Length - 2, 2);
				array++;
			}

			bool is_pointer = (sb [sb.Length - 1] == '*');
			if (is_pointer)
				sb.Remove (sb.Length - 1, 1);

			type = GetTypeName (sb.Replace ('+', '.').ToString ());
			sb.Length = 0;
			if (is_ref)
				sb.Append (self.GetAttribute ("direction")).Append (' ');

			sb.Append (type);

			while (array-- > 0)
				sb.Append ("[]");
			if (is_nullable)
				sb.Append ('?');
			if (is_pointer)
				sb.Append ('*');
			return sb.ToString ();
		}

		static string GetTypeName (string type)
		{
			int pos = type.IndexOf ('`');
			if (pos >= 0) {
				int end = type.LastIndexOf (']');
				string subtype = type.Substring (pos + 3, end - pos - 3);
				return type.Substring (0, pos) + "&lt;" + GetTypeName (subtype) + "&gt;";
			}

			switch (type) {
			case "System.String":
				return "string";
			case "System.Int32":
				return "int";
			case "System.UInt32":
				return "uint";
			case "System.Int64":
				return "long";
			case "System.UInt64":
				return "ulong";
			case "System.Void":
				return "void";
			case "System.Boolean":
				return "bool";
			case "System.Object":
				return "object";
			case "System.Single":
				return "float";
			case "System.Double":
				return "double";
			case "System.Byte":
				return "byte";
			case "System.SByte":
				return "sbyte";
			case "System.Int16":
				return "short";
			case "System.UInt16":
				return "ushort";
			case "System.Char":
				return "char";
			case "System.nint":
				return "nint";
			case "System.nuint":
				return "uint";
			case "System.nfloat":
				return "nfloat";
			case "System.IntPtr":
				return "IntPtr";
			default:
				if (type.StartsWith (State.Namespace, StringComparison.Ordinal))
					type = type.Substring (State.Namespace.Length + 1);
				return type;
			}
		}

		public static MethodAttributes GetMethodAttributes (this XElement element)
		{
			var srcAttribs = element.Attribute ("attrib");
			return (MethodAttributes) (srcAttribs != null ? Int32.Parse (srcAttribs.Value) : 0);
		}

		public static FieldAttributes GetFieldAttributes (this XElement element)
		{
			var srcAttribs = element.Attribute ("attrib");
			return (FieldAttributes) (srcAttribs != null ? Int32.Parse (srcAttribs.Value) : 0);
		}
	}
}