@sap/cds-compiler 4.0.0 → 4.1.2

package/lib/language/language.g4

@@ -216,7 +216,7 @@ usingProxy[ outer, proxy ]
     )
   ;
 
-artifactDefOrExtend[ outer, defOnly = false ] locals[ art = {} ] // cannot use `parent` as parameter name!
+artifactDefOrExtend[ outer, defOnly = false ] locals[ art = new parser.XsnArtifact() ] // cannot use `parent` as parameter name!
 @after{ /* #ATN 1 */ }
   :
     { $art.location = this.startLocation(); this.docComment( $art ); }
@@ -285,13 +285,13 @@ optionalSemi
 
 // Annotation def and main definitions ------------------------------------------
 
-annotationDef[ art, outer ] locals[ name = {} ]
+annotationDef[ art, outer ] locals[ name = new parser.XsnName() ]
 @after { this.attachLocation( $art ); }
   :
     annotation=ANNOTATION simplePath[ $name, 'AnnoDef' ]
     { if ($outer.kind !== 'source') { // this is a syntax restriction to avoid confusion
         this.error( 'syntax-unexpected-vocabulary', $annotation, { '#': $outer.kind } );
-        $art = {}; }
+        $art = new this.XsnArtifact(); }
       else {
         if (!$outer.vocabularies) $outer.vocabularies = Object.create(null);
         this.addDef( $art, $outer, 'vocabularies', 'annotation', $name );
@@ -301,7 +301,7 @@ annotationDef[ art, outer ] locals[ name = {} ]
     typeSpecSemi[ $art ] // also 'includes'...
   ;
 
-serviceDef[ art, outer, defOnly = false ] locals[ name = {} ]
+serviceDef[ art, outer, defOnly = false ] locals[ name = new parser.XsnName(); ]
 @after { this.attachLocation( $art ); }
   :
     SERVICE simplePath[ $name, 'Service' ]
@@ -309,7 +309,7 @@ serviceDef[ art, outer, defOnly = false ] locals[ name = {} ]
     optArtifactsBlock[ $art, defOnly ]
   ;
 
-contextDef[ art, outer, defOnly = false ] locals[ name = {} ]
+contextDef[ art, outer, defOnly = false ] locals[ name = new parser.XsnName(); ]
 @after { this.attachLocation( $art ); }
   :
     CONTEXT simplePath[ $name, 'Context' ]
@@ -317,7 +317,7 @@ contextDef[ art, outer, defOnly = false ] locals[ name = {} ]
     optArtifactsBlock[ $art, defOnly ]
   ;
 
-eventDef[ art, outer ] locals[ name = {} ]
+eventDef[ art, outer ] locals[ name = new parser.XsnName(); ]
 @after { /* #ATN 1 */ this.attachLocation( $art ); }
   :
     EVENT simplePath[ $name, 'Event' ]
@@ -353,7 +353,7 @@ eventDef[ art, outer ] locals[ name = {} ]
     )
   ;
 
-viewDef[ art, outer ] locals[ name = {} ]
+viewDef[ art, outer ] locals[ name = new parser.XsnName(); ]
 @after { this.attachLocation( $art ); }
   :
     v=VIEW simplePath[ $name, 'Entity' ]
@@ -376,7 +376,7 @@ viewDef[ art, outer ] locals[ name = {} ]
     requiredSemi
   ;
 
-entityDef[ art, outer ] locals[ name = {} ]
+entityDef[ art, outer ] locals[ name = new parser.XsnName() ]
 @after { this.attachLocation( $art ); }
   :
     ENTITY simplePath[ $name, 'Entity' ]
@@ -424,7 +424,7 @@ entityDef[ art, outer ] locals[ name = {} ]
     )
   ;
 
-aspectDef[ art, outer ] locals[ name = {} ]
+aspectDef[ art, outer ] locals[ name = new parser.XsnName() ]
 @after { this.attachLocation( $art ); }
   :
     ( ASPECT | ( abs=ABSTRACT | HideAlternatives ) ent=ENTITY )
