Installer

Base class for an installer - a process to acquire and set up some third-party software or component to some temporary location, so that we can then invoke and use it.

class Installer {

static

string installationDirectory;

static

void delegate(string) logger;

static void log(string s);

string name [@property getter];

string subdirectory [@property getter];

string[] binPaths [@property getter];

string[] binDirs [@property getter];

static string[] pathDirs [@property getter];

string directory [@property getter];

string[] requiredExecutables [@property getter];

static bool haveExecutable(string name);

static string findExecutable(string name, string[] dirs);

string exePath(string name);

bool installedLocally [@property getter];

bool availableOnSystem [@property getter];

bool available [@property getter];

void require();

void requireLocal(bool shouldAddToPath);

void addToPath();

void atomicInstallImpl();

void installImpl(string target);

static string saveLocation(string url);

template cachedAction(alias fun, string fmt);

protected final static

string[string] urlDigests;

static void saveFile(string url, string target);

alias saveTo = cachedAction!(saveFile, "Downloading %s to %s...");

alias save = withTarget!(saveLocation, saveTo);

static auto saveAs(string url, string fn);

static string stripArchiveExtension(string fn);

alias unpackTo = cachedAction!(ae.sys.archive.unpack, "Unpacking %s to %s...");

alias unpack = withTarget!(stripArchiveExtension, unpackTo);

static string resolveRedirectImpl(string url);

static string resolveRedirect(string url);

void windowsOnly();

void uninstallable();

}

Members

Aliases

save alias save = withTarget!(saveLocation, saveTo): Undocumented in source.
saveTo alias saveTo = cachedAction!(saveFile, "Downloading %s to %s..."): Undocumented in source.
unpack alias unpack = withTarget!(stripArchiveExtension, unpackTo): Undocumented in source.
unpackTo alias unpackTo = cachedAction!(ae.sys.archive.unpack, "Unpacking %s to %s..."): Undocumented in source.

Functions

addToPath void addToPath(): Change this process's PATH environment variable to include the path to this component's executable directories.
atomicInstallImpl void atomicInstallImpl(): Install to directory atomically.
exePath string exePath(string name): Get the full path to an executable.
installImpl void installImpl(string target): Undocumented in source. Be warned that the author may not have intended to support it.
require void require(): Install this component if necessary.
requireLocal void requireLocal(bool shouldAddToPath): Install this component locally, if it isn't already installed.
uninstallable void uninstallable(): Undocumented in source. Be warned that the author may not have intended to support it.
windowsOnly void windowsOnly(): Undocumented in source. Be warned that the author may not have intended to support it.

Properties

available bool available [@property getter]: Whether the component is installed, locally or already present on the system.
availableOnSystem bool availableOnSystem [@property getter]: Whether the component is already present on the system.
binDirs string[] binDirs [@property getter]: As above, but expanded to full absolute directory paths.
binPaths string[] binPaths [@property getter]: Subdirectories (under the installation subdirectory) containing executables which need to be added to PATH.
directory string directory [@property getter]: The full installation directory.
installedLocally bool installedLocally [@property getter]: Whether the component is installed locally.
name string name [@property getter]: Component name. Used for logging.
pathDirs deprecated string[] pathDirs [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
requiredExecutables string[] requiredExecutables [@property getter]: The list of executable names required to be present. Null if this component is never considered already available on the system.
subdirectory string subdirectory [@property getter]: The subdirectory where this component will be installed.

Static functions

findExecutable deprecated string findExecutable(string name, string[] dirs): Undocumented in source. Be warned that the author may not have intended to support it.
haveExecutable deprecated bool haveExecutable(string name): Undocumented in source. Be warned that the author may not have intended to support it.
log void log(string s): Undocumented in source. Be warned that the author may not have intended to support it.
resolveRedirect string resolveRedirect(string url): Undocumented in source. Be warned that the author may not have intended to support it.
resolveRedirectImpl string resolveRedirectImpl(string url): Undocumented in source. Be warned that the author may not have intended to support it.
saveAs auto saveAs(string url, string fn): Undocumented in source. Be warned that the author may not have intended to support it.
saveFile void saveFile(string url, string target): Undocumented in source. Be warned that the author may not have intended to support it.
saveLocation string saveLocation(string url): Undocumented in source. Be warned that the author may not have intended to support it.
stripArchiveExtension string stripArchiveExtension(string fn): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

installationDirectory string installationDirectory;: Where all software will be unpacked (current directory, by default).
logger void delegate(string) logger;: Log sink
urlDigests string[string] urlDigests;: Undocumented in source.

Templates

cachedAction template cachedAction(alias fun, string fmt): Undocumented in source.

Installer

Members

Aliases

Functions

Properties

Static functions

Static variables

Templates

Meta

Source