using System;
using System.Xml;
using System.Text.RegularExpressions;
using System.Collections;
using SharpVectors.Dom;
#if TEST
using NUnit.Framework;
#endif
namespace SharpVectors.Dom.Css{
/// <summary>
/// The CSSStyleDeclaration interface represents a single CSS declaration block. This interface may be used to determine the style properties currently set in a block or to set style properties explicitly within the block.
/// While an implementation may not recognize all CSS properties within a CSS declaration block, it is expected to provide access to all specified properties in the style sheet through the CSSStyleDeclaration interface. Furthermore, implementations that support a specific level of CSS should correctly handle CSS shorthand properties for that level. For a further discussion of shorthand properties, see the CSS2Properties interface.
/// This interface is also used to provide a read-only access to the computed values of an element. See also the ViewCSS interface.
/// Note: The CSS Object Model doesn't provide an access to the specified or actual values of the CSS cascade
/// </summary>
/// <developer>niklas@protocol7.com</developer>
/// <completed>80</completed>
public class CssStyleDeclaration : ICssStyleDeclaration
{
#region Static members
private static Regex styleRegex = new Regex(@"^(?<name>[A-Za-z\-0-9]+)\s*:(?<value>[^;\}!]+)(!\s?(?<priority>important))?;?");
#endregion
#region Constructors
/// <summary>
/// The constructor used internally when collecting styles for a specified element
/// </summary>
internal CssStyleDeclaration()
{
_origin = CssStyleSheetType.Collector;
_readOnly = true;
_parentRule = null;
}
/// <summary>
/// The constructor for CssStyleDeclaration
/// </summary>
/// <param name="css">The string to parse for CSS</param>
/// <param name="parentRule">The parent rule or parent stylesheet</param>
/// <param name="readOnly">True if this instance is readonly</param>
/// <param name="origin">The type of CssStyleSheet</param>
public CssStyleDeclaration(ref string css, CssRule parentRule, bool readOnly, CssStyleSheetType origin)
{
_origin = origin;
_readOnly = readOnly;
_parentRule = parentRule;
css = parseString(css);
}
public CssStyleDeclaration(string css, CssRule parentRule, bool readOnly, CssStyleSheetType origin)
{
_origin = origin;
_readOnly = readOnly;
_parentRule = parentRule;
parseString(css);
}
#endregion
#region parseString
private string parseString(string cssText)
{
bool startedWithABracket = false;
cssText = cssText.Trim();
if(cssText.StartsWith("{"))
{
cssText = cssText.Substring(1).Trim();
startedWithABracket = true;
}
Match match = styleRegex.Match(cssText);
while(match.Success)
{
string name = match.Groups["name"].Value;
string value = match.Groups["value"].Value;
if(_parentRule != null)
{
value = ((CssRule)_parentRule).DeReplaceStrings(value);
}
string prio = match.Groups["priority"].Value;
SharpCssStyle style = new SharpCssStyle(name, value, prio, _origin);
bool addStyle = false;
if(styles.ContainsKey(name))
{
string existingPrio = ((SharpCssStyle)styles[name]).Priority;
if(existingPrio != "important" ||
prio == "important")
{
styles.Remove(name);
addStyle = true;
}
}
else
{
addStyle = true;
}
if(addStyle)
{
styles.Add(name, style);
}
cssText = cssText.Substring(match.Length).Trim();
match = styleRegex.Match(cssText);
}
cssText = cssText.Trim();
if(cssText.StartsWith("}"))
{
cssText = cssText.Substring(1);
}
else if(startedWithABracket)
{
throw new DomException(DomExceptionType.SyntaxErr, "Style declaration ending bracket missing");
}
return cssText;
}
#endregion
#region Private fields
private CssStyleSheetType _origin;
private bool _readOnly;
private Hashtable styles = new Hashtable();
#endregion
public bool ReadOnly
{
get
{
return _readOnly;
}
}
public CssStyleSheetType Origin
{
get
{
return _origin;
}
}
#region Public methods
/// <summary>
/// Used to find matching style rules in the cascading order
/// </summary>
internal void GetStylesForElement(CssCollectedStyleDeclaration csd, int specificity)
{
foreach(DictionaryEntry de in styles)
{
SharpCssStyle scs = (SharpCssStyle)de.Value;
csd.CollectProperty(scs.Name, specificity, (CssValue)GetPropertyCssValue(scs.Name), scs.Origin, scs.Priority);
}
}
#endregion
#region Implementation of ICssStyleDeclaration
/// <summary>
/// Used to set a property value and priority within this declaration block
/// </summary>
/// <param name="propertyName">The name of the CSS property. See the CSS property index.</param>
/// <param name="value">The new value of the property.</param>
/// <param name="priority">The new priority of the property (e.g. "important").</param>
/// <exception cref="DomException">SYNTAX_ERR: Raised if the specified value has a syntax error and is unparsable.</exception>
/// <exception cref="DomException">NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is readonly or the property is readonly.</exception>
public void SetProperty(string propertyName, string value, string priority)
{
if(ReadOnly) throw new DomException(DomExceptionType.NoModificationAllowedErr);
styles[propertyName] = new SharpCssStyle(propertyName, value, priority, _origin);
}
/// <summary>
/// Used to retrieve the priority of a CSS property (e.g. the "important" qualifier) if the property has been explicitly set in this declaration block.
/// </summary>
/// <param name="propertyName">The name of the CSS property. See the CSS property index.</param>
/// <returns>A string representing the priority (e.g. "important") if one exists. The empty string if none exists.</returns>
public virtual string GetPropertyPriority(string propertyName)
{
return (styles.ContainsKey(propertyName)) ? ((SharpCssStyle)styles[propertyName]).Priority : String.Empty;
}
/// <summary>
/// Used to remove a CSS property if it has been explicitly set within this declaration block.
/// </summary>
/// <param name="propertyName">The name of the CSS property. See the CSS property index.</param>
/// <returns>Returns the value of the property if it has been explicitly set for this declaration block. Returns the empty string if the property has not been set or the property name does not correspond to a known CSS property.</returns>
/// <exception cref="DomException">NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is readonly or the property is readonly.</exception>
public string RemoveProperty(string propertyName)
{
if(ReadOnly) throw new DomException(DomExceptionType.NoModificationAllowedErr);
if(styles.ContainsKey(propertyName))
{
SharpCssStyle s = (SharpCssStyle)styles[propertyName];
styles.Remove(propertyName);
return s.Value;
}
else return String.Empty;
}
/// <summary>
/// Used to retrieve the object representation of the value of a CSS property if it has been explicitly set within this declaration block. This method returns null if the property is a shorthand property. Shorthand property values can only be accessed and modified as strings, using the getPropertyValue and setProperty methods.
/// </summary>
/// <param name="propertyName">The name of the CSS property. See the CSS property index.</param>
/// <returns>Returns the value of the property if it has been explicitly set for this declaration block. Returns null if the property has not been set.</returns>
public virtual ICssValue GetPropertyCssValue(string propertyName)
{
if(styles.ContainsKey(propertyName))
{
SharpCssStyle scs = (SharpCssStyle)styles[propertyName];
if(scs.CssValue == null)
{
scs.CssValue = CssValue.GetCssValue(scs.Value, ReadOnly);
}
return scs.CssValue;
}
else
{
return null;
}
}
/// <summary>
/// Used to retrieve the value of a CSS property if it has been explicitly set within this declaration block.
/// </summary>
/// <param name="propertyName">The name of the CSS property. See the CSS property index.</param>
/// <returns>Returns the value of the property if it has been explicitly set for this declaration block. Returns the empty string if the property has not been set.</returns>
public virtual string GetPropertyValue(string propertyName)
{
return (styles.ContainsKey(propertyName)) ? ((SharpCssStyle)styles[propertyName]).Value : String.Empty;
}
private ICssRule _parentRule;
/// <summary>
/// The CSS rule that contains this declaration block or null if this CSSStyleDeclaration is not attached to a CSSRule.
/// </summary>
public ICssRule ParentRule
{
get
{
return _parentRule;
}
}
/// <summary>
/// The number of properties that have been explicitly set in this declaration block. The range of valid indices is 0 to length-1 inclusive.
/// </summary>
public virtual ulong Length
{
get
{
return (ulong)styles.Count;
}
}
/// <summary>
/// The parsable textual representation of the declaration block (excluding the surrounding curly braces). Setting this attribute will result in the parsing of the new value and resetting of all the properties in the declaration block including the removal or addition of properties.
/// </summary>
/// <exception cref="DomException">SYNTAX_ERR: Raised if the specified CSS string value has a syntax error and is unparsable.</exception>
/// <exception cref="DomException">NO_MODIFICATION_ALLOWED_ERR: Raised if this declaration is readonly or a property is readonly.</exception>
public virtual string CssText
{
get
{
string ret = String.Empty;
IDictionaryEnumerator enu = styles.GetEnumerator();
while(enu.MoveNext())
{
SharpCssStyle style = (SharpCssStyle)enu.Value;
ret += style.CssText + ";";
}
return ret;
}
set
{
throw new NotImplementedException();
/*if(ReadOnly) throw new DomException("NO_MODIFICATION_ALLOWED_ERR");
else _Csstext = value;*/
}
}
/// <summary>
/// Used to retrieve the properties that have been explicitly set in this declaration block. The order of the properties retrieved using this method does not have to be the order in which they were set. This method can be used to iterate over all properties in this declaration block.
/// The name of the property at this ordinal position. The empty string if no property exists at this position.
/// </summary>
public virtual string this[ulong index]
{
get
{
if(index>=Length) return String.Empty;
else
{
int ind = (int)index;
IDictionaryEnumerator enu = styles.GetEnumerator();
enu.MoveNext();
for(int i = 0; i<ind; i++) enu.MoveNext();
return (string)enu.Key;
}
}
}
#endregion
#region Unit tests
#if TEST
[TestFixture]
public class CssStyleDeclarationTests
{
protected CssXmlElement getElm()
{
return TestUtil.GetXmlElement("<a />", "", "a") as CssXmlElement;
}
protected virtual CssStyleDeclaration getCSD()
{
return getCSD(true);
}
protected virtual CssStyleDeclaration getCSD(bool readOnly)
{
CssStyleSheet ss = new CssStyleSheet(null, "", "", "", null, CssStyleSheetType.Author);
CssRule rule = new CssMediaRule("", ss, false, new string[0], CssStyleSheetType.Author);
string cssText = "{length: \n23cm !important;foo: bar;}";
return new CssStyleDeclaration(ref cssText, rule, readOnly, CssStyleSheetType.Author);
}
[Test]
public void TestCssText()
{
CssStyleDeclaration csd = getCSD();
if(csd.CssText.Equals("length:23cm !important;foo:bar;") ||
csd.CssText.Equals("foo:bar;length:23cm !important;"))
{
}
else
{
Assert.Fail();
}
}
[Test]
public void TestLength()
{
CssStyleDeclaration csd = getCSD();
Assert.AreEqual(2, csd.Length);
}
[Test]
public virtual void TestOrigin()
{
CssStyleDeclaration csd = getCSD();
Assert.AreEqual(CssStyleSheetType.Author, csd.Origin);
}
[Test]
public void TestPropertyValue()
{
CssStyleDeclaration csd = getCSD();
Assert.AreEqual("bar", csd.GetPropertyValue("foo"));
Assert.AreEqual("23cm", csd.GetPropertyValue("length"));
}
[Test]
public void TestPriority()
{
CssStyleDeclaration csd = getCSD();
Assert.AreEqual("", csd.GetPropertyPriority("foo"));
Assert.AreEqual("important", csd.GetPropertyPriority("length"));
}
[Test]
public void TestCssPropertyValue()
{
CssStyleDeclaration csd = getCSD();
CssValue cssValue = (CssValue)csd.GetPropertyCssValue("foo");
Assert.AreEqual("bar", cssValue.CssText);
Assert.AreEqual(CssValueType.PrimitiveValue, cssValue.CssValueType, "1");
cssValue = (CssValue)csd.GetPropertyCssValue("length");
Assert.AreEqual("23cm", cssValue.CssText);
Assert.AreEqual(CssValueType.PrimitiveValue, cssValue.CssValueType, "2");
}
[Test]
[ExpectedException(typeof(DomException))]
public void TestReadOnly()
{
CssStyleDeclaration csd = getCSD();
csd.SetProperty("foo", "bar", "");
}
[Test]
public virtual void TestReadWrite()
{
CssStyleDeclaration csd = getCSD(false);
csd.SetProperty("foo", "newvalue", "");
CssValue cssValue = (CssValue)csd.GetPropertyCssValue("foo");
Assert.AreEqual("newvalue", cssValue.CssText);
Assert.AreEqual("", csd.GetPropertyPriority("foo"));
csd.SetProperty("foo", "value2", "important");
cssValue = (CssValue)csd.GetPropertyCssValue("foo");
Assert.AreEqual("value2", cssValue.CssText);
Assert.AreEqual("important", csd.GetPropertyPriority("foo"));
}
[Test]
public virtual void TestIndex()
{
CssStyleDeclaration csd = getCSD();
if(csd[0].Equals("length") && csd[1].Equals("foo"))
{
}
else if(csd[0].Equals("foo") && csd[1].Equals("length"))
{
}
else
{
Assert.Fail();
}
}
}
#endif
#endregion
}
}
|