2 // XsltCompiledContext.cs
5 // Ben Maurer (bmaurer@users.sourceforge.net)
6 // Atsushi Enomoto (atsushi@ximian.com)
8 // (C) 2004 Atsushi Enomoto
12 // Permission is hereby granted, free of charge, to any person obtaining
13 // a copy of this software and associated documentation files (the
14 // "Software"), to deal in the Software without restriction, including
15 // without limitation the rights to use, copy, modify, merge, publish,
16 // distribute, sublicense, and/or sell copies of the Software, and to
17 // permit persons to whom the Software is furnished to do so, subject to
18 // the following conditions:
20 // The above copyright notice and this permission notice shall be
21 // included in all copies or substantial portions of the Software.
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 using System.Collections;
33 using System.Globalization;
34 using System.Reflection;
37 using System.Xml.XPath;
41 using QName = System.Xml.XmlQualifiedName;
43 namespace Mono.Xml.Xsl
45 internal abstract class XPFuncImpl : IXsltContextFunction
48 XPathResultType returnType;
49 XPathResultType [] argTypes;
51 public XPFuncImpl () {}
52 public XPFuncImpl (int minArgs, int maxArgs, XPathResultType returnType, XPathResultType[] argTypes)
54 this.Init(minArgs, maxArgs, returnType, argTypes);
57 protected void Init (int minArgs, int maxArgs, XPathResultType returnType, XPathResultType[] argTypes)
59 this.minargs = minArgs;
60 this.maxargs = maxArgs;
61 this.returnType = returnType;
62 this.argTypes = argTypes;
65 public int Minargs { get { return this.minargs; }}
66 public int Maxargs { get { return this.maxargs; }}
67 public XPathResultType ReturnType { get { return this.returnType; }}
68 public XPathResultType [] ArgTypes { get { return this.argTypes; }}
69 public object Invoke (XsltContext xsltContext, object [] args, XPathNavigator docContext)
71 return Invoke ((XsltCompiledContext)xsltContext, args, docContext);
74 public abstract object Invoke (XsltCompiledContext xsltContext, object [] args, XPathNavigator docContext);
76 public static XPathResultType GetXPathType (Type type, XPathNavigator node) {
77 switch (Type.GetTypeCode(type)) {
79 return XPathResultType.String;
80 case TypeCode.Boolean:
81 return XPathResultType.Boolean;
83 if (typeof (XPathNavigator).IsAssignableFrom (type) || typeof (IXPathNavigable).IsAssignableFrom (type))
84 return XPathResultType.Navigator;
86 if (typeof (XPathNodeIterator).IsAssignableFrom (type))
87 return XPathResultType.NodeSet;
89 return XPathResultType.Any;
90 case TypeCode.DateTime :
91 throw new XsltException ("Invalid type DateTime was specified.", null, node);
93 return XPathResultType.Number;
98 class XsltExtensionFunction : XPFuncImpl
100 private object extension;
101 private MethodInfo method;
102 private TypeCode [] typeCodes;
104 public XsltExtensionFunction (object extension, MethodInfo method, XPathNavigator currentNode)
106 this.extension = extension;
107 this.method = method;
109 ParameterInfo [] parameters = method.GetParameters ();
110 int minArgs = parameters.Length;
111 int maxArgs = parameters.Length;
113 this.typeCodes = new TypeCode [parameters.Length];
114 XPathResultType[] argTypes = new XPathResultType [parameters.Length];
116 bool canBeOpt = true;
117 for (int i = parameters.Length - 1; 0 <= i; i--) { // optionals at the end
118 typeCodes [i] = Type.GetTypeCode (parameters [i].ParameterType);
119 argTypes [i] = GetXPathType (parameters [i].ParameterType, currentNode);
121 if (parameters[i].IsOptional)
127 base.Init (minArgs, maxArgs, GetXPathType (method.ReturnType, currentNode), argTypes);
130 public override object Invoke (XsltCompiledContext xsltContext, object [] args, XPathNavigator docContext)
133 ParameterInfo [] pis = method.GetParameters ();
134 object [] castedArgs = new object [pis.Length];
135 for (int i = 0; i < args.Length; i++) {
136 Type t = pis [i].ParameterType;
137 switch (t.FullName) {
139 case "System.UInt16":
141 case "System.UInt32":
143 case "System.UInt64":
144 case "System.Single":
145 case "System.Decimal":
146 castedArgs [i] = Convert.ChangeType (args [i], t);
149 castedArgs [i] = args [i];
154 object result = null;
155 switch (method.ReturnType.FullName) {
157 case "System.UInt16":
159 case "System.UInt32":
161 case "System.UInt64":
162 case "System.Single":
163 case "System.Decimal":
164 result = (double) method.Invoke (extension, castedArgs);
167 result = method.Invoke(extension, castedArgs);
170 IXPathNavigable navigable = result as IXPathNavigable;
171 if (navigable != null)
172 return navigable.CreateNavigator ();
175 } catch (Exception ex) {
176 throw new XsltException ("Custom function reported an error.", ex);
177 // Debug.WriteLine ("****** INCORRECT RESOLUTION **********");
182 class XsltCurrent : XPathFunction
184 public XsltCurrent (FunctionArguments args) : base (args)
187 throw new XPathException ("current takes 0 args");
190 public override XPathResultType ReturnType { get { return XPathResultType.NodeSet; }}
192 public override object Evaluate (BaseIterator iter)
194 return new SelfIterator ((iter.NamespaceManager as XsltCompiledContext).Processor.CurrentNode, null);
198 class XsltDocument : XPathFunction
200 Expression arg0, arg1;
203 public XsltDocument (FunctionArguments args, Compiler c) : base (args)
205 if (args == null || (args.Tail != null && args.Tail.Tail != null))
206 throw new XPathException ("document takes one or two args");
209 if (args.Tail != null)
210 arg1 = args.Tail.Arg;
211 doc = c.Input.Clone ();
213 public override XPathResultType ReturnType { get { return XPathResultType.NodeSet; }}
215 public override object Evaluate (BaseIterator iter)
217 string baseUri = null;
219 XPathNodeIterator it = arg1.EvaluateNodeSet (iter);
221 baseUri = it.Current.BaseURI;
223 baseUri = VoidBaseUriFlag;
226 object o = arg0.Evaluate (iter);
227 if (o is XPathNodeIterator)
228 return GetDocument ((iter.NamespaceManager as XsltCompiledContext), (XPathNodeIterator)o, baseUri);
230 return GetDocument ((iter.NamespaceManager as XsltCompiledContext), o is IFormattable ? ((IFormattable) o).ToString (null, CultureInfo.InvariantCulture) : o.ToString (), baseUri);
233 static string VoidBaseUriFlag = "&^)(*&%*^$&$VOID!BASE!URI!";
235 Uri Resolve (string thisUri, string baseUri, XslTransformProcessor p)
237 // Debug.WriteLine ("THIS: " + thisUri);
238 // Debug.WriteLine ("BASE: " + baseUri);
239 XmlResolver r = p.Resolver;
243 if (! object.ReferenceEquals (baseUri, VoidBaseUriFlag) && baseUri != String.Empty)
244 uriBase = r.ResolveUri (null, baseUri);
246 return r.ResolveUri (uriBase, thisUri);
249 XPathNodeIterator GetDocument (XsltCompiledContext xsltContext, XPathNodeIterator itr, string baseUri)
251 ArrayList list = new ArrayList ();
252 Hashtable got = new Hashtable ();
254 while (itr.MoveNext()) {
255 Uri uri = Resolve (itr.Current.Value, baseUri != null ? baseUri : /*itr.Current.BaseURI*/doc.BaseURI, xsltContext.Processor);
256 if (!got.ContainsKey (uri)) {
258 if (uri != null && uri.ToString () == "") {
259 XPathNavigator n = doc.Clone ();
263 list.Add (xsltContext.Processor.GetDocument (uri));
267 return new ListIterator (list, xsltContext, false);
270 XPathNodeIterator GetDocument (XsltCompiledContext xsltContext, string arg0, string baseUri)
272 Uri uri = Resolve (arg0, baseUri != null ? baseUri : doc.BaseURI, xsltContext.Processor);
274 if (uri != null && uri.ToString () == "") {
278 n = xsltContext.Processor.GetDocument (uri);
280 return new SelfIterator (n, xsltContext);
284 class XsltElementAvailable : XPathFunction
287 IStaticXsltContext ctx;
289 public XsltElementAvailable (FunctionArguments args, IStaticXsltContext ctx) : base (args)
291 if (args == null || args.Tail != null)
292 throw new XPathException ("element-available takes 1 arg");
298 public override XPathResultType ReturnType { get { return XPathResultType.Boolean; }}
300 public override object Evaluate (BaseIterator iter)
302 QName name = XslNameUtil.FromString (arg0.EvaluateString (iter), ctx);
305 (name.Namespace == Compiler.XsltNamespace) &&
308 // A list of all the instructions (does not include top-level-elements)
310 name.Name == "apply-imports" ||
311 name.Name == "apply-templates" ||
312 name.Name == "call-template" ||
313 name.Name == "choose" ||
314 name.Name == "comment" ||
315 name.Name == "copy" ||
316 name.Name == "copy-of" ||
317 name.Name == "element" ||
318 name.Name == "fallback" ||
319 name.Name == "for-each" ||
320 name.Name == "message" ||
321 name.Name == "number" ||
322 name.Name == "processing-instruction" ||
323 name.Name == "text" ||
324 name.Name == "value-of" ||
325 name.Name == "variable"
331 class XsltFormatNumber : XPathFunction
333 Expression arg0, arg1, arg2;
334 IStaticXsltContext ctx;
336 public XsltFormatNumber (FunctionArguments args, IStaticXsltContext ctx) : base (args)
338 if (args == null || args.Tail == null || (args.Tail.Tail != null && args.Tail.Tail.Tail != null))
339 throw new XPathException ("format-number takes 2 or 3 args");
342 arg1 = args.Tail.Arg;
343 if (args.Tail.Tail != null) {
344 arg2= args.Tail.Tail.Arg;
348 public override XPathResultType ReturnType { get { return XPathResultType.String; }}
350 public override object Evaluate (BaseIterator iter)
352 double d = arg0.EvaluateNumber (iter);
353 string s = arg1.EvaluateString (iter);
354 QName nm = QName.Empty;
357 nm = XslNameUtil.FromString (arg2.EvaluateString (iter), ctx);
360 return (iter.NamespaceManager as XsltCompiledContext).Processor.CompiledStyle
361 .LookupDecimalFormat (nm).FormatNumber (d, s);
362 } catch (ArgumentException ex) {
363 throw new XsltException (ex.Message, ex, iter.Current);
368 class XsltFunctionAvailable : XPathFunction
371 IStaticXsltContext ctx;
373 public XsltFunctionAvailable (FunctionArguments args, IStaticXsltContext ctx) : base (args)
375 if (args == null || args.Tail != null)
376 throw new XPathException ("element-available takes 1 arg");
382 public override XPathResultType ReturnType { get { return XPathResultType.Boolean; }}
384 public override object Evaluate (BaseIterator iter)
387 string name = arg0.EvaluateString (iter);
388 int colon = name.IndexOf (':');
389 // extension function
391 return (iter.NamespaceManager as XsltCompiledContext).ResolveFunction (
392 XslNameUtil.FromString (name, ctx),
402 name == "contains" ||
409 name == "local-name" ||
411 name == "namespace-uri" ||
412 name == "normalize-space" ||
415 name == "position" ||
417 name == "starts-with" ||
419 name == "string-length" ||
420 name == "substring" ||
421 name == "substring-after" ||
422 name == "substring-before" ||
424 name == "translate" ||
427 name == "document" ||
428 name == "format-number" ||
429 name == "function-available" ||
430 name == "generate-id" ||
433 name == "unparsed-entity-uri" ||
434 name == "element-available" ||
435 name == "system-property"
440 class XsltGenerateId : XPathFunction
442 //FIXME: generate short string, not the huge thing it makes now
444 public XsltGenerateId (FunctionArguments args) : base (args)
447 if (args.Tail != null)
448 throw new XPathException ("generate-id takes 1 or no args");
453 public override XPathResultType ReturnType { get { return XPathResultType.String; }}
454 public override object Evaluate (BaseIterator iter)
458 XPathNodeIterator itr = arg0.EvaluateNodeSet (iter);
460 n = itr.Current.Clone ();
462 return string.Empty; // empty nodeset == empty string
464 n = iter.Current.Clone ();
466 StringBuilder sb = new StringBuilder ("Mono"); // Ensure begins with alpha
467 sb.Append (XmlConvert.EncodeLocalName (n.BaseURI));
468 sb.Replace ('_', 'm'); // remove underscores from EncodeLocalName
469 sb.Append (n.NodeType);
473 sb.Append (IndexInParent (n));
475 } while (n.MoveToParent ());
477 return sb.ToString ();
480 int IndexInParent (XPathNavigator nav)
483 while (nav.MoveToPrevious ())
490 class XsltKey : XPathFunction
492 Expression arg0, arg1;
493 IStaticXsltContext ctx;
496 public XsltKey (FunctionArguments args, IStaticXsltContext ctx) : base (args)
498 if (args == null || args.Tail == null)
499 throw new XPathException ("key takes 2 args");
501 arg1 = args.Tail.Arg;
504 public Expression KeyName { get { return arg0; } }
505 public Expression Field { get { return arg1; } }
506 public override XPathResultType ReturnType { get { return XPathResultType.NodeSet; }}
508 public override object Evaluate (BaseIterator iter)
510 QName name = XslNameUtil.FromString (arg0.EvaluateString (iter), this.ctx);
511 XsltCompiledContext ctx = iter.NamespaceManager as XsltCompiledContext;
513 key = ctx.Processor.CompiledStyle.Style.FindKey (name);
515 ArrayList result = new ArrayList ();
516 object o = arg1.Evaluate (iter);
517 XPathNodeIterator it = o as XPathNodeIterator;
520 while (it.MoveNext())
521 FindKeyMatch (ctx, it.Current.Value, result, iter.Current);
523 FindKeyMatch (ctx, XPathFunctions.ToString (o), result, iter.Current);
526 return new ListIterator (result, (iter.NamespaceManager as XsltCompiledContext), true);
529 void FindKeyMatch (XsltCompiledContext xsltContext, string value, ArrayList result, XPathNavigator context)
531 XPathNavigator searchDoc = context.Clone ();
532 searchDoc.MoveToRoot ();
534 XPathNodeIterator desc = searchDoc.SelectDescendants (XPathNodeType.All, true);
536 while (desc.MoveNext ()) {
537 if (key.Matches (desc.Current, xsltContext, value))
538 AddResult (result, desc.Current);
540 if (desc.Current.MoveToFirstAttribute ()) {
542 if (key.Matches (desc.Current, xsltContext, value))
543 AddResult (result, desc.Current);
544 } while (desc.Current.MoveToNextAttribute ());
546 desc.Current.MoveToParent ();
552 void AddResult (ArrayList result, XPathNavigator nav)
554 for (int i = 0; i < result.Count; i++) {
555 XmlNodeOrder docOrder = nav.ComparePosition (((XPathNavigator)result [i]));
556 if (docOrder == XmlNodeOrder.Same)
559 if (docOrder == XmlNodeOrder.Before) {
560 result.Insert(i, nav.Clone ());
564 result.Add (nav.Clone ());
568 class XsltSystemProperty : XPathFunction
571 IStaticXsltContext ctx;
573 public XsltSystemProperty (FunctionArguments args, IStaticXsltContext ctx) : base (args)
575 if (args == null || args.Tail != null)
576 throw new XPathException ("system-property takes 1 arg");
582 public override XPathResultType ReturnType { get { return XPathResultType.String; }}
583 public override object Evaluate (BaseIterator iter)
585 QName name = XslNameUtil.FromString (arg0.EvaluateString (iter), ctx);
587 if (name.Namespace == Compiler.XsltNamespace) {
589 case "version": return "1.0";
590 case "vendor": return "Mono";
591 case "vendor-url": return "http://www.go-mono.com/";
599 class XsltUnparsedEntityUri : XPathFunction
603 public XsltUnparsedEntityUri (FunctionArguments args) : base (args)
605 if (args == null || args.Tail != null)
606 throw new XPathException ("unparsed-entity-uri takes 1 arg");
611 public override XPathResultType ReturnType { get { return XPathResultType.String; }}
612 public override object Evaluate (BaseIterator iter)
614 IHasXmlNode xn = iter.Current as IHasXmlNode;
617 XmlNode n = xn.GetNode ();
618 if (n.OwnerDocument == null)
620 XmlDocumentType doctype = n.OwnerDocument.DocumentType;
623 XmlEntity ent = doctype.Entities.GetNamedItem (arg0.EvaluateString (iter)) as XmlEntity;
626 return ent.SystemId != null ? ent.SystemId : String.Empty;
630 class MSXslNodeSet : XPathFunction
634 public MSXslNodeSet (FunctionArguments args) : base (args)
636 if (args == null || args.Tail != null)
637 throw new XPathException ("element-available takes 1 arg");
642 public override XPathResultType ReturnType {
644 return XPathResultType.NodeSet;
648 public override object Evaluate (BaseIterator iter)
650 XsltCompiledContext ctx = iter.NamespaceManager as XsltCompiledContext;
651 XPathNavigator loc = iter.Current != null ? iter.Current.Clone () : null;
652 XPathNavigator nav = arg0.EvaluateAs (iter, XPathResultType.Navigator) as XPathNavigator;
655 return new XsltException ("Cannot convert the XPath argument to a result tree fragment.", null, loc);
657 return new XsltException ("Cannot convert the XPath argument to a result tree fragment.", null);
659 ArrayList al = new ArrayList ();
661 return new ListIterator (al, ctx, false);