com.google.gwt.dev

Class DevModeBase

java.lang.Object

com.google.gwt.dev.DevModeBase

All Implemented Interfaces:

DoneCallback, UiCallback

Direct Known Subclasses:

DevMode

public abstract class DevModeBase
extends Object
implements DoneCallback

The main executable class for the hosted mode shell. This class must not have any GUI dependencies.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DevModeBase.ArgHandlerBindAddress Handles the -bindAddress command line flag.
protected static class	DevModeBase.ArgHandlerBlacklist Handles the -blacklist command line argument.
protected static class	DevModeBase.ArgHandlerCodeServerPort Handles the -codeServerPort command line flag.
protected static class	DevModeBase.ArgHandlerLogDir Handles the -logdir command line option.
protected static class	DevModeBase.ArgHandlerNoServerFlag Runs a convenient embedded web server.
protected static class	DevModeBase.ArgHandlerPort Handles the -port command line flag.
protected static class	DevModeBase.ArgHandlerRemoteUI Handles the -remoteUI command line flag.
protected static class	DevModeBase.ArgHandlerWhitelist Handles the -whitelist command line flag.
protected static class	DevModeBase.ArgProcessor The base dev mode argument processor.
protected static interface	DevModeBase.HostedModeBaseOptions Base options for dev mode.
protected static class	DevModeBase.HostedModeBaseOptionsImpl Concrete class to implement all hosted mode base options.
protected static interface	DevModeBase.OptionBindAddress Controls what local address to bind to.
protected static interface	DevModeBase.OptionCodeServerPort Controls what port the code server listens on.
protected static interface	DevModeBase.OptionLogDir Controls whether and where to log data to file.
protected static interface	DevModeBase.OptionNoServer Controls whether to run a server or not.
protected static interface	DevModeBase.OptionPort Controls what port to use.
protected static interface	DevModeBase.OptionRemoteUI Controls the UI that should be used to display the dev mode server's data.
protected static interface	DevModeBase.OptionStartupURLs Controls the startup URLs.
class	DevModeBase.UiBrowserWidgetHostImpl Implementation of BrowserWidgetHost that supports the abstract UI interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected TreeLogger.Type	baseLogLevelForUI
protected BrowserWidgetHost	browserHost
protected CompilerContext	compilerContext
protected CompilerContext.Builder	compilerContextBuilder
protected String	connectAddress
protected boolean	isHttps
protected DevModeBase.HostedModeBaseOptions	options
protected DevModeUI	ui

Constructor Summary

Constructors

Constructor and Description
DevModeBase()

Method Summary

Modifier and Type	Method and Description
void	addStartupURL(String url)
protected long	checkForUpdatesInterval() Derived classes can override to lengthen ping delay.
protected abstract DevModeBase.HostedModeBaseOptions	createOptions()
protected ShellModuleSpaceHost	doCreateShellModuleSpaceHost(TreeLogger logger, CompilationState compilationState, ModuleDef moduleDef) Creates an instance of ShellModuleSpaceHost (or a derived class) using the specified constituent parts.
protected abstract void	doShutDownServer()
protected boolean	doSlowStartup() Perform any slower startup tasks, such as loading modules.
protected abstract boolean	doStartup()
protected boolean	doStartup(File persistentCacheDir) Perform any startup tasks, including initializing the UI (if any) and the logger, updates checker, and the development mode code server.
protected abstract int	doStartUpServer()
protected abstract void	ensureCodeServerListener()
TreeLogger.Type	getBaseLogLevelForUI() Gets the base log level recommended by the UI for INFO-level messages.
protected String	getHost()
int	getPort()
TreeLogger	getTopLogger()
protected void	inferStartupUrls() Add any plausible HTML files which might be used as startup URLs.
protected boolean	isHeadless() By default we will open the application window.
protected StandardLinkerContext	link(TreeLogger logger, ModuleDef module) Perform an initial hosted mode link, without overwriting newer or unmodified files in the output folder.
protected ModuleDef	loadModule(TreeLogger logger, String moduleName, boolean refresh) Load a module.
protected abstract URL	makeStartupUrl(String url)
static String	normalizeURL(String unknownUrlText, boolean isHttps, int port, String host)
void	onDone() Callback for the UI to indicate it is done.
protected abstract void	produceOutput(TreeLogger logger, StandardLinkerContext linkerStack, ArtifactSet artifacts, ModuleDef module, boolean isRelink)
protected static String	randomString() Produce a random string that has low probability of collisions.
void	run() Sets up all the major aspects of running the shell graphically, including creating the main window and optionally starting an embedded web server.
protected void	setDone()
protected void	setHeadless(boolean headlessMode)
void	setPort(int port)
void	setRunTomcat(boolean run)
protected void	shutDown()
protected boolean	startUp()
protected abstract void	warnAboutNoStartupUrls() Log a warning explaining that no startup URLs were specified and no plausible startup URLs were found.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Field Detail

baseLogLevelForUI

protected TreeLogger.Type baseLogLevelForUI

connectAddress

protected String connectAddress

isHttps

protected boolean isHttps

options

protected final DevModeBase.HostedModeBaseOptions options

compilerContextBuilder

protected final CompilerContext.Builder compilerContextBuilder

compilerContext

protected CompilerContext compilerContext

ui

protected DevModeUI ui

browserHost

protected BrowserWidgetHost browserHost

Constructor Detail

DevModeBase

public DevModeBase()

Method Detail

normalizeURL

public static String normalizeURL(String unknownUrlText,
                                  boolean isHttps,
                                  int port,
                                  String host)

randomString

protected static String randomString()

Produce a random string that has low probability of collisions.

In this case, we use 16 characters, each drawn from a pool of 94, so the number of possible values is 94^16, leading to an expected number of values used before a collision occurs as sqrt(pi/2) * 94^8 (treated the same as a birthday attack), or a little under 10^16.

This algorithm is also implemented in hosted.html, though it is not technically important that they match.

Returns:

a random string

addStartupURL

public final void addStartupURL(String url)

getBaseLogLevelForUI

public TreeLogger.Type getBaseLogLevelForUI()

Gets the base log level recommended by the UI for INFO-level messages. This method can only be called once createUI() has been called. Please do not depend on this method, as it is subject to change.

Returns:

the log level to use for INFO-level messages

getPort

public final int getPort()

getTopLogger

public TreeLogger getTopLogger()

onDone

public void onDone()

Callback for the UI to indicate it is done.

Specified by:

onDone in interface DoneCallback

run

public final void run()

Sets up all the major aspects of running the shell graphically, including creating the main window and optionally starting an embedded web server.

setPort

public final void setPort(int port)

setRunTomcat

public final void setRunTomcat(boolean run)

checkForUpdatesInterval

protected long checkForUpdatesInterval()

Derived classes can override to lengthen ping delay.

createOptions

protected abstract DevModeBase.HostedModeBaseOptions createOptions()

doCreateShellModuleSpaceHost

protected final ShellModuleSpaceHost doCreateShellModuleSpaceHost(TreeLogger logger,
                                                                  CompilationState compilationState,
                                                                  ModuleDef moduleDef)
                                                           throws UnableToCompleteException

Creates an instance of ShellModuleSpaceHost (or a derived class) using the specified constituent parts. This method is made to be overridden for subclasses that need to change the behavior of ShellModuleSpaceHost.

Parameters:

logger - TreeLogger to use

compilationState -

moduleDef -

Returns:

ShellModuleSpaceHost instance

Throws:

UnableToCompleteException

doShutDownServer

protected abstract void doShutDownServer()

doSlowStartup

protected boolean doSlowStartup()

Perform any slower startup tasks, such as loading modules. This is separate from doStartup() so that the UI can be updated as soon as possible and the web server can be started earlier.

Returns:

false if startup failed

doStartup

protected abstract boolean doStartup()

doStartup

protected boolean doStartup(File persistentCacheDir)

Perform any startup tasks, including initializing the UI (if any) and the logger, updates checker, and the development mode code server.

Subclasses that override this method should be careful what facilities are used before the super implementation is called.

Returns:

true if startup was successful

doStartUpServer

protected abstract int doStartUpServer()

ensureCodeServerListener

protected abstract void ensureCodeServerListener()

getHost

protected String getHost()

inferStartupUrls

protected void inferStartupUrls()

Add any plausible HTML files which might be used as startup URLs. Found URLs should be added to options.addStartupUrl(url).

isHeadless

protected final boolean isHeadless()

By default we will open the application window.

Returns:

true if we are running in headless mode

link

protected final StandardLinkerContext link(TreeLogger logger,
                                           ModuleDef module)
                                    throws UnableToCompleteException

Perform an initial hosted mode link, without overwriting newer or unmodified files in the output folder.

Parameters:

logger - the logger to use

module - the module to link

Throws:

UnableToCompleteException

loadModule

protected ModuleDef loadModule(TreeLogger logger,
                               String moduleName,
                               boolean refresh)
                        throws UnableToCompleteException

Load a module.

Parameters:

logger - TreeLogger to use

moduleName - name of the module to load

refresh - if true, refresh the module from disk

Returns:

the loaded module

Throws:

UnableToCompleteException

makeStartupUrl

protected abstract URL makeStartupUrl(String url)
                               throws UnableToCompleteException

Throws:

UnableToCompleteException

produceOutput

protected abstract void produceOutput(TreeLogger logger,
                                      StandardLinkerContext linkerStack,
                                      ArtifactSet artifacts,
                                      ModuleDef module,
                                      boolean isRelink)
                               throws UnableToCompleteException

Throws:

UnableToCompleteException

setDone

protected final void setDone()

setHeadless

protected final void setHeadless(boolean headlessMode)

shutDown

protected final void shutDown()

startUp

protected final boolean startUp()

warnAboutNoStartupUrls

protected abstract void warnAboutNoStartupUrls()

Log a warning explaining that no startup URLs were specified and no plausible startup URLs were found.