com.google.javascript.jscomp.ScopeCreator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of closure-compiler-linter Show documentation

Closure Compiler is a JavaScript optimizing compiler. It parses your JavaScript, analyzes it, removes dead code and rewrites and minimizes what's left. It also checks syntax, variable references, and types, and warns about common JavaScript pitfalls. It is used in many of Google's JavaScript apps, including Gmail, Google Web Search, Google Maps, and Google Docs. This binary checks for style issues such as incorrect or missing JSDoc usage, and missing goog.require() statements. It does not do more advanced checks such as typechecking.

There is a newer version: v20200830

Show newest version

/*
 * Copyright 2006 The Closure Compiler Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.javascript.jscomp;

import com.google.javascript.rhino.Node;

/**
 * This interface defines how objects capable of creating scopes from the parse
 * tree behave.
 *
 */
interface ScopeCreator {
  /**
   * Creates a {@link Scope} object.
   *
   * @param n the root node (either a FUNCTION node, a SCRIPT node, or a
   *    synthetic block node whose children are all SCRIPT nodes)
   * @param parent the parent Scope object (may be null)
   */
  AbstractScope createScope(Node n, AbstractScope parent);

  boolean hasBlockScope();

  /**
   * A scope creator that can be provided to NodeTraversal to ensure that no scopes are actually
   * ever created. This is in contrast to the default Es6SyntacticScopeCreator, which will create
   * scopes on demand.
   */
  ScopeCreator ASSERT_NO_SCOPES_CREATED =
      new ScopeCreator() {
        @Override
        public AbstractScope createScope(Node n, AbstractScope parent) {
          throw new IllegalStateException(
              "ScopeCreator.ASSERT_NO_SCOPES_CREATED cannot create child scopes.");
        }

        @Override
        public boolean hasBlockScope() {
          return true;
        }
      };
}