mcs/class/System.XML/Mono.Xml.Xsl.Operations/XslVariable.cs

   1 //
   2 // XslVariable.cs
   3 //
   4 // Authors:
   5 //      Ben Maurer (bmaurer@users.sourceforge.net)
   6 //      Atsushi Enomoto (ginga@kit.hi-ho.ne.jp)
   7 //
   8 // (C) 2003 Ben Maurer
   9 // (C) 2003 Atsushi Enomoto
  10 //
  11
  12 //
  13 // Permission is hereby granted, free of charge, to any person obtaining
  14 // a copy of this software and associated documentation files (the
  15 // "Software"), to deal in the Software without restriction, including
  16 // without limitation the rights to use, copy, modify, merge, publish,
  17 // distribute, sublicense, and/or sell copies of the Software, and to
  18 // permit persons to whom the Software is furnished to do so, subject to
  19 // the following conditions:
  20 //
  21 // The above copyright notice and this permission notice shall be
  22 // included in all copies or substantial portions of the Software.
  23 //
  24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31 //
  32
  33 using System;
  34 using System.Collections;
  35 using System.Xml;
  36 using System.Xml.XPath;
  37 using System.Xml.Xsl;
  38 using Mono.Xml.XPath;
  39
  40 using QName = System.Xml.XmlQualifiedName;
  41
  42 namespace Mono.Xml.Xsl.Operations {
  43
  44         internal class XslVariableInformation
  45         {
  46                 QName name;
  47                 XPathExpression select;
  48                 XslOperation content;
  49
  50                 public XslVariableInformation (Compiler c)
  51                 {
  52                         c.AssertAttribute ("name");
  53                         c.Input.MoveToFirstAttribute ();
  54                         do {
  55                                 if (c.Input.NamespaceURI != String.Empty)
  56                                         continue;
  57                                 switch (c.Input.LocalName) {
  58                                 case "name":
  59                                 case "select":
  60                                         break;
  61                                 default:
  62                                         throw new XsltCompileException ("Invalid attribute " + c.Input.Name, null, c.Input);
  63                                 }
  64                         } while (c.Input.MoveToNextAttribute ());
  65                         c.Input.MoveToParent ();
  66
  67                         name = c.ParseQNameAttribute ("name");
  68                         try {
  69                                 XmlConvert.VerifyName (name.Name);
  70                         } catch (XmlException ex) {
  71                                 throw new XsltCompileException ("Variable name is not qualified name.", ex, c.Input);
  72                         }
  73
  74                         string sel = c.GetAttribute ("select");
  75                         if (sel != null && sel != "" ) {
  76                                 select = c.CompileExpression (c.GetAttribute ("select"));
  77                                 // TODO assert empty
  78                         } else  if (c.Input.MoveToFirstChild ()) {
  79                                 content = c.CompileTemplateContent ();
  80                                 c.Input.MoveToParent ();
  81                         }
  82                 }
  83
  84                 public object Evaluate (XslTransformProcessor p)
  85                 {
  86                         if (select != null) {
  87                                 object o = p.Evaluate (select);
  88                                 // To resolve variable references correctly, we
  89                                 // have to collect all the target nodes here.
  90                                 // (otherwise, variables might be resolved with
  91                                 // different level of variable stack in
  92                                 // XslTransformProcessor).
  93                                 if (o is XPathNodeIterator) {
  94                                         ArrayList al = new ArrayList ();
  95                                         XPathNodeIterator iter = (XPathNodeIterator) o;
  96                                         while (iter.MoveNext ())
  97                                                 al.Add (iter.Current);
  98                                         o = new ListIterator (al, p.XPathContext, false);
  99                                 }
 100                                 return o;
 101                         } else if (content != null) {
 102 //                              XmlNodeWriter w = new XmlNodeWriter (false);
 103 //                              DTMXPathDocumentWriter w = new DTMXPathDocumentWriter (p.CurrentNode.NameTable, 200);
 104                                 DTMXPathDocumentWriter2 w = new DTMXPathDocumentWriter2 (p.CurrentNode.NameTable, 200);
 105                                 Outputter outputter = new GenericOutputter(w, p.Outputs, null, true);
 106                                 p.PushOutput (outputter);
 107                                 content.Evaluate (p);
 108                                 p.PopOutput ();
 109 //                              return w.Document.CreateNavigator ().SelectChildren (XPathNodeType.All);
 110 //                              return w.CreateDocument ().CreateNavigator ().SelectChildren (XPathNodeType.All);
 111 //                              return w.Document.CreateNavigator ();
 112                                 return w.CreateDocument ().CreateNavigator ();
 113                         } else {
 114                                 return "";
 115                         }
 116                 }
 117
 118                 public QName Name { get { return name; }}
 119
 120                 internal XPathExpression Select {
 121                         get { return select; }
 122                 }
 123
 124                 internal XslOperation Content {
 125                         get { return content; }
 126                 }
 127         }
 128
 129         internal abstract class XslGeneralVariable : XslCompiledElement, IXsltContextVariable {
 130                 protected XslVariableInformation var;
 131
 132                 public XslGeneralVariable (Compiler c) : base (c) {}
 133
 134                 protected override void Compile (Compiler c)
 135                 {
 136                         this.var = new XslVariableInformation (c);
 137                 }
 138
 139                 public override abstract void Evaluate (XslTransformProcessor p);
 140                 protected abstract object GetValue (XslTransformProcessor p);
 141
 142
 143                 public object Evaluate (XsltContext xsltContext)
 144                 {
 145                         object value = GetValue (((XsltCompiledContext)xsltContext).Processor);
 146
 147                         if (value is XPathNodeIterator)
 148                                 return ((XPathNodeIterator)value).Clone ();
 149
 150                         return value;
 151                 }
 152
 153                 public QName Name {get {return  var.Name;}}
 154                 public XPathResultType VariableType { get {return XPathResultType.Any;}}
 155                 public abstract bool IsLocal { get; }
 156                 public abstract bool IsParam { get; }
 157         }
 158
 159         internal class XslGlobalVariable : XslGeneralVariable {
 160                 public XslGlobalVariable (Compiler c) : base (c) {}
 161                 static object busyObject = new Object ();
 162
 163
 164                 public override void Evaluate (XslTransformProcessor p)
 165                 {
 166                         Hashtable varInfo = p.globalVariableTable;
 167
 168                         if (varInfo.Contains (this)) {
 169                                 if (varInfo [this] == busyObject)
 170                                         throw new XsltException ("Circular dependency was detected.", null, p.CurrentNode);
 171                                 return;
 172                         }
 173
 174                         varInfo [this] = busyObject;
 175                         varInfo [this] = var.Evaluate (p);
 176
 177                 }
 178
 179                 protected override object GetValue (XslTransformProcessor p)
 180                 {
 181                         Evaluate (p);
 182                         return p.globalVariableTable [this];
 183                 }
 184
 185                 public override bool IsLocal { get { return false; }}
 186                 public override bool IsParam { get { return false; }}
 187         }
 188
 189         internal class XslGlobalParam : XslGlobalVariable {
 190
 191                 public XslGlobalParam (Compiler c) : base (c) {}
 192
 193                 public void Override (XslTransformProcessor p, object paramVal)
 194                 {
 195                         Debug.Assert (!p.globalVariableTable.Contains (this), "Shouldn't have been evaluated by this point");
 196
 197                         p.globalVariableTable [this] = paramVal;
 198                 }
 199
 200                 public override bool IsParam { get { return true; }}
 201         }
 202
 203         internal class XslLocalVariable : XslGeneralVariable {
 204                 protected int slot;
 205
 206                 public XslLocalVariable (Compiler c) : base (c)
 207                 {
 208                         slot = c.AddVariable (this);
 209                 }
 210
 211                 public override void Evaluate (XslTransformProcessor p)
 212                 {
 213                         p.SetStackItem (slot, var.Evaluate (p));
 214                 }
 215
 216                 protected override object GetValue (XslTransformProcessor p)
 217                 {
 218                         return p.GetStackItem (slot);
 219                 }
 220
 221                 public bool IsEvaluated (XslTransformProcessor p)
 222                 {
 223                         return p.GetStackItem (slot) != null;
 224                 }
 225
 226                 public override bool IsLocal { get { return true; }}
 227                 public override bool IsParam { get { return false; }}
 228         }
 229
 230         internal class XslLocalParam : XslLocalVariable {
 231
 232                 public XslLocalParam (Compiler c) : base (c) {}
 233
 234                 public override void Evaluate (XslTransformProcessor p)
 235                 {
 236                         if (p.GetStackItem (slot) != null)
 237                                 return; // evaluated already
 238
 239                         if (p.Arguments != null &&
 240                                 var.Select == null &&
 241                                 var.Content == null) {
 242                                 object val = p.Arguments.GetParam (Name.Name,
 243                                         Name.Namespace);
 244                                 if (val != null) {
 245                                         Override (p, val);
 246                                         return;
 247                                 }
 248                         }
 249
 250                         base.Evaluate (p);
 251                 }
 252
 253                 public void Override (XslTransformProcessor p, object paramVal)
 254                 {
 255                         p.SetStackItem (slot, paramVal);
 256                 }
 257
 258                 public override bool IsParam { get { return true; }}
 259         }
 260
 261         internal class XPathVariableBinding : Expression {
 262                 XslGeneralVariable v;
 263                 public XPathVariableBinding (XslGeneralVariable v)
 264                 {
 265                         this.v = v;
 266                 }
 267                 public override String ToString () { return "$" + v.Name.ToString (); }
 268                 public override XPathResultType ReturnType { get { return XPathResultType.Any; }}
 269                 public override XPathResultType GetReturnType (BaseIterator iter)
 270                 {
 271                         return XPathResultType.Any;
 272                 }
 273
 274                 public override object Evaluate (BaseIterator iter)
 275                 {
 276                         return v.Evaluate (iter.NamespaceManager as XsltContext);
 277                 }
 278         }
 279 }