Click here to Skip to main content
15,885,985 members
Articles / Web Development / CSS3

AngleSharp

Rate me:
Please Sign up or sign in to vote.
5.00/5 (87 votes)
3 Jul 2013BSD28 min read 261.7K   4.3K   166  
Bringing the DOM to C# with a HTML5/CSS3 parser written in C#.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.CompilerServices;

namespace AngleSharp.DOM.Collections
{
    /// <summary>
    /// Represents a list of DOMTokens.
    /// </summary>
    [DOM("DOMTokenList")]
    public sealed class DOMTokenList : IHTMLObject, IEnumerable<String>
    {
        #region Members

        List<String> tokens;
        String oldTokenString;
        Func<String> getter;
        Action<String> setter;

        #endregion

        #region ctor

        /// <summary>
        /// Creates a new list of tokens.
        /// </summary>
        internal DOMTokenList()
        {
            tokens = new List<string>();
        }

        /// <summary>
        /// Creates a bound DOMTokenList from the given properties.
        /// </summary>
        /// <param name="getter">The access to the getter property part.</param>
        /// <param name="setter">The access to the setter property part.</param>
        /// <returns>The DOMTokenList.</returns>
        internal static DOMTokenList From(Func<string> getter, Action<string> setter)
        {
            var list = new DOMTokenList();

            list.getter = getter;
            list.setter = setter;

            return list;
        }

        #endregion

        #region Properties

        /// <summary>
        /// Gets the number of tokens.
        /// </summary>
        [DOM("length")]
        public Int32 Length
        {
            get
            {
                GetValue(); 
                return tokens.Count;
            }
        }

        /// <summary>
        /// Gets an item in the list by its index.
        /// </summary>
        /// <param name="index">The index of the token.</param>
        /// <returns>The token at the specified index.</returns>
        [DOM("item")]
        public String this[Int32 index]
        {
            get
            {
                GetValue();

                if (index < 0 || index >= tokens.Count)
                    return null;

                return tokens[index];
            }
        }

        #endregion

        #region Methods

        /// <summary>
        /// Returns true if the underlying string contains token, otherwise false.
        /// </summary>
        /// <param name="token">The token to consider.</param>
        /// <returns>True if the string contained the token, otherwise false.</returns>
        [DOM("contains")]
        public Boolean Contains(String token)
        {
            GetValue();

            if(tokens.Contains(token))
                return true;

            return false;
        }

        /// <summary>
        /// Remove token from the underlying string.
        /// </summary>
        /// <param name="token">The token to remove.</param>
        /// <returns>The current token list.</returns>
        [DOM("remove")]
        public DOMTokenList Remove(String token)
        {
            GetValue();
            tokens.Remove(token);
            SetValue();
            return this;
        }

        /// <summary>
        /// Adds token to the underlying string.
        /// </summary>
        /// <param name="token">The token to add.</param>
        /// <returns>The current token list.</returns>
        [DOM("add")]
        public DOMTokenList Add(String token)
        {
            GetValue();

            if (!tokens.Contains(token))
            {
                tokens.Add(token);
                SetValue();
            }

            return this;
        }

        /// <summary>
        /// Removes token from string and returns false. If token doesn't exist it's added and the function returns true.
        /// </summary>
        /// <param name="token">The token to consider.</param>
        /// <returns>True if the string contained the token, otherwise false.</returns>
        [DOM("toggle")]
        public Boolean Toggle(String token)
        {
            GetValue();

            if (tokens.Contains(token))
            {
                tokens.Remove(token);
                SetValue();
                return false;
            }

            tokens.Add(token);
            SetValue();
            return true;
        }

        #endregion

        #region Internal methods

        /// <summary>
        /// Returns true if the underlying string contains at least one of the tokens, otherwise false.
        /// </summary>
        /// <param name="tokens">The tokens to consider.</param>
        /// <returns>True if the string contained a token, otherwise false.</returns>
        internal Boolean Contains(String[] tokens)
        {
            GetValue();

            for (int i = 0; i < tokens.Length; i++)
                if (this.tokens.Contains(tokens[i]))
                    return true;

            return false;
        }

        #endregion

        #region Helper

        /// <summary>
        /// Gets the current value from the getter.
        /// </summary>
        void GetValue()
        {
            if (getter != null)
            {
                var str = getter();

                if (str != oldTokenString)
                {
                    tokens.Clear();
                    oldTokenString = str;
                    var strs = str.SplitSpaces();

                    for (int i = 0; i < strs.Length; i++)
                        if (!tokens.Contains(strs[i]))
                            tokens.Add(strs[i]);
                }
            }
        }

        /// <summary>
        /// Sets the currnt value using the setter.
        /// </summary>
        void SetValue()
        {
            oldTokenString = String.Join(" ", tokens);

            if (setter != null)
                setter(oldTokenString);
        }

        #endregion

        #region IEnumerable implementation

        /// <summary>
        /// Returns an enumerator that iterates through the strings in the collection.
        /// </summary>
        /// <returns>An enumerator that can be used to iterate through the tokens.</returns>
        public IEnumerator<String> GetEnumerator()
        {
            GetValue();
            return tokens.GetEnumerator();
        }

        /// <summary>
        /// Returns an enumerator that iterates through the strings in the collection.
        /// </summary>
        /// <returns>An enumerator that can be used to iterate through the tokens.</returns>
        IEnumerator IEnumerable.GetEnumerator()
        {
            return GetEnumerator();
        }

        #endregion

        #region String representation

        /// <summary>
        /// Returns an HTML-code representation of the token list.
        /// </summary>
        /// <returns>A string containing the HTML code.</returns>
        public String ToHtml()
        {
            return oldTokenString;
        }

        #endregion
    }
}

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 BSD License


Written By
Chief Technology Officer
Germany Germany
Florian lives in Munich, Germany. He started his programming career with Perl. After programming C/C++ for some years he discovered his favorite programming language C#. He did work at Siemens as a programmer until he decided to study Physics.

During his studies he worked as an IT consultant for various companies. After graduating with a PhD in theoretical particle Physics he is working as a senior technical consultant in the field of home automation and IoT.

Florian has been giving lectures in C#, HTML5 with CSS3 and JavaScript, software design, and other topics. He is regularly giving talks at user groups, conferences, and companies. He is actively contributing to open-source projects. Florian is the maintainer of AngleSharp, a completely managed browser engine.

Comments and Discussions