@@ -453,12 +453,11 @@ aspectDef[ art, outer ] locals[ name = {} ]
       )?
       optionalSemi
     | // `aspect MyAspect;`, e.g. for annotation aspects.
-      { this.aspectWithoutElements( $art ); }
       requiredSemi
     )
   ;
 
-typeDef[ art, outer ] locals[ name = {} ]
+typeDef[ art, outer ] locals[ name = new parser.XsnName() ]
 @after { this.attachLocation( $art ); }
   :
     TYPE simplePath[ $name, 'Type' ]
@@ -468,7 +467,7 @@ typeDef[ art, outer ] locals[ name = {} ]
     typeSpecSemi[ $art ]
   ;
 
-actionFunctionMainDef[ art, outer ] locals[ name = {} ]
+actionFunctionMainDef[ art, outer ] locals[ name = new parser.XsnName() ]
 @after { this.attachLocation( $art ); }
   :
     ACTION simplePath[ $name, 'Action' ]
@@ -488,7 +487,7 @@ actionFunctionMainDef[ art, outer ] locals[ name = {} ]
 
 // Member definitions: actions, elements, enums, parameters: --------------------
 
-actionFunctionDef[ outer ] locals[ art = {} ]
+actionFunctionDef[ outer ] locals[ art = new parser.XsnArtifact() ]
 @after { this.attachLocation( $art ); }
   :
     { $art.location = this.startLocation();; this.docComment( $art ); }
@@ -510,7 +509,7 @@ actionFunctionDef[ outer ] locals[ art = {} ]
     )
   ;
 
-parameterDef[ outer ] locals[ art = {} ]
+parameterDef[ outer ] locals[ art = new parser.XsnArtifact() ]
 @after { this.attachLocation( $art ); }
   :
     { this.meltKeywordToIdentifier();; this.docComment( $art ); }
@@ -546,7 +545,7 @@ parameterListDef[ art ]
     ')' { this.finalizeDictOrArray( $art.params ); }
   ;
 
-enumSymbolDef[ outer ] locals[ art = {} ]
+enumSymbolDef[ outer ] locals[ art = new parser.XsnArtifact() ]
 @after { this.attachLocation( $art ); }
   :
     { $art.location = this.startLocation();; this.docComment( $art ); }
@@ -570,14 +569,14 @@ enumSymbolDef[ outer ] locals[ art = {} ]
     requiredSemi
   ;
 
-elementDef[ outer ] locals[ $art = {} ]
+elementDef[ outer ] locals[ $art = new parser.XsnArtifact() ]
   :
     { $art.location = this.startLocation();; this.docComment( $art ); }
     annotationAssignment_ll1[ $art ]*
-    elementDefInner[ $art, $outer, false ]
+    elementDefInner[ $art, $outer ]
   ;
 
-elementDefInner[ art, outer, mightBeEnum ]
+elementDefInner[ art, outer, explicitElement = false ]
 @after{ this.attachLocation( $art ); }
   :
     // VIRTUAL is keyword, except if before the following tokens texts:
@@ -592,7 +591,7 @@ elementDefInner[ art, outer, mightBeEnum ]
       }
     )?
     { this.setLocalToken( 'ELEMENT', 'ELEMENT', /^[;:{@=}]$/ ); }
-    ( ELEMENT { $mightBeEnum = false; } )? // auto-recognizable at other places
+    ( ELEMENT { $explicitElement = true; } )? // auto-recognizable at other places
     name=ident['Element']
     { this.addDef( $art, $outer, 'elements', 'element', $name.id );
       this.docComment( $art ); }
@@ -605,7 +604,7 @@ elementDefInner[ art, outer, mightBeEnum ]
       )
     |
       ':'
-      elementType[ $art, $mightBeEnum ]
+      elementType[ $art ]
     |
       eq='=' e=expression       // SQL has syntax variant using AS - we DO NOT
       stored=STORED?
@@ -613,10 +612,8 @@ elementDefInner[ art, outer, mightBeEnum ]
         // this.setIntroLocation( eq );  -- future
         if ($stored)
           $art.value.stored = this.valueWithTokenLocation( true, $stored );
