/*
* eXist Open Source Native XML Database
* Copyright (C) 2001-2009 The eXist Project
* http://exist-db.org
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $Id$
*/
package org.exist.xquery.functions.fn;
import org.exist.Namespaces;
import org.exist.dom.QName;
import org.exist.util.XMLChar;
import org.exist.xquery.BasicFunction;
import org.exist.xquery.Cardinality;
import org.exist.xquery.Dependency;
import org.exist.xquery.ErrorCodes;
import org.exist.xquery.Function;
import org.exist.xquery.FunctionSignature;
import org.exist.xquery.Profiler;
import org.exist.xquery.XPathException;
import org.exist.xquery.XQueryContext;
import org.exist.xquery.value.FunctionParameterSequenceType;
import org.exist.xquery.value.FunctionReturnSequenceType;
import org.exist.xquery.value.QNameValue;
import org.exist.xquery.value.Sequence;
import org.exist.xquery.value.SequenceType;
import org.exist.xquery.value.Type;
import org.exist.xquery.value.ValueSequence;
/**
* @author wolf
*
*/
public class FunQName extends BasicFunction {
public final static FunctionSignature signature =
new FunctionSignature(
new QName("QName", Function.BUILTIN_FUNCTION_NS),
"Returns an xs:QName with the namespace URI given in $uri. If $uri is " +
"the zero-length string or the empty sequence, it represents \"no namespace\"; in " +
"this case, if the value of $qname contains a colon (:), an error is " +
"raised [err:FOCA0002]. The prefix (or absence of a prefix) in $qname is " +
"retained in the returned xs:QName value. The local name in the result is " +
"taken from the local part of $qname.\n\nIf $qname does not have " +
"the correct lexical form for xs:QName an error is raised [err:FOCA0002].\n\n" +
"Note that unlike xs:QName this function does not require a xs:string literal as the argument.",
new SequenceType[] {
new FunctionParameterSequenceType("uri", Type.STRING, Cardinality.ZERO_OR_ONE, "The namespace URI"),
new FunctionParameterSequenceType("qname", Type.STRING, Cardinality.EXACTLY_ONE, "The prefix")
},
new FunctionReturnSequenceType(Type.QNAME, Cardinality.EXACTLY_ONE, "the xs:QName with the namespace URI given in $uri"));
/**
* @param context
*/
public FunQName(XQueryContext context) {
super(context, signature);
}
/* (non-Javadoc)
* @see org.exist.xquery.BasicFunction#eval(org.exist.xquery.value.Sequence[], org.exist.xquery.value.Sequence)
*/
public Sequence eval(Sequence[] args, Sequence contextSequence) throws XPathException {
if (context.getProfiler().isEnabled()) {
context.getProfiler().start(this);
context.getProfiler().message(this, Profiler.DEPENDENCIES, "DEPENDENCIES", Dependency.getDependenciesName(this.getDependencies()));
if (contextSequence != null)
{context.getProfiler().message(this, Profiler.START_SEQUENCES, "CONTEXT SEQUENCE", contextSequence);}
}
//TODO : currently useless (but for empty sequences) since the type is forced :-(
if (!args[0].isEmpty() && args[0].getItemType() != Type.STRING)
{throw new XPathException(this, ErrorCodes.XPTY0004, "Namespace URI is of type '" +
Type.getTypeName(args[0].getItemType()) + "', 'xs:string' expected", args[0]);}
String namespace;
if (args[0].isEmpty())
{namespace = "";}
else
{namespace = args[0].getStringValue();}
final String param = args[1].getStringValue();
String prefix = null;
String localName = null;
try {
prefix = QName.extractPrefix(param);
localName = QName.extractLocalName(param);
} catch (final IllegalArgumentException e) {
final ValueSequence argsSeq = new ValueSequence(args[0]);
argsSeq.addAll(args[1]);
throw new XPathException(this, ErrorCodes.FOCA0002, "Invalid lexical form of either prefix or local name.", argsSeq);
}
if ((prefix != null && prefix.length() > 0) && (namespace == null || namespace.length() == 0)){
final ValueSequence argsSeq = new ValueSequence(args[0]);
argsSeq.addAll(args[1]);
throw new XPathException(this, ErrorCodes.FOCA0002, "Non-empty namespace prefix with empty namespace URI", argsSeq);
}
if (namespace != null) {
if (namespace.equalsIgnoreCase(Namespaces.XMLNS_NS))
{if (prefix == null)
throw new XPathException(this, ErrorCodes.XQDY0044, "'"+Namespaces.XMLNS_NS+"' can't be use with no prefix");
else if (!prefix.equalsIgnoreCase("xmlns"))
throw new XPathException(this, ErrorCodes.XQDY0044, "'"+Namespaces.XMLNS_NS+"' can't be use with prefix '"+prefix+"'");}
if (namespace.equalsIgnoreCase(Namespaces.XML_NS))
{if (prefix == null)
throw new XPathException(this, ErrorCodes.XQDY0044, "'"+Namespaces.XML_NS+"' can't be use with no prefix");
else if (!prefix.equalsIgnoreCase("xml"))
throw new XPathException(this, ErrorCodes.XQDY0044, "'"+Namespaces.XML_NS+"' can't be use with prefix '"+prefix+"'");}
}
if (prefix != null) {
if (prefix.equalsIgnoreCase("xml") && !namespace.equalsIgnoreCase(Namespaces.XML_NS))
{throw new XPathException(this, ErrorCodes.XQDY0044, "prefix 'xml' can be used only with '"+Namespaces.XML_NS+"'");}
}
final QName qname = new QName(localName, namespace, prefix);
if (prefix != null && namespace != null) {
if (context.getURIForPrefix(prefix) == null) {
//TOCHECK : context.declareInScopeNamespace(prefix, uri) ?
context.declareNamespace(prefix, namespace);
}
//context.declareInScopeNamespace(prefix, namespace);
}
if(!XMLChar.isValidName(qname.getLocalPart()))
{throw new XPathException(this, ErrorCodes.FOCA0002, "'" + qname.getLocalPart() + "' is not a valid local name.");}
final Sequence result = new QNameValue(context, qname);
if (context.getProfiler().isEnabled())
{context.getProfiler().end(this, "", result);}
return result;
}
}