Base

java.lang.Object
- processing.app.Base

```
public class Base
extends java.lang.Object
```
The base class for the main processing application. Primary role of this class is for platform identification and general interaction with the system (launching URLs, loading files and images, etc) that comes from that.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEBUG` True if heavy debugging error/log messages are enabled
`static javax.swing.JMenu`	`defaultFileMenu` A lone file menu to be used when all sketch windows are closed.
`static boolean`	`RELEASE` Set true if this a proper release rather than a numbered revision.
`static int`	`REVISION`
`static java.lang.String`	`VERSION_NAME` This might be replaced by main() if there's a lib/version.txt file.

Constructor Summary

Constructors
Constructor and Description

Base(java.lang.String[] args)

Constructors
Constructor and Description
`Base(java.lang.String[] args)`

Method Summary

Methods
Modifier and Type	Method and Description
`static int`	`calcFolderSize(java.io.File folder)` Calculate the size of the contents of a folder.
`static java.lang.String`	`contentsToClassPath(java.io.File folder)` Given a folder, return a list of absolute paths to all jar or zip files inside that folder, separated by pathSeparatorChar.
`static void`	`copyDir(java.io.File sourceDir, java.io.File targetDir)` Copy a folder from one place to another.
`static void`	`copyFile(java.io.File sourceFile, java.io.File targetFile)`
`static int`	`countLines(java.lang.String what)` Get the number of lines in a file by counting the number of newline characters inside a String (and adding 1).
`static java.io.File`	`createTempFolder(java.lang.String prefix, java.lang.String suffix, java.io.File directory)` Create a temporary folder by using the createTempFile() mechanism, deleting the file it creates, and making a folder using the location that was provided.
`Editor`	`getActiveEditor()` Returns the front most, active editor window.
`static java.io.File`	`getContentFile(java.lang.String name)`
`java.util.List<Editor>`	`getEditors()` Get the list of currently active editor windows.
`static java.io.InputStream`	`getLibStream(java.lang.String filename)` Return an InputStream for a file inside the Processing lib folder.
`java.util.ArrayList<ModeContribution>`	`getModeContribs()`
`java.util.ArrayList<Mode>`	`getModeList()`
`static int`	`getNativeBits()` Return whether sketches will run as 32- or 64-bits.
`static Platform`	`getPlatform()` Get list of platform constants.
`static int`	`getPlatformIndex(java.lang.String what)`
`static java.lang.String`	`getPlatformName()`
`static java.lang.String`	`getPlatformName(int which)` Map a platform constant to its name.
`javax.swing.JMenu`	`getRecentMenu()`
`static java.io.File`	`getSettingsFile(java.lang.String filename)` Convenience method to get a File object for the specified filename inside the settings folder.
`static java.io.File`	`getSettingsFolder()`
`static java.io.File`	`getSketchbookFolder()`
`static java.io.File`	`getSketchbookLibrariesFolder()`
`javax.swing.JMenu`	`getSketchbookMenu()`
`static java.io.File`	`getSketchbookModesFolder()`
`static java.io.File`	`getSketchbookToolsFolder()`
`javax.swing.JMenu`	`getToolbarRecentMenu()`
`static java.io.File`	`getToolsFolder()`
`void`	`handleAbout()` Show the About box.
`boolean`	`handleClose(Editor editor, boolean modeSwitch)` Close a sketch as specified by its editor window.
`void`	`handleNew()` Create a new untitled document in a new sketch window.
`Editor`	`handleOpen(java.lang.String path)` Open a sketch from the path specified.
`Editor`	`handleOpen(java.lang.String path, boolean untitled)` Open a sketch in a new window.
`void`	`handleOpenLibraryManager()` Show the library installer window.
`void`	`handleOpenModeManager()` Show the mode installer window.
`void`	`handleOpenPrompt()` Prompt for a sketch to open, and open it in a new window.
`void`	`handleOpenToolManager()` Show the tool installer window.
`void`	`handlePrefs()` Show the Preferences window.
`boolean`	`handleQuit()` Handler for File → Quit.
`void`	`handleRecent(Editor editor)`
`void`	`handleShowUpdates()`
`static void`	`initPlatform()`
`static void`	`initRequirements()`
`static boolean`	`isLinux()` true if running on linux.
`static boolean`	`isMacOS()` returns true if Processing is running on a Mac OS X machine.
`static boolean`	`isWindows()` returns true if running on windows.
`static java.lang.String[]`	`listFiles(java.io.File folder, boolean relative)` Recursively creates a list of all files within the specified folder, and returns a list of their relative paths.
`static java.lang.String[]`	`listFiles(java.io.File folder, boolean relative, java.lang.String extension)`
`static java.io.File[]`	`listJarFiles(java.io.File folder)`
`static byte[]`	`loadBytesRaw(java.io.File file)` Same as PApplet.loadBytes(), however never does gzip decoding.
`static java.lang.String`	`loadFile(java.io.File file)` Grab the contents of a file as a string.
`static void`	`locateSketchbookFolder()`
`static void`	`log(java.lang.Object from, java.lang.String message)`
`static void`	`log(java.lang.String message)`
`static void`	`log(java.lang.String message, java.lang.Exception e)`
`static void`	`main(java.lang.String[] args)`
`static void`	`openFolder(java.io.File file)` Implements the other cross-platform headache of opening a folder in the machine's native file browser.
`static void`	`openURL(java.lang.String url)` Implements the cross-platform headache of opening URLs.
`static java.lang.String[]`	`packageListFromClassPath(java.lang.String path)` A classpath, separated by the path separator, will contain a series of .jar/.zip files or directories containing .class files, or containing subdirectories that have .class files.
`void`	`populateSketchbookMenu(javax.swing.JMenu menu)`
`static java.util.HashMap<java.lang.String,java.lang.String>`	`readSettings(java.io.File inputFile)` Read from a file with a bunch of attribute/value pairs that are separated by = and ignore comments with #.
`static void`	`readSettings(java.lang.String fileName, java.lang.String[] lines, java.util.HashMap<java.lang.String,java.lang.String> exports)`
`static void`	`removeDescendants(java.io.File dir)` Recursively remove all files within a directory, used with removeDir(), or when the contents of a dir should be removed, but not the directory itself.
`static void`	`removeDir(java.io.File dir)` Remove all files in a directory and the directory itself.
`void`	`removeRecent(Editor editor)` Called before a sketch is renamed so that its old name is no longer in the menu.
`static void`	`saveFile(java.lang.String str, java.io.File file)` Spew the contents of a String object out to a file.
`static void`	`setCommandLine()`
`void`	`setSketchbookFolder(java.io.File folder)`
`static void`	`showError(java.lang.String title, java.lang.String message, java.lang.Throwable e)` Show an error message that's actually fatal to the program.
`static void`	`showMessage(java.lang.String title, java.lang.String message)` "No cookie for you" type messages.
`static void`	`showWarning(java.lang.String title, java.lang.String message, java.lang.Exception e)` Non-fatal error message with optional stack trace side dish.
`static void`	`showWarningTiered(java.lang.String title, java.lang.String primary, java.lang.String secondary, java.lang.Exception e)` Non-fatal error message with optional stack trace side dish.
`static int`	`showYesNoCancelQuestion(Editor editor, java.lang.String title, java.lang.String primary, java.lang.String secondary)`
`static int`	`showYesNoQuestion(java.awt.Frame editor, java.lang.String title, java.lang.String primary, java.lang.String secondary)`
`void`	`thinkDifferentExamples()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REVISION
```
public static final int REVISION
```
    See Also:
    Constant Field Values
  - VERSION_NAME