-        if ($mightBeEnum && !$stored &&
-            ($e.expr?.val !== undefined || $e.expr?.sym !== undefined) &&
-            !$virtual && !$key && !$masked && !$art.elements && !$art.type)
-          $art['$'+'syntax'] = 'enum';
+        if ($explicitElement)
+          $art['$'+'syntax'] = 'element';
       }
       { this.docComment( $art ); }
       annotationAssignment_ll1[ $art ]* // for enum symbol def via EXTEND
@@ -750,7 +747,7 @@ defaultValue[ art ] locals[ elem, elements = {} ]
 
 // Extend and annotate ----------------------------------------------------------
 
-extendArtifact[ art, outer ] locals[ name = {}, elemName = {} ]
+extendArtifact[ art, outer ] locals[ name = new parser.XsnName(), elemName = new parser.XsnName() ]
 @after{ /* #ATN 1 */ this.attachLocation( $art ); }
   :
     simplePath[ $name, 'Extend' ]
@@ -771,7 +768,7 @@ extendArtifact[ art, outer ] locals[ name = {}, elemName = {} ]
       (
         // all the alternatives from `extendWithOptElementsOrType` --------------
         '{' { $art.elements = this.createDict(); }
-        elementDefOrExtend[ $art, true ]*
+        elementDefOrExtend[ $art ]*
         '}' { this.finalizeDictOrArray( $art.elements ); }
         { this.checkExtensionDict( $art.elements ); }
         optionalSemi
@@ -779,7 +776,7 @@ extendArtifact[ art, outer ] locals[ name = {}, elemName = {} ]
         requiredSemi
       |
         ELEMENTS { $art.elements = this.createDict(); } '{'
-        elementDefOrExtend[ $art ]*
+        elementDefOrExtend[ $art, true ]*
         '}' { this.finalizeDictOrArray( $art.elements ); }
         { this.checkExtensionDict( $art.elements ); }
         optionalSemi
@@ -823,7 +820,7 @@ extendArtifact[ art, outer ] locals[ name = {}, elemName = {} ]
     )
   ;
 
-extendService[ art, outer ] locals[ name = {} ]
+extendService[ art, outer ] locals[ name = new parser.XsnName() ]
 @after { this.attachLocation( $art ); }
   :
     SERVICE { $art.expectedKind = this.valueWithTokenLocation(); }
@@ -833,7 +830,7 @@ extendService[ art, outer ] locals[ name = {} ]
     optArtifactsBlock[ art, 'service' ]
   ;
 
-extendContext[ art, outer ] locals[ name = {} ]
+extendContext[ art, outer ] locals[ name = new parser.XsnName() ]
 @after { this.attachLocation( $art ); }
   :
     CONTEXT { $art.expectedKind = this.valueWithTokenLocation(); }
@@ -843,7 +840,7 @@ extendContext[ art, outer ] locals[ name = {} ]
     optArtifactsBlock[ art, 'context' ]
   ;
 
-extendEntityOrAspect[ art, outer ] locals[ name = {} ]
+extendEntityOrAspect[ art, outer ] locals[ name = new parser.XsnName() ]
 @after { /* #ATN 1 */ this.attachLocation( $art ); }
   :
     (ASPECT | ENTITY) { $art.expectedKind = this.valueWithTokenLocation(); }
@@ -888,7 +885,7 @@ extendForEntity[ art ]
     requiredSemi
   ;
 
-extendProjection[ art, outer ] locals[ name = {} ]
+extendProjection[ art, outer ] locals[ name = new parser.XsnName() ]
 @after { this.attachLocation( $art ); }
   :
     PROJECTION { $art.expectedKind = this.valueWithTokenLocation( 'entity' ); }
@@ -924,7 +921,7 @@ extendProjection[ art, outer ] locals[ name = {} ]
     )
   ;
 
-extendType[ art, outer ] locals[ name = {} ]
+extendType[ art, outer ] locals[ name = new parser.XsnName() ]
 @after { this.attachLocation( $art ); }
   :
     TYPE { $art.expectedKind = this.valueWithTokenLocation(); }
