// Copyright (c) 2007 Omer Rauchwerger (a.k.a rauchy) (omer@rauchy.net)
// All rights reserved.
//
// This file is part of Regionerate.
// 
// This program is free software; you can redistribute it and/or modify it 
// under the terms of the GNU General Public License as published by 
// the Free Software Foundation; either version 3 of the License, 
// or (at your option) any later version.
//
// 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, see <http://www.gnu.org/licenses/>.

using System.Xml;

namespace Rauchy.Regionerate.Shared.Components.Rendering
{
    /// <summary>
    /// A textual sign which can be embedded in strings and later be identified in them.
    /// </summary>
    public abstract class Symbol
    {
        #region Methods (3) 

        // Public Methods (3) 

        /// <summary>
        /// Embeds the textual chariteristics of this <see cref="Symbol"/> inside the specified text.
        /// </summary>
        /// <returns>The provided text with the <see cref="Symbol"/> embedded in it.</returns>
        public abstract string Embed( string text );

        /// <summary>
        /// Determines whether the textual chariteristics of this <see cref="Symbol"/> are embedded in the specified text.
        /// </summary>
        public abstract bool IsEmbeddedIn( string text );

        /// <summary>
        /// Parses the specified <see cref="XmlNode"/>and constructs a <see cref="Symbol"/> out of it.
        /// </summary>
        /// <returns>The requested <see cref="Symbol"/> which is declared in the provided Xml node.</returns>
        public static Symbol Parse( XmlNode xmlNode )
        {
            if ( xmlNode[ "Prefix" ] != null )
            {
                XmlNode prefixNode = xmlNode[ "Prefix" ];
                string value = prefixNode.Attributes[ "Value" ].Value;
                return new Prefix( value );
            }
            else if ( xmlNode[ "Wrapper" ] != null )
            {
                XmlNode wrapperNode = xmlNode[ "Wrapper" ];
                string prefix = wrapperNode.Attributes[ "Prefix" ].Value;
                string suffix = wrapperNode.Attributes[ "Suffix" ].Value;
                return new Wrapper( prefix, suffix );
            }
            else // (xmlNode["HiddenDragon" != null)
            {
                return new HiddenDragon();
            }
        }

        #endregion Methods 
    }
}