Package org.jmol.script

Class ScriptExpr

  • All Implemented Interfaces:
    JmolScriptEvaluator
    Direct Known Subclasses:
    ScriptEval
    abstract class ScriptExpr
extends ScriptParam
    The ScriptExpr class holds the main functions for processing mathematical and atom selection expressions. The two methods, parameterExpression and atomExpression are the key starting points for this processing.

    • Field Detail

      • debugHigh

        public boolean debugHigh

      • cmdExt

        private CmdExt cmdExt

      • isoExt

        private IsoExt isoExt

      • tempStatement

        protected T[] tempStatement

      • ptTemp

        private javajs.util.P3 ptTemp

    • Constructor Detail

      • ScriptExpr

        ScriptExpr()

    • Method Detail

      • getCmdExt

        public CmdExt getCmdExt()

      • getIsoExt

        public IsoExt getIsoExt()

      • getMathExt

        public MathExt getMathExt()

      • getSmilesExt

        public SmilesExt getSmilesExt()

      • getExt

        private java.lang.Object getExt​(java.lang.String type)

      • parameterExpressionList

        protected javajs.util.Lst<SV> parameterExpressionList​(int pt,
                                                      int ptAtom,
                                                      boolean isArrayItem)
                                               throws ScriptException
        Throws:
        ScriptException

      • parameterExpressionString

        protected java.lang.String parameterExpressionString​(int pt,
                                                     int ptMax)
                                              throws ScriptException
        Throws:
        ScriptException

      • parameterExpressionSelect

        protected boolean parameterExpressionSelect​(java.util.Map<java.lang.String,​SV> h,
                                            T[] where)
                                     throws ScriptException
        Throws:
        ScriptException

      • parameterExpression

        private java.lang.Object parameterExpression​(int pt,
                                             int ptMax,
                                             java.lang.String key,
                                             boolean ignoreComma,
                                             boolean asVector,
                                             int ptAtom,
                                             boolean isArrayItem,
                                             java.util.Map<java.lang.String,​SV> localVars,
                                             java.lang.String localVar,
                                             boolean isSpecialAssignment)
                                      throws ScriptException
        This is the primary driver of the RPN (reverse Polish notation) expression processor. It handles all math outside of a "traditional" Jmol SELECT/RESTRICT context. [Object atomExpression() takes care of that, and also uses the RPN class.]
        Parameters:
        pt - token index in statement start of expression or negative for one expression only.
        ptMax - token index in statement end of expression
        key - variable name for debugging reference only -- null indicates return Boolean -- "" indicates return String
        ignoreComma -
        asVector - a flag passed on to RPN;
        ptAtom - this is a for() or select() function with a specific atom selected
        isArrayItem - we are storing A[x] = ... so we need to deliver "x" as well
        localVars - see below -- lists all nested for(x, {exp}, select(y, {ex},...)) variables
        localVar - x or y in above for(), select() examples
        isSpecialAssignment - x[n] = ....
        Returns:
        either a vector or a value, caller's choice.
        Throws:
        ScriptException - errors are thrown directly to the Eval error system.

      • atomExpression

        public BS atomExpression​(T[] code,
                         int pcStart,
                         int pcStop,
                         boolean allowRefresh,
                         boolean allowUnderflow,
                         java.lang.Object[] ret,
                         boolean andNotDeleted)
                  throws ScriptException
        Parameters:
        code -
        pcStart -
        pcStop -
        allowRefresh -
        allowUnderflow -
        ret - -- true return value; may not be a BS
        andNotDeleted - IGNORED
        Returns:
        atom bitset
        Throws:
        ScriptException

      • noCopy

        protected boolean noCopy​(int i,
                         int dir)

      • getAssocArray

        protected java.util.Map<java.lang.String,​java.lang.Object> getAssocArray​(int i)
                                                                        throws ScriptException
        Throws:
        ScriptException

      • listBS

        protected javajs.util.Lst<SV> listBS​(BS bs)

      • compareFloatData

        protected BS compareFloatData​(int tokWhat,
                              float[] data,
                              int tokOperator,
                              float comparisonFloat)
        Parameters:
        tokWhat -
        data -
        tokOperator -
        comparisonFloat -
        Returns:
        BitSet

      • compareFloat

        protected boolean compareFloat​(int tokOperator,
                               float a,
                               float b)

      • compareString

        private BS compareString​(int tokWhat,
                         int tokOperator,
                         java.lang.String comparisonString)
                  throws ScriptException
        Throws:
        ScriptException

      • compareStringValues

        private boolean compareStringValues​(int tokOperator,
                                    java.lang.String propertyValue,
                                    java.lang.String comparisonValue)
                             throws ScriptException
        Throws:
        ScriptException

      • compareInt

        private BS compareInt​(int tokWhat,
                      int tokOperator,
                      int ival)

      • getBitsetProperty

        public java.lang.Object getBitsetProperty​(BS bs,
                                          int tok,
                                          javajs.util.P3 ptRef,
                                          javajs.util.P4 planeRef,
                                          java.lang.Object tokenValue,
                                          java.lang.Object opValue,
                                          boolean useAtomMap,
                                          int index,
                                          boolean asVectorIfAll)
                                   throws ScriptException
        Throws:
        ScriptException

      • bitSetForModelFileNumber

        private BS bitSetForModelFileNumber​(int m)

      • getStringObjectAsVariable

        private java.lang.Object getStringObjectAsVariable​(java.lang.Object obj)

      • getAtomBits

        protected BS getAtomBits​(int tokType,
                         java.lang.Object specInfo)

      • getSeqCode

        protected static int getSeqCode​(T instruction)

      • setVariable

        protected SV setVariable​(int pt,
                         int ptMax,
                         java.lang.String key,
                         boolean isSet)
                  throws ScriptException
        Parameters:
        pt - starting point in command token sequence
        ptMax - ending point in command token sequenec, possibly -1 for "all"
        key - the variable name to save the result in. This must be a standard user variable, either local or global
        isSet - from Set ... or Var .... or just xxx ....
        Returns:
        a variable or null
        Throws:
        ScriptException

      • setStatement

        protected boolean setStatement​(T[] st0,
                               int pt0)
                        throws ScriptException
        provides support for @x and @{....} in statements. The compiler passes on these, because they must be integrated with the statement dynamically.
        Parameters:
        st0 - aaToken[i]
        pt0 -
        Returns:
        a fixed token set -- with possible overrun of unused null tokens
        Throws:
        ScriptException