@@ -940,7 +937,7 @@ extendType[ art, outer ] locals[ name = {} ]
       annotationAssignment_ll1[ $art ]*
       (
         '{' { $art.elements = this.createDict(); }
-        elementDefOrExtend[ $art, true ]*
+        elementDefOrExtend[ $art ]*
         '}' { this.finalizeDictOrArray( $art.elements ); }
         { this.checkExtensionDict( $art.elements ); }
         optionalSemi
@@ -965,13 +962,13 @@ extendWithOptElementsOrType[ art ]
     annotationAssignment_ll1[ $art ]*
     (
       '{' { $art.elements = this.createDict(); }
-      elementDefOrExtend[ $art, true ]*
+      elementDefOrExtend[ $art ]*
       '}' { this.finalizeDictOrArray( $art.elements ); }
       { this.checkExtensionDict( $art.elements ); }
       optionalSemi
     |
       ELEMENTS { $art.elements = this.createDict(); } '{'
-      elementDefOrExtend[ $art ]*
+      elementDefOrExtend[ $art, true ]*
       '}' { this.finalizeDictOrArray( $art.elements ); }
       { this.checkExtensionDict( $art.elements ); }
       optionalSemi
@@ -995,7 +992,7 @@ extendWithOptElementsNoWith[ art ]
     annotationAssignment_ll1[ $art ]*
     (
       '{' { $art.elements = this.createDict(); }
-      elementDefOrExtend[ $art, true ]*
+      elementDefOrExtend[ $art ]*
       '}' { this.finalizeDictOrArray( $art.elements ); }
       { this.checkExtensionDict( $art.elements ); }
       optionalSemi
@@ -1006,7 +1003,7 @@ extendWithOptElementsNoWith[ art ]
 
 // For `extend … with elements` or `extend entity … with`, `extend aspect … with`,
 // i.e. definitions in { … } are never enums
-elementDefOrExtend[ outer, mightBeEnum = false ] locals[ art = {} ]
+elementDefOrExtend[ outer, explicitElement = false ] locals[ art = new parser.XsnArtifact() ]
 @after { /* #ATN 1 */ }  // if ($art) this.attachLocation( $art ); }
   :
     { $art.location = this.startLocation();; this.docComment( $art ); }
@@ -1016,7 +1013,7 @@ elementDefOrExtend[ outer, mightBeEnum = false ] locals[ art = {} ]
       EXTEND
       extendElement[ $art, $outer ]
     |
-      elementDefInner[ $art, $outer, $mightBeEnum ]
+      elementDefInner[ $art, $outer, $explicitElement ]
     )
   ;
 
@@ -1030,7 +1027,7 @@ extendElement[ art, outer ]
     extendWithOptElementsOrType[ $art, $art ]
   ;
 
-annotateArtifact[ art, outer ] locals[ name = {}, elemName = {} ]
+annotateArtifact[ art, outer ] locals[ name = new parser.XsnName(), elemName = new parser.XsnName() ]
 @after { this.attachLocation( $art ); }
   :
     simplePath[ $name, 'Annotate' ]
@@ -1090,7 +1087,7 @@ annotateArtifact[ art, outer ] locals[ name = {}, elemName = {} ]
     )
   ;
 
-annotateElement[ outer ] locals[ art = {} ]
+annotateElement[ outer ] locals[ art = new parser.XsnArtifact() ]
 @after{ this.attachLocation( $art ); }
   :
     { $art.location = this.startLocation();; this.docComment( $art ); }
@@ -1110,7 +1107,7 @@ annotateElement[ outer ] locals[ art = {} ]
     )
   ;
 
-annotateAction [ outer ] locals [ art = {} ]
+annotateAction [ outer ] locals [ art = new parser.XsnArtifact() ]
 @after{ this.attachLocation( $art ); }
   :
     { $art.location = this.startLocation();; this.docComment( $art ); }
@@ -1138,7 +1135,7 @@ annotateAction [ outer ] locals [ art = {} ]
 annotateReturns[ art ]
 @after{ this.attachLocation( $art.returns ); }
   :