```
public static java.lang.String VERSION_NAME
```
    This might be replaced by main() if there's a lib/version.txt file.
  - RELEASE
```
public static boolean RELEASE
```
    Set true if this a proper release rather than a numbered revision.
  - DEBUG
```
public static boolean DEBUG
```
    True if heavy debugging error/log messages are enabled
  - defaultFileMenu
```
public static javax.swing.JMenu defaultFileMenu
```
    A lone file menu to be used when all sketch windows are closed.
- Constructor Detail
  - Base
```
public Base(java.lang.String[] args)
```
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```
  - setCommandLine
```
public static void setCommandLine()
```
  - initPlatform
```
public static void initPlatform()
```
  - initRequirements
```
public static void initRequirements()
```
  - getActiveEditor
```
public Editor getActiveEditor()
```
    Returns the front most, active editor window.
  - getEditors
```
public java.util.List<Editor> getEditors()
```
    Get the list of currently active editor windows.
  - getModeContribs
```
public java.util.ArrayList<ModeContribution> getModeContribs()
```
  - getModeList
```
public java.util.ArrayList<Mode> getModeList()
```
  - handleNew
```
public void handleNew()
```
    Create a new untitled document in a new sketch window.
  - handleOpenPrompt
```
public void handleOpenPrompt()
```
    Prompt for a sketch to open, and open it in a new window.
  - handleOpen
```
public Editor handleOpen(java.lang.String path)
```
    Open a sketch from the path specified. Do not use for untitled sketches.
  - handleOpen
```
public Editor handleOpen(java.lang.String path,
                boolean untitled)
