Menu
▾
▴
[mvp-xml-cvs] XPointer/v1/src IDAssuredValidatingReader.cs,1.1,1.2 Pointer.cs,1.3,1.4 XPointer.csproj,1.6,1.7 XPointerException.cs,1.2,1.3 XPointerReader.cs,1.9,1.10
|
From: Oleg T. <he...@us...> - 2004-11-07 16:48:03
|
Update of /cvsroot/mvp-xml/XPointer/v1/src In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv493/v1/src Modified Files: IDAssuredValidatingReader.cs Pointer.cs XPointer.csproj XPointerException.cs XPointerReader.cs Log Message: Documenation stuff. Index: Pointer.cs =================================================================== RCS file: /cvsroot/mvp-xml/XPointer/v1/src/Pointer.cs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- Pointer.cs 31 Oct 2004 08:07:15 -0000 1.3 +++ Pointer.cs 7 Nov 2004 16:47:53 -0000 1.4 @@ -16,7 +16,7 @@ #region public methods /// <summary> - /// Parses <see cref="XPointer"/> pointer and compiles it into + /// Parses XPointer pointer and compiles it into /// an instance of <see cref="Pointer"/> class. /// </summary> /// <param name="xpointer">XPointer pointer</param> Index: XPointerException.cs =================================================================== RCS file: /cvsroot/mvp-xml/XPointer/v1/src/XPointerException.cs,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- XPointerException.cs 4 Nov 2004 15:49:44 -0000 1.2 +++ XPointerException.cs 7 Nov 2004 16:47:53 -0000 1.3 @@ -11,21 +11,67 @@ /// </summary> public abstract class XPointerException : Exception { + /// <summary> + /// Initializes a new instance of the <see cref="ApplicationException"/> + /// class with a specified error message. + /// </summary> + /// <param name="message">Error message</param> public XPointerException(string message) : base(message) {} + + /// <summary> + /// Initializes a new instance of the <see cref="ApplicationException"/> + /// class with a specified error message and a reference to the + /// inner exception that is the cause of this exception. + /// </summary> + /// <param name="message">Error message</param> + /// <param name="innerException">Inner exception</param> public XPointerException(string message, Exception innerException) : base(message, innerException) {} } + /// <summary> + /// XPointer Framework syntax error. + /// </summary> public class XPointerSyntaxException : XPointerException { + /// <summary> + /// Initializes a new instance of the <see cref="XPointerSyntaxException"/> + /// class with a specified error message. + /// </summary> + /// <param name="message">Error message</param> public XPointerSyntaxException(string message) : base(message) {} + + /// <summary> + /// Initializes a new instance of the <see cref="XPointerSyntaxException"/> + /// class with a specified error message and a reference to the + /// inner exception that is the cause of this exception. + /// </summary> + /// <param name="message">Error message</param> + /// <param name="innerException">Inner exception</param> public XPointerSyntaxException(string message, Exception innerException) : base(message, innerException) {} } + /// <summary> + /// XPointer doesn't identify any subresources - it's an error as per + /// XPointer Framework. + /// </summary> public class NoSubresourcesIdentifiedException : XPointerException { + /// <summary> + /// Initializes a new instance of the <see cref="NoSubresourcesIdentifiedException"/> + /// class with a specified error message. + /// </summary> + /// <param name="message">Error message</param> public NoSubresourcesIdentifiedException(string message) : base(message) {} + + /// <summary> + /// Initializes a new instance of the <see cref="NoSubresourcesIdentifiedException"/> + /// class with a specified error message and a reference to the + /// inner exception that is the cause of this exception. + /// </summary> + /// <param name="message">Error message</param> + /// <param name="innerException">Inner exception</param> public NoSubresourcesIdentifiedException(string message, Exception innerException) : base(message, innerException) {} } Index: XPointer.csproj =================================================================== RCS file: /cvsroot/mvp-xml/XPointer/v1/src/XPointer.csproj,v retrieving revision 1.6 retrieving revision 1.7 diff -u -d -r1.6 -r1.7 --- XPointer.csproj 28 Oct 2004 18:21:23 -0000 1.6 +++ XPointer.csproj 7 Nov 2004 16:47:53 -0000 1.7 @@ -29,7 +29,7 @@ CheckForOverflowUnderflow = "false" ConfigurationOverrideFile = "" DefineConstants = "DEBUG;TRACE" - DocumentationFile = "" + DocumentationFile = "Mvp.Xml.XPointer.xml" DebugSymbols = "true" FileAlignment = "4096" IncrementalBuild = "false" Index: IDAssuredValidatingReader.cs =================================================================== RCS file: /cvsroot/mvp-xml/XPointer/v1/src/IDAssuredValidatingReader.cs,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- IDAssuredValidatingReader.cs 11 Oct 2004 20:55:37 -0000 1.1 +++ IDAssuredValidatingReader.cs 7 Nov 2004 16:47:53 -0000 1.2 @@ -4,81 +4,92 @@ #endregion -/// <summary> -/// Auxillary XmlReader that always reports dummy DOCTYPE. This is done -/// to turn on support for id() function in XML Schema defined XML documents. -/// See http://www.tkachenko.com/blog/archives/000060.html. -/// </summary> -public class IdAssuredValidatingReader : XmlValidatingReader +namespace Mvp.Xml.XPointer { - #region private members - private bool _exposeDummyDoctype; - private bool _isInProlog = true; + /// <summary> + /// Auxillary XmlReader that always reports dummy DOCTYPE. This is done + /// to turn on support for id() function in XML Schema defined XML documents. + /// See http://www.tkachenko.com/blog/archives/000060.html. + /// </summary> + internal class IdAssuredValidatingReader : XmlValidatingReader + { + #region private members - #endregion + private bool _exposeDummyDoctype; + private bool _isInProlog = true; - #region constructors - - public IdAssuredValidatingReader(XmlReader r) : base (r) {} + #endregion - #endregion + #region constructors + + /// <summary> + /// Constructs <c>IdAssuredValidatingReader</c> on top of another reader. + /// </summary> + /// <param name="r"></param> + public IdAssuredValidatingReader(XmlReader r) : base (r) {} - #region XmlValidatingReader overrides + #endregion + + #region XmlValidatingReader overrides - public override XmlNodeType NodeType - { - get - { - return _exposeDummyDoctype ? - XmlNodeType.DocumentType : - base.NodeType; - } - } + /// <summary>See <see cref="XmlValidatingReader.NodeType"/>.</summary> + public override XmlNodeType NodeType + { + get + { + return _exposeDummyDoctype ? + XmlNodeType.DocumentType : + base.NodeType; + } + } - public override bool MoveToNextAttribute() - { - return _exposeDummyDoctype? - false : - base.MoveToNextAttribute(); - } + /// <summary>See <see cref="XmlValidatingReader.MoveToNextAttribute"/>.</summary> + public override bool MoveToNextAttribute() + { + return _exposeDummyDoctype? + false : + base.MoveToNextAttribute(); + } - public override bool Read() - { - if (_isInProlog) + /// <summary>See <see cref="XmlValidatingReader.Read"/>.</summary> + public override bool Read() { - if (!_exposeDummyDoctype) + if (_isInProlog) { - //We are looking for the very first element - bool baseRead = base.Read(); - if (base.NodeType == XmlNodeType.Element) + if (!_exposeDummyDoctype) { - _exposeDummyDoctype = true; - return true; + //We are looking for the very first element + bool baseRead = base.Read(); + if (base.NodeType == XmlNodeType.Element) + { + _exposeDummyDoctype = true; + return true; + } + else if (base.NodeType == XmlNodeType.DocumentType) + { + //Document has own DOCTYPE, switch back to normal flow + _exposeDummyDoctype = false; + _isInProlog = false; + return true; + } + else + { + return baseRead; + } } - else if (base.NodeType == XmlNodeType.DocumentType) + else { - //Document has own DOCTYPE, switch back to normal flow + //Done, switch back to normal flow _exposeDummyDoctype = false; _isInProlog = false; return true; } - else - { - return baseRead; - } } - else - { - //Done, switch back to normal flow - _exposeDummyDoctype = false; - _isInProlog = false; - return true; - } - } - else - return base.Read(); - } + else + return base.Read(); + } - #endregion + #endregion + } } \ No newline at end of file Index: XPointerReader.cs =================================================================== RCS file: /cvsroot/mvp-xml/XPointer/v1/src/XPointerReader.cs,v retrieving revision 1.9 retrieving revision 1.10 diff -u -d -r1.9 -r1.10 --- XPointerReader.cs 7 Nov 2004 14:50:34 -0000 1.9 +++ XPointerReader.cs 7 Nov 2004 16:47:53 -0000 1.10 @@ -14,8 +14,12 @@ namespace Mvp.Xml.XPointer { /// <summary> - /// XPointer-aware XmlReader. + /// <c>XPointerReader</c> implements XPointer Framework in + /// a fast, non-caching, forward-only way. <c>XPointerReader</c> + /// supports XPointer Framework, element(), xmlns(), xpath1() and + /// xpointer() (XPath subset only) XPointer schemes. /// </summary> + /// <remarks>See <a href="http://mvp-xml.sf.net/xpointer">XPointer.NET homepage</a> for more info.</remarks> /// <author>Oleg Tkachenko, ol...@tk...</author> public class XPointerReader : XmlReader, IHasXPathNavigator { @@ -192,193 +196,231 @@ #endregion #region XmlReader overrides - + + /// <summary>See <see cref="XmlReader.AttributeCount"/>.</summary> public override int AttributeCount { get { return _reader.AttributeCount; } } + /// <summary>See <see cref="XmlReader.BaseURI"/>.</summary> public override string BaseURI { get { return _reader.BaseURI; } } + /// <summary>See <see cref="XmlReader.HasValue"/>.</summary> public override bool HasValue { get { return _reader.HasValue; } } + /// <summary>See <see cref="XmlReader.IsDefault"/>.</summary> public override bool IsDefault { get { return _reader.IsDefault; } } + /// <summary>See <see cref="XmlReader.Name"/>.</summary> public override string Name { get { return _reader.Name; } } + /// <summary>See <see cref="XmlReader.LocalName"/>.</summary> public override string LocalName { get { return _reader.LocalName; } } + /// <summary>See <see cref="XmlReader.NamespaceURI"/>.</summary> public override string NamespaceURI { get { return _reader.NamespaceURI; } } + /// <summary>See <see cref="XmlReader.NameTable"/>.</summary> public override XmlNameTable NameTable { get{ return _reader.NameTable; } } + /// <summary>See <see cref="XmlReader.NodeType"/>.</summary> public override XmlNodeType NodeType { get { return _reader.NodeType; } } + /// <summary>See <see cref="XmlReader.Prefix"/>.</summary> public override string Prefix { get { return _reader.Prefix; } } + /// <summary>See <see cref="XmlReader.QuoteChar"/>.</summary> public override char QuoteChar { get { return _reader.QuoteChar; } } + /// <summary>See <see cref="XmlReader.Close"/>.</summary> public override void Close() { if (_reader != null) _reader.Close(); } + /// <summary>See <see cref="XmlReader.Depth"/>.</summary> public override int Depth { get { return _reader.Depth; } } + /// <summary>See <see cref="XmlReader.EOF"/>.</summary> public override bool EOF { get { return _reader.EOF; } } + /// <summary>See <see cref="XmlReader.GetAttribute"/>.</summary> public override string GetAttribute(int i) { return _reader.GetAttribute(i); } + /// <summary>See <see cref="XmlReader.GetAttribute"/>.</summary> public override string GetAttribute(string name) { return _reader.GetAttribute(name); } + /// <summary>See <see cref="XmlReader.GetAttribute"/>.</summary> public override string GetAttribute(string name, string namespaceURI) { return _reader.GetAttribute(name, namespaceURI); } + /// <summary>See <see cref="XmlReader.IsEmptyElement"/>.</summary> public override bool IsEmptyElement { get { return _reader.IsEmptyElement; } } + /// <summary>See <see cref="XmlReader.LookupNamespace"/>.</summary> public override String LookupNamespace(String prefix) { return _reader.LookupNamespace(prefix); } + /// <summary>See <see cref="XmlReader.MoveToAttribute"/>.</summary> public override void MoveToAttribute(int i) { _reader.MoveToAttribute(i); } + /// <summary>See <see cref="XmlReader.MoveToAttribute"/>.</summary> public override bool MoveToAttribute(string name) { return _reader.MoveToAttribute(name); } + /// <summary>See <see cref="XmlReader.MoveToAttribute"/>.</summary> public override bool MoveToAttribute(string name, string ns) { return _reader.MoveToAttribute(name, ns); } + /// <summary>See <see cref="XmlReader.MoveToElement"/>.</summary> public override bool MoveToElement() { return _reader.MoveToElement(); } + /// <summary>See <see cref="XmlReader.MoveToFirstAttribute"/>.</summary> public override bool MoveToFirstAttribute() { return _reader.MoveToFirstAttribute(); } + /// <summary>See <see cref="XmlReader.MoveToNextAttribute"/>.</summary> public override bool MoveToNextAttribute() { return _reader.MoveToNextAttribute(); } + /// <summary>See <see cref="XmlReader.ReadAttributeValue"/>.</summary> public override bool ReadAttributeValue() { return _reader.ReadAttributeValue(); } - + + /// <summary>See <see cref="XmlReader.ReadState"/>.</summary> public override ReadState ReadState { get { return _reader.ReadState; } } + /// <summary>See <see cref="XmlReader.this"/>.</summary> public override String this [int i] { get { return _reader[i]; } } + /// <summary>See <see cref="XmlReader.this"/>.</summary> public override string this [string name] { get { return _reader[name]; } } + /// <summary>See <see cref="XmlReader.this"/>.</summary> public override string this [string name, string namespaceURI] { get { return _reader[name, namespaceURI]; } } + /// <summary>See <see cref="XmlReader.ResolveEntity"/>.</summary> public override void ResolveEntity() { _reader.ResolveEntity(); } + /// <summary>See <see cref="XmlReader.XmlLang"/>.</summary> public override string XmlLang { get { return _reader.XmlLang; } } + /// <summary>See <see cref="XmlReader.XmlSpace"/>.</summary> public override XmlSpace XmlSpace { get { return _reader.XmlSpace; } } + /// <summary>See <see cref="XmlReader.Value"/>.</summary> public override string Value { get { return _reader.Value; } } + /// <summary>See <see cref="XmlReader.ReadInnerXml"/>.</summary> public override string ReadInnerXml() { return _reader.ReadInnerXml(); } + /// <summary>See <see cref="XmlReader.ReadOuterXml"/>.</summary> public override string ReadOuterXml() { return _reader.ReadOuterXml(); } + /// <summary>See <see cref="XmlReader.ReadString"/>.</summary> public override string ReadString() { return _reader.ReadString(); } + /// <summary>See <see cref="XmlReader.Read"/>.</summary> public override bool Read() { bool baseRead = _reader.Read(); |