-    ret=RETURNS { $art.returns = { kind: 'annotate' }; }
+    ret=RETURNS { $art.returns = new this.XsnArtifact();; $art.returns.kind = 'annotate'; }
     { this.docComment( $art.returns ); }
     annotationAssignment_ll1[ $art.returns ]*
     ( '{' { $art.returns.elements = this.createDict(); }
@@ -1150,7 +1147,7 @@ annotateReturns[ art ]
     )
   ;
 
-annotateParam [ outer ] locals [ art = {} ]
+annotateParam [ outer ] locals [ art = new parser.XsnArtifact() ]
 @after{ this.attachLocation( $art ); }
   :
     { $art.location = this.startLocation();; this.docComment( $art ); }
@@ -1424,9 +1421,12 @@ typeAssociationCont[ art ]
         )*
       )?
       '}' { this.finalizeDictOrArray( $art.foreignKeys ); }
+      defaultAndNullability[ $art ]?
     |
       ON cond=condition
       { $art.on=$cond.cond; }
+    |
+      defaultAndNullability[ $art ]
     )
   ;
 
@@ -1442,12 +1442,12 @@ typeAssociationElementCont[ art ] // including Composition
         )*
       )?
       '}' { this.finalizeDictOrArray( $art.foreignKeys ); }
-      nullability[ $art ]?
+      defaultAndNullability[ $art ]?
     |
       ON cond=condition
       { $art.on=$cond.cond; }
     |
-      nullability[ $art ]
+      defaultAndNullability[ $art ]
     )?
     { this.docComment( $art ); }
     annotationAssignment_ll1[ $art ]*
@@ -1515,7 +1515,7 @@ nullability[ art ]
   | n1=NULL
   ;
 
-foreignKey[ outer ] locals[ art = {}, elem = {} ]
+foreignKey[ outer ] locals[ art = new parser.XsnArtifact(), elem = {} ]
 @after { this.attachLocation($art); }
   :
     simplePath[ $elem, 'ref' ] { $art.targetElement = $elem; }
@@ -1784,7 +1784,7 @@ tableTerm returns [ table ]
       }
       ':' fromPath[ $table, 'ref']
     )?
-    ( AS n1=ident['FromAlias'] { $table.name = $n1.id }
+    ( AS n1=ident['FromAlias'] { $table.name = $n1.id; }
     | n2=identNoKeyword['FromAlias'] { $table.name = this.fragileAlias( $n2.id ); }
       // if we would use rule `ident`, we would either had to make all JOIN
       // kinds reserved or introduce ATN
@@ -1823,7 +1823,7 @@ fromPath[ qp, idkind ] returns[ dotAfterFilter = null ]
         if (!$qp.scope) $qp.scope = $qp.path.length;
       } }
       '.' id=ident[$idkind] { this.pushIdent( $qp.path, $id.id ); }
