artisynth.core.driver

Class LibraryInstaller

java.lang.Object

artisynth.core.driver.LibraryInstaller

public class LibraryInstaller
extends java.lang.Object

Class to installer Artisynth libraries (both jar files and native binaries). It is intended to be callable as both as a standalone application and from within ArtiSynth. By default, it finds the libraries to load in the file lib/LIBRARIES, where lib/ is the folder next to the one containing this class (i.e., next to bin/ when run from bin/libraryInstaller.jar, or next to classes/ when run from ArtiSynth's compiled classes).

Libraries that are no longer needed can be listed in the file lib/OBSOLETE, so that they are removed along with older versions of the current libraries (see removeOldJars() and removeOldNativeLibs()).

Constructor Summary

Constructors

Constructor and Description
LibraryInstaller() Creates a new LibraryInstaller.

Method Summary

Modifier and Type	Method and Description
void	addLibrary(java.lang.String libName)
void	addLibrary(java.lang.String libName, java.lang.String linkName) Adds a native library that is to be accessible through a link with the name linkName, such as libiomp5.so for libiomp5.so.2026.1.
void	clearJars()
void	clearNativeLibs()
java.util.List<java.lang.String>	getJarnames() Returns the names of the jar files in the library list.
java.io.File	getLibDir()
java.lang.String	getRemoteSource()
boolean	isConnectionException(java.lang.Exception e)
static void	main(java.lang.String[] args)
void	readLibs(java.io.File file) Reads the library list from a file (in the format of lib/LIBRARIES), or from standard input if file is null.
void	readObsolete(java.io.File file) Reads the obsolete list from a file (in the format of lib/OBSOLETE), or from standard input if file is null.
int	removeOldJars() Removes older versions of the jar files in the library list.
int	removeOldNativeLibs() Removes older versions of the native libraries in the library list.
void	setLibDir(java.lang.String dirPath)
static void	setRemoteSource(java.lang.String source)
boolean	updateEclipseClasspath(java.io.File cpfile) Updates the jar file entries of an Eclipse .classpath file so that they match the jar files in the library list that have no system specifier (i.e., the jar files that form ArtiSynth's classpath; see bin/makeClasspath).
int	verifyJars(boolean updateLibs) Verify that all jar files are present and, if requested, updated.
int	verifyNativeLibs(boolean updateLibs) Verify that all native libraries are present and, if requested, updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

LibraryInstaller

public LibraryInstaller()

Creates a new LibraryInstaller. The library folder is inferred from the location of this class (see inferLibDir()), and can be reset using setLibDir(java.lang.String). The folder is not checked here, so that an alternate folder can still be set if the inferred one does not exist.

Method Detail

getRemoteSource

public java.lang.String getRemoteSource()

setRemoteSource

public static void setRemoteSource(java.lang.String source)

addLibrary

public void addLibrary(java.lang.String libName)

addLibrary

public void addLibrary(java.lang.String libName,
                       java.lang.String linkName)

Adds a native library that is to be accessible through a link with the name linkName, such as libiomp5.so for libiomp5.so.2026.1. See NativeLibraryManager.verify(String,String).

getJarnames

public java.util.List<java.lang.String> getJarnames()

Returns the names of the jar files in the library list. For lists read using readLibs(java.io.File), this includes only jar files required for the current system.

clearJars

public void clearJars()

clearNativeLibs

public void clearNativeLibs()

setLibDir

public void setLibDir(java.lang.String dirPath)

getLibDir

public java.io.File getLibDir()

main

public static void main(java.lang.String[] args)

verifyNativeLibs

public int verifyNativeLibs(boolean updateLibs)
                     throws java.lang.Exception

Verify that all native libraries are present and, if requested, updated.

Parameters:

updateLibs - if true, verifies that each library is the most recent, and downloads it if it isn't.

Returns:

number of libraries actually downloaded, or -1 if an error was encountered.

Throws:

java.lang.Exception

isConnectionException

public boolean isConnectionException(java.lang.Exception e)

verifyJars

public int verifyJars(boolean updateLibs)
               throws java.lang.Exception

Verify that all jar files are present and, if requested, updated.

Parameters:

updateLibs - if true, verifies that each jar file is the most recent, and downloads it if it isn't.

Returns:

number of jar files actually downloaded, or -1 if an error was encountered.

Throws:

java.lang.Exception

removeOldJars

public int removeOldJars()

Removes older versions of the jar files in the library list. A jar file in the library folder is removed if it is not in the library list, but has the same stem (see getJarStem(java.lang.String)) as a jar file that is in the list and is present in the folder. For example, if the list contains jogl-all-2.6.0.jar, then jogl-all-2.5.0.jar would be removed, but only if jogl-all-2.6.0.jar is present. This should therefore be called after verifyJars(boolean), so that an older version can still be used if a download fails.

Jar files whose stems match nothing in the list are left alone, as are files that cannot be deleted (which can happen on Windows if they are in use by another process, such as a running instance of ArtiSynth). A warning is printed for the latter.

Jar files listed in the obsolete list (see readObsolete(java.io.File)) are also removed, unless their stems match the stem of a jar file in the library list (for any system), or they are special jar files.

Returns:

number of jar files actually removed

removeOldNativeLibs

public int removeOldNativeLibs()

Removes older versions of the native libraries in the library list. See NativeLibraryManager.removeOlderVersions(maspack.fileutil.NativeLibraryManager.LibDesc) for details. This should be called after verifyNativeLibs(boolean).

Native libraries listed in the obsolete list (see readObsolete(java.io.File)) are also removed, unless they are libraries in the library list or their links. An exactly named obsolete library is removed even if another version of it is in the library list. See NativeLibraryManager.removeObsoleteLibraries(java.util.Collection<java.lang.String>, java.util.Collection<java.lang.String>, java.util.Collection<java.lang.String>) for details.

Returns:

number of library files actually removed

updateEclipseClasspath

public boolean updateEclipseClasspath(java.io.File cpfile)
                               throws java.io.IOException

Updates the jar file entries of an Eclipse .classpath file so that they match the jar files in the library list that have no system specifier (i.e., the jar files that form ArtiSynth's classpath; see bin/makeClasspath). All existing entries for jar files in lib/ are removed, and entries for the listed jar files are inserted, in the listed order, where the first removed entry was (or before the output entry if there were none). A new entry keeps the attributes (such as javadoc locations) of any removed entry whose jar file has the same stem (see getJarStem(java.lang.String)). Each entry is also given the attribute optional="true", so that Eclipse does not flag the project as having build path errors when the jar file is missing (as it is in a fresh checkout, before the libraries are installed). Other entries, and the file's formatting, are left unchanged, and the file is rewritten only if its contents change, so that Eclipse is not triggered to rebuild needlessly. Nothing is done if no library list has been read.

Parameters:

cpfile - .classpath file to update

Returns:

true if the file was changed

Throws:

java.io.IOException

readLibs

public void readLibs(java.io.File file)
              throws java.io.IOException

Reads the library list from a file (in the format of lib/LIBRARIES), or from standard input if file is null.

Throws:

java.io.IOException

readObsolete

public void readObsolete(java.io.File file)
                  throws java.io.IOException

Reads the obsolete list from a file (in the format of lib/OBSOLETE), or from standard input if file is null. Each line contains the name of an obsolete jar file or native library, optionally preceded by a system specifier, as in lib/LIBRARIES. Names may contain '*' wildcards. If no obsolete list is read before removeOldJars() or removeOldNativeLibs() is called, then OBSOLETE in the library folder is read if present.

Throws:

java.io.IOException