moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Follow on from bug 44675 - regenerated functionMetadata.txt from new ooo excelfileformat.odt

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@658986 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Josh Micich 2008-05-22 03:26:25 +00:00
parent d3ee29261c
commit 30faafa87e
5 changed files with 74 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/resources/main/org/apache/poi/hssf/record/formula/function/functionMetadata-asGenerated.txt
View File

@ -14,7 +14,7 @@
# limitations under the License. # limitations under the License.
# Created by (org.apache.poi.hssf.record.formula.function.ExcelFileFormatDocFunctionExtractor) # Created by (org.apache.poi.hssf.record.formula.function.ExcelFileFormatDocFunctionExtractor)
# from source file 'excelfileformat.odt' (size=355750, crc=0x2FAEA65A) # from source file 'excelfileformat.odt' (size=356107, md5=0x8f789cb6e75594caf068f8e193004ef4)
# #
#Columns: (index, name, minParams, maxParams, returnClass, paramClasses, isVolatile, hasFootnote ) #Columns: (index, name, minParams, maxParams, returnClass, paramClasses, isVolatile, hasFootnote )
@ -37,7 +37,7 @@
15 SIN 1 1 V V 15 SIN 1 1 V V
16 COS 1 1 V V 16 COS 1 1 V V
17 TAN 1 1 V V 17 TAN 1 1 V V
18 ARCTAN 1 1 V V 18 ATAN 1 1 V V
19 PI 0 0 V - 19 PI 0 0 V -
20 SQRT 1 1 V V 20 SQRT 1 1 V V
21 EXP 1 1 V V 21 EXP 1 1 V V
@ -141,8 +141,8 @@
169 COUNTA 0 30 V R 169 COUNTA 0 30 V R
183 PRODUCT 0 30 V R 183 PRODUCT 0 30 V R
184 FACT 1 1 V V 184 FACT 1 1 V V
191 DPRODUCT 3 3 V R R R 189 DPRODUCT 3 3 V R R R
192 ISNONTEXT 1 1 V V 190 ISNONTEXT 1 1 V V
193 STDEVP 1 30 V R 193 STDEVP 1 30 V R
194 VARP 1 30 V R 194 VARP 1 30 V R
195 DSTDEVP 3 3 V R R R 195 DSTDEVP 3 3 V R R R
@ -184,6 +184,8 @@
244 INFO 1 1 V V 244 INFO 1 1 V V
# New Built-In Sheet Functions in BIFF4 # New Built-In Sheet Functions in BIFF4
14 FIXED 2 3 V V V V x 14 FIXED 2 3 V V V V x
204 USDOLLAR 1 2 V V V x
215 DBCS 1 1 V V x
216 RANK 2 3 V V R V 216 RANK 2 3 V V R V
247 DB 4 5 V V V V V V 247 DB 4 5 V V V V V V
252 FREQUENCY 2 2 A R R 252 FREQUENCY 2 2 A R R

6
src/resources/main/org/apache/poi/hssf/record/formula/function/functionMetadata.txt
View File

@ -14,11 +14,9 @@
# limitations under the License. # limitations under the License.
# Created by (org.apache.poi.hssf.record.formula.function.ExcelFileFormatDocFunctionExtractor) # Created by (org.apache.poi.hssf.record.formula.function.ExcelFileFormatDocFunctionExtractor)
# from source file 'excelfileformat.odt' (size=355750, crc=0x2FAEA65A) # from source file 'excelfileformat.odt' (size=356107, md5=0x8f789cb6e75594caf068f8e193004ef4)
# #
#Columns: (index, name, minParams, maxParams, returnClass, paramClasses, isVolatile, hasFootnote ) #Columns: (index, name, minParams, maxParams, returnClass, paramClasses, isVolatile, hasFootnote )
#
# + some manual edits !
# Built-In Sheet Functions in BIFF2 # Built-In Sheet Functions in BIFF2
0 COUNT 0 30 V R 0 COUNT 0 30 V R
@ -186,7 +184,7 @@
244 INFO 1 1 V V 244 INFO 1 1 V V
# New Built-In Sheet Functions in BIFF4 # New Built-In Sheet Functions in BIFF4
14 FIXED 2 3 V V V V x 14 FIXED 2 3 V V V V x
204 USDOLLAR 1 1 V V x 204 USDOLLAR 1 2 V V V x
215 DBCS 1 1 V V x 215 DBCS 1 1 V V x
216 RANK 2 3 V V R V 216 RANK 2 3 V V R V
247 DB 4 5 V V V V V V 247 DB 4 5 V V V V V V

89
src/testcases/org/apache/poi/hssf/record/formula/function/ExcelFileFormatDocFunctionExtractor.java
View File

@ -26,9 +26,12 @@ import java.io.InputStream;
import java.io.OutputStream; import java.io.OutputStream;
import java.io.PrintStream; import java.io.PrintStream;
import java.io.UnsupportedEncodingException; import java.io.UnsupportedEncodingException;
import java.math.BigInteger;
import java.net.MalformedURLException; import java.net.MalformedURLException;
import java.net.URL; import java.net.URL;
import java.net.URLConnection; import java.net.URLConnection;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.HashMap; import java.util.HashMap;
@ -37,7 +40,6 @@ import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import java.util.Stack; import java.util.Stack;
import java.util.zip.CRC32;
import java.util.zip.ZipException; import java.util.zip.ZipException;
import java.util.zip.ZipFile; import java.util.zip.ZipFile;
@ -149,7 +151,6 @@ public final class ExcelFileFormatDocFunctionExtractor {
private static final class FunctionDataCollector { private static final class FunctionDataCollector {
private final Map _allFunctionsByIndex; private final Map _allFunctionsByIndex;
private final Map _allFunctionsByName; private final Map _allFunctionsByName;
private final Set _groupFunctionIndexes; private final Set _groupFunctionIndexes;
@ -184,25 +185,29 @@ public final class ExcelFileFormatDocFunctionExtractor {
_allFunctionsByName.put(funcName, fd); _allFunctionsByName.put(funcName, fd);
} }
/**
* Some extra validation here.
* Any function which changes definition will have a footnote in the source document
*/
private void checkRedefinedFunction(boolean hasNote, String funcName, Integer funcIxKey) { private void checkRedefinedFunction(boolean hasNote, String funcName, Integer funcIxKey) {
FunctionData fdPrev; FunctionData fdPrev;
// check by index
fdPrev = (FunctionData) _allFunctionsByIndex.get(funcIxKey); fdPrev = (FunctionData) _allFunctionsByIndex.get(funcIxKey);
if(fdPrev != null) { if(fdPrev != null) {
if(fdPrev.hasFootnote() && hasNote) { if(!fdPrev.hasFootnote() || !hasNote) {
// func def can change if both have a foot-note throw new RuntimeException("changing function ["
+ funcIxKey + "] definition without foot-note");
}
_allFunctionsByName.remove(fdPrev.getName()); _allFunctionsByName.remove(fdPrev.getName());
} else {
throw new RuntimeException("changing function definition without foot-note");
}
} }
// check by name
fdPrev = (FunctionData) _allFunctionsByName.get(funcName); fdPrev = (FunctionData) _allFunctionsByName.get(funcName);
if(fdPrev != null) { if(fdPrev != null) {
if(fdPrev.hasFootnote() && hasNote) { if(!fdPrev.hasFootnote() || !hasNote) {
// func def can change if both have a foot-note throw new RuntimeException("changing function '"
_allFunctionsByIndex.remove(new Integer(fdPrev.getIndex())); + funcName + "' definition without foot-note");
} else {
throw new RuntimeException("changing function definition without foot-note");
} }
_allFunctionsByIndex.remove(new Integer(fdPrev.getIndex()));
} }
} }
@ -237,9 +242,13 @@ public final class ExcelFileFormatDocFunctionExtractor {
private static final String[] TABLE_CELL_RELPATH_NAMES = { private static final String[] TABLE_CELL_RELPATH_NAMES = {
"table:table-row", "table:table-cell", "text:p", "table:table-row", "table:table-cell", "text:p",
}; };
private static final String[] NOTE_REF_RELPATH_NAMES = { // after May 2008 there was one more style applied to the footnotes
private static final String[] NOTE_REF_RELPATH_NAMES_OLD = {
"table:table-row", "table:table-cell", "text:p", "text:span", "text:note-ref", "table:table-row", "table:table-cell", "text:p", "text:span", "text:note-ref",
}; };
private static final String[] NOTE_REF_RELPATH_NAMES = {
"table:table-row", "table:table-cell", "text:p", "text:span", "text:span", "text:note-ref",
};
private final Stack _elemNameStack; private final Stack _elemNameStack;
@ -368,6 +377,8 @@ public final class ExcelFileFormatDocFunctionExtractor {
} else if(matchesRelPath(TABLE_CELL_RELPATH_NAMES)) { } else if(matchesRelPath(TABLE_CELL_RELPATH_NAMES)) {
_textNodeBuffer.setLength(0); _textNodeBuffer.setLength(0);
_cellHasNote = false; _cellHasNote = false;
} else if(matchesRelPath(NOTE_REF_RELPATH_NAMES_OLD)) {
_cellHasNote = true;
} else if(matchesRelPath(NOTE_REF_RELPATH_NAMES)) { } else if(matchesRelPath(NOTE_REF_RELPATH_NAMES)) {
_cellHasNote = true; _cellHasNote = true;
} }
@ -456,6 +467,9 @@ public final class ExcelFileFormatDocFunctionExtractor {
} }
private static void processFile(File effDocFile, File outFile) { private static void processFile(File effDocFile, File outFile) {
if(!effDocFile.exists()) {
throw new RuntimeException("file '" + effDocFile.getAbsolutePath() + "' does not exist");
}
OutputStream os; OutputStream os;
try { try {
os = new FileOutputStream(outFile); os = new FileOutputStream(outFile);
@ -475,7 +489,7 @@ public final class ExcelFileFormatDocFunctionExtractor {
ps.println("# Created by (" + genClass.getName() + ")"); ps.println("# Created by (" + genClass.getName() + ")");
// identify the source file // identify the source file
ps.print("# from source file '" + SOURCE_DOC_FILE_NAME + "'"); ps.print("# from source file '" + SOURCE_DOC_FILE_NAME + "'");
ps.println(" (size=" + effDocFile.length() + ", crc=" + getFileCRC(effDocFile) + ")"); ps.println(" (size=" + effDocFile.length() + ", md5=" + getFileMD5(effDocFile) + ")");
ps.println("#"); ps.println("#");
ps.println("#Columns: (index, name, minParams, maxParams, returnClass, paramClasses, isVolatile, hasFootnote )"); ps.println("#Columns: (index, name, minParams, maxParams, returnClass, paramClasses, isVolatile, hasFootnote )");
ps.println(""); ps.println("");
@ -490,6 +504,14 @@ public final class ExcelFileFormatDocFunctionExtractor {
throw new RuntimeException(e); throw new RuntimeException(e);
} }
ps.close(); ps.close();
String canonicalOutputFileName;
try {
canonicalOutputFileName = outFile.getCanonicalPath();
} catch (IOException e) {
throw new RuntimeException(e);
}
System.out.println("Successfully output to '" + canonicalOutputFileName + "'");
} }
private static void outputLicenseHeader(PrintStream ps) { private static void outputLicenseHeader(PrintStream ps) {
@ -519,8 +541,14 @@ public final class ExcelFileFormatDocFunctionExtractor {
/** /**
* Helps identify the source file * Helps identify the source file
*/ */
private static String getFileCRC(File f) { private static String getFileMD5(File f) {
CRC32 crc = new CRC32(); MessageDigest m;
try {
m = MessageDigest.getInstance("MD5");
} catch (NoSuchAlgorithmException e) {
throw new RuntimeException(e);
}
byte[]buf = new byte[2048]; byte[]buf = new byte[2048];
try { try {
InputStream is = new FileInputStream(f); InputStream is = new FileInputStream(f);
@ -529,21 +557,17 @@ public final class ExcelFileFormatDocFunctionExtractor {
if(bytesRead<1) { if(bytesRead<1) {
break; break;
} }
crc.update(buf, 0, bytesRead); m.update(buf, 0, bytesRead);
} }
is.close(); is.close();
} catch (IOException e) { } catch (IOException e) {
throw new RuntimeException(e); throw new RuntimeException(e);
} }
return "0x" + Long.toHexString(crc.getValue()).toUpperCase();
return "0x" + new BigInteger(1, m.digest()).toString(16);
} }
private static File getSourceFile() { private static File downloadSourceFile() {
if (false) {
File dir = new File("c:/temp");
File effDocFile = new File(dir, SOURCE_DOC_FILE_NAME);
return effDocFile;
}
URL url; URL url;
try { try {
url = new URL("http://sc.openoffice.org/" + SOURCE_DOC_FILE_NAME); url = new URL("http://sc.openoffice.org/" + SOURCE_DOC_FILE_NAME);
@ -557,7 +581,7 @@ public final class ExcelFileFormatDocFunctionExtractor {
URLConnection conn = url.openConnection(); URLConnection conn = url.openConnection();
InputStream is = conn.getInputStream(); InputStream is = conn.getInputStream();
System.out.println("downloading " + url.toExternalForm()); System.out.println("downloading " + url.toExternalForm());
result = File.createTempFile("excelfileformat", "odt"); result = File.createTempFile("excelfileformat", ".odt");
OutputStream os = new FileOutputStream(result); OutputStream os = new FileOutputStream(result);
while(true) { while(true) {
int bytesRead = is.read(buf); int bytesRead = is.read(buf);
@ -577,12 +601,17 @@ public final class ExcelFileFormatDocFunctionExtractor {
public static void main(String[] args) { public static void main(String[] args) {
File effDocFile = getSourceFile(); File outFile = new File("functionMetadata-asGenerated.txt");
if(!effDocFile.exists()) {
throw new RuntimeException("file '" + effDocFile.getAbsolutePath() + "' does not exist"); if (false) { // set true to use local file
File dir = new File("c:/temp");
File effDocFile = new File(dir, SOURCE_DOC_FILE_NAME);
processFile(effDocFile, outFile);
return;
} }
File outFile = new File("functionMetadata-asGenerated.txt"); File tempEFFDocFile = downloadSourceFile();
processFile(effDocFile, outFile); processFile(tempEFFDocFile, outFile);
tempEFFDocFile.delete();
} }
} }

5
src/testcases/org/apache/poi/hssf/record/formula/function/TestParseMissingBuiltInFuncs.java
View File

@ -21,7 +21,6 @@ import junit.framework.AssertionFailedError;
import junit.framework.TestCase; import junit.framework.TestCase;
import org.apache.poi.hssf.model.FormulaParser; import org.apache.poi.hssf.model.FormulaParser;
import org.apache.poi.hssf.model.Workbook;
import org.apache.poi.hssf.record.formula.AbstractFunctionPtg; import org.apache.poi.hssf.record.formula.AbstractFunctionPtg;
import org.apache.poi.hssf.record.formula.FuncPtg; import org.apache.poi.hssf.record.formula.FuncPtg;
import org.apache.poi.hssf.record.formula.FuncVarPtg; import org.apache.poi.hssf.record.formula.FuncVarPtg;
@ -29,7 +28,7 @@ import org.apache.poi.hssf.record.formula.Ptg;
import org.apache.poi.hssf.usermodel.HSSFWorkbook; import org.apache.poi.hssf.usermodel.HSSFWorkbook;
/** /**
* Tests parsing of some built-in functions that were not properly * Tests parsing of some built-in functions that were not properly
* registered in POI as bug #44675, #44733 (March/April 2008). * registered in POI as of bug #44675, #44733 (March/April 2008).
* *
* @author Josh Micich * @author Josh Micich
*/ */
@ -76,7 +75,7 @@ public final class TestParseMissingBuiltInFuncs extends TestCase {
} }
public void testUsdollar() { public void testUsdollar() {
confirmFunc("USDOLLAR(1)", 2, false, 204); confirmFunc("USDOLLAR(1)", 2, true, 204);
} }
public void testDBCS() { public void testDBCS() {

12
src/testcases/org/apache/poi/hssf/record/formula/function/TestReadMissingBuiltInFuncs.java
View File

@ -17,22 +17,18 @@
package org.apache.poi.hssf.record.formula.function; package org.apache.poi.hssf.record.formula.function;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.InvocationTargetException; import java.lang.reflect.InvocationTargetException;
import junit.framework.AssertionFailedError;
import junit.framework.TestCase;
import org.apache.poi.hssf.HSSFTestDataSamples; import org.apache.poi.hssf.HSSFTestDataSamples;
import org.apache.poi.hssf.record.RecordFormatException; import org.apache.poi.hssf.record.RecordFormatException;
import org.apache.poi.hssf.usermodel.HSSFSheet; import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook; import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import junit.framework.AssertionFailedError;
import junit.framework.TestCase;
/** /**
* Tests reading from a sample spreadsheet some built-in functions that were not properly * Tests reading from a sample spreadsheet some built-in functions that were not properly
* registered in POI as bug #44675, #44733 (March/April 2008). * registered in POI as of bug #44675, #44733 (March/April 2008).
* *
* @author Josh Micich * @author Josh Micich
*/ */