mcs/class/System.XML/Mono.Xml.Xsl/XslTemplate.cs

   1 //
   2 // XslTemplate.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.Globalization;
  36 using System.Xml;
  37 using System.Xml.XPath;
  38 using System.Xml.Xsl;
  39 using Mono.Xml.Xsl.Operations;
  40 using Mono.Xml.XPath;
  41
  42 using QName = System.Xml.XmlQualifiedName;
  43
  44 namespace Mono.Xml.Xsl {
  45         internal class XslModedTemplateTable {
  46
  47                 class TemplateWithPriority : IComparable {
  48                         public readonly double Priority;
  49                         public readonly XslTemplate Template;
  50                         public readonly Pattern Pattern;
  51                         public readonly int TemplateID;
  52
  53                         public TemplateWithPriority (XslTemplate t, Pattern p)
  54                         {
  55                                 Template = t;
  56                                 Pattern = p;
  57                                 Priority = p.DefaultPriority;
  58                                 TemplateID = t.Id;
  59                         }
  60
  61                         public TemplateWithPriority (XslTemplate t, double p)
  62                         {
  63                                 Template = t;
  64                                 Pattern = t.Match;
  65                                 Priority = p;
  66                                 TemplateID = t.Id;
  67                         }
  68
  69                         public int CompareTo (object o)
  70                         {
  71                                 TemplateWithPriority a = this,
  72                                         b = (TemplateWithPriority)o;
  73
  74                                 //Debug.WriteLine (a.Pattern.ToString () + " ? " + b.Pattern.ToString ());
  75                                 //Debug.WriteLine (a.Priority + "   " + b.Priority);
  76
  77                                 int r0 = a.Priority.CompareTo (b.Priority);
  78                                 //Debug.WriteLine (r0);
  79                                 if (r0 != 0) return r0;
  80
  81                                 int r1 = a.TemplateID.CompareTo (b.TemplateID);
  82                                 //Debug.WriteLine (r1);
  83                                 return r1;
  84                         }
  85
  86                         public bool Matches (XPathNavigator n, XslTransformProcessor p)
  87                         {
  88                                 //Debug.WriteLine (Pattern.ToString ());
  89                                 return p.Matches (Pattern, n);
  90                         }
  91                 }
  92
  93                 // [QName name]=>XslTemplate
  94
  95                 ArrayList unnamedTemplates = new ArrayList ();
  96
  97                 XmlQualifiedName mode;
  98
  99                 public XslModedTemplateTable (XmlQualifiedName mode)
 100                 {
 101                         if (mode == null)
 102                                 throw new InvalidOperationException ();
 103                         this.mode = mode;
 104                 }
 105
 106                 public XmlQualifiedName Mode {
 107                         get { return mode; }
 108                 }
 109
 110                 public void Add (XslTemplate t)
 111                 {
 112                         if (!double.IsNaN (t.Priority))
 113                                 unnamedTemplates.Add (new TemplateWithPriority (t, t.Priority));
 114                         else
 115                                 Add (t, t.Match);
 116                 }
 117
 118                 public void Add (XslTemplate t, Pattern p)
 119                 {
 120                         if (p is UnionPattern) {
 121                                 Add (t, ((UnionPattern)p).p0);
 122                                 Add (t, ((UnionPattern)p).p1);
 123                                 return;
 124                         }
 125
 126                         unnamedTemplates.Add (new TemplateWithPriority (t, p));
 127                 }
 128
 129                 bool sorted = false;
 130
 131                 public XslTemplate FindMatch (XPathNavigator node, XslTransformProcessor p)
 132                 {
 133                         //Debug.WriteLine ("...");
 134                         if (!sorted) {
 135                                 unnamedTemplates.Sort ();
 136                                 unnamedTemplates.Reverse ();
 137
 138                                 sorted = true;
 139                         }
 140
 141                         for (int i = 0; i < unnamedTemplates.Count; i++) {
 142                                 TemplateWithPriority t = (TemplateWithPriority) unnamedTemplates [i];
 143                                 if (t.Matches (node, p))
 144                                         return t.Template;
 145                         }
 146
 147                         return null;
 148                 }
 149         }
 150
 151         internal class XslTemplateTable {
 152                 // [QName mode]=>XslTemplateTable
 153                 Hashtable templateTables = new Hashtable ();
 154                 Hashtable namedTemplates = new Hashtable ();
 155                 XslStylesheet parent;
 156
 157                 public XslTemplateTable (XslStylesheet parent)
 158                 {
 159                         this.parent = parent;
 160                 }
 161
 162                 public Hashtable TemplateTables {
 163                         get { return templateTables; }
 164                 }
 165
 166                 public XslModedTemplateTable this [XmlQualifiedName mode] {
 167                         get {
 168                                 return templateTables [mode] as XslModedTemplateTable;
 169                         }
 170                 }
 171
 172                 public void Add (XslTemplate template)
 173                 {
 174                         if (template.Name != XmlQualifiedName.Empty) {
 175                                 if (namedTemplates [template.Name] != null)
 176                                         throw new InvalidOperationException ("Named template " + template.Name + " is already registered.");
 177
 178                                 namedTemplates [template.Name] = template;
 179                         }
 180
 181                         if (template.Match == null) return;
 182
 183                         XslModedTemplateTable tbl = this [template.Mode];
 184                         if (tbl == null) {
 185                                 tbl = new XslModedTemplateTable (template.Mode);
 186                                 Add (tbl);
 187                         }
 188
 189                         tbl.Add (template);
 190                 }
 191
 192                 public void Add (XslModedTemplateTable table)
 193                 {
 194                         if (this [table.Mode] != null)
 195                                 throw new InvalidOperationException ("Mode " + table.Mode + " is already registered.");
 196                         templateTables.Add (table.Mode, table);
 197                 }
 198
 199                 public XslTemplate FindMatch (XPathNavigator node, XmlQualifiedName mode, XslTransformProcessor p)
 200                 {
 201                         XslTemplate ret;
 202
 203                         if (this [mode] != null)
 204                         {
 205                                 ret =  this [mode].FindMatch (node, p);
 206                                 if (ret != null) return ret;
 207                         }
 208
 209                         for (int i = parent.Imports.Count - 1; i >= 0; i--)
 210                         {
 211                                 XslStylesheet s = (XslStylesheet)parent.Imports [i];
 212                                 ret = s.Templates.FindMatch (node, mode, p);
 213                                 if (ret != null)
 214                                         return ret;
 215                         }
 216
 217                         return null;
 218                 }
 219
 220                 public XslTemplate FindTemplate (XmlQualifiedName name)
 221                 {
 222                         XslTemplate ret = (XslTemplate)namedTemplates [name];
 223
 224                         if (ret != null) return ret;
 225
 226                         for (int i = parent.Imports.Count - 1; i >= 0; i--) {
 227                                 XslStylesheet s = (XslStylesheet)parent.Imports [i];
 228                                 ret = s.Templates.FindTemplate (name);
 229                                 if (ret != null)
 230                                         return ret;
 231                         }
 232
 233                         return null;
 234                 }
 235         }
 236
 237         internal class XslTemplate
 238         {
 239                 XmlQualifiedName name;
 240                 Pattern match;
 241                 XmlQualifiedName mode;
 242                 double priority = double.NaN;
 243                 ArrayList parameters;
 244                 XslOperation content;
 245
 246                 static int nextId = 0;
 247                 public readonly int Id = nextId ++;
 248
 249                 XslStylesheet style;
 250                 int stackSize;
 251
 252
 253                 public XslTemplate (Compiler c)
 254                 {
 255                         if (c == null) return; // built in template
 256                         this.style = c.CurrentStylesheet;
 257
 258                         c.PushScope ();
 259
 260                         if (c.Input.Name == "template" &&
 261                             c.Input.NamespaceURI == Compiler.XsltNamespace &&
 262                             c.Input.MoveToAttribute ("mode", String.Empty)) {
 263                                 c.Input.MoveToParent ();
 264                                 if (!c.Input.MoveToAttribute ("match", String.Empty))
 265                                         throw new XsltCompileException ("XSLT 'template' element must not have 'mode' attribute when it does not have 'match' attribute", null, c.Input);
 266                                 c.Input.MoveToParent ();
 267                         }
 268
 269                         if (c.Input.NamespaceURI != Compiler.XsltNamespace) {
 270                                 this.name = QName.Empty;
 271                                 this.match = c.CompilePattern ("/", c.Input);
 272                                 this.mode = QName.Empty;
 273                         } else {
 274                                 this.name = c.ParseQNameAttribute ("name");
 275                                 this.match = c.CompilePattern (c.GetAttribute ("match"), c.Input);
 276                                 this.mode = c.ParseQNameAttribute ("mode");
 277
 278                                 string pri = c.GetAttribute ("priority");
 279                                 if (pri != null) {
 280                                         try {
 281                                                 this.priority = double.Parse (pri, CultureInfo.InvariantCulture);
 282                                         } catch (FormatException ex) {
 283                                                 throw new XsltException ("Invalid priority number format", ex, c.Input);
 284                                         }
 285                                 }
 286                         }
 287                         Parse (c);
 288
 289                         stackSize = c.PopScope ().VariableHighTide;
 290
 291                 }
 292
 293                 public XmlQualifiedName Name {
 294                         get { return name; }
 295                 }
 296
 297                 public Pattern Match {
 298                         get {
 299                                 return match;
 300                         }
 301                 }
 302
 303                 public XmlQualifiedName Mode {
 304                         get { return mode; }
 305                 }
 306
 307                 public double Priority {
 308                         get { return priority; }
 309                 }
 310
 311                 public XslStylesheet Parent {
 312                         get { return style; }
 313                 }
 314
 315                 private void Parse (Compiler c) {
 316                         if (c.Input.NamespaceURI != Compiler.XsltNamespace) {
 317                                 content = c.CompileTemplateContent ();
 318                                 return;
 319                         }
 320
 321                         if (c.Input.MoveToFirstChild ()) {
 322                                 bool alldone = true;
 323                                 XPathNavigator contentStart = c.Input.Clone ();
 324                                 bool shouldMove = false;
 325                                 do {
 326                                         if (shouldMove) {
 327                                                 shouldMove = false;
 328                                                 contentStart.MoveTo (c.Input);
 329                                         }
 330                                         if (c.Input.NodeType == XPathNodeType.Text)
 331                                                 { alldone = false; break; }
 332
 333                                         if (c.Input.NodeType != XPathNodeType.Element)
 334                                                 continue;
 335                                         if (c.Input.NamespaceURI != Compiler.XsltNamespace)
 336                                                 { alldone = false; break; }
 337                                         if (c.Input.LocalName != "param")
 338                                                 { alldone = false; break; }
 339
 340                                         if (this.parameters == null)
 341                                                 this.parameters = new ArrayList ();
 342
 343                                         parameters.Add (new XslLocalParam (c));
 344                                         shouldMove = true;
 345                                 } while (c.Input.MoveToNext ());
 346                                 if (!alldone) {
 347                                         c.Input.MoveTo (contentStart);
 348                                         content = c.CompileTemplateContent ();
 349                                 }
 350                                 c.Input.MoveToParent ();
 351                         }
 352                 }
 353
 354                 public virtual void Evaluate (XslTransformProcessor p, Hashtable withParams)
 355                 {
 356                         p.PushStack (stackSize);
 357
 358                         if (parameters != null) {
 359                                 if (withParams == null) {
 360                                         int len = parameters.Count;
 361                                         for (int i = 0; i < len; i++) {
 362                                                 XslLocalParam param = (XslLocalParam)parameters [i];
 363                                                 param.Evaluate (p);
 364                                         }
 365                                 } else {
 366                                         int len = parameters.Count;
 367                                         for (int i = 0; i < len; i++) {
 368                                                 XslLocalParam param = (XslLocalParam)parameters [i];
 369                                                 object o = withParams [param.Name];
 370                                                 if (o != null)
 371                                                         param.Override (p, o);
 372                                                 else
 373                                                         param.Evaluate (p);
 374                                         }
 375                                 }
 376                         }
 377
 378                         if (content != null)
 379                                 content.Evaluate (p);
 380
 381                         p.PopStack ();
 382                 }
 383                 public void Evaluate (XslTransformProcessor p)
 384                 {
 385                         Evaluate (p, null);
 386                 }
 387         }
 388
 389         internal class XslDefaultNodeTemplate : XslTemplate {
 390                 QName mode;
 391
 392                 static XslDefaultNodeTemplate instance = new XslDefaultNodeTemplate (QName.Empty);
 393                 public XslDefaultNodeTemplate (QName mode) : base (null)
 394                 {
 395                         this.mode = mode;
 396                 }
 397
 398                 public static XslTemplate Instance {
 399                         get { return instance; }
 400                 }
 401
 402                 public override void Evaluate (XslTransformProcessor p, Hashtable withParams)
 403                 {
 404                         p.ApplyTemplates (p.CurrentNode.SelectChildren (XPathNodeType.All), mode, null);
 405                 }
 406         }
 407
 408         internal class XslEmptyTemplate : XslTemplate {
 409
 410                 static XslEmptyTemplate instance = new XslEmptyTemplate ();
 411                 XslEmptyTemplate () : base (null) {}
 412
 413                 public static XslTemplate Instance {
 414                         get { return instance; }
 415                 }
 416
 417                 public override void Evaluate (XslTransformProcessor p, Hashtable withParams)
 418                 {
 419                 }
 420         }
 421
 422         internal class XslDefaultTextTemplate: XslTemplate {
 423
 424                 static XslDefaultTextTemplate instance = new XslDefaultTextTemplate ();
 425                 XslDefaultTextTemplate () : base (null) {}
 426
 427                 public static XslTemplate Instance {
 428                         get { return instance; }
 429                 }
 430
 431                 public override void Evaluate (XslTransformProcessor p, Hashtable withParams)
 432                 {
 433                         if (p.CurrentNode.NodeType == XPathNodeType.Whitespace) {
 434                                 if (p.PreserveWhitespace ())
 435                                         p.Out.WriteWhitespace (p.CurrentNode.Value);
 436                         }
 437                         else
 438                                 p.Out.WriteString (p.CurrentNode.Value);
 439                 }
 440         }
 441 }