Click here to Skip to main content
Click here to Skip to main content
Articles » Languages » XML » Serializing » Downloads
 
Add your own
alternative version

Yet Another XML Serialization Library for the .NET Framework

, 2 Oct 2012 MIT
A flexible XML serialization library that lets developers design the XML file structure, and select the exception handling policy. YAXLib supports polymorphic serialization and serializing generic and non-generic collection classes and arrays.
YAXLib-src-1.1.zip
YAXLib
DemoApplication
Properties
Settings.settings
SampleClasses
YAXLib
Properties
YAXLib-src-1.zip
Settings.settings
YAXLib-src-1_1.zip
Settings.settings
YAXLib-src-2.0.zip
Settings.settings
LocalTestRun.testrunconfig
YAXLib.vsmdi
YAXLibTests
Properties
Test References
// Copyright 2009 - 2010 Sina Iravanian - <sina@sinairv.com>
//
// This source file(s) may be redistributed, altered and customized
// by any means PROVIDING the authors name and all copyright
// notices remain intact.
// THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED. USE IT AT YOUR OWN RISK. THE AUTHOR ACCEPTS NO
// LIABILITY FOR ANY DATA DAMAGE/LOSS THAT THIS PRODUCT MAY CAUSE.
//-----------------------------------------------------------------------

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

namespace YAXLib
{
    /// <summary>
    /// Provides a wrapper arount enum types, in order to provide alias definition capabilities for enums
    /// </summary>
    internal class EnumWrapper
    {
        /// <summary>
        /// The enum underlying type
        /// </summary>
        private Type m_enumType = null;

        /// <summary>
        /// maps real enum names to their corresponding user defined aliases 
        /// </summary>
        private Dictionary<string, string> m_enumMembers = new Dictionary<string, string>();

        /// <summary>
        /// Initializes a new instance of the <see cref="EnumWrapper"/> class.
        /// </summary>
        /// <param name="t">The enum type.</param>
        public EnumWrapper(Type t)
        {
            if (!t.IsEnum)
                throw new ArithmeticException();

            m_enumType = t;

            foreach (var m in t.GetFields())
            {
                if (m.FieldType == t)
                {
                    string originalName = m.Name;
                    string alias = originalName;
                    foreach (var attr in m.GetCustomAttributes(false))
                    {
                        if (attr is YAXEnumAttribute)
                        {
                            alias = (attr as YAXEnumAttribute).Alias;
                        }
                    }

                    if (alias != originalName)
                    {
                        if (!m_enumMembers.ContainsKey(alias))
                            m_enumMembers.Add(m.Name, alias);
                        else if (!m_enumMembers.ContainsKey(originalName))
                            m_enumMembers.Add(m.Name, originalName);
                        else
                            throw new YAXException("Enum alias already exists");
                    }
                }
            }
        }

        /// <summary>
        /// Parses the alias and returns the correct enum value. Throws an exception if the alias cannot be matched.
        /// </summary>
        /// <param name="alias">The alias.</param>
        /// <returns>the enum member corresponding to the specified alias</returns>
        public object ParseAlias(string alias)
        {
            string[] components = alias.Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries);

            if (components.Length > 0)
            {
                StringBuilder sb = new StringBuilder();
                string realName = FindRealNameFromAlias(components[0]);
                sb.Append(realName);

                for(int i = 1; i < components.Length; i++)
                {
                    sb.Append(", ");
                    realName = FindRealNameFromAlias(components[i]);
                    sb.Append(realName);
                }

                return Enum.Parse(m_enumType, sb.ToString());
            }

            throw new Exception("Invalid enum alias");
        }

        /// <summary>
        /// Gets the alias for the specified enum value.
        /// </summary>
        /// <param name="enumMember">The enum member.</param>
        /// <returns>the alias corresponding to the specified enum member</returns>
        public object GetAlias(object enumMember)
        {
            string originalName = enumMember.ToString();

            string[] components = originalName.Split(new char[] { ',', ' ', '\t' }, StringSplitOptions.RemoveEmptyEntries);

            if (components.Length == 1)
            {
                string alias;
                if (m_enumMembers.TryGetValue(originalName, out alias))
                    return alias;
                else
                    return enumMember;
            }
            else if (components.Length > 1)
            {
                StringBuilder result = new StringBuilder();
                for (int i = 0; i < components.Length; i++)
                {
                    if (i != 0)
                        result.Append(", ");

                    string alias;
                    if (m_enumMembers.TryGetValue(components[i], out alias))
                        result.Append(alias);
                    else
                        result.Append(components[i]);
                }

                return result.ToString();
            }
            else
            {
                throw new Exception("Invalid enum member");
            }
        }

        /// <summary>
        /// Finds the real name from alias.
        /// </summary>
        /// <param name="alias">The alias.</param>
        /// <returns>the real name of the enum member</returns>
        private string FindRealNameFromAlias(string alias)
        {
            alias = alias.Trim();
            foreach (var pair in m_enumMembers)
            {
                if (pair.Value == alias)
                    return pair.Key;
            }

            return alias;
        }
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The MIT License

Share

About the Author

Sina Iravanian
Software Developer
Australia Australia
A software designer and developer
Follow on   Twitter   Google+

| Advertise | Privacy | Terms of Use | Mobile
Web04 | 2.8.141216.1 | Last Updated 2 Oct 2012
Article Copyright 2009 by Sina Iravanian
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid