JS: Autoformat {AST,HTML}Extractor.java

asgerf · asgerf · commit 2553338bce8e · 2021-08-19T14:54:05.000+02:00
diff --git a/javascript/extractor/src/com/semmle/js/extractor/ASTExtractor.java b/javascript/extractor/src/com/semmle/js/extractor/ASTExtractor.java
@@ -174,30 +174,31 @@ public class ASTExtractor {
   private final RegExpExtractor regexpExtractor;
   private final ExtractorConfig config;
 
-  public ASTExtractor(ExtractorConfig config, LexicalExtractor lexicalExtractor, ScopeManager scopeManager) {
+  public ASTExtractor(
+      ExtractorConfig config, LexicalExtractor lexicalExtractor, ScopeManager scopeManager) {
     this.config = config;
     this.trapwriter = lexicalExtractor.getTrapwriter();
     this.locationManager = lexicalExtractor.getLocationManager();
     this.contextManager = new SyntacticContextManager();
     this.scopeManager = scopeManager;
     this.lexicalExtractor = lexicalExtractor;
     this.regexpExtractor = new RegExpExtractor(trapwriter, locationManager);
-    this.toplevelLabel = makeTopLevelLabel(trapwriter, locationManager.getFileLabel(), locationManager.getStartLine(), locationManager.getStartColumn());
+    this.toplevelLabel =
+        makeTopLevelLabel(
+            trapwriter,
+            locationManager.getFileLabel(),
+            locationManager.getStartLine(),
+            locationManager.getStartColumn());
   }
 
   /**
    * Returns the label for the top-level starting at the given location.
-   * <p>
-   * May be used to refer to the top-level before it has been extracted.
+   *
+   * <p>May be used to refer to the top-level before it has been extracted.
    */
-  public static Label makeTopLevelLabel(TrapWriter trapWriter, Label fileLabel, int startLine, int startColumn) {
-    return trapWriter.globalID(
-        "script;{"
-            + fileLabel
-            + "},"
-            + startLine
-            + ','
-            + startColumn);
+  public static Label makeTopLevelLabel(
+      TrapWriter trapWriter, Label fileLabel, int startLine, int startColumn) {
+    return trapWriter.globalID("script;{" + fileLabel + "}," + startLine + ',' + startColumn);
   }
 
   public TrapWriter getTrapwriter() {
@@ -254,8 +255,8 @@ public enum IdContext {
     TYPE_LABEL,
 
     /**
-     * An identifier that refers to a variable from inside a type, i.e. the operand to a
-     * <code>typeof</code> type or left operand to an <code>is</code> type.
+     * An identifier that refers to a variable from inside a type, i.e. the operand to a <code>
+     * typeof</code> type or left operand to an <code>is</code> type.
      *
      * <p>This is generally treated as a type, except a variable binding will be emitted for it.
      */
@@ -273,16 +274,16 @@ public enum IdContext {
     /**
      * An identifier that occurs in a type-only import.
      *
-     * These may declare a type and/or a namespace, but for compatibility with our AST,
-     * must be emitted as a VarDecl (with no variable binding).
+     * <p>These may declare a type and/or a namespace, but for compatibility with our AST, must be
+     * emitted as a VarDecl (with no variable binding).
      */
     TYPE_ONLY_IMPORT,
 
     /**
      * An identifier that occurs in a type-only export.
      *
-     * These may refer to a type and/or a namespace, but for compatibility with our AST,
-     * must be emitted as an ExportVarAccess (with no variable binding).
+     * <p>These may refer to a type and/or a namespace, but for compatibility with our AST, must be
+     * emitted as an ExportVarAccess (with no variable binding).
      */
     TYPE_ONLY_EXPORT,
 
@@ -302,8 +303,8 @@ public enum IdContext {
     EXPORT,
 
     /**
-     * An identifier that occurs as a qualified name in a default export expression, such as
-     * <code>A</code> in <code>export default A.B</code>.
+     * An identifier that occurs as a qualified name in a default export expression, such as <code>A
+     * </code> in <code>export default A.B</code>.
      *
      * <p>This acts like {@link #EXPORT}, except it cannot refer to a type (i.e. it must be a
      * variable and/or a namespace).
@@ -314,8 +315,8 @@ public enum IdContext {
      * True if this occurs as part of a type annotation, i.e. it is {@link #TYPE_BIND} or {@link
      * #TYPE_DECL}, {@link #TYPE_LABEL}, {@link #VAR_IN_TYPE_BIND}, or {@link #NAMESPACE_BIND}.
      *
-     * <p>Does not hold for {@link #VAR_AND_TYPE_DECL}, {@link #TYPE_ONLY_IMPORT}, or @{link {@link #TYPE_ONLY_EXPORT}
-     * as these do not occur in type annotations.
+     * <p>Does not hold for {@link #VAR_AND_TYPE_DECL}, {@link #TYPE_ONLY_IMPORT}, or @{link {@link
+     * #TYPE_ONLY_EXPORT} as these do not occur in type annotations.
      */
     public boolean isInsideType() {
       return this == TYPE_BIND
@@ -577,7 +578,9 @@ public Label visit(Literal nd, Context c) {
           Matcher m = TemplateEngines.TEMPLATE_TAGS.matcher(nd.getRaw());
           int offset = nd.getLoc().getStart().getOffset();
           while (m.find()) {
-            Label locationLbl = TemplateEngines.makeLocation(lexicalExtractor.getTextualExtractor(), offset + m.start(), offset + m.end());
+            Label locationLbl =
+                TemplateEngines.makeLocation(
+                    lexicalExtractor.getTextualExtractor(), offset + m.start(), offset + m.end());
             trapwriter.addTuple("expr_contains_template_tag_location", key, locationLbl);
           }
         }
@@ -716,7 +719,8 @@ public Label visit(Program nd, Context c) {
                     + locationManager.getStartLine()
                     + ","
                     + locationManager.getStartColumn());
-        Scope moduleScope = scopeManager.enterScope(ScopeKind.MODULE, moduleScopeKey, toplevelLabel);
+        Scope moduleScope =
+            scopeManager.enterScope(ScopeKind.MODULE, moduleScopeKey, toplevelLabel);
         if (sourceType.hasNoGlobalScope()) {
           scopeManager.setImplicitVariableScope(moduleScope);
         }
@@ -1178,9 +1182,7 @@ public Label visit(Property nd, Context c) {
       return propkey;
     }
 
-    /**
-     * Extracts the string value of <code>expr</code> as an HTML snippet.
-     */
+    /** Extracts the string value of <code>expr</code> as an HTML snippet. */
     private void extractStringValueAsHtml(Expression expr, Label exprLabel) {
       TextualExtractor textualExtractor = lexicalExtractor.getTextualExtractor();
       if (textualExtractor.isSnippet()) {
@@ -1193,16 +1195,21 @@ private void extractStringValueAsHtml(Expression expr, Label exprLabel) {
       String source = sourceAndOffset.fst();
       SourceLocation loc = expr.getLoc();
       Path originalFile = textualExtractor.getExtractedFile().toPath();
-      Path vfile = originalFile.resolveSibling(originalFile.getFileName().toString() + "." + loc.getStart().getLine() + "." + loc.getStart().getColumn() + ".html");
-      SourceMap sourceMap = textualExtractor.getSourceMap().offsetBy(loc.getStart().getOffset(), sourceAndOffset.snd());
-      TextualExtractor innerTextualExtractor = new TextualExtractor(
-          trapwriter,
-          locationManager,
-          source,
-          false,
-          getMetrics(),
-          vfile.toFile(),
-          sourceMap);
+      Path vfile =
+          originalFile.resolveSibling(
+              originalFile.getFileName().toString()
+                  + "."
+                  + loc.getStart().getLine()
+                  + "."
+                  + loc.getStart().getColumn()
+                  + ".html");
+      SourceMap sourceMap =
+          textualExtractor
+              .getSourceMap()
+              .offsetBy(loc.getStart().getOffset(), sourceAndOffset.snd());
+      TextualExtractor innerTextualExtractor =
+          new TextualExtractor(
+              trapwriter, locationManager, source, false, getMetrics(), vfile.toFile(), sourceMap);
       HTMLExtractor html = HTMLExtractor.forEmbeddedHtml(config);
       List<Label> rootNodes = html.extractEx(innerTextualExtractor).fst();
       int rootNodeIndex = 0;
@@ -1212,7 +1219,7 @@ private void extractStringValueAsHtml(Expression expr, Label exprLabel) {
     }
 
     private String tryGetIdentifierName(Expression e) {
-      return e instanceof Identifier ? ((Identifier)e).getName() : null;
+      return e instanceof Identifier ? ((Identifier) e).getName() : null;
     }
 
     private Pair<String, OffsetTranslation> tryGetStringValueFromExpression(Expression e) {
@@ -1232,7 +1239,8 @@ private Pair<String, OffsetTranslation> tryGetStringValueFromExpression(Expressi
           return null;
         }
         TemplateElement element = lit.getQuasis().get(0);
-        return Pair.make((String) element.getCooked(), makeStringLiteralOffsets("`" + element.getRaw() + "`"));
+        return Pair.make(
+            (String) element.getCooked(), makeStringLiteralOffsets("`" + element.getRaw() + "`"));
       }
       return null;
     }
@@ -1677,9 +1685,9 @@ public Label visit(ExportNamedDeclaration nd, Context c) {
       visit(nd.getDeclaration(), lbl, -1);
       visit(nd.getSource(), lbl, -2);
       IdContext childContext =
-          nd.hasSource() ? IdContext.LABEL :
-          nd.hasTypeKeyword() ? IdContext.TYPE_ONLY_EXPORT :
-          IdContext.EXPORT;
+          nd.hasSource()
+              ? IdContext.LABEL
+              : nd.hasTypeKeyword() ? IdContext.TYPE_ONLY_EXPORT : IdContext.EXPORT;
       visitAll(nd.getSpecifiers(), lbl, childContext, 0);
       if (nd.hasTypeKeyword()) {
         trapwriter.addTuple("has_type_keyword", lbl);
@@ -1699,7 +1707,10 @@ public Label visit(ExportSpecifier nd, Context c) {
     public Label visit(ImportDeclaration nd, Context c) {
       Label lbl = super.visit(nd, c);
       visit(nd.getSource(), lbl, -1);
-      IdContext childContext = nd.hasTypeKeyword() ? IdContext.TYPE_ONLY_IMPORT : IdContext.VAR_AND_TYPE_AND_NAMESPACE_DECL;
+      IdContext childContext =
+          nd.hasTypeKeyword()
+              ? IdContext.TYPE_ONLY_IMPORT
+              : IdContext.VAR_AND_TYPE_AND_NAMESPACE_DECL;
       visitAll(nd.getSpecifiers(), lbl, childContext, 0);
       emitNodeSymbol(nd, lbl);
       if (nd.hasTypeKeyword()) {
@@ -2235,10 +2246,14 @@ public Label visit(AngularPipeRef nd, Context c) {
 
     @Override
     public Label visit(GeneratedCodeExpr nd, Context c) {
-        Label key = super.visit(nd, c);
-        Label templateLbl = TemplateEngines.makeLocation(lexicalExtractor.getTextualExtractor(), nd.getLoc().getStart().getOffset(), nd.getLoc().getEnd().getOffset());
-        trapwriter.addTuple("expr_contains_template_tag_location", key, templateLbl);
-        return key;
+      Label key = super.visit(nd, c);
+      Label templateLbl =
+          TemplateEngines.makeLocation(
+              lexicalExtractor.getTextualExtractor(),
+              nd.getLoc().getStart().getOffset(),
+              nd.getLoc().getEnd().getOffset());
+      trapwriter.addTuple("expr_contains_template_tag_location", key, templateLbl);
+      return key;
     }
   }
 
diff --git a/javascript/extractor/src/com/semmle/js/extractor/HTMLExtractor.java b/javascript/extractor/src/com/semmle/js/extractor/HTMLExtractor.java
@@ -153,8 +153,7 @@ public void handleElement(Element elt, HtmlPopulator.Context context) {
     @Override
     public void handleText(
         Source src, int textBegin, int textEnd, Label parentLabel, boolean isCData) {
-      extractTemplateTags(
-          textualExtractor, src, textBegin, textEnd, () -> parentLabel);
+      extractTemplateTags(textualExtractor, src, textBegin, textEnd, () -> parentLabel);
     }
 
     @Override
@@ -392,7 +391,8 @@ private void extractTemplateTags(
     if (isEmbedded) return; // Do not extract template tags for HTML snippets embedded in a JS file
 
     TrapWriter trapwriter = textualExtractor.getTrapwriter();
-    Matcher m = TemplateEngines.TEMPLATE_TAGS.matcher(textualExtractor.getSource()).region(start, end);
+    Matcher m =
+        TemplateEngines.TEMPLATE_TAGS.matcher(textualExtractor.getSource()).region(start, end);
     while (m.find()) {
       int startOffset = m.start();
       int endOffset = m.end();
