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 = Convert.ChangeType (method.Invoke (extension, castedArgs), typeof (double));
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 ();
266 Hashtable got = new Hashtable ();
268 while (itr.MoveNext()) {
269 Uri uri = Resolve (itr.Current.Value, baseUri != null ? baseUri : /*itr.Current.BaseURI*/doc.BaseURI, xsltContext.Processor);
270 if (!got.ContainsKey (uri)) {
272 if (uri != null && uri.ToString () == "") {
273 XPathNavigator n = doc.Clone ();
277 list.Add (xsltContext.Processor.GetDocument (uri));
280 } catch (Exception) {
282 // See http://www.w3.org/TR/xslt#document and
286 return new ListIterator (list, xsltContext);
289 XPathNodeIterator GetDocument (XsltCompiledContext xsltContext, string arg0, string baseUri)
292 Uri uri = Resolve (arg0, baseUri != null ? baseUri : doc.BaseURI, xsltContext.Processor);
294 if (uri != null && uri.ToString () == "") {
298 n = xsltContext.Processor.GetDocument (uri);
300 return new SelfIterator (n, xsltContext);
301 } catch (Exception) {
302 return new ListIterator (new ArrayList (), xsltContext);
306 public override string ToString ()
308 return String.Concat ("document(",
310 arg1 != null ? "," : String.Empty,
311 arg1 != null ? arg1.ToString () : String.Empty,
316 class XsltElementAvailable : XPathFunction
319 IStaticXsltContext ctx;
321 public XsltElementAvailable (FunctionArguments args, IStaticXsltContext ctx) : base (args)
323 if (args == null || args.Tail != null)
324 throw new XPathException ("element-available takes 1 arg");
330 public override XPathResultType ReturnType { get { return XPathResultType.Boolean; }}
332 internal override bool Peer {
333 get { return arg0.Peer; }
336 public override object Evaluate (BaseIterator iter)
338 QName name = XslNameUtil.FromString (arg0.EvaluateString (iter), ctx);
341 (name.Namespace == Compiler.XsltNamespace) &&
344 // A list of all the instructions (does not include top-level-elements)
346 name.Name == "apply-imports" ||
347 name.Name == "apply-templates" ||
348 name.Name == "call-template" ||
349 name.Name == "choose" ||
350 name.Name == "comment" ||
351 name.Name == "copy" ||
352 name.Name == "copy-of" ||
353 name.Name == "element" ||
354 name.Name == "fallback" ||
355 name.Name == "for-each" ||
356 name.Name == "message" ||
357 name.Name == "number" ||
358 name.Name == "processing-instruction" ||
359 name.Name == "text" ||
360 name.Name == "value-of" ||
361 name.Name == "variable"
367 class XsltFormatNumber : XPathFunction
369 Expression arg0, arg1, arg2;
370 IStaticXsltContext ctx;
372 public XsltFormatNumber (FunctionArguments args, IStaticXsltContext ctx) : base (args)
374 if (args == null || args.Tail == null || (args.Tail.Tail != null && args.Tail.Tail.Tail != null))
375 throw new XPathException ("format-number takes 2 or 3 args");
378 arg1 = args.Tail.Arg;
379 if (args.Tail.Tail != null) {
380 arg2= args.Tail.Tail.Arg;
384 public override XPathResultType ReturnType { get { return XPathResultType.String; }}
386 internal override bool Peer {
387 get { return arg0.Peer && arg1.Peer && (arg2 != null ? arg2.Peer : true); }
390 public override object Evaluate (BaseIterator iter)
392 double d = arg0.EvaluateNumber (iter);
393 string s = arg1.EvaluateString (iter);
394 QName nm = QName.Empty;
397 nm = XslNameUtil.FromString (arg2.EvaluateString (iter), ctx);
400 return (iter.NamespaceManager as XsltCompiledContext).Processor.CompiledStyle
401 .LookupDecimalFormat (nm).FormatNumber (d, s);
402 } catch (ArgumentException ex) {
403 throw new XsltException (ex.Message, ex, iter.Current);
408 class XsltFunctionAvailable : XPathFunction
411 IStaticXsltContext ctx;
413 public XsltFunctionAvailable (FunctionArguments args, IStaticXsltContext ctx) : base (args)
415 if (args == null || args.Tail != null)
416 throw new XPathException ("element-available takes 1 arg");
422 public override XPathResultType ReturnType { get { return XPathResultType.Boolean; }}
424 internal override bool Peer {
425 get { return arg0.Peer; }
428 public override object Evaluate (BaseIterator iter)
431 string name = arg0.EvaluateString (iter);
432 int colon = name.IndexOf (':');
433 // extension function
435 return (iter.NamespaceManager as XsltCompiledContext).ResolveFunction (
436 XslNameUtil.FromString (name, ctx),
446 name == "contains" ||
453 name == "local-name" ||
455 name == "namespace-uri" ||
456 name == "normalize-space" ||
459 name == "position" ||
461 name == "starts-with" ||
463 name == "string-length" ||
464 name == "substring" ||
465 name == "substring-after" ||
466 name == "substring-before" ||
468 name == "translate" ||
471 name == "document" ||
472 name == "format-number" ||
473 name == "function-available" ||
474 name == "generate-id" ||
477 name == "unparsed-entity-uri" ||
478 name == "element-available" ||
479 name == "system-property"
484 class XsltGenerateId : XPathFunction
486 //FIXME: generate short string, not the huge thing it makes now
488 public XsltGenerateId (FunctionArguments args) : base (args)
491 if (args.Tail != null)
492 throw new XPathException ("generate-id takes 1 or no args");
497 public override XPathResultType ReturnType { get { return XPathResultType.String; }}
499 internal override bool Peer {
500 get { return arg0.Peer; }
503 public override object Evaluate (BaseIterator iter)
507 XPathNodeIterator itr = arg0.EvaluateNodeSet (iter);
509 n = itr.Current.Clone ();
511 return string.Empty; // empty nodeset == empty string
513 n = iter.Current.Clone ();
515 StringBuilder sb = new StringBuilder ("Mono"); // Ensure begins with alpha
516 sb.Append (XmlConvert.EncodeLocalName (n.BaseURI));
517 sb.Replace ('_', 'm'); // remove underscores from EncodeLocalName
518 sb.Append (n.NodeType);
522 sb.Append (IndexInParent (n));
524 } while (n.MoveToParent ());
526 return sb.ToString ();
529 int IndexInParent (XPathNavigator nav)
532 while (nav.MoveToPrevious ())
539 class XsltKey : XPathFunction
541 Expression arg0, arg1;
542 IStaticXsltContext staticContext;
544 public XsltKey (FunctionArguments args, IStaticXsltContext ctx) : base (args)
547 if (args == null || args.Tail == null)
548 throw new XPathException ("key takes 2 args");
550 arg1 = args.Tail.Arg;
552 public Expression KeyName { get { return arg0; } }
553 public Expression Field { get { return arg1; } }
554 public override XPathResultType ReturnType { get { return XPathResultType.NodeSet; }}
556 internal override bool Peer {
557 get { return arg0.Peer && arg1.Peer; }
560 public bool PatternMatches (XPathNavigator nav, XsltContext nsmgr)
562 XsltCompiledContext ctx = nsmgr as XsltCompiledContext;
563 // for key pattern, it must contain literal value
564 return ctx.MatchesKey (nav, staticContext,
565 arg0.StaticValueAsString,
566 arg1.StaticValueAsString);
569 public override object Evaluate (BaseIterator iter)
571 XsltCompiledContext ctx = iter.NamespaceManager
572 as XsltCompiledContext;
573 return ctx.EvaluateKey (staticContext, iter, arg0, arg1);
577 class XsltSystemProperty : XPathFunction
580 IStaticXsltContext ctx;
582 public XsltSystemProperty (FunctionArguments args, IStaticXsltContext ctx) : base (args)
584 if (args == null || args.Tail != null)
585 throw new XPathException ("system-property takes 1 arg");
591 public override XPathResultType ReturnType { get { return XPathResultType.String; }}
593 internal override bool Peer {
594 get { return arg0.Peer; }
597 public override object Evaluate (BaseIterator iter)
599 QName name = XslNameUtil.FromString (arg0.EvaluateString (iter), ctx);
601 if (name.Namespace == Compiler.XsltNamespace) {
603 case "version": return "1.0";
604 case "vendor": return "Mono";
605 case "vendor-url": return "http://www.go-mono.com/";
613 class XsltUnparsedEntityUri : XPathFunction
617 public XsltUnparsedEntityUri (FunctionArguments args) : base (args)
619 if (args == null || args.Tail != null)
620 throw new XPathException ("unparsed-entity-uri takes 1 arg");
625 public override XPathResultType ReturnType { get { return XPathResultType.String; }}
627 internal override bool Peer {
628 get { return arg0.Peer; }
631 public override object Evaluate (BaseIterator iter)
633 IHasXmlNode xn = iter.Current as IHasXmlNode;
636 XmlNode n = xn.GetNode ();
637 if (n.OwnerDocument == null)
639 XmlDocumentType doctype = n.OwnerDocument.DocumentType;
642 XmlEntity ent = doctype.Entities.GetNamedItem (arg0.EvaluateString (iter)) as XmlEntity;
645 return ent.SystemId != null ? ent.SystemId : String.Empty;
649 class MSXslNodeSet : XPathFunction
653 public MSXslNodeSet (FunctionArguments args) : base (args)
655 if (args == null || args.Tail != null)
656 throw new XPathException ("element-available takes 1 arg");
661 public override XPathResultType ReturnType {
663 return XPathResultType.NodeSet;
667 internal override bool Peer {
668 get { return arg0.Peer; }
671 public override object Evaluate (BaseIterator iter)
673 XsltCompiledContext ctx = iter.NamespaceManager as XsltCompiledContext;
674 XPathNavigator loc = iter.Current != null ? iter.Current.Clone () : null;
675 XPathNavigator nav = arg0.EvaluateAs (iter, XPathResultType.Navigator) as XPathNavigator;
678 return new XsltException ("Cannot convert the XPath argument to a result tree fragment.", null, loc);
680 return new XsltException ("Cannot convert the XPath argument to a result tree fragment.", null);
682 ArrayList al = new ArrayList ();
684 return new ListIterator (al, ctx);