-      ( fromArguments[ $id.id ] cardinalityAndFilter[ $id.id ]? 
+      ( fromArguments[ $id.id ] cardinalityAndFilter[ $id.id ]?
         { if (!$dotAfterFilter) $dotAfterFilter = false; }
       | cardinalityAndFilter[ $id.id ]
         { if (!$dotAfterFilter) $dotAfterFilter = false; }
@@ -1887,7 +1887,7 @@ selectItemDef[ outer ] locals[ art ]
     star='*'
     { $outer.push( this.valueWithTokenLocation( '*', $star ) ); }
   |
-    { $art = {};; this.docComment( $art ); }
+    { $art = new this.XsnArtifact();; this.docComment( $art ); }
     annotationAssignment_atn[ $art ]*
     // VIRTUAL is keyword, except if before the following tokens texts:
     { this.setLocalToken( 'VIRTUAL', 'VIRTUAL', /^([,.:\[@]|as)$/i ) ; } // not '{'
@@ -1904,7 +1904,7 @@ selectItemDefBody[ art, outer ] locals[ assoc ]
       e=expression { $art.value = $e.expr; }
       // we cannot use 'condition' instead, as long as we allow aliases without
       // AS (using rule 'ident' instead of 'identNoKeyword') -> ambiguities
-      ( as=AS n1=ident['Item'] { $art.name = $n1.id }
+      ( as=AS n1=ident['Item'] { $art.name = $n1.id; }
       | n2=ident['Item'] { $art.name = this.fragileAlias( $n2.id, true ); }
       | { this.classifyImplicitName( 'Item', $e.expr ); }
       )
@@ -1929,7 +1929,7 @@ selectItemDefBody[ art, outer ] locals[ assoc ]
     |
       selectItemInlineList[ $art, 'expand' ]
       excludingClause[ $art ]?
-      AS n1=ident['Item'] { $art.name = $n1.id }
+      AS n1=ident['Item'] { $art.name = $n1.id; }
     )
     { this.docComment( $art ); }
     annotationAssignment_fix[ $art ]*
@@ -1995,7 +1995,7 @@ selectItemInlineDef[ outer ] locals[ art ]
     star='*'
     { $outer.push( this.valueWithTokenLocation( '*', $star ) ); }
   |
-    { $art = {};; this.docComment( $art ); }
+    { $art = new this.XsnArtifact();; this.docComment( $art ); }
     annotationAssignment_atn[ $art ]*
     selectItemDefBody[ $art, $outer ]
   ;
@@ -2312,7 +2312,7 @@ expressionTerm returns [ expr ] locals [ args = [] ]
     )
   ;
 
-specialFunction returns [ ret = {} ] locals[ art = {} ]
+specialFunction returns [ ret = {} ] locals[ art = new parser.XsnArtifact() ]
   :
     ca=CAST '('                 // see createArray() in action
     {
@@ -2663,7 +2663,7 @@ annotationAssignment_fix[ art ] locals[ assignment ]
     (
       annotationAssignment_paren[ $art ]
     |
-      { $assignment = { name: {} }; }
+      { $assignment = { name: new this.XsnName() }; }
       annotationPath[ $assignment.name, 'anno' ]
       ( '#' annotationPathVariant[ $assignment.name ] )?
       { this.warnIfColonFollows( $assignment ); }
@@ -2681,7 +2681,7 @@ annotationAssignment_ll1[ art ] locals[ assignment ]
     (
       annotationAssignment_paren[ $art ]
     |
-      { $assignment = { name: {} }; }
+      { $assignment = { name: new this.XsnName() }; }
       annotationPath[ $assignment.name, 'anno' ]
       ( '#' annotationPathVariant[ $assignment.name ] )?
       (
@@ -2703,7 +2703,7 @@ annotationAssignment_atn[ art ] locals[ assignment ]
     (
       annotationAssignment_paren[ $art ]
     |
-      { $assignment = { name: {} }; }
+      { $assignment = { name: new this.XsnName() }; }
       annotationPath[ $assignment.name, 'anno' ]
       // '#' is in the follow set of this rule, as it is used in rule "selectItemDef"
       // before an "expression" which can start with a '#' for an enum value
@@ -2749,7 +2749,7 @@ annotationAssignment_paren[ art ]
     ')'
   ;
 
-annotationAssignment_1[ art ] locals[ assignment = { name: {} } ]
+annotationAssignment_1[ art ] locals[ assignment = { name: new parser.XsnName() } ]
 @after { this.assignAnnotation( $art, $assignment ); }
   :
     annotationPath[ $assignment.name, 'anno' ]
@@ -2865,7 +2865,7 @@ annoValueBase[ assignment ] locals [ seenEllipsis = false ]
     ')'
   ;
 
-flattenedValue[ assignment ] locals[ val = { name: {} } ]
+flattenedValue[ assignment ] locals[ val = { name: new parser.XsnName() } ]
   :
     at='@'? annotationPath[ $val.name, 'name', $at ]
     ( '#' annotationPathVariant[ $val.name ] )?
@@ -2876,7 +2876,7 @@ flattenedValue[ assignment ] locals[ val = { name: {} } ]
     { $assignment['$'+'flatten'].push( $val ); }
   ;
 
-namedValue[ struct ] locals[ val = { name: {} } ]
+namedValue[ struct ] locals[ val = { name: new parser.XsnName() } ]
   :
     at='@'? annotationPath[ $val.name, 'name', $at ]
     ( ':' { this.meltKeywordToIdentifier(true); }

package/lib/language/multiLineStringParser.js

@@ -6,6 +6,7 @@ const {
   cdlNewLineRegEx,
 } = require('./textUtils');
 const { CompilerAssertion } = require('../base/error');
+const { CsnLocation } = require('../compiler/classes');
 
 /**
  * Strips and counts the indentation from the given string.
@@ -462,6 +463,7 @@ class MultiLineStringParser {
    */
   _locationForCharacters(i, width) {
     return {
+      __proto__: CsnLocation.prototype,
       file: this.parser.filename,
       line: this.token.line + this._lineInString,
       endLine: this.token.line + this._lineInString,

package/lib/main.d.ts

@@ -466,6 +466,11 @@ declare namespace compiler {
    */
   export class CompilationError extends Error {
       constructor(messages: CompileMessage[], model?: any, text?: string, ...args: any[]);
+      /**
+       * String to identify this class. Can be used instead of relying on `instanceof`.
+       * @since v4.0.0
+       */
+      code = 'ERR_CDS_COMPILATION_FAILURE';
       messages: CompileMessage[];
       toString(): string;
       /**

package/lib/model/csnRefs.js

@@ -49,14 +49,14 @@
 //    inspectRef() - to enable caching.
 //
 // If any of these conditions are not given, our functions usually simply
-// throws an exception (which might even be a plain TypeError), but it might
+// throw an exception (which might even be a plain TypeError), but it might
 // also just return any value.  CSN processors can provide user-friendly error
 // messages by calling the Core Compiler in case of exceptions.  For details,
 // see internalDoc/CoreCompiler.md#use-of-the-core-compiler-for-csn-processors.
 
 // During a transformation, care must be taken to adhere to these conditions.
 // E.g. a structure flattening function cannot create an element `s_x` and
-// delete `s` and then still expects inspectRef() to be able to resolve a
+// delete `s` and then still expect inspectRef() to be able to resolve a
 // reference `['s', 'x']`.
 
 // There are currently 3 (SQL) backend issues for which we provide a workaround:
@@ -205,15 +205,14 @@ const artifactProperties = [ 'elements', 'columns', 'keys', 'mixin', 'enum',
 // - lexical: false | Function - determines where to look first for “lexical names”
 // - dynamic: String - describes the dynamic environment (if in query)
 // - assoc: String, with dynamic: 'global' - what to do with assoc steps
-//   * 'static': visit elements of anonymous aspect if not last ref item
 //   * 'target': always follow target, including last ref item
-//   * other (& not provided) = follow target if not last ref item
+//   * other (& not provided) = follow target (targetAspect if no target) if not last ref item
 const referenceSemantics = {
   $init: { $initOnly: true },
-  type: { lexical: false, dynamic: 'global', assoc: 'static' },
-  includes: { lexical: false, dynamic: 'global', assoc: 'static' }, // no elem ref anyway
-  target: { lexical: false, dynamic: 'global', assoc: 'static' },   // no elem ref anyway
-  targetAspect: { lexical: false, dynamic: 'global', assoc: 'static' },
+  type: { lexical: false, dynamic: 'global' },
+  includes: { lexical: false, dynamic: 'global' },
+  target: { lexical: false, dynamic: 'global' },
+  targetAspect: { lexical: false, dynamic: 'global' },
   from: { lexical: false, dynamic: 'global', assoc: 'target' },
   keys: { lexical: false, dynamic: 'target' },
   keys_origin: { lexical: false, dynamic: 'target' },
@@ -265,6 +264,9 @@ function csnRefs( csn, universalReady ) {
     queryOrMain,
     getColumn: elem => getCache( elem, '_column' ),
     getElement: col => getCache( col, '_element' ),
+    /** Returns the column's name; either explicit, implicit or internal one. */
+    getColumnName: col => getCache( col, '$as' ),
+    $getQueries: def => getCache( def, '$queries' ), // unstable API
     initDefinition,
     dropDefinitionCache,
     targetAspect,
@@ -314,7 +316,7 @@ function csnRefs( csn, universalReady ) {
       env = effectiveType( env.items );
     if (env.elements)           // shortcut
       return env;
-    const target = (staticAssoc ? targetAspect( env ) : env.target);
+    const target = (staticAssoc ? targetAspect( env ) : env.target || env.targetAspect);
     if (typeof target !== 'string')
       return target || env;
     const def = csn.definitions[target];
@@ -352,7 +354,7 @@ function csnRefs( csn, universalReady ) {
 
   function fromArtifactRef( ref ) {
     // do not cache while there is second param
-    const art = artifactFromRef( ref, true );
+    const art = artifactFromRef( ref );
     if (art)
       return art;
     throw new ModelError( `Unknown artifact reference: ${ typeof ref !== 'string' ? JSON.stringify(ref.ref) : ref }` );
@@ -363,7 +365,7 @@ function csnRefs( csn, universalReady ) {
     let art = csn.definitions[pathId( head )];
     initDefinition( art );
     for (const elem of tail) {
-      const env = navigationEnv( art, true );
+      const env = navigationEnv( art );
       art = env.elements[pathId( elem )];
     }
     return art;
@@ -758,7 +760,7 @@ function csnRefs( csn, universalReady ) {
       qcache.elements = elements;
       const { columns } = qcache._select;
       if (elements && columns)
-        columns.map( c => initColumnElement( c, qcache ) );
+        columns.map( (col, colIndex) => initColumnElement( col, colIndex, qcache ) );
       else if (columns && !elements)
         throw new ModelError( `Query elements not available: ${ Object.keys( (index ? qcache._select : main) ).join('+') }`);
     } );
@@ -784,16 +786,19 @@ function csnRefs( csn, universalReady ) {
       : { $aliases: Object.create(null), $next: pcache.$next };
   }
 
-  function initColumnElement( col, parentElementOrQueryCache ) {
+  function initColumnElement( col, colIndex, parentElementOrQueryCache ) {
     if (col === '*')
       return;
     if (col.inline) {
-      col.inline.map( c => initColumnElement( c, parentElementOrQueryCache ) );
+      col.inline.map( c => initColumnElement( c, null, parentElementOrQueryCache ) );
       return;
     }
     setCache( col, '_parent',   // not set for query (has property _select)
               !parentElementOrQueryCache._select && parentElementOrQueryCache );
-    const as = col.as || col.func || implicitAs( col.ref );
+    let as = columnAlias( col );
+    if (!as && colIndex !== null)
+      as = `$_column_${ colIndex + 1 }`;
+    setCache( col, '$as', as );
     let type = parentElementOrQueryCache;
     while (type.items)
       type = type.items;
@@ -801,7 +806,7 @@ function csnRefs( csn, universalReady ) {
     if (elem)                   // TODO to.sql: something is strange if this is not set
       setCache( elem, '_column', col );
     if (col.expand)
-      col.expand.map( c => initColumnElement( c, elem ) );
+      col.expand.map( c => initColumnElement( c, null, elem ) );
   }
 
   // property name convention in cache:
@@ -843,10 +848,11 @@ function csnRefs( csn, universalReady ) {
   }
 }
 
-// Return value of a query SELECT for the query node, or the main artifact,
-// i.e. a value with an `elements` property.
-// TODO: only used in forRelationalDB - move somewhere else
 /**
+ * Return value of a query SELECT for the query node, or the main artifact,
+ * i.e. a value with an `elements` property.
+ * TODO: only used in forRelationalDB - move somewhere else
+ *
  * @param {object} query node (object with SET or SELECT property)
  * @param {object} main definition
  */
@@ -1122,6 +1128,17 @@ function isSelectQuery( query ) {
   return true;
 }
 
+/**
+ * Alias is either explicit or implicit from reference or function without arguments.
+ * If the column is an expression without explicit alias, `false` is returned.
+ * Use csnRefs.getColumnName() instead.
+ *
+ * @returns {string|false}
+ */
+function columnAlias( col ) {
+  return col.as || (!col.args && col.func) || (col.ref && implicitAs( col.ref ));
+}
+
 module.exports = {
   csnRefs,
   traverseQuery,
@@ -1129,4 +1146,5 @@ module.exports = {
   implicitAs,
   analyseCsnPath,
   pathId,
+  columnAlias,
 };