[MOD] XQuery, record constructor: equality checks, string representation

Author: ChristianGruen

basex-core/src/main/java/org/basex/query/expr/constr/CMap.java

@@ -67,7 +67,7 @@ public Expr optimize(final CompileContext cc) throws QueryException {
     }
 
     // not too large, only strings as keys? replace with record constructor
-    boolean record = el <= RecordType.MAX_GENERATED_SIZE;
+    boolean record = el / 2 <= RecordType.MAX_GENERATED_SIZE;
     for(int e = 0; e < el && record; e += 2) {
       if(nested(e) || !(exprs[e] instanceof AStr && exprs[e].seqType().eq(Types.STRING_O))) {
         record = false;

basex-core/src/main/java/org/basex/query/func/RecordConstructor.java

@@ -20,12 +20,10 @@
 public class RecordConstructor extends StandardFunc {
   /** Record type. */
   private final RecordType recordType;
-  /** The size of a structure resulting from this constructor. */
-  private final long structSize;
-  /** The map builder function. */
-  private final QueryBiFunction<QueryContext, InputInfo, XQMap> builder;
   /** Field names. */
   private final QNm[] names;
+  /** Created compact record map. */
+  private final boolean compact;
 
   /**
    * Constructor.
@@ -36,18 +34,12 @@ public RecordConstructor(final RecordType recordType) {
     final TokenObjectMap<RecordField> fields = recordType.fields();
     final int fs = fields.size();
     names = new QNm[fs];
-    boolean complete = true;
-    for(int i = 1; i <= fs; ++i) {
-      names[i - 1] = new QNm(fields.key(i));
-      complete = complete && fields.value(i).alwaysAdded();
-    }
-    if(complete) {
-      builder = this::recordMap;
-      structSize = fs;
-    } else {
-      builder = this::map;
-      structSize = -1;
+    boolean c = true;
+    for(int f = 1; f <= fs; ++f) {
+      names[f - 1] = new QNm(fields.key(f));
+      c = c && fields.value(f).alwaysAdded();
     }
+    compact = c;
   }
 
   /**
@@ -58,69 +50,62 @@ public RecordConstructor(final RecordType recordType) {
    * @return constructor function
    */
   public static RecordConstructor get(final InputInfo ii, final RecordType rt, final Expr[] args) {
-    RecordConstructor constructor = new RecordConstructor(rt);
-    constructor.init(ii, definition(rt), args);
-    return constructor;
-  }
-
-  @Override
-  public Expr opt(final CompileContext cc) throws QueryException {
-    return values(true, cc) ? cc.preEval(this) : this;
+    final RecordConstructor rc = new RecordConstructor(rt);
+    rc.init(ii, definition(rt), args);
+    return rc;
   }
 
   @Override
   public XQMap item(final QueryContext qc, final InputInfo ii) throws QueryException {
-    return builder.apply(qc, ii);
-  }
-
-  @Override
-  public long structSize() {
-    return structSize;
-  }
-
-  /**
-   * Creates a compact record map. This is more efficient than the regular map implementation, but
-   * only possible if all fields of the type are present.
-   * @param qc query context
-   * @param ii input info
-   * @return record map
-   * @throws QueryException query exception
-   */
-  private XQRecordMap recordMap(final QueryContext qc, final InputInfo ii) throws QueryException {
     final TokenObjectMap<RecordField> fields = recordType.fields();
-    final int fs = fields.size();
+    final int fs = fields.size(), el = exprs.length;
     final Value[] values = new Value[fs];
     for(int f = 0; f < fs; ++f) {
       final RecordField rf = fields.value(f + 1);
-      final Value value = f < exprs.length ? exprs[f].value(qc) : rf.init().value(qc);
-      values[f] = rf.seqType().coerce(value, qc, ii, names[f], null);
+      final Value value = f < el ? exprs[f].value(qc) : rf.init().value(qc);
+      if(!value.isEmpty() || rf.alwaysAdded()) {
+        values[f] = rf.seqType().coerce(value, qc, ii, names[f], null);
+      }
     }
-    return new XQRecordMap(recordType, values);
-  }
+    // create compact record map if all fields of the type are present
+    if(compact) return new XQRecordMap(recordType, values);
 
-  /**
-   * Creates a regular map. This is used if some fields of the record type may be absent.
-   * @param qc query context
-   * @param ii input info
-   * @return map
-   * @throws QueryException query exception
-   */
-  private XQMap map(final QueryContext qc, final InputInfo ii) throws QueryException {
-    final TokenObjectMap<RecordField> fields = recordType.fields();
-    final int fs = fields.size();
+    // create regular map otherwise
     final MapBuilder mb = new MapBuilder(fs);
     for(int f = 0; f < fs; ++f) {
-      final RecordField rf = fields.value(f + 1);
-      final Value value = f < exprs.length ? exprs[f].value(qc) : rf.init().value(qc);
-      if(!value.isEmpty() || rf.alwaysAdded()) {
-        mb.put(fields.key(f + 1), rf.seqType().coerce(value, qc, ii, names[f], null));
-      }
+      if(values[f] != null) mb.put(fields.key(f + 1), values[f]);
     }
     final XQMap map = mb.map();
     map.type = recordType;
     return map;
   }
 
+  @Override
+  public long structSize() {
+    return compact ? recordType.fields().size() : -1;
+  }
+
+  @Override
+  public boolean equals(final Object obj) {
+    return this == obj || obj instanceof final RecordConstructor rc && recordType.eq(rc.recordType);
+  }
+
+  @Override
+  public void toString(final QueryString qs) {
+    if(recordType.name() != null) {
+      super.toString(qs);
+    } else {
+      qs.token("{ ");
+      final TokenObjectMap<RecordField> fields = recordType.fields();
+      int f = 0;
+      for(final Expr expr : exprs) {
+        if(++f > 1) qs.token(',');
+        qs.quoted(fields.key(f)).token(':').token(expr);
+      }
+      qs.token(" }");
+    }
+  }
+
   /**
    * Returns a constructor function definition for this record type.
    * @param rt record type
@@ -147,8 +132,8 @@ public static FuncDefinition definition(final RecordType rt) {
       params[i] = f.isOptional() ? st.union(Occ.ZERO) : st;
     }
 
-    Supplier<RecordConstructor> supplier = () -> new RecordConstructor(rt);
+    final Supplier<RecordConstructor> supplier = () -> new RecordConstructor(rt);
     return new FuncDefinition(supplier, description, params, rt.seqType(),
         EnumSet.noneOf(Flag.class), rt.name() == null ? Token.EMPTY : rt.name().uri(), Perm.NONE);
   }
-}
+}

basex-core/src/main/java/org/basex/query/func/StandardFunc.java

@@ -885,7 +885,7 @@ protected final QueryException error(final QueryException ex, final QueryError e
   }
 
   @Override
-  public final boolean equals(final Object obj) {
+  public boolean equals(final Object obj) {
     return this == obj || obj instanceof final StandardFunc sf && definition == sf.definition &&
         super.equals(obj);
   }
@@ -917,7 +917,7 @@ public final void toXml(final QueryPlan plan) {
   }
 
   @Override
-  public final void toString(final QueryString qs) {
+  public void toString(final QueryString qs) {
     final byte[] name = definition.name.prefixId(FN_URI);
     final int undefined = undefined();
     if(undefined == 0) {

basex-core/src/main/java/org/basex/query/value/type/RecordType.java

@@ -22,7 +22,7 @@
  * @author Gunther Rademacher
  */
 public final class RecordType extends MapType {
-  /** Maximum size for generated record definitions. */
+  /** Maximum number of entries in generated records. */
   public static final int MAX_GENERATED_SIZE = 32;
 
   /** Record fields. */

basex-core/src/test/java/org/basex/query/expr/RecordTest.java

@@ -7,6 +7,7 @@
 import org.basex.query.func.*;
 import org.basex.query.value.item.*;
 import org.basex.query.value.map.*;
+import org.basex.query.value.seq.*;
 import org.junit.jupiter.api.*;
 
 /**
@@ -321,4 +322,55 @@ declare record cx:complex(r as xs:double, i? as xs:double := ());
     error("let $m as record(a, b?) := {} return $m", INVTYPE_X);
     error("let $m as record(a, b?) := { 'c': 3 } return $m", INVTYPE_X);
   }
+
+  /** Equality of map/record constructors. */
+  @Test public void equal() {
+    // empty record
+    String constr = "{}";
+    check("(" + constr + ", " + constr + ")", "{}\n{}", exists(SingletonSeq.class));
+
+    // single-entry record (compile-time evaluation)
+    constr = "{ 'AA': 0 }";
+    check("(" + constr + ", " + constr + ")?AA", "0\n0", exists(SingletonSeq.class));
+    // small record (compile-time evaluation)
+    constr = "{ 'AA': 0, 'AB': 1 }";
+    check("(" + constr + ", " + constr + ")?AA", "0\n0", exists(SingletonSeq.class));
+    // big record (compile-time evaluation)
+    constr =
+        "{ 'AA': 0, 'AB': 0, 'AC': 0, 'AD': 0, 'AE': 0, 'AF': 0, 'AG': 0, 'AH': 0, 'AI': 0, "
+        + "'AJ': 0, 'AK': 0, 'AL': 0, 'AM': 0, 'AN': 0, 'AO': 0, 'AP': 0, 'AQ': 0, 'AR': 0, "
+        + "'AS': 0, 'AT': 0, 'AU': 0, 'AV': 0, 'AW': 0, 'AX': 0, 'AY': 0, 'AZ': 0 }";
+    check("(" + constr + ", " + constr + ")?AA", "0\n0", exists(SingletonSeq.class));
+    // map (compile-time evaluation)
+    constr =
+        "{ 'AA': 0, 'AB': 0, 'AC': 0, 'AD': 0, 'AE': 0, 'AF': 0, 'AG': 0, 'AH': 0, 'AI': 0, "
+        + "'AJ': 0, 'AK': 0, 'AL': 0, 'AM': 0, 'AN': 0, 'AO': 0, 'AP': 0, 'AQ': 0, 'AR': 0, "
+        + "'AS': 0, 'AT': 0, 'AU': 0, 'AV': 0, 'AW': 0, 'AX': 0, 'AY': 0, 'AZ': 0, "
+        + "'BA': 0, 'BB': 0, 'BC': 0, 'BD': 0, 'BE': 0, 'BF': 0, 'BG': 0 }";
+    check("(" + constr + ", " + constr + ")?AA", "0\n0", exists(SingletonSeq.class));
+
+    // single-entry record (runtime evaluation)
+    constr = "{ 'AA': <a/> }";
+    check("(" + constr + ", " + constr + ")?AA", "<a/>\n<a/>", exists(REPLICATE));
+    // small record (runtime evaluation)
+    constr = "{ 'AA': 0, 'AB': <a/> }";
+    check("(" + constr + ", " + constr + ")?AA", "0\n0", exists(REPLICATE));
+    // big record (runtime evaluation)
+    constr =
+        "{ 'AA': 0, 'AB': 0, 'AC': 0, 'AD': 0, 'AE': 0, 'AF': 0, 'AG': 0, 'AH': 0, 'AI': 0, "
+        + "'AJ': 0, 'AK': 0, 'AL': 0, 'AM': 0, 'AN': 0, 'AO': 0, 'AP': 0, 'AQ': 0, 'AR': 0, "
+        + "'AS': 0, 'AT': 0, 'AU': 0, 'AV': 0, 'AW': 0, 'AX': 0, 'AY': 0, 'AZ': <a/> }";
+    check("(" + constr + ", " + constr + ")?AA", "0\n0", exists(REPLICATE));
+    // map (runtime evaluation)
+    constr =
+        "{ 'AA': 0, 'AB': 0, 'AC': 0, 'AD': 0, 'AE': 0, 'AF': 0, 'AG': 0, 'AH': 0, 'AI': 0, "
+        + "'AJ': 0, 'AK': 0, 'AL': 0, 'AM': 0, 'AN': 0, 'AO': 0, 'AP': 0, 'AQ': 0, 'AR': 0, "
+        + "'AS': 0, 'AT': 0, 'AU': 0, 'AV': 0, 'AW': 0, 'AX': 0, 'AY': 0, 'AZ': 0, "
+        + "'BA': 0, 'BB': 0, 'BC': 0, 'BD': 0, 'BE': 0, 'BF': 0, 'BG': <a/> }";
+    check("(" + constr + ", " + constr + ")?AA", "0\n0", exists(REPLICATE));
+
+    // named record (runtime evaluation)
+    check("declare record local:r(AA, AB); (local:r(0, <a/>), local:r(0, <a/>))?AA",
+        "0\n0", exists(REPLICATE));
+  }
 }