```
    Open a sketch in a new window.
    
    Parameters:
    path - Path to the pde file for the sketch in question
    
    Returns:
    the Editor object, so that properties (like 'untitled') can be set by the caller
  - handleClose
```
public boolean handleClose(Editor editor,
                  boolean modeSwitch)
```
    Close a sketch as specified by its editor window.
    
    Parameters:
    editor - Editor object of the sketch to be closed.
    
    Returns:
    true if succeeded in closing, false if canceled.
  - handleQuit
```
public boolean handleQuit()
```
    Handler for File → Quit.
    
    Returns:
    false if canceled, true otherwise.
  - thinkDifferentExamples
```
public void thinkDifferentExamples()
```
  - populateSketchbookMenu
```
public void populateSketchbookMenu(javax.swing.JMenu menu)
```
  - getSketchbookMenu
```
public javax.swing.JMenu getSketchbookMenu()
```
  - getRecentMenu
```
public javax.swing.JMenu getRecentMenu()
```
  - getToolbarRecentMenu
```
public javax.swing.JMenu getToolbarRecentMenu()
```
  - handleRecent
```
public void handleRecent(Editor editor)
```
  - removeRecent
```
public void removeRecent(Editor editor)
```
    Called before a sketch is renamed so that its old name is no longer in the menu.
  - handleAbout
```
public void handleAbout()
```
    Show the About box.
  - handlePrefs
```
public void handlePrefs()
```
    Show the Preferences window.
  - handleOpenLibraryManager
```
public void handleOpenLibraryManager()
```
    Show the library installer window.
  - handleOpenToolManager
```
public void handleOpenToolManager()
```
    Show the tool installer window.
  - handleOpenModeManager
```
public void handleOpenModeManager()
```
    Show the mode installer window.
  - handleShowUpdates
```
public void handleShowUpdates()
```
  - getPlatform
```
public static Platform getPlatform()
```
    Get list of platform constants.
  - getPlatformName
```
public static java.lang.String getPlatformName()
```
  - getNativeBits
```
public static int getNativeBits()
```
    Return whether sketches will run as 32- or 64-bits. On Linux and Windows, this is the bit depth of the machine, while on OS X it's determined by the setting from preferences, since both 32- and 64-bit are supported.
  - getPlatformName
```
public static java.lang.String getPlatformName(int which)
```
    Map a platform constant to its name.
    
    Parameters:
    which - PConstants.WINDOWS, PConstants.MACOSX, PConstants.LINUX
    
    Returns:
    one of "windows", "macosx", or "linux"
  - getPlatformIndex
```
public static int getPlatformIndex(java.lang.String what)
```
  - isMacOS
```
public static boolean isMacOS()
```
    returns true if Processing is running on a Mac OS X machine.
  - isWindows
```
public static boolean isWindows()
```
    returns true if running on windows.
  - isLinux
```
public static boolean isLinux()
```
    true if running on linux.
  - getSettingsFolder
```
public static java.io.File getSettingsFolder()
```
  - getSettingsFile
```
public static java.io.File getSettingsFile(java.lang.String filename)
```
    Convenience method to get a File object for the specified filename inside the settings folder. Used to get preferences and recent sketch files.
    
    Parameters:
    filename - A file inside the settings folder.
    
    Returns:
    filename wrapped as a File object inside the settings folder
  - createTempFolder
```
public static java.io.File createTempFolder(java.lang.String prefix,
                            java.lang.String suffix,
                            java.io.File directory)
                                     throws java.io.IOException
