com.google.javascript.jscomp.deps

Class JsFileParser

java.lang.Object

com.google.javascript.jscomp.deps.JsFileLineParser

com.google.javascript.jscomp.deps.JsFileParser

@GwtIncompatible(value="java.util.regex")
public final class JsFileParser
extends JsFileLineParser

A parser that can extract goog.require() and goog.provide() dependency information from a .js file.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.javascript.jscomp.deps.JsFileLineParser

JsFileLineParser.ParseException

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	BASE_JS_START The first non-comment line of base.js
private boolean	fileHasProvidesOrRequires
private boolean	fileIsModule
private static Pattern	GOOG_PROVIDE_REQUIRE_PATTERN Pattern for matching goog.provide(*) and goog.require(*).
private Matcher	googMatcher Matchers used in the parsing.
private boolean	includeGoogBase Whether to provide/require the root namespace.
private static java.util.logging.Logger	logger
private java.util.List<java.lang.String>	provides The info for the file we are currently parsing.
private java.util.List<java.lang.String>	requires

Fields inherited from class com.google.javascript.jscomp.deps.JsFileLineParser

errorManager, filePath, lineNum, PARSE_ERROR, PARSE_WARNING, parseSucceeded, shortcutMode

Constructor Summary

Constructors

Constructor and Description
JsFileParser(ErrorManager errorManager) Constructor

Method Summary

Modifier and Type	Method and Description
DependencyInfo	parseFile(java.lang.String filePath, java.lang.String closureRelativePath, java.lang.String fileContents) Parses the given file and returns the dependency information that it contained.
protected boolean	parseLine(java.lang.String line) Parses a line of JavaScript, extracting goog.provide and goog.require information.
private DependencyInfo	parseReader(java.lang.String filePath, java.lang.String closureRelativePath, java.io.Reader fileContents)
JsFileParser	setIncludeGoogBase(boolean include) Sets whether we should create implicit provides and requires of the root namespace.

Methods inherited from class com.google.javascript.jscomp.deps.JsFileLineParser

didParseSucceed, doParse, parseJsString, parseJsStringArray, parseJsStringMap, setShortcutMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private static java.util.logging.Logger logger

GOOG_PROVIDE_REQUIRE_PATTERN

private static final Pattern GOOG_PROVIDE_REQUIRE_PATTERN

Pattern for matching goog.provide(*) and goog.require(*).

BASE_JS_START

private static final java.lang.String BASE_JS_START

The first non-comment line of base.js

See Also:

Constant Field Values

googMatcher

private Matcher googMatcher

Matchers used in the parsing.

provides

private java.util.List<java.lang.String> provides

The info for the file we are currently parsing.

requires

private java.util.List<java.lang.String> requires

fileHasProvidesOrRequires

private boolean fileHasProvidesOrRequires

fileIsModule

private boolean fileIsModule

includeGoogBase

private boolean includeGoogBase

Whether to provide/require the root namespace.

Constructor Detail

JsFileParser

public JsFileParser(ErrorManager errorManager)

Constructor

Parameters:

errorManager - Handles parse errors.

Method Detail

setIncludeGoogBase

public JsFileParser setIncludeGoogBase(boolean include)

Sets whether we should create implicit provides and requires of the root namespace. When generating deps files, you do not want this behavior. Deps files need base.js to run anyway, so they don't need information about it. When generating abstract build graphs, you probably do want this behavior. It will create an implicit dependency of all files with provides/requires on base.js.

Returns:

this for easy chaining.

parseFile

public DependencyInfo parseFile(java.lang.String filePath,
                                java.lang.String closureRelativePath,
                                java.lang.String fileContents)

Parses the given file and returns the dependency information that it contained.

Parameters:

filePath - Path to the file to parse.

closureRelativePath - Path of the file relative to closure.

fileContents - The contents to parse.

Returns:

A DependencyInfo containing all provides/requires found in the file.

parseReader

private DependencyInfo parseReader(java.lang.String filePath,
                                   java.lang.String closureRelativePath,
                                   java.io.Reader fileContents)

parseLine

protected boolean parseLine(java.lang.String line)
                     throws JsFileLineParser.ParseException

Parses a line of JavaScript, extracting goog.provide and goog.require information.

Specified by:

parseLine in class JsFileLineParser

Parameters:

line - The line to parse.

Returns:

true to keep going, false otherwise.

Throws:

JsFileLineParser.ParseException - Should be thrown to signify a problem with the line.