org.bytedeco.ale

Class Settings

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.ale.Settings

All Implemented Interfaces:

AutoCloseable

@NoOffset
 @Properties(inherit=ale.class)
public class Settings
extends Pointer

This class provides an interface for accessing frontend specific settings.

Version:

$Id: Settings.hxx,v 1.33 2007/07/27 13:49:16 stephena Exp $

Author:

Stephen Anthony

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Settings(OSystem osystem) Create a new settings abstract class
Settings(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
boolean	getBool(BytePointer key)
boolean	getBool(BytePointer key, boolean strict) Get the value assigned to the specified key.
boolean	getBool(String key)
boolean	getBool(String key, boolean strict)
float	getFloat(BytePointer key)
float	getFloat(BytePointer key, boolean strict) Get the value assigned to the specified key.
float	getFloat(String key)
float	getFloat(String key, boolean strict)
int	getInt(BytePointer key)
int	getInt(BytePointer key, boolean strict) Get the value assigned to the specified key.
int	getInt(String key)
int	getInt(String key, boolean strict)
void	getSize(BytePointer key, int[] x, int[] y)
void	getSize(BytePointer key, IntBuffer x, IntBuffer y)
void	getSize(BytePointer key, IntPointer x, IntPointer y) Get the x*y size assigned to the specified key.
void	getSize(String key, int[] x, int[] y)
void	getSize(String key, IntBuffer x, IntBuffer y)
void	getSize(String key, IntPointer x, IntPointer y)
BytePointer	getString(BytePointer key)
BytePointer	getString(BytePointer key, boolean strict) Get the value assigned to the specified key.
String	getString(String key)
String	getString(String key, boolean strict)
BytePointer	loadCommandLine(int argc, byte[] argv)
String	loadCommandLine(int argc, ByteBuffer argv)
BytePointer	loadCommandLine(int argc, BytePointer argv)
BytePointer	loadCommandLine(int argc, PointerPointer argv) This method should be called to load the arguments from the commandline.
void	loadConfig() This method should be called to load the current settings from an rc file.
void	loadConfig(BytePointer config_file) This method loads the given
void	loadConfig(String config_file)
void	saveConfig() This method should be called to save the current settings to an rc file.
void	setBool(BytePointer key, boolean value) Set the value associated with key to the given value.
void	setBool(String key, boolean value)
void	setFloat(BytePointer key, float value) Set the value associated with key to the given value.
void	setFloat(String key, float value)
void	setInt(BytePointer key, int value) Set the value associated with key to the given value.
void	setInt(String key, int value)
void	setSize(BytePointer key, int value1, int value2) Set the value associated with key to the given value.
void	setSize(String key, int value1, int value2)
void	setString(BytePointer key, BytePointer value) Set the value associated with key to the given value.
void	setString(String key, String value)
void	usage() This method should be called to display usage information.
void	validate() This method should be called *after* settings have been read, to validate (and change, if necessary) any improper settings.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Settings

public Settings(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Settings

public Settings(OSystem osystem)

Create a new settings abstract class

Method Detail

loadConfig

public void loadConfig()

This method should be called to load the current settings from an rc file.

loadConfig

public void loadConfig(@Cast(value="const char*")
                       BytePointer config_file)

This method loads the given

loadConfig

public void loadConfig(String config_file)

saveConfig

public void saveConfig()

This method should be called to save the current settings to an rc file.

loadCommandLine

@StdString
public BytePointer loadCommandLine(int argc,
                                               @Cast(value="char**")
                                               PointerPointer argv)

This method should be called to load the arguments from the commandline.

Returns:

Name of the ROM to load, otherwise empty string

loadCommandLine

@StdString
public BytePointer loadCommandLine(int argc,
                                               @Cast(value="char**") @ByPtrPtr
                                               BytePointer argv)

loadCommandLine

@StdString
public String loadCommandLine(int argc,
                                          @Cast(value="char**") @ByPtrPtr
                                          ByteBuffer argv)

loadCommandLine

@StdString
public BytePointer loadCommandLine(int argc,
                                               @Cast(value="char**") @ByPtrPtr
                                               byte[] argv)

validate

public void validate()

This method should be called *after* settings have been read, to validate (and change, if necessary) any improper settings.

usage

public void usage()

This method should be called to display usage information.

getInt

public int getInt(@StdString
                  BytePointer key,
                  @Cast(value="bool")
                  boolean strict)

Get the value assigned to the specified key. If the key does not exist then -1 is returned.

Parameters:

key - The key of the setting to lookup

Returns:

The integer value of the setting

getInt

public int getInt(@StdString
                  BytePointer key)

getInt

public int getInt(@StdString
                  String key,
                  @Cast(value="bool")
                  boolean strict)

getInt

public int getInt(@StdString
                  String key)

getFloat

public float getFloat(@StdString
                      BytePointer key,
                      @Cast(value="bool")
                      boolean strict)

Get the value assigned to the specified key. If the key does not exist then -1.0 is returned.

Parameters:

key - The key of the setting to lookup

Returns:

The floating point value of the setting

getFloat

public float getFloat(@StdString
                      BytePointer key)

getFloat

public float getFloat(@StdString
                      String key,
                      @Cast(value="bool")
                      boolean strict)

getFloat

public float getFloat(@StdString
                      String key)

getBool

@Cast(value="bool")
public boolean getBool(@StdString
                                            BytePointer key,
                                            @Cast(value="bool")
                                            boolean strict)

Get the value assigned to the specified key. If the key does not exist then false is returned.

Parameters:

key - The key of the setting to lookup

Returns:

The boolean value of the setting

getBool

@Cast(value="bool")
public boolean getBool(@StdString
                                            BytePointer key)

getBool

@Cast(value="bool")
public boolean getBool(@StdString
                                            String key,
                                            @Cast(value="bool")
                                            boolean strict)

getBool

@Cast(value="bool")
public boolean getBool(@StdString
                                            String key)

getString

@StdString
public BytePointer getString(@StdString
                                         BytePointer key,
                                         @Cast(value="bool")
                                         boolean strict)

Get the value assigned to the specified key. If the key does not exist then the empty string is returned.

Parameters:

key - The key of the setting to lookup

Returns:

The string value of the setting

getString

@StdString
public BytePointer getString(@StdString
                                         BytePointer key)

getString

@StdString
public String getString(@StdString
                                    String key,
                                    @Cast(value="bool")
                                    boolean strict)

getString

@StdString
public String getString(@StdString
                                    String key)

getSize

public void getSize(@StdString
                    BytePointer key,
                    @ByRef
                    IntPointer x,
                    @ByRef
                    IntPointer y)

Get the x*y size assigned to the specified key. If the key does not exist (or is invalid) then results are -1 for each item.

Parameters:

key - The key of the setting to lookup

getSize

public void getSize(@StdString
                    String key,
                    @ByRef
                    IntBuffer x,
                    @ByRef
                    IntBuffer y)

getSize

public void getSize(@StdString
                    BytePointer key,
                    @ByRef
                    int[] x,
                    @ByRef
                    int[] y)

getSize

public void getSize(@StdString
                    String key,
                    @ByRef
                    IntPointer x,
                    @ByRef
                    IntPointer y)

getSize

public void getSize(@StdString
                    BytePointer key,
                    @ByRef
                    IntBuffer x,
                    @ByRef
                    IntBuffer y)

getSize

public void getSize(@StdString
                    String key,
                    @ByRef
                    int[] x,
                    @ByRef
                    int[] y)

setInt

public void setInt(@StdString
                   BytePointer key,
                   int value)

Set the value associated with key to the given value.

Parameters:

key - The key of the setting

value - The value to assign to the setting

setInt

public void setInt(@StdString
                   String key,
                   int value)

setFloat

public void setFloat(@StdString
                     BytePointer key,
                     float value)

Set the value associated with key to the given value.

Parameters:

key - The key of the setting

value - The value to assign to the setting

setFloat

public void setFloat(@StdString
                     String key,
                     float value)

setBool

public void setBool(@StdString
                    BytePointer key,
                    @Cast(value="const bool")
                    boolean value)

Set the value associated with key to the given value.

Parameters:

key - The key of the setting

value - The value to assign to the setting

setBool

public void setBool(@StdString
                    String key,
                    @Cast(value="const bool")
                    boolean value)

setString

public void setString(@StdString
                      BytePointer key,
                      @StdString
                      BytePointer value)

Set the value associated with key to the given value.

Parameters:

key - The key of the setting

value - The value to assign to the setting

setString

public void setString(@StdString
                      String key,
                      @StdString
                      String value)

setSize

public void setSize(@StdString
                    BytePointer key,
                    int value1,
                    int value2)

Set the value associated with key to the given value.

Parameters:

key - The key of the setting

value - The value to assign to the setting

setSize

public void setSize(@StdString
                    String key,
                    int value1,
                    int value2)