```
    Create a temporary folder by using the createTempFile() mechanism, deleting the file it creates, and making a folder using the location that was provided. Unlike createTempFile(), there is no minimum size for prefix. If prefix is less than 3 characters, the remaining characters will be filled with underscores
    
    Throws:
    
    java.io.IOException
  - getToolsFolder
```
public static java.io.File getToolsFolder()
```
  - locateSketchbookFolder
```
public static void locateSketchbookFolder()
```
  - setSketchbookFolder
```
public void setSketchbookFolder(java.io.File folder)
```
  - getSketchbookFolder
```
public static java.io.File getSketchbookFolder()
```
  - getSketchbookLibrariesFolder
```
public static java.io.File getSketchbookLibrariesFolder()
```
  - getSketchbookToolsFolder
```
public static java.io.File getSketchbookToolsFolder()
```
  - getSketchbookModesFolder
```
public static java.io.File getSketchbookModesFolder()
```
  - openURL
```
public static void openURL(java.lang.String url)
```
    Implements the cross-platform headache of opening URLs. For 2.0a8 and later, this requires the parameter to be an actual URL, meaning that you can't send it a file:// path without a prefix. It also just calls into Platform, which now uses java.awt.Desktop (where possible, meaning not on Linux) now that we're requiring Java 6. As it happens the URL must also be properly URL-encoded.
  - openFolder
```
public static void openFolder(java.io.File file)
```
    Implements the other cross-platform headache of opening a folder in the machine's native file browser.
  - showMessage
```
public static void showMessage(java.lang.String title,
               java.lang.String message)
```
    "No cookie for you" type messages. Nothing fatal or all that much of a bummer, but something to notify the user about.
  - showWarning
```
public static void showWarning(java.lang.String title,
               java.lang.String message,
               java.lang.Exception e)
```
    Non-fatal error message with optional stack trace side dish.
  - showWarningTiered
```
public static void showWarningTiered(java.lang.String title,
                     java.lang.String primary,
                     java.lang.String secondary,
                     java.lang.Exception e)
```
    Non-fatal error message with optional stack trace side dish.
  - showError
```
public static void showError(java.lang.String title,
             java.lang.String message,
             java.lang.Throwable e)
```
    Show an error message that's actually fatal to the program. This is an error that can't be recovered. Use showWarning() for errors that allow P5 to continue running.
  - showYesNoCancelQuestion
```
public static int showYesNoCancelQuestion(Editor editor,
                          java.lang.String title,
                          java.lang.String primary,
                          java.lang.String secondary)
```
  - showYesNoQuestion
```
public static int showYesNoQuestion(java.awt.Frame editor,
                    java.lang.String title,
                    java.lang.String primary,
                    java.lang.String secondary)
```
  - getContentFile
```
public static java.io.File getContentFile(java.lang.String name)
```
  - getLibStream
```
public static java.io.InputStream getLibStream(java.lang.String filename)
                                        throws java.io.IOException
```
    Return an InputStream for a file inside the Processing lib folder.
    
    Throws:
    
    java.io.IOException
  - countLines
```
public static int countLines(java.lang.String what)
```
    Get the number of lines in a file by counting the number of newline characters inside a String (and adding 1).
  - loadBytesRaw
```
public static byte[] loadBytesRaw(java.io.File file)
                           throws java.io.IOException
```
    Same as PApplet.loadBytes(), however never does gzip decoding.
    
    Throws:
    
    java.io.IOException
  - readSettings
```
public static java.util.HashMap<java.lang.String,java.lang.String> readSettings(java.io.File inputFile)
```
    Read from a file with a bunch of attribute/value pairs that are separated by = and ignore comments with #.
  - readSettings
```
public static void readSettings(java.lang.String fileName,
                java.lang.String[] lines,
                java.util.HashMap<java.lang.String,java.lang.String> exports)
```
  - copyFile
```
public static void copyFile(java.io.File sourceFile,
            java.io.File targetFile)
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - loadFile
```
public static java.lang.String loadFile(java.io.File file)
                                 throws java.io.IOException
```
    Grab the contents of a file as a string.
    
    Throws:
    
    java.io.IOException
  - saveFile
