| Methods Summary |
|---|
| private void | Abort(java.lang.String s)Report Error and Halt
Error(s);
//System.exit(1); //throw exception??
throw new RuntimeException("Cannot Parse, sorry : " + s + " @ " + pointer + " [Formula String was: '" + formulaString + "']");
|
| private void | Add()Recognize and Translate an Add
Match('+");
Term();
tokens.add(new AddPtg());
|
| private int | Arguments()get arguments to a function
int numArgs = 0;
if (look != ')") {
numArgs++;
Expression();
addArgumentPointer();
}
while (look == '," || look == ';") { //TODO handle EmptyArgs
if(look == ',") {
Match(',");
}
else {
Match(';");
}
Expression();
addArgumentPointer();
numArgs++;
}
return numArgs;
|
| private void | Concat()Recognize and Translate a Concatination
Match('&");
Term();
tokens.add(new ConcatPtg());
|
| private void | Divide()Recognize and Translate a Divide
Match('/");
Factor();
tokens.add(new DividePtg());
|
| private void | Emit(java.lang.String s)Output a String with Tab
System.out.print(TAB+s);
|
| private void | EmitLn(java.lang.String s)Output a String with Tab and CRLF
Emit(s);
System.out.println();;
|
| private void | Equal()Recognize and Translate a test for Equality
Match('=");
Expression();
tokens.add(new EqualPtg());
|
| private void | Error(java.lang.String s)Report an Error
System.out.println("Error: "+s);
|
| private void | Expected(java.lang.String s)Report What Was Expected
Abort(s + " Expected");
|
| private void | Expression()Parse and Translate an Expression
Term();
while (IsAddop(look)) {
if (look == '+" ) Add();
else if (look == '-") Subtract();
}
/*
* This isn't quite right since it would allow multiple comparison operators.
*/
if(look == '=" || look == '>" || look == '<") {
if (look == '=") Equal();
else if (look == '>") GreaterThan();
else if (look == '<") LessThan();
return;
}
|
| private void | Factor()Parse and Translate a Math Factor
if (look == '-")
{
Match('-");
Factor();
tokens.add(new UnaryMinusPtg());
}
else if (look == '+") {
Match('+");
Factor();
tokens.add(new UnaryPlusPtg());
}
else if (look == '(" ) {
Match('(");
Expression();
Match(')");
tokens.add(new ParenthesisPtg());
} else if (IsAlpha(look) || look == '\'"){
Ident();
} else if(look == '"") {
StringLiteral();
} else if (look == ')" || look == ',") {
tokens.add(new MissingArgPtg());
} else {
String number = GetNum();
if (look=='.") {
Match('.");
String decimalPart = null;
if (IsDigit(look)) number = number +"."+ GetNum(); //this also takes care of someone entering "1234."
if ('E" == look) {
String exponent = GetExponent();
number += 'E" + exponent;
}
tokens.add(new NumberPtg(number));
}
else if ('E" == look) {
String exponent = GetExponent();
number += 'E"+exponent;
tokens.add(new NumberPtg(number));
}
else {
tokens.add(getNumberPtgFromString(number)); //TODO:what if the number is too big to be a short? ..add factory to return Int or Number!
}
}
|
| private void | GetChar()Read New Character From Input Stream
// Check to see if we've walked off the end of the string.
// Just return if so and reset Look to smoething to keep
// SkipWhitespace from spinning
if (pointer == formulaLength) {
look = (char)0;
return;
}
look=formulaString.charAt(pointer++);
//System.out.println("Got char: "+ look);
|
| private java.lang.String | GetExponent()Get the exponent for numbers of form 1.3E21
StringBuffer retval = new StringBuffer();
String sign = "";
GetChar();
if ('-" == look) {
sign = "-";
GetChar();
}
while (IsDigit(look)) {
retval.append(look);
GetChar();
}
if (retval.length() > 0) {
retval.insert(0, sign);
}
return retval.toString();
|
| private java.lang.String | GetName()Get an Identifier
StringBuffer Token = new StringBuffer();
if (!IsAlpha(look) && look != '\'") {
Expected("Name");
}
if(look == '\'")
{
Match('\'");
boolean done = look == '\'";
while(!done)
{
Token.append(Character.toUpperCase(look));
GetChar();
if(look == '\'")
{
Match('\'");
done = look != '\'";
}
}
}
else
{
while (IsAlNum(look)) {
Token.append(Character.toUpperCase(look));
GetChar();
}
}
SkipWhite();
return Token.toString();
|
| private java.lang.String | GetNameAsIs()Get an Identifier AS IS, without stripping white spaces or
converting to uppercase; used for literals
StringBuffer Token = new StringBuffer();
while (IsAlNum(look) || IsWhite(look) || IsSpecialChar(look)) {
Token = Token.append(look);
GetChar();
}
return Token.toString();
|
| private java.lang.String | GetNum()Get a Number
StringBuffer value = new StringBuffer();
if (!IsDigit(look)) Expected("Integer");
while (IsDigit(look)){
value.append(look);
GetChar();
}
SkipWhite();
return value.toString();
|
| private void | GreaterEqual()Recognize and translate Greater than or Equal
Match('=");
Expression();
tokens.add(new GreaterEqualPtg());
|
| private void | GreaterThan()Recognize and Translate a Greater Than
Match('>");
if(look == '=")
GreaterEqual();
else {
Expression();
tokens.add(new GreaterThanPtg());
}
|
| private void | Ident()Parse and Translate a String Identifier
String name;
name = GetName();
if (look == '("){
//This is a function
function(name);
} else if (look == ':") { // this is a AreaReference
String first = name;
Match(':");
String second = GetName();
tokens.add(new AreaPtg(first+":"+second));
} else if (look == '!") {
Match('!");
String sheetName = name;
String first = GetName();
short externIdx = book.checkExternSheet(book.getSheetIndex(sheetName));
if (look == ':") {
Match(':");
String second=GetName();
if (look == '!") {
//The sheet name was included in both of the areas. Only really
//need it once
Match('!");
String third=GetName();
if (!sheetName.equals(second))
throw new RuntimeException("Unhandled double sheet reference.");
tokens.add(new Area3DPtg(first+":"+third,externIdx));
} else {
tokens.add(new Area3DPtg(first+":"+second,externIdx));
}
} else {
tokens.add(new Ref3DPtg(first,externIdx));
}
} else {
//this can be either a cell ref or a named range !!
boolean cellRef = true ; //we should probably do it with reg exp??
boolean boolLit = (name.equals("TRUE") || name.equals("FALSE"));
if (boolLit) {
tokens.add(new BoolPtg(name));
} else if (cellRef) {
tokens.add(new ReferencePtg(name));
}else {
//handle after named range is integrated!!
}
}
|
| private boolean | IsAddop(char c)Recognize an Addop
return (c =='+" || c =='-");
|
| private boolean | IsAlNum(char c)Recognize an Alphanumeric
return (IsAlpha(c) || IsDigit(c));
|
| private boolean | IsAlpha(char c)Recognize an Alpha Character
return Character.isLetter(c) || c == '$" || c=='_";
|
| private boolean | IsDigit(char c)Recognize a Decimal Digit
//System.out.println("Checking digit for"+c);
return Character.isDigit(c);
|
| private boolean | IsSpecialChar(char c)Determines special characters;primarily in use for definition of string literals
return (c == '>" || c== '<" || c== '=" || c=='&" || c=='[" || c==']");
|
| private boolean | IsWhite(char c)Recognize White Space
return (c ==' " || c== TAB);
|
| private void | LessEqual()Recognize and translate Less than or Equal
Match('=");
Expression();
tokens.add(new LessEqualPtg());
|
| private void | LessThan()Recognize and Translate a Less Than
Match('<");
if(look == '=")
LessEqual();
else if(look == '>")
NotEqual();
else {
Expression();
tokens.add(new LessThanPtg());
}
|
| private void | Match(char x)Match a Specific Input Character
if (look != x) {
Expected("" + x + "");
}else {
GetChar();
SkipWhite();
}
|
| private void | Multiply()Recognize and Translate a Multiply
Match('*");
Factor();
tokens.add(new MultiplyPtg());
|
| private void | NotEqual()Recognize and not Equal
Match('>");
Expression();
tokens.add(new NotEqualPtg());
|
| private void | Power()
Match('^");
Term();
tokens.add(new PowerPtg());
|
| private void | SkipWhite()Skip Over Leading White Space
while (IsWhite(look)) {
GetChar();
}
|
| private void | StringLiteral()
// Can't use match here 'cuz it consumes whitespace
// which we need to preserve inside the string.
// - pete
// Match('"');
if (look != '"")
Expected("\"");
else
{
GetChar();
StringBuffer Token = new StringBuffer();
for (;;)
{
if (look == '"")
{
GetChar();
SkipWhite(); //potential white space here since it doesnt matter up to the operator
if (look == '"")
Token.append("\"");
else
break;
}
else if (look == 0)
{
break;
}
else
{
Token.append(look);
GetChar();
}
}
tokens.add(new StringPtg(Token.toString()));
}
|
| private void | Subtract()Recognize and Translate a Subtract
Match('-");
Term();
tokens.add(new SubtractPtg());
|
| private void | Term()Parse and Translate a Math Term
Factor();
while (look == '*" || look == '/" || look == '^" || look == '&") {
///TODO do we need to do anything here??
if (look == '*") Multiply();
else if (look == '/") Divide();
else if (look == '^") Power();
else if (look == '&") Concat();
}
|
| private void | addArgumentPointer()Adds a pointer to the last token to the latest function argument list.
if (this.functionTokens.size() > 0) {
//no bounds check because this method should not be called unless a token array is setup by function()
List arguments = (List)this.functionTokens.get(0);
arguments.add(tokens.get(tokens.size()-1));
}
|
| private org.apache.poi.hssf.model.Node | createTree()Create a tree representation of the RPN token array
used to run the class(RVA) change algo
java.util.Stack stack = new java.util.Stack();
int numPtgs = tokens.size();
OperationPtg o;
int numOperands;
Node[] operands;
for (int i=0;i<numPtgs;i++) {
if (tokens.get(i) instanceof OperationPtg) {
o = (OperationPtg) tokens.get(i);
numOperands = o.getNumberOfOperands();
operands = new Node[numOperands];
for (int j=0;j<numOperands;j++) {
operands[numOperands-j-1] = (Node) stack.pop();
}
Node result = new Node(o);
result.setChildren(operands);
stack.push(result);
} else {
stack.push(new Node((Ptg)tokens.get(i)));
}
}
return (Node) stack.pop();
|
| private void | function(java.lang.String name)
//average 2 args per function
this.functionTokens.add(0, new ArrayList(2));
Match('(");
int numArgs = Arguments();
Match(')");
AbstractFunctionPtg functionPtg = getFunction(name,(byte)numArgs);
tokens.add(functionPtg);
if (functionPtg.getName().equals("externalflag")) {
tokens.add(new NamePtg(name, this.book));
}
//remove what we just put in
this.functionTokens.remove(0);
|
| private org.apache.poi.hssf.record.formula.AbstractFunctionPtg | getFunction(java.lang.String name, byte numArgs)Generates the variable function ptg for the formula.
For IF Formulas, additional PTGs are added to the tokens
AbstractFunctionPtg retval = null;
if (name.equals("IF")) {
retval = new FuncVarPtg(AbstractFunctionPtg.ATTR_NAME, numArgs);
//simulated pop, no bounds checking because this list better be populated by function()
List argumentPointers = (List)this.functionTokens.get(0);
AttrPtg ifPtg = new AttrPtg();
ifPtg.setData((short)7); //mirroring excel output
ifPtg.setOptimizedIf(true);
if (argumentPointers.size() != 2 && argumentPointers.size() != 3) {
throw new IllegalArgumentException("["+argumentPointers.size()+"] Arguments Found - An IF formula requires 2 or 3 arguments. IF(CONDITION, TRUE_VALUE, FALSE_VALUE [OPTIONAL]");
}
//Biffview of an IF formula record indicates the attr ptg goes after the condition ptgs and are
//tracked in the argument pointers
//The beginning first argument pointer is the last ptg of the condition
int ifIndex = tokens.indexOf(argumentPointers.get(0))+1;
tokens.add(ifIndex, ifPtg);
//we now need a goto ptgAttr to skip to the end of the formula after a true condition
//the true condition is should be inserted after the last ptg in the first argument
int gotoIndex = tokens.indexOf(argumentPointers.get(1))+1;
AttrPtg goto1Ptg = new AttrPtg();
goto1Ptg.setGoto(true);
tokens.add(gotoIndex, goto1Ptg);
if (numArgs > 2) { //only add false jump if there is a false condition
//second goto to skip past the function ptg
AttrPtg goto2Ptg = new AttrPtg();
goto2Ptg.setGoto(true);
goto2Ptg.setData((short)(retval.getSize()-1));
//Page 472 of the Microsoft Excel Developer's kit states that:
//The b(or w) field specifies the number byes (or words to skip, minus 1
tokens.add(goto2Ptg); //this goes after all the arguments are defined
}
//data portion of the if ptg points to the false subexpression (Page 472 of MS Excel Developer's kit)
//count the number of bytes after the ifPtg to the False Subexpression
//doesn't specify -1 in the documentation
ifPtg.setData((short)(getPtgSize(ifIndex+1, gotoIndex)));
//count all the additional (goto) ptgs but dont count itself
int ptgCount = this.getPtgSize(gotoIndex)-goto1Ptg.getSize()+retval.getSize();
if (ptgCount > (int)Short.MAX_VALUE) {
throw new RuntimeException("Ptg Size exceeds short when being specified for a goto ptg in an if");
}
goto1Ptg.setData((short)(ptgCount-1));
} else {
retval = new FuncVarPtg(name,numArgs);
}
return retval;
|
| private org.apache.poi.hssf.record.formula.Ptg | getNumberPtgFromString(java.lang.String number)Get a PTG for an integer from its string representation.
return Int or Number Ptg based on size of input
try {
return new IntPtg(number);
} catch (NumberFormatException e) {
return new NumberPtg(number);
}
|
| private int | getPtgSize(int index)Adds the size of all the ptgs after the provided index (inclusive).
Initially used to count a goto
int count = 0;
Iterator ptgIterator = tokens.listIterator(index);
while (ptgIterator.hasNext()) {
Ptg ptg = (Ptg)ptgIterator.next();
count+=ptg.getSize();
}
return count;
|
| private int | getPtgSize(int start, int end)
int count = 0;
int index = start;
Iterator ptgIterator = tokens.listIterator(index);
while (ptgIterator.hasNext() && index <= end) {
Ptg ptg = (Ptg)ptgIterator.next();
count+=ptg.getSize();
index++;
}
return count;
|
| public org.apache.poi.hssf.record.formula.Ptg[] | getRPNPtg()API call to retrive the array of Ptgs created as
a result of the parsing
return getRPNPtg(FORMULA_TYPE_CELL);
|
| public org.apache.poi.hssf.record.formula.Ptg[] | getRPNPtg(int formulaType)
Node node = createTree();
setRootLevelRVA(node, formulaType);
setParameterRVA(node,formulaType);
return (Ptg[]) tokens.toArray(new Ptg[0]);
|
| private void | init()Initialize
GetChar();
SkipWhite();
|
| public void | parse()API call to execute the parsing of the formula
synchronized (tokens) {
init();
Expression();
}
|
| private void | setClass(org.apache.poi.hssf.model.Node n, byte theClass)
Ptg p = (Ptg) n.getValue();
if (p instanceof AbstractFunctionPtg || !(p instanceof OperationPtg)) {
p.setClass(theClass);
} else {
for (int i =0;i<n.getNumChildren();i++) {
setClass(n.getChild(i),theClass);
}
}
|
| private void | setParameterRVA(org.apache.poi.hssf.model.Node n, int formulaType)
Ptg p = n.getValue();
int numOperands = n.getNumChildren();
if (p instanceof AbstractFunctionPtg) {
for (int i =0;i<numOperands;i++) {
setParameterRVA(n.getChild(i),((AbstractFunctionPtg)p).getParameterClass(i),formulaType);
// if (n.getChild(i).getValue() instanceof AbstractFunctionPtg) {
// setParameterRVA(n.getChild(i),formulaType);
// }
setParameterRVA(n.getChild(i),formulaType);
}
} else {
for (int i =0;i<numOperands;i++) {
setParameterRVA(n.getChild(i),formulaType);
}
}
|
| private void | setParameterRVA(org.apache.poi.hssf.model.Node n, int expectedClass, int formulaType)
Ptg p = (Ptg) n.getValue();
if (expectedClass == Ptg.CLASS_REF) { //pg 15, table 1
if (p.getDefaultOperandClass() == Ptg.CLASS_REF ) {
setClass(n, Ptg.CLASS_REF);
}
if (p.getDefaultOperandClass() == Ptg.CLASS_VALUE) {
if (formulaType==FORMULA_TYPE_CELL || formulaType == FORMULA_TYPE_SHARED) {
setClass(n,Ptg.CLASS_VALUE);
} else {
setClass(n,Ptg.CLASS_ARRAY);
}
}
if (p.getDefaultOperandClass() == Ptg.CLASS_ARRAY ) {
setClass(n, Ptg.CLASS_ARRAY);
}
} else if (expectedClass == Ptg.CLASS_VALUE) { //pg 15, table 2
if (formulaType == FORMULA_TYPE_NAMEDRANGE) {
setClass(n,Ptg.CLASS_ARRAY) ;
} else {
setClass(n,Ptg.CLASS_VALUE);
}
} else { //Array class, pg 16.
if (p.getDefaultOperandClass() == Ptg.CLASS_VALUE &&
(formulaType==FORMULA_TYPE_CELL || formulaType == FORMULA_TYPE_SHARED)) {
setClass(n,Ptg.CLASS_VALUE);
} else {
setClass(n,Ptg.CLASS_ARRAY);
}
}
|
| private void | setRootLevelRVA(org.apache.poi.hssf.model.Node n, int formulaType)
//Pg 16, excelfileformat.pdf @ openoffice.org
Ptg p = (Ptg) n.getValue();
if (formulaType == FormulaParser.FORMULA_TYPE_NAMEDRANGE) {
if (p.getDefaultOperandClass() == Ptg.CLASS_REF) {
setClass(n,Ptg.CLASS_REF);
} else {
setClass(n,Ptg.CLASS_ARRAY);
}
} else {
setClass(n,Ptg.CLASS_VALUE);
}
|
| public static java.lang.String | toFormulaString(Workbook book, java.util.List lptgs)Convience method which takes in a list then passes it to the other toFormulaString
signature.
String retval = null;
if (lptgs == null || lptgs.size() == 0) return "#NAME";
Ptg[] ptgs = new Ptg[lptgs.size()];
ptgs = (Ptg[])lptgs.toArray(ptgs);
retval = toFormulaString(book, ptgs);
return retval;
|
| public static java.lang.String | toFormulaString(Workbook book, org.apache.poi.hssf.record.formula.Ptg[] ptgs)Static method to convert an array of Ptgs in RPN order
to a human readable string format in infix mode.
if (ptgs == null || ptgs.length == 0) return "#NAME";
java.util.Stack stack = new java.util.Stack();
AttrPtg ifptg = null;
// Excel allows to have AttrPtg at position 0 (such as Blanks) which
// do not have any operands. Skip them.
stack.push(ptgs[0].toFormulaString(book));
for (int i = 1; i < ptgs.length; i++) {
if (! (ptgs[i] instanceof OperationPtg)) {
stack.push(ptgs[i].toFormulaString(book));
continue;
}
if (ptgs[i] instanceof AttrPtg && ((AttrPtg) ptgs[i]).isOptimizedIf()) {
ifptg = (AttrPtg) ptgs[i];
continue;
}
final OperationPtg o = (OperationPtg) ptgs[i];
final String[] operands = new String[o.getNumberOfOperands()];
for (int j = operands.length; j > 0; j--) {
//TODO: catch stack underflow and throw parse exception.
operands[j - 1] = (String) stack.pop();
}
stack.push(o.toFormulaString(operands));
if (!(o instanceof AbstractFunctionPtg)) continue;
final AbstractFunctionPtg f = (AbstractFunctionPtg) o;
final String fname = f.getName();
if (fname == null) continue;
if ((ifptg != null) && (fname.equals("specialflag"))) {
// this special case will be way different.
stack.push(ifptg.toFormulaString(new String[]{(String) stack.pop()}));
continue;
}
if (fname.equals("externalflag")) {
final String top = (String) stack.pop();
final int paren = top.indexOf('(");
final int comma = top.indexOf(',");
if (comma == -1) {
final int rparen = top.indexOf(')");
stack.push(top.substring(paren + 1, rparen) + "()");
}
else {
stack.push(top.substring(paren + 1, comma) + '(" +
top.substring(comma + 1));
}
}
}
// TODO: catch stack underflow and throw parse exception.
return (String) stack.pop();
|
| public java.lang.String | toString()toString on the parser instance returns the RPN ordered list of tokens
Useful for testing
StringBuffer buf = new StringBuffer();
for (int i=0;i<tokens.size();i++) {
buf.append( ( (Ptg)tokens.get(i)).toFormulaString(book));
buf.append(' ");
}
return buf.toString();
|
