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);
197 internal override bool Peer {
198 get { return false; }
201 public override string ToString ()
207 class XsltDocument : XPathFunction
209 Expression arg0, arg1;
212 public XsltDocument (FunctionArguments args, Compiler c) : base (args)
214 if (args == null || (args.Tail != null && args.Tail.Tail != null))
215 throw new XPathException ("document takes one or two args");
218 if (args.Tail != null)
219 arg1 = args.Tail.Arg;
220 doc = c.Input.Clone ();
222 public override XPathResultType ReturnType { get { return XPathResultType.NodeSet; }}
224 internal override bool Peer {
225 get { return arg0.Peer && (arg1 != null ? arg1.Peer : true); }
228 public override object Evaluate (BaseIterator iter)
230 string baseUri = null;
232 XPathNodeIterator it = arg1.EvaluateNodeSet (iter);
234 baseUri = it.Current.BaseURI;
236 baseUri = VoidBaseUriFlag;
239 object o = arg0.Evaluate (iter);
240 if (o is XPathNodeIterator)
241 return GetDocument ((iter.NamespaceManager as XsltCompiledContext), (XPathNodeIterator)o, baseUri);
243 return GetDocument ((iter.NamespaceManager as XsltCompiledContext), o is IFormattable ? ((IFormattable) o).ToString (null, CultureInfo.InvariantCulture) : o.ToString (), baseUri);
246 static string VoidBaseUriFlag = "&^)(*&%*^$&$VOID!BASE!URI!";
248 Uri Resolve (string thisUri, string baseUri, XslTransformProcessor p)
250 // Debug.WriteLine ("THIS: " + thisUri);
251 // Debug.WriteLine ("BASE: " + baseUri);
252 XmlResolver r = p.Resolver;
256 if (! object.ReferenceEquals (baseUri, VoidBaseUriFlag) && baseUri != String.Empty)
257 uriBase = r.ResolveUri (null, baseUri);
259 return r.ResolveUri (uriBase, thisUri);
262 XPathNodeIterator GetDocument (XsltCompiledContext xsltContext, XPathNodeIterator itr, string baseUri)
264 ArrayList list = new ArrayList ();
265 Hashtable got = new Hashtable ();
267 while (itr.MoveNext()) {
268 Uri uri = Resolve (itr.Current.Value, baseUri != null ? baseUri : /*itr.Current.BaseURI*/doc.BaseURI, xsltContext.Processor);
269 if (!got.ContainsKey (uri)) {
271 if (uri != null && uri.ToString () == "") {
272 XPathNavigator n = doc.Clone ();
276 list.Add (xsltContext.Processor.GetDocument (uri));
280 return new ListIterator (list, xsltContext);
283 XPathNodeIterator GetDocument (XsltCompiledContext xsltContext, string arg0, string baseUri)
285 Uri uri = Resolve (arg0, baseUri != null ? baseUri : doc.BaseURI, xsltContext.Processor);
287 if (uri != null && uri.ToString () == "") {
291 n = xsltContext.Processor.GetDocument (uri);
293 return new SelfIterator (n, xsltContext);
296 public override string ToString ()
298 return String.Concat ("document(",
300 arg1 != null ? "," : String.Empty,
301 arg1 != null ? arg1.ToString () : String.Empty,
306 class XsltElementAvailable : XPathFunction
309 IStaticXsltContext ctx;
311 public XsltElementAvailable (FunctionArguments args, IStaticXsltContext ctx) : base (args)
313 if (args == null || args.Tail != null)
314 throw new XPathException ("element-available takes 1 arg");
320 public override XPathResultType ReturnType { get { return XPathResultType.Boolean; }}
322 internal override bool Peer {
323 get { return arg0.Peer; }
326 public override object Evaluate (BaseIterator iter)
328 QName name = XslNameUtil.FromString (arg0.EvaluateString (iter), ctx);
331 (name.Namespace == Compiler.XsltNamespace) &&
334 // A list of all the instructions (does not include top-level-elements)
336 name.Name == "apply-imports" ||
337 name.Name == "apply-templates" ||
338 name.Name == "call-template" ||
339 name.Name == "choose" ||
340 name.Name == "comment" ||
341 name.Name == "copy" ||
342 name.Name == "copy-of" ||
343 name.Name == "element" ||
344 name.Name == "fallback" ||
345 name.Name == "for-each" ||
346 name.Name == "message" ||
347 name.Name == "number" ||
348 name.Name == "processing-instruction" ||
349 name.Name == "text" ||
350 name.Name == "value-of" ||
351 name.Name == "variable"
357 class XsltFormatNumber : XPathFunction
359 Expression arg0, arg1, arg2;
360 IStaticXsltContext ctx;
362 public XsltFormatNumber (FunctionArguments args, IStaticXsltContext ctx) : base (args)
364 if (args == null || args.Tail == null || (args.Tail.Tail != null && args.Tail.Tail.Tail != null))
365 throw new XPathException ("format-number takes 2 or 3 args");
368 arg1 = args.Tail.Arg;
369 if (args.Tail.Tail != null) {
370 arg2= args.Tail.Tail.Arg;
374 public override XPathResultType ReturnType { get { return XPathResultType.String; }}
376 internal override bool Peer {
377 get { return arg0.Peer && arg1.Peer && (arg2 != null ? arg2.Peer : true); }
380 public override object Evaluate (BaseIterator iter)
382 double d = arg0.EvaluateNumber (iter);
383 string s = arg1.EvaluateString (iter);
384 QName nm = QName.Empty;
387 nm = XslNameUtil.FromString (arg2.EvaluateString (iter), ctx);
390 return (iter.NamespaceManager as XsltCompiledContext).Processor.CompiledStyle
391 .LookupDecimalFormat (nm).FormatNumber (d, s);
392 } catch (ArgumentException ex) {
393 throw new XsltException (ex.Message, ex, iter.Current);
398 class XsltFunctionAvailable : XPathFunction
401 IStaticXsltContext ctx;
403 public XsltFunctionAvailable (FunctionArguments args, IStaticXsltContext ctx) : base (args)
405 if (args == null || args.Tail != null)
406 throw new XPathException ("element-available takes 1 arg");
412 public override XPathResultType ReturnType { get { return XPathResultType.Boolean; }}
414 internal override bool Peer {
415 get { return arg0.Peer; }
418 public override object Evaluate (BaseIterator iter)
421 string name = arg0.EvaluateString (iter);
422 int colon = name.IndexOf (':');
423 // extension function
425 return (iter.NamespaceManager as XsltCompiledContext).ResolveFunction (
426 XslNameUtil.FromString (name, ctx),
436 name == "contains" ||
443 name == "local-name" ||
445 name == "namespace-uri" ||
446 name == "normalize-space" ||
449 name == "position" ||
451 name == "starts-with" ||
453 name == "string-length" ||
454 name == "substring" ||
455 name == "substring-after" ||
456 name == "substring-before" ||
458 name == "translate" ||
461 name == "document" ||
462 name == "format-number" ||
463 name == "function-available" ||
464 name == "generate-id" ||
467 name == "unparsed-entity-uri" ||
468 name == "element-available" ||
469 name == "system-property"
474 class XsltGenerateId : XPathFunction
476 //FIXME: generate short string, not the huge thing it makes now
478 public XsltGenerateId (FunctionArguments args) : base (args)
481 if (args.Tail != null)
482 throw new XPathException ("generate-id takes 1 or no args");
487 public override XPathResultType ReturnType { get { return XPathResultType.String; }}
489 internal override bool Peer {
490 get { return arg0.Peer; }
493 public override object Evaluate (BaseIterator iter)
497 XPathNodeIterator itr = arg0.EvaluateNodeSet (iter);
499 n = itr.Current.Clone ();
501 return string.Empty; // empty nodeset == empty string
503 n = iter.Current.Clone ();
505 StringBuilder sb = new StringBuilder ("Mono"); // Ensure begins with alpha
506 sb.Append (XmlConvert.EncodeLocalName (n.BaseURI));
507 sb.Replace ('_', 'm'); // remove underscores from EncodeLocalName
508 sb.Append (n.NodeType);
512 sb.Append (IndexInParent (n));
514 } while (n.MoveToParent ());
516 return sb.ToString ();
519 int IndexInParent (XPathNavigator nav)
522 while (nav.MoveToPrevious ())
529 class XsltKey : XPathFunction
531 Expression arg0, arg1;
532 IStaticXsltContext staticContext;
534 public XsltKey (FunctionArguments args, IStaticXsltContext ctx) : base (args)
537 if (args == null || args.Tail == null)
538 throw new XPathException ("key takes 2 args");
540 arg1 = args.Tail.Arg;
542 public Expression KeyName { get { return arg0; } }
543 public Expression Field { get { return arg1; } }
544 public override XPathResultType ReturnType { get { return XPathResultType.NodeSet; }}
546 internal override bool Peer {
547 get { return arg0.Peer && arg1.Peer; }
550 public bool PatternMatches (XPathNavigator nav, XsltContext nsmgr)
552 XsltCompiledContext ctx = nsmgr as XsltCompiledContext;
553 // for key pattern, it must contain literal value
554 return ctx.MatchesKey (nav, staticContext,
555 arg0.StaticValueAsString,
556 arg1.StaticValueAsString);
559 public override object Evaluate (BaseIterator iter)
561 XsltCompiledContext ctx = iter.NamespaceManager
562 as XsltCompiledContext;
563 return ctx.EvaluateKey (staticContext, iter, arg0, arg1);
567 class XsltSystemProperty : XPathFunction
570 IStaticXsltContext ctx;
572 public XsltSystemProperty (FunctionArguments args, IStaticXsltContext ctx) : base (args)
574 if (args == null || args.Tail != null)
575 throw new XPathException ("system-property takes 1 arg");
581 public override XPathResultType ReturnType { get { return XPathResultType.String; }}
583 internal override bool Peer {
584 get { return arg0.Peer; }
587 public override object Evaluate (BaseIterator iter)
589 QName name = XslNameUtil.FromString (arg0.EvaluateString (iter), ctx);
591 if (name.Namespace == Compiler.XsltNamespace) {
593 case "version": return "1.0";
594 case "vendor": return "Mono";
595 case "vendor-url": return "http://www.go-mono.com/";
603 class XsltUnparsedEntityUri : XPathFunction
607 public XsltUnparsedEntityUri (FunctionArguments args) : base (args)
609 if (args == null || args.Tail != null)
610 throw new XPathException ("unparsed-entity-uri takes 1 arg");
615 public override XPathResultType ReturnType { get { return XPathResultType.String; }}
617 internal override bool Peer {
618 get { return arg0.Peer; }
621 public override object Evaluate (BaseIterator iter)
623 IHasXmlNode xn = iter.Current as IHasXmlNode;
626 XmlNode n = xn.GetNode ();
627 if (n.OwnerDocument == null)
629 XmlDocumentType doctype = n.OwnerDocument.DocumentType;
632 XmlEntity ent = doctype.Entities.GetNamedItem (arg0.EvaluateString (iter)) as XmlEntity;
635 return ent.SystemId != null ? ent.SystemId : String.Empty;
639 class MSXslNodeSet : XPathFunction
643 public MSXslNodeSet (FunctionArguments args) : base (args)
645 if (args == null || args.Tail != null)
646 throw new XPathException ("element-available takes 1 arg");
651 public override XPathResultType ReturnType {
653 return XPathResultType.NodeSet;
657 internal override bool Peer {
658 get { return arg0.Peer; }
661 public override object Evaluate (BaseIterator iter)
663 XsltCompiledContext ctx = iter.NamespaceManager as XsltCompiledContext;
664 XPathNavigator loc = iter.Current != null ? iter.Current.Clone () : null;
665 XPathNavigator nav = arg0.EvaluateAs (iter, XPathResultType.Navigator) as XPathNavigator;
668 return new XsltException ("Cannot convert the XPath argument to a result tree fragment.", null, loc);
670 return new XsltException ("Cannot convert the XPath argument to a result tree fragment.", null);
672 ArrayList al = new ArrayList ();
674 return new ListIterator (al, ctx);