```
public static void saveFile(java.lang.String str,
            java.io.File file)
                     throws java.io.IOException
```
    Spew the contents of a String object out to a file.
    
    Throws:
    
    java.io.IOException
  - copyDir
```
public static void copyDir(java.io.File sourceDir,
           java.io.File targetDir)
                    throws java.io.IOException
```
    Copy a folder from one place to another. This ignores all dot files and folders found in the source directory, to avoid copying silly .DS_Store files and potentially troublesome .svn folders.
    
    Throws:
    
    java.io.IOException
  - removeDir
```
public static void removeDir(java.io.File dir)
```
    Remove all files in a directory and the directory itself. TODO implement cross-platform "move to trash" instead of deleting, since this is potentially scary if there's a bug.
  - removeDescendants
```
public static void removeDescendants(java.io.File dir)
```
    Recursively remove all files within a directory, used with removeDir(), or when the contents of a dir should be removed, but not the directory itself. (i.e. when cleaning temp files from lib/build)
  - calcFolderSize
```
public static int calcFolderSize(java.io.File folder)
```
    Calculate the size of the contents of a folder. Used to determine whether sketches are empty or not. Note that the function calls itself recursively.
  - listFiles
```
public static java.lang.String[] listFiles(java.io.File folder,
                           boolean relative)
```
    Recursively creates a list of all files within the specified folder, and returns a list of their relative paths. Ignores any files/folders prefixed with a dot.
  - listFiles
```
public static java.lang.String[] listFiles(java.io.File folder,
                           boolean relative,
                           java.lang.String extension)
```
  - listJarFiles
```
public static java.io.File[] listJarFiles(java.io.File folder)
```
    Parameters:
    folder - source folder to search
    
    Returns:
    a list of .jar and .zip files in that folder
  - contentsToClassPath
```
public static java.lang.String contentsToClassPath(java.io.File folder)
```
    Given a folder, return a list of absolute paths to all jar or zip files inside that folder, separated by pathSeparatorChar. This will prepend a colon (or whatever the path separator is) so that it can be directly appended to another path string. As of 0136, this will no longer add the root folder as well. This function doesn't bother checking to see if there are any .class files in the folder or within a subfolder.
  - packageListFromClassPath
```
public static java.lang.String[] packageListFromClassPath(java.lang.String path)
```
    A classpath, separated by the path separator, will contain a series of .jar/.zip files or directories containing .class files, or containing subdirectories that have .class files.
    
    Parameters:
    path - the input classpath
    
    Returns:
    array of possible package names
  - log
```
public static void log(java.lang.Object from,
       java.lang.String message)
```
  - log
```
public static void log(java.lang.String message)
```
  - log
```
public static void log(java.lang.String message,
       java.lang.Exception e)
```

Class Base

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REVISION

VERSION_NAME

RELEASE

DEBUG

defaultFileMenu

Constructor Detail

Base

Method Detail

main

setCommandLine

initPlatform

initRequirements

getActiveEditor

getEditors

getModeContribs

getModeList

handleNew

handleOpenPrompt

handleOpen

handleOpen

handleClose

handleQuit

thinkDifferentExamples

populateSketchbookMenu

getSketchbookMenu

getRecentMenu

getToolbarRecentMenu

handleRecent

removeRecent

handleAbout

handlePrefs

handleOpenLibraryManager

handleOpenToolManager

handleOpenModeManager

handleShowUpdates

getPlatform

getPlatformName

getNativeBits

getPlatformName

getPlatformIndex

isMacOS

isWindows

isLinux

getSettingsFolder

getSettingsFile

createTempFolder

getToolsFolder

locateSketchbookFolder

setSketchbookFolder

getSketchbookFolder

getSketchbookLibrariesFolder

getSketchbookToolsFolder

getSketchbookModesFolder

openURL

openFolder

showMessage

showWarning

showWarningTiered

showError

showYesNoCancelQuestion

showYesNoQuestion

getContentFile

getLibStream

countLines

loadBytesRaw

readSettings

readSettings

copyFile

loadFile

saveFile

copyDir

removeDir

removeDescendants

calcFolderSize