codesimian
Class CodesimianOptions

java.lang.Object
  codesimian.CS<CSGeneric>
      codesimian.DefaultCS
          codesimian.CodesimianOptions

All Implemented Interfaces:

CodeSimian

public class CodesimianOptions
extends DefaultCS

Codesimian's global options, including initial amounts of some types of liquid, like "liquidChaos".

This class should be designed to be very very hard for CodeSimian to use, but easy for Humans to use.

If P(0) exists, it is the string name of the option that should be displayed at the top of the list. Similarly, if P(1) exists, its the second option, P(2) third... If no options with those names exist in the current options file, ignores that P.

For example, if either of the (theoretical options) executesystemcommands or codesimiantypesonkeyboard options is false, codesimian can not execute javac.exe to java-compile updates of itself.

TODO: Should every option be required to have a Liquid value?

Field Summary

Fields inherited from class codesimian.CS

DESCRIPTION, END, EXECPROXY, HEAP, JAVACODE, MYFUEL, NAME, NEWINSTANCE, NULL, PARENT, PARSEPRIORITY, PREV, TESTER, THIS

Constructor Summary

CodesimianOptions()

Method Summary

CS	copyAll() returns a copy of all codesimian's options, a CS used as a list of CS.
static CodesimianOptions	defaultInstance()
java.lang.String	description() a short description of this CS, shorter than the javadoc, but long enough to tell what the params are for.
double	DForProxy() Execute this CS and cast to double.
java.lang.String[]	getAllOptionNames()
CS	getOption(java.lang.String optionName) returns a new copy of the option
java.lang.String	keyword() For the CodeSimian language as a String. CodeSimian language keyword, like "+" "*" "max" ">" etc. Override this function if you want to specify a keyword other than how I derive them from the class name, like + for Add. Some CSs might never be intended to be used in the language by their keyword. The best example (4/05) is Num, because it is used in the language like "3.4" instead of "num()".
java.lang.Object	L(java.lang.Class type) Optionally execute this CS, and definitely try to CAST it to the specified Java type.
int	maxP() Maximum quantity of Params
int	minP() For DForProxy(). Minimum number of parameters in param[] needed to call DForProxy(). Defines which indexs of param[] DForProxy() can use. Functions with a different number of parameters must override this. OVERRIDE THIS FUNCTION IF EXEC USES A DIFFERENT NUMBER OF PARAMETERS. Default is 1.
CS	reflectAll() returns a CS to be used as a list.
void	refresh()
boolean	setP(int index, CS value) Every CS is a list of other CSs, between size minP() and maxP() inclusive.
void	sortCsListOfOptionsGUIs(java.lang.String[] firstFewOptionNames)
void	sortListOfStringsGUIWithDefaultFilenamesFirst(java.lang.String nullOrFirstFilename) if nullOrFirstFilename is null, default filenames start at index 0, else index 1 and the first filename is nullOrFirstFilename

Methods inherited from class codesimian.DefaultCS

B, C, countP, decrementMyFuel, deleteP, F, fuel, getExec, getObject, heap, I, indexP, indexPName, insertB, insertC, insertD, insertF, insertI, insertJ, insertL, insertL, insertL1, insertP, insertS, insertZ, J, javaCode, LForProxy, LForProxy, myFuel, name, newInstance, objectToCS, objectToCSArray, objectToCSArray, P, prevD, prevL, PType, S, setB, setC, setCountP, setD, setD, setExec, setF, setFuel, setI, setJ, setL, setL, setL, setL1, setMyFuel, setName, setObject, setPrevExec, setPType, setS, setZ, start, toString, V, Z

Methods inherited from class codesimian.CS

addB, addC, addD, addF, addI, addJ, addL, addP, addP, addP, addP, addP, addS, addZ, BForProxy, CForProxy, clone, cost, D, deleteP, FForProxy, GETB, GETC, GETD, GETF, GETI, GETJ, GETL, GETS, GETZ, IForProxy, isIllusion, JForProxy, L, L, L, L, maxD, minD, overwrites, parent, parsePriority, PB, PC, PD, PF, PI, PJ, PL, prevB, prevC, prevF, prevI, prevJ, prevS, prevZ, proxyOf, PS, PZ, reflect, reflect, reflect6, setB, SETB, setC, SETC, setCost, SETD, setDescription, setF, SETF, setHeap, setI, SETI, setJ, SETJ, SETL, setL, setL, setParent, setParsePriority, setProxyOf, setS, SETS, setTester, setZ, SETZ, SForProxy, tester, toJavaCode, VForProxy, voidReflect, ZForProxy

Methods inherited from class java.lang.Object

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

Constructor Detail

CodesimianOptions

public CodesimianOptions()

Method Detail

defaultInstance

public static CodesimianOptions defaultInstance()

getOption

public CS getOption(java.lang.String optionName)

returns a new copy of the option

getAllOptionNames

public java.lang.String[] getAllOptionNames()

minP

public int minP()

Description copied from class: DefaultCS

For DForProxy().
Minimum number of parameters in param[] needed to call DForProxy().
Defines which indexs of param[] DForProxy() can use.
Functions with a different number of parameters must override this.
OVERRIDE THIS FUNCTION IF EXEC USES A DIFFERENT NUMBER OF PARAMETERS.
Default is 1.

Overrides:

minP in class DefaultCS

maxP

public int maxP()

Description copied from class: CS

Maximum quantity of Params

Overrides:

maxP in class CS

keyword

public java.lang.String keyword()

Description copied from class: DefaultCS

For the CodeSimian language as a String.
CodeSimian language keyword, like "+" "*" "max" ">" etc.

Override this function if you want to specify a keyword other than how I derive them from the class name, like + for Add.

Some CSs might never be intended to be used in the language by their keyword.
The best example (4/05) is Num, because it is used in the language like "3.4" instead of "num()".
Default: Returns class name, minus package name (and its dots), and change the first letter to lowercase.

For example, CS.MaxParams does not override keyword(), which returns "maxP".

Overrides:

keyword in class DefaultCS

See Also:

CS.parent(), CS.newInstance(), CS.name()

setP

public boolean setP(int index,
                    CS value)

Description copied from class: CS

Every CS is a list of other CSs, between size minP() and maxP() inclusive. setP overwrites one of those CSs or adds a new one at the end, depending on the index. If index is between 0 and countP()-1, overwrites. If it equals countP(), adds at end.

Overrides:

setP in class DefaultCS

copyAll

public CS copyAll()

returns a copy of all codesimian's options, a CS used as a list of CS. If you want to modify that list and see Codesimian's options modified, use reflectAll().

reflectAll

public CS reflectAll()

returns a CS to be used as a list. If you change the contents of that list, Codesimian's options change. If you dont want it to do that, use copyAll() instead.

description

public java.lang.String description()

Description copied from class: CS

a short description of this CS, shorter than the javadoc, but long enough to tell what the params are for. Example use: in automatically generated webpages for CodeSimian. Example: "returns sum of all params" for Add.

Overrides:

description in class DefaultCS

L

public java.lang.Object L(java.lang.Class type)

Description copied from class: CS

Optionally execute this CS, and definitely try to CAST it to the specified Java type. If fail, throw a ClassCastException.

It is preferred not to return CSs from this function. If you have a CS to return, the standard is to put it in param0... setP(0,returnValue), where the function caller should get the output from... P(0).

The functions: V Z B C S I J F D and L , usually EXECUTE this CS and CAST its value to the specified type.
L does not have to execute this CS, but all the others do. The other difference is L can throw a CSCastException (extends ClassCastException).

No pattern of L()'s behavior is guaranteed except for primitive wrappers and 1D arrays.
The L's of some some CSs are more predictable than others, often written about in javadoc of a class.
If it casts correctly, it could fail later. If it fails many times, and you try again, it could still succeed.

These 10 function names are also used by a core part of Java (but not as function names): java.lang.Class.name() . Example: new int[7][6][5].getClass().getName() returns "[[[I".

EXAMPLES:
JButton b = (JButton) new ButtonCS().L(Component.class); //JButton inherits from Component
int fiveFiftyFive = new N(555).I();
double charValues[] = (double[]) new S("arraySize11").L(double[].class);

Overrides:

L in class CS

See Also:

CS.Z(), CS.B(), CS.C(), CS.S(), CS.I(), CS.J(), CS.F(), CS.D()

DForProxy

public double DForProxy()

Description copied from class: CS

Execute this CS and cast to double.

D() and DForProxy() are the 2 most important functions in CS. They execute this CS. All other execute functions, by default, return DForProxy cast to their own type.

For example, J() calls the proxy which calls JForProxy() which calls DForProxy(). D() calls the proxy which calls DForProxy().

By default, all other primitive EXECUTE functions defer to D.
Functions that EXECUTE this CS: L(Class) L(int,Class,int) Z() B() C() S() I() J() F() D() V()

Specified by:

DForProxy in class DefaultCS

sortCsListOfOptionsGUIs

public void sortCsListOfOptionsGUIs(java.lang.String[] firstFewOptionNames)

sortListOfStringsGUIWithDefaultFilenamesFirst

public void sortListOfStringsGUIWithDefaultFilenamesFirst(java.lang.String nullOrFirstFilename)

if nullOrFirstFilename is null, default filenames start at index 0, else index 1 and the first filename is nullOrFirstFilename

refresh

public void refresh()