diff --git a/.classpath b/.classpath deleted file mode 100644 index 75589e24b1..0000000000 --- a/.classpath +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - diff --git a/.cvsignore b/.cvsignore index 558342ccee..6a33107942 100644 --- a/.cvsignore +++ b/.cvsignore @@ -1,4 +1,5 @@ dist +build scripts *.el *.ipr @@ -8,3 +9,5 @@ build.number log*.* *.log build +.classpath +.project diff --git a/.project b/.project deleted file mode 100644 index 2a90ecdda8..0000000000 --- a/.project +++ /dev/null @@ -1,17 +0,0 @@ - - - POI - - - - - - org.eclipse.jdt.core.javabuilder - - - - - - org.eclipse.jdt.core.javanature - - diff --git a/build.xml b/build.xml index 0ed314e0bf..3b6ba76afc 100644 --- a/build.xml +++ b/build.xml @@ -6,7 +6,7 @@ Glen Stampoultzis glens at apache.org - This build was tested with and 1.5.3 although it will probably work with + This build was tested with ant 1.5.3 although it will probably work with other versions. The following jar files should be installed into the ant lib directory: @@ -15,6 +15,7 @@ junit(3.8+) http://www.ibiblio.org/maven/junit/jars/ xerces http://www.ibiblio.org/maven/xerces/jars/ jdepend http://www.ibiblio.org/maven/jdepend/jars/ + xalan http://www.ibiblio.org/maven/xalan/jars/ The ant jar "optional.jar" should also be available otherwise the build will fail. @@ -82,7 +83,7 @@ - + @@ -141,14 +142,17 @@ + - - + + + + @@ -214,15 +218,16 @@ - - - + - + + + + @@ -238,14 +243,9 @@ - - - - - - - - + + + @@ -254,6 +254,24 @@ + + + + + + + + + + + + + + + + + + @@ -334,11 +352,10 @@ - - Please install apache forrest and set the - FORREST_HOME environment variable. - - + Please install Apache Forrest (see +<http://xml.apache.org/forrest/index.html>) and set the +FORREST_HOME environment variable! + @@ -386,6 +403,18 @@ + + + + + + @@ -425,15 +454,7 @@ out="${jdepend.report.out.dir}/index.html" style="jdepend.xsl"/> - - - + - - - + + + @@ -570,6 +591,6 @@ - + diff --git a/src/documentation/content/xdocs/book.xml b/src/documentation/content/xdocs/book.xml index 178ecadb59..7b054188a4 100644 --- a/src/documentation/content/xdocs/book.xml +++ b/src/documentation/content/xdocs/book.xml @@ -9,7 +9,7 @@ - + diff --git a/src/documentation/content/xdocs/changes.xml b/src/documentation/content/xdocs/changes.xml deleted file mode 100644 index de73c7bc6c..0000000000 --- a/src/documentation/content/xdocs/changes.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - History of Changes - - - - - - - - - - - Patch applied for deep cloning of worksheets was provided - Patch applied to allow sheet reordering - Added additional print area setting methods using row/column numbers - HDF: Negative Array size fix - Added argument pointers to support the IF formula - Formulas: Added special character support for string literals, specifically for SUMIF formula support and addresses a bug as well - BlockingInputStream committed to help ensure reads - Fixed problem with NaN values differing from the investigated value from file reads in FormulaRecords - Patch for getColumnWidth in HSSF - Patch for dealing with mult-level numbered lists in HDF - Due to named reference work, several named-ranged bugs were closed - Patch applied to prevent sheet corruption after a template modification - Shared Formulas now Supported - Added GreaterEqual, LessEqual and NotEqual to Formula Parser - Added GreaterThan and LessThan functionality to formulas - Patches for i10n - POI Build System Updated - font names can now be null - - - Support for zoom level - Freeze and split pane support - Row and column headers on printouts - - - Custom Data Format Support - Enhanced Unicode Support for Russian and Japanese - Enhanced formula support including read-only for - "optimized if" statements. - Support for cloning objects - Fixes for header/footer - Spanish Documentation translations - Support for preserving VBA macros - - - Removed runtime dependency on commons logging. - Formula support - - - Removed depedency on commons logging. Now define poi.logging system property to enable logging to standard out. - Fixed SST string handling so that spreadsheets with rich text or extended text will be read correctly. - - - New project build. - New project documentation system based on Cocoon. - Package rename - Various bug fixes - Early stages of HSF development (not ready for development) - Initial low level record support for charting (not complete) - - - Created new event model - Optimizations made to HSSF including aggregate records for - values, rows, etc. - predictive sizing, offset based writing (instead of lots of - array copies) - minor re-factoring and bug fixes. - - - Minor documentation updates. - - - Added DataFormat helper class and exposed set and get format - on HSSFCellStyle - Fixed column width apis (unit wise) and various javadoc on - the subject - Fix for Dimensions record (again)... (one of these days I'll - write a unit test for this ;-p). - Some optimization on sheet creation. - - - Changes not recorded. - - - Added MulBlank, Blank, ColInfo - Added log4j facility and removed all sys.out type logging - Added support for adding font's, styles and corresponding - high level api for styling cells - added support for changing row height, cell width and default - row height/cell width. - Added fixes for internationalization (UTF-16 should work now - from HSSFCell.setStringValue, etc when the encoding is set) - added support for adding/removing and naming sheets. - - - Bugfix release. We were throwing an exception when reading - RKRecord objects. - - - Got continuation records to work (read/write) - Added various pre-support for formulas - Massive API reorganization, repackaging. - BiffViewer class added for validating HSSF & POI and/or - HSSF Output. - Better API support for modification. - - - Added encoding flag to high and low level api to use utf-16 - when needed (HSSFCell.setEncoding()) - added read only support for Label records (which are - reinterpreted as LabelSST when written) - Broken continuation record implementation (oops) - BiffViewer class added for validating HSSF & POI and/or - HSSF Output. - - - Support for read/write and modify. - Read only support for MulRK records (converted to Number when - writing) - - - - diff --git a/src/documentation/xdocs/dtd/book-cocoon-v10.dtd b/src/documentation/content/xdocs/dtd/book-cocoon-v10.dtd old mode 100755 new mode 100644 similarity index 100% rename from src/documentation/xdocs/dtd/book-cocoon-v10.dtd rename to src/documentation/content/xdocs/dtd/book-cocoon-v10.dtd diff --git a/src/documentation/xdocs/dtd/changes-v11.dtd b/src/documentation/content/xdocs/dtd/changes-v11.dtd similarity index 100% rename from src/documentation/xdocs/dtd/changes-v11.dtd rename to src/documentation/content/xdocs/dtd/changes-v11.dtd diff --git a/src/documentation/xdocs/dtd/document-v11.dtd b/src/documentation/content/xdocs/dtd/document-v11.dtd similarity index 100% rename from src/documentation/xdocs/dtd/document-v11.dtd rename to src/documentation/content/xdocs/dtd/document-v11.dtd diff --git a/src/documentation/xdocs/dtd/faq-v11.dtd b/src/documentation/content/xdocs/dtd/faq-v11.dtd similarity index 100% rename from src/documentation/xdocs/dtd/faq-v11.dtd rename to src/documentation/content/xdocs/dtd/faq-v11.dtd diff --git a/src/documentation/xdocs/dtd/javadoc-v04draft.dtd b/src/documentation/content/xdocs/dtd/javadoc-v04draft.dtd old mode 100755 new mode 100644 similarity index 100% rename from src/documentation/xdocs/dtd/javadoc-v04draft.dtd rename to src/documentation/content/xdocs/dtd/javadoc-v04draft.dtd diff --git a/src/documentation/xdocs/dtd/specification-v11.dtd b/src/documentation/content/xdocs/dtd/specification-v11.dtd similarity index 100% rename from src/documentation/xdocs/dtd/specification-v11.dtd rename to src/documentation/content/xdocs/dtd/specification-v11.dtd diff --git a/src/documentation/xdocs/dtd/todo-v11.dtd b/src/documentation/content/xdocs/dtd/todo-v11.dtd similarity index 100% rename from src/documentation/xdocs/dtd/todo-v11.dtd rename to src/documentation/content/xdocs/dtd/todo-v11.dtd diff --git a/src/documentation/content/xdocs/howtobuild.xml b/src/documentation/content/xdocs/howtobuild.xml index 30cca65161..9b99b26756 100644 --- a/src/documentation/content/xdocs/howtobuild.xml +++ b/src/documentation/content/xdocs/howtobuild.xml @@ -46,6 +46,10 @@ jdepend http://www.ibiblio.org/maven/jdepend/jars/ + + xalan + http://www.ibiblio.org/maven/xalan/jars/ +

Just pick the latest versions of these jars and place diff --git a/src/documentation/content/xdocs/hssf/chart.xml b/src/documentation/content/xdocs/hssf/chart.xml index 55d2c832b2..33b174bf05 100644 --- a/src/documentation/content/xdocs/hssf/chart.xml +++ b/src/documentation/content/xdocs/hssf/chart.xml @@ -478,7 +478,7 @@ recordid = 0x1034, size =0 [END] [/END] - + ============================================ Offset 0x1006 (4102) rectype = 0x1044, recsize = 0x4 @@ -801,6 +801,7 @@ .crossesFarRight = false .reversed = false [/CATSERRANGE] + ============================================ Offset 0x1124 (4388) @@ -1220,7 +1221,7 @@ [UNKNOWN RECORD] .id = 104f [/UNKNOWN RECORD] - + ============================================ Offset 0x12c4 (4804) rectype = 0x1051, recsize = 0x8 diff --git a/src/documentation/content/xdocs/hssf/quick-guide.xml b/src/documentation/content/xdocs/hssf/quick-guide.xml index b5203d2058..39a1753385 100644 --- a/src/documentation/content/xdocs/hssf/quick-guide.xml +++ b/src/documentation/content/xdocs/hssf/quick-guide.xml @@ -31,7 +31,7 @@

  • Reading and writing
  • Use newlines in cells.
  • Create user defined data formats.
  • -
  • Fit sheet to one page
  • +
  • Fit Sheet to One Page
  • Set print area for a sheet.
  • Set page numbers on the footer of a sheet.
  • Shift rows.
  • @@ -420,14 +420,14 @@ fileOut.close(); - -
    Set Print Area to One Page + +
    Fit Sheet to One Page HSSFWorkbook wb = new HSSFWorkbook(); HSSFSheet sheet = wb.createSheet("format sheet"); - HSSFPrintSetup ps = sheet.getPrintSetup() + HSSFPrintSetup ps = sheet.getPrintSetup(); - sheet.setAutobreaks(true) + sheet.setAutobreaks(true); ps.setFitHeight((short)1); ps.setFitWidth((short)1); diff --git a/src/documentation/content/xdocs/index.xml b/src/documentation/content/xdocs/index.xml index 274ebf30ef..634745e2df 100644 --- a/src/documentation/content/xdocs/index.xml +++ b/src/documentation/content/xdocs/index.xml @@ -18,11 +18,15 @@
    Purpose

    The POI project consists of APIs for manipulating various file formats - based upon Microsoft's OLE 2 Compound Document format using pure Java. + based upon Microsoft's OLE 2 Compound Document format using pure Java. In short, you can + read and write MS Excel files using Java. Soon, you'll be able to read and write + Word files using Java. POI is your Java Excel solution as well as your Word Excel solution. + However, we have a complete API for porting other OLE 2 Compound Document formats and welcome + others to participate.

    OLE 2 Compound Document Format based files include most Microsoft Office - files such as XLS and DOC. + files such as XLS and DOC as well as MFC serialization API based file formats.

    As a general policy we try to collaborate as much as possible with other projects to @@ -46,7 +50,7 @@ we say that POIFS is the most complete and correct port of this file format to date!

    - You'd use HSSF if you needed to read or write an XLS (Excel) file using Java. You can also read and modify + You'd use HSSF if you needed to read or write an Excel file using Java (XLS). You can also read and modify spreadsheets using this API, although right now writing is more mature.

    diff --git a/src/documentation/content/xdocs/site.xml b/src/documentation/content/xdocs/site.xml index 0d57b605dd..0f80defbaa 100644 --- a/src/documentation/content/xdocs/site.xml +++ b/src/documentation/content/xdocs/site.xml @@ -16,6 +16,7 @@ See http://xml.apache.org/forrest/linking.html for more info + @@ -31,7 +32,8 @@ See http://xml.apache.org/forrest/linking.html for more info - + + diff --git a/src/documentation/content/xdocs/status.xml b/src/documentation/content/xdocs/status.xml index 6a21002c8e..2cf814ae0e 100644 --- a/src/documentation/content/xdocs/status.xml +++ b/src/documentation/content/xdocs/status.xml @@ -1,18 +1,191 @@ - + - + + + + + + 12561 (Min) HSSFWorkbook throws Exceptions + 12730 (Nor) values dont get copied to another sheet. + 13224 (Maj) Exception thrown when cell has =Names call + 13796 (Nor) Error Reading Formula Record (optimized if, external link) + 13921 (Nor) Sheet name cannot exceed 31 characters and cannot contain : + 14330 (Nor) Error reading FormulaRecord + 14460 (Nor) Name in Formula - ArrayOutOfBoundsException + 15228 (Cri) [Urgent] ArrayIndexoutofbounds Exception. POI - Version 1.8 + 16488 (Maj) Unable to open written spreadsheet in Excel, but can in Open + 16559 (Nor) testCustomPalette.xls crashes Excel 97 + 16560 (Nor) testBoolErr.xls crashes Excel '97 + 17374 (Min) HSSFFont - BOLDWEIGHT_NORMAL + 18800 (Maj) The sheet made by HSSFWorkbook#cloneSheet() doesn't work cor + 18846 (Min) [PATCH][RFE]Refactor the transformation between byte array a + 19599 (Min) java.lang.IllegalArgumentException + 19961 (Nor) [PATCH] Sheet.getColumnWidth() returns wrong value + 21066 (Blo) Can not modify a blank spreadsheet + 21444 (Enh) [PATCH] Macro functions + 21447 (Nor) [RFE]String Formula Cells + 21674 (Enh) [PATCH] Documentation changes for @(Greater|Less|Not)EqualPt + 21863 (Enh) [PATCH] build.xml fixes + 22195 (Nor) [RFE] [PATCH] Support for Storage Class ID + 22742 (Cri) Failed to create HSSFWorkbook! + 22922 (Cri) HSSFSheet.shiftRows() throws java.lang.IndexOutOfBoundsExcep + 22963 (Nor) org.apache.poi.hpsf.SummaryInformation.getEditTime() should + 24149 (Maj) Error passing inputstream to POIFSFileSystem + 21722 (Nor) [PATCH] Add a ProtectRecord to Sheets and give control over + 9576 (Nor) [PATCH] DBCELL, INDEX EXTSST (was Acess 97 import) + 13478 (Blo) [PATCH] [RFE] POIFS, RawDataBlock: Missing workaround for lo + 14824 (Nor) Unable to modify empty sheets + 12843 (Cri) [PATCH] Make POI handle chinese better + 15353 (Nor) [RFE] creating a cell with a hyperlink + 15375 (Blo) Post 1.5.1 POI causes spreadsheet to become unopenable. + + + + HPSF is now able to read properties which are given in the property set stream but which don't have a value ("variant" type VT_EMPTY). The getXXX() methods of the PropertySet class return null if their return type is a reference (like a string) or 0 if the return type is numeric. Details about the return types and about how to distinguish between a property value of zero and a property value that is not present can be found in the API documentation. + Gridlines can now be turned on and off + NamePTG refactoring/fixes + minor fixes to ExternSheet and formula strings + Sheet comparisons now ignore case + + + + A nasty concurrency problem has been fixed. Any users working in a multithreaded environment should seriously consider upgrading to this release. + The EXTSST record has been implemented. This record is used by excel for optimized reading of strings. + When rows are shifted, the merged regions now move with them. If a row contains 2 merged cells, the resulting shifted row should have those cells merged as well. + There were some issues when removing merged + regions (specifically, removing all of them and then adding some more) and have been resolved. + When a sheet contained shared formulas (when a formula is + dragged across greater than 6 cells), the clone would fail. We now support cloning of + sheets that contain this Excel optimization. + Support added for reading formulas with UnaryPlus and UnaryMinus operators. + + + Patch applied for deep cloning of worksheets was provided + Patch applied to allow sheet reordering + Added additional print area setting methods using row/column numbers + HDF: Negative Array size fix + Added argument pointers to support the IF formula + Formulas: Added special character support for string literals, specifically for SUMIF formula support and addresses a bug as well + BlockingInputStream committed to help ensure reads + Fixed problem with NaN values differing from the investigated value from file reads in FormulaRecords + Patch for getColumnWidth in HSSF + Patch for dealing with mult-level numbered lists in HDF + Due to named reference work, several named-ranged bugs were closed + Patch applied to prevent sheet corruption after a template modification + Shared Formulas now Supported + Added GreaterEqual, LessEqual and NotEqual to Formula Parser + Added GreaterThan and LessThan functionality to formulas + Patches for i10n + POI Build System Updated + font names can now be null + + + Support for zoom level + Freeze and split pane support + Row and column headers on printouts + + + Custom Data Format Support + Enhanced Unicode Support for Russian and Japanese + Enhanced formula support including read-only for + "optimized if" statements. + Support for cloning objects + Fixes for header/footer + Spanish Documentation translations + Support for preserving VBA macros + + + Removed runtime dependency on commons logging. + Formula support + + + Removed depedency on commons logging. Now define poi.logging system property to enable logging to standard out. + Fixed SST string handling so that spreadsheets with rich text or extended text will be read correctly. + + + New project build. + New project documentation system based on Cocoon. + Package rename + Various bug fixes + Early stages of HSF development (not ready for development) + Initial low level record support for charting (not complete) + + + Created new event model + Optimizations made to HSSF including aggregate records for + values, rows, etc. + predictive sizing, offset based writing (instead of lots of + array copies) + minor re-factoring and bug fixes. + + + Minor documentation updates. + + + Added DataFormat helper class and exposed set and get format + on HSSFCellStyle + Fixed column width apis (unit wise) and various javadoc on + the subject + Fix for Dimensions record (again)... (one of these days I'll + write a unit test for this ;-p). + Some optimization on sheet creation. + + + Changes not recorded. + + + Added MulBlank, Blank, ColInfo + Added log4j facility and removed all sys.out type logging + Added support for adding font's, styles and corresponding + high level api for styling cells + added support for changing row height, cell width and default + row height/cell width. + Added fixes for internationalization (UTF-16 should work now + from HSSFCell.setStringValue, etc when the encoding is set) + added support for adding/removing and naming sheets. + + + Bugfix release. We were throwing an exception when reading + RKRecord objects. + + + Got continuation records to work (read/write) + Added various pre-support for formulas + Massive API reorganization, repackaging. + BiffViewer class added for validating HSSF & POI and/or + HSSF Output. + Better API support for modification. + + + Added encoding flag to high and low level api to use utf-16 + when needed (HSSFCell.setEncoding()) + added read only support for Label records (which are + reinterpreted as LabelSST when written) + Broken continuation record implementation (oops) + BiffViewer class added for validating HSSF & POI and/or + HSSF Output. + + + Support for read/write and modify. + Read only support for MulRK records (converted to Number when + writing) + + + + + - Things To Do for POI + - + Finish HDF @@ -24,7 +197,7 @@ - + Expose functionality in low level records in higher level API @@ -50,103 +223,4 @@ - - - History of Changes - - - Support for zoom level - Freeze and split pane support - Row and column headers on printouts - - - Custom Data Format Support - Enhanced Unicode Support for Russian and Japanese - Enhanced formula support including read-only for - "optimized if" statements. - Support for cloning objects - Fixes for header/footer - Spanish Documentation translations - Support for preserving VBA macros - - - Removed runtime dependency on commons logging. - Formula support - - - Removed depedency on commons logging. Now define poi.logging system property to enable logging to standard out. - Fixed SST string handling so that spreadsheets with rich text or extended text will be read correctly. - - - New project build. - New project documentation system based on Cocoon. - Package rename - Various bug fixes - Early stages of HSF development (not ready for development) - Initial low level record support for charting (not complete) - - - Created new event model - Optimizations made to HSSF including aggregate records for - values, rows, etc. - predictive sizing, offset based writing (instead of lots of - array copies) - minor re-factoring and bug fixes. - - - Minor documentation updates. - - - Added DataFormat helper class and exposed set and get format - on HSSFCellStyle - Fixed column width apis (unit wise) and various javadoc on - the subject - Fix for Dimensions record (again)... (one of these days I'll - write a unit test for this ;-p). - Some optimization on sheet creation. - - - Changes not recorded. - - - Added MulBlank, Blank, ColInfo - Added log4j facility and removed all sys.out type logging - Added support for adding font's, styles and corresponding - high level api for styling cells - added support for changing row height, cell width and default - row height/cell width. - Added fixes for internationalization (UTF-16 should work now - from HSSFCell.setStringValue, etc when the encoding is set) - added support for adding/removing and naming sheets. - - - Bugfix release. We were throwing an exception when reading - RKRecord objects. - - - Got continuation records to work (read/write) - Added various pre-support for formulas - Massive API reorganization, repackaging. - BiffViewer class added for validating HSSF & POI and/or - HSSF Output. - Better API support for modification. - - - Added encoding flag to high and low level api to use utf-16 - when needed (HSSFCell.setEncoding()) - added read only support for Label records (which are - reinterpreted as LabelSST when written) - Broken continuation record implementation (oops) - BiffViewer class added for validating HSSF & POI and/or - HSSF Output. - - - Support for read/write and modify. - Read only support for MulRK records (converted to Number when - writing) - - - - - - \ No newline at end of file + diff --git a/src/documentation/content/xdocs/tabs.xml b/src/documentation/content/xdocs/tabs.xml index 761cf495b4..7a4b189814 100644 --- a/src/documentation/content/xdocs/tabs.xml +++ b/src/documentation/content/xdocs/tabs.xml @@ -1,9 +1,9 @@ - - - - - - - - - Soporte para Formato de Datos Personalizado (Custom) - Soporte Unicode Mejorado para Ruso y Japonés - Soporte para Fórmulas Mejorado, incluyendo - sólo-lectura para sentencias tipo "optimizado si" (optimized if). - Soporte para la clonación de objetos - Arreglos en la cabecera/pie - Traducciones de la documentación al Español - Soporte para preservar macros VBA - - - Se quita la dependencia en tiempo de ejecución del registro - (logging) de "commons". - Soporte para fórmulas - - - Se quita la dependencia del registro de "commons". Ahora hay que definir la propiedad del sistema poi.loggin para permitir - que los registros (logs) vayan a la salida estándar. - Se arregla la gestión de la cadena SST para que las hojas de cálculo con texto rico (rich text) o texto - extendido se lean correctamente. - - - Nueva versión (build) del proyecto. - Nuevo sistema de documentación del proyecto basada en Cocoon. - Cambio de nombre del paquete - Varios errores (bugs) corregidos - Etapas preliminares del desarrollo de HFS (no esta listo para el desarrollo) - Soporte inicial de registros de bajo nivel para gráficas (no está completo) - - - Se crea un nuevo modelo de eventos - Se optimiza HSSF, incluyendo registros (records) para - valores, filas, etc. - predicción de tamaño, escritura basada en desplazamiento (en lugar de - multitud de copias de arrays) - un poco de re-factoring (¿re-factorización? mejor no) y corrección de errores. - - - Actualizaciones menores a la documentación. - - - Se añade la clase de ayuda DataFormat y se expone el formato set y get en - HSSFCellStyle - Correcciones a las apis de anchura de columna (en cuanto a las unidades) y - varios comentarios javadoc al respecto - Corrección para el registro de "Dimensions" (de nuevo)... (uno de estos días - escribiré una prueba unitaria (unit test) para esto ;-p). - Alguna optimización en la creación de páginas. - - - Mejoras no registradas - - - Se añaden MulBlank, Blank, ColInfo - Se añade facilidad log4j y se quitan las anotaciones (logs) del tipo sys.out - Se añade soporte para la adición de fuentes, estilos y el api de alto - nivel correspondiente para dar estilo a las celdas - Se añade soporte para cambiar el alto de una fila, el ancho de una celda, y - sus valores por defecto. - Correcciones para internacionalización (UTF-16 debería funcionar ahora - desde HSSFCell.setStringValue, etc cuando se define la codificación) - Soporte para la adición / eliminación y cambio de nombre de hojas. - - - Distribución de corrección de errores. - Lanzamos una excepción cuando leemos objetos de tipo RKRecord. - - - Registros de continuación ya funcionan (lectura/escritura) - Se añade soporte previo para fórmulas - Reorganización del API masiva, re-enpaquetado. - Se añade la clase BiffViewer para validar HSSF & POI y/o la - salida de HSSF. - Se mejora el soporte a la modificación del API. - - - Se añade una bandera de codificación para que las apis de alto - y bajo nivel utilicen utf-16 cuando sea necesario (HSSFCell.setEncoding()) - Se añade soporte de sólo lectura a registros de Etiqueta - (que son reinterpretados como LabelSST cuando se escriben) - Se rompe la implementación del registro de continuación (oops) - Se añade la clase BiffViewer - para validar HSSF & POI y/o la - salida de HSSF. - - - Soporte para lectura/escritura y modificación. - Soporte de sólo lectura para registros de tipo MulRK - (convertidos a Number cuando se escriben) - - - - diff --git a/src/documentation/resources/images/group-logo.gif b/src/documentation/resources/images/group-logo.gif index 543f6863a3..472e47fd76 100644 Binary files a/src/documentation/resources/images/group-logo.gif and b/src/documentation/resources/images/group-logo.gif differ diff --git a/src/documentation/skinconf.xml b/src/documentation/skinconf.xml index 4606684523..86dcc52eeb 100644 --- a/src/documentation/skinconf.xml +++ b/src/documentation/skinconf.xml @@ -9,22 +9,29 @@ be used to configure the chosen Forrest skin. - + + + + + - + + + @@ -44,12 +51,15 @@ be used to configure the chosen Forrest skin. + + ]> false false + true jakarta.apache.org jakarta diff --git a/src/examples/src/org/apache/poi/hssf/usermodel/examples/ReadWriteWorkbook.java b/src/examples/src/org/apache/poi/hssf/usermodel/examples/ReadWriteWorkbook.java index f80afb95fd..4080a4dc3d 100644 --- a/src/examples/src/org/apache/poi/hssf/usermodel/examples/ReadWriteWorkbook.java +++ b/src/examples/src/org/apache/poi/hssf/usermodel/examples/ReadWriteWorkbook.java @@ -80,6 +80,8 @@ public class ReadWriteWorkbook HSSFWorkbook wb = new HSSFWorkbook(fs); HSSFSheet sheet = wb.getSheetAt(0); HSSFRow row = sheet.getRow(2); + if (row == null) + row = sheet.createRow(2); HSSFCell cell = row.getCell((short)3); if (cell == null) cell = row.createCell((short)3); diff --git a/src/java/org/apache/poi/hpsf/ClassID.java b/src/java/org/apache/poi/hpsf/ClassID.java index 6d56767030..e9939af46b 100644 --- a/src/java/org/apache/poi/hpsf/ClassID.java +++ b/src/java/org/apache/poi/hpsf/ClassID.java @@ -56,6 +56,8 @@ package org.apache.poi.hpsf; import java.io.*; + +import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndian; /** @@ -98,15 +100,21 @@ public class ClassID */ public ClassID() { - bytes = new byte[LENGTH]; - for (int i = 0; i < LENGTH; i++) - bytes[i] = 0x00; + bytes = new byte[LENGTH]; + for (int i = 0; i < LENGTH; i++) + bytes[i] = 0x00; } - public final static int LENGTH = 16; + /**

    The number of bytes occupied by this object in the byte + * stream.

    */ + public static final int LENGTH = 16; + /** + * @return The number of bytes occupied by this object in the byte + * stream. + */ public int length() { return LENGTH; @@ -117,10 +125,12 @@ public class ClassID /** *

    Gets the bytes making out the class ID. They are returned in * correct order, i.e. big-endian.

    + * + * @return the bytes making out the class ID. */ public byte[] getBytes() { - return bytes; + return bytes; } @@ -153,9 +163,9 @@ public class ClassID bytes[6] = src[7 + offset]; bytes[7] = src[6 + offset]; - /* Read 8 bytes. */ - for (int i = 8; i < 16; i++) - bytes[i] = src[i + offset]; + /* Read 8 bytes. */ + for (int i = 8; i < 16; i++) + bytes[i] = src[i + offset]; return bytes; } @@ -170,30 +180,75 @@ public class ClassID * * @param offset The offset within the dst byte array. * - * @throws ArrayIndexOutOfBoundsException if there is not enough - * room for the class ID in the byte array. There must be at least - * 16 bytes in the byte array after the offset - * position. + * @exception ArrayStoreException if there is not enough room for the class + * ID 16 bytes in the byte array after the offset position. */ public void write(final byte[] dst, final int offset) + throws ArrayStoreException { + /* Check array size: */ + if (dst.length < 16) + throw new ArrayStoreException + ("Destination byte[] must have room for at least 16 bytes, " + + "but has a length of only " + dst.length + "."); /* Write double word. */ - dst[0 + offset] = bytes[3]; - dst[1 + offset] = bytes[2]; - dst[2 + offset] = bytes[1]; - dst[3 + offset] = bytes[0]; + dst[0 + offset] = bytes[3]; + dst[1 + offset] = bytes[2]; + dst[2 + offset] = bytes[1]; + dst[3 + offset] = bytes[0]; /* Write first word. */ - dst[4 + offset] = bytes[5]; - dst[5 + offset] = bytes[4]; + dst[4 + offset] = bytes[5]; + dst[5 + offset] = bytes[4]; /* Write second word. */ - dst[6 + offset] = bytes[7]; - dst[7 + offset] = bytes[6]; + dst[6 + offset] = bytes[7]; + dst[7 + offset] = bytes[6]; - /* Write 8 bytes. */ - for (int i = 8; i < 16; i++) - dst[i + offset] = bytes[i]; + /* Write 8 bytes. */ + for (int i = 8; i < 16; i++) + dst[i + offset] = bytes[i]; } + + + /** + *

    Checks whether this ClassID is equal to another + * object.

    + * + * @param o the object to compare this PropertySet with + * @return true if the objects are equal, else + * false.

    + */ + public boolean equals(final Object o) + { + if (o == null || !(o instanceof ClassID)) + return false; + final ClassID cid = (ClassID) o; + if (bytes.length != cid.bytes.length) + return false; + for (int i = 0; i < bytes.length; i++) + if (bytes[i] != cid.bytes[i]) + return false; + return true; + } + /** + * Returns a human readable representation of the Class ID + * in standard format "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" + * @return String representation of the Class ID represented + * by this object. + */ + public String toString() + { + StringBuffer sbClassId = new StringBuffer( 38); + sbClassId.append( '{'); + for( int i=0; i < 16; i++) { + sbClassId.append( HexDump.toHex( bytes[ i])); + if( i == 3 || i == 5 || i == 7 || i == 9) { + sbClassId.append( '-'); + } + } + sbClassId.append( '}'); + return sbClassId.toString(); + } } diff --git a/src/java/org/apache/poi/hpsf/TypeReader.java b/src/java/org/apache/poi/hpsf/TypeReader.java index a6264f75d7..dc441b4b7c 100644 --- a/src/java/org/apache/poi/hpsf/TypeReader.java +++ b/src/java/org/apache/poi/hpsf/TypeReader.java @@ -62,7 +62,6 @@ */ package org.apache.poi.hpsf; -import java.util.*; import org.apache.poi.util.LittleEndian; /** @@ -85,6 +84,7 @@ public class TypeReader * starts * @param length The length of the variant including the variant * type field + * @param type The variant type to read * @return A Java object that corresponds best to the variant * field. For example, a VT_I4 is returned as a {@link Long}, a * VT_LPSTR as a {@link String}. @@ -92,15 +92,25 @@ public class TypeReader * @see Variant */ public static Object read(final byte[] src, int offset, int length, - final int type) + final int type) { - /* - * FIXME: Support reading more types and clean up this code! - */ - Object value; - length = length - LittleEndian.INT_SIZE; + /* + * FIXME: Support reading more types and clean up this code! + */ + Object value; + length = length - LittleEndian.INT_SIZE; switch (type) - { + { + case Variant.VT_EMPTY: + { + /* + * FIXME: The value returned by this case relies on the + * assumption that the value VT_EMPTY denotes consists of zero + * bytes. I'd be glad if some could confirm or correct this. + */ + value = null; + break; + } case Variant.VT_I2: { /* @@ -137,11 +147,11 @@ public class TypeReader * Read a byte string. In Java it is represented as a * String object. The 0x00 bytes at the end must be * stripped. - * - * FIXME: Reading an 8-bit string should pay attention - * to the codepage. Currently the byte making out the - * property's value are interpreted according to the - * platform's default character set. + * + * FIXME: Reading an 8-bit string should pay attention + * to the codepage. Currently the byte making out the + * property's value are interpreted according to the + * platform's default character set. */ final int first = offset + LittleEndian.INT_SIZE; long last = first + LittleEndian.getUInt(src, offset) - 1; @@ -149,7 +159,7 @@ public class TypeReader while (src[(int) last] == 0 && first <= last) last--; value = new String(src, (int) first, (int) (last - first + 1)); - break; + break; } case Variant.VT_LPWSTR: { @@ -160,27 +170,27 @@ public class TypeReader */ final int first = offset + LittleEndian.INT_SIZE; long last = first + LittleEndian.getUInt(src, offset) - 1; - long l = last - first; + long l = last - first; offset += LittleEndian.INT_SIZE; - StringBuffer b = new StringBuffer((int) (last - first)); - for (int i = 0; i <= l; i++) - { - final int i1 = offset + (i * 2); - final int i2 = i1 + 1; - b.append((char) ((src[i2] << 8) + src[i1])); - } - /* Strip 0x00 characters from the end of the string: */ - while (b.charAt(b.length() - 1) == 0x00) - b.setLength(b.length() - 1); - value = b.toString(); - break; + StringBuffer b = new StringBuffer((int) (last - first)); + for (int i = 0; i <= l; i++) + { + final int i1 = offset + (i * 2); + final int i2 = i1 + 1; + b.append((char) ((src[i2] << 8) + src[i1])); + } + /* Strip 0x00 characters from the end of the string: */ + while (b.charAt(b.length() - 1) == 0x00) + b.setLength(b.length() - 1); + value = b.toString(); + break; } case Variant.VT_CF: { final byte[] v = new byte[length]; for (int i = 0; i < length; i++) v[i] = src[(int) (offset + i)]; - value = v; + value = v; break; } case Variant.VT_BOOL: @@ -190,24 +200,24 @@ public class TypeReader * src[offset + 3] contain the DWord for VT_BOOL, so * skip it, we don't need it. */ - final int first = offset + LittleEndian.INT_SIZE; + // final int first = offset + LittleEndian.INT_SIZE; long bool = LittleEndian.getUInt(src, offset); if (bool != 0) value = new Boolean(true); else value = new Boolean(false); - break; + break; } default: { final byte[] v = new byte[length]; for (int i = 0; i < length; i++) v[i] = src[(int) (offset + i)]; - value = v; + value = v; break; } } - return value; + return value; } } diff --git a/src/java/org/apache/poi/hpsf/Variant.java b/src/java/org/apache/poi/hpsf/Variant.java index f49ce4a2e4..e40685d5bf 100644 --- a/src/java/org/apache/poi/hpsf/Variant.java +++ b/src/java/org/apache/poi/hpsf/Variant.java @@ -76,178 +76,178 @@ public class Variant /** *

    [V][P] Nothing.

    */ - public final static int VT_EMPTY = 0; + public static final int VT_EMPTY = 0; /** *

    [V][P] SQL style Null.

    */ - public final static int VT_NULL = 1; + public static final int VT_NULL = 1; /** *

    [V][T][P][S] 2 byte signed int.

    */ - public final static int VT_I2 = 2; + public static final int VT_I2 = 2; /** *

    [V][T][P][S] 4 byte signed int.

    */ - public final static int VT_I4 = 3; + public static final int VT_I4 = 3; /** *

    [V][T][P][S] 4 byte real.

    */ - public final static int VT_R4 = 4; + public static final int VT_R4 = 4; /** *

    [V][T][P][S] 8 byte real.

    */ - public final static int VT_R8 = 5; + public static final int VT_R8 = 5; /** *

    [V][T][P][S] currency. How long is this? How is it to be * interpreted?

    */ - public final static int VT_CY = 6; + public static final int VT_CY = 6; /** *

    [V][T][P][S] date. How long is this? How is it to be * interpreted?

    */ - public final static int VT_DATE = 7; + public static final int VT_DATE = 7; /** *

    [V][T][P][S] OLE Automation string. How long is this? How is it * to be interpreted?

    */ - public final static int VT_BSTR = 8; + public static final int VT_BSTR = 8; /** *

    [V][T][P][S] IDispatch *. How long is this? How is it to be * interpreted?

    */ - public final static int VT_DISPATCH = 9; + public static final int VT_DISPATCH = 9; /** *

    [V][T][S] SCODE. How * long is this? How is it to be interpreted?

    */ - public final static int VT_ERROR = 10; + public static final int VT_ERROR = 10; /** *

    [V][T][P][S] True=-1, False=0.

    */ - public final static int VT_BOOL = 11; + public static final int VT_BOOL = 11; /** *

    [V][T][P][S] VARIANT *. How long is this? How is it to be * interpreted?

    */ - public final static int VT_VARIANT = 12; + public static final int VT_VARIANT = 12; /** *

    [V][T][S] IUnknown *. How long is this? How is it to be * interpreted?

    */ - public final static int VT_UNKNOWN = 13; + public static final int VT_UNKNOWN = 13; /** *

    [V][T][S] 16 byte fixed point.

    */ - public final static int VT_DECIMAL = 14; + public static final int VT_DECIMAL = 14; /** *

    [T] signed char.

    */ - public final static int VT_I1 = 16; + public static final int VT_I1 = 16; /** *

    [V][T][P][S] unsigned char.

    */ - public final static int VT_UI1 = 17; + public static final int VT_UI1 = 17; /** *

    [T][P] unsigned short.

    */ - public final static int VT_UI2 = 18; + public static final int VT_UI2 = 18; /** *

    [T][P] unsigned int.

    */ - public final static int VT_UI4 = 19; + public static final int VT_UI4 = 19; /** *

    [T][P] signed 64-bit int.

    */ - public final static int VT_I8 = 20; + public static final int VT_I8 = 20; /** *

    [T][P] unsigned 64-bit int.

    */ - public final static int VT_UI8 = 21; + public static final int VT_UI8 = 21; /** *

    [T] signed machine int.

    */ - public final static int VT_INT = 22; + public static final int VT_INT = 22; /** *

    [T] unsigned machine int.

    */ - public final static int VT_UINT = 23; + public static final int VT_UINT = 23; /** *

    [T] C style void.

    */ - public final static int VT_VOID = 24; + public static final int VT_VOID = 24; /** *

    [T] Standard return type. How long is this? How is it to be * interpreted?

    */ - public final static int VT_HRESULT = 25; + public static final int VT_HRESULT = 25; /** *

    [T] pointer type. How long is this? How is it to be * interpreted?

    */ - public final static int VT_PTR = 26; + public static final int VT_PTR = 26; /** *

    [T] (use VT_ARRAY in VARIANT).

    */ - public final static int VT_SAFEARRAY = 27; + public static final int VT_SAFEARRAY = 27; /** *

    [T] C style array. How long is this? How is it to be * interpreted?

    */ - public final static int VT_CARRAY = 28; + public static final int VT_CARRAY = 28; /** *

    [T] user defined type. How long is this? How is it to be * interpreted?

    */ - public final static int VT_USERDEFINED = 29; + public static final int VT_USERDEFINED = 29; /** *

    [T][P] null terminated string.

    */ - public final static int VT_LPSTR = 30; + public static final int VT_LPSTR = 30; /** *

    [T][P] wide (Unicode) null terminated string.

    */ - public final static int VT_LPWSTR = 31; + public static final int VT_LPWSTR = 31; /** *

    [P] FILETIME. The FILETIME structure holds a date and time @@ -256,50 +256,50 @@ public class Variant * have passed since January 1, 1601. This 64-bit value is split * into the two dwords stored in the structure.

    */ - public final static int VT_FILETIME = 64; + public static final int VT_FILETIME = 64; /** *

    [P] Length prefixed bytes.

    */ - public final static int VT_BLOB = 65; + public static final int VT_BLOB = 65; /** *

    [P] Name of the stream follows.

    */ - public final static int VT_STREAM = 66; + public static final int VT_STREAM = 66; /** *

    [P] Name of the storage follows.

    */ - public final static int VT_STORAGE = 67; + public static final int VT_STORAGE = 67; /** *

    [P] Stream contains an object. How long is this? How is it * to be interpreted?

    */ - public final static int VT_STREAMED_OBJECT = 68; + public static final int VT_STREAMED_OBJECT = 68; /** *

    [P] Storage contains an object. How long is this? How is it * to be interpreted?

    */ - public final static int VT_STORED_OBJECT = 69; + public static final int VT_STORED_OBJECT = 69; /** *

    [P] Blob contains an object. How long is this? How is it to be * interpreted?

    */ - public final static int VT_BLOB_OBJECT = 70; + public static final int VT_BLOB_OBJECT = 70; /** *

    [P] Clipboard format. How long is this? How is it to be * interpreted?

    */ - public final static int VT_CF = 71; + public static final int VT_CF = 71; /** *

    [P] A Class ID.

    @@ -331,34 +331,46 @@ public class Variant * target="_blank"> * msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp.

    */ - public final static int VT_CLSID = 72; + public static final int VT_CLSID = 72; /** *

    [P] simple counted array. How long is this? How is it to be * interpreted?

    */ - public final static int VT_VECTOR = 0x1000; + public static final int VT_VECTOR = 0x1000; /** *

    [V] SAFEARRAY*. How * long is this? How is it to be interpreted?

    */ - public final static int VT_ARRAY = 0x2000; + public static final int VT_ARRAY = 0x2000; /** *

    [V] void* for local use. How long is this? How is it to be * interpreted?

    */ - public final static int VT_BYREF = 0x4000; + public static final int VT_BYREF = 0x4000; - public final static int VT_RESERVED = 0x8000; + /** + *

    FIXME: Document this!

    + */ + public static final int VT_RESERVED = 0x8000; - public final static int VT_ILLEGAL = 0xFFFF; + /** + *

    FIXME: Document this!

    + */ + public static final int VT_ILLEGAL = 0xFFFF; - public final static int VT_ILLEGALMASKED = 0xFFF; + /** + *

    FIXME: Document this!

    + */ + public static final int VT_ILLEGALMASKED = 0xFFF; - public final static int VT_TYPEMASK = 0xFFF; + /** + *

    FIXME: Document this!

    + */ + public static final int VT_TYPEMASK = 0xFFF; -} +} \ No newline at end of file diff --git a/src/java/org/apache/poi/hssf/dev/FormulaViewer.java b/src/java/org/apache/poi/hssf/dev/FormulaViewer.java index 1e7fd95965..3443fda1a6 100644 --- a/src/java/org/apache/poi/hssf/dev/FormulaViewer.java +++ b/src/java/org/apache/poi/hssf/dev/FormulaViewer.java @@ -77,7 +77,6 @@ import org.apache.poi.hssf.record.*; import org.apache.poi.hssf.record.formula.*; import org.apache.poi.hssf.model.*; import org.apache.poi.hssf.usermodel.*; -import org.apache.poi.hssf.util.SheetReferences; /** * FormulaViewer - finds formulas in a BIFF8 file and attempts to read them/display @@ -144,7 +143,7 @@ public class FormulaViewer StringBuffer buf = new StringBuffer(); if (token instanceof ExpPtg) return; - buf.append(name=((OperationPtg) token).toFormulaString((SheetReferences)null)); + buf.append(name=((OperationPtg) token).toFormulaString((Workbook)null)); buf.append(sep); switch (token.getPtgClass()) { case Ptg.CLASS_REF : @@ -213,7 +212,7 @@ public class FormulaViewer StringBuffer buf = new StringBuffer(); for (int i=0;i0) { - o = (OperationPtg) ptgs[i]; + stack.push(ptgs[0].toFormulaString(book)); - if (o instanceof AttrPtg && ((AttrPtg)o).isOptimizedIf()) { - ifptg=(AttrPtg)o; - } else { + for (int i = 1; i < ptgs.length; i++) { + if (! (ptgs[i] instanceof OperationPtg)) { + stack.push(ptgs[i].toFormulaString(book)); + continue; + } - numOperands = o.getNumberOfOperands(); - operands = new String[numOperands]; + if (ptgs[i] instanceof AttrPtg && ((AttrPtg) ptgs[i]).isOptimizedIf()) { + ifptg = (AttrPtg) ptgs[i]; + continue; + } - for (int j=0;j 0; j--) { + //TODO: catch stack underflow and throw parse exception. + operands[j - 1] = (String) stack.pop(); } - if ( (o instanceof AbstractFunctionPtg) && - ((AbstractFunctionPtg)o).getName().equals("specialflag") && - ifptg != null - ) { + 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. - result = ifptg.toFormulaString( - new String[] {(o.toFormulaString(operands))} - ); - ifptg = null; - } else { - result = o.toFormulaString(operands); + stack.push(ifptg.toFormulaString(new String[]{(String) stack.pop()})); + continue; } - stack.push(result); + 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(ptgs[i].toFormulaString(refs)); + else { + stack.push(top.substring(paren + 1, comma) + '(' + + top.substring(comma + 1)); } } - return (String) stack.pop(); //TODO: catch stack underflow and throw parse exception. } + // TODO: catch stack underflow and throw parse exception. + return (String) stack.pop(); + } + + /** Create a tree representation of the RPN token array *used to run the class(RVA) change algo */ @@ -890,11 +909,9 @@ end; * Useful for testing */ public String toString() { - SheetReferences refs = null; - if (book!=null) book.getSheetReferences(); StringBuffer buf = new StringBuffer(); for (int i=0;i 0) { + merged = (MergeCellsRecord) mergedRecords.get(mergedRecords.size() - 1); + } else { + merged = null; + } + } } } @@ -970,10 +1004,7 @@ public class Sheet implements Model { checkCells(); log.logFormatted(log.DEBUG, "remove value record row,dimsloc %,%", - new int[] - { - row, dimsloc - }); + new int[]{row, dimsloc} ); loc = dimsloc; cells.removeCell(col); @@ -2011,7 +2042,7 @@ public class Sheet implements Model * @return record containing a WindowTwoRecord */ - protected Record createWindowTwo() + protected WindowTwoRecord createWindowTwo() { WindowTwoRecord retval = new WindowTwoRecord(); @@ -2312,7 +2343,6 @@ public class Sheet implements Model * @param sel True to select the sheet, false otherwise. */ public void setSelected(boolean sel) { - WindowTwoRecord windowTwo = (WindowTwoRecord) findFirstRecordBySid(WindowTwoRecord.sid); windowTwo.setSelected(sel); } @@ -2321,82 +2351,59 @@ public class Sheet implements Model * @param margin which margin to get * @return the size of the margin */ - public double getMargin(short margin) { - Margin m; - switch ( margin ) - { - case LeftMargin: - m = (Margin) findFirstRecordBySid( LeftMarginRecord.sid ); - if ( m == null ) - return .75; - break; - case RightMargin: - m = (Margin) findFirstRecordBySid( RightMarginRecord.sid ); - if ( m == null ) - return .75; - break; - case TopMargin: - m = (Margin) findFirstRecordBySid( TopMarginRecord.sid ); - if ( m == null ) - return 1.0; - break; - case BottomMargin: - m = (Margin) findFirstRecordBySid( BottomMarginRecord.sid ); - if ( m == null ) - return 1.0; - break; - default : - throw new RuntimeException( "Unknown margin constant: " + margin ); - } - return m.getMargin(); - } + public double getMargin(short margin) { + if (getMargins()[margin] != null) + return margins[margin].getMargin(); + else { + switch ( margin ) + { + case LeftMargin: + return .75; + case RightMargin: + return .75; + case TopMargin: + return 1.0; + case BottomMargin: + return 1.0; + default : + throw new RuntimeException( "Unknown margin constant: " + margin ); + } + } + } /** * Sets the size of the margin in inches. * @param margin which margin to get * @param size the size of the margin */ - public void setMargin(short margin, double size) { - Margin m; - switch ( margin ) - { - case LeftMargin: - m = (Margin) findFirstRecordBySid( LeftMarginRecord.sid ); - if ( m == null ) - { - m = new LeftMarginRecord(); - records.add( getDimsLoc() + 1, m ); - } - break; - case RightMargin: - m = (Margin) findFirstRecordBySid( RightMarginRecord.sid ); - if ( m == null ) - { - m = new RightMarginRecord(); - records.add( getDimsLoc() + 1, m ); - } - break; - case TopMargin: - m = (Margin) findFirstRecordBySid( TopMarginRecord.sid ); - if ( m == null ) - { - m = new TopMarginRecord(); - records.add( getDimsLoc() + 1, m ); - } - break; - case BottomMargin: - m = (Margin) findFirstRecordBySid( BottomMarginRecord.sid ); - if ( m == null ) - { - m = new BottomMarginRecord(); - records.add( getDimsLoc() + 1, m ); - } - break; - default : - throw new RuntimeException( "Unknown margin constant: " + margin ); - } - m.setMargin( size ); - } + public void setMargin(short margin, double size) { + Margin m = getMargins()[margin]; + if (m == null) { + switch ( margin ) + { + case LeftMargin: + m = new LeftMarginRecord(); + records.add( getDimsLoc() + 1, m ); + break; + case RightMargin: + m = new RightMarginRecord(); + records.add( getDimsLoc() + 1, m ); + break; + case TopMargin: + m = new TopMarginRecord(); + records.add( getDimsLoc() + 1, m ); + break; + case BottomMargin: + m = new BottomMarginRecord(); + records.add( getDimsLoc() + 1, m ); + break; + default : + throw new RuntimeException( "Unknown margin constant: " + margin ); + } + margins[margin] = m; + } + m.setMargin( size ); + } public int getEofLoc() { @@ -2434,9 +2441,8 @@ public class Sheet implements Model } records.add(loc+1, pane); - WindowTwoRecord windowRecord = (WindowTwoRecord) records.get(loc); - windowRecord.setFreezePanes(true); - windowRecord.setFreezePanesNoSplit(true); + windowTwo.setFreezePanes(true); + windowTwo.setFreezePanesNoSplit(true); SelectionRecord sel = (SelectionRecord) findFirstRecordBySid(SelectionRecord.sid); // SelectionRecord sel2 = (SelectionRecord) sel.clone(); @@ -2484,9 +2490,8 @@ public class Sheet implements Model r.setActivePane((short) activePane); records.add(loc+1, r); - WindowTwoRecord windowRecord = (WindowTwoRecord) records.get(loc); - windowRecord.setFreezePanes(false); - windowRecord.setFreezePanesNoSplit(false); + windowTwo.setFreezePanes(false); + windowTwo.setFreezePanesNoSplit(false); SelectionRecord sel = (SelectionRecord) findFirstRecordBySid(SelectionRecord.sid); // SelectionRecord sel2 = (SelectionRecord) sel.clone(); @@ -2519,5 +2524,84 @@ public class Sheet implements Model { this.selection = selection; } + /** + * creates a Protect record with protect set to false. + * @see org.apache.poi.hssf.record.ProtectRecord + * @see org.apache.poi.hssf.record.Record + * @return a ProtectRecord + */ + protected Record createProtect() + { + log.log(log.DEBUG, "create protect record with protection disabled"); + ProtectRecord retval = new ProtectRecord(); + + retval.setProtect(false); + // by default even when we support encryption we won't + return retval; + } + + public ProtectRecord getProtect() + { + return protect; + } + + /** + * Sets whether the gridlines are shown in a viewer. + * @param show whether to show gridlines or not + */ + public void setDisplayGridlines(boolean show) { + windowTwo.setDisplayGridlines(show); + } + + /** + * Returns if gridlines are displayed. + * @return whether gridlines are displayed + */ + public boolean isDisplayGridlines() { + return windowTwo.getDisplayGridlines(); + } + + /** + * Sets whether the formulas are shown in a viewer. + * @param show whether to show formulas or not + */ + public void setDisplayFormulas(boolean show) { + windowTwo.setDisplayFormulas(show); + } + + /** + * Returns if formulas are displayed. + * @return whether formulas are displayed + */ + public boolean isDisplayFormulas() { + return windowTwo.getDisplayFormulas(); + } + + /** + * Sets whether the RowColHeadings are shown in a viewer. + * @param show whether to show RowColHeadings or not + */ + public void setDisplayRowColHeadings(boolean show) { + windowTwo.setDisplayRowColHeadings(show); + } + + /** + * Returns if RowColHeadings are displayed. + * @return whether RowColHeadings are displayed + */ + public boolean isDisplayRowColHeadings() { + return windowTwo.getDisplayRowColHeadings(); + } + + /** + * Returns the array of margins. If not created, will create. + * + * @return the array of marings. + */ + protected Margin[] getMargins() { + if (margins == null) + margins = new Margin[4]; + return margins; + } } diff --git a/src/java/org/apache/poi/hssf/model/Workbook.java b/src/java/org/apache/poi/hssf/model/Workbook.java index cad91171e8..4696d8985f 100644 --- a/src/java/org/apache/poi/hssf/model/Workbook.java +++ b/src/java/org/apache/poi/hssf/model/Workbook.java @@ -513,7 +513,7 @@ public class Workbook implements Model { for (int k = 0; k < boundsheets.size(); k++) { String sheet = getSheetName(k); - if (sheet.equals(name)) { + if (sheet.equalsIgnoreCase(name)) { retval = k; break; } @@ -686,37 +686,27 @@ public class Workbook implements Model { * * @return byte array containing the HSSF-only portions of the POIFS file. */ - - public byte [] serialize() { - log.log(DEBUG, "Serializing Workbook!"); - byte[] retval = null; - - // ArrayList bytes = new ArrayList(records.size()); - int arraysize = getSize(); - int pos = 0; - - // for (int k = 0; k < records.size(); k++) - // { - // bytes.add((( Record ) records.get(k)).serialize()); - // } - // for (int k = 0; k < bytes.size(); k++) - // { - // arraysize += (( byte [] ) bytes.get(k)).length; - // } - retval = new byte[ arraysize ]; - for (int k = 0; k < records.size(); k++) { - - // byte[] rec = (( byte [] ) bytes.get(k)); - // System.arraycopy(rec, 0, retval, pos, rec.length); - Record record = records.get(k); - // Let's skip RECALCID records, as they are only use for optimization - if(record.getSid() != RecalcIdRecord.sid || ((RecalcIdRecord)record).isNeeded()) { - pos += record.serialize(pos, retval); // rec.length; - } - } - log.log(DEBUG, "Exiting serialize workbook"); - return retval; - } + // GJS: Not used so why keep it. +// public byte [] serialize() { +// log.log(DEBUG, "Serializing Workbook!"); +// byte[] retval = null; +// +//// ArrayList bytes = new ArrayList(records.size()); +// int arraysize = getSize(); +// int pos = 0; +// +// retval = new byte[ arraysize ]; +// for (int k = 0; k < records.size(); k++) { +// +// Record record = records.get(k); +//// Let's skip RECALCID records, as they are only use for optimization +// if(record.getSid() != RecalcIdRecord.sid || ((RecalcIdRecord)record).isNeeded()) { +// pos += record.serialize(pos, retval); // rec.length; +// } +// } +// log.log(DEBUG, "Exiting serialize workbook"); +// return retval; +// } /** * Serializes all records int the worksheet section into a big byte array. Use @@ -725,44 +715,54 @@ public class Workbook implements Model { * @param data array of bytes to write this to */ - public int serialize(int offset, byte [] data) { - log.log(DEBUG, "Serializing Workbook with offsets"); + public int serialize( int offset, byte[] data ) + { + log.log( DEBUG, "Serializing Workbook with offsets" ); - // ArrayList bytes = new ArrayList(records.size()); - // int arraysize = getSize(); // 0; - int pos = 0; + int pos = 0; - // for (int k = 0; k < records.size(); k++) - // { - // bytes.add((( Record ) records.get(k)).serialize()); - // - // } - // for (int k = 0; k < bytes.size(); k++) - // { - // arraysize += (( byte [] ) bytes.get(k)).length; - // } - for (int k = 0; k < records.size(); k++) { + SSTRecord sst = null; + int sstPos = 0; + for ( int k = 0; k < records.size(); k++ ) + { - // byte[] rec = (( byte [] ) bytes.get(k)); - // System.arraycopy(rec, 0, data, offset + pos, rec.length); - Record record = records.get(k); + Record record = records.get( k ); // Let's skip RECALCID records, as they are only use for optimization - if(record.getSid() != RecalcIdRecord.sid || ((RecalcIdRecord)record).isNeeded()) { - pos += record.serialize(pos + offset, data); // rec.length; + if ( record.getSid() != RecalcIdRecord.sid || ( (RecalcIdRecord) record ).isNeeded() ) + { + if (record instanceof SSTRecord) + { + sst = (SSTRecord)record; + sstPos = pos; + } + if (record.getSid() == ExtSSTRecord.sid && sst != null) + { + record = sst.createExtSSTRecord(sstPos + offset); + } + pos += record.serialize( pos + offset, data ); // rec.length; } } - log.log(DEBUG, "Exiting serialize workbook"); + log.log( DEBUG, "Exiting serialize workbook" ); return pos; } - public int getSize() { + public int getSize() + { int retval = 0; - for (int k = 0; k < records.size(); k++) { - Record record = records.get(k); + SSTRecord sst = null; + for ( int k = 0; k < records.size(); k++ ) + { + Record record = records.get( k ); // Let's skip RECALCID records, as they are only use for optimization - if(record.getSid() != RecalcIdRecord.sid || ((RecalcIdRecord)record).isNeeded()) { - retval += record.getRecordSize(); + if ( record.getSid() != RecalcIdRecord.sid || ( (RecalcIdRecord) record ).isNeeded() ) + { + if (record instanceof SSTRecord) + sst = (SSTRecord)record; + if (record.getSid() == ExtSSTRecord.sid && sst != null) + retval += sst.calcExtSSTRecordSize(); + else + retval += record.getRecordSize(); } } return retval; @@ -1729,15 +1729,17 @@ public class Workbook implements Model { } public SheetReferences getSheetReferences() { - SheetReferences refs = new SheetReferences(); - - if (externSheet != null) { - for (int k = 0; k < externSheet.getNumOfREFStructures(); k++) { - String sheetName = findSheetNameFromExternSheet((short)k); - refs.addSheetReference(sheetName, k); - } - } - return refs; + SheetReferences refs = new SheetReferences(); + + if (externSheet != null) { + for (int k = 0; k < externSheet.getNumOfREFStructures(); k++) { + + String sheetName = findSheetNameFromExternSheet((short)k); + refs.addSheetReference(sheetName, k); + + } + } + return refs; } /** finds the sheet name by his extern sheet index @@ -1745,10 +1747,12 @@ public class Workbook implements Model { * @return sheet name */ public String findSheetNameFromExternSheet(short num){ - String result; + String result=""; short indexToSheet = externSheet.getREFRecordAt(num).getIndexToFirstSupBook(); - result = getSheetName(indexToSheet); + if (indexToSheet>-1) { //error check, bail out gracefully! + result = getSheetName(indexToSheet); + } return result; } @@ -2060,18 +2064,22 @@ public class Workbook implements Model { */ public PaletteRecord getCustomPalette() { - PaletteRecord palette; - Record rec = records.get(records.getPalettepos()); - if (rec instanceof PaletteRecord) - { - palette = (PaletteRecord) rec; - } - else - { - palette = createPalette(); - records.add(records.getPalettepos(), palette); - } - return palette; + PaletteRecord palette; + int palettePos = records.getPalettepos(); + if (palettePos != -1) { + Record rec = records.get(palettePos); + if (rec instanceof PaletteRecord) { + palette = (PaletteRecord) rec; + } else throw new RuntimeException("InternalError: Expected PaletteRecord but got a '"+rec+"'"); + } + else + { + palette = createPalette(); + //Add the palette record after the bof which is always the first record + records.add(1, palette); + records.setPalettepos(1); + } + return palette; } diff --git a/src/java/org/apache/poi/hssf/model/WorkbookRecordList.java b/src/java/org/apache/poi/hssf/model/WorkbookRecordList.java index 0f2fa32540..654ea88782 100644 --- a/src/java/org/apache/poi/hssf/model/WorkbookRecordList.java +++ b/src/java/org/apache/poi/hssf/model/WorkbookRecordList.java @@ -74,7 +74,7 @@ public class WorkbookRecordList private int namepos = 0; // holds the position of last name record private int supbookpos = 0; // holds the position of sup book private int externsheetPos = 0;// holds the position of the extern sheet - private int palettepos = 0; // hold the position of the palette, if applicable + private int palettepos = -1; // hold the position of the palette, if applicable public void setRecords( List records ) @@ -103,7 +103,7 @@ public class WorkbookRecordList if (getBackuppos() >= pos) setBackuppos( backuppos + 1 ); if (getNamepos() >= pos) setNamepos(namepos+1); if (getSupbookpos() >= pos) setSupbookpos(supbookpos+1); - if (getPalettepos() >= pos) setPalettepos( palettepos + 1 ); + if ((getPalettepos() != -1) && (getPalettepos() >= pos)) setPalettepos( palettepos + 1 ); if (getExternsheetPos() >= pos) setExternsheetPos(getExternsheetPos() + 1); } @@ -128,7 +128,7 @@ public class WorkbookRecordList if (getBackuppos() >= pos) setBackuppos( backuppos - 1 ); if (getNamepos() >= pos) setNamepos(getNamepos()-1); if (getSupbookpos() >= pos) setSupbookpos(getSupbookpos()-1); - if (getPalettepos() >= pos) setPalettepos( palettepos - 1 ); + if ((getPalettepos() != -1) && (getPalettepos() >= pos)) setPalettepos( palettepos - 1 ); if (getExternsheetPos() >= pos) setExternsheetPos( getExternsheetPos() -1); } diff --git a/src/java/org/apache/poi/hssf/record/BoolErrRecord.java b/src/java/org/apache/poi/hssf/record/BoolErrRecord.java index 859748a84a..4391fc43aa 100644 --- a/src/java/org/apache/poi/hssf/record/BoolErrRecord.java +++ b/src/java/org/apache/poi/hssf/record/BoolErrRecord.java @@ -172,12 +172,18 @@ public class BoolErrRecord * set the error value for the cell * * @param value error representing the error value + * this value can only be 0,7,15,23,29,36 or 42 + * see bugzilla bug 16560 for an explanation */ public void setValue(byte value) { - field_4_bBoolErr = value; - field_5_fError = ( byte ) 1; + if ( (value==0)||(value==7)||(value==15)||(value==23)||(value==29)||(value==36)||(value==42)) { + field_4_bBoolErr = value; + field_5_fError = ( byte ) 1; + } else { + throw new RuntimeException("Error Value can only be 0,7,15,23,29,36 or 42. It cannot be "+value); + } } //public short getRow() diff --git a/src/java/org/apache/poi/hssf/record/BottomMarginRecord.java b/src/java/org/apache/poi/hssf/record/BottomMarginRecord.java index a74be0f6c9..fcab41a1f2 100644 --- a/src/java/org/apache/poi/hssf/record/BottomMarginRecord.java +++ b/src/java/org/apache/poi/hssf/record/BottomMarginRecord.java @@ -1 +1,187 @@ -/* ==================================================================== * The Apache Software License, Version 1.1 * * Copyright (c) 2003 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Apache" and "Apache Software Foundation" and * "Apache POI" must not be used to endorse or promote products * derived from this software without prior written permission. For * written permission, please contact apache@apache.org. * * 5. Products derived from this software may not be called "Apache", * "Apache POI", nor may "Apache" appear in their name, without * prior written permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . */package org.apache.poi.hssf.record;import org.apache.poi.util.*;/** * Record for the bottom margin. * NOTE: This source was automatically generated. * @author Shawn Laubach (slaubach at apache dot org) */public class BottomMarginRecord extends Record implements Margin{ public final static short sid = 0x29; private double field_1_margin; public BottomMarginRecord() { } /** * Constructs a BottomMargin record and sets its fields appropriately. * * @param id id must be 0x29 or an exception * will be throw upon validation * @param size size the size of the data area of the record * @param data data of the record (should not contain sid/len) */ public BottomMarginRecord(short id, short size, byte [] data) { super(id, size, data); } /** * Constructs a BottomMargin record and sets its fields appropriately. * * @param id id must be 0x29 or an exception * will be throw upon validation * @param size size the size of the data area of the record * @param data data of the record (should not contain sid/len) * @param offset of the record's data */ public BottomMarginRecord(short id, short size, byte [] data, int offset) { super(id, size, data, offset); } /** * Checks the sid matches the expected side for this record * * @param id the expected sid. */ protected void validateSid(short id) { if (id != sid) { throw new RecordFormatException("Not a BottomMargin record"); } } protected void fillFields(byte [] data, short size, int offset) { field_1_margin = LittleEndian.getDouble(data, 0x0 + offset); } public String toString() { StringBuffer buffer = new StringBuffer(); buffer.append("[BottomMargin]\n"); buffer.append(" .margin = ") .append(" (").append(getMargin()).append(" )\n"); buffer.append("[/BottomMargin]\n"); return buffer.toString(); } public int serialize(int offset, byte[] data) { LittleEndian.putShort(data, 0 + offset, sid); LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); LittleEndian.putDouble(data, 4 + offset, field_1_margin); return getRecordSize(); } /** * Size of record (exluding 4 byte header) */ public int getRecordSize() { return 4 + 8; } public short getSid() { return this.sid; } /** * Get the margin field for the BottomMargin record. */ public double getMargin() { return field_1_margin; } /** * Set the margin field for the BottomMargin record. */ public void setMargin(double field_1_margin) { this.field_1_margin = field_1_margin; } public Object clone() { BottomMarginRecord rec = new BottomMarginRecord(); rec.field_1_margin = this.field_1_margin; return rec; }} // END OF CLASS \ No newline at end of file +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2003 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache POI" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache POI", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + + +package org.apache.poi.hssf.record; + + + +import org.apache.poi.util.*; + +/** + * Record for the bottom margin. + * NOTE: This source was automatically generated. + * @author Shawn Laubach (slaubach at apache dot org) + */ +public class BottomMarginRecord + extends Record implements Margin +{ + public final static short sid = 0x29; + private double field_1_margin; + + + public BottomMarginRecord() + { + + } + + /** + * Constructs a BottomMargin record and sets its fields appropriately. + * + * @param id id must be 0x29 or an exception + * will be throw upon validation + * @param size size the size of the data area of the record + * @param data data of the record (should not contain sid/len) + */ + + public BottomMarginRecord(short id, short size, byte [] data) + { + super(id, size, data); + } + + /** + * Constructs a BottomMargin record and sets its fields appropriately. + * + * @param id id must be 0x29 or an exception + * will be throw upon validation + * @param size size the size of the data area of the record + * @param data data of the record (should not contain sid/len) + * @param offset of the record's data + */ + + public BottomMarginRecord(short id, short size, byte [] data, int offset) + { + super(id, size, data, offset); + } + + /** + * Checks the sid matches the expected side for this record + * + * @param id the expected sid. + */ + protected void validateSid(short id) + { + if (id != sid) + { + throw new RecordFormatException("Not a BottomMargin record"); + } + } + + protected void fillFields(byte [] data, short size, int offset) + { + field_1_margin = LittleEndian.getDouble(data, 0x0 + offset); + + } + + public String toString() + { + StringBuffer buffer = new StringBuffer(); + + buffer.append("[BottomMargin]\n"); + + buffer.append(" .margin = ") + .append(" (").append(getMargin()).append(" )\n"); + + buffer.append("[/BottomMargin]\n"); + return buffer.toString(); + } + + public int serialize(int offset, byte[] data) + { + LittleEndian.putShort(data, 0 + offset, sid); + LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); + + LittleEndian.putDouble(data, 4 + offset, field_1_margin); + + return getRecordSize(); + } + + /** + * Size of record (exluding 4 byte header) + */ + public int getRecordSize() + { + return 4 + 8; + } + + public short getSid() + { + return this.sid; + } + + + /** + * Get the margin field for the BottomMargin record. + */ + public double getMargin() + { + return field_1_margin; + } + + /** + * Set the margin field for the BottomMargin record. + */ + public void setMargin(double field_1_margin) + { + this.field_1_margin = field_1_margin; + } + + public Object clone() { + BottomMarginRecord rec = new BottomMarginRecord(); + rec.field_1_margin = this.field_1_margin; + return rec; + } + + +} // END OF CLASS \ No newline at end of file diff --git a/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java b/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java index 6e01246a65..95c5878064 100644 --- a/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java +++ b/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java @@ -194,10 +194,22 @@ public class BoundSheetRecord /** * Set the sheetname for this sheet. (this appears in the tabs at the bottom) * @param sheetname the name of the sheet + * @thows IllegalArgumentException if sheet name will cause excel to crash. */ public void setSheetname( String sheetname ) { + + if ((sheetname == null) || (sheetname.length()==0) + || (sheetname.length()>31) + || (sheetname.indexOf("/") > -1) + || (sheetname.indexOf("\\") > -1) + || (sheetname.indexOf("?") > -1) + || (sheetname.indexOf("*") > -1) + || (sheetname.indexOf("]") > -1) + || (sheetname.indexOf("[") > -1) ){ + throw new IllegalArgumentException("Sheet name cannot be blank, greater than 31 chars, or contain any of /\\*?[]"); + } field_5_sheetname = sheetname; } diff --git a/src/java/org/apache/poi/hssf/record/ContinueRecord.java b/src/java/org/apache/poi/hssf/record/ContinueRecord.java index dbe00e52eb..8d7eee7f72 100644 --- a/src/java/org/apache/poi/hssf/record/ContinueRecord.java +++ b/src/java/org/apache/poi/hssf/record/ContinueRecord.java @@ -267,4 +267,14 @@ public class ContinueRecord protected void fillFields(byte [] ignored_parm1, short ignored_parm2, int ignored_parm3) { } + + /** + * Clone this record. + */ + public Object clone() { + ContinueRecord clone = new ContinueRecord(); + clone.setData(field_1_data); + return clone; + } + } diff --git a/src/java/org/apache/poi/hssf/record/ExtSSTInfoSubRecord.java b/src/java/org/apache/poi/hssf/record/ExtSSTInfoSubRecord.java index e80c8affdf..d98f466aff 100644 --- a/src/java/org/apache/poi/hssf/record/ExtSSTInfoSubRecord.java +++ b/src/java/org/apache/poi/hssf/record/ExtSSTInfoSubRecord.java @@ -65,7 +65,6 @@ import org.apache.poi.util.LittleEndian; /** * Extended SST table info subrecord

    * contains the elements of "info" in the SST's array field

    - * WE HAVE VERY LITTLE INFORMATION ON HOW TO IMPLEMENT THIS RECORD! (EXTSSST)

    * @author Andrew C. Oliver (acoliver at apache dot org) * @version 2.0-pre * @see org.apache.poi.hssf.record.ExtSSTRecord @@ -74,6 +73,7 @@ import org.apache.poi.util.LittleEndian; public class ExtSSTInfoSubRecord extends Record { + public static final int INFO_SIZE = 8; public final static short sid = 0xFFF; // only here for conformance, doesn't really have an sid private int field_1_stream_pos; // stream pointer to the SST record @@ -114,7 +114,7 @@ public class ExtSSTInfoSubRecord field_1_stream_pos = pos; } - public void setBucketSSTOffset(short offset) + public void setBucketRecordOffset(short offset) { field_2_bucket_sst_offset = offset; } @@ -159,6 +159,6 @@ public class ExtSSTInfoSubRecord public short getSid() { - return this.sid; + return sid; } } diff --git a/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java b/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java index 7a8e2391e9..9a85e5966d 100644 --- a/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java +++ b/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java @@ -61,13 +61,13 @@ import java.util.ArrayList; /** * Title: Extended Static String Table

    - * Description: I really don't understand this thing... its supposed to be "a hash - * table for optimizing external copy operations" -- - *

    - * This sounds like a job for Marc "BitMaster" Johnson aka the - * "Hawaiian Master Chef".

    + * Description: This record is used for a quick lookup into the SST record. This + * record breaks the SST table into a set of buckets. The offsets + * to these buckets within the SST record are kept as well as the + * position relative to the start of the SST record. * REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

    * @author Andrew C. Oliver (acoliver at apache dot org) + * @author Jason Height (jheight at apache dot org) * @version 2.0-pre * @see org.apache.poi.hssf.record.ExtSSTInfoSubRecord */ @@ -75,10 +75,15 @@ import java.util.ArrayList; public class ExtSSTRecord extends Record { + public static final int DEFAULT_BUCKET_SIZE = 8; + //Cant seem to find this documented but from the biffviewer it is clear that + //Excel only records the indexes for the first 128 buckets. + public static final int MAX_BUCKETS = 128; public final static short sid = 0xff; - private short field_1_strings_per_bucket; + private short field_1_strings_per_bucket = DEFAULT_BUCKET_SIZE; private ArrayList field_2_sst_info; + public ExtSSTRecord() { field_2_sst_info = new ArrayList(); @@ -119,12 +124,11 @@ public class ExtSSTRecord } } - // this probably doesn't work but we don't really care at this point protected void fillFields(byte [] data, short size, int offset) { field_2_sst_info = new ArrayList(); field_1_strings_per_bucket = LittleEndian.getShort(data, 0 + offset); - for (int k = 2; k < ((data.length - offset) - size); k += 8) + for (int k = 2; k < (size-offset); k += 8) { byte[] tempdata = new byte[ 8 + offset ]; @@ -189,26 +193,55 @@ public class ExtSSTRecord public int serialize(int offset, byte [] data) { LittleEndian.putShort(data, 0 + offset, sid); - -// LittleEndian.putShort(data,2,(short)(2 + (getNumInfoRecords() *8))); - LittleEndian.putShort(data, 2 + offset, ( short ) (2 + (0x3fa - 2))); - int pos = 4; + LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); + LittleEndian.putShort(data, 4 + offset, field_1_strings_per_bucket); + int pos = 6; for (int k = 0; k < getNumInfoRecords(); k++) { - System.arraycopy(getInfoRecordAt(k).serialize(), 0, data, - pos + offset, 8); + ExtSSTInfoSubRecord rec = getInfoRecordAt(k); + pos += rec.serialize(pos + offset, data); } - return getRecordSize(); + return pos; } + /** Returns the size of this record */ public int getRecordSize() { - return 6 + 0x3fa - 2; + return 6 + 8*getNumInfoRecords(); + } + + public static final int getNumberOfInfoRecsForStrings(int numStrings) { + int infoRecs = (numStrings / DEFAULT_BUCKET_SIZE); + if ((numStrings % DEFAULT_BUCKET_SIZE) != 0) + infoRecs ++; + //Excel seems to max out after 128 info records. + //This isnt really documented anywhere... + if (infoRecs > MAX_BUCKETS) + infoRecs = MAX_BUCKETS; + return infoRecs; + } + + /** Given a number of strings (in the sst), returns the size of the extsst record*/ + public static final int getRecordSizeForStrings(int numStrings) { + return 4 + 2 + (getNumberOfInfoRecsForStrings(numStrings) * 8); } public short getSid() { - return this.sid; + return sid; } + + public void setBucketOffsets( int[] bucketAbsoluteOffsets, int[] bucketRelativeOffsets ) + { + this.field_2_sst_info = new ArrayList(bucketAbsoluteOffsets.length); + for ( int i = 0; i < bucketAbsoluteOffsets.length; i++ ) + { + ExtSSTInfoSubRecord r = new ExtSSTInfoSubRecord(); + r.setBucketRecordOffset((short)bucketRelativeOffsets[i]); + r.setStreamPos(bucketAbsoluteOffsets[i]); + field_2_sst_info.add(r); + } + } + } diff --git a/src/java/org/apache/poi/hssf/record/ExternSheetRecord.java b/src/java/org/apache/poi/hssf/record/ExternSheetRecord.java index 761d400522..048fb443ff 100644 --- a/src/java/org/apache/poi/hssf/record/ExternSheetRecord.java +++ b/src/java/org/apache/poi/hssf/record/ExternSheetRecord.java @@ -1 +1,230 @@ -/* ==================================================================== * The Apache Software License, Version 1.1 * * Copyright (c) 2003 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Apache" and "Apache Software Foundation" and * "Apache POI" must not be used to endorse or promote products * derived from this software without prior written permission. For * written permission, please contact apache@apache.org. * * 5. Products derived from this software may not be called "Apache", * "Apache POI", nor may "Apache" appear in their name, without * prior written permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . */package org.apache.poi.hssf.record;import org.apache.poi.util.LittleEndian;import java.util.ArrayList;/** * Title: Extern Sheet

    * Description: A List of Inndexes to SupBook

    * REFERENCE:

    * @author Libin Roman (Vista Portal LDT. Developer) * @version 1.0-pre */public class ExternSheetRecord extends Record { public final static short sid = 0x17; private short field_1_number_of_REF_sturcutres; private ArrayList field_2_REF_structures; public ExternSheetRecord() { field_2_REF_structures = new ArrayList(); } /** * Constructs a Extern Sheet record and sets its fields appropriately. * * @param id id must be 0x16 or an exception will be throw upon validation * @param size the size of the data area of the record * @param data data of the record (should not contain sid/len) */ public ExternSheetRecord(short id, short size, byte[] data) { super(id, size, data); } /** * Constructs a Extern Sheet record and sets its fields appropriately. * * @param id id must be 0x16 or an exception will be throw upon validation * @param size the size of the data area of the record * @param data data of the record (should not contain sid/len) * @param offset of the record's data */ public ExternSheetRecord(short id, short size, byte[] data, int offset) { super(id, size, data, offset); } /** * called by constructor, should throw runtime exception in the event of a * record passed with a differing ID. * * @param id alleged id for this record */ protected void validateSid(short id) { if (id != sid) { throw new RecordFormatException("NOT An ExternSheet RECORD"); } } /** * called by the constructor, should set class level fields. Should throw * runtime exception for bad/icomplete data. * * @param data raw data * @param size size of data * @param offset of the record's data (provided a big array of the file) */ protected void fillFields(byte [] data, short size, int offset) { field_2_REF_structures = new ArrayList(); field_1_number_of_REF_sturcutres = LittleEndian.getShort(data, 0 + offset); int pos = 2 + offset; for (int i = 0 ; i < field_1_number_of_REF_sturcutres ; ++i) { ExternSheetSubRecord rec = new ExternSheetSubRecord((short)0, (short)6 , data , pos); pos += 6; field_2_REF_structures.add( rec); } } /** * sets the number of the REF structors , that is in Excel file * @param numStruct number of REF structs */ public void setNumOfREFStructures(short numStruct) { field_1_number_of_REF_sturcutres = numStruct; } /** * return the number of the REF structors , that is in Excel file * @return number of REF structs */ public short getNumOfREFStructures() { return field_1_number_of_REF_sturcutres; } /** * adds REF struct (ExternSheetSubRecord) * @param rec REF struct */ public void addREFRecord(ExternSheetSubRecord rec) { field_2_REF_structures.add(rec); } /** returns the number of REF Records, which is in model * @return number of REF records */ public int getNumOfREFRecords() { return field_2_REF_structures.size(); } /** returns the REF record (ExternSheetSubRecord) * @param elem index to place * @return REF record */ public ExternSheetSubRecord getREFRecordAt(int elem) { ExternSheetSubRecord result = ( ExternSheetSubRecord ) field_2_REF_structures.get(elem); return result; } public String toString() { StringBuffer buffer = new StringBuffer(); buffer.append("[EXTERNSHEET]\n"); buffer.append(" numOfRefs = ").append(getNumOfREFStructures()).append("\n"); for (int k=0; k < this.getNumOfREFRecords(); k++) { buffer.append("refrec #").append(k).append('\n'); buffer.append(getREFRecordAt(k).toString()); buffer.append("----refrec #").append(k).append('\n'); } buffer.append("[/EXTERNSHEET]\n"); return buffer.toString(); } /** * called by the class that is responsible for writing this sucker. * Subclasses should implement this so that their data is passed back in a * byte array. * * @param offset to begin writing at * @param data byte array containing instance data * @return number of bytes written */ public int serialize(int offset, byte [] data) { LittleEndian.putShort(data, 0 + offset, sid); LittleEndian.putShort(data, 2 + offset,(short)(2 + (getNumOfREFRecords() *6))); LittleEndian.putShort(data, 4 + offset, getNumOfREFStructures()); int pos = 6 ; for (int k = 0; k < getNumOfREFRecords(); k++) { ExternSheetSubRecord record = getREFRecordAt(k); System.arraycopy(record.serialize(), 0, data, pos + offset, 6); pos +=6; } return getRecordSize(); } public int getRecordSize() { return 4 + 2 + getNumOfREFRecords() * 6; } /** * return the non static version of the id for this record. */ public short getSid() { return this.sid; }} \ No newline at end of file +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2002 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache POI" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache POI", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + +package org.apache.poi.hssf.record; + +import org.apache.poi.util.LittleEndian; + +import java.util.ArrayList; + +/** + * Title: Extern Sheet

    + * Description: A List of Inndexes to SupBook

    + * REFERENCE:

    + * @author Libin Roman (Vista Portal LDT. Developer) + * @version 1.0-pre + */ + +public class ExternSheetRecord extends Record { + public final static short sid = 0x17; + private short field_1_number_of_REF_sturcutres; + private ArrayList field_2_REF_structures; + + public ExternSheetRecord() { + field_2_REF_structures = new ArrayList(); + } + + /** + * Constructs a Extern Sheet record and sets its fields appropriately. + * + * @param id id must be 0x16 or an exception will be throw upon validation + * @param size the size of the data area of the record + * @param data data of the record (should not contain sid/len) + */ + + public ExternSheetRecord(short id, short size, byte[] data) { + super(id, size, data); + } + + /** + * Constructs a Extern Sheet record and sets its fields appropriately. + * + * @param id id must be 0x16 or an exception will be throw upon validation + * @param size the size of the data area of the record + * @param data data of the record (should not contain sid/len) + * @param offset of the record's data + */ + public ExternSheetRecord(short id, short size, byte[] data, int offset) { + super(id, size, data, offset); + } + + /** + * called by constructor, should throw runtime exception in the event of a + * record passed with a differing ID. + * + * @param id alleged id for this record + */ + protected void validateSid(short id) { + if (id != sid) { + throw new RecordFormatException("NOT An ExternSheet RECORD"); + } + } + + /** + * called by the constructor, should set class level fields. Should throw + * runtime exception for bad/icomplete data. + * + * @param data raw data + * @param size size of data + * @param offset of the record's data (provided a big array of the file) + */ + protected void fillFields(byte [] data, short size, int offset) { + field_2_REF_structures = new ArrayList(); + + field_1_number_of_REF_sturcutres = LittleEndian.getShort(data, 0 + offset); + + int pos = 2 + offset; + for (int i = 0 ; i < field_1_number_of_REF_sturcutres ; ++i) { + ExternSheetSubRecord rec = new ExternSheetSubRecord((short)0, (short)6 , data , pos); + + pos += 6; + + field_2_REF_structures.add( rec); + } + } + + /** + * sets the number of the REF structors , that is in Excel file + * @param numStruct number of REF structs + */ + public void setNumOfREFStructures(short numStruct) { + field_1_number_of_REF_sturcutres = numStruct; + } + + /** + * return the number of the REF structors , that is in Excel file + * @return number of REF structs + */ + public short getNumOfREFStructures() { + return field_1_number_of_REF_sturcutres; + } + + /** + * adds REF struct (ExternSheetSubRecord) + * @param rec REF struct + */ + public void addREFRecord(ExternSheetSubRecord rec) { + field_2_REF_structures.add(rec); + } + + /** returns the number of REF Records, which is in model + * @return number of REF records + */ + public int getNumOfREFRecords() { + return field_2_REF_structures.size(); + } + + /** returns the REF record (ExternSheetSubRecord) + * @param elem index to place + * @return REF record + */ + public ExternSheetSubRecord getREFRecordAt(int elem) { + ExternSheetSubRecord result = ( ExternSheetSubRecord ) field_2_REF_structures.get(elem); + + return result; + } + + public String toString() { + StringBuffer buffer = new StringBuffer(); + + buffer.append("[EXTERNSHEET]\n"); + buffer.append(" numOfRefs = ").append(getNumOfREFStructures()).append("\n"); + for (int k=0; k < this.getNumOfREFRecords(); k++) { + buffer.append("refrec #").append(k).append('\n'); + buffer.append(getREFRecordAt(k).toString()); + buffer.append("----refrec #").append(k).append('\n'); + } + buffer.append("[/EXTERNSHEET]\n"); + + + return buffer.toString(); + } + + /** + * called by the class that is responsible for writing this sucker. + * Subclasses should implement this so that their data is passed back in a + * byte array. + * + * @param offset to begin writing at + * @param data byte array containing instance data + * @return number of bytes written + */ + public int serialize(int offset, byte [] data) { + LittleEndian.putShort(data, 0 + offset, sid); + LittleEndian.putShort(data, 2 + offset,(short)(2 + (getNumOfREFRecords() *6))); + + LittleEndian.putShort(data, 4 + offset, getNumOfREFStructures()); + + int pos = 6 ; + + for (int k = 0; k < getNumOfREFRecords(); k++) { + ExternSheetSubRecord record = getREFRecordAt(k); + System.arraycopy(record.serialize(), 0, data, pos + offset, 6); + + pos +=6; + } + return getRecordSize(); + } + + public int getRecordSize() { + return 4 + 2 + getNumOfREFRecords() * 6; + } + + /** + * return the non static version of the id for this record. + */ + public short getSid() { + return this.sid; + } +} diff --git a/src/java/org/apache/poi/hssf/record/FormulaRecord.java b/src/java/org/apache/poi/hssf/record/FormulaRecord.java index ad926be474..050558739b 100644 --- a/src/java/org/apache/poi/hssf/record/FormulaRecord.java +++ b/src/java/org/apache/poi/hssf/record/FormulaRecord.java @@ -557,8 +557,13 @@ public class FormulaRecord .append("\n"); buffer.append(" .xf = ") .append(Integer.toHexString(getXFIndex())).append("\n"); - buffer.append(" .value = ").append(getValue()) - .append("\n"); + if (Double.isNaN(this.getValue()) && value_data != null) + buffer.append(" .value (NaN) = ") + .append(org.apache.poi.util.HexDump.dump(value_data,0,0)) + .append("\n"); + else + buffer.append(" .value = ").append(getValue()) + .append("\n"); buffer.append(" .options = ").append(getOptions()) .append("\n"); buffer.append(" .zero = ").append(field_6_zero) @@ -607,9 +612,10 @@ public class FormulaRecord if (field_8_parsed_expr != null) size = field_8_parsed_expr.size(); for (int i=0; i< size; i++) { - Ptg ptg = (Ptg)((Ptg)field_8_parsed_expr.get(i)).clone(); - rec.field_8_parsed_expr.set(i, ptg); + Ptg ptg = (Ptg)((Ptg)field_8_parsed_expr.get(i)).clone(); + rec.field_8_parsed_expr.add(i, ptg); } + rec.value_data = value_data; rec.all_data = all_data; return rec; } diff --git a/src/java/org/apache/poi/hssf/record/LabelRecord.java b/src/java/org/apache/poi/hssf/record/LabelRecord.java index 558584ba95..8755a062ab 100644 --- a/src/java/org/apache/poi/hssf/record/LabelRecord.java +++ b/src/java/org/apache/poi/hssf/record/LabelRecord.java @@ -150,15 +150,16 @@ public class LabelRecord field_3_xf_index = LittleEndian.getShort(data, 4 + offset); field_4_string_len = LittleEndian.getShort(data, 6 + offset); field_5_unicode_flag = data[ 8 + offset ]; - if (isUnCompressedUnicode()) - { - field_6_value = StringUtil.getFromUnicode(data, 8 + offset, + if (field_4_string_len > 0) { + if (isUnCompressedUnicode()) { + field_6_value = StringUtil.getFromUnicode(data, 9 + offset, field_4_string_len); } - else - { - field_6_value = StringUtil.getFromCompressedUnicode(data, 9 + offset, getStringLength()); + else { + field_6_value = StringUtil.getFromCompressedUnicode(data, 9 + offset, + getStringLength()); } + } else field_6_value = null; } /* READ ONLY ACCESS... THIS IS FOR COMPATIBILITY ONLY...USE LABELSST! @@ -237,6 +238,27 @@ public class LabelRecord return this.sid; } + public String toString() + { + StringBuffer buffer = new StringBuffer(); + buffer.append("[LABEL]\n"); + buffer.append(" .row = ") + .append(Integer.toHexString(getRow())).append("\n"); + buffer.append(" .column = ") + .append(Integer.toHexString(getColumn())).append("\n"); + buffer.append(" .xfindex = ") + .append(Integer.toHexString(getXFIndex())).append("\n"); + buffer.append(" .string_len = ") + .append(Integer.toHexString(field_4_string_len)).append("\n"); + buffer.append(" .unicode_flag = ") + .append(Integer.toHexString(field_5_unicode_flag)).append("\n"); + buffer.append(" .value = ") + .append(getValue()).append("\n"); + buffer.append("[/LABEL]\n"); + return buffer.toString(); + } + + public boolean isBefore(CellValueRecordInterface i) { if (this.getRow() > i.getRow()) diff --git a/src/java/org/apache/poi/hssf/record/NameRecord.java b/src/java/org/apache/poi/hssf/record/NameRecord.java index 09bf2a416d..b91c829b87 100644 --- a/src/java/org/apache/poi/hssf/record/NameRecord.java +++ b/src/java/org/apache/poi/hssf/record/NameRecord.java @@ -58,11 +58,11 @@ package org.apache.poi.hssf.record; import java.util.List; import java.util.Stack; +import org.apache.poi.hssf.model.Workbook; import org.apache.poi.hssf.record.formula.Area3DPtg; import org.apache.poi.hssf.record.formula.Ptg; import org.apache.poi.hssf.record.formula.Ref3DPtg; import org.apache.poi.hssf.util.RangeAddress; -import org.apache.poi.hssf.util.SheetReferences; import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndian; import org.apache.poi.util.StringUtil; @@ -127,6 +127,14 @@ public class NameRecord extends Record { */ public final static byte BUILTIN_SHEET_TITLE = (byte)12; + public static final short OPT_HIDDEN_NAME = (short) 0x0001; + public static final short OPT_FUNCTION_NAME = (short) 0x0002; + public static final short OPT_COMMAND_NAME = (short) 0x0004; + public static final short OPT_MACRO = (short) 0x0008; + public static final short OPT_COMPLEX = (short) 0x0010; + public static final short OPT_BUILTIN = (short) 0x0020; + public static final short OPT_BINDATA = (short) 0x1000; + private short field_1_option_flag; private byte field_2_keyboard_shortcut; @@ -192,7 +200,7 @@ public class NameRecord extends Record { { this(); this.field_12_builtIn_name = builtin; - this.setOptionFlag((short)(this.getOptionFlag() | (short)0x20)); + this.setOptionFlag((short)(this.getOptionFlag() | OPT_BUILTIN)); this.setNameTextLength((byte)1); this.setEqualsToIndexToSheet(index); //the extern sheets are set through references @@ -252,13 +260,22 @@ public class NameRecord extends Record { /** * Convenience method to retrieve the index the name refers to. - * @see getEqualsToIndexToSheet() + * @see #getEqualsToIndexToSheet() * @return short */ public short getIndexToSheet() { return getEqualsToIndexToSheet(); } + /** + * @return function group + * @see FnGroupCountRecord + */ + public byte getFnGroup() { + int masked = field_1_option_flag & 0x0fc0; + return (byte) (masked >> 4); + } + public void setEqualsToIndexToSheet(short value) { field_6_equals_to_index_to_sheet = value; @@ -409,11 +426,47 @@ public class NameRecord extends Record { return field_11_compressed_unicode_flag; } + /** + * @return true if name is hidden + */ + public boolean isHiddenName() { + return (field_1_option_flag & OPT_HIDDEN_NAME) != 0; + } + + /** + * @return true if name is a function + */ + public boolean isFunctionName() { + return (field_1_option_flag & OPT_FUNCTION_NAME) != 0; + } + + /** + * @return true if name is a command + */ + public boolean isCommandName() { + return (field_1_option_flag & OPT_COMMAND_NAME) != 0; + } + + /** + * @return true if function macro or command macro + */ + public boolean isMacro() { + return (field_1_option_flag & OPT_MACRO) != 0; + } + + /** + * @return true if array formula or user defined + */ + public boolean isComplexFunction() { + return (field_1_option_flag & OPT_COMPLEX) != 0; + } + + /**Convenience Function to determine if the name is a built-in name */ public boolean isBuiltInName() { - return ((this.getOptionFlag() & (short)0x20) != 0); + return ((this.getOptionFlag() & OPT_BUILTIN) != 0); } @@ -511,7 +564,7 @@ public class NameRecord extends Record { data[18 + offset] = getCompressedUnicodeFlag(); /* temp: gjs - if ( ( field_1_option_flag & (short) 0x20 ) != 0 ) + if (isBuiltInName()) { LittleEndian.putShort( data, 2 + offset, (short) ( 16 + field_13_raw_name_definition.length ) ); @@ -647,16 +700,16 @@ public class NameRecord extends Record { /** gets the reference , the area only (range) * @return area reference */ - public String getAreaReference(SheetReferences refs){ + public String getAreaReference(Workbook book){ if (field_13_name_definition == null) return "#REF!"; Ptg ptg = (Ptg) field_13_name_definition.peek(); String result = ""; if (ptg.getClass() == Area3DPtg.class){ - result = ptg.toFormulaString(refs); + result = ptg.toFormulaString(book); } else if (ptg.getClass() == Ref3DPtg.class){ - result = ptg.toFormulaString(refs); + result = ptg.toFormulaString(book); } return result; @@ -727,7 +780,7 @@ public class NameRecord extends Record { /* temp: gjs - if ( ( field_1_option_flag & (short)0x20 ) != 0 ) { + if (isBuiltInName()) { // DEBUG // System.out.println( "Built-in name" ); @@ -794,6 +847,8 @@ public class NameRecord extends Record { pos += ptg.getSize(); sizeCounter += ptg.getSize(); stack.push(ptg); + field_13_raw_name_definition=new byte[size]; + System.arraycopy(data,offset,field_13_raw_name_definition,0,size); } } catch (java.lang.UnsupportedOperationException uoe) { System.err.println("[WARNING] Unknown Ptg " @@ -880,7 +935,7 @@ public class NameRecord extends Record { .append("\n"); buffer.append(" .unused = ").append( field_5_index_to_sheet ) .append("\n"); - buffer.append(" .( 0 = Global name, otherwise index to sheet (one-based) ) = ").append( field_6_equals_to_index_to_sheet ) + buffer.append(" .index to sheet (1-based, 0=Global) = ").append( field_6_equals_to_index_to_sheet ) .append("\n"); buffer.append(" .Length of menu text (character count) = ").append( field_7_length_custom_menu ) .append("\n"); @@ -906,6 +961,7 @@ public class NameRecord extends Record { .append("\n"); buffer.append(" .Status bar text (Unicode string without length field) = ").append( field_17_status_bar_text ) .append("\n"); + buffer.append(org.apache.poi.util.HexDump.dump(this.field_13_raw_name_definition,0,0)); buffer.append("[/NAME]\n"); return buffer.toString(); diff --git a/src/java/org/apache/poi/hssf/record/PasswordRecord.java b/src/java/org/apache/poi/hssf/record/PasswordRecord.java index 9feb6a2cbd..ba9cbfc5f0 100644 --- a/src/java/org/apache/poi/hssf/record/PasswordRecord.java +++ b/src/java/org/apache/poi/hssf/record/PasswordRecord.java @@ -166,4 +166,14 @@ public class PasswordRecord { return this.sid; } + + /** + * Clone this record. + */ + public Object clone() { + PasswordRecord clone = new PasswordRecord(); + clone.setPassword(field_1_password); + return clone; + } + } diff --git a/src/java/org/apache/poi/hssf/record/ProtectRecord.java b/src/java/org/apache/poi/hssf/record/ProtectRecord.java index 66978f9bf4..a633756d51 100644 --- a/src/java/org/apache/poi/hssf/record/ProtectRecord.java +++ b/src/java/org/apache/poi/hssf/record/ProtectRecord.java @@ -139,9 +139,9 @@ public class ProtectRecord * @return whether to protect the sheet or not */ - public short getProtect() + public boolean getProtect() { - return field_1_protect; + return (field_1_protect == 1); } public String toString() @@ -149,8 +149,8 @@ public class ProtectRecord StringBuffer buffer = new StringBuffer(); buffer.append("[PROTECT]\n"); - buffer.append(" .protected = ") - .append(Integer.toHexString(getProtect())).append("\n"); + buffer.append(" .protect = ").append(getProtect()) + .append("\n"); buffer.append("[/PROTECT]\n"); return buffer.toString(); } @@ -160,7 +160,7 @@ public class ProtectRecord LittleEndian.putShort(data, 0 + offset, sid); LittleEndian.putShort(data, 2 + offset, (( short ) 0x02)); // 2 bytes (6 total) - LittleEndian.putShort(data, 4 + offset, getProtect()); + LittleEndian.putShort(data, 4 + offset, field_1_protect); return getRecordSize(); } diff --git a/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java b/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java index e385a4adfc..be64938126 100644 --- a/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java +++ b/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java @@ -139,18 +139,18 @@ public class ProtectionRev4Record * @return whether to protect the workbook or not */ - public short getProtect() - { - return field_1_protect; - } + public boolean getProtect() + { + return (field_1_protect == 1); + } public String toString() { StringBuffer buffer = new StringBuffer(); buffer.append("[PROT4REV]\n"); - buffer.append(" .rowheight = ") - .append(Integer.toHexString(getProtect())).append("\n"); + buffer.append(" .protect = ").append(getProtect()) + .append("\n"); buffer.append("[/PROT4REV]\n"); return buffer.toString(); } @@ -160,7 +160,7 @@ public class ProtectionRev4Record LittleEndian.putShort(data, 0 + offset, sid); LittleEndian.putShort(data, 2 + offset, (( short ) 0x02)); // 2 bytes (6 total) - LittleEndian.putShort(data, 4 + offset, getProtect()); + LittleEndian.putShort(data, 4 + offset, field_1_protect); return getRecordSize(); } diff --git a/src/java/org/apache/poi/hssf/record/Record.java b/src/java/org/apache/poi/hssf/record/Record.java index 7783026054..bd4e73789f 100644 --- a/src/java/org/apache/poi/hssf/record/Record.java +++ b/src/java/org/apache/poi/hssf/record/Record.java @@ -70,16 +70,6 @@ package org.apache.poi.hssf.record; public abstract class Record { - /** - * The static ID, subclasses should override this value with the id for the - * record type they handle. - */ - - public short sid = 0; - private short id = 0; - private short size = 0; - private byte[] data = null; - /** * instantiates a blank record strictly for ID matching */ @@ -98,9 +88,6 @@ public abstract class Record public Record(short id, short size, byte [] data) { - this.id = id; - this.size = size; - this.data = data; validateSid(id); fillFields(data, size); } @@ -115,9 +102,6 @@ public abstract class Record public Record(short id, short size, byte [] data, int offset) { - this.id = id; - this.size = size; - this.data = data; validateSid(id); fillFields(data, size, offset); } diff --git a/src/java/org/apache/poi/hssf/record/RecordProcessor.java b/src/java/org/apache/poi/hssf/record/RecordProcessor.java index c8d659c259..ba86f678f8 100644 --- a/src/java/org/apache/poi/hssf/record/RecordProcessor.java +++ b/src/java/org/apache/poi/hssf/record/RecordProcessor.java @@ -156,5 +156,10 @@ class RecordProcessor recordOffset += amount; available -= amount; } + + public int getRecordOffset() + { + return recordOffset; + } } diff --git a/src/java/org/apache/poi/hssf/record/SSTDeserializer.java b/src/java/org/apache/poi/hssf/record/SSTDeserializer.java index dcf4e50b93..40fd4b02e2 100644 --- a/src/java/org/apache/poi/hssf/record/SSTDeserializer.java +++ b/src/java/org/apache/poi/hssf/record/SSTDeserializer.java @@ -62,13 +62,14 @@ import org.apache.poi.util.LittleEndianConsts; * Handles the task of deserializing a SST string. The two main entry points are * * @author Glen Stampoultzis (glens at apache.org) + * @author Jason Height (jheight at apache.org) */ class SSTDeserializer { private BinaryTree strings; - /** this is the number of characters we expect in the first sub-record in a subsequent continuation record */ - private int continuationExpectedChars; + /** this is the number of characters that have been read prior to the continuation */ + private int continuationReadChars; /** this is the string we were working on before hitting the end of the current record. This string is NOT finished. */ private String unfinishedString; /** this is true if the string uses wide characters */ @@ -82,6 +83,7 @@ class SSTDeserializer /** Number of characters in current string */ private int charCount; private int extensionLength; + private int continueSkipBytes = 0; public SSTDeserializer( BinaryTree strings ) @@ -93,13 +95,14 @@ class SSTDeserializer private void initVars() { runCount = 0; - continuationExpectedChars = 0; + continuationReadChars = 0; unfinishedString = ""; // bytesInCurrentSegment = 0; // stringDataOffset = 0; wideChar = false; richText = false; extendedText = false; + continueSkipBytes = 0; } /** @@ -107,14 +110,15 @@ class SSTDeserializer * strings may span across multiple continuations. Read the SST record * carefully before beginning to hack. */ - public void manufactureStrings( final byte[] data, final int initialOffset, short dataSize ) + public void manufactureStrings( final byte[] data, final int initialOffset) { initVars(); int offset = initialOffset; - while ( ( offset - initialOffset ) < dataSize ) + final int dataSize = data.length; + while ( offset < dataSize ) { - int remaining = dataSize - offset + initialOffset; + int remaining = dataSize - offset; if ( ( remaining > 0 ) && ( remaining < LittleEndianConsts.SHORT_SIZE ) ) { @@ -122,26 +126,31 @@ class SSTDeserializer } if ( remaining == LittleEndianConsts.SHORT_SIZE ) { - setContinuationExpectedChars( LittleEndian.getUShort( data, offset ) ); + //JMH Dont know about this + setContinuationCharsRead( 0 );//LittleEndian.getUShort( data, offset ) ); unfinishedString = ""; break; } charCount = LittleEndian.getUShort( data, offset ); + int charsRead = charCount; readStringHeader( data, offset ); boolean stringContinuesOverContinuation = remaining < totalStringSize(); if ( stringContinuesOverContinuation ) { - int remainingBytes = ( initialOffset + dataSize ) - offset - stringHeaderOverhead(); - setContinuationExpectedChars( charCount - calculateCharCount( remainingBytes ) ); - charCount -= getContinuationExpectedChars(); + int remainingBytes = dataSize - offset - stringHeaderOverhead(); + //Only read the size of the string or whatever is left before the + //continuation + charsRead = Math.min(charsRead, calculateCharCount( remainingBytes )); + setContinuationCharsRead( charsRead ); + if (charsRead == charCount) { + //Since all of the characters will have been read, but the entire string (including formatting runs etc) + //hasnt, Compute the number of bytes to skip when the continue record starts + continueSkipBytes = offsetForContinuedRecord(0) - (remainingBytes - calculateByteCount(charsRead)); + } } - else - { - setContinuationExpectedChars( 0 ); - } - processString( data, offset, charCount ); + processString( data, offset, charsRead ); offset += totalStringSize(); - if ( getContinuationExpectedChars() != 0 ) + if ( stringContinuesOverContinuation ) { break; } @@ -222,6 +231,7 @@ class SSTDeserializer UnicodeString string = new UnicodeString( UnicodeString.sid, (short) unicodeStringBuffer.length, unicodeStringBuffer ); + setContinuationCharsRead( calculateCharCount(bytesRead)); if ( isStringFinished() ) { @@ -238,7 +248,7 @@ class SSTDeserializer private boolean isStringFinished() { - return getContinuationExpectedChars() == 0; + return getContinuationCharsRead() == charCount; } /** @@ -301,8 +311,9 @@ class SSTDeserializer { if ( isStringFinished() ) { + final int offset = continueSkipBytes; initVars(); - manufactureStrings( record, 0, (short) record.length ); + manufactureStrings( record, offset); } else { @@ -330,13 +341,12 @@ class SSTDeserializer */ private void readStringRemainder( final byte[] record ) { - int stringRemainderSizeInBytes = calculateByteCount( getContinuationExpectedChars() ); -// stringDataOffset = LittleEndianConsts.BYTE_SIZE; + int stringRemainderSizeInBytes = calculateByteCount( charCount-getContinuationCharsRead() ); byte[] unicodeStringData = new byte[SSTRecord.STRING_MINIMAL_OVERHEAD - + calculateByteCount( getContinuationExpectedChars() )]; + + stringRemainderSizeInBytes]; // write the string length - LittleEndian.putShort( unicodeStringData, 0, (short) getContinuationExpectedChars() ); + LittleEndian.putShort( unicodeStringData, 0, (short) (charCount-getContinuationCharsRead()) ); // write the options flag unicodeStringData[LittleEndianConsts.SHORT_SIZE] = createOptionByte( wideChar, richText, extendedText ); @@ -345,7 +355,7 @@ class SSTDeserializer // past all the overhead of the str_data array arraycopy( record, LittleEndianConsts.BYTE_SIZE, unicodeStringData, SSTRecord.STRING_MINIMAL_OVERHEAD, - unicodeStringData.length - SSTRecord.STRING_MINIMAL_OVERHEAD ); + stringRemainderSizeInBytes ); // use special constructor to create the final string UnicodeString string = new UnicodeString( UnicodeString.sid, @@ -356,7 +366,7 @@ class SSTDeserializer addToStringTable( strings, integer, string ); int newOffset = offsetForContinuedRecord( stringRemainderSizeInBytes ); - manufactureStrings( record, newOffset, (short) ( record.length - newOffset ) ); + manufactureStrings( record, newOffset); } /** @@ -388,8 +398,12 @@ class SSTDeserializer private int offsetForContinuedRecord( int stringRemainderSizeInBytes ) { - return stringRemainderSizeInBytes + LittleEndianConsts.BYTE_SIZE - + runCount * LittleEndianConsts.INT_SIZE + extensionLength; + int offset = stringRemainderSizeInBytes + runCount * LittleEndianConsts.INT_SIZE + extensionLength; + if (stringRemainderSizeInBytes != 0) + //If a portion of the string remains then the wideChar options byte is repeated, + //so need to skip this. + offset += + LittleEndianConsts.BYTE_SIZE; + return offset; } private byte createOptionByte( boolean wideChar, boolean richText, boolean farEast ) @@ -409,17 +423,22 @@ class SSTDeserializer int dataLengthInBytes = record.length - LittleEndianConsts.BYTE_SIZE; byte[] unicodeStringData = new byte[record.length + LittleEndianConsts.SHORT_SIZE]; - LittleEndian.putShort( unicodeStringData, (byte) 0, (short) calculateCharCount( dataLengthInBytes ) ); + int charsRead = calculateCharCount( dataLengthInBytes ); + LittleEndian.putShort( unicodeStringData, (byte) 0, (short) charsRead ); arraycopy( record, 0, unicodeStringData, LittleEndianConsts.SHORT_SIZE, record.length ); - UnicodeString ucs = new UnicodeString( UnicodeString.sid, (short) unicodeStringData.length, unicodeStringData ); + UnicodeString ucs = new UnicodeString( UnicodeString.sid, (short) unicodeStringData.length, unicodeStringData, unfinishedString); - unfinishedString = unfinishedString + ucs.getString(); - setContinuationExpectedChars( getContinuationExpectedChars() - calculateCharCount( dataLengthInBytes ) ); + unfinishedString = ucs.getString(); + setContinuationCharsRead( getContinuationCharsRead() + charsRead ); + if (getContinuationCharsRead() == charCount) { + Integer integer = new Integer( strings.size() ); + addToStringTable( strings, integer, ucs ); + } } private boolean stringSpansContinuation( int continuationSizeInBytes ) { - return calculateByteCount( getContinuationExpectedChars() ) > continuationSizeInBytes; + return calculateByteCount( charCount - getContinuationCharsRead() ) > continuationSizeInBytes; } /** @@ -427,14 +446,14 @@ class SSTDeserializer * sub-record in a subsequent continuation record */ - int getContinuationExpectedChars() + int getContinuationCharsRead() { - return continuationExpectedChars; + return continuationReadChars; } - private void setContinuationExpectedChars( final int count ) + private void setContinuationCharsRead( final int count ) { - continuationExpectedChars = count; + continuationReadChars = count; } private int calculateByteCount( final int character_count ) diff --git a/src/java/org/apache/poi/hssf/record/SSTRecord.java b/src/java/org/apache/poi/hssf/record/SSTRecord.java index a3f0807021..7f703e7cd2 100644 --- a/src/java/org/apache/poi/hssf/record/SSTRecord.java +++ b/src/java/org/apache/poi/hssf/record/SSTRecord.java @@ -60,7 +60,6 @@ import org.apache.poi.util.LittleEndianConsts; import java.util.Iterator; import java.util.List; -import java.util.ArrayList; /** * Title: Static String Table Record @@ -73,7 +72,7 @@ import java.util.ArrayList; * @author Andrew C. Oliver (acoliver at apache dot org) * @author Marc Johnson (mjohnson at apache dot org) * @author Glen Stampoultzis (glens at apache.org) - * @version 2.0-pre + * * @see org.apache.poi.hssf.record.LabelSSTRecord * @see org.apache.poi.hssf.record.ContinueRecord */ @@ -112,10 +111,14 @@ public class SSTRecord private List _record_lengths = null; private SSTDeserializer deserializer; + /** Offsets from the beginning of the SST record (even across continuations) */ + int[] bucketAbsoluteOffsets; + /** Offsets relative the start of the current SST or continue record */ + int[] bucketRelativeOffsets; + /** * default constructor */ - public SSTRecord() { field_1_num_strings = 0; @@ -220,7 +223,7 @@ public class SSTRecord field_1_num_strings++; String str = ( string == null ) ? "" : string; - int rval = -1; + int rval; UnicodeString ucs = new UnicodeString(); ucs.setString( str ); @@ -334,7 +337,7 @@ public class SSTRecord for ( int k = 0; k < field_3_strings.size(); k++ ) { buffer.append( " .string_" + k + " = " ) - .append( ( (UnicodeString) field_3_strings + .append( ( field_3_strings .get( new Integer( k ) ) ).toString() ).append( "\n" ); } buffer.append( "[/SST]\n" ); @@ -394,7 +397,7 @@ public class SSTRecord * The data consists of sets of string data. This string data is * arranged as follows: *

    - * + *

          * short  string_length;   // length of string data
          * byte   string_flag;     // flag specifying special string
          *                         // handling
    @@ -407,7 +410,7 @@ public class SSTRecord
          *                         // array is run_count)
          * byte[] extension;       // optional extension (length of array
          *                         // is extend_length)
    -     * 
    +     * 
    *

    * The string_flag is bit mapped as follows: *

    @@ -479,7 +482,7 @@ public class SSTRecord field_2_num_unique_strings = LittleEndian.getInt( data, 4 + offset ); field_3_strings = new BinaryTree(); deserializer = new SSTDeserializer(field_3_strings); - deserializer.manufactureStrings( data, 8 + offset, (short)(size - 8) ); + deserializer.manufactureStrings( data, 8 + offset); } @@ -507,14 +510,22 @@ public class SSTRecord * Subclasses should implement this so that their data is passed back in a * byte array. * - * @return byte array containing instance data + * @return size */ public int serialize( int offset, byte[] data ) { SSTSerializer serializer = new SSTSerializer( _record_lengths, field_3_strings, getNumStrings(), getNumUniqueStrings() ); - return serializer.serialize( getRecordSize(), offset, data ); + int bytes = serializer.serialize( getRecordSize(), offset, data ); + bucketAbsoluteOffsets = serializer.getBucketAbsoluteOffsets(); + bucketRelativeOffsets = serializer.getBucketRelativeOffsets(); +// for ( int i = 0; i < bucketAbsoluteOffsets.length; i++ ) +// { +// System.out.println( "bucketAbsoluteOffset = " + bucketAbsoluteOffsets[i] ); +// System.out.println( "bucketRelativeOffset = " + bucketRelativeOffsets[i] ); +// } + return bytes; } @@ -538,6 +549,45 @@ public class SSTRecord { deserializer.processContinueRecord( record ); } + + /** + * Creates an extended string record based on the current contents of + * the current SST record. The offset within the stream to the SST record + * is required because the extended string record points directly to the + * strings in the SST record. + *

    + * NOTE: THIS FUNCTION MUST ONLY BE CALLED AFTER THE SST RECORD HAS BEEN + * SERIALIZED. + * + * @param sstOffset The offset in the stream to the start of the + * SST record. + * @return The new SST record. + */ + public ExtSSTRecord createExtSSTRecord(int sstOffset) + { + if (bucketAbsoluteOffsets == null || bucketAbsoluteOffsets == null) + throw new IllegalStateException("SST record has not yet been serialized."); + + ExtSSTRecord extSST = new ExtSSTRecord(); + extSST.setNumStringsPerBucket((short)8); + int[] absoluteOffsets = (int[]) bucketAbsoluteOffsets.clone(); + int[] relativeOffsets = (int[]) bucketRelativeOffsets.clone(); + for ( int i = 0; i < absoluteOffsets.length; i++ ) + absoluteOffsets[i] += sstOffset; + extSST.setBucketOffsets(absoluteOffsets, relativeOffsets); + return extSST; + } + + /** + * Calculates the size in bytes of the EXTSST record as it would be if the + * record was serialized. + * + * @return The size of the ExtSST record in bytes. + */ + public int calcExtSSTRecordSize() + { + return ExtSSTRecord.getRecordSizeForStrings(field_3_strings.size()); + } } diff --git a/src/java/org/apache/poi/hssf/record/SSTRecordSizeCalculator.java b/src/java/org/apache/poi/hssf/record/SSTRecordSizeCalculator.java index fbdfba50f3..15a52f9807 100644 --- a/src/java/org/apache/poi/hssf/record/SSTRecordSizeCalculator.java +++ b/src/java/org/apache/poi/hssf/record/SSTRecordSizeCalculator.java @@ -61,7 +61,9 @@ import java.util.List; import java.util.Map; /** - * Used to calculate the record sizes for a particular record. + * Used to calculate the record sizes for a particular record. This kind of + * sucks because it's similar to the SST serialization code. In general + * the SST serialization code needs to be rewritten. * * @author Glen Stampoultzis (glens at apache.org) */ diff --git a/src/java/org/apache/poi/hssf/record/SSTSerializer.java b/src/java/org/apache/poi/hssf/record/SSTSerializer.java index 8239eeb8b4..f4538bb704 100644 --- a/src/java/org/apache/poi/hssf/record/SSTSerializer.java +++ b/src/java/org/apache/poi/hssf/record/SSTSerializer.java @@ -77,6 +77,12 @@ class SSTSerializer private int numUniqueStrings; private SSTRecordHeader sstRecordHeader; + /** Offsets from the beginning of the SST record (even across continuations) */ + int[] bucketAbsoluteOffsets; + /** Offsets relative the start of the current SST or continue record */ + int[] bucketRelativeOffsets; + int startOfSST, startOfRecord; + public SSTSerializer( List recordLengths, BinaryTree strings, int numStrings, int numUniqueStrings ) { this.recordLengths = recordLengths; @@ -84,6 +90,10 @@ class SSTSerializer this.numStrings = numStrings; this.numUniqueStrings = numUniqueStrings; this.sstRecordHeader = new SSTRecordHeader( numStrings, numUniqueStrings ); + + int infoRecs = ExtSSTRecord.getNumberOfInfoRecsForStrings(strings.size()); + this.bucketAbsoluteOffsets = new int[infoRecs]; + this.bucketRelativeOffsets = new int[infoRecs]; } /** @@ -133,7 +143,6 @@ class SSTSerializer /** * This case is chosen when an SST record does not span over to a continue record. - * */ private void serializeSingleSSTRecord( byte[] data, int offset, int record_length_index ) { @@ -144,6 +153,15 @@ class SSTSerializer for ( int k = 0; k < strings.size(); k++ ) { + if (k % ExtSSTRecord.DEFAULT_BUCKET_SIZE == 0) + { + int index = k/ExtSSTRecord.DEFAULT_BUCKET_SIZE; + if (index < ExtSSTRecord.MAX_BUCKETS) { + //Excel only indexes the first 128 buckets. + bucketAbsoluteOffsets[index] = pos; + bucketRelativeOffsets[index] = pos; + } + } System.arraycopy( getUnicodeString( k ).serialize(), 0, data, pos + offset, getUnicodeString( k ).getRecordSize() ); pos += getUnicodeString( k ).getRecordSize(); } @@ -157,6 +175,8 @@ class SSTSerializer private void serializeLargeRecord( int record_size, int record_length_index, byte[] buffer, int offset ) { + startOfSST = offset; + byte[] stringReminant = null; int stringIndex = 0; boolean lastneedcontinue = false; @@ -170,6 +190,7 @@ class SSTSerializer recordLength, numStrings, numUniqueStrings ); // write the appropriate header + startOfRecord = offset + totalWritten; recordProcessor.writeRecordHeader( offset, totalWritten, recordLength, first_record ); first_record = false; @@ -189,6 +210,17 @@ class SSTSerializer { UnicodeString unistr = getUnicodeString( stringIndex ); + if (stringIndex % ExtSSTRecord.DEFAULT_BUCKET_SIZE == 0) + { + int index = stringIndex / ExtSSTRecord.DEFAULT_BUCKET_SIZE; + if (index < ExtSSTRecord.MAX_BUCKETS) { + bucketAbsoluteOffsets[index] = offset + totalWritten + + recordProcessor.getRecordOffset() - startOfSST; + bucketRelativeOffsets[index] = offset + totalWritten + + recordProcessor.getRecordOffset() - startOfRecord; + } + } + if ( unistr.getRecordSize() <= recordProcessor.getAvailable() ) { recordProcessor.writeWholeString( unistr, offset, totalWritten ); @@ -235,4 +267,14 @@ class SSTSerializer { return recordLengths; } + + public int[] getBucketAbsoluteOffsets() + { + return bucketAbsoluteOffsets; + } + + public int[] getBucketRelativeOffsets() + { + return bucketRelativeOffsets; + } } diff --git a/src/java/org/apache/poi/hssf/record/StringRecord.java b/src/java/org/apache/poi/hssf/record/StringRecord.java index ed157bb52a..914a92d8e3 100644 --- a/src/java/org/apache/poi/hssf/record/StringRecord.java +++ b/src/java/org/apache/poi/hssf/record/StringRecord.java @@ -138,6 +138,11 @@ public class StringRecord } } + public boolean isInValueSection() + { + return true; + } + private int getStringLength() { return field_1_string_length; diff --git a/src/java/org/apache/poi/hssf/record/StyleRecord.java b/src/java/org/apache/poi/hssf/record/StyleRecord.java index c4f8ee35cc..d6bb482e5c 100644 --- a/src/java/org/apache/poi/hssf/record/StyleRecord.java +++ b/src/java/org/apache/poi/hssf/record/StyleRecord.java @@ -57,12 +57,14 @@ package org.apache.poi.hssf.record; import org.apache.poi.util.LittleEndian; import org.apache.poi.util.StringUtil; +import org.apache.poi.util.BitField; /** * Title: Style Record

    * Description: Describes a builtin to the gui or user defined style

    * REFERENCE: PG 390 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

    * @author Andrew C. Oliver (acoliver at apache dot org) + * @author aviks : string fixes for UserDefined Style * @version 2.0-pre */ @@ -81,8 +83,10 @@ public class StyleRecord private byte field_3_outline_style_level; // only for user defined styles - private byte field_2_name_length; - private String field_3_name; + private short field_2_name_length; //OO doc says 16 bit length, so we believe + private byte field_3_string_options; + private BitField fHighByte; + private String field_4_name; public StyleRecord() { @@ -125,17 +129,24 @@ public class StyleRecord protected void fillFields(byte [] data, short size, int offset) { + fHighByte = new BitField(0x01); //have to init here, since we are being called + //from super, and class level init hasnt been done. field_1_xf_index = LittleEndian.getShort(data, 0 + offset); - if (getType() == 1) + if (getType() == STYLE_BUILT_IN) { field_2_builtin_style = data[ 2 + offset ]; field_3_outline_style_level = data[ 3 + offset ]; } - else if (getType() == 0) + else if (getType() == STYLE_USER_DEFINED) { - field_2_name_length = data[ 2 + offset ]; - field_3_name = StringUtil.getFromCompressedUnicode(data, 3 + offset, - LittleEndian.ubyteToInt(field_2_name_length)); + field_2_name_length = LittleEndian.getShort(data, 2 + offset ); + field_3_string_options = data[4+offset]; + + if (fHighByte.isSet(field_3_string_options)) { + field_4_name= StringUtil.getFromUnicode(data,offset+5,field_2_name_length); + }else { + field_4_name=StringUtil.getFromCompressedUnicode(data,offset+5,field_2_name_length); + } } // todo sanity check exception to make sure we're one or the other @@ -199,7 +210,8 @@ public class StyleRecord public void setName(String name) { - field_3_name = name; + field_4_name = name; + //TODO set name length and string options } // end user defined @@ -273,7 +285,7 @@ public class StyleRecord * @see #getName() */ - public byte getNameLength() + public short getNameLength() { return field_2_name_length; } @@ -286,7 +298,7 @@ public class StyleRecord public String getName() { - return field_3_name; + return field_4_name; } // end user defined @@ -361,7 +373,7 @@ public class StyleRecord else { LittleEndian.putShort(data, 2 + offset, - (( short ) (0x03 + getNameLength()))); + (( short ) (getRecordSize()-4))); } LittleEndian.putShort(data, 4 + offset, getIndex()); if (getType() == STYLE_BUILT_IN) @@ -371,8 +383,9 @@ public class StyleRecord } else { - data[ 6 + offset ] = getNameLength(); - StringUtil.putCompressedUnicode(getName(), data, 7 + offset); + LittleEndian.putShort(data, 6 + offset , getNameLength()); + data[8+offset]=this.field_3_string_options; + StringUtil.putCompressedUnicode(getName(), data, 9 + offset); } return getRecordSize(); } @@ -387,7 +400,11 @@ public class StyleRecord } else { - retval = 7 + getNameLength(); + if (fHighByte.isSet(field_3_string_options)) { + retval= 9+2*getNameLength(); + }else { + retval = 9 + getNameLength(); + } } return retval; } diff --git a/src/java/org/apache/poi/hssf/record/UnknownRecord.java b/src/java/org/apache/poi/hssf/record/UnknownRecord.java index 36b0595498..b88d22f455 100644 --- a/src/java/org/apache/poi/hssf/record/UnknownRecord.java +++ b/src/java/org/apache/poi/hssf/record/UnknownRecord.java @@ -65,16 +65,14 @@ import org.apache.poi.util.LittleEndian; * Company: SuperLink Software, Inc.

    * @author Andrew C. Oliver (acoliver at apache dot org) * @author Jason Height (jheight at chariot dot net dot au) - * @version 2.0-pre + * @author Glen Stampoultzis (glens at apache.org) */ public class UnknownRecord extends Record { - private short sid = 0; - private short size = 0; - private byte[] thedata = null; - int offset = 0; + private short sid = 0; + private byte[] thedata = null; public UnknownRecord() { @@ -91,7 +89,6 @@ public class UnknownRecord public UnknownRecord(short id, short size, byte [] data) { sid = id; - size = size; thedata = data; } @@ -127,7 +124,7 @@ public class UnknownRecord protected void fillFields(byte [] data, short sid) { - sid = sid; + this.sid = sid; thedata = data; } @@ -179,9 +176,7 @@ public class UnknownRecord /** Unlike the other Record.clone methods this is a shallow clone*/ public Object clone() { UnknownRecord rec = new UnknownRecord(); - rec.offset = offset; rec.sid = sid; - rec.size = size; rec.thedata = thedata; return rec; } diff --git a/src/java/org/apache/poi/hssf/record/aggregates/FormulaRecordAggregate.java b/src/java/org/apache/poi/hssf/record/aggregates/FormulaRecordAggregate.java index 7d5b0b048d..761d821dcf 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/FormulaRecordAggregate.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/FormulaRecordAggregate.java @@ -82,6 +82,19 @@ public class FormulaRecordAggregate this.stringRecord = stringRecord; } + /** + * Used only in the clone + * @param formulaRecord + * @param stringRecord + * @param sharedRecord + */ + public FormulaRecordAggregate( FormulaRecord formulaRecord, StringRecord stringRecord, SharedFormulaRecord sharedRecord) + { + this.formulaRecord = formulaRecord; + this.stringRecord = stringRecord; + this.sharedFormulaRecord = sharedRecord; + } + protected void validateSid( short id ) @@ -106,14 +119,14 @@ public class FormulaRecordAggregate { int pos = offset; pos += formulaRecord.serialize(pos, data); - if (stringRecord != null) - { - pos += stringRecord.serialize(pos, data); - } if (this.getSharedFormulaRecord() != null) { pos += getSharedFormulaRecord().serialize(pos, data); } + if (stringRecord != null) + { + pos += stringRecord.serialize(pos, data); + } return pos - offset; } @@ -221,7 +234,10 @@ public class FormulaRecordAggregate * @see java.lang.Object#clone() */ public Object clone() { - return new FormulaRecordAggregate((FormulaRecord) this.formulaRecord.clone(), (StringRecord) this.stringRecord.clone()); + StringRecord clonedString = (stringRecord == null) ? null : (StringRecord)stringRecord.clone(); + SharedFormulaRecord clonedShared = (sharedFormulaRecord == null) ? null : (SharedFormulaRecord)sharedFormulaRecord.clone(); + + return new FormulaRecordAggregate((FormulaRecord) this.formulaRecord.clone(), clonedString, clonedShared); } @@ -241,4 +257,19 @@ public class FormulaRecordAggregate this.sharedFormulaRecord = sharedFormulaRecord; } + /* + * Setting to true so that this value does not abort the whole ValueAggregation + * (non-Javadoc) + * @see org.apache.poi.hssf.record.Record#isInValueSection() + */ + public boolean isInValueSection() { + + return true; + } + + public String getStringValue() { + if(stringRecord==null) return null; + return stringRecord.getString(); + } + } diff --git a/src/java/org/apache/poi/hssf/record/formula/AbstractFunctionPtg.java b/src/java/org/apache/poi/hssf/record/formula/AbstractFunctionPtg.java index da08a6dc3d..cd2660219e 100644 --- a/src/java/org/apache/poi/hssf/record/formula/AbstractFunctionPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/AbstractFunctionPtg.java @@ -54,9 +54,8 @@ package org.apache.poi.hssf.record.formula; import org.apache.poi.util.BinaryTree; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; -import java.util.Stack; /** * This class provides the base functionality for Excel sheet functions @@ -69,7 +68,7 @@ public abstract class AbstractFunctionPtg extends OperationPtg { //constant used allow a ptgAttr to be mapped properly for its functionPtg public static final String ATTR_NAME = "specialflag"; - + public static final short INDEX_EXTERNAL = 255; private static BinaryTree map = produceHash(); protected static Object[][] functionData = produceFunctionData(); @@ -104,7 +103,7 @@ public abstract class AbstractFunctionPtg extends OperationPtg { return lookupName(field_2_fnc_index); } - public String toFormulaString(SheetReferences refs) { + public String toFormulaString(Workbook book) { return getName(); } @@ -140,7 +139,9 @@ public abstract class AbstractFunctionPtg extends OperationPtg { } protected short lookupIndex(String name) { - return (short)((Integer)map.getKeyForValue(name)).intValue(); + Integer index = (Integer) map.getKeyForValue(name); + if (index != null) return index.shortValue(); + return INDEX_EXTERNAL; } /** @@ -389,6 +390,7 @@ public abstract class AbstractFunctionPtg extends OperationPtg { dmap.put(new Integer(252),"FREQUENCY"); dmap.put(new Integer(253),"ADDTOOLBAR"); dmap.put(new Integer(254),"DELETETOOLBAR"); + dmap.put(new Integer(255),"externalflag"); dmap.put(new Integer(256),"RESETTOOLBAR"); dmap.put(new Integer(257),"EVALUATE"); dmap.put(new Integer(258),"GETTOOLBAR"); diff --git a/src/java/org/apache/poi/hssf/record/formula/AddPtg.java b/src/java/org/apache/poi/hssf/record/formula/AddPtg.java index ead8840677..3a519dceb4 100644 --- a/src/java/org/apache/poi/hssf/record/formula/AddPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/AddPtg.java @@ -62,7 +62,7 @@ package org.apache.poi.hssf.record.formula; import java.util.List; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * Addition operator PTG the "+" binomial operator. If you need more @@ -113,7 +113,7 @@ public class AddPtg } /** Implementation of method from Ptg */ - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "+"; } diff --git a/src/java/org/apache/poi/hssf/record/formula/Area3DPtg.java b/src/java/org/apache/poi/hssf/record/formula/Area3DPtg.java index 1e425669db..59c405c1e6 100644 --- a/src/java/org/apache/poi/hssf/record/formula/Area3DPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/Area3DPtg.java @@ -291,8 +291,9 @@ public class Area3DPtg extends Ptg } - public String toFormulaString( SheetReferences refs ) + public String toFormulaString(Workbook book) { + SheetReferences refs = book == null ? null : book.getSheetReferences(); StringBuffer retval = new StringBuffer(); if ( refs != null ) { @@ -318,6 +319,7 @@ public class Area3DPtg extends Ptg ptg.field_3_last_row = field_3_last_row; ptg.field_4_first_column = field_4_first_column; ptg.field_5_last_column = field_5_last_column; + ptg.setClass(ptgClass); return ptg; } @@ -351,4 +353,3 @@ public class Area3DPtg extends Ptg } - diff --git a/src/java/org/apache/poi/hssf/record/formula/AreaPtg.java b/src/java/org/apache/poi/hssf/record/formula/AreaPtg.java index 87ebb2c769..3189a2c856 100644 --- a/src/java/org/apache/poi/hssf/record/formula/AreaPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/AreaPtg.java @@ -65,7 +65,7 @@ import org.apache.poi.util.BitField; import org.apache.poi.hssf.util.AreaReference; import org.apache.poi.hssf.util.CellReference; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * Specifies a rectangular area of cells A1:A4 for instance. @@ -305,7 +305,7 @@ public class AreaPtg field_4_last_column = column; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return (new CellReference(getFirstRow(),getFirstColumn(),!isFirstRowRelative(),!isFirstColRelative())).toString() + ":" + (new CellReference(getLastRow(),getLastColumn(),!isLastRowRelative(),!isLastColRelative())).toString(); @@ -321,6 +321,7 @@ public class AreaPtg ptg.field_2_last_row = field_2_last_row; ptg.field_3_first_column = field_3_first_column; ptg.field_4_last_column = field_4_last_column; + ptg.setClass(ptgClass); return ptg; } diff --git a/src/java/org/apache/poi/hssf/record/formula/AttrPtg.java b/src/java/org/apache/poi/hssf/record/formula/AttrPtg.java index d389094d7e..ebbfcba877 100644 --- a/src/java/org/apache/poi/hssf/record/formula/AttrPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/AttrPtg.java @@ -60,7 +60,7 @@ */ package org.apache.poi.hssf.record.formula; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; import org.apache.poi.util.LittleEndian; import org.apache.poi.util.BitField; @@ -207,11 +207,11 @@ public class AttrPtg if(space.isSet(field_1_options)) { return operands[ 0 ]; } else if (optiIf.isSet(field_1_options)) { - return toFormulaString((SheetReferences)null) + "(" + operands[ 0 ] +")"; + return toFormulaString((Workbook)null) + "(" + operands[ 0 ] +")"; } else if (optGoto.isSet(field_1_options)) { - return toFormulaString((SheetReferences)null) + operands[0]; //goto isn't a real formula element should not show up + return toFormulaString((Workbook)null) + operands[0]; //goto isn't a real formula element should not show up } else { - return toFormulaString((SheetReferences)null) + "(" + operands[ 0 ] + ")"; + return toFormulaString((Workbook)null) + "(" + operands[ 0 ] + ")"; } } @@ -226,7 +226,7 @@ public class AttrPtg return -1; } - public String toFormulaString(SheetReferences refs) { + public String toFormulaString(Workbook book) { if(semiVolatile.isSet(field_1_options)) { return "ATTR(semiVolatile)"; } diff --git a/src/java/org/apache/poi/hssf/record/formula/BoolPtg.java b/src/java/org/apache/poi/hssf/record/formula/BoolPtg.java index 954eb0f80c..84ad7cfca5 100644 --- a/src/java/org/apache/poi/hssf/record/formula/BoolPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/BoolPtg.java @@ -60,7 +60,7 @@ package org.apache.poi.hssf.record.formula; import org.apache.poi.util.LittleEndian; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * Boolean (boolean) @@ -114,7 +114,7 @@ public class BoolPtg return SIZE; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return field_1_value ? "TRUE" : "FALSE"; } diff --git a/src/java/org/apache/poi/hssf/record/formula/ConcatPtg.java b/src/java/org/apache/poi/hssf/record/formula/ConcatPtg.java index bed92e461a..e7249bfbc1 100644 --- a/src/java/org/apache/poi/hssf/record/formula/ConcatPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/ConcatPtg.java @@ -62,7 +62,7 @@ package org.apache.poi.hssf.record.formula; import java.util.List; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * @@ -108,7 +108,7 @@ public class ConcatPtg return 2; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return CONCAT; } diff --git a/src/java/org/apache/poi/hssf/record/formula/DividePtg.java b/src/java/org/apache/poi/hssf/record/formula/DividePtg.java index 124f25edef..6bb0d9420a 100644 --- a/src/java/org/apache/poi/hssf/record/formula/DividePtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/DividePtg.java @@ -62,7 +62,7 @@ package org.apache.poi.hssf.record.formula; import java.util.List; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * This PTG implements the standard binomial divide "/" @@ -108,7 +108,7 @@ public class DividePtg return 2; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "/"; } @@ -117,7 +117,7 @@ public class DividePtg StringBuffer buffer = new StringBuffer(); buffer.append(operands[ 0 ]); - buffer.append(toFormulaString((SheetReferences)null)); + buffer.append(toFormulaString((Workbook)null)); buffer.append(operands[ 1 ]); return buffer.toString(); } diff --git a/src/java/org/apache/poi/hssf/record/formula/EqualPtg.java b/src/java/org/apache/poi/hssf/record/formula/EqualPtg.java index 1ddff9ac64..12438a3397 100644 --- a/src/java/org/apache/poi/hssf/record/formula/EqualPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/EqualPtg.java @@ -62,7 +62,7 @@ package org.apache.poi.hssf.record.formula; import java.util.List; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * @@ -107,7 +107,7 @@ public class EqualPtg return 2; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "="; } @@ -117,7 +117,7 @@ public class EqualPtg buffer.append(operands[ 0 ]); - buffer.append(toFormulaString((SheetReferences)null)); + buffer.append(toFormulaString((Workbook)null)); buffer.append(operands[ 1 ]); return buffer.toString(); } diff --git a/src/java/org/apache/poi/hssf/record/formula/ExpPtg.java b/src/java/org/apache/poi/hssf/record/formula/ExpPtg.java index 576bce3316..d70e57968f 100644 --- a/src/java/org/apache/poi/hssf/record/formula/ExpPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/ExpPtg.java @@ -60,7 +60,7 @@ */ package org.apache.poi.hssf.record.formula; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * @@ -102,7 +102,7 @@ public class ExpPtg return SIZE; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "NO IDEA SHARED FORMULA EXP PTG"; } @@ -110,7 +110,10 @@ public class ExpPtg public byte getDefaultOperandClass() {return Ptg.CLASS_VALUE;} public Object clone() { - throw new RuntimeException("NO IDEA SHARED FORMULA EXP PTG"); + //can't clone one that doesnt have data can we?? + if (this.existing == null) throw new RuntimeException("NO IDEA SHARED FORMULA EXP PTG"); + + return new ExpPtg(this.existing, 0); } } diff --git a/src/java/org/apache/poi/hssf/record/formula/FuncPtg.java b/src/java/org/apache/poi/hssf/record/formula/FuncPtg.java index 1c230c95a4..713d200b2d 100644 --- a/src/java/org/apache/poi/hssf/record/formula/FuncPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/FuncPtg.java @@ -63,7 +63,8 @@ public class FuncPtg extends AbstractFunctionPtg{ FuncPtg ptg = new FuncPtg(); //ptg.field_1_num_args = field_1_num_args; ptg.field_2_fnc_index = field_2_fnc_index; - return ptg; + ptg.setClass(ptgClass); + return ptg; } public int getSize() { diff --git a/src/java/org/apache/poi/hssf/record/formula/FuncVarPtg.java b/src/java/org/apache/poi/hssf/record/formula/FuncVarPtg.java index f333ba694e..6bf4d7f540 100644 --- a/src/java/org/apache/poi/hssf/record/formula/FuncVarPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/FuncVarPtg.java @@ -52,6 +52,7 @@ public class FuncVarPtg extends AbstractFunctionPtg{ FuncVarPtg ptg = new FuncVarPtg(); ptg.field_1_num_args = field_1_num_args; ptg.field_2_fnc_index = field_2_fnc_index; + ptg.setClass(ptgClass); return ptg; } diff --git a/src/java/org/apache/poi/hssf/record/formula/GreaterEqualPtg.java b/src/java/org/apache/poi/hssf/record/formula/GreaterEqualPtg.java index de0b6238d9..b387a5e842 100755 --- a/src/java/org/apache/poi/hssf/record/formula/GreaterEqualPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/GreaterEqualPtg.java @@ -54,7 +54,7 @@ package org.apache.poi.hssf.record.formula; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * PTG class to implement greater or equal to @@ -66,7 +66,7 @@ public class GreaterEqualPtg public final static int SIZE = 1; public final static byte sid = 0x0c; - /** Creates new AddPtg */ + /** Creates new GreaterEqualPtg */ public GreaterEqualPtg() { @@ -98,7 +98,7 @@ public class GreaterEqualPtg return 2; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return ">="; } @@ -108,7 +108,7 @@ public class GreaterEqualPtg buffer.append(operands[ 0 ]); - buffer.append(toFormulaString((SheetReferences)null)); + buffer.append(toFormulaString((Workbook)null)); buffer.append(operands[ 1 ]); return buffer.toString(); } diff --git a/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java b/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java index 5f7d6450e0..04fbcac2ef 100644 --- a/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java @@ -61,7 +61,7 @@ package org.apache.poi.hssf.record.formula; import java.util.List; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * Greater than operator PTG ">" @@ -133,7 +133,7 @@ public class GreaterThanPtg * Implementation of method from Ptg * @param refs the Sheet References */ - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return this.GREATERTHAN; } @@ -171,5 +171,3 @@ public class GreaterThanPtg return new GreaterThanPtg(); } } - - diff --git a/src/java/org/apache/poi/hssf/record/formula/IntPtg.java b/src/java/org/apache/poi/hssf/record/formula/IntPtg.java index 200f5dc651..e06f1ecd25 100644 --- a/src/java/org/apache/poi/hssf/record/formula/IntPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/IntPtg.java @@ -61,7 +61,7 @@ package org.apache.poi.hssf.record.formula; import org.apache.poi.util.LittleEndian; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * Integer (short intger) @@ -116,7 +116,7 @@ public class IntPtg return SIZE; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "" + getValue(); } diff --git a/src/java/org/apache/poi/hssf/record/formula/LessEqualPtg.java b/src/java/org/apache/poi/hssf/record/formula/LessEqualPtg.java index 0c8165fb7c..c1c7570029 100755 --- a/src/java/org/apache/poi/hssf/record/formula/LessEqualPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/LessEqualPtg.java @@ -53,7 +53,7 @@ */ package org.apache.poi.hssf.record.formula; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** @@ -67,7 +67,7 @@ public class LessEqualPtg public final static int SIZE = 1; public final static byte sid = 0x0a; - /** Creates new AddPtg */ + /** Creates new LessEqualPtg */ public LessEqualPtg() { @@ -99,7 +99,7 @@ public class LessEqualPtg return 2; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "<="; } @@ -109,7 +109,7 @@ public class LessEqualPtg buffer.append(operands[ 0 ]); - buffer.append(toFormulaString((SheetReferences)null)); + buffer.append(toFormulaString((Workbook)null)); buffer.append(operands[ 1 ]); return buffer.toString(); } diff --git a/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java b/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java index cab99be9c3..a856b93bde 100644 --- a/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java @@ -63,7 +63,7 @@ package org.apache.poi.hssf.record.formula; import java.util.List; //POI -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * Less than operator PTG "<". The SID is taken from the @@ -142,7 +142,7 @@ public class LessThanPtg * Implementation of method from Ptg * @param refs the Sheet References */ - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return this.LESSTHAN; } @@ -180,6 +180,3 @@ public class LessThanPtg } } - - - diff --git a/src/java/org/apache/poi/hssf/record/formula/MemErrPtg.java b/src/java/org/apache/poi/hssf/record/formula/MemErrPtg.java index c48ad8c3b1..31a1bcafec 100644 --- a/src/java/org/apache/poi/hssf/record/formula/MemErrPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/MemErrPtg.java @@ -61,7 +61,7 @@ package org.apache.poi.hssf.record.formula; import org.apache.poi.util.LittleEndian; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * @@ -118,7 +118,7 @@ public class MemErrPtg return SIZE; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "ERR#"; } diff --git a/src/java/org/apache/poi/hssf/record/formula/MemFuncPtg.java b/src/java/org/apache/poi/hssf/record/formula/MemFuncPtg.java index 2d422b1c7e..a8b63609c4 100644 --- a/src/java/org/apache/poi/hssf/record/formula/MemFuncPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/MemFuncPtg.java @@ -60,7 +60,7 @@ package org.apache.poi.hssf.record.formula; import org.apache.poi.util.LittleEndian; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * @author Glen Stampoultzis (glens at apache.org) @@ -96,7 +96,7 @@ public class MemFuncPtg extends ControlPtg LittleEndian.putShort( array, offset + 1, (short)field_1_len_ref_subexpression ); } - public String toFormulaString( SheetReferences refs ) + public String toFormulaString(Workbook book) { return ""; } diff --git a/src/java/org/apache/poi/hssf/record/formula/MissingArgPtg.java b/src/java/org/apache/poi/hssf/record/formula/MissingArgPtg.java index 3f88ded3b8..c65ab41f3d 100644 --- a/src/java/org/apache/poi/hssf/record/formula/MissingArgPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/MissingArgPtg.java @@ -54,7 +54,7 @@ package org.apache.poi.hssf.record.formula; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * Missing Function Arguments @@ -91,7 +91,7 @@ public class MissingArgPtg } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return " "; } @@ -103,5 +103,3 @@ public class MissingArgPtg } } - - diff --git a/src/java/org/apache/poi/hssf/record/formula/MultiplyPtg.java b/src/java/org/apache/poi/hssf/record/formula/MultiplyPtg.java index 143702ce16..6b33e619b6 100644 --- a/src/java/org/apache/poi/hssf/record/formula/MultiplyPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/MultiplyPtg.java @@ -61,7 +61,7 @@ package org.apache.poi.hssf.record.formula; import java.util.List; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * Implements the standard mathmatical multiplication - * @@ -114,7 +114,7 @@ public class MultiplyPtg } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "*"; } @@ -123,9 +123,9 @@ public class MultiplyPtg { StringBuffer buffer = new StringBuffer(); - buffer.append(operands[ 0 ].toFormulaString((SheetReferences)null)); + buffer.append(operands[ 0 ].toFormulaString((Workbook)null)); buffer.append("*"); - buffer.append(operands[ 1 ].toFormulaString((SheetReferences)null)); + buffer.append(operands[ 1 ].toFormulaString((Workbook)null)); return buffer.toString(); } @@ -133,7 +133,7 @@ public class MultiplyPtg StringBuffer buffer = new StringBuffer(); buffer.append(operands[ 0 ]); - buffer.append(toFormulaString((SheetReferences)null)); + buffer.append(toFormulaString((Workbook)null)); buffer.append(operands[ 1 ]); return buffer.toString(); } diff --git a/src/java/org/apache/poi/hssf/record/formula/NamePtg.java b/src/java/org/apache/poi/hssf/record/formula/NamePtg.java index c926d511a1..6cdee6af03 100644 --- a/src/java/org/apache/poi/hssf/record/formula/NamePtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/NamePtg.java @@ -61,7 +61,8 @@ package org.apache.poi.hssf.record.formula; import org.apache.poi.util.LittleEndian; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; +import org.apache.poi.hssf.record.NameRecord; /** * @@ -73,10 +74,10 @@ public class NamePtg extends Ptg { public final static short sid = 0x23; - private final static int SIZE = 7; - private short field_1_ixti; // unknown function - private short field_2_label_index; - private short field_3_zero; // reserved must be 0 + private final static int SIZE = 5; + private short field_1_label_index; + private short field_2_zero; // reserved must be 0 + boolean xtra=false; private NamePtg() { @@ -85,9 +86,22 @@ public class NamePtg /** Creates new NamePtg */ - public NamePtg(String name) + public NamePtg(String name, Workbook book) { - //TODO + final short n = (short) (book.getNumNames() + 1); + NameRecord rec; + for (short i = 1; i < n; i++) { + rec = book.getNameRecord(i - 1); + if (name.equals(rec.getNameText())) { + field_1_label_index = i; + return; + } + } + rec = new NameRecord(); + rec.setNameText(name); + rec.setNameTextLength((byte) name.length()); + book.addName(rec); + field_1_label_index = n; } /** Creates new NamePtg */ @@ -95,13 +109,17 @@ public class NamePtg public NamePtg(byte [] data, int offset) { offset++; - field_1_ixti = LittleEndian.getShort(data, offset); - field_2_label_index = LittleEndian.getShort(data, offset + 2); - field_3_zero = LittleEndian.getShort(data, offset + 4); + //field_1_ixti = LittleEndian.getShort(data, offset); + field_1_label_index = LittleEndian.getShort(data, offset ); + field_2_zero = LittleEndian.getShort(data, offset + 2); + //if (data[offset+6]==0) xtra=true; } public void writeBytes(byte [] array, int offset) { + array[offset+0]= (byte) (sid + ptgClass); + LittleEndian.putShort(array,offset+1,field_1_label_index); + LittleEndian.putShort(array,offset+3, field_2_zero); } public int getSize() @@ -109,18 +127,18 @@ public class NamePtg return SIZE; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { - return "NO IDEA - NAME"; + NameRecord rec = book.getNameRecord(field_1_label_index - 1); + return rec.getNameText(); } - public byte getDefaultOperandClass() {return Ptg.CLASS_VALUE;} + public byte getDefaultOperandClass() {return Ptg.CLASS_REF;} public Object clone() { NamePtg ptg = new NamePtg(); - ptg.field_1_ixti = field_1_ixti; - ptg.field_2_label_index = field_2_label_index; - ptg.field_3_zero = field_3_zero; + ptg.field_1_label_index = field_1_label_index; + ptg.field_2_zero = field_2_zero; return ptg; } } diff --git a/src/java/org/apache/poi/hssf/record/formula/NameXPtg.java b/src/java/org/apache/poi/hssf/record/formula/NameXPtg.java index b913f438a4..9b6225d809 100644 --- a/src/java/org/apache/poi/hssf/record/formula/NameXPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/NameXPtg.java @@ -61,7 +61,7 @@ package org.apache.poi.hssf.record.formula; import org.apache.poi.util.LittleEndian; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * @@ -102,7 +102,7 @@ public class NameXPtg extends Ptg public void writeBytes(byte [] array, int offset) { - array[ offset + 0 ] = sid; + array[ offset + 0 ] = (byte)(sid + ptgClass); LittleEndian.putShort(array, offset + 1, field_1_ixals); LittleEndian.putShort(array,offset+3, field_2_ilbl); LittleEndian.putShort(array, offset + 5, field_3_reserved); @@ -113,7 +113,7 @@ public class NameXPtg extends Ptg return SIZE; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "NO IDEA - NAME"; } @@ -125,6 +125,7 @@ public class NameXPtg extends Ptg ptg.field_1_ixals = field_1_ixals; ptg.field_3_reserved = field_3_reserved; ptg.field_2_ilbl = field_2_ilbl; + ptg.setClass(ptgClass); return ptg; } } diff --git a/src/java/org/apache/poi/hssf/record/formula/NotEqualPtg.java b/src/java/org/apache/poi/hssf/record/formula/NotEqualPtg.java index c43c196789..b12b16ae97 100755 --- a/src/java/org/apache/poi/hssf/record/formula/NotEqualPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/NotEqualPtg.java @@ -56,7 +56,7 @@ package org.apache.poi.hssf.record.formula; import java.util.List; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * Ptg class to implement not equal @@ -69,7 +69,7 @@ public class NotEqualPtg public final static int SIZE = 1; public final static byte sid = 0x0e; - /** Creates new AddPtg */ + /** Creates new NotEqualPtg */ public NotEqualPtg() { @@ -101,7 +101,7 @@ public class NotEqualPtg return 2; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "<>"; } @@ -111,7 +111,7 @@ public class NotEqualPtg buffer.append(operands[ 0 ]); - buffer.append(toFormulaString((SheetReferences)null)); + buffer.append(toFormulaString((Workbook)null)); buffer.append(operands[ 1 ]); return buffer.toString(); } diff --git a/src/java/org/apache/poi/hssf/record/formula/NumberPtg.java b/src/java/org/apache/poi/hssf/record/formula/NumberPtg.java index e071420bc5..b43c5536eb 100644 --- a/src/java/org/apache/poi/hssf/record/formula/NumberPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/NumberPtg.java @@ -55,7 +55,7 @@ package org.apache.poi.hssf.record.formula; import org.apache.poi.util.LittleEndian; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * Number * Stores a floating point value in a formula @@ -113,7 +113,7 @@ public class NumberPtg return SIZE; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "" + getValue(); } @@ -125,4 +125,3 @@ public class NumberPtg return ptg; } } - diff --git a/src/java/org/apache/poi/hssf/record/formula/ParenthesisPtg.java b/src/java/org/apache/poi/hssf/record/formula/ParenthesisPtg.java index c2118f151f..2abff9e73a 100644 --- a/src/java/org/apache/poi/hssf/record/formula/ParenthesisPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/ParenthesisPtg.java @@ -57,7 +57,7 @@ package org.apache.poi.hssf.record.formula; import java.util.List; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * While formula tokens are stored in RPN order and thus do not need parenthesis for @@ -107,7 +107,7 @@ public class ParenthesisPtg return 1; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "()"; } @@ -124,4 +124,3 @@ public class ParenthesisPtg } } - diff --git a/src/java/org/apache/poi/hssf/record/formula/PowerPtg.java b/src/java/org/apache/poi/hssf/record/formula/PowerPtg.java index ca7fa64863..161918abef 100644 --- a/src/java/org/apache/poi/hssf/record/formula/PowerPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/PowerPtg.java @@ -62,7 +62,7 @@ package org.apache.poi.hssf.record.formula; import java.util.List; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * @@ -108,7 +108,7 @@ public class PowerPtg return 2; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "^"; } @@ -118,7 +118,7 @@ public class PowerPtg buffer.append(operands[ 0 ]); - buffer.append(toFormulaString((SheetReferences)null)); + buffer.append(toFormulaString((Workbook)null)); buffer.append(operands[ 1 ]); return buffer.toString(); } diff --git a/src/java/org/apache/poi/hssf/record/formula/Ptg.java b/src/java/org/apache/poi/hssf/record/formula/Ptg.java index 3787d0056e..cdf584ed1a 100644 --- a/src/java/org/apache/poi/hssf/record/formula/Ptg.java +++ b/src/java/org/apache/poi/hssf/record/formula/Ptg.java @@ -63,7 +63,7 @@ package org.apache.poi.hssf.record.formula; import java.util.List; import java.util.ArrayList; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * @@ -307,6 +307,12 @@ public abstract class Ptg case MissingArgPtg.sid: retval = new MissingArgPtg(data,offset); break; + case UnaryPlusPtg.sid: + retval=new UnaryPlusPtg(data,offset); + break; + case UnaryMinusPtg.sid: + retval=new UnaryMinusPtg(data,offset); + break; default : @@ -341,7 +347,7 @@ public abstract class Ptg /** * return a string representation of this token alone */ - public abstract String toFormulaString(SheetReferences refs); + public abstract String toFormulaString(Workbook book); /** * dump a debug representation (hexdump) to a string */ @@ -357,6 +363,14 @@ public abstract class Ptg return retval; } + /** Overridden toString method to ensure object hash is not printed. + * This helps get rid of gratuitous diffs when comparing two dumps + * Subclasses may output more relevant information by overriding this method + **/ + public String toString(){ + return this.getClass().toString(); + } + public static final byte CLASS_REF = 0x00; public static final byte CLASS_VALUE = 0x20; public static final byte CLASS_ARRAY = 0x40; diff --git a/src/java/org/apache/poi/hssf/record/formula/Ref3DPtg.java b/src/java/org/apache/poi/hssf/record/formula/Ref3DPtg.java index 0d842955b9..4e175e85be 100644 --- a/src/java/org/apache/poi/hssf/record/formula/Ref3DPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/Ref3DPtg.java @@ -61,6 +61,7 @@ import org.apache.poi.util.LittleEndian; import org.apache.poi.hssf.util.RangeAddress; import org.apache.poi.hssf.util.CellReference; import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; import org.apache.poi.util.BitField; import org.apache.poi.hssf.model.Workbook; @@ -104,7 +105,7 @@ public class Ref3DPtg extends Ptg { public String toString() { StringBuffer buffer = new StringBuffer(); - buffer.append("Ref3dPrg\n"); + buffer.append("Ref3dPtg\n"); buffer.append("Index to Extern Sheet = " + getExternSheetIndex()).append("\n"); buffer.append("Row = " + getRow()).append("\n"); buffer.append("Col = " + getColumn()).append("\n"); @@ -193,8 +194,9 @@ public class Ref3DPtg extends Ptg { } - public String toFormulaString(SheetReferences refs) { + public String toFormulaString(Workbook book) { StringBuffer retval = new StringBuffer(); + SheetReferences refs = book == null ? null : book.getSheetReferences(); if (refs != null) { retval.append(refs.getSheetName((int)this.field_1_index_extern_sheet)); retval.append('!'); @@ -210,6 +212,7 @@ public class Ref3DPtg extends Ptg { ptg.field_1_index_extern_sheet = field_1_index_extern_sheet; ptg.field_2_row = field_2_row; ptg.field_3_column = field_3_column; + ptg.setClass(ptgClass); return ptg; } diff --git a/src/java/org/apache/poi/hssf/record/formula/ReferencePtg.java b/src/java/org/apache/poi/hssf/record/formula/ReferencePtg.java index 90f7d899c8..4c14aaf55f 100644 --- a/src/java/org/apache/poi/hssf/record/formula/ReferencePtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/ReferencePtg.java @@ -64,7 +64,7 @@ import org.apache.poi.util.LittleEndian; import org.apache.poi.util.BitField; import org.apache.poi.hssf.util.CellReference; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * ReferencePtg - handles references (such as A1, A2, IA4) @@ -179,7 +179,7 @@ public class ReferencePtg extends Ptg return SIZE; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { //TODO -- should we store a cellreference instance in this ptg?? but .. memory is an issue, i believe! return (new CellReference(getRow(),getColumn(),!isRowRelative(),!isColRelative())).toString(); @@ -193,6 +193,7 @@ public class ReferencePtg extends Ptg ReferencePtg ptg = new ReferencePtg(); ptg.field_1_row = field_1_row; ptg.field_2_col = field_2_col; + ptg.setClass(ptgClass); return ptg; } } diff --git a/src/java/org/apache/poi/hssf/record/formula/StringPtg.java b/src/java/org/apache/poi/hssf/record/formula/StringPtg.java index 022fffd83c..1ad2789d47 100644 --- a/src/java/org/apache/poi/hssf/record/formula/StringPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/StringPtg.java @@ -55,8 +55,9 @@ package org.apache.poi.hssf.record.formula; import org.apache.poi.util.LittleEndian; - -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.util.BitField; +import org.apache.poi.hssf.model.Workbook; +import org.apache.poi.util.StringUtil; /** * Number @@ -70,7 +71,12 @@ public class StringPtg { public final static int SIZE = 9; public final static byte sid = 0x17; - private String field_1_value; + //NOTE: OO doc says 16bit lenght, but BiffViewer says 8 + // Book says something totally different, so dont look there! + byte field_1_length; + byte field_2_options; + BitField fHighByte = new BitField(0x01); + private String field_3_string; private StringPtg() { //Required for clone methods @@ -79,7 +85,16 @@ public class StringPtg /** Create a StringPtg from a byte array read from disk */ public StringPtg(byte [] data, int offset) { - setValue(new String(data, offset+3, data[offset+1] + 256*data[offset+2])); + offset++; + field_1_length = data[offset]; + field_2_options = data[offset+1]; + if (fHighByte.isSet(field_2_options)) { + field_3_string= StringUtil.getFromUnicode(data,offset+2,field_1_length); + }else { + field_3_string=StringUtil.getFromCompressedUnicode(data,offset+2,field_1_length); + } + + //setValue(new String(data, offset+3, data[offset+1] + 256*data[offset+2])); } /** Create a StringPtg from a string representation of the number @@ -88,35 +103,49 @@ public class StringPtg * @param value : String representation of a floating point number */ public StringPtg(String value) { - setValue(value); + if (value.length() >255) { + throw new IllegalArgumentException("String literals in formulas cant be bigger than 255 characters ASCII"); + } + this.field_2_options=0; + this.fHighByte.setBoolean(field_2_options, false); + this.field_3_string=value; + this.field_1_length=(byte)value.length(); //for the moment, we support only ASCII strings in formulas we create } - + /* public void setValue(String value) { field_1_value = value; - } + }*/ public String getValue() { - return field_1_value; + return field_3_string; } public void writeBytes(byte [] array, int offset) { array[ offset + 0 ] = sid; - array[ offset + 1 ] = (byte)(getValue().length() % 256); - array[ offset + 2 ] = (byte)(getValue().length() / 256); - System.arraycopy(getValue().getBytes(), 0, array, offset + 3, getValue().length()); + array[ offset + 1 ] = field_1_length; + array[ offset + 2 ] = field_2_options; + if (fHighByte.isSet(field_2_options)) { + StringUtil.putUncompressedUnicode(getValue(),array,offset+3); + }else { + StringUtil.putCompressedUnicode(getValue(),array,offset+3); + } } public int getSize() { - return field_1_value.length() + 3; + if (fHighByte.isSet(field_2_options)) { + return 2*field_1_length+3; + }else { + return field_1_length+3; + } } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "\""+getValue()+"\""; } @@ -126,9 +155,10 @@ public class StringPtg public Object clone() { StringPtg ptg = new StringPtg(); - ptg.field_1_value = field_1_value; + ptg.field_1_length = field_1_length; + ptg.field_2_options=field_2_options; + ptg.field_3_string=field_3_string; return ptg; } } - diff --git a/src/java/org/apache/poi/hssf/record/formula/SubtractPtg.java b/src/java/org/apache/poi/hssf/record/formula/SubtractPtg.java index 2c5588f3dd..cd9fa5fd78 100644 --- a/src/java/org/apache/poi/hssf/record/formula/SubtractPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/SubtractPtg.java @@ -61,7 +61,7 @@ package org.apache.poi.hssf.record.formula; import java.util.List; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * @@ -105,7 +105,7 @@ public class SubtractPtg return 2; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "-"; } diff --git a/src/java/org/apache/poi/hssf/record/formula/UnaryMinusPtg.java b/src/java/org/apache/poi/hssf/record/formula/UnaryMinusPtg.java new file mode 100644 index 0000000000..bb60dd09bc --- /dev/null +++ b/src/java/org/apache/poi/hssf/record/formula/UnaryMinusPtg.java @@ -0,0 +1,127 @@ + +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2003 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache POI" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache POI", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ +package org.apache.poi.hssf.record.formula; + +import java.util.List; + +import org.apache.poi.hssf.model.Workbook; + +/** + * Unary Plus operator + * does not have any effect on the operand + * @author Avik Sengupta + */ + +public class UnaryMinusPtg extends OperationPtg +{ + public final static int SIZE = 1; + public final static byte sid = 0x13; + + private final static String MINUS = "-"; + + /** Creates new AddPtg */ + + public UnaryMinusPtg() + { + } + + public UnaryMinusPtg(byte[] data, int offset) + { + + // doesn't need anything + } + + + public void writeBytes(byte [] array, int offset) + { + array[ offset + 0 ] = sid; + } + + public int getSize() + { + return SIZE; + } + + public int getType() + { + return this.TYPE_UNARY; + } + + public int getNumberOfOperands() + { + return 1; + } + + /** Implementation of method from Ptg */ + public String toFormulaString(Workbook book) + { + return "+"; + } + + /** implementation of method from OperationsPtg*/ + public String toFormulaString(String[] operands) { + StringBuffer buffer = new StringBuffer(); + buffer.append(MINUS); + buffer.append(operands[ 0]); + return buffer.toString(); + } + + public byte getDefaultOperandClass() {return Ptg.CLASS_VALUE;} + + public Object clone() { + return new UnaryPlusPtg(); + } + +} diff --git a/src/java/org/apache/poi/hssf/record/formula/UnaryPlusPtg.java b/src/java/org/apache/poi/hssf/record/formula/UnaryPlusPtg.java new file mode 100644 index 0000000000..c7ec1e0e99 --- /dev/null +++ b/src/java/org/apache/poi/hssf/record/formula/UnaryPlusPtg.java @@ -0,0 +1,127 @@ + +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2003 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache POI" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache POI", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ +package org.apache.poi.hssf.record.formula; + +import java.util.List; + +import org.apache.poi.hssf.model.Workbook; + +/** + * Unary Plus operator + * does not have any effect on the operand + * @author Avik Sengupta + */ + +public class UnaryPlusPtg extends OperationPtg +{ + public final static int SIZE = 1; + public final static byte sid = 0x12; + + private final static String ADD = "+"; + + /** Creates new AddPtg */ + + public UnaryPlusPtg() + { + } + + public UnaryPlusPtg(byte[] data, int offset) + { + + // doesn't need anything + } + + + public void writeBytes(byte [] array, int offset) + { + array[ offset + 0 ] = sid; + } + + public int getSize() + { + return SIZE; + } + + public int getType() + { + return this.TYPE_UNARY; + } + + public int getNumberOfOperands() + { + return 1; + } + + /** Implementation of method from Ptg */ + public String toFormulaString(Workbook book) + { + return "+"; + } + + /** implementation of method from OperationsPtg*/ + public String toFormulaString(String[] operands) { + StringBuffer buffer = new StringBuffer(); + buffer.append(ADD); + buffer.append(operands[ 0]); + return buffer.toString(); + } + + public byte getDefaultOperandClass() {return Ptg.CLASS_VALUE;} + + public Object clone() { + return new UnaryPlusPtg(); + } + +} diff --git a/src/java/org/apache/poi/hssf/record/formula/UnionPtg.java b/src/java/org/apache/poi/hssf/record/formula/UnionPtg.java index f84235055e..dea5997e05 100644 --- a/src/java/org/apache/poi/hssf/record/formula/UnionPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/UnionPtg.java @@ -54,7 +54,7 @@ package org.apache.poi.hssf.record.formula; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * @author Glen Stampoultzis (glens at apache.org) @@ -95,7 +95,7 @@ public class UnionPtg extends OperationPtg } /** Implementation of method from Ptg */ - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return ","; } diff --git a/src/java/org/apache/poi/hssf/record/formula/UnknownPtg.java b/src/java/org/apache/poi/hssf/record/formula/UnknownPtg.java index 2dd064973c..56d03f60c1 100644 --- a/src/java/org/apache/poi/hssf/record/formula/UnknownPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/UnknownPtg.java @@ -60,7 +60,7 @@ */ package org.apache.poi.hssf.record.formula; -import org.apache.poi.hssf.util.SheetReferences; +import org.apache.poi.hssf.model.Workbook; /** * @@ -94,7 +94,7 @@ public class UnknownPtg return size; } - public String toFormulaString(SheetReferences refs) + public String toFormulaString(Workbook book) { return "UNKNOWN"; } diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java b/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java index 5986b84635..7ebd7e38d3 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java @@ -326,6 +326,7 @@ public class HSSFCell case CELL_TYPE_FORMULA : cellValue = (( FormulaRecordAggregate ) cval).getFormulaRecord().getValue(); + stringValue=((FormulaRecordAggregate) cval).getStringValue(); break; case CELL_TYPE_BOOLEAN : @@ -726,8 +727,7 @@ public class HSSFCell public String getCellFormula() { //Workbook.currentBook=book; - SheetReferences refs = book.getSheetReferences(); - String retval = FormulaParser.toFormulaString(refs, ((FormulaRecordAggregate)record).getFormulaRecord().getParsedExpression()); + String retval = FormulaParser.toFormulaString(book, ((FormulaRecordAggregate)record).getFormulaRecord().getParsedExpression()); //Workbook.currentBook=null; return retval; } @@ -798,6 +798,7 @@ public class HSSFCell /** * get the value of the cell as a string - for numeric cells we throw an exception. * For blank cells we return an empty string. + * For formulaCells that are not string Formulas, we return empty String */ public String getStringCellValue() @@ -821,6 +822,10 @@ public class HSSFCell throw new NumberFormatException( "You cannot get a string value from an error cell"); } + if (cellType == CELL_TYPE_FORMULA) + { + if (stringValue==null) return ""; + } return stringValue; } diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java b/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java index bbde46a407..61b8c60de7 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java @@ -85,7 +85,7 @@ public class HSSFFont * Normal boldness (not bold) */ - public final static short BOLDWEIGHT_NORMAL = 190; + public final static short BOLDWEIGHT_NORMAL = 0x190; /** * Bold boldness (bold) diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFName.java b/src/java/org/apache/poi/hssf/usermodel/HSSFName.java index 0f7178225e..8c18634025 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFName.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFName.java @@ -123,8 +123,7 @@ public class HSSFName { public String getReference() { String result; - SheetReferences refs = book.getSheetReferences(); - result = name.getAreaReference(refs); + result = name.getAreaReference(book); return result; } @@ -167,4 +166,3 @@ public class HSSFName { } } - diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFPalette.java b/src/java/org/apache/poi/hssf/usermodel/HSSFPalette.java index 6c5d0eed70..863533d455 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFPalette.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFPalette.java @@ -103,7 +103,7 @@ public class HSSFPalette for (short i = (short) PaletteRecord.FIRST_COLOR_INDEX; b != null; b = palette.getColor(++i)) { - if (b[0] == red && b[1] == blue && b[2] == green) + if (b[0] == red && b[1] == green && b[2] == blue) { return new CustomColor(i, b); } diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java index a1a6e795fc..9fe691724c 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java @@ -59,17 +59,25 @@ */ package org.apache.poi.hssf.usermodel; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import java.util.TreeMap; + import org.apache.poi.hssf.model.Sheet; import org.apache.poi.hssf.model.Workbook; -import org.apache.poi.hssf.record.*; +import org.apache.poi.hssf.record.CellValueRecordInterface; +import org.apache.poi.hssf.record.HCenterRecord; +import org.apache.poi.hssf.record.Record; +import org.apache.poi.hssf.record.RowRecord; +import org.apache.poi.hssf.record.SCLRecord; +import org.apache.poi.hssf.record.VCenterRecord; +import org.apache.poi.hssf.record.WSBoolRecord; +import org.apache.poi.hssf.record.WindowTwoRecord; import org.apache.poi.hssf.util.Region; import org.apache.poi.util.POILogFactory; import org.apache.poi.util.POILogger; -import java.util.Iterator; -import java.util.TreeMap; -import java.util.List; - /** * High level representation of a worksheet. * @author Andrew C. Oliver (acoliver at apache dot org) @@ -865,6 +873,22 @@ public class HSSFSheet { getSheet().setMargin( margin, size ); } + + /** + * Answer whether protection is enabled or disabled + * @return true => protection enabled; false => protection disabled + */ + public boolean getProtect() { + return getSheet().getProtect().getProtect(); + } + + /** + * Sets the protection on enabled or disabled + * @param protect true => protection enabled; false => protection disabled + */ + public void setProtect(boolean protect) { + getSheet().getProtect().setProtect(protect); + } /** * Sets the zoom magnication for the sheet. The zoom is expressed as a @@ -887,6 +911,50 @@ public class HSSFSheet getSheet().setSCLRecord(sclRecord); } + /** + * Shifts the merged regions left or right depending on mode + *

    + * TODO: MODE , this is only row specific + * @param startRow + * @param endRow + * @param n + * @param isRow + */ + protected void shiftMerged(int startRow, int endRow, int n, boolean isRow) { + List shiftedRegions = new ArrayList(); + //move merged regions completely if they fall within the new region boundaries when they are shifted + for (int i = 0; i < this.getNumMergedRegions(); i++) { + Region merged = this.getMergedRegionAt(i); + + boolean inStart = (merged.getRowFrom() >= startRow || merged.getRowTo() >= startRow); + boolean inEnd = (merged.getRowTo() <= endRow || merged.getRowFrom() <= endRow); + + //dont check if it's not within the shifted area + if (! (inStart && inEnd)) continue; + + //only shift if the region outside the shifted rows is not merged too + if (!merged.contains(startRow-1, (short)0) && !merged.contains(endRow+1, (short)0)){ + merged.setRowFrom(merged.getRowFrom()+n); + merged.setRowTo(merged.getRowTo()+n); + //have to remove/add it back + shiftedRegions.add(merged); + this.removeMergedRegion(i); + i = i -1; // we have to back up now since we removed one + + } + + } + + //readd so it doesn't get shifted again + Iterator iterator = shiftedRegions.iterator(); + while (iterator.hasNext()) { + Region region = (Region)iterator.next(); + + this.addMergedRegion(region); + } + + } + /** * Shifts rows between startRow and endRow n number of rows. * If you use a negative number, it will shift rows up. @@ -894,19 +962,25 @@ public class HSSFSheet * * Calls shiftRows(startRow, endRow, n, false, false); * + *

    + * Additionally shifts merged regions that are completely defined in these + * rows (ie. merged 2 cells on a row to be shifted). * @param startRow the row to start shifting * @param endRow the row to end shifting * @param n the number of rows to shift */ public void shiftRows( int startRow, int endRow, int n ) { - shiftRows(startRow, endRow, n, false, false); + shiftRows(startRow, endRow, n, false, false); } /** * Shifts rows between startRow and endRow n number of rows. * If you use a negative number, it will shift rows up. * Code ensures that rows don't wrap around - * + * + *

    + * Additionally shifts merged regions that are completely defined in these + * rows (ie. merged 2 cells on a row to be shifted). * @param startRow the row to start shifting * @param endRow the row to end shifting * @param n the number of rows to shift @@ -928,6 +1002,9 @@ public class HSSFSheet e = startRow; inc = -1; } + + shiftMerged(startRow, endRow, n, true); + for ( int rowNum = s; rowNum >= startRow && rowNum <= endRow && rowNum >= 0 && rowNum < 65536; rowNum += inc ) { HSSFRow row = getRow( rowNum ); @@ -937,6 +1014,9 @@ public class HSSFSheet HSSFCell cell; + + + // Removes the cells before over writting them. for ( short col = row2Replace.getFirstCellNum(); col <= row2Replace.getLastCellNum(); col++ ) { @@ -1021,5 +1101,51 @@ public class HSSFSheet getSheet().createSplitPane( xSplitPos, ySplitPos, topRow, leftmostColumn, activePane ); } + /** + * Sets whether the gridlines are shown in a viewer. + * @param show whether to show gridlines or not + */ + public void setDisplayGridlines(boolean show) { + sheet.setDisplayGridlines(show); + } + /** + * Returns if gridlines are displayed. + * @return whether gridlines are displayed + */ + public boolean isDisplayGridlines() { + return sheet.isDisplayGridlines(); + } + + /** + * Sets whether the formulas are shown in a viewer. + * @param show whether to show formulas or not + */ + public void setDisplayFormulas(boolean show) { + sheet.setDisplayFormulas(show); + } + + /** + * Returns if formulas are displayed. + * @return whether formulas are displayed + */ + public boolean isDisplayFormulas() { + return sheet.isDisplayFormulas(); + } + + /** + * Sets whether the RowColHeadings are shown in a viewer. + * @param show whether to show RowColHeadings or not + */ + public void setDisplayRowColHeadings(boolean show) { + sheet.setDisplayRowColHeadings(show); + } + + /** + * Returns if RowColHeadings are displayed. + * @return whether RowColHeadings are displayed + */ + public boolean isDisplayRowColHeadings() { + return sheet.isDisplayRowColHeadings(); + } } diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java index 8420aa63b0..c1bfbd3182 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java @@ -147,6 +147,14 @@ public class HSSFWorkbook * memory. */ private POIFSFileSystem poifs; + + /** + * Used to keep track of the data formatter so that all + * createDataFormatter calls return the same one for a given + * book. This ensures that updates from one places is visible + * someplace else. + */ + private HSSFDataFormat formatter; private static POILogger log = POILogFactory.getLogger(HSSFWorkbook.class); @@ -273,7 +281,9 @@ public class HSSFWorkbook /** - * set the sheet name. + * set the sheet name. + * Will throw IllegalArgumentException if the name is greater than 31 chars + * or contains /\?*[] * @param sheet number (0 based) * @param sheet name */ @@ -374,7 +384,11 @@ public class HSSFWorkbook windowTwo.setPaged(sheets.size() == 1); sheets.add(clonedSheet); - workbook.setSheetName(sheets.size()-1, srcName+"[1]"); + if (srcName.length()<28) { + workbook.setSheetName(sheets.size()-1, srcName+"(2)"); + }else { + workbook.setSheetName(sheets.size()-1,srcName.substring(0,28)+"(2)"); + } return clonedSheet; } return null; @@ -890,7 +904,7 @@ public class HSSFWorkbook if (name == null) return null; //adding one here because 0 indicates a global named region; doesnt make sense for print areas - return name.getAreaReference(workbook.getSheetReferences()); + return name.getAreaReference(workbook); } /** @@ -945,13 +959,15 @@ public class HSSFWorkbook } /** - * Creates an instance of HSSFDataFormat. + * Returns the instance of HSSFDataFormat for this workbook. * @return the HSSFDataFormat object * @see org.apache.poi.hssf.record.FormatRecord * @see org.apache.poi.hssf.record.Record */ public HSSFDataFormat createDataFormat() { - return new HSSFDataFormat(workbook); + if (formatter == null) + formatter = new HSSFDataFormat(workbook); + return formatter; } /** remove the named range by his name diff --git a/src/java/org/apache/poi/poifs/filesystem/DirectoryEntry.java b/src/java/org/apache/poi/poifs/filesystem/DirectoryEntry.java index 135a2ba4e2..a85e7e9cb8 100644 --- a/src/java/org/apache/poi/poifs/filesystem/DirectoryEntry.java +++ b/src/java/org/apache/poi/poifs/filesystem/DirectoryEntry.java @@ -59,6 +59,8 @@ import java.io.*; import java.util.*; +import org.apache.poi.hpsf.ClassID; + /** * This interface defines methods specific to Directory objects * managed by a Filesystem instance. @@ -160,5 +162,20 @@ public interface DirectoryEntry public DirectoryEntry createDirectory(final String name) throws IOException; + + /** + * Gets the storage clsid of the directory entry + * + * @return storage Class ID + */ + public ClassID getStorageClsid(); + + /** + * Sets the storage clsid for the directory entry + * + * @param clsidStorage storage Class ID + */ + public void setStorageClsid(ClassID clsidStorage); + } // end public interface DirectoryEntry diff --git a/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java b/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java index d7c670c252..feeb74771d 100644 --- a/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java +++ b/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java @@ -59,6 +59,7 @@ import java.io.*; import java.util.*; +import org.apache.poi.hpsf.ClassID; import org.apache.poi.poifs.dev.POIFSViewable; import org.apache.poi.poifs.property.DirectoryProperty; import org.apache.poi.poifs.property.DocumentProperty; @@ -346,6 +347,26 @@ public class DirectoryNode return rval; } + /** + * Gets the storage clsid of the directory entry + * + * @return storage Class ID + */ + public ClassID getStorageClsid() + { + return getProperty().getStorageClsid(); + } + + /** + * Sets the storage clsid for the directory entry + * + * @param clsidStorage storage Class ID + */ + public void setStorageClsid(ClassID clsidStorage) + { + getProperty().setStorageClsid(clsidStorage); + } + /* ********** END implementation of DirectoryEntry ********** */ /* ********** START implementation of Entry ********** */ diff --git a/src/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java b/src/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java index 3d173aa46e..3a62e3e1f0 100644 --- a/src/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java +++ b/src/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java @@ -423,6 +423,8 @@ public class POIFSFileSystem DirectoryNode new_dir = ( DirectoryNode ) parent.createDirectory(name); + new_dir.setStorageClsid( property.getStorageClsid() ); + processProperties( small_blocks, big_blocks, (( DirectoryProperty ) property).getChildren(), new_dir); diff --git a/src/java/org/apache/poi/poifs/property/Property.java b/src/java/org/apache/poi/poifs/property/Property.java index 6811a72508..c09c25619b 100644 --- a/src/java/org/apache/poi/poifs/property/Property.java +++ b/src/java/org/apache/poi/poifs/property/Property.java @@ -59,6 +59,8 @@ import java.io.*; import java.util.*; +import org.apache.poi.hpsf.ClassID; + import org.apache.poi.poifs.common.POIFSConstants; import org.apache.poi.poifs.dev.POIFSViewable; import org.apache.poi.util.ByteField; @@ -87,6 +89,8 @@ public abstract class Property static final private int _previous_property_offset = 0x44; static final private int _next_property_offset = 0x48; static final private int _child_property_offset = 0x4C; + static final private int _storage_clsid_offset = 0x50; + static final private int _user_flags_offset = 0x60; static final private int _seconds_1_offset = 0x64; static final private int _days_1_offset = 0x68; static final private int _seconds_2_offset = 0x6C; @@ -107,6 +111,8 @@ public abstract class Property private IntegerField _previous_property; private IntegerField _next_property; private IntegerField _child_property; + private ClassID _storage_clsid; + private IntegerField _user_flags; private IntegerField _seconds_1; private IntegerField _days_1; private IntegerField _seconds_2; @@ -136,6 +142,8 @@ public abstract class Property _NO_INDEX, _raw_data); _child_property = new IntegerField(_child_property_offset, _NO_INDEX, _raw_data); + _storage_clsid = new ClassID(_raw_data,_storage_clsid_offset); + _user_flags = new IntegerField(_user_flags_offset, 0, _raw_data); _seconds_1 = new IntegerField(_seconds_1_offset, 0, _raw_data); _days_1 = new IntegerField(_days_1_offset, 0, _raw_data); @@ -173,6 +181,8 @@ public abstract class Property _raw_data); _child_property = new IntegerField(_child_property_offset, _raw_data); + _storage_clsid = new ClassID(_raw_data,_storage_clsid_offset); + _user_flags = new IntegerField(_user_flags_offset, 0, _raw_data); _seconds_1 = new IntegerField(_seconds_1_offset, _raw_data); _days_1 = new IntegerField(_days_1_offset, _raw_data); _seconds_2 = new IntegerField(_seconds_2_offset, _raw_data); @@ -295,12 +305,21 @@ public abstract class Property abstract public boolean isDirectory(); + /** + * Sets the storage clsid, which is the Class ID of a COM object which + * reads and writes this stream + * @return storage Class ID for this property stream + */ + public ClassID getStorageClsid() + { + return _storage_clsid; + } + /** * Set the name; silently truncates the name if it's too long. * * @param name the new name */ - protected final void setName(final String name) { char[] char_array = name.toCharArray(); @@ -327,6 +346,20 @@ public abstract class Property * LittleEndianConsts.SHORT_SIZE), _raw_data); } + /** + * Sets the storage class ID for this property stream. This is the Class ID + * of the COM object which can read and write this property stream + * @param clsidStorage Storage Class ID + */ + public void setStorageClsid( ClassID clsidStorage) + { + _storage_clsid = clsidStorage; + if( clsidStorage == null) { + Arrays.fill( _raw_data, _storage_clsid_offset, _storage_clsid_offset + ClassID.LENGTH, (byte) 0); + } else { + clsidStorage.write( _raw_data, _storage_clsid_offset); + } + } /** * Set the property type. Makes no attempt to validate the value. * diff --git a/src/java/org/apache/poi/poifs/storage/DocumentBlock.java b/src/java/org/apache/poi/poifs/storage/DocumentBlock.java index f6d0d92b4d..7af3487faa 100644 --- a/src/java/org/apache/poi/poifs/storage/DocumentBlock.java +++ b/src/java/org/apache/poi/poifs/storage/DocumentBlock.java @@ -62,6 +62,7 @@ import java.io.OutputStream; import java.util.Arrays; import org.apache.poi.poifs.common.POIFSConstants; +import org.apache.poi.util.IOUtils; import org.apache.poi.util.IntegerField; import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndianConsts; @@ -106,7 +107,7 @@ public class DocumentBlock throws IOException { this(); - int count = stream.read(_data); + int count = IOUtils.readFully(stream, _data); _bytes_read = (count == -1) ? 0 : count; diff --git a/src/java/org/apache/poi/poifs/storage/HeaderBlockReader.java b/src/java/org/apache/poi/poifs/storage/HeaderBlockReader.java index 015d455d22..ad77368512 100644 --- a/src/java/org/apache/poi/poifs/storage/HeaderBlockReader.java +++ b/src/java/org/apache/poi/poifs/storage/HeaderBlockReader.java @@ -60,6 +60,7 @@ import java.io.*; import java.util.*; import org.apache.poi.poifs.common.POIFSConstants; +import org.apache.poi.util.IOUtils; import org.apache.poi.util.IntegerField; import org.apache.poi.util.LittleEndian; import org.apache.poi.util.LittleEndianConsts; @@ -104,7 +105,7 @@ public class HeaderBlockReader throws IOException { _data = new byte[ POIFSConstants.BIG_BLOCK_SIZE ]; - int byte_count = stream.read(_data); + int byte_count = IOUtils.readFully(stream, _data); if (byte_count != POIFSConstants.BIG_BLOCK_SIZE) { diff --git a/src/java/org/apache/poi/poifs/storage/RawDataBlock.java b/src/java/org/apache/poi/poifs/storage/RawDataBlock.java index 862fd8ca25..863b6108e7 100644 --- a/src/java/org/apache/poi/poifs/storage/RawDataBlock.java +++ b/src/java/org/apache/poi/poifs/storage/RawDataBlock.java @@ -56,6 +56,7 @@ package org.apache.poi.poifs.storage; import org.apache.poi.poifs.common.POIFSConstants; +import org.apache.poi.util.IOUtils; import java.io.*; @@ -84,7 +85,7 @@ public class RawDataBlock throws IOException { _data = new byte[ POIFSConstants.BIG_BLOCK_SIZE ]; - int count = stream.read(_data); + int count = IOUtils.readFully(stream, _data); if (count == -1) { diff --git a/src/java/org/apache/poi/util/HexDump.java b/src/java/org/apache/poi/util/HexDump.java index bc846459d1..74198bc525 100644 --- a/src/java/org/apache/poi/util/HexDump.java +++ b/src/java/org/apache/poi/util/HexDump.java @@ -67,6 +67,20 @@ import java.io.*; public class HexDump { + public static final String EOL = + System.getProperty("line.separator"); +// private static final StringBuffer _lbuffer = new StringBuffer(8); +// private static final StringBuffer _cbuffer = new StringBuffer(2); + private static final char _hexcodes[] = + { + '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', + 'E', 'F' + }; + private static final int _shifts[] = + { + 28, 24, 20, 16, 12, 8, 4, 0 + }; + // all static methods, so no need for a public constructor private HexDump() @@ -95,12 +109,14 @@ public class HexDump throws IOException, ArrayIndexOutOfBoundsException, IllegalArgumentException { - if ((index < 0) || (index >= data.length)) + if ((index < 0) || (data.length != 0 && index >= data.length)) { throw new ArrayIndexOutOfBoundsException( "illegal index: " + index + " into array of length " + data.length); } + if (data.length == 0) + return; // nothing more to do. if (stream == null) { throw new IllegalArgumentException("cannot write to nullstream"); @@ -241,39 +257,26 @@ public class HexDump } - public static final String EOL = - System.getProperty("line.separator"); - private static final StringBuffer _lbuffer = new StringBuffer(8); - private static final StringBuffer _cbuffer = new StringBuffer(2); - private static final char _hexcodes[] = - { - '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', - 'E', 'F' - }; - private static final int _shifts[] = - { - 28, 24, 20, 16, 12, 8, 4, 0 - }; - private static String dump(final long value) { - _lbuffer.setLength(0); + StringBuffer buf = new StringBuffer(); + buf.setLength(0); for (int j = 0; j < 8; j++) { - _lbuffer - .append(_hexcodes[ (( int ) (value >> _shifts[ j ])) & 15 ]); + buf.append( _hexcodes[ (( int ) (value >> _shifts[ j ])) & 15 ]); } - return _lbuffer.toString(); + return buf.toString(); } private static String dump(final byte value) { - _cbuffer.setLength(0); + StringBuffer buf = new StringBuffer(); + buf.setLength(0); for (int j = 0; j < 2; j++) { - _cbuffer.append(_hexcodes[ (value >> _shifts[ j + 6 ]) & 15 ]); + buf.append(_hexcodes[ (value >> _shifts[ j + 6 ]) & 15 ]); } - return _cbuffer.toString(); + return buf.toString(); } /** @@ -294,6 +297,7 @@ public class HexDump retVal.append(']'); return retVal.toString(); } + /** * Converts the parameter to a hex value. * @@ -337,4 +341,41 @@ public class HexDump } return result.toString(); } + + /** + * Dumps bytesToDump bytes to an output stream. + * + * @param in The stream to read from + * @param out The output stream + * @param start The index to use as the starting position for the left hand side label + * @param bytesToDump The number of bytes to output. Use -1 to read until the end of file. + */ + public static void dump( InputStream in, PrintStream out, int start, int bytesToDump ) throws IOException + { + ByteArrayOutputStream buf = new ByteArrayOutputStream(); + if (bytesToDump == -1) + { + int c = in.read(); + while (c != -1) + { + buf.write(c); + c = in.read(); + } + } + else + { + int bytesRemaining = bytesToDump; + while (bytesRemaining-- > 0) + { + int c = in.read(); + if (c == -1) + break; + else + buf.write(c); + } + } + + byte[] data = buf.toByteArray(); + dump(data, 0, out, start, data.length); + } } diff --git a/src/java/org/apache/poi/util/HexRead.java b/src/java/org/apache/poi/util/HexRead.java index 0be7930a7b..6c5eceb125 100644 --- a/src/java/org/apache/poi/util/HexRead.java +++ b/src/java/org/apache/poi/util/HexRead.java @@ -1 +1,225 @@ -/* ==================================================================== * The Apache Software License, Version 1.1 * * Copyright (c) 2003 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Apache" and "Apache Software Foundation" and * "Apache POI" must not be used to endorse or promote products * derived from this software without prior written permission. For * written permission, please contact apache@apache.org. * * 5. Products derived from this software may not be called "Apache", * "Apache POI", nor may "Apache" appear in their name, without * prior written permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . */package org.apache.poi.util;import java.io.IOException;import java.io.File;import java.io.FileInputStream;import java.io.InputStream;import java.util.List;import java.util.ArrayList;/** * Utilities to read hex from files. * * @author Marc Johnson * @author Glen Stampoultzis (glens at apache.org) */public class HexRead{ /** * This method reads hex data from a filename and returns a byte array. * The file may contain line comments that are preceeded with a # symbol. * * @param filename The filename to read * @return The bytes read from the file. * @throws IOException If there was a problem while reading the file. */ public static byte[] readData( String filename ) throws IOException { File file = new File( filename ); FileInputStream stream = new FileInputStream( file ); try { return readData(stream, -1); } finally { stream.close(); } } /** * Same as readData(String) except that this method allows you to specify sections within * a file. Sections are referenced using section headers in the form: *

         *  [sectioname]     * 
    * * @see #readData(String) */ public static byte[] readData(String filename, String section) throws IOException { File file = new File( filename ); FileInputStream stream = new FileInputStream( file ); try { StringBuffer sectionText = new StringBuffer(); boolean inSection = false; int c = stream.read(); while (c != -1) { switch(c) { case '[': inSection = true; break; case '\n': case '\r': inSection = false; sectionText = new StringBuffer(); break; case ']': inSection = false; if (sectionText.toString().equals(section)) return readData(stream, '['); sectionText = new StringBuffer(); break; default: if (inSection) sectionText.append((char)c); } c = stream.read(); } } finally { stream.close(); } throw new IOException("Section '" + section + "' not found"); } static private byte[] readData( FileInputStream stream, int eofChar ) throws IOException { int characterCount = 0; byte b = (byte) 0; List bytes = new ArrayList(); boolean done = false; while ( !done ) { int count = stream.read(); char baseChar = 'a'; if ( count == eofChar) break; switch ( count ) { case '#': readToEOL(stream); break; case '0': case '1': case '2': case '3': case '4': case '5': case '6': case '7': case '8': case '9': b <<= 4; b += (byte) ( count - '0' ); characterCount++; if ( characterCount == 2 ) { bytes.add( new Byte( b ) ); characterCount = 0; b = (byte) 0; } break; case 'A': case 'B': case 'C': case 'D': case 'E': case 'F': baseChar = 'A'; case 'a': case 'b': case 'c': case 'd': case 'e': case 'f': b <<= 4; b += (byte) ( count + 10 - baseChar ); characterCount++; if ( characterCount == 2 ) { bytes.add( new Byte( b ) ); characterCount = 0; b = (byte) 0; } break; case -1: done = true; break; default : break; } } Byte[] polished = (Byte[]) bytes.toArray( new Byte[0] ); byte[] rval = new byte[polished.length]; for ( int j = 0; j < polished.length; j++ ) { rval[j] = polished[j].byteValue(); } return rval; } static private void readToEOL( InputStream stream ) throws IOException { int c = stream.read(); while ( c != -1 && c != '\n' && c != '\r') { c = stream.read(); } }} \ No newline at end of file +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2002 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache POI" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache POI", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + +package org.apache.poi.util; + +import java.io.*; +import java.util.List; +import java.util.ArrayList; + +/** + * Utilities to read hex from files. + * + * @author Marc Johnson + * @author Glen Stampoultzis (glens at apache.org) */ +public class HexRead +{ + /** + * This method reads hex data from a filename and returns a byte array. + * The file may contain line comments that are preceeded with a # symbol. + * + * @param filename The filename to read + * @return The bytes read from the file. + * @throws IOException If there was a problem while reading the file. */ + public static byte[] readData( String filename ) throws IOException + { + File file = new File( filename ); + FileInputStream stream = new FileInputStream( file ); + try + { + return readData( stream, -1 ); + } + finally + { + stream.close(); + } + } + + /** + * Same as readData(String) except that this method allows you to specify sections within + * a file. Sections are referenced using section headers in the form: + *
    +     *  [sectioname]
    +     * 
    + * + * @see #readData(String) + */ + public static byte[] readData( String filename, String section ) throws IOException + { + File file = new File( filename ); + FileInputStream stream = new FileInputStream( file ); + try + { + StringBuffer sectionText = new StringBuffer(); + boolean inSection = false; + int c = stream.read(); + while ( c != -1 ) + { + switch ( c ) + { + case '[': + inSection = true; + break; + case '\n': + case '\r': + inSection = false; + sectionText = new StringBuffer(); + break; + case ']': + inSection = false; + if ( sectionText.toString().equals( section ) ) return readData( stream, '[' ); + sectionText = new StringBuffer(); + break; + default: + if ( inSection ) sectionText.append( (char) c ); + } + c = stream.read(); + } + } + finally + { + stream.close(); + } + throw new IOException( "Section '" + section + "' not found" ); + } + + static public byte[] readData( InputStream stream, int eofChar ) throws IOException + { + int characterCount = 0; + byte b = (byte) 0; + List bytes = new ArrayList(); + boolean done = false; + while ( !done ) + { + int count = stream.read(); + char baseChar = 'a'; + if ( count == eofChar ) break; + switch ( count ) + { + case '#': + readToEOL( stream ); + break; + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + b <<= 4; + b += (byte) ( count - '0' ); + characterCount++; + if ( characterCount == 2 ) + { + bytes.add( new Byte( b ) ); + characterCount = 0; + b = (byte) 0; + } + break; + case 'A': + case 'B': + case 'C': + case 'D': + case 'E': + case 'F': + baseChar = 'A'; + case 'a': + case 'b': + case 'c': + case 'd': + case 'e': + case 'f': + b <<= 4; + b += (byte) ( count + 10 - baseChar ); + characterCount++; + if ( characterCount == 2 ) + { + bytes.add( new Byte( b ) ); + characterCount = 0; + b = (byte) 0; + } + break; + case -1: + done = true; + break; + default : + break; + } + } + Byte[] polished = (Byte[]) bytes.toArray( new Byte[0] ); + byte[] rval = new byte[polished.length]; + for ( int j = 0; j < polished.length; j++ ) + { + rval[j] = polished[j].byteValue(); + } + return rval; + } + + static public byte[] readFromString(String data) throws IOException + { + return readData(new ByteArrayInputStream( data.getBytes() ), -1); + } + + static private void readToEOL( InputStream stream ) throws IOException + { + int c = stream.read(); + while ( c != -1 && c != '\n' && c != '\r' ) + { + c = stream.read(); + } + } +} \ No newline at end of file diff --git a/src/java/org/apache/poi/util/IOUtils.java b/src/java/org/apache/poi/util/IOUtils.java new file mode 100644 index 0000000000..06089b00d7 --- /dev/null +++ b/src/java/org/apache/poi/util/IOUtils.java @@ -0,0 +1,99 @@ + +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2002 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache POI" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache POI", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + +package org.apache.poi.util; + +import java.io.IOException; +import java.io.InputStream; + +public class IOUtils +{ + private IOUtils() + { + } + + /** + * Helper method, just calls readFully(in, b, 0, b.length) + */ + public static int readFully(InputStream in, byte[] b) + throws IOException + { + return readFully(in, b, 0, b.length); + } + + /** + * Same as the normal in.read(b, off, len), but tries to ensure that + * the entire len number of bytes is read. + *

    + * If the end of file is reached before any bytes are read, returns -1. + * Otherwise, returns the number of bytes read. + */ + public static int readFully(InputStream in, byte[] b, int off, int len) + throws IOException + { + int total = 0; + for (;;) { + int got = in.read(b, off + total, len - total); + if (got < 0) { + return (total == 0) ? -1 : total; + } else { + total += got; + if (total == len) + return total; + } + } + } +} + diff --git a/src/java/org/apache/poi/util/LittleEndian.java b/src/java/org/apache/poi/util/LittleEndian.java index 0f525c156d..4c4b51a011 100644 --- a/src/java/org/apache/poi/util/LittleEndian.java +++ b/src/java/org/apache/poi/util/LittleEndian.java @@ -475,23 +475,10 @@ public class LittleEndian return getLong(readFromStream(stream, LONG_SIZE)); } - - private final static byte[] _short_buffer = new byte[SHORT_SIZE]; - private final static byte[] _int_buffer = new byte[INT_SIZE]; - private final static byte[] _long_buffer = new byte[LONG_SIZE]; - - /** * Read the appropriate number of bytes from the stream and return them to * the caller.

    * - * It should be noted that, in an attempt to improve system performance and - * to prevent a transient explosion of discarded byte arrays to be garbage - * collected, static byte arrays are employed for the standard cases of - * reading a short, an int, or a long.

    - * - * THIS INTRODUCES A RISK FOR THREADED OPERATIONS!

    - * * However, for the purposes of the POI project, this risk is deemed * negligible. It is, however, so noted. * @@ -510,23 +497,8 @@ public class LittleEndian public static byte[] readFromStream(final InputStream stream, final int size) throws IOException, BufferUnderrunException { - byte[] buffer = null; + byte[] buffer = new byte[size]; - switch (size) { - - case SHORT_SIZE: - buffer = _short_buffer; - break; - case INT_SIZE: - buffer = _int_buffer; - break; - case LONG_SIZE: - buffer = _long_buffer; - break; - default: - buffer = new byte[size]; - break; - } int count = stream.read(buffer); if (count == -1) { diff --git a/src/java/org/apache/poi/util/StringUtil.java b/src/java/org/apache/poi/util/StringUtil.java index 845854e599..a2ef1247da 100644 --- a/src/java/org/apache/poi/util/StringUtil.java +++ b/src/java/org/apache/poi/util/StringUtil.java @@ -1 +1,363 @@ -/* * ==================================================================== * The Apache Software License, Version 1.1 * * Copyright (c) 2003 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Apache" and "Apache Software Foundation" and * "Apache POI" must not be used to endorse or promote products * derived from this software without prior written permission. For * written permission, please contact apache@apache.org. * * 5. Products derived from this software may not be called "Apache", * "Apache POI", nor may "Apache" appear in their name, without * prior written permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . */package org.apache.poi.util;import java.io.UnsupportedEncodingException;import java.text.NumberFormat;import java.text.FieldPosition;/** * Title: String Utility Description: Collection of string handling utilities * * Now it is quite confusing: the method pairs, in which * one of them write data and other read written data are: * putUncompressedUnicodeHigh and getFromUnicode * putUncompressedUnicode and getFromUnicodeHigh * *@author Andrew C. Oliver *@author Sergei Kozello (sergeikozello at mail.ru) *@created May 10, 2002 *@version 1.0 */public class StringUtil { private final static String ENCODING="ISO-8859-1"; /** * Constructor for the StringUtil object */ private StringUtil() { } /** * given a byte array of 16-bit unicode characters, compress to 8-bit and * return a string * * { 0x16, 0x00 } -> 0x16 * *@param string the byte array to be converted *@param offset the initial offset into the * byte array. it is assumed that string[ offset ] and string[ offset + * 1 ] contain the first 16-bit unicode character *@param len *@return the converted string *@exception ArrayIndexOutOfBoundsException if offset is out of bounds for * the byte array (i.e., is negative or is greater than or equal to * string.length) *@exception IllegalArgumentException if len is too large (i.e., * there is not enough data in string to create a String of that * length) *@len the length of the final string */ public static String getFromUnicodeHigh(final byte[] string, final int offset, final int len) throws ArrayIndexOutOfBoundsException, IllegalArgumentException { if ((offset < 0) || (offset >= string.length)) { throw new ArrayIndexOutOfBoundsException("Illegal offset"); } if ((len < 0) || (((string.length - offset) / 2) < len)) { throw new IllegalArgumentException("Illegal length"); } char[] chars = new char[ len ]; for ( int i = 0; i < chars.length; i++ ) { chars[i] = (char)( string[ offset + ( 2*i ) ] & 0xFF | ( string[ offset + ( 2*i+1 ) ] << 8 ) ); } return new String( chars ); } /** * given a byte array of 16-bit unicode characters, compress to 8-bit and * return a string * * { 0x16, 0x00 } -> 0x16 * *@param string the byte array to be converted *@return the converted string */ public static String getFromUnicodeHigh( final byte[] string ) { return getFromUnicodeHigh( string, 0, string.length / 2 ); } /** * given a byte array of 16-bit unicode characters, compress to 8-bit and * return a string * * { 0x00, 0x16 } -> 0x16 * *@param string the byte array to be converted *@param offset the initial offset into the * byte array. it is assumed that string[ offset ] and string[ offset + * 1 ] contain the first 16-bit unicode character *@param len *@return the converted string *@exception ArrayIndexOutOfBoundsException if offset is out of bounds for * the byte array (i.e., is negative or is greater than or equal to * string.length) *@exception IllegalArgumentException if len is too large (i.e., * there is not enough data in string to create a String of that * length) *@len the length of the final string */ public static String getFromUnicode(final byte[] string, final int offset, final int len) throws ArrayIndexOutOfBoundsException, IllegalArgumentException { if ((offset < 0) || (offset >= string.length)) { throw new ArrayIndexOutOfBoundsException("Illegal offset"); } if ((len < 0) || (((string.length - offset) / 2) < len)) { throw new IllegalArgumentException("Illegal length"); } char[] chars = new char[ len ]; for ( int i = 0; i < chars.length; i++ ) { chars[i] = (char)( ( string[ offset + ( 2*i ) ] << 8 ) + string[ offset + ( 2*i+1 ) ] ); } return new String( chars ); } /** * given a byte array of 16-bit unicode characters, compress to 8-bit and * return a string * * { 0x00, 0x16 } -> 0x16 * *@param string the byte array to be converted *@return the converted string */ public static String getFromUnicode(final byte[] string) { return getFromUnicode(string, 0, string.length / 2); } /** * read compressed unicode(8bit) * * @author Toshiaki Kamoshida(kamoshida.toshiaki at future dot co dot jp) * * @param string byte array to read * @param offset offset to read byte array * @param len length to read byte array * @return String generated String instance by reading byte array */ public static String getFromCompressedUnicode(final byte[] string, final int offset, final int len){ try{ return new String(string,offset,len,"ISO-8859-1"); } catch(UnsupportedEncodingException e){ throw new InternalError();/* unreachable */ } } /** * write compressed unicode * *@param input the String containing the data to be written *@param output the byte array to which the data is to be written *@param offset an offset into the byte arrat at which the data is start * when written */ public static void putCompressedUnicode(final String input, final byte[] output, final int offset) { int strlen = input.length(); for (int k = 0; k < strlen; k++) { output[offset + k] = (byte) input.charAt(k); } } /** * Write uncompressed unicode * *@param input the String containing the unicode data to be written *@param output the byte array to hold the uncompressed unicode *@param offset the offset to start writing into the byte array */ public static void putUncompressedUnicode(final String input, final byte[] output, final int offset) { int strlen = input.length(); for (int k = 0; k < strlen; k++) { char c = input.charAt(k); output[offset + (2 * k)] = (byte) c; output[offset + (2 * k) + 1] = (byte) (c >> 8); } } /** * Write uncompressed unicode * *@param input the String containing the unicode data to be written *@param output the byte array to hold the uncompressed unicode *@param offset the offset to start writing into the byte array */ public static void putUncompressedUnicodeHigh(final String input, final byte[] output, final int offset) { int strlen = input.length(); for (int k = 0; k < strlen; k++) { char c = input.charAt(k); output[offset + (2 * k)] = (byte) (c >> 8); output[offset + (2 * k)] = (byte) c; } } /** * Description of the Method * *@param message Description of the Parameter *@param params Description of the Parameter *@return Description of the Return Value */ public static String format(String message, Object[] params) { int currentParamNumber = 0; StringBuffer formattedMessage = new StringBuffer(); for (int i = 0; i < message.length(); i++) { if (message.charAt(i) == '%') { if (currentParamNumber >= params.length) { formattedMessage.append("?missing data?"); } else if ((params[currentParamNumber] instanceof Number) && (i + 1 < message.length())) { i += matchOptionalFormatting( (Number) params[currentParamNumber++], message.substring(i + 1), formattedMessage); } else { formattedMessage.append(params[currentParamNumber++].toString()); } } else { if ((message.charAt(i) == '\\') && (i + 1 < message.length()) && (message.charAt(i + 1) == '%')) { formattedMessage.append('%'); i++; } else { formattedMessage.append(message.charAt(i)); } } } return formattedMessage.toString(); } /** * Description of the Method * *@param number Description of the Parameter *@param formatting Description of the Parameter *@param outputTo Description of the Parameter *@return Description of the Return Value */ private static int matchOptionalFormatting(Number number, String formatting, StringBuffer outputTo) { NumberFormat numberFormat = NumberFormat.getInstance(); if ((0 < formatting.length()) && Character.isDigit(formatting.charAt(0))) { numberFormat.setMinimumIntegerDigits(Integer.parseInt(formatting.charAt(0) + "")); if ((2 < formatting.length()) && (formatting.charAt(1) == '.') && Character.isDigit(formatting.charAt(2))) { numberFormat.setMaximumFractionDigits(Integer.parseInt(formatting.charAt(2) + "")); numberFormat.format(number, outputTo, new FieldPosition(0)); return 3; } numberFormat.format(number, outputTo, new FieldPosition(0)); return 1; } else if ((0 < formatting.length()) && (formatting.charAt(0) == '.')) { if ((1 < formatting.length()) && Character.isDigit(formatting.charAt(1))) { numberFormat.setMaximumFractionDigits(Integer.parseInt(formatting.charAt(1) + "")); numberFormat.format(number, outputTo, new FieldPosition(0)); return 2; } } numberFormat.format(number, outputTo, new FieldPosition(0)); return 1; } /** * @return the encoding we want to use (ISO-8859-1) */ public static String getPreferredEncoding() { return ENCODING; }} \ No newline at end of file +/* + * ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2002 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache POI" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache POI", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ +package org.apache.poi.util; + +import java.io.UnsupportedEncodingException; + +import java.text.NumberFormat; +import java.text.FieldPosition; + +/** + * Title: String Utility Description: Collection of string handling utilities + * + * Now it is quite confusing: the method pairs, in which + * one of them write data and other read written data are: + * putUncompressedUnicodeHigh and getFromUnicode + * putUncompressedUnicode and getFromUnicodeHigh + * + *@author Andrew C. Oliver + *@author Sergei Kozello (sergeikozello at mail.ru) + *@created May 10, 2002 + *@version 1.0 + */ + +public class StringUtil { + + private final static String ENCODING="ISO-8859-1"; + /** + * Constructor for the StringUtil object + */ + private StringUtil() { } + + + /** + * given a byte array of 16-bit unicode characters, compress to 8-bit and + * return a string + * + * { 0x16, 0x00 } -> 0x16 + * + *@param string the byte array to be converted + *@param offset the initial offset into the + * byte array. it is assumed that string[ offset ] and string[ offset + + * 1 ] contain the first 16-bit unicode character + *@param len + *@return the converted string + *@exception ArrayIndexOutOfBoundsException if offset is out of bounds for + * the byte array (i.e., is negative or is greater than or equal to + * string.length) + *@exception IllegalArgumentException if len is too large (i.e., + * there is not enough data in string to create a String of that + * length) + *@len the length of the final string + */ + + public static String getFromUnicodeHigh(final byte[] string, + final int offset, final int len) + throws ArrayIndexOutOfBoundsException, IllegalArgumentException { + + if ((offset < 0) || (offset >= string.length)) { + throw new ArrayIndexOutOfBoundsException("Illegal offset"); + } + if ((len < 0) || (((string.length - offset) / 2) < len)) { + throw new IllegalArgumentException("Illegal length"); + } + + char[] chars = new char[ len ]; + for ( int i = 0; i < chars.length; i++ ) { + chars[i] = (char)( string[ offset + ( 2*i ) ] & 0xFF | + ( string[ offset + ( 2*i+1 ) ] << 8 ) ); + } + + return new String( chars ); + } + + + /** + * given a byte array of 16-bit unicode characters, compress to 8-bit and + * return a string + * + * { 0x16, 0x00 } -> 0x16 + * + *@param string the byte array to be converted + *@return the converted string + */ + + public static String getFromUnicodeHigh( final byte[] string ) { + return getFromUnicodeHigh( string, 0, string.length / 2 ); + } + + + /** + * given a byte array of 16-bit unicode characters, compress to 8-bit and + * return a string + * + * { 0x00, 0x16 } -> 0x16 + * + *@param string the byte array to be converted + *@param offset the initial offset into the + * byte array. it is assumed that string[ offset ] and string[ offset + + * 1 ] contain the first 16-bit unicode character + *@param len + *@return the converted string + *@exception ArrayIndexOutOfBoundsException if offset is out of bounds for + * the byte array (i.e., is negative or is greater than or equal to + * string.length) + *@exception IllegalArgumentException if len is too large (i.e., + * there is not enough data in string to create a String of that + * length) + *@len the length of the final string + */ + + public static String getFromUnicode(final byte[] string, + final int offset, final int len) + throws ArrayIndexOutOfBoundsException, IllegalArgumentException { + if ((offset < 0) || (offset >= string.length)) { + throw new ArrayIndexOutOfBoundsException("Illegal offset"); + } + if ((len < 0) || (((string.length - offset) / 2) < len)) { + throw new IllegalArgumentException("Illegal length"); + } + + + char[] chars = new char[ len ]; + for ( int i = 0; i < chars.length; i++ ) { + chars[i] = (char)( ( string[ offset + ( 2*i ) ] << 8 ) + + string[ offset + ( 2*i+1 ) ] ); + } + + return new String( chars ); + } + + + /** + * given a byte array of 16-bit unicode characters, compress to 8-bit and + * return a string + * + * { 0x00, 0x16 } -> 0x16 + * + *@param string the byte array to be converted + *@return the converted string + */ + + public static String getFromUnicode(final byte[] string) { + return getFromUnicode(string, 0, string.length / 2); + } + + + /** + * read compressed unicode(8bit) + * + * @author Toshiaki Kamoshida(kamoshida.toshiaki at future dot co dot jp) + * + * @param string byte array to read + * @param offset offset to read byte array + * @param len length to read byte array + * @return String generated String instance by reading byte array + */ + public static String getFromCompressedUnicode(final byte[] string, + final int offset, final int len){ + try{ + return new String(string,offset,len,"ISO-8859-1"); + } + catch(UnsupportedEncodingException e){ + throw new InternalError();/* unreachable */ + } + } + + /** + * write compressed unicode + * + *@param input the String containing the data to be written + *@param output the byte array to which the data is to be written + *@param offset an offset into the byte arrat at which the data is start + * when written + */ + + public static void putCompressedUnicode(final String input, + final byte[] output, + final int offset) { + int strlen = input.length(); + + for (int k = 0; k < strlen; k++) { + output[offset + k] = (byte) input.charAt(k); + } + } + + + /** + * Write uncompressed unicode + * + *@param input the String containing the unicode data to be written + *@param output the byte array to hold the uncompressed unicode + *@param offset the offset to start writing into the byte array + */ + + public static void putUncompressedUnicode(final String input, + final byte[] output, + final int offset) { + int strlen = input.length(); + + for (int k = 0; k < strlen; k++) { + char c = input.charAt(k); + + output[offset + (2 * k)] = (byte) c; + output[offset + (2 * k) + 1] = (byte) (c >> 8); + } + } + + /** + * Write uncompressed unicode + * + *@param input the String containing the unicode data to be written + *@param output the byte array to hold the uncompressed unicode + *@param offset the offset to start writing into the byte array + */ + + public static void putUncompressedUnicodeHigh(final String input, + final byte[] output, + final int offset) { + int strlen = input.length(); + + for (int k = 0; k < strlen; k++) { + char c = input.charAt(k); + + output[offset + (2 * k)] = (byte) (c >> 8); + output[offset + (2 * k)] = (byte) c; + } + } + + + + + /** + * Description of the Method + * + *@param message Description of the Parameter + *@param params Description of the Parameter + *@return Description of the Return Value + */ + public static String format(String message, Object[] params) { + int currentParamNumber = 0; + StringBuffer formattedMessage = new StringBuffer(); + + for (int i = 0; i < message.length(); i++) { + if (message.charAt(i) == '%') { + if (currentParamNumber >= params.length) { + formattedMessage.append("?missing data?"); + } else if ((params[currentParamNumber] instanceof Number) + && (i + 1 < message.length())) { + i += matchOptionalFormatting( + (Number) params[currentParamNumber++], + message.substring(i + 1), formattedMessage); + } else { + formattedMessage.append(params[currentParamNumber++].toString()); + } + } else { + if ((message.charAt(i) == '\\') && (i + 1 < message.length()) + && (message.charAt(i + 1) == '%')) { + formattedMessage.append('%'); + i++; + } else { + formattedMessage.append(message.charAt(i)); + } + } + } + return formattedMessage.toString(); + } + + + /** + * Description of the Method + * + *@param number Description of the Parameter + *@param formatting Description of the Parameter + *@param outputTo Description of the Parameter + *@return Description of the Return Value + */ + private static int matchOptionalFormatting(Number number, + String formatting, + StringBuffer outputTo) { + NumberFormat numberFormat = NumberFormat.getInstance(); + + if ((0 < formatting.length()) + && Character.isDigit(formatting.charAt(0))) { + numberFormat.setMinimumIntegerDigits(Integer.parseInt(formatting.charAt(0) + "")); + if ((2 < formatting.length()) && (formatting.charAt(1) == '.') + && Character.isDigit(formatting.charAt(2))) { + numberFormat.setMaximumFractionDigits(Integer.parseInt(formatting.charAt(2) + "")); + numberFormat.format(number, outputTo, new FieldPosition(0)); + return 3; + } + numberFormat.format(number, outputTo, new FieldPosition(0)); + return 1; + } else if ((0 < formatting.length()) && (formatting.charAt(0) == '.')) { + if ((1 < formatting.length()) + && Character.isDigit(formatting.charAt(1))) { + numberFormat.setMaximumFractionDigits(Integer.parseInt(formatting.charAt(1) + "")); + numberFormat.format(number, outputTo, new FieldPosition(0)); + return 2; + } + } + numberFormat.format(number, outputTo, new FieldPosition(0)); + return 1; + } + + /** + * @return the encoding we want to use (ISO-8859-1) + */ + public static String getPreferredEncoding() { + return ENCODING; + } +} \ No newline at end of file diff --git a/src/java/org/apache/poi/util/SystemOutLogger.java b/src/java/org/apache/poi/util/SystemOutLogger.java index ccd9522a12..98458f7917 100644 --- a/src/java/org/apache/poi/util/SystemOutLogger.java +++ b/src/java/org/apache/poi/util/SystemOutLogger.java @@ -63,13 +63,12 @@ import java.util.*; * A logger class that strives to make it as easy as possible for * developers to write log calls, while simultaneously making those * calls as cheap as possible by performing lazy evaluation of the log - * message.

    + * message. * * @author Marc Johnson (mjohnson at apache dot org) * @author Glen Stampoultzis (glens at apache.org) * @author Nicola Ken Barozzi (nicolaken at apache.org) */ - public class SystemOutLogger extends POILogger { private String cat; @@ -88,19 +87,27 @@ public class SystemOutLogger extends POILogger public void log(final int level, final Object obj1) { - System.out.println("["+cat+"] "+obj1); + if (check(level)) + System.out.println("["+cat+"] "+obj1); } /** * Check if a logger is enabled to log at the specified level * * @param level One of DEBUG, INFO, WARN, ERROR, FATAL - * @param obj1 The logger to check. + * @see #DEBUG + * @see #INFO + * @see #WARN + * @see #ERROR + * @see #FATAL */ - public boolean check(final int level) { - return true; + int currentLevel = Integer.parseInt(System.getProperty("poi.log.level", WARN + "")); + if (level >= currentLevel) + return true; + else + return false; } diff --git a/src/testcases/org/apache/poi/hpsf/basic/POIFile.java b/src/testcases/org/apache/poi/hpsf/basic/POIFile.java index 9786f35866..288242f1c4 100644 --- a/src/testcases/org/apache/poi/hpsf/basic/POIFile.java +++ b/src/testcases/org/apache/poi/hpsf/basic/POIFile.java @@ -53,7 +53,8 @@ */ package org.apache.poi.hpsf.basic; -import org.apache.poi.poifs.filesystem.*; + +import org.apache.poi.poifs.filesystem.POIFSDocumentPath; @@ -73,32 +74,32 @@ public class POIFile public void setName(final String name) { - this.name = name; + this.name = name; } public String getName() { - return name; + return name; } public void setPath(final POIFSDocumentPath path) { - this.path = path; + this.path = path; } public POIFSDocumentPath getPath() { - return path; + return path; } public void setBytes(final byte[] bytes) { - this.bytes = bytes; + this.bytes = bytes; } public byte[] getBytes() { - return bytes; + return bytes; } } diff --git a/src/testcases/org/apache/poi/hpsf/basic/TestBasic.java b/src/testcases/org/apache/poi/hpsf/basic/TestBasic.java index 474489b638..0357c5a233 100644 --- a/src/testcases/org/apache/poi/hpsf/basic/TestBasic.java +++ b/src/testcases/org/apache/poi/hpsf/basic/TestBasic.java @@ -54,10 +54,23 @@ package org.apache.poi.hpsf.basic; -import java.io.*; -import java.util.*; -import junit.framework.*; -import org.apache.poi.hpsf.*; +import java.io.ByteArrayInputStream; +import java.io.File; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.InputStream; + +import junit.framework.Assert; +import junit.framework.TestCase; + +import org.apache.poi.hpsf.DocumentSummaryInformation; +import org.apache.poi.hpsf.HPSFException; +import org.apache.poi.hpsf.MarkUnsupportedException; +import org.apache.poi.hpsf.NoPropertySetStreamException; +import org.apache.poi.hpsf.PropertySet; +import org.apache.poi.hpsf.PropertySetFactory; +import org.apache.poi.hpsf.SummaryInformation; +import org.apache.poi.hpsf.UnexpectedPropertySetTypeException; @@ -71,37 +84,37 @@ import org.apache.poi.hpsf.*; public class TestBasic extends TestCase { - final static String POI_FS = "TestGermanWord90.doc"; - final static String[] POI_FILES = new String[] - { - "\005SummaryInformation", - "\005DocumentSummaryInformation", - "WordDocument", - "\001CompObj", - "1Table" - }; - final static int BYTE_ORDER = 0xfffe; - final static int FORMAT = 0x0000; - final static int OS_VERSION = 0x00020A04; - final static byte[] CLASS_ID = - { - (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00, - (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00, - (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00, - (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00 - }; - final static int[] SECTION_COUNT = + static final String POI_FS = "TestGermanWord90.doc"; + static final String[] POI_FILES = new String[] + { + "\005SummaryInformation", + "\005DocumentSummaryInformation", + "WordDocument", + "\001CompObj", + "1Table" + }; + static final int BYTE_ORDER = 0xfffe; + static final int FORMAT = 0x0000; + static final int OS_VERSION = 0x00020A04; + static final byte[] CLASS_ID = + { + (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00, + (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00, + (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00, + (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00 + }; + static final int[] SECTION_COUNT = {1, 2}; - final static boolean[] IS_SUMMARY_INFORMATION = + static final boolean[] IS_SUMMARY_INFORMATION = {true, false}; - final static boolean[] IS_DOCUMENT_SUMMARY_INFORMATION = - {false, true}; + static final boolean[] IS_DOCUMENT_SUMMARY_INFORMATION = + {false, true}; POIFile[] poiFiles; - public TestBasic(String name) + public TestBasic(final String name) { super(name); } @@ -113,11 +126,11 @@ public class TestBasic extends TestCase */ public void setUp() throws FileNotFoundException, IOException { - final File dataDir = - new File(System.getProperty("HPSF.testdata.path")); - final File data = new File(dataDir, POI_FS); + final File dataDir = + new File(System.getProperty("HPSF.testdata.path")); + final File data = new File(dataDir, POI_FS); - poiFiles = Util.readPOIFiles(data); + poiFiles = Util.readPOIFiles(data); } @@ -128,9 +141,9 @@ public class TestBasic extends TestCase */ public void testReadFiles() throws IOException { - String[] expected = POI_FILES; - for (int i = 0; i < expected.length; i++) - Assert.assertEquals(poiFiles[i].getName(), expected[i]); + String[] expected = POI_FILES; + for (int i = 0; i < expected.length; i++) + Assert.assertEquals(poiFiles[i].getName(), expected[i]); } @@ -146,37 +159,37 @@ public class TestBasic extends TestCase */ public void testCreatePropertySets() throws IOException { - Class[] expected = new Class[] - { - SummaryInformation.class, - DocumentSummaryInformation.class, - NoPropertySetStreamException.class, - NoPropertySetStreamException.class, - NoPropertySetStreamException.class - }; - for (int i = 0; i < expected.length; i++) - { - InputStream in = new ByteArrayInputStream(poiFiles[i].getBytes()); - Object o; - try - { - o = PropertySetFactory.create(in); - } - catch (NoPropertySetStreamException ex) - { - o = ex; - } - catch (UnexpectedPropertySetTypeException ex) - { - o = ex; - } - catch (MarkUnsupportedException ex) - { - o = ex; - } - in.close(); - Assert.assertEquals(o.getClass(), expected[i]); - } + Class[] expected = new Class[] + { + SummaryInformation.class, + DocumentSummaryInformation.class, + NoPropertySetStreamException.class, + NoPropertySetStreamException.class, + NoPropertySetStreamException.class + }; + for (int i = 0; i < expected.length; i++) + { + InputStream in = new ByteArrayInputStream(poiFiles[i].getBytes()); + Object o; + try + { + o = PropertySetFactory.create(in); + } + catch (NoPropertySetStreamException ex) + { + o = ex; + } + catch (UnexpectedPropertySetTypeException ex) + { + o = ex; + } + catch (MarkUnsupportedException ex) + { + o = ex; + } + in.close(); + Assert.assertEquals(o.getClass(), expected[i]); + } } @@ -188,25 +201,24 @@ public class TestBasic extends TestCase */ public void testPropertySetMethods() throws IOException, HPSFException { - String[] expected = POI_FILES; - /* Loop over the two property sets. */ - for (int i = 0; i < 2; i++) - { - byte[] b = poiFiles[i].getBytes(); - PropertySet ps = - PropertySetFactory.create(new ByteArrayInputStream(b)); - Assert.assertEquals(ps.getByteOrder(), BYTE_ORDER); - Assert.assertEquals(ps.getFormat(), FORMAT); - Assert.assertEquals(ps.getOSVersion(), OS_VERSION); - Assert.assertEquals(new String(ps.getClassID().getBytes()), - new String(CLASS_ID)); - Assert.assertEquals(ps.getSectionCount(), SECTION_COUNT[i]); - Assert.assertEquals(ps.isSummaryInformation(), - IS_SUMMARY_INFORMATION[i]); - Assert.assertEquals(ps.isDocumentSummaryInformation(), - IS_DOCUMENT_SUMMARY_INFORMATION[i]); - } + /* Loop over the two property sets. */ + for (int i = 0; i < 2; i++) + { + byte[] b = poiFiles[i].getBytes(); + PropertySet ps = + PropertySetFactory.create(new ByteArrayInputStream(b)); + Assert.assertEquals(ps.getByteOrder(), BYTE_ORDER); + Assert.assertEquals(ps.getFormat(), FORMAT); + Assert.assertEquals(ps.getOSVersion(), OS_VERSION); + Assert.assertEquals(new String(ps.getClassID().getBytes()), + new String(CLASS_ID)); + Assert.assertEquals(ps.getSectionCount(), SECTION_COUNT[i]); + Assert.assertEquals(ps.isSummaryInformation(), + IS_SUMMARY_INFORMATION[i]); + Assert.assertEquals(ps.isDocumentSummaryInformation(), + IS_DOCUMENT_SUMMARY_INFORMATION[i]); + } } @@ -214,11 +226,11 @@ public class TestBasic extends TestCase /** *

    Runs the test cases stand-alone.

    */ - public static void main(String[] args) throws Throwable + public static void main(final String[] args) throws Throwable { - System.setProperty("HPSF.testdata.path", - "./src/testcases/org/apache/poi/hpsf/data"); - junit.textui.TestRunner.run(TestBasic.class); + System.setProperty("HPSF.testdata.path", + "./src/testcases/org/apache/poi/hpsf/data"); + junit.textui.TestRunner.run(TestBasic.class); } } diff --git a/src/testcases/org/apache/poi/hpsf/basic/TestClassID.java b/src/testcases/org/apache/poi/hpsf/basic/TestClassID.java new file mode 100644 index 0000000000..c36f8161ec --- /dev/null +++ b/src/testcases/org/apache/poi/hpsf/basic/TestClassID.java @@ -0,0 +1,171 @@ +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2003 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache POI" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache POI", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + +package org.apache.poi.hpsf.basic; + +import junit.framework.Assert; +import junit.framework.TestCase; + +import org.apache.poi.hpsf.ClassID; + +/** + *

    Tests ClassID structure.

    + * + * @author Michael Zalewski (zalewski@optonline.net) + */ +public class TestClassID extends TestCase +{ + /** + *

    Constructor

    + * + * @param name the test case's name + */ + public TestClassID(final String name) + { + super(name); + } + + /** + * Various tests of overridden .equals() + */ + public void testEquals() + { + ClassID clsidTest1 = new ClassID( + new byte[] { 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08 + , 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10 } + , 0 + ); + ClassID clsidTest2 = new ClassID( + new byte[] { 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08 + , 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10 } + , 0 + ); + ClassID clsidTest3 = new ClassID( + new byte[] { 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08 + , 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x11 } + , 0 + ); + Assert.assertEquals( clsidTest1, clsidTest1); + Assert.assertEquals( clsidTest1, clsidTest2); + Assert.assertFalse( clsidTest1.equals( clsidTest3)); + Assert.assertFalse( clsidTest1.equals( null)); + } + /** + * Try to write to a buffer that is too small. This should + * throw an Exception + */ + public void testWriteArrayStoreException() + { + ClassID clsidTest = new ClassID( + new byte[] { 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08 + , 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10 } + , 0 + ); + boolean bExceptionOccurred = false; + try { + clsidTest.write( new byte[ 15], 0); + } catch( Exception e) { + bExceptionOccurred = true; + } + Assert.assertTrue( bExceptionOccurred); + + bExceptionOccurred = false; + try { + clsidTest.write( new byte[ 16], 1); + } catch( Exception e) { + bExceptionOccurred = true; + } + Assert.assertTrue( bExceptionOccurred); + + // These should work without throwing an Exception + bExceptionOccurred = false; + try { + clsidTest.write( new byte[ 16], 0); + clsidTest.write( new byte[ 17], 1); + } catch( Exception e) { + bExceptionOccurred = true; + } + Assert.assertFalse( bExceptionOccurred); + } + /** + *

    Tests the {@link PropertySet} methods. The test file has two + * property set: the first one is a {@link SummaryInformation}, + * the second one is a {@link DocumentSummaryInformation}.

    + */ + public void testClassID() + { + ClassID clsidTest = new ClassID( + new byte[] { 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08 + , 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10 } + , 0 + ); + Assert.assertEquals( + clsidTest.toString().toUpperCase() + , "{04030201-0605-0807-090A-0B0C0D0E0F10}" + ); + } + + + + /** + *

    Runs the test cases stand-alone.

    + */ + public static void main(final String[] args) + { + System.setProperty("HPSF.testdata.path", + "./src/testcases/org/apache/poi/hpsf/data"); + junit.textui.TestRunner.run(TestClassID.class); + } + +} diff --git a/src/testcases/org/apache/poi/hpsf/basic/TestEmptyProperties.java b/src/testcases/org/apache/poi/hpsf/basic/TestEmptyProperties.java new file mode 100644 index 0000000000..fbe9fbf7f9 --- /dev/null +++ b/src/testcases/org/apache/poi/hpsf/basic/TestEmptyProperties.java @@ -0,0 +1,189 @@ +package org.apache.poi.hpsf.basic; + +import java.io.ByteArrayInputStream; +import java.io.File; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.InputStream; + +import junit.framework.Assert; +import junit.framework.TestCase; + +import org.apache.poi.hpsf.HPSFException; +import org.apache.poi.hpsf.MarkUnsupportedException; +import org.apache.poi.hpsf.NoPropertySetStreamException; +import org.apache.poi.hpsf.PropertySet; +import org.apache.poi.hpsf.PropertySetFactory; +import org.apache.poi.hpsf.SummaryInformation; +import org.apache.poi.hpsf.UnexpectedPropertySetTypeException; + +/** + *

    Test case for OLE2 files with empty properties. An empty property's type + * is {@link Variant.VT_EMPTY}.

    + * + * @author Rainer Klute <klute@rainer-klute.de> + * @since 2003-07-25 + * @version $Id$ + */ +public class TestEmptyProperties extends TestCase +{ + + /** + *

    This test file's summary information stream contains some empty + * properties.

    + */ + static final String POI_FS = "TestCorel.shw"; + + static final String[] POI_FILES = new String[] + { + "PerfectOffice_MAIN", + "\005SummaryInformation", + "Main" + }; + + POIFile[] poiFiles; + + + + /** + *

    Constructor

    + * + * @param name The name of the test case + */ + public TestEmptyProperties(final String name) + { + super(name); + } + + + + /** + *

    Read a the test file from the "data" directory.

    + * + * @exception FileNotFoundException if the file containing the test data + * does not exist + * @exception IOException if an I/O exception occurs + */ + public void setUp() throws FileNotFoundException, IOException + { + final File dataDir = + new File(System.getProperty("HPSF.testdata.path")); + final File data = new File(dataDir, POI_FS); + + poiFiles = Util.readPOIFiles(data); + } + + + + /** + *

    Checks the names of the files in the POI filesystem. They + * are expected to be in a certain order.

    + * + * @exception IOException if an I/O exception occurs + */ + public void testReadFiles() throws IOException + { + String[] expected = POI_FILES; + for (int i = 0; i < expected.length; i++) + Assert.assertEquals(poiFiles[i].getName(), expected[i]); + } + + + + /** + *

    Tests whether property sets can be created from the POI + * files in the POI file system. This test case expects the first + * file to be a {@link SummaryInformation}, the second file to be + * a {@link DocumentSummaryInformation} and the rest to be no + * property sets. In the latter cases a {@link + * NoPropertySetStreamException} will be thrown when trying to + * create a {@link PropertySet}.

    + * + * @exception IOException if an I/O exception occurs + */ + public void testCreatePropertySets() throws IOException + { + Class[] expected = new Class[] + { + NoPropertySetStreamException.class, + SummaryInformation.class, + NoPropertySetStreamException.class + }; + for (int i = 0; i < expected.length; i++) + { + InputStream in = new ByteArrayInputStream(poiFiles[i].getBytes()); + Object o; + try + { + o = PropertySetFactory.create(in); + } + catch (NoPropertySetStreamException ex) + { + o = ex; + } + catch (UnexpectedPropertySetTypeException ex) + { + o = ex; + } + catch (MarkUnsupportedException ex) + { + o = ex; + } + in.close(); + Assert.assertEquals(o.getClass(), expected[i]); + } + } + + + + /** + *

    Tests the {@link PropertySet} methods. The test file has two + * property sets: the first one is a {@link SummaryInformation}, + * the second one is a {@link DocumentSummaryInformation}.

    + * + * @exception IOException if an I/O exception occurs + * @exception HPSFException if an HPSF operation fails + */ + public void testPropertySetMethods() throws IOException, HPSFException + { + byte[] b = poiFiles[1].getBytes(); + PropertySet ps = + PropertySetFactory.create(new ByteArrayInputStream(b)); + SummaryInformation s = (SummaryInformation) ps; + assertNull(s.getTitle()); + assertNull(s.getSubject()); + assertNotNull(s.getAuthor()); + assertNull(s.getKeywords()); + assertNull(s.getComments()); + assertNotNull(s.getTemplate()); + assertNotNull(s.getLastAuthor()); + assertNotNull(s.getRevNumber()); + assertNull(s.getEditTime()); + assertNull(s.getLastPrinted()); + assertNull(s.getCreateDateTime()); + assertNull(s.getLastSaveDateTime()); + assertEquals(s.getPageCount(), 0); + assertEquals(s.getWordCount(), 0); + assertEquals(s.getCharCount(), 0); + assertNull(s.getThumbnail()); + assertNull(s.getApplicationName()); + } + + + + /** + *

    Runs the test cases stand-alone.

    + * + * @param args the command-line arguments (unused) + * + * @exception Throwable if any exception or error occurs + */ + public static void main(final String[] args) throws Throwable + { + System.setProperty("HPSF.testdata.path", + "./src/testcases/org/apache/poi/hpsf/data"); + junit.textui.TestRunner.run(TestBasic.class); + } + +} diff --git a/src/testcases/org/apache/poi/hpsf/basic/TestUnicode.java b/src/testcases/org/apache/poi/hpsf/basic/TestUnicode.java index b2c7b2ab50..cf3b351cc6 100644 --- a/src/testcases/org/apache/poi/hpsf/basic/TestUnicode.java +++ b/src/testcases/org/apache/poi/hpsf/basic/TestUnicode.java @@ -54,10 +54,18 @@ package org.apache.poi.hpsf.basic; -import java.io.*; -import java.util.*; -import junit.framework.*; -import org.apache.poi.hpsf.*; +import java.io.ByteArrayInputStream; +import java.io.File; +import java.io.FileNotFoundException; +import java.io.IOException; + +import junit.framework.Assert; +import junit.framework.TestCase; + +import org.apache.poi.hpsf.HPSFException; +import org.apache.poi.hpsf.PropertySet; +import org.apache.poi.hpsf.PropertySetFactory; +import org.apache.poi.hpsf.Section; @@ -72,17 +80,22 @@ import org.apache.poi.hpsf.*; public class TestUnicode extends TestCase { - final static String POI_FS = "TestUnicode.xls"; - final static String[] POI_FILES = new String[] - { - "\005DocumentSummaryInformation", - }; + static final String POI_FS = "TestUnicode.xls"; + static final String[] POI_FILES = new String[] + { + "\005DocumentSummaryInformation", + }; File data; POIFile[] poiFiles; - public TestUnicode(String name) + /** + *

    Constructor

    + * + * @param name the test case's name + */ + public TestUnicode(final String name) { super(name); } @@ -92,11 +105,11 @@ public class TestUnicode extends TestCase /** *

    Read a the test file from the "data" directory.

    */ - public void setUp() throws FileNotFoundException, IOException + protected void setUp() throws FileNotFoundException, IOException { - final File dataDir = - new File(System.getProperty("HPSF.testdata.path")); - data = new File(dataDir, POI_FS); + final File dataDir = + new File(System.getProperty("HPSF.testdata.path")); + data = new File(dataDir, POI_FS); } @@ -108,23 +121,23 @@ public class TestUnicode extends TestCase */ public void testPropertySetMethods() throws IOException, HPSFException { - POIFile poiFile = Util.readPOIFiles(data, POI_FILES)[0]; - byte[] b = poiFile.getBytes(); - PropertySet ps = - PropertySetFactory.create(new ByteArrayInputStream(b)); - Assert.assertTrue(ps.isDocumentSummaryInformation()); - Assert.assertEquals(ps.getSectionCount(), 2); - Section s = (Section) ps.getSections().get(1); - Assert.assertEquals(s.getProperty(1), - new Integer(1200)); - Assert.assertEquals(s.getProperty(2), - new Long(4198897018l)); - Assert.assertEquals(s.getProperty(3), - "MCon_Info zu Office bei Schreiner"); - Assert.assertEquals(s.getProperty(4), - "petrovitsch@schreiner-online.de"); - Assert.assertEquals(s.getProperty(5), - "Petrovitsch, Wilhelm"); + POIFile poiFile = Util.readPOIFiles(data, POI_FILES)[0]; + byte[] b = poiFile.getBytes(); + PropertySet ps = + PropertySetFactory.create(new ByteArrayInputStream(b)); + Assert.assertTrue(ps.isDocumentSummaryInformation()); + Assert.assertEquals(ps.getSectionCount(), 2); + Section s = (Section) ps.getSections().get(1); + Assert.assertEquals(s.getProperty(1), + new Integer(1200)); + Assert.assertEquals(s.getProperty(2), + new Long(4198897018L)); + Assert.assertEquals(s.getProperty(3), + "MCon_Info zu Office bei Schreiner"); + Assert.assertEquals(s.getProperty(4), + "petrovitsch@schreiner-online.de"); + Assert.assertEquals(s.getProperty(5), + "Petrovitsch, Wilhelm"); } @@ -132,10 +145,10 @@ public class TestUnicode extends TestCase /** *

    Runs the test cases stand-alone.

    */ - public static void main(String[] args) + public static void main(final String[] args) { - System.setProperty("HPSF.testdata.path", - "./src/testcases/org/apache/poi/hpsf/data"); + System.setProperty("HPSF.testdata.path", + "./src/testcases/org/apache/poi/hpsf/data"); junit.textui.TestRunner.run(TestUnicode.class); } diff --git a/src/testcases/org/apache/poi/hpsf/basic/Util.java b/src/testcases/org/apache/poi/hpsf/basic/Util.java index 87aaf216a7..7afd37194f 100644 --- a/src/testcases/org/apache/poi/hpsf/basic/Util.java +++ b/src/testcases/org/apache/poi/hpsf/basic/Util.java @@ -54,9 +54,24 @@ package org.apache.poi.hpsf.basic; -import java.io.*; -import java.util.*; -import org.apache.poi.poifs.eventfilesystem.*; +import java.io.ByteArrayOutputStream; +import java.io.EOFException; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Iterator; +import java.util.LinkedList; +import java.util.List; +import java.util.Properties; + +import org.apache.poi.poifs.eventfilesystem.POIFSReader; +import org.apache.poi.poifs.eventfilesystem.POIFSReaderEvent; +import org.apache.poi.poifs.eventfilesystem.POIFSReaderListener; @@ -73,6 +88,9 @@ public class Util /** *

    Reads bytes from an input stream and writes them to an * output stream until end of file is encountered.

    + * + * @param in the input stream to read from + * @param out the output stream to write to */ public static void copy(final InputStream in, final OutputStream out) throws IOException @@ -88,8 +106,8 @@ public class Util read = in.read(b, 0, BUF_SIZE); if (read > 0) out.write(b, 0, read); - else - eof = true; + else + eof = true; } catch (EOFException ex) { @@ -106,16 +124,16 @@ public class Util * into memory and thus does not cope well with large POI * filessystems.

    * - * @param file The name of the POI filesystem as seen by the + * @param poiFs The name of the POI filesystem as seen by the * operating system. (This is the "filename".) * * @return The POI files. The elements are ordered in the same way * as the files in the POI filesystem. */ public static POIFile[] readPOIFiles(final File poiFs) - throws FileNotFoundException, IOException + throws FileNotFoundException, IOException { - return readPOIFiles(poiFs, null); + return readPOIFiles(poiFs, null); } @@ -126,7 +144,7 @@ public class Util * files into memory and thus does not cope well with large POI * filessystems.

    * - * @param file The name of the POI filesystem as seen by the + * @param poiFs The name of the POI filesystem as seen by the * operating system. (This is the "filename".) * * @param poiFiles The names of the POI files to be read. @@ -135,50 +153,49 @@ public class Util * as the files in the POI filesystem. */ public static POIFile[] readPOIFiles(final File poiFs, - final String[] poiFiles) - throws FileNotFoundException, IOException + final String[] poiFiles) + throws FileNotFoundException, IOException { - final List files = new ArrayList(); - POIFSReader r = new POIFSReader(); - POIFSReaderListener pfl = new POIFSReaderListener() - { - public void processPOIFSReaderEvent(POIFSReaderEvent event) - { - try - { - POIFile f = new POIFile(); - f.setName(event.getName()); - f.setPath(event.getPath()); - InputStream in = event.getStream(); - ByteArrayOutputStream out = - new ByteArrayOutputStream(); - Util.copy(in, out); - out.close(); - f.setBytes(out.toByteArray()); - files.add(f); - } - catch (IOException ex) - { - ex.printStackTrace(); - throw new RuntimeException(ex.getMessage()); - } - } - }; - if (poiFiles == null) - /* Register the listener for all POI files. */ - r.registerListener(pfl); - else - /* Register the listener for the specified POI files - * only. */ - for (int i = 0; i < poiFiles.length; i++) - r.registerListener(pfl, poiFiles[i]); + final List files = new ArrayList(); + POIFSReader r = new POIFSReader(); + POIFSReaderListener pfl = new POIFSReaderListener() + { + public void processPOIFSReaderEvent(final POIFSReaderEvent event) + { + try + { + POIFile f = new POIFile(); + f.setName(event.getName()); + f.setPath(event.getPath()); + InputStream in = event.getStream(); + ByteArrayOutputStream out = new ByteArrayOutputStream(); + Util.copy(in, out); + out.close(); + f.setBytes(out.toByteArray()); + files.add(f); + } + catch (IOException ex) + { + ex.printStackTrace(); + throw new RuntimeException(ex.getMessage()); + } + } + }; + if (poiFiles == null) + /* Register the listener for all POI files. */ + r.registerListener(pfl); + else + /* Register the listener for the specified POI files + * only. */ + for (int i = 0; i < poiFiles.length; i++) + r.registerListener(pfl, poiFiles[i]); - /* Read the POI filesystem. */ - r.read(new FileInputStream(poiFs)); - POIFile[] result = new POIFile[files.size()]; - for (int i = 0; i < result.length; i++) - result[i] = (POIFile) files.get(i); - return result; + /* Read the POI filesystem. */ + r.read(new FileInputStream(poiFs)); + POIFile[] result = new POIFile[files.size()]; + for (int i = 0; i < result.length; i++) + result[i] = (POIFile) files.get(i); + return result; } @@ -188,19 +205,19 @@ public class Util */ public static void printSystemProperties() { - Properties p = System.getProperties(); - List names = new LinkedList(); - for (Iterator i = p.keySet().iterator(); i.hasNext();) - names.add(i.next()); - Collections.sort(names); - for (Iterator i = names.iterator(); i.hasNext();) + final Properties p = System.getProperties(); + final List names = new LinkedList(); + for (Iterator i = p.keySet().iterator(); i.hasNext();) + names.add(i.next()); + Collections.sort(names); + for (final Iterator i = names.iterator(); i.hasNext();) { - String name = (String) i.next(); - String value = (String) p.get(name); - System.out.println(name + ": " + value); - } - System.out.println("Current directory: " + - System.getProperty("user.dir")); + String name = (String) i.next(); + String value = (String) p.get(name); + System.out.println(name + ": " + value); + } + System.out.println("Current directory: " + + System.getProperty("user.dir")); } } diff --git a/src/testcases/org/apache/poi/hpsf/data/TestCorel.shw b/src/testcases/org/apache/poi/hpsf/data/TestCorel.shw new file mode 100755 index 0000000000..e0af1945e8 Binary files /dev/null and b/src/testcases/org/apache/poi/hpsf/data/TestCorel.shw differ diff --git a/src/testcases/org/apache/poi/hssf/data/12561-1.xls b/src/testcases/org/apache/poi/hssf/data/12561-1.xls new file mode 100755 index 0000000000..40b7276cb8 Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/12561-1.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/12561-2.xls b/src/testcases/org/apache/poi/hssf/data/12561-2.xls new file mode 100755 index 0000000000..bb360c1ab4 Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/12561-2.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/12843-1.xls b/src/testcases/org/apache/poi/hssf/data/12843-1.xls new file mode 100644 index 0000000000..0ef5df4264 Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/12843-1.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/12843-2.xls b/src/testcases/org/apache/poi/hssf/data/12843-2.xls new file mode 100644 index 0000000000..beff64650f Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/12843-2.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/13224.xls b/src/testcases/org/apache/poi/hssf/data/13224.xls new file mode 100755 index 0000000000..81f69d3334 Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/13224.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/13796.xls b/src/testcases/org/apache/poi/hssf/data/13796.xls new file mode 100644 index 0000000000..efae53f48d Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/13796.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/14330-1.xls b/src/testcases/org/apache/poi/hssf/data/14330-1.xls new file mode 100644 index 0000000000..6fd2d9524a Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/14330-1.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/14330-2.xls b/src/testcases/org/apache/poi/hssf/data/14330-2.xls new file mode 100644 index 0000000000..8e56a6df3d Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/14330-2.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/14460.xls b/src/testcases/org/apache/poi/hssf/data/14460.xls new file mode 100644 index 0000000000..284d684613 Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/14460.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/15228.xls b/src/testcases/org/apache/poi/hssf/data/15228.xls new file mode 100644 index 0000000000..3b26ed1e90 Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/15228.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/15375.xls b/src/testcases/org/apache/poi/hssf/data/15375.xls new file mode 100644 index 0000000000..99ab193be6 Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/15375.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/15556.xls b/src/testcases/org/apache/poi/hssf/data/15556.xls new file mode 100644 index 0000000000..82b48a55bc Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/15556.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/19599-1.xls b/src/testcases/org/apache/poi/hssf/data/19599-1.xls new file mode 100644 index 0000000000..4ce27d1fb7 Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/19599-1.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/19599-2.xls b/src/testcases/org/apache/poi/hssf/data/19599-2.xls new file mode 100644 index 0000000000..17f45839dd Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/19599-2.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/22742.xls b/src/testcases/org/apache/poi/hssf/data/22742.xls new file mode 100644 index 0000000000..cd367ca9b6 Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/22742.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/24215.xls b/src/testcases/org/apache/poi/hssf/data/24215.xls new file mode 100644 index 0000000000..bcbbe63121 Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/24215.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/EmbeddedChartHeaderTest.xls b/src/testcases/org/apache/poi/hssf/data/EmbeddedChartHeaderTest.xls new file mode 100644 index 0000000000..af0cb2276e Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/EmbeddedChartHeaderTest.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/SquareMacro.xls b/src/testcases/org/apache/poi/hssf/data/SquareMacro.xls new file mode 100644 index 0000000000..54beeeb37e Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/SquareMacro.xls differ diff --git a/src/testcases/org/apache/poi/hssf/data/blankworkbook.xls b/src/testcases/org/apache/poi/hssf/data/blankworkbook.xls new file mode 100644 index 0000000000..fcf734d6a8 Binary files /dev/null and b/src/testcases/org/apache/poi/hssf/data/blankworkbook.xls differ diff --git a/src/testcases/org/apache/poi/hssf/model/SheetTest.java b/src/testcases/org/apache/poi/hssf/model/SheetTest.java index 9a78fd63c9..0b2723cacd 100644 --- a/src/testcases/org/apache/poi/hssf/model/SheetTest.java +++ b/src/testcases/org/apache/poi/hssf/model/SheetTest.java @@ -7,6 +7,7 @@ import java.util.List; import junit.framework.TestCase; import org.apache.poi.hssf.record.ColumnInfoRecord; +import org.apache.poi.hssf.record.MergeCellsRecord; import org.apache.poi.hssf.record.RowRecord; import org.apache.poi.hssf.record.StringRecord; @@ -71,6 +72,31 @@ public class SheetTest extends TestCase assertTrue("Expected " + recordsRemoved + " record to be removed from the starting " + records + ". Currently there are " + sheet.getRecords().size() + " records", records - sheet.getRecords().size() == recordsRemoved); } + /** + * Bug: 22922 (Reported by Xuemin Guan) + *

    + * Remove mergedregion fails when a sheet loses records after an initial CreateSheet + * fills up the records. + * + */ + public void testMovingMergedRegion() { + List records = new ArrayList(); + + MergeCellsRecord merged = new MergeCellsRecord(); + merged.addArea(0, (short)0, 1, (short)2); + records.add(new RowRecord()); + records.add(new RowRecord()); + records.add(new RowRecord()); + records.add(merged); + + Sheet sheet = Sheet.createSheet(records, 0); + sheet.records.remove(0); + + //stub object to throw off list INDEX operations + sheet.removeMergedRegion(0); + assertEquals("Should be no more merged regions", 0, sheet.getNumMergedRegions()); + } + public void testGetMergedRegionAt() { //TODO @@ -147,13 +173,6 @@ public class SheetTest extends TestCase } - - public static void main(String [] args) { - System.out - .println("Testing : "+SheetTest.class.getName()); - junit.textui.TestRunner.run(SheetTest.class); - } - } diff --git a/src/testcases/org/apache/poi/hssf/model/TestFormulaParser.java b/src/testcases/org/apache/poi/hssf/model/TestFormulaParser.java index c4722a9a73..b45f48f375 100644 --- a/src/testcases/org/apache/poi/hssf/model/TestFormulaParser.java +++ b/src/testcases/org/apache/poi/hssf/model/TestFormulaParser.java @@ -56,7 +56,6 @@ package org.apache.poi.hssf.model; import junit.framework.TestCase; import org.apache.poi.hssf.record.formula.*; -import org.apache.poi.hssf.util.SheetReferences; /** * Test the low level formula parser functionality. High level tests are to @@ -145,7 +144,7 @@ public class TestFormulaParser extends TestCase { assertEquals(true, flag.getValue()); assertEquals("Y", y.getValue()); assertEquals("N", n.getValue()); - assertEquals("IF", funif.toFormulaString(new SheetReferences())); + assertEquals("IF", funif.toFormulaString((Workbook) null)); assertTrue("Goto ptg exists", goto1.isGoto()); } @@ -285,6 +284,36 @@ public class TestFormulaParser extends TestCase { } + public void testMacroFunction() { + Workbook w = new Workbook(); + FormulaParser fp = new FormulaParser("FOO()", w); + fp.parse(); + Ptg[] ptg = fp.getRPNPtg(); + + AbstractFunctionPtg tfunc = (AbstractFunctionPtg) ptg[0]; + assertEquals("externalflag", tfunc.getName()); + + NamePtg tname = (NamePtg) ptg[1]; + assertEquals("FOO", tname.toFormulaString(w)); + } + + public void testEmbeddedSlash() { + FormulaParser fp = new FormulaParser("HYPERLINK(\"http://www.jakarta.org\",\"Jakarta\");",null); + fp.parse(); + Ptg[] ptg = fp.getRPNPtg(); + assertTrue("first ptg is string",ptg[0] instanceof StringPtg); + assertTrue("second ptg is string",ptg[1] instanceof StringPtg); + + } + + public void testConcatenate(){ + FormulaParser fp = new FormulaParser("CONCATENATE(\"first\",\"second\")",null); + fp.parse(); + Ptg[] ptg = fp.getRPNPtg(); + assertTrue("first ptg is string",ptg[0] instanceof StringPtg); + assertTrue("second ptg is string",ptg[1] instanceof StringPtg); + } + public static void main(String [] args) { System.out.println("Testing org.apache.poi.hssf.record.formula.FormulaParser"); junit.textui.TestRunner.run(TestFormulaParser.class); diff --git a/src/testcases/org/apache/poi/hssf/record/TestBoundSheetRecord.java b/src/testcases/org/apache/poi/hssf/record/TestBoundSheetRecord.java index 2058c2f9e1..4ca6075354 100644 --- a/src/testcases/org/apache/poi/hssf/record/TestBoundSheetRecord.java +++ b/src/testcases/org/apache/poi/hssf/record/TestBoundSheetRecord.java @@ -92,5 +92,25 @@ public class TestBoundSheetRecord assertEquals(" 2 + 2 + 4 + 2 + 1 + 1 + len(str) * 2", 24, record.getRecordSize()); } + + public void testName() { + BoundSheetRecord record = new BoundSheetRecord(); + record.setSheetname("1234567890223456789032345678904"); + assertTrue("Success", true); + try { + record.setSheetname("12345678902234567890323456789042"); + assertTrue("Should have thrown IllegalArgumentException, but didnt", false); + } catch (IllegalArgumentException e) { + assertTrue("succefully threw exception",true); + } + + try { + record.setSheetname("s//*s"); + assertTrue("Should have thrown IllegalArgumentException, but didnt", false); + } catch (IllegalArgumentException e) { + assertTrue("succefully threw exception",true); + } + + } } diff --git a/src/testcases/org/apache/poi/hssf/record/TestSSTDeserializer.java b/src/testcases/org/apache/poi/hssf/record/TestSSTDeserializer.java index 6272653202..a506e37c11 100644 --- a/src/testcases/org/apache/poi/hssf/record/TestSSTDeserializer.java +++ b/src/testcases/org/apache/poi/hssf/record/TestSSTDeserializer.java @@ -88,7 +88,7 @@ public class TestSSTDeserializer byte[] bytes = HexRead.readData( _test_file_path + File.separator + "richtextdata.txt", "header" ); BinaryTree strings = new BinaryTree(); SSTDeserializer deserializer = new SSTDeserializer( strings ); - deserializer.manufactureStrings( bytes, 0, (short)bytes.length ); + deserializer.manufactureStrings( bytes, 0); byte[] continueBytes = HexRead.readData( _test_file_path + File.separator + "richtextdata.txt", "continue1" ); deserializer.processContinueRecord( continueBytes ); @@ -101,7 +101,7 @@ public class TestSSTDeserializer byte[] bytes = HexRead.readData( _test_file_path + File.separator + "evencontinuation.txt", "header" ); BinaryTree strings = new BinaryTree(); SSTDeserializer deserializer = new SSTDeserializer( strings ); - deserializer.manufactureStrings( bytes, 0, (short)bytes.length ); + deserializer.manufactureStrings( bytes, 0); byte[] continueBytes = HexRead.readData( _test_file_path + File.separator + "evencontinuation.txt", "continue1" ); deserializer.processContinueRecord( continueBytes ); @@ -119,7 +119,7 @@ public class TestSSTDeserializer byte[] bytes = HexRead.readData( _test_file_path + File.separator + "stringacross2continuations.txt", "header" ); BinaryTree strings = new BinaryTree(); SSTDeserializer deserializer = new SSTDeserializer( strings ); - deserializer.manufactureStrings( bytes, 0, (short)bytes.length ); + deserializer.manufactureStrings( bytes, 0); bytes = HexRead.readData( _test_file_path + File.separator + "stringacross2continuations.txt", "continue1" ); deserializer.processContinueRecord( bytes ); bytes = HexRead.readData( _test_file_path + File.separator + "stringacross2continuations.txt", "continue2" ); @@ -136,7 +136,7 @@ public class TestSSTDeserializer byte[] bytes = HexRead.readData( _test_file_path + File.separator + "extendedtextstrings.txt", "rich-header" ); BinaryTree strings = new BinaryTree(); SSTDeserializer deserializer = new SSTDeserializer( strings ); - deserializer.manufactureStrings( bytes, 0, (short)bytes.length ); + deserializer.manufactureStrings( bytes, 0); byte[] continueBytes = HexRead.readData( _test_file_path + File.separator + "extendedtextstrings.txt", "rich-continue1" ); deserializer.processContinueRecord( continueBytes ); @@ -146,7 +146,7 @@ public class TestSSTDeserializer bytes = HexRead.readData( _test_file_path + File.separator + "extendedtextstrings.txt", "norich-header" ); strings = new BinaryTree(); deserializer = new SSTDeserializer( strings ); - deserializer.manufactureStrings( bytes, 0, (short)bytes.length ); + deserializer.manufactureStrings( bytes, 0); continueBytes = HexRead.readData( _test_file_path + File.separator + "extendedtextstrings.txt", "norich-continue1" ); deserializer.processContinueRecord( continueBytes ); diff --git a/src/testcases/org/apache/poi/hssf/record/TestSSTRecord.java b/src/testcases/org/apache/poi/hssf/record/TestSSTRecord.java index 24105993dd..747868c98a 100644 --- a/src/testcases/org/apache/poi/hssf/record/TestSSTRecord.java +++ b/src/testcases/org/apache/poi/hssf/record/TestSSTRecord.java @@ -429,7 +429,7 @@ public class TestSSTRecord assertEquals( 1464, record.getNumStrings() ); assertEquals( 688, record.getNumUniqueStrings() ); assertEquals( 492, record.countStrings() ); - assertEquals( 1, record.getDeserializer().getContinuationExpectedChars() ); +//jmh assertEquals( 1, record.getDeserializer().getContinuationExpectedChars() ); assertEquals( "Consolidated B-24J Liberator The Dragon & His Tai", record.getDeserializer().getUnfinishedString() ); // assertEquals( 52, record.getDeserializer().getTotalLength() ); @@ -448,7 +448,7 @@ public class TestSSTRecord assertEquals( 0, record.getNumStrings() ); assertEquals( 0, record.getNumUniqueStrings() ); assertEquals( 0, record.countStrings() ); - assertEquals( 0, record.getDeserializer().getContinuationExpectedChars() ); + assertEquals( 0, record.getDeserializer().getContinuationCharsRead() ); assertEquals( "", record.getDeserializer().getUnfinishedString() ); // assertEquals( 0, record.getDeserializer().getTotalLength() ); // assertEquals( 0, record.getDeserializer().getStringDataOffset() ); diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestBugs.java b/src/testcases/org/apache/poi/hssf/usermodel/TestBugs.java new file mode 100644 index 0000000000..b43d5c6c1b --- /dev/null +++ b/src/testcases/org/apache/poi/hssf/usermodel/TestBugs.java @@ -0,0 +1,413 @@ +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2003, 2003 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache POI" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache POI", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + +package org.apache.poi.hssf.usermodel; + +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.util.Date; + +import junit.framework.TestCase; + + + +/** + * Testcases for bugs entered in bugzilla + * the Test name contains the bugzilla bug id + * @author Avik Sengupta + */ + +public class TestBugs +extends TestCase { + public TestBugs(String s) { + super(s); + } + + /** Test reading AND writing a complicated workbook + *Test opening resulting sheet in excel*/ + public void test15228() + throws java.io.IOException { + String readFilename = System.getProperty("HSSF.testdata.path"); + FileInputStream in = new FileInputStream(readFilename+File.separator+"15228.xls"); + HSSFWorkbook wb = new HSSFWorkbook(in); + HSSFSheet s = wb.getSheetAt(0); + HSSFRow r = s.createRow(0); + HSSFCell c = r.createCell((short)0); + c.setCellValue(10); + File file = File.createTempFile("test15228",".xls"); + FileOutputStream out = new FileOutputStream(file); + wb.write(out); + assertTrue("No exception thrown", true); + assertTrue("File Should Exist", file.exists()); + + } + + public void test13796() + throws java.io.IOException { + String readFilename = System.getProperty("HSSF.testdata.path"); + FileInputStream in = new FileInputStream(readFilename+File.separator+"13796.xls"); + HSSFWorkbook wb = new HSSFWorkbook(in); + HSSFSheet s = wb.getSheetAt(0); + HSSFRow r = s.createRow(0); + HSSFCell c = r.createCell((short)0); + c.setCellValue(10); + File file = File.createTempFile("test13796",".xls"); + FileOutputStream out = new FileOutputStream(file); + wb.write(out); + assertTrue("No exception thrown", true); + assertTrue("File Should Exist", file.exists()); + + } + /**Test writing a hyperlink + * Open resulting sheet in Excel and check that A1 contains a hyperlink*/ + public void test23094() throws Exception { + File file = File.createTempFile("test23094",".xls"); + FileOutputStream out = new FileOutputStream(file); + HSSFWorkbook wb = new HSSFWorkbook(); + HSSFSheet s = wb.createSheet(); + HSSFRow r = s.createRow(0); + r.createCell((short)0).setCellFormula("HYPERLINK( \"http://jakarta.apache.org\", \"Jakarta\" )"); + assertTrue("No Exception expected",true); + wb.write(out); + out.close(); + } + + /* test hyperlinks + * open resulting file in excel, and check that there is a link to Google + **/ + public void test15353() throws Exception { + HSSFWorkbook wb = new HSSFWorkbook(); + HSSFSheet sheet = wb.createSheet("My sheet"); + + HSSFRow row = sheet.createRow( (short) 0 ); + HSSFCell cell = row.createCell( (short) 0 ); + cell.setCellFormula("HYPERLINK(\"http://google.com\",\"Google\")"); + + // Write out the workbook + File f = File.createTempFile("test15353",".xls"); + FileOutputStream fileOut = new FileOutputStream(f); + wb.write(fileOut); + fileOut.close(); + } + + /** test reading of a formula with a name and a cell ref in one + **/ + public void test14460() throws Exception { + String filename = System.getProperty("HSSF.testdata.path"); + filename=filename+"/14460.xls"; + FileInputStream in = new FileInputStream(filename); + HSSFWorkbook wb = new HSSFWorkbook(in); + HSSFSheet sheet = wb.getSheetAt(0); + assertTrue("No exception throws", true); + } + + public void test14330() throws Exception { + String filedir = System.getProperty("HSSF.testdata.path"); + String filename=filedir+"/14330-1.xls"; + FileInputStream in = new FileInputStream(filename); + HSSFWorkbook wb = new HSSFWorkbook(in); + HSSFSheet sheet = wb.getSheetAt(0); + + filename=filedir+"/14330-2.xls"; + in = new FileInputStream(filename); + wb = new HSSFWorkbook(in); + sheet = wb.getSheetAt(0); + assertTrue("No exception throws", true); + } + + /** test rewriting a file with large number of unique strings + *open resulting file in Excel to check results!*/ + public void test15375() { + + try { + String filename = System.getProperty("HSSF.testdata.path"); + filename=filename+"/15375.xls"; + FileInputStream in = new FileInputStream(filename); + HSSFWorkbook wb = new HSSFWorkbook(in); + HSSFSheet sheet = wb.getSheetAt(0); + + HSSFRow row = sheet.getRow(5); + HSSFCell cell = row.getCell((short)3); + if (cell == null) + cell = row.createCell((short)3); + + // Write test + cell.setCellType(HSSFCell.CELL_TYPE_STRING); + cell.setCellValue("a test"); + + // change existing numeric cell value + + HSSFRow oRow = sheet.getRow(14); + HSSFCell oCell = oRow.getCell((short)4); + oCell.setCellValue(75); + oCell = oRow.getCell((short)5); + oCell.setCellValue("0.3"); + + // Write the output to a file + File f = File.createTempFile("test15375",".xls"); + FileOutputStream fileOut = new FileOutputStream(f); + wb.write(fileOut); + fileOut.close(); + } + catch (java.io.FileNotFoundException ex) { + ex.printStackTrace(); + } + catch (java.io.IOException ex) { + ex.printStackTrace(); + } + + } + + /** test writing a file with large number of unique strings + *open resulting file in Excel to check results!*/ + + public void test15375_2() throws Exception{ + + + HSSFWorkbook wb = new HSSFWorkbook(); + HSSFSheet sheet = wb.createSheet(); + + String tmp1 = null; + String tmp2 = null; + String tmp3 = null; + + for (int i = 0; i < 6000; i++) { + tmp1 = "Test1" + i; + tmp2 = "Test2" + i; + tmp3 = "Test3" + i; + + HSSFRow row = sheet.createRow((short)i); + + HSSFCell cell = row.createCell((short)0); + cell.setCellValue(tmp1); + cell = row.createCell((short)1); + cell.setCellValue(tmp2); + cell = row.createCell((short)2); + cell.setCellValue(tmp3); + } + File f = File.createTempFile("test15375-2",".xls"); + FileOutputStream fileOut = new FileOutputStream(f); + wb.write(fileOut); + fileOut.close(); + } + /** another test for the number of unique strings issue + *test opening the resulting file in Excel*/ + public void test22568() { + int r=2000;int c=3; + + HSSFWorkbook wb = new HSSFWorkbook() ; + HSSFSheet sheet = wb.createSheet("ExcelTest") ; + + int col_cnt=0, rw_cnt=0 ; + + col_cnt = c; + rw_cnt = r; + + HSSFRow rw = null ; + HSSFCell cell =null; + rw = sheet.createRow((short)0) ; + //Header row + for(short j=0; j4000\",B1:B5)"; @@ -1060,6 +1060,66 @@ extends TestCase { assertTrue("sumif == 0 bytes", file.length() > 0); } + public void testSquareMacro() throws IOException { + File dir = new File(System.getProperty("HSSF.testdata.path")); + File xls = new File(dir, "SquareMacro.xls"); + FileInputStream in = new FileInputStream(xls); + HSSFWorkbook w; + try { + w = new HSSFWorkbook(in); + } finally { + in.close(); + } + HSSFSheet s0 = w.getSheetAt(0); + HSSFRow[] r = {s0.getRow(0), s0.getRow(1)}; + + HSSFCell a1 = r[0].getCell((short) 0); + assertEquals("square(1)", a1.getCellFormula()); + assertEquals(1d, a1.getNumericCellValue(), 1e-9); + + HSSFCell a2 = r[1].getCell((short) 0); + assertEquals("square(2)", a2.getCellFormula()); + assertEquals(4d, a2.getNumericCellValue(), 1e-9); + + HSSFCell b1 = r[0].getCell((short) 1); + assertEquals("IF(TRUE,square(1))", b1.getCellFormula()); + assertEquals(1d, b1.getNumericCellValue(), 1e-9); + + HSSFCell b2 = r[1].getCell((short) 1); + assertEquals("IF(TRUE,square(2))", b2.getCellFormula()); + assertEquals(4d, b2.getNumericCellValue(), 1e-9); + + HSSFCell c1 = r[0].getCell((short) 2); + assertEquals("square(square(1))", c1.getCellFormula()); + assertEquals(1d, c1.getNumericCellValue(), 1e-9); + + HSSFCell c2 = r[1].getCell((short) 2); + assertEquals("square(square(2))", c2.getCellFormula()); + assertEquals(16d, c2.getNumericCellValue(), 1e-9); + + HSSFCell d1 = r[0].getCell((short) 3); + assertEquals("square(one())", d1.getCellFormula()); + assertEquals(1d, d1.getNumericCellValue(), 1e-9); + + HSSFCell d2 = r[1].getCell((short) 3); + assertEquals("square(two())", d2.getCellFormula()); + assertEquals(4d, d2.getNumericCellValue(), 1e-9); + } + + public void testStringFormulaRead() throws IOException { + File dir = new File(System.getProperty("HSSF.testdata.path")); + File xls = new File(dir, "StringFormulas.xls"); + FileInputStream in = new FileInputStream(xls); + HSSFWorkbook w; + try { + w = new HSSFWorkbook(in); + } finally { + in.close(); + } + HSSFCell c = w.getSheetAt(0).getRow(0).getCell((short)0); + assertEquals("String Cell value","XYZ",c.getStringCellValue()); + } + public static void main(String [] args) { System.out .println("Testing org.apache.poi.hssf.usermodel.TestFormulas"); diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFCell.java b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFCell.java index dcb114cae0..1ad9759808 100644 --- a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFCell.java +++ b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFCell.java @@ -116,7 +116,7 @@ extends TestCase { c=r.createCell((short)2); //c.setCellType(HSSFCell.CELL_TYPE_ERROR); - c.setCellErrorValue((byte)1); + c.setCellErrorValue((byte)7); wb.write(out); @@ -136,7 +136,7 @@ extends TestCase { c = r.getCell((short)1); assertTrue("boolean value 0,1 = 0",c.getErrorCellValue() == 0); c = r.getCell((short)2); - assertTrue("boolean value 0,2 = 1",c.getErrorCellValue() == 1); + assertTrue("boolean value 0,2 = 7",c.getErrorCellValue() == 7); in.close(); } diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFHeaderFooter.java b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFHeaderFooter.java new file mode 100644 index 0000000000..9374c17dcb --- /dev/null +++ b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFHeaderFooter.java @@ -0,0 +1,126 @@ +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2003 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache POI" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache POI", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + +package org.apache.poi.hssf.usermodel; + +import junit.framework.TestCase; +import org.apache.poi.hssf.usermodel.HSSFHeader; +import org.apache.poi.hssf.usermodel.HSSFFooter; +import org.apache.poi.hssf.usermodel.HSSFSheet; +import org.apache.poi.hssf.usermodel.HSSFWorkbook; + +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; + +/** + * Tests row shifting capabilities. + * + * + * @author Shawn Laubach (slaubach at apache dot com) + */ + +public class TestHSSFHeaderFooter extends TestCase { + + /** + * Constructor for TestHeaderFooter. + * @param arg0 + */ + public TestHSSFHeaderFooter(String arg0) { + super(arg0); + } + + /** + * Tests that get header retreives the proper values. + * + * @author Shawn Laubach (slaubach at apache dot org) + */ + public void testRetrieveCorrectHeader() throws Exception + { + // Read initial file in + String filename = System.getProperty( "HSSF.testdata.path" ); + filename = filename + "/EmbeddedChartHeaderTest.xls"; + FileInputStream fin = new FileInputStream( filename ); + HSSFWorkbook wb = new HSSFWorkbook( fin ); + fin.close(); + HSSFSheet s = wb.getSheetAt( 0 ); + HSSFHeader head = s.getHeader(); + + assertEquals("Top Left", head.getLeft()); + assertEquals("Top Center", head.getCenter()); + assertEquals("Top Right", head.getRight()); + } + + /** + * Tests that get header retreives the proper values. + * + * @author Shawn Laubach (slaubach at apache dot org) + */ + public void testRetrieveCorrectFooter() throws Exception + { + // Read initial file in + String filename = System.getProperty( "HSSF.testdata.path" ); + filename = filename + "/EmbeddedChartHeaderTest.xls"; + FileInputStream fin = new FileInputStream( filename ); + HSSFWorkbook wb = new HSSFWorkbook( fin ); + fin.close(); + HSSFSheet s = wb.getSheetAt( 0 ); + HSSFFooter foot = s.getFooter(); + + assertEquals("Bottom Left", foot.getLeft()); + assertEquals("Bottom Center", foot.getCenter()); + assertEquals("Bottom Right", foot.getRight()); + } +} + diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFSheet.java b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFSheet.java index 8e58186b55..3779f3a781 100644 --- a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFSheet.java +++ b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFSheet.java @@ -54,18 +54,21 @@ package org.apache.poi.hssf.usermodel; -import junit.framework.TestCase; -import org.apache.poi.hssf.model.Sheet; -import org.apache.poi.hssf.record.HCenterRecord; -import org.apache.poi.hssf.record.VCenterRecord; -import org.apache.poi.hssf.record.WSBoolRecord; -import org.apache.poi.hssf.record.SCLRecord; -import org.apache.poi.hssf.record.WindowTwoRecord; - import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; +import junit.framework.TestCase; + +import org.apache.poi.hssf.model.Sheet; +import org.apache.poi.hssf.record.HCenterRecord; +import org.apache.poi.hssf.record.ProtectRecord; +import org.apache.poi.hssf.record.SCLRecord; +import org.apache.poi.hssf.record.VCenterRecord; +import org.apache.poi.hssf.record.WSBoolRecord; +import org.apache.poi.hssf.record.WindowTwoRecord; +import org.apache.poi.hssf.util.Region; + /** * Tests HSSFSheet. This test case is very incomplete at the moment. * @@ -236,6 +239,27 @@ public class TestHSSFSheet cell.setCellValue("Difference Check"); assertEquals(cloned.getRow((short)0).getCell((short)0).getStringCellValue(), "clone_test"); } + + /** + * Test that the ProtectRecord is included when creating or cloning a sheet + */ + public void testProtect() { + HSSFWorkbook workbook = new HSSFWorkbook(); + HSSFSheet hssfSheet = workbook.createSheet(); + Sheet sheet = hssfSheet.getSheet(); + ProtectRecord protect = sheet.getProtect(); + + assertFalse(protect.getProtect()); + + // This will tell us that cloneSheet, and by extension, + // the list forms of createSheet leave us with an accessible + // ProtectRecord. + hssfSheet.setProtect(true); + Sheet cloned = sheet.cloneSheet(); + assertNotNull(cloned.getProtect()); + assertTrue(hssfSheet.getProtect()); + } + public void testZoom() throws Exception @@ -254,4 +278,111 @@ public class TestHSSFSheet assertTrue(sclLoc == window2Loc + 1); } + + + /** + * When removing one merged region, it would break + * + */ + public void testRemoveMerged() { + HSSFWorkbook wb = new HSSFWorkbook(); + HSSFSheet sheet = wb.createSheet(); + Region region = new Region(0, (short)0, 1, (short)1); + sheet.addMergedRegion(region); + region = new Region(1, (short)0, 2, (short)1); + sheet.addMergedRegion(region); + + sheet.removeMergedRegion(0); + + region = sheet.getMergedRegionAt(0); + assertEquals("Left over region should be starting at row 1", 1, region.getRowFrom()); + + sheet.removeMergedRegion(0); + + assertEquals("there should be no merged regions left!", 0, sheet.getNumMergedRegions()); + + //an, add, remove, get(0) would null pointer + sheet.addMergedRegion(region); + assertEquals("there should now be one merged region!", 1, sheet.getNumMergedRegions()); + sheet.removeMergedRegion(0); + assertEquals("there should now be zero merged regions!", 0, sheet.getNumMergedRegions()); + //add it again! + region.setRowTo(4); + + sheet.addMergedRegion(region); + assertEquals("there should now be one merged region!", 1, sheet.getNumMergedRegions()); + + //should exist now! + assertTrue("there isn't more than one merged region in there", 1 <= sheet.getNumMergedRegions()); + region = sheet.getMergedRegionAt(0); + assertEquals("the merged row to doesnt match the one we put in ", 4, region.getRowTo()); + + } + + public void testShiftMerged() { + HSSFWorkbook wb = new HSSFWorkbook(); + HSSFSheet sheet = wb.createSheet(); + HSSFRow row = sheet.createRow(0); + HSSFCell cell = row.createCell((short)0); + cell.setCellValue("first row, first cell"); + + row = sheet.createRow(1); + cell = row.createCell((short)1); + cell.setCellValue("second row, second cell"); + + Region region = new Region(1, (short)0, 1, (short)1); + sheet.addMergedRegion(region); + + sheet.shiftRows(1, 1, 1); + + region = sheet.getMergedRegionAt(0); + assertEquals("Merged region not moved over to row 2", 2, region.getRowFrom()); + + } + + /** + * Tests the display of gridlines, formulas, and rowcolheadings. + * @author Shawn Laubach (slaubach at apache dot org) + */ + public void testDisplayOptions() throws Exception { + HSSFWorkbook wb = new HSSFWorkbook(); + HSSFSheet sheet = wb.createSheet(); + + File tempFile = File.createTempFile("display", "test.xls"); + FileOutputStream stream = new FileOutputStream(tempFile); + wb.write(stream); + stream.close(); + + FileInputStream readStream = new FileInputStream(tempFile); + wb = new HSSFWorkbook(readStream); + sheet = wb.getSheetAt(0); + readStream.close(); + + assertEquals(sheet.isDisplayGridlines(), true); + assertEquals(sheet.isDisplayRowColHeadings(), true); + assertEquals(sheet.isDisplayFormulas(), false); + + sheet.setDisplayGridlines(false); + sheet.setDisplayRowColHeadings(false); + sheet.setDisplayFormulas(true); + + tempFile = File.createTempFile("display", "test.xls"); + stream = new FileOutputStream(tempFile); + wb.write(stream); + stream.close(); + + readStream = new FileInputStream(tempFile); + wb = new HSSFWorkbook(readStream); + sheet = wb.getSheetAt(0); + readStream.close(); + + + assertEquals(sheet.isDisplayGridlines(), false); + assertEquals(sheet.isDisplayRowColHeadings(), false); + assertEquals(sheet.isDisplayFormulas(), true); + } + + public static void main(java.lang.String[] args) { + junit.textui.TestRunner.run(TestHSSFSheet.class); + } } diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestSheetShiftRows.java b/src/testcases/org/apache/poi/hssf/usermodel/TestSheetShiftRows.java index a48fb683fc..e91003e4da 100755 --- a/src/testcases/org/apache/poi/hssf/usermodel/TestSheetShiftRows.java +++ b/src/testcases/org/apache/poi/hssf/usermodel/TestSheetShiftRows.java @@ -175,5 +175,18 @@ public class TestSheetShiftRows extends TestCase { s.createRow(3).createCell((short)0).setCellValue("TEST2"); s.shiftRows(0,4,1); } + + /** + * Tests when shifting the first row. + * + * @author Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot jp) + */ + public void testShiftRow0(){ + HSSFWorkbook b = new HSSFWorkbook(); + HSSFSheet s = b.createSheet(); + s.createRow(0).createCell((short)0).setCellValue("TEST1"); + s.createRow(3).createCell((short)0).setCellValue("TEST2"); + s.shiftRows(0,4,1); + } } diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestWorkbook.java b/src/testcases/org/apache/poi/hssf/usermodel/TestWorkbook.java index c8bc7b86b6..6b5fd97440 100644 --- a/src/testcases/org/apache/poi/hssf/usermodel/TestWorkbook.java +++ b/src/testcases/org/apache/poi/hssf/usermodel/TestWorkbook.java @@ -304,6 +304,8 @@ public class TestWorkbook assertEquals(1.25,cell.getNumericCellValue(), 1e-10); assertEquals(format.getFormat(df), "0.0"); + + assertEquals(format, workbook.createDataFormat()); stream.close(); } diff --git a/src/testcases/org/apache/poi/poifs/filesystem/SlowInputStream.java b/src/testcases/org/apache/poi/poifs/filesystem/SlowInputStream.java new file mode 100644 index 0000000000..efd8c56512 --- /dev/null +++ b/src/testcases/org/apache/poi/poifs/filesystem/SlowInputStream.java @@ -0,0 +1,76 @@ + +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2002 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache POI" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache POI", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + +package org.apache.poi.poifs.filesystem; + +import java.io.*; +import java.util.Random; + +/** + * Returns a random amount of requested data. Used to check conformance with + * InputStream API contracts. + */ +public class SlowInputStream extends FilterInputStream +{ + private Random r = new Random(0); + + public SlowInputStream(InputStream in) { + super(in); + } + + public int read(byte[] b, int off, int len) throws IOException { + return super.read(b, off, r.nextInt(len) + 1); + } +} diff --git a/src/testcases/org/apache/poi/poifs/filesystem/TestDocument.java b/src/testcases/org/apache/poi/poifs/filesystem/TestDocument.java index af417fad16..2e9fd02822 100644 --- a/src/testcases/org/apache/poi/poifs/filesystem/TestDocument.java +++ b/src/testcases/org/apache/poi/poifs/filesystem/TestDocument.java @@ -107,7 +107,7 @@ public class TestDocument { array[ j ] = ( byte ) j; } - document = new POIFSDocument("foo", new ByteArrayInputStream(array)); + document = new POIFSDocument("foo", new SlowInputStream(new ByteArrayInputStream(array))); checkDocument(document, array); // verify correct number of blocks get created for document diff --git a/src/testcases/org/apache/poi/poifs/property/TestDocumentProperty.java b/src/testcases/org/apache/poi/poifs/property/TestDocumentProperty.java index 74a3807562..e677a7983e 100644 --- a/src/testcases/org/apache/poi/poifs/property/TestDocumentProperty.java +++ b/src/testcases/org/apache/poi/poifs/property/TestDocumentProperty.java @@ -150,6 +150,7 @@ public class TestDocumentProperty ( byte ) 0xFE, ( byte ) 0xFF, ( byte ) 0xFF, ( byte ) 0xFF, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, + ( byte ) 0x57, ( byte ) 0x00, ( byte ) 0x6F, ( byte ) 0x00, ( byte ) 0x72, ( byte ) 0x00, ( byte ) 0x6B, ( byte ) 0x00, ( byte ) 0x62, ( byte ) 0x00, ( byte ) 0x6F, ( byte ) 0x00, @@ -182,6 +183,7 @@ public class TestDocumentProperty ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x10, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, + ( byte ) 0x05, ( byte ) 0x00, ( byte ) 0x53, ( byte ) 0x00, ( byte ) 0x75, ( byte ) 0x00, ( byte ) 0x6D, ( byte ) 0x00, ( byte ) 0x6D, ( byte ) 0x00, ( byte ) 0x61, ( byte ) 0x00, @@ -214,6 +216,7 @@ public class TestDocumentProperty ( byte ) 0x08, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x10, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, + ( byte ) 0x05, ( byte ) 0x00, ( byte ) 0x44, ( byte ) 0x00, ( byte ) 0x6F, ( byte ) 0x00, ( byte ) 0x63, ( byte ) 0x00, ( byte ) 0x75, ( byte ) 0x00, ( byte ) 0x6D, ( byte ) 0x00, diff --git a/src/testcases/org/apache/poi/poifs/property/TestRootProperty.java b/src/testcases/org/apache/poi/poifs/property/TestRootProperty.java index 430c521479..8357a0a466 100644 --- a/src/testcases/org/apache/poi/poifs/property/TestRootProperty.java +++ b/src/testcases/org/apache/poi/poifs/property/TestRootProperty.java @@ -217,11 +217,11 @@ public class TestRootProperty ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00, ( byte ) 0x00 }; - verifyReadingProperty(0, input, 0, "Root Entry"); + verifyReadingProperty(0, input, 0, "Root Entry", "{00020820-0000-0000-C000-000000000046}"); } private void verifyReadingProperty(int index, byte [] input, int offset, - String name) + String name, String sClsId) throws IOException { RootProperty property = new RootProperty(index, input, @@ -242,6 +242,7 @@ public class TestRootProperty assertEquals(index, property.getIndex()); assertEquals(name, property.getName()); assertTrue(!property.getChildren().hasNext()); + assertEquals(property.getStorageClsid().toString(), sClsId); } /** diff --git a/src/testcases/org/apache/poi/util/TestHexDump.java b/src/testcases/org/apache/poi/util/TestHexDump.java index 7a86cff764..c8e3ca9e5c 100644 --- a/src/testcases/org/apache/poi/util/TestHexDump.java +++ b/src/testcases/org/apache/poi/util/TestHexDump.java @@ -314,6 +314,9 @@ public class TestHexDump // as expected } + + // verify proper behaviour with a 0 length dump on 0 length dataset + HexDump.dump(new byte[0], 0, new ByteArrayOutputStream(), 0, 0); } public void testToHex()