[bugfix] Cleanup and fix issues with setting the parent Expression of…

… an Expression

exist-core/src/main/java/org/exist/xquery/BinaryOp.java

@@ -1,4 +1,13 @@
 /*
+ * Copyright (C) 2014 Evolved Binary Ltd
+ *
+ * Changes made by Evolved Binary are proprietary and are not Open Source.
+ *
+ * NOTE: Parts of this file contain code from The eXist-db Authors.
+ *       The original license header is included below.
+ *
+ * ----------------------------------------------------------------------------
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -60,12 +69,8 @@ public void setContextDocSet(DocumentSet contextSet) {
     	getRight().setContextDocSet(contextSet);
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.exist.xquery.PathExpr#analyze(org.exist.xquery.Expression)
-     */
-    public void analyze(AnalyzeContextInfo contextInfo) throws XPathException {
+    @Override
+    public void analyze(final AnalyzeContextInfo contextInfo) throws XPathException {
     	inPredicate = (contextInfo.getFlags() & IN_PREDICATE) != 0;
     	contextId = contextInfo.getContextId();
     	inWhereClause = (contextInfo.getFlags() & IN_WHERE_CLAUSE) != 0;

exist-core/src/main/java/org/exist/xquery/Function.java

@@ -1,4 +1,13 @@
 /*
+ * Copyright (C) 2014 Evolved Binary Ltd
+ *
+ * Changes made by Evolved Binary are proprietary and are not Open Source.
+ *
+ * NOTE: Parts of this file contain code from The eXist-db Authors.
+ *       The original license header is included below.
+ *
+ * ----------------------------------------------------------------------------
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -69,11 +78,6 @@ public abstract class Function extends PathExpr {
      */
     private FunctionSignature mySignature;
 
-    /**
-     * The parent expression from which this function is called.
-     */
-    private Expression parent;
-
     /**
      * Flag to indicate if argument types are statically checked.
      * This is set to true by default (meaning: no further checks needed).
@@ -193,16 +197,6 @@ public void setParent(final Expression parent) {
         this.parent = parent;
     }
 
-    /**
-     * Returns the expression from which this function gets called.
-     *
-     * @return the parent expression
-     */
-    @Override
-    public Expression getParent() {
-        return parent;
-    }
-
     /**
      * Set the (static) arguments for this function from a list of expressions.
      *
@@ -394,6 +388,7 @@ protected Tuple2<Expression, Integer> strictCheckArgumentType(Expression argumen
 
     @Override
     public void analyze(final AnalyzeContextInfo contextInfo) throws XPathException {
+        this.parent = contextInfo.getParent();
         inPredicate = (contextInfo.getFlags() & IN_PREDICATE) > 0;
         unordered = (contextInfo.getFlags() & UNORDERED) > 0;
         contextId = contextInfo.getContextId();

exist-core/src/main/java/org/exist/xquery/GeneralComparison.java

@@ -159,11 +159,9 @@ public GeneralComparison( XQueryContext context, Expression left, Expression rig
         }
     }
 
-    /* (non-Javadoc)
-     * @see org.exist.xquery.BinaryOp#analyze(org.exist.xquery.AnalyzeContextInfo)
-     */
-    public void analyze( AnalyzeContextInfo contextInfo ) throws XPathException
-    {
+    @Override
+    public void analyze(final AnalyzeContextInfo contextInfo) throws XPathException {
+        this.parent = contextInfo.getParent();
         contextInfo.addFlag( NEED_INDEX_INFO );
         contextInfo.setParent( this );
         super.analyze( contextInfo );

exist-core/src/main/java/org/exist/xquery/LocationStep.java

@@ -1,4 +1,13 @@
 /*
+ * Copyright (C) 2014 Evolved Binary Ltd
+ *
+ * Changes made by Evolved Binary are proprietary and are not Open Source.
+ *
+ * NOTE: Parts of this file contain code from The eXist-db Authors.
+ *       The original license header is included below.
+ *
+ * ----------------------------------------------------------------------------
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -1192,7 +1201,8 @@ protected DocumentSet getDocumentSet(final NodeSet contextSet) {
      *
      * @return the parent expression
      */
-    public Expression getParentExpression() {
+    @Override
+    public Expression getParent() {
         return this.parent;
     }
 

exist-core/src/main/java/org/exist/xquery/LogicalOp.java

@@ -1,4 +1,13 @@
 /*
+ * Copyright (C) 2014 Evolved Binary Ltd
+ *
+ * Changes made by Evolved Binary are proprietary and are not Open Source.
+ *
+ * NOTE: Parts of this file contain code from The eXist-db Authors.
+ *       The original license header is included below.
+ *
+ * ----------------------------------------------------------------------------
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -41,8 +50,6 @@ public abstract class LogicalOp extends BinaryOp {
 	 */
 	protected boolean optimize = false;
 	protected boolean rewritable = false;
-
-    protected Expression parent;
 
 	public LogicalOp(XQueryContext context) {
 		super(context);
@@ -56,10 +63,8 @@ public abstract Sequence eval(
 		Item contextItem)
 		throws XPathException;
 
-	/* (non-Javadoc)
-	 * @see org.exist.xquery.BinaryOp#analyze(org.exist.xquery.Expression, int)
-	 */
-	public void analyze(AnalyzeContextInfo contextInfo) throws XPathException {
+	@Override
+	public void analyze(final AnalyzeContextInfo contextInfo) throws XPathException {
         this.parent = contextInfo.getParent();
         super.analyze(contextInfo);		
 		//To optimize, we want nodes
@@ -102,10 +107,6 @@ public int getDependencies() {
 		else
 			{return Dependency.CONTEXT_SET;}
 	}
-
-    public Expression getParent() {
-        return this.parent;
-    }
 
     public boolean isRewritable() {
     	return rewritable;

exist-core/src/main/java/org/exist/xquery/OpNumeric.java

@@ -1,4 +1,13 @@
 /*
+ * Copyright (C) 2014 Evolved Binary Ltd
+ *
+ * Changes made by Evolved Binary are proprietary and are not Open Source.
+ *
+ * NOTE: Parts of this file contain code from The eXist-db Authors.
+ *       The original license header is included below.
+ *
+ * ----------------------------------------------------------------------------
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -98,7 +107,9 @@ public int returnsType() {
         return returnType;
     }
 
-    public void analyze(AnalyzeContextInfo contextInfo) throws XPathException {
+    @Override
+    public void analyze(final AnalyzeContextInfo contextInfo) throws XPathException {
+        this.parent = contextInfo.getParent();
         super.analyze(contextInfo);
         contextInfo.setStaticReturnType(returnType);
     }

exist-core/src/main/java/org/exist/xquery/Optimizer.java

@@ -1,4 +1,13 @@
 /*
+ * Copyright (C) 2014 Evolved Binary Ltd
+ *
+ * Changes made by Evolved Binary are proprietary and are not Open Source.
+ *
+ * NOTE: Parts of this file contain code from The eXist-db Authors.
+ *       The original license header is included below.
+ *
+ * ----------------------------------------------------------------------------
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -114,7 +123,7 @@ public void visitLocationStep(final LocationStep locationStep) {
             }
         }
 
-        final Expression parent = locationStep.getParentExpression();
+        final Expression parent = locationStep.getParent();
 
         if (optimize) {
             // we found at least one Optimizable. Rewrite the whole expression and

exist-core/src/main/java/org/exist/xquery/PathExpr.java

@@ -1,4 +1,13 @@
 /*
+ * Copyright (C) 2014 Evolved Binary Ltd
+ *
+ * Changes made by Evolved Binary are proprietary and are not Open Source.
+ *
+ * NOTE: Parts of this file contain code from The eXist-db Authors.
+ *       The original license header is included below.
+ *
+ * ----------------------------------------------------------------------------
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -182,7 +191,7 @@ public void analyze(final AnalyzeContextInfo contextInfo) throws XPathException
             if (i > 1) {
                 contextInfo.setContextStep(steps.get(i - 1));
             }
-            contextInfo.setParent(this);
+            contextInfo.setParent(this);  // TODO(AR) it seems we have to repeatedly mutate the parent contextInfo here... it would be better to have some immutable structure!
             expr.analyze(contextInfo);
         }
     }

exist-core/src/main/java/org/exist/xquery/Predicate.java

@@ -1,4 +1,13 @@
 /*
+ * Copyright (C) 2014 Evolved Binary Ltd
+ *
+ * Changes made by Evolved Binary are proprietary and are not Open Source.
+ *
+ * NOTE: Parts of this file contain code from The eXist-db Authors.
+ *       The original license header is included below.
+ *
+ * ----------------------------------------------------------------------------
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -64,8 +73,6 @@ public enum ExecutionMode {
 
     private int outerContextId;
 
-    private Expression parent;
-
     public Predicate(final XQueryContext context) {
         super(context);
     }
@@ -92,7 +99,6 @@ public int getDependencies() {
 
     @Override
     public void analyze(final AnalyzeContextInfo contextInfo) throws XPathException {
-        parent = contextInfo.getParent();
         AnalyzeContextInfo newContextInfo = createContext(contextInfo);
         super.analyze(newContextInfo);
         final Expression inner = getSubExpression(0);
@@ -134,7 +140,7 @@ private AnalyzeContextInfo createContext(final AnalyzeContextInfo contextInfo) {
         outerContextId = newContextInfo.getContextId();
         newContextInfo.setContextId(getExpressionId());
         newContextInfo.setStaticType(contextInfo.getStaticType());
-        newContextInfo.setParent(this);
+        newContextInfo.setParent(contextInfo.getParent());
         return newContextInfo;
     }
 
@@ -636,11 +642,6 @@ public void resetState(final boolean postOptimization) {
         }
     }
 
-    @Override
-    public Expression getParent() {
-        return parent;
-    }
-
     @Override
     public void accept(final ExpressionVisitor visitor) {
         visitor.visitPredicate(this);

extensions/indexes/range/src/main/java/org/exist/xquery/modules/range/OptimizeFieldPragma.java

@@ -1,4 +1,13 @@
 /*
+ * Copyright (C) 2014 Evolved Binary Ltd
+ *
+ * Changes made by Evolved Binary are proprietary and are not Open Source.
+ *
+ * NOTE: Parts of this file contain code from The eXist-db Authors.
+ *       The original license header is included below.
+ *
+ * ----------------------------------------------------------------------------
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -73,7 +82,7 @@ public void before(final XQueryContext context, final Expression expression, fin
         final LocationStep locationStep = (LocationStep) expression;
         @Nullable final Predicate[] preds = locationStep.getPredicates();
         if (preds != null) {
-            final Expression parentExpr = locationStep.getParentExpression();
+            final Expression parentExpr = locationStep.getParent();
             if (!(parentExpr instanceof RewritableExpression)) {
                 return;
             }

extensions/indexes/range/src/main/java/org/exist/xquery/modules/range/RangeQueryRewriter.java

@@ -1,4 +1,13 @@
 /*
+ * Copyright (C) 2014 Evolved Binary Ltd
+ *
+ * Changes made by Evolved Binary are proprietary and are not Open Source.
+ *
+ * NOTE: Parts of this file contain code from The eXist-db Authors.
+ *       The original license header is included below.
+ *
+ * ----------------------------------------------------------------------------
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -51,7 +60,7 @@ public Pragma rewriteLocationStep(final LocationStep locationStep) throws XPathE
 
         @Nullable final Predicate[] preds = locationStep.getPredicates();
         if (preds != null) {
-            final Expression parentExpr = locationStep.getParentExpression();
+            final Expression parentExpr = locationStep.getParent();
             if ((parentExpr instanceof RewritableExpression)) {
                 // Step 1: replace all optimizable expressions within predicates with
                 // calls to the range functions. If those functions are used or not will
@@ -255,7 +264,7 @@ protected static NodePath toNodePath(List<LocationStep> steps) {
     }
 
     protected static List<LocationStep> getPrecedingSteps(LocationStep current) {
-        Expression parentExpr = current.getParentExpression();
+        Expression parentExpr = current.getParent();
         if (!(parentExpr instanceof RewritableExpression)) {
             return null;
         }