net.minecraftforge.gradle.user

Class UserBasePlugin<T extends UserBaseExtension>

java.lang.Object

net.minecraftforge.gradle.common.BasePlugin<T>

net.minecraftforge.gradle.user.UserBasePlugin<T>

All Implemented Interfaces:

org.gradle.api.Plugin<org.gradle.api.Project>

Direct Known Subclasses:

PatcherUserBasePlugin, UserVanillaBasePlugin

public abstract class UserBasePlugin<T extends UserBaseExtension>
extends BasePlugin<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	useLocalCache A boolean used to cache the output of useLocalCache;

Fields inherited from class net.minecraftforge.gradle.common.BasePlugin

otherPlugin, project, replacer

Constructor Summary

Constructors

Constructor and Description
UserBasePlugin()

Method Summary

Modifier and Type	Method and Description
protected void	addAtsToDeobf()
protected abstract void	afterDecomp(boolean isDecomp, boolean useLocalCache, java.lang.String mcConfig) This method should add the MC dependency to the supplied config, as well as do any extra configuration that requires the provided information.
protected void	afterEvaluate()
void	applyPlugin()
protected abstract void	applyUserPlugin()
protected java.lang.Object	chooseDeobfOutput(java.lang.String globalPattern, java.lang.String localPattern, java.lang.String appendage, java.lang.String classifier) This method returns an object that resolved to the correct pattern based on the useLocalCache() method
protected void	configureCompilation() Creates the api SourceSet and configures the classpaths of all the SourceSets to have MC and the MC deps in them.
protected void	configureEclipse() Configures the eclipse classpath Also creates task that generate the eclipse run configs and attaches them to the eclipse task.
protected void	configureIntellij() Adds the intellij run configs and makes a few other tweaks to the intellij project creation
protected void	configureRetromapping()
protected void	createSourceCopyTasks() Creates and partially configures the source replacement tasks.
protected void	doDepAtExtraction()
protected void	doDevTimeDeobf()
protected abstract java.util.List<java.lang.String>	getClientJvmArgs(T ext) For run configurations.
protected abstract java.util.List<java.lang.String>	getClientRunArgs(T ext) For run configurations.
protected abstract java.lang.String	getClientRunClass(T ext) To be inserted into GradleStart.
protected abstract java.lang.String	getClientTweaker(T ext) To be inserted into GradleStart.
protected TaskDepDummy	getDummyDep(java.lang.String config, DelayedFile dummy, java.lang.String taskName)
protected abstract java.util.List<java.lang.String>	getServerJvmArgs(T ext) For run configurations.
protected abstract java.util.List<java.lang.String>	getServerRunArgs(T ext) For run configurations.
protected abstract java.lang.String	getServerRunClass(T ext) To be inserted into GradleStartServer.
protected abstract java.lang.String	getServerTweaker(T ext) To be inserted into GradleStartServer.
protected abstract java.lang.Object	getStartDir() The location where the GradleStart files will be generated to.
protected abstract boolean	hasClientRun() This method is called early, and not late.
protected abstract boolean	hasServerRun() This method is called early, and not late.
void	injectIntellijRuns(org.w3c.dom.Document doc, java.lang.String module)
protected void	makeDecompTasks(java.lang.String globalPattern, java.lang.String localPattern, java.lang.Object inputJar, java.lang.String inputTask, java.lang.Object mcpPatchSet, java.lang.Object mcpInject)
protected void	makeRunTasks()
protected void	mapConfigurations()
protected void	remapDeps(org.gradle.api.Project project, org.gradle.api.artifacts.Configuration config, java.lang.String resolvedConfig, org.gradle.api.Task dummyTask)
protected void	setupDevTimeDeobf(org.gradle.api.Task compileDummy, org.gradle.api.Task providedDummy)
protected void	setupReobf(ReobfTaskFactory.ReobfTaskWrapper reobf) Sets up the default settings for reobf tasks.
protected boolean	useLocalCache(T extension) This method is called sufficiently late.

Methods inherited from class net.minecraftforge.gradle.common.BasePlugin

addFlatRepo, addMavenRepo, apply, applyExternalPlugin, buildProject, cacheFile, delayedFile, delayedString, delayedTree, doFGVersionCheck, getExtension, getWithEtag, makeTask, makeTask, makeTask, maybeMakeTask, maybeMakeTask, maybeMakeTask, onVersionCheck, parseAndStoreVersion

Methods inherited from class java.lang.Object

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

Field Detail

useLocalCache

protected boolean useLocalCache

A boolean used to cache the output of useLocalCache;

Constructor Detail

UserBasePlugin

public UserBasePlugin()

Method Detail

applyPlugin

public final void applyPlugin()

Specified by:

applyPlugin in class BasePlugin<T extends UserBaseExtension>

afterEvaluate

protected void afterEvaluate()

Overrides:

afterEvaluate in class BasePlugin<T extends UserBaseExtension>

applyUserPlugin

protected abstract void applyUserPlugin()

setupReobf

protected void setupReobf(ReobfTaskFactory.ReobfTaskWrapper reobf)

Sets up the default settings for reobf tasks.

Parameters:

reobf - The task to setup

makeDecompTasks

protected void makeDecompTasks(java.lang.String globalPattern,
                               java.lang.String localPattern,
                               java.lang.Object inputJar,
                               java.lang.String inputTask,
                               java.lang.Object mcpPatchSet,
                               java.lang.Object mcpInject)

chooseDeobfOutput

protected final java.lang.Object chooseDeobfOutput(java.lang.String globalPattern,
                                                   java.lang.String localPattern,
                                                   java.lang.String appendage,
                                                   java.lang.String classifier)

This method returns an object that resolved to the correct pattern based on the useLocalCache() method

Parameters:

globalPattern - The global pattern

localPattern - The local pattern

appendage - The appendage

classifier - The classifier

Returns:

useable deobfsucated output file

useLocalCache

protected boolean useLocalCache(T extension)

This method is called sufficiently late. Either afterEvaluate or inside a task, thus it has the extension object. This method is called to decide whether or not to use the project-local cache instead of the global cache. The actual locations of each cache are specified elsewhere. TODO: add see annotations

Parameters:

extension - The extension object of this plugin

Returns:

whether or not to use the local cache

configureCompilation

protected void configureCompilation()

Creates the api SourceSet and configures the classpaths of all the SourceSets to have MC and the MC deps in them. Also sets the target JDK to java 6

createSourceCopyTasks

protected void createSourceCopyTasks()

Creates and partially configures the source replacement tasks. The actual replacements must be configured afterEvaluate.

doDevTimeDeobf

protected final void doDevTimeDeobf()

setupDevTimeDeobf

protected void setupDevTimeDeobf(org.gradle.api.Task compileDummy,
                                 org.gradle.api.Task providedDummy)

remapDeps

protected void remapDeps(org.gradle.api.Project project,
                         org.gradle.api.artifacts.Configuration config,
                         java.lang.String resolvedConfig,
                         org.gradle.api.Task dummyTask)

doDepAtExtraction

protected void doDepAtExtraction()

configureRetromapping

protected void configureRetromapping()

makeRunTasks

protected void makeRunTasks()

getDummyDep

protected final TaskDepDummy getDummyDep(java.lang.String config,
                                         DelayedFile dummy,
                                         java.lang.String taskName)

mapConfigurations

protected void mapConfigurations()

addAtsToDeobf

protected void addAtsToDeobf()

afterDecomp

protected abstract void afterDecomp(boolean isDecomp,
                                    boolean useLocalCache,
                                    java.lang.String mcConfig)

This method should add the MC dependency to the supplied config, as well as do any extra configuration that requires the provided information.

Parameters:

isDecomp - Whether to use the recmpield MC artifact

useLocalCache - Whetehr or not ATs were applied to this artifact

mcConfig - Which gradle configuration to add the MC dep to

hasServerRun

protected abstract boolean hasServerRun()

This method is called early, and not late.

Returns:

TRUE if a server run config and GradleStartServer should be created.

hasClientRun

protected abstract boolean hasClientRun()

This method is called early, and not late.

Returns:

TRUE if a client run config and GradleStart should be created.

getStartDir

protected abstract java.lang.Object getStartDir()

The location where the GradleStart files will be generated to.

Returns:

object that resolves to a file

getClientTweaker

protected abstract java.lang.String getClientTweaker(T ext)

To be inserted into GradleStart. Is called late afterEvaluate or at runtime.

Parameters:

ext - the Extension object

Returns:

empty string if no tweaker. NEVER NULL.

getServerTweaker

protected abstract java.lang.String getServerTweaker(T ext)

To be inserted into GradleStartServer. Is called late afterEvaluate or at runtime.

Parameters:

ext - the Extension object

Returns:

empty string if no tweaker. NEVER NULL.

getClientRunClass

protected abstract java.lang.String getClientRunClass(T ext)

To be inserted into GradleStart. Is called late afterEvaluate or at runtime.

Parameters:

ext - the Extension object

Returns:

empty string if default launchwrapper. NEVER NULL.

getClientRunArgs

protected abstract java.util.List<java.lang.String> getClientRunArgs(T ext)

For run configurations. Is called late afterEvaluate or at runtime.

Parameters:

ext - the Extension object

Returns:

empty list for no arguments. NEVER NULL.

getClientJvmArgs

protected abstract java.util.List<java.lang.String> getClientJvmArgs(T ext)

For run configurations. Is called late afterEvaluate or at runtime.

Parameters:

ext - the Extension object

Returns:

empty list for no arguments. NEVER NULL.

getServerRunClass

protected abstract java.lang.String getServerRunClass(T ext)

To be inserted into GradleStartServer. Is called late afterEvaluate or at runtime.

Parameters:

ext - the Extension object

Returns:

empty string if default launchwrapper. NEVER NULL.

getServerRunArgs

protected abstract java.util.List<java.lang.String> getServerRunArgs(T ext)

For run configurations. Is called late afterEvaluate or at runtime.

Parameters:

ext - the Extension object

Returns:

empty list for no arguments. NEVER NULL.

getServerJvmArgs

protected abstract java.util.List<java.lang.String> getServerJvmArgs(T ext)

For run configurations. Is called late afterEvaluate or at runtime.

Parameters:

ext - the Extension object

Returns:

empty list for no arguments. NEVER NULL.

configureEclipse

protected void configureEclipse()

Configures the eclipse classpath Also creates task that generate the eclipse run configs and attaches them to the eclipse task.

configureIntellij

protected void configureIntellij()

Adds the intellij run configs and makes a few other tweaks to the intellij project creation

injectIntellijRuns

public final void injectIntellijRuns(org.w3c.dom.Document doc,
                                     java.lang.String module)
                              throws org.w3c.dom.DOMException,
                                     java.io.IOException

Throws:

org.w3c.dom.DOMException

java.io.IOException