initial work on supporting calls to add-in functions

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@684971 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/poi/hssf/model/FormulaParser.java

@@ -26,6 +26,7 @@ import org.apache.poi.hssf.record.formula.*;
 import org.apache.poi.hssf.record.formula.function.FunctionMetadata;
 import org.apache.poi.hssf.record.formula.function.FunctionMetadataRegistry;
 import org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator;
+import org.apache.poi.hssf.usermodel.HSSFName;
 import org.apache.poi.hssf.usermodel.HSSFWorkbook;
 import org.apache.poi.hssf.util.AreaReference;
 import org.apache.poi.hssf.util.CellReference;
@@ -369,13 +370,31 @@ public final class FormulaParser {
      * @param name case preserved function name (as it was entered/appeared in the formula).
      */
     private ParseNode function(String name) {
-        NamePtg nameToken = null;
+        Ptg nameToken = null;
-        // Note regarding parameter -
+        if(!AbstractFunctionPtg.isBuiltInFunctionName(name)) {
-        if(!AbstractFunctionPtg.isInternalFunctionName(name)) {
+        	// user defined function
-            // external functions get a Name token which points to a defined name record
-            nameToken = new NamePtg(name, this.book);
-
             // in the token tree, the name is more or less the first argument
+        	
+        
+        	int nameIndex = book.getNameIndex(name);
+        	if (nameIndex >= 0) {
+        		HSSFName hName = book.getNameAt(nameIndex);
+        		if (!hName.isFunctionName()) {
+        			throw new FormulaParseException("Attempt to use name '" + name 
+        					+ "' as a function, but defined name in workbook does not refer to a function");
+        		}
+        		
+        		// calls to user-defined functions within the workbook 
+        		// get a Name token which points to a defined name record
+        		nameToken = new NamePtg(name, this.book);
+        	} else {
+        		
+        		nameToken = book.getNameXPtg(name);
+        		if (nameToken == null) {
+        			throw new FormulaParseException("Name '" + name 
+        					+ "' is completely unknown in the current workbook");
+        		}
+        	}
         }
 
         Match('(');
@@ -389,11 +408,11 @@ public final class FormulaParser {
      * Generates the variable function ptg for the formula.
      * <p>
      * For IF Formulas, additional PTGs are added to the tokens
-     * @param name
+     * @param name a {@link NamePtg} or {@link NameXPtg} or <code>null</code>
      * @param numArgs
      * @return Ptg a null is returned if we're in an IF formula, it needs extreme manipulation and is handled in this function
      */
-    private ParseNode getFunction(String name, NamePtg namePtg, ParseNode[] args) {
+    private ParseNode getFunction(String name, Ptg namePtg, ParseNode[] args) {
 
         FunctionMetadata fm = FunctionMetadataRegistry.getFunctionByName(name.toUpperCase());
         int numArgs = args.length;

src/java/org/apache/poi/hssf/model/LinkTable.java

@@ -25,11 +25,11 @@ import org.apache.poi.hssf.record.CRNCountRecord;
 import org.apache.poi.hssf.record.CRNRecord;
 import org.apache.poi.hssf.record.CountryRecord;
 import org.apache.poi.hssf.record.ExternSheetRecord;
-import org.apache.poi.hssf.record.ExternSheetSubRecord;
 import org.apache.poi.hssf.record.ExternalNameRecord;
 import org.apache.poi.hssf.record.NameRecord;
 import org.apache.poi.hssf.record.Record;
 import org.apache.poi.hssf.record.SupBookRecord;
+import org.apache.poi.hssf.record.formula.NameXPtg;
 
 /**
  * Link Table (OOO pdf reference: 4.10.3 ) <p/>
@@ -122,6 +122,19 @@ final class LinkTable {
 		public String getNameText(int definedNameIndex) {
 			return _externalNameRecords[definedNameIndex].getText();
 		}
+
+		/**
+		 * Performs case-insensitive search
+		 * @return -1 if not found
+		 */
+		public int getIndexOfName(String name) {
+			for (int i = 0; i < _externalNameRecords.length; i++) {
+				if(_externalNameRecords[i].getText().equalsIgnoreCase(name)) {
+					return i;
+				}
+			}
+			return -1;
+		}
 	}
 
 	private final ExternalBookBlock[] _externalBookBlocks;
@@ -270,42 +283,31 @@ final class LinkTable {
 	}
 
 	
-	public short getIndexToSheet(short num) {
+	public int getIndexToSheet(int extRefIndex) {
-		return _externSheetRecord.getREFRecordAt(num).getIndexToFirstSupBook();
+		return _externSheetRecord.getFirstSheetIndexFromRefIndex(extRefIndex);
 	}
 
-	public int getSheetIndexFromExternSheetIndex(int externSheetNumber) {
+	public int getSheetIndexFromExternSheetIndex(int extRefIndex) {
-		if (externSheetNumber >= _externSheetRecord.getNumOfREFStructures()) {
+		if (extRefIndex >= _externSheetRecord.getNumOfRefs()) {
 			return -1;
 		}
-		return _externSheetRecord.getREFRecordAt(externSheetNumber).getIndexToFirstSupBook();
+		return _externSheetRecord.getFirstSheetIndexFromRefIndex(extRefIndex);
 	}
 
-	public short addSheetIndexToExternSheet(short sheetNumber) {
+	public int addSheetIndexToExternSheet(int sheetNumber) {
-
+		// TODO - what about the first parameter (extBookIndex)?
-		ExternSheetSubRecord record = new ExternSheetSubRecord();
+		return _externSheetRecord.addRef(0, sheetNumber, sheetNumber);
-		record.setIndexToFirstSupBook(sheetNumber);
-		record.setIndexToLastSupBook(sheetNumber);
-		_externSheetRecord.addREFRecord(record);
-		_externSheetRecord.setNumOfREFStructures((short)(_externSheetRecord.getNumOfREFStructures() + 1));
-		return (short)(_externSheetRecord.getNumOfREFStructures() - 1);
 	}
 
-	public short checkExternSheet(int sheetNumber) {
+	public short checkExternSheet(int sheetIndex) {
 
 		//Trying to find reference to this sheet
-		int nESRs = _externSheetRecord.getNumOfREFStructures();
+		int i = _externSheetRecord.getRefIxForSheet(sheetIndex);
-		for(short i=0; i< nESRs; i++) {
+		if (i>=0) {
-			ExternSheetSubRecord esr = _externSheetRecord.getREFRecordAt(i);
+			return (short)i;
-
-			if (esr.getIndexToFirstSupBook() ==  sheetNumber
-					&& esr.getIndexToLastSupBook() == sheetNumber){
-				return i;
 		}
-		}
-
 		//We Haven't found reference to this sheet
-		return addSheetIndexToExternSheet((short) sheetNumber);
+		return (short)addSheetIndexToExternSheet((short) sheetIndex);
 	}
 
 
@@ -326,11 +328,31 @@ final class LinkTable {
 	}
 
 	public int getNumberOfREFStructures() {
-		return _externSheetRecord.getNumOfREFStructures();
+		return _externSheetRecord.getNumOfRefs();
 	}
 
 	public String resolveNameXText(int refIndex, int definedNameIndex) {
-		short extBookIndex = _externSheetRecord.getREFRecordAt(refIndex).getIndexToSupBook();
+		int extBookIndex = _externSheetRecord.getExtbookIndexFromRefIndex(refIndex);
 		return _externalBookBlocks[extBookIndex].getNameText(definedNameIndex);
 	}
+
+	public NameXPtg getNameXPtg(String name) {
+		// first find any external book block that contains the name:
+		for (int i = 0; i < _externalBookBlocks.length; i++) {
+			int definedNameIndex = _externalBookBlocks[i].getIndexOfName(name);
+			if (definedNameIndex < 0) {
+				continue;
+			}
+			// found it.
+			int sheetRefIndex = findRefIndexFromExtBookIndex(i); 
+			if (sheetRefIndex >= 0) {
+				return new NameXPtg(sheetRefIndex, definedNameIndex);
+			}
+		}
+		return null;
+	}
+
+	private int findRefIndexFromExtBookIndex(int extBookIndex) {
+		return _externSheetRecord.findRefIndexFromExtBookIndex(extBookIndex); 
+	}
 }

src/java/org/apache/poi/hssf/model/Workbook.java

@@ -15,21 +15,70 @@
    limitations under the License.
 ==================================================================== */
 
-
 package org.apache.poi.hssf.model;
 
-import org.apache.poi.ddf.*;
-import org.apache.poi.hssf.record.*;
-import org.apache.poi.hssf.util.HSSFColor;
-import org.apache.poi.hssf.util.SheetReferences;
-import org.apache.poi.util.POILogFactory;
-import org.apache.poi.util.POILogger;
-
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Locale;
 
+import org.apache.poi.ddf.EscherBSERecord;
+import org.apache.poi.ddf.EscherBoolProperty;
+import org.apache.poi.ddf.EscherContainerRecord;
+import org.apache.poi.ddf.EscherDggRecord;
+import org.apache.poi.ddf.EscherOptRecord;
+import org.apache.poi.ddf.EscherProperties;
+import org.apache.poi.ddf.EscherRGBProperty;
+import org.apache.poi.ddf.EscherRecord;
+import org.apache.poi.ddf.EscherSplitMenuColorsRecord;
+import org.apache.poi.hssf.record.BOFRecord;
+import org.apache.poi.hssf.record.BackupRecord;
+import org.apache.poi.hssf.record.BookBoolRecord;
+import org.apache.poi.hssf.record.BoundSheetRecord;
+import org.apache.poi.hssf.record.CodepageRecord;
+import org.apache.poi.hssf.record.CountryRecord;
+import org.apache.poi.hssf.record.DSFRecord;
+import org.apache.poi.hssf.record.DateWindow1904Record;
+import org.apache.poi.hssf.record.DrawingGroupRecord;
+import org.apache.poi.hssf.record.EOFRecord;
+import org.apache.poi.hssf.record.ExtSSTRecord;
+import org.apache.poi.hssf.record.ExtendedFormatRecord;
+import org.apache.poi.hssf.record.ExternSheetRecord;
+import org.apache.poi.hssf.record.FileSharingRecord;
+import org.apache.poi.hssf.record.FnGroupCountRecord;
+import org.apache.poi.hssf.record.FontRecord;
+import org.apache.poi.hssf.record.FormatRecord;
+import org.apache.poi.hssf.record.HideObjRecord;
+import org.apache.poi.hssf.record.HyperlinkRecord;
+import org.apache.poi.hssf.record.InterfaceEndRecord;
+import org.apache.poi.hssf.record.InterfaceHdrRecord;
+import org.apache.poi.hssf.record.MMSRecord;
+import org.apache.poi.hssf.record.NameRecord;
+import org.apache.poi.hssf.record.PaletteRecord;
+import org.apache.poi.hssf.record.PasswordRecord;
+import org.apache.poi.hssf.record.PasswordRev4Record;
+import org.apache.poi.hssf.record.PrecisionRecord;
+import org.apache.poi.hssf.record.ProtectRecord;
+import org.apache.poi.hssf.record.ProtectionRev4Record;
+import org.apache.poi.hssf.record.RecalcIdRecord;
+import org.apache.poi.hssf.record.Record;
+import org.apache.poi.hssf.record.RefreshAllRecord;
+import org.apache.poi.hssf.record.SSTRecord;
+import org.apache.poi.hssf.record.StyleRecord;
+import org.apache.poi.hssf.record.SupBookRecord;
+import org.apache.poi.hssf.record.TabIdRecord;
+import org.apache.poi.hssf.record.UnicodeString;
+import org.apache.poi.hssf.record.UseSelFSRecord;
+import org.apache.poi.hssf.record.WindowOneRecord;
+import org.apache.poi.hssf.record.WindowProtectRecord;
+import org.apache.poi.hssf.record.WriteAccessRecord;
+import org.apache.poi.hssf.record.WriteProtectRecord;
+import org.apache.poi.hssf.record.formula.NameXPtg;
+import org.apache.poi.hssf.util.HSSFColor;
+import org.apache.poi.hssf.util.SheetReferences;
+import org.apache.poi.util.POILogFactory;
+import org.apache.poi.util.POILogger;
+
 /**
  * Low level model implementation of a Workbook.  Provides creational methods
  * for settings and objects contained in the workbook object.
@@ -461,19 +510,23 @@ public final class Workbook implements Model {
     /**
      * Sets the BOF for a given sheet
      *
-     * @param sheetnum the number of the sheet to set the positing of the bof for
+     * @param sheetIndex the number of the sheet to set the positing of the bof for
      * @param pos the actual bof position
      */
 
-    public void setSheetBof(int sheetnum, int pos) {
+    public void setSheetBof(int sheetIndex, int pos) {
         if (log.check( POILogger.DEBUG ))
-            log.log(DEBUG, "setting bof for sheetnum =", new Integer(sheetnum),
+            log.log(DEBUG, "setting bof for sheetnum =", new Integer(sheetIndex),
                 " at pos=", new Integer(pos));
-        checkSheets(sheetnum);
+        checkSheets(sheetIndex);
-        (( BoundSheetRecord ) boundsheets.get(sheetnum))
+        getBoundSheetRec(sheetIndex)
         .setPositionOfBof(pos);
     }
 
+    private BoundSheetRecord getBoundSheetRec(int sheetIndex) {
+        return ((BoundSheetRecord) boundsheets.get(sheetIndex));
+    }
+
     /**
      * Returns the position of the backup record.
      */
@@ -509,7 +562,7 @@ public final class Workbook implements Model {
     {
         for ( int i = 0; i < boundsheets.size(); i++ )
         {
-            BoundSheetRecord boundSheetRecord = (BoundSheetRecord) boundsheets.get( i );
+            BoundSheetRecord boundSheetRecord = getBoundSheetRec(i);
             if (excludeSheetIdx != i && name.equalsIgnoreCase(boundSheetRecord.getSheetname()))
                 return true;
         }
@@ -526,7 +579,7 @@ public final class Workbook implements Model {
      */    
     public void setSheetName(int sheetnum, String sheetname, short encoding ) {
         checkSheets(sheetnum);
-        BoundSheetRecord sheet = (BoundSheetRecord)boundsheets.get( sheetnum );
+        BoundSheetRecord sheet = getBoundSheetRec(sheetnum);
         sheet.setSheetname(sheetname);
         sheet.setSheetnameLength( (byte)sheetname.length() );
         sheet.setCompressedUnicodeFlag( (byte)encoding );
@@ -548,13 +601,11 @@ public final class Workbook implements Model {
     /**
      * gets the name for a given sheet.
      *
-     * @param sheetnum the sheet number (0 based)
+     * @param sheetIndex the sheet number (0 based)
      * @return sheetname the name for the sheet
      */
-
+    public String getSheetName(int sheetIndex) {
-    public String getSheetName(int sheetnum) {
+        return getBoundSheetRec(sheetIndex).getSheetname();
-        return (( BoundSheetRecord ) boundsheets.get(sheetnum))
-        .getSheetname();
     }
 
     /**
@@ -565,8 +616,7 @@ public final class Workbook implements Model {
      */
 
     public boolean isSheetHidden(int sheetnum) {
-        BoundSheetRecord bsr = ( BoundSheetRecord ) boundsheets.get(sheetnum);
+        return getBoundSheetRec(sheetnum).isHidden();
-        return bsr.isHidden();
     }
 
     /**
@@ -577,8 +627,7 @@ public final class Workbook implements Model {
      */
     
     public void setSheetHidden(int sheetnum, boolean hidden) {
-        BoundSheetRecord bsr = ( BoundSheetRecord ) boundsheets.get(sheetnum);
+        getBoundSheetRec(sheetnum).setHidden(hidden);
-        bsr.setHidden(hidden);
     }
     /**
      * get the sheet's index
@@ -851,7 +900,7 @@ public final class Workbook implements Model {
                 if (record instanceof BoundSheetRecord) {
                      if(!wroteBoundSheets) {
                         for (int i = 0; i < boundsheets.size(); i++) {
-                            len+= ((BoundSheetRecord)boundsheets.get(i))
+                            len+= getBoundSheetRec(i)
                                              .serialize(pos+offset+len, data);
                         }
                         wroteBoundSheets = true;
@@ -1134,8 +1183,8 @@ public final class Workbook implements Model {
         retval.setWidth(( short ) 0x3a5c);
         retval.setHeight(( short ) 0x23be);
         retval.setOptions(( short ) 0x38);
-        retval.setSelectedTab(( short ) 0x0);
+        retval.setActiveSheetIndex( 0x0);
-        retval.setDisplayedTab(( short ) 0x0);
+        retval.setFirstVisibleTab(0x0);
         retval.setNumSelectedTabs(( short ) 1);
         retval.setTabWidthRatio(( short ) 0x258);
         return retval;
@@ -1882,15 +1931,15 @@ public final class Workbook implements Model {
      * @return sheet name
      */
     public String findSheetNameFromExternSheet(short num){
-        String result="";
 
-        short indexToSheet = linkTable.getIndexToSheet(num);
+        int indexToSheet = linkTable.getIndexToSheet(num);
         
-        if (indexToSheet>-1) { //error check, bail out gracefully!
+        if (indexToSheet < 0) {
-            result = getSheetName(indexToSheet);
+            // TODO - what does '-1' mean here?
+            //error check, bail out gracefully!
+            return "";
         }
-
+        return getSheetName(indexToSheet);
-        return result;
     }
 
     /**
@@ -2402,6 +2451,8 @@ public final class Workbook implements Model {
     public String resolveNameXText(int refIndex, int definedNameIndex) {
         return linkTable.resolveNameXText(refIndex, definedNameIndex);
     }
+
+    public NameXPtg getNameXPtg(String name) {
+        return getOrCreateLinkTable().getNameXPtg(name);
+    }
 }
-
-

src/java/org/apache/poi/hssf/record/ExternSheetRecord.java

@@ -1,4 +1,3 @@
-
 /* ====================================================================
    Licensed to the Apache Software Foundation (ASF) under one or more
    contributor license agreements.  See the NOTICE file distributed with
@@ -16,28 +15,84 @@
    limitations under the License.
 ==================================================================== */
 
-
 package org.apache.poi.hssf.record;
 
+import java.util.ArrayList;
+import java.util.List;
+
 import org.apache.poi.util.LittleEndian;
 
-import java.util.ArrayList;
-
 /**
- * Title:        Extern Sheet <P>
+ * EXTERNSHEET (0x0017)<br/>
- * Description:  A List of Inndexes to SupBook <P>
+ * A List of Indexes to  EXTERNALBOOK (supplemental book) Records <p/>
- * REFERENCE:  <P>
+ * 
  * @author Libin Roman (Vista Portal LDT. Developer)
- * @version 1.0-pre
  */
-
 public class ExternSheetRecord extends Record {
-    public final static short sid = 0x17;
+    public final static short sid = 0x0017;
-    private short             field_1_number_of_REF_sturcutres;
+    private List         _list;
-    private ArrayList         field_2_REF_structures;
+    
+    private final class RefSubRecord {
+    	public static final int ENCODED_SIZE = 6;
+
+    	/** index to External Book Block (which starts with a EXTERNALBOOK record) */
+        private int _extBookIndex;
+        private int _firstSheetIndex; // may be -1 (0xFFFF)
+        private int _lastSheetIndex;  // may be -1 (0xFFFF)
+        
+        
+        /** a Constructor for making new sub record
+         */
+        public RefSubRecord(int extBookIndex, int firstSheetIndex, int lastSheetIndex) {
+    		_extBookIndex = extBookIndex;
+    		_firstSheetIndex = firstSheetIndex;
+    		_lastSheetIndex = lastSheetIndex;
+        }
+        
+        /**
+         * @param in the RecordInputstream to read the record from
+         */
+        public RefSubRecord(RecordInputStream in) {
+            this(in.readShort(), in.readShort(), in.readShort());
+        }
+        public int getExtBookIndex(){
+            return _extBookIndex;
+        }
+        public int getFirstSheetIndex(){
+            return _firstSheetIndex;
+        }
+        public int getLastSheetIndex(){
+            return _lastSheetIndex;
+        }
+        
+        public String toString() {
+            StringBuffer buffer = new StringBuffer();
+            buffer.append("extBook=").append(_extBookIndex);
+            buffer.append(" firstSheet=").append(_firstSheetIndex);
+            buffer.append(" lastSheet=").append(_lastSheetIndex);
+            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 void serialize(int offset, byte [] data) {
+            LittleEndian.putUShort(data, 0 + offset, _extBookIndex);
+            LittleEndian.putUShort(data, 2 + offset, _firstSheetIndex);
+            LittleEndian.putUShort(data, 4 + offset, _lastSheetIndex);
+        }
+    }    
+    
+    
     
     public ExternSheetRecord() {
-        field_2_REF_structures = new ArrayList();
+        _list = new ArrayList();
     }
     
     /**
@@ -68,72 +123,60 @@ public class ExternSheetRecord extends Record {
      * @param in the RecordInputstream to read the record from
      */
     protected void fillFields(RecordInputStream in) {
-        field_2_REF_structures           = new ArrayList();
+        _list           = new ArrayList();
         
-        field_1_number_of_REF_sturcutres = in.readShort();
+        int nItems  = in.readShort();
         
-        for (int i = 0 ; i < field_1_number_of_REF_sturcutres ; ++i) {
+        for (int i = 0 ; i < nItems ; ++i) {
-            ExternSheetSubRecord rec = new ExternSheetSubRecord(in);
+            RefSubRecord rec = new RefSubRecord(in);
             
-            field_2_REF_structures.add( rec);
+            _list.add( rec);
         }
     }
     
+
     /**  
-     * sets the number of the REF structors , that is in Excel file
+     * @return number of REF structures
-     * @param numStruct number of REF structs
      */
-    public void setNumOfREFStructures(short numStruct) {
+    public int getNumOfRefs() {
-        field_1_number_of_REF_sturcutres = numStruct;
+        return _list.size();
-    }
-    
-    /**  
-     * 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) {
+    public void addREFRecord(RefSubRecord rec) {
-        field_2_REF_structures.add(rec);
+        _list.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();
+        return _list.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();
+        StringBuffer sb = new StringBuffer();
-        
+        int nItems = _list.size();
-        buffer.append("[EXTERNSHEET]\n");
+        sb.append("[EXTERNSHEET]\n");
-        buffer.append("   numOfRefs     = ").append(getNumOfREFStructures()).append("\n");
+        sb.append("   numOfRefs     = ").append(nItems).append("\n");
-        for (int k=0; k < this.getNumOfREFRecords(); k++) {
+        for (int i=0; i < nItems; i++) {
-            buffer.append("refrec         #").append(k).append('\n');
+            sb.append("refrec         #").append(i).append(": ");
-            buffer.append(getREFRecordAt(k).toString());
+            sb.append(getRef(i).toString());
-            buffer.append("----refrec     #").append(k).append('\n');
+            sb.append('\n');
         }
-        buffer.append("[/EXTERNSHEET]\n");
+        sb.append("[/EXTERNSHEET]\n");
         
         
-        return buffer.toString();
+        return sb.toString();
+    }
+    
+    
+    private int getDataSize() {
+    	return 2 + _list.size() * RefSubRecord.ENCODED_SIZE;
     }
     
     /**
@@ -146,24 +189,29 @@ public class ExternSheetRecord extends Record {
      * @return number of bytes written
      */
     public int serialize(int offset, byte [] data) {
-        LittleEndian.putShort(data, 0 + offset, sid);
+        int dataSize = getDataSize();
-        LittleEndian.putShort(data, 2 + offset,(short)(2 + (getNumOfREFRecords() *6)));
         
-        LittleEndian.putShort(data, 4 + offset, getNumOfREFStructures());
+        int nItems = _list.size();
+
+        LittleEndian.putShort(data, 0 + offset, sid);
+		LittleEndian.putUShort(data, 2 + offset, dataSize);
+        LittleEndian.putUShort(data, 4 + offset, nItems);
         
         int pos = 6 ;
         
-        for (int k = 0; k < getNumOfREFRecords(); k++) {
+        for (int i = 0; i < nItems; i++) {
-            ExternSheetSubRecord record = getREFRecordAt(k);
+            getRef(i).serialize(offset + pos, data);
-            System.arraycopy(record.serialize(), 0, data, pos + offset, 6);
-            
             pos +=6;
         }
-        return getRecordSize();
+        return dataSize + 4;
+    }
+
+	private RefSubRecord getRef(int i) {
+		return (RefSubRecord) _list.get(i);
 	}
     
     public int getRecordSize() {
-        return 4 + 2 + getNumOfREFRecords() * 6;
+        return 4 + getDataSize();
     }
     
     /**
@@ -172,4 +220,44 @@ public class ExternSheetRecord extends Record {
     public short getSid() {
         return sid;
     }
+
+	public int getExtbookIndexFromRefIndex(int refIndex) {
+        return getRef(refIndex).getExtBookIndex();
+	}
+
+	/**
+	 * @return -1 if not found
+	 */
+	public int findRefIndexFromExtBookIndex(int extBookIndex) {
+        int nItems = _list.size();
+        for (int i = 0; i < nItems; i++) {
+            if (getRef(i).getExtBookIndex() == extBookIndex) {
+            	return i;
+            }
+        }
+		return -1;
+	}
+
+	public int getFirstSheetIndexFromRefIndex(int extRefIndex) {
+		return getRef(extRefIndex).getFirstSheetIndex();
+	}
+
+	/**
+	 * @return index of newly added ref
+	 */
+	public int addRef(int extBookIndex, int firstSheetIndex, int lastSheetIndex) {
+		_list.add(new RefSubRecord(extBookIndex, firstSheetIndex, lastSheetIndex));
+		return _list.size() - 1;
+	}
+
+	public int getRefIxForSheet(int sheetIndex) {
+        int nItems = _list.size();
+        for (int i = 0; i < nItems; i++) {
+            RefSubRecord ref = getRef(i);
+			if (ref.getFirstSheetIndex() == sheetIndex && ref.getLastSheetIndex() == sheetIndex) {
+            	return i;
+            }
+        }
+		return -1;
+	}
 }

src/java/org/apache/poi/hssf/record/ExternSheetSubRecord.java

@@ -1,154 +0,0 @@
-
-/* ====================================================================
-   Licensed to the Apache Software Foundation (ASF) under one or more
-   contributor license agreements.  See the NOTICE file distributed with
-   this work for additional information regarding copyright ownership.
-   The ASF licenses this file to You under the Apache License, Version 2.0
-   (the "License"); you may not use this file except in compliance with
-   the License.  You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-==================================================================== */
-        
-
-package org.apache.poi.hssf.record;
-
-import org.apache.poi.util.LittleEndian;
-
-/**
- * Title:        A sub Record for Extern Sheet <P>
- * Description:  Defines a named range within a workbook. <P>
- * REFERENCE:  <P>
- * @author Libin Roman (Vista Portal LDT. Developer)
- * @version 1.0-pre
- */
-
-public class ExternSheetSubRecord extends Record {
-    public final static short sid = 0xFFF; // only here for conformance, doesn't really have an sid
-    private short             field_1_index_to_supbook;
-    private short             field_2_index_to_first_supbook_sheet;
-    private short             field_3_index_to_last_supbook_sheet;
-    
-    
-    /** a Constractor for making new sub record
-     */
-    public ExternSheetSubRecord() {
-    }
-    
-    /**
-     * Constructs a Extern Sheet Sub Record record and sets its fields appropriately.
-     *
-     * @param in the RecordInputstream to read the record from
-     */
-    public ExternSheetSubRecord(RecordInputStream in) {
-        super(in);
-    }
-    
-    
-    /** Sets the Index to the sup book
-     * @param index sup book index
-     */
-    public void setIndexToSupBook(short index){
-        field_1_index_to_supbook = index;
-    }
-    
-    /** gets the index to sup book
-     * @return sup book index
-     */
-    public short getIndexToSupBook(){
-        return field_1_index_to_supbook;
-    }
-    
-    /** sets the index to first sheet in supbook
-     * @param index index to first sheet
-     */
-    public void setIndexToFirstSupBook(short index){
-        field_2_index_to_first_supbook_sheet = index;
-    }
-    
-    /** gets the index to first sheet from supbook
-     * @return index to first supbook
-     */
-    public short getIndexToFirstSupBook(){
-        return field_2_index_to_first_supbook_sheet;
-    }
-    
-    /** sets the index to last sheet in supbook
-     * @param index index to last sheet
-     */
-    public void setIndexToLastSupBook(short index){
-        field_3_index_to_last_supbook_sheet = index;
-    }
-    
-    /** gets the index to last sheet in supbook
-     * @return index to last supbook
-     */
-    public short getIndexToLastSupBook(){
-        return field_3_index_to_last_supbook_sheet;
-    }
-    
-    /**
-     * 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) {
-        // do nothing
-    }
-    
-    /**
-     * @param in the RecordInputstream to read the record from
-     */
-    protected void fillFields(RecordInputStream in) {
-        field_1_index_to_supbook             = in.readShort();
-        field_2_index_to_first_supbook_sheet = in.readShort();
-        field_3_index_to_last_supbook_sheet  = in.readShort();
-    }
-    
-    
-    public String toString() {
-        StringBuffer buffer = new StringBuffer();
-        buffer.append("   supbookindex =").append(getIndexToSupBook()).append('\n');
-        buffer.append("   1stsbindex   =").append(getIndexToFirstSupBook()).append('\n');
-        buffer.append("   lastsbindex  =").append(getIndexToLastSupBook()).append('\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, getIndexToSupBook());
-        LittleEndian.putShort(data, 2 + offset, getIndexToFirstSupBook());
-        LittleEndian.putShort(data, 4 + offset, getIndexToLastSupBook());
-        
-        return getRecordSize();
-    }
-    
-    
-    /** returns the record size
-     */
-    public int getRecordSize() {
-        return 6;
-    }
-    
-    /**
-     * return the non static version of the id for this record.
-     */
-    public short getSid() {
-        return sid;
-    }
-}

src/java/org/apache/poi/hssf/record/NameRecord.java

@@ -34,7 +34,7 @@ import org.apache.poi.util.LittleEndian;
 import org.apache.poi.util.StringUtil;
 
 /**
- * Title:        Name Record (aka Named Range) <P>
+ * Title:        DEFINEDNAME Record (0x0018) <p/>
  * Description:  Defines a named range within a workbook. <P>
  * REFERENCE:  <P>
  * @author Libin Roman (Vista Portal LDT. Developer)
@@ -43,10 +43,7 @@ import org.apache.poi.util.StringUtil;
  * @version 1.0-pre
  */
 public final class NameRecord extends Record {
-	/**
+    public final static short sid = 0x0018;
-	 */
-	public final static short sid = 0x18; //Docs says that it is 0x218
-	
 	/**Included for completeness sake, not implemented
 	   */
 	public final static byte  BUILTIN_CONSOLIDATE_AREA      = (byte)1;
@@ -92,14 +89,15 @@ public final class NameRecord extends Record {
 	 */
 	public final static byte  BUILTIN_SHEET_TITLE           = (byte)12;
 	
-	public static final short OPT_HIDDEN_NAME =   (short) 0x0001;
+	private static final class Option {
-	public static final short OPT_FUNCTION_NAME = (short) 0x0002;
+		public static final int OPT_HIDDEN_NAME =   0x0001;
-	public static final short OPT_COMMAND_NAME =  (short) 0x0004;
+		public static final int OPT_FUNCTION_NAME = 0x0002;
-	public static final short OPT_MACRO =         (short) 0x0008;
+		public static final int OPT_COMMAND_NAME =  0x0004;
-	public static final short OPT_COMPLEX =       (short) 0x0010;
+		public static final int OPT_MACRO =         0x0008;
-	public static final short OPT_BUILTIN =       (short) 0x0020;
+		public static final int OPT_COMPLEX =       0x0010;
-	public static final short OPT_BINDATA =       (short) 0x1000;
+		public static final int OPT_BUILTIN =       0x0020;
-
+		public static final int OPT_BINDATA =       0x1000;
+	}
 	
 	private short             field_1_option_flag;
 	private byte              field_2_keyboard_shortcut;
@@ -150,7 +148,7 @@ public final class NameRecord extends Record {
 	{
 		this();		
 		this.field_12_builtIn_name = builtin;
-	    this.setOptionFlag((short)(this.getOptionFlag() | OPT_BUILTIN));
+		this.setOptionFlag((short)(this.field_1_option_flag | Option.OPT_BUILTIN));
 		this.setNameTextLength((byte)1);
 		field_6_sheetNumber = sheetNumber; //the extern sheets are set through references
 		
@@ -383,47 +381,45 @@ public final 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 (field_1_option_flag & Option.OPT_HIDDEN_NAME) != 0;
 	}
-
 	/**
 	 * @return true if name is a function
 	 */
 	public boolean isFunctionName() {
-	    return (field_1_option_flag & OPT_FUNCTION_NAME) != 0;
+		return (field_1_option_flag & Option.OPT_FUNCTION_NAME) != 0;
 	}
 
+
 	/**
 	 * @return true if name is a command
 	 */
 	public boolean isCommandName() {
-	    return (field_1_option_flag & OPT_COMMAND_NAME) != 0;
+		return (field_1_option_flag & Option.OPT_COMMAND_NAME) != 0;
 	}
-
 	/**
 	 * @return true if function macro or command macro
 	 */
 	public boolean isMacro() {
-	    return (field_1_option_flag & OPT_MACRO) != 0;
+		return (field_1_option_flag & Option.OPT_MACRO) != 0;
 	}
-
 	/**
 	 * @return true if array formula or user defined
 	 */
 	public boolean isComplexFunction() {
-	    return (field_1_option_flag & OPT_COMPLEX) != 0;
+		return (field_1_option_flag & Option.OPT_COMPLEX) != 0;
 	}
 
-
 	/**Convenience Function to determine if the name is a built-in name
 	 */
 	public boolean isBuiltInName()
 	{
-	    return ((this.getOptionFlag() & OPT_BUILTIN) != 0);
+		return ((this.field_1_option_flag & Option.OPT_BUILTIN) != 0);
 	}
 
 

src/java/org/apache/poi/hssf/record/SupBookRecord.java

@@ -22,7 +22,7 @@ import org.apache.poi.util.LittleEndian;
 
 /**
  * Title:        Sup Book (EXTERNALBOOK) <P>
- * Description:  A External Workbook Description (Suplemental Book)
+ * Description:  A External Workbook Description (Supplemental Book)
  *               Its only a dummy record for making new ExternSheet Record <P>
  * REFERENCE:  5.38<P>
  * @author Libin Roman (Vista Portal LDT. Developer)

src/java/org/apache/poi/hssf/record/formula/AbstractFunctionPtg.java

@@ -110,7 +110,7 @@ public abstract class AbstractFunctionPtg extends OperationPtg {
      * @return <code>true</code> if the name specifies a standard worksheet function,
      *  <code>false</code> if the name should be assumed to be an external function.
      */
-    public static final boolean isInternalFunctionName(String name) {
+    public static final boolean isBuiltInFunctionName(String name) {
         short ix = FunctionMetadataRegistry.lookupIndexByName(name.toUpperCase());
         return ix >= 0;
     }

src/java/org/apache/poi/hssf/record/formula/NameXPtg.java

@@ -28,32 +28,46 @@ import org.apache.poi.hssf.record.RecordInputStream;
 public final class NameXPtg extends OperandPtg {
 	public final static short sid = 0x39;
 	private final static int SIZE = 7;
-    private short             field_1_ixals;   // index to REF entry in externsheet record
-    private short             field_2_ilbl;    //index to defined name or externname table(1 based)
-    private short            field_3_reserved;   // reserved must be 0
 
+	/** index to REF entry in externsheet record */
+	private int _sheetRefIndex;
+	/** index to defined name or externname table(1 based) */
+	private int _nameNumber;
+	/** reserved must be 0 */
+	private int _reserved;
 
-    public NameXPtg(RecordInputStream in) {
+	private NameXPtg(int sheetRefIndex, int nameNumber, int reserved) {
-        field_1_ixals        = in.readShort();
+		_sheetRefIndex = sheetRefIndex;
-        field_2_ilbl        = in.readShort();
+		_nameNumber = nameNumber;
-        field_3_reserved = in.readShort();
+		_reserved = reserved;
 	}
 
-    public void writeBytes(byte [] array, int offset) {
+	/**
-        array[ offset + 0 ] = (byte)(sid + getPtgClass());
+	 * @param sheetRefIndex index to REF entry in externsheet record
-        LittleEndian.putShort(array, offset + 1, field_1_ixals);
+	 * @param nameIndex index to defined name or externname table
-        LittleEndian.putShort(array,offset+3, field_2_ilbl);
+	 */
-        LittleEndian.putShort(array, offset + 5, field_3_reserved);
+	public NameXPtg(int sheetRefIndex, int nameIndex) {
+		this(sheetRefIndex, nameIndex + 1, 0);
+	}
+
+	public NameXPtg(RecordInputStream in) {
+		this(in.readUShort(), in.readUShort(), in.readUShort());
+	}
+
+	public void writeBytes(byte[] array, int offset) {
+		LittleEndian.putByte(array, offset + 0, sid + getPtgClass());
+		LittleEndian.putUShort(array, offset + 1, _sheetRefIndex);
+		LittleEndian.putUShort(array, offset + 3, _nameNumber);
+		LittleEndian.putUShort(array, offset + 5, _reserved);
 	}
 
 	public int getSize() {
 		return SIZE;
 	}
 
-    public String toFormulaString(HSSFWorkbook book)
+	public String toFormulaString(HSSFWorkbook book) {
-    {
 		// -1 to convert definedNameIndex from 1-based to zero-based
-        return book.resolveNameXText(field_1_ixals, field_2_ilbl-1); 
+		return book.resolveNameXText(_sheetRefIndex, _nameNumber - 1);
 	}
 
 	public byte getDefaultOperandClass() {

src/java/org/apache/poi/hssf/usermodel/HSSFName.java

@@ -22,67 +22,57 @@ import org.apache.poi.hssf.record.NameRecord;
 import org.apache.poi.hssf.util.RangeAddress;
 
 /**
- * Title:        High Level Represantion of Named Range <P>
+ * High Level Representation of a 'defined name' which could be a 'built-in' name, 
- * REFERENCE:  <P>
+ * 'named range' or name of a user defined function.
+ * 
  * @author Libin Roman (Vista Portal LDT. Developer)
  */
-
+public final class HSSFName {
-public class HSSFName {
+    private HSSFWorkbook _book;
-    private HSSFWorkbook         book;
+    private NameRecord _definedNameRec;
-    private NameRecord       name;
     
     /** Creates new HSSFName   - called by HSSFWorkbook to create a sheet from
      * scratch.
      *
      * @see org.apache.poi.hssf.usermodel.HSSFWorkbook#createName()
      * @param name the Name Record
-     * @param book lowlevel Workbook object associated with the sheet.
+     * @param book workbook object associated with the sheet.
      */
-    
+    /* package */ HSSFName(HSSFWorkbook book, NameRecord name) {
-    protected HSSFName(HSSFWorkbook book, NameRecord name) {
+        _book = book;
-        this.book = book;
+        _definedNameRec = name;
-        this.name = name;
     }
     
     /** Get the sheets name which this named range is referenced to
-     * @return sheet name, which this named range refered to
+     * @return sheet name, which this named range referred to
      */    
-
     public String getSheetName() {
-        String result ;
+        short indexToExternSheet = _definedNameRec.getExternSheetNumber();
-        short indexToExternSheet = name.getExternSheetNumber();
         
-        result = book.getWorkbook().findSheetNameFromExternSheet(indexToExternSheet);
+        return _book.getWorkbook().findSheetNameFromExternSheet(indexToExternSheet);
-        
-        return result;
     }
     
     /** 
-     * gets the name of the named range
+     * @return text name of this defined name
-     * @return named range name
      */    
-
     public String getNameName(){
-        String result = name.getNameText();
+        return _definedNameRec.getNameText();
-        
-        return result;
     }
     
     /** 
      * sets the name of the named range
      * @param nameName named range name to set
      */    
-
     public void setNameName(String nameName){
-        name.setNameText(nameName);
+        _definedNameRec.setNameText(nameName);
-        name.setNameTextLength((byte)nameName.length());
+        _definedNameRec.setNameTextLength((byte)nameName.length());
-        Workbook wb = book.getWorkbook();
+        Workbook wb = _book.getWorkbook();
         
         //Check to ensure no other names have the same case-insensitive name
         for ( int i = wb.getNumNames()-1; i >=0; i-- )
         {
         	NameRecord rec = wb.getNameRecord(i);
-        	if (rec != name) {
+        	if (rec != _definedNameRec) {
         		if (rec.getNameText().equalsIgnoreCase(getNameName()))
         			throw new IllegalArgumentException("The workbook already contains this name (case-insensitive)");
         	}
@@ -90,31 +80,24 @@ public class HSSFName {
     }
 
     /** 
-     * gets the reference of the named range
+     * Note - this method only applies to named ranges
-     * @return reference of the named range
+     * @return the formula text defining the named range
      */    
-
     public String getReference() {
-        String result;
+    	if (_definedNameRec.isFunctionName()) {
-        result = name.getAreaReference(book);
+    		throw new IllegalStateException("Only applicable to named ranges");
-
+    	}
-        return result;
+        return _definedNameRec.getAreaReference(_book);
     }
-
-    
 
     /** 
      * sets the sheet name which this named range referenced to
      * @param sheetName the sheet name of the reference
      */    
-
     private void setSheetName(String sheetName){
-        int sheetNumber = book.getSheetIndex(sheetName);
+        int sheetNumber = _book.getSheetIndex(sheetName);
-
+        short externSheetNumber = _book.getExternalSheetIndex(sheetNumber);
-        short externSheetNumber = book.getExternalSheetIndex(sheetNumber);
+        _definedNameRec.setExternSheetNumber(externSheetNumber);
-        name.setExternSheetNumber(externSheetNumber);
-//        name.setIndexToSheet(externSheetNumber);
-
     }
 
   
@@ -122,7 +105,6 @@ public class HSSFName {
      * sets the reference of this named range
      * @param ref the reference to set
      */    
-
     public void setReference(String ref){
 
         RangeAddress ra = new RangeAddress(ref);
@@ -134,8 +116,7 @@ public class HSSFName {
         }
 
 		//allow the poi utilities to parse it out
-        name.setAreaReference(ref);
+        _definedNameRec.setAreaReference(ref);
-
     }
 
     /**
@@ -147,4 +128,14 @@ public class HSSFName {
         String ref = getReference();
         return "#REF!".endsWith(ref);
     }
+    public boolean isFunctionName() {
+    	return _definedNameRec.isFunctionName();
+    }
+    public String toString() {
+        StringBuffer sb = new StringBuffer(64);
+        sb.append(getClass().getName()).append(" [");
+        sb.append(_definedNameRec.getNameText());
+        sb.append("]");
+        return sb.toString();
+    }
 }

src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java

@@ -17,24 +17,6 @@
 
 package org.apache.poi.hssf.usermodel;
 
-import org.apache.poi.POIDocument;
-import org.apache.poi.ddf.EscherBSERecord;
-import org.apache.poi.ddf.EscherBitmapBlip;
-import org.apache.poi.ddf.EscherRecord;
-import org.apache.poi.ddf.EscherBlipRecord;
-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.formula.Area3DPtg;
-import org.apache.poi.hssf.record.formula.MemFuncPtg;
-import org.apache.poi.hssf.record.formula.UnionPtg;
-import org.apache.poi.hssf.usermodel.HSSFRow.MissingCellPolicy;
-import org.apache.poi.hssf.util.CellReference;
-import org.apache.poi.hssf.util.SheetReferences;
-import org.apache.poi.poifs.filesystem.*;
-import org.apache.poi.util.POILogFactory;
-import org.apache.poi.util.POILogger;
-
 import java.io.ByteArrayInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
@@ -47,6 +29,40 @@ import java.util.Iterator;
 import java.util.List;
 import java.util.Stack;
 
+import org.apache.poi.POIDocument;
+import org.apache.poi.ddf.EscherBSERecord;
+import org.apache.poi.ddf.EscherBitmapBlip;
+import org.apache.poi.ddf.EscherBlipRecord;
+import org.apache.poi.ddf.EscherRecord;
+import org.apache.poi.hssf.model.Sheet;
+import org.apache.poi.hssf.model.Workbook;
+import org.apache.poi.hssf.record.AbstractEscherHolderRecord;
+import org.apache.poi.hssf.record.BackupRecord;
+import org.apache.poi.hssf.record.DrawingGroupRecord;
+import org.apache.poi.hssf.record.EmbeddedObjectRefSubRecord;
+import org.apache.poi.hssf.record.ExtendedFormatRecord;
+import org.apache.poi.hssf.record.FontRecord;
+import org.apache.poi.hssf.record.LabelRecord;
+import org.apache.poi.hssf.record.LabelSSTRecord;
+import org.apache.poi.hssf.record.NameRecord;
+import org.apache.poi.hssf.record.ObjRecord;
+import org.apache.poi.hssf.record.Record;
+import org.apache.poi.hssf.record.RecordFactory;
+import org.apache.poi.hssf.record.SSTRecord;
+import org.apache.poi.hssf.record.UnicodeString;
+import org.apache.poi.hssf.record.UnknownRecord;
+import org.apache.poi.hssf.record.formula.Area3DPtg;
+import org.apache.poi.hssf.record.formula.MemFuncPtg;
+import org.apache.poi.hssf.record.formula.NameXPtg;
+import org.apache.poi.hssf.record.formula.UnionPtg;
+import org.apache.poi.hssf.usermodel.HSSFRow.MissingCellPolicy;
+import org.apache.poi.hssf.util.CellReference;
+import org.apache.poi.hssf.util.SheetReferences;
+import org.apache.poi.poifs.filesystem.DirectoryNode;
+import org.apache.poi.poifs.filesystem.POIFSFileSystem;
+import org.apache.poi.util.POILogFactory;
+import org.apache.poi.util.POILogger;
+
 /**
  * High level representation of a workbook.  This is the first object most users
  * will construct whether they are reading or writing a workbook.  It is also the
@@ -1640,9 +1656,16 @@ public class HSSFWorkbook extends POIDocument
         }
     }
 
-    private byte[] newUID()
+    private static byte[] newUID() {
-    {
+        return new byte[16];
-        byte[] bytes = new byte[16];
-        return bytes;
     }
+
+    /**
+     * Note - This method should only used by POI internally.  
+     * It may get deleted or change definition in future POI versions
+     */
+	public NameXPtg getNameXPtg(String name) {
+		return workbook.getNameXPtg(name);		
+	}
+
 }

src/testcases/org/apache/poi/hssf/model/TestFormulaParser.java

@@ -20,6 +20,7 @@ package org.apache.poi.hssf.model;
 import junit.framework.AssertionFailedError;
 import junit.framework.TestCase;
 
+import org.apache.poi.hssf.HSSFTestDataSamples;
 import org.apache.poi.hssf.model.FormulaParser.FormulaParseException;
 import org.apache.poi.hssf.record.formula.AbstractFunctionPtg;
 import org.apache.poi.hssf.record.formula.AddPtg;
@@ -123,12 +124,15 @@ public final class TestFormulaParser extends TestCase {
 	}
 
 	public void testMacroFunction() {
-		HSSFWorkbook w = new HSSFWorkbook();
+		// testNames.xls contains a VB function called 'myFunc'
-		Ptg[] ptg = FormulaParser.parse("FOO()", w);
+		HSSFWorkbook w = HSSFTestDataSamples.openSampleWorkbook("testNames.xls");
+
+		Ptg[] ptg = FormulaParser.parse("myFunc()", w);
+		// myFunc() actually takes 1 parameter.  Don't know if POI will ever be able to detect this problem
 
 		// the name gets encoded as the first arg
 		NamePtg tname = (NamePtg) ptg[0];
-		assertEquals("FOO", tname.toFormulaString(w));
+		assertEquals("myFunc", tname.toFormulaString(w));
 
 		AbstractFunctionPtg tfunc = (AbstractFunctionPtg) ptg[1];
 		assertTrue(tfunc.isExternalFunction());

src/testcases/org/apache/poi/hssf/record/formula/TestExternalFunctionFormulas.java

@@ -17,11 +17,19 @@
 
 package org.apache.poi.hssf.record.formula;
 
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+
 import junit.framework.TestCase;
 
 import org.apache.poi.hssf.HSSFTestDataSamples;
+import org.apache.poi.hssf.model.FormulaParser;
+import org.apache.poi.hssf.usermodel.HSSFCell;
+import org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator;
 import org.apache.poi.hssf.usermodel.HSSFSheet;
 import org.apache.poi.hssf.usermodel.HSSFWorkbook;
+import org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator.CellValue;
 /**
  * Tests for functions from external workbooks (e.g. YEARFRAC).
  * 
@@ -30,7 +38,6 @@ import org.apache.poi.hssf.usermodel.HSSFWorkbook;
  */
 public final class TestExternalFunctionFormulas extends TestCase {
 
-    
 	/**
 	 * tests <tt>NameXPtg.toFormulaString(Workbook)</tt> and logic in Workbook below that   
 	 */
@@ -39,8 +46,37 @@ public final class TestExternalFunctionFormulas extends TestCase {
 		
 		String expectedFormula = "YEARFRAC(B1,C1)";
 		HSSFSheet sht = wb.getSheetAt(0);
-        String cellFormula = sht.getRow(0).getCell((short)0).getCellFormula();
+		String cellFormula = sht.getRow(0).getCell(0).getCellFormula();
 		assertEquals(expectedFormula, cellFormula);
 	}
 	
+	public void testParse() {
+		HSSFWorkbook wb = HSSFTestDataSamples.openSampleWorkbook("externalFunctionExample.xls");
+		Ptg[] ptgs = FormulaParser.parse("YEARFRAC(B1,C1)", wb);
+		assertEquals(4, ptgs.length);
+		assertEquals(NameXPtg.class, ptgs[0].getClass());
+		
+		wb.getSheetAt(0).getRow(0).createCell(6).setCellFormula("YEARFRAC(C1,B1)");
+		if (false) {
+			// In case you fancy checking in excel
+			try {
+				File tempFile = File.createTempFile("testExtFunc", ".xls");
+				FileOutputStream fout = new FileOutputStream(tempFile);
+				wb.write(fout);
+				fout.close();
+				System.out.println("check out " + tempFile.getAbsolutePath());
+			} catch (IOException e) {
+				throw new RuntimeException(e);
+			}
+		}
+	}
+	
+	public void DISABLEDtestEvaluate() {
+		HSSFWorkbook wb = HSSFTestDataSamples.openSampleWorkbook("externalFunctionExample.xls");
+		HSSFSheet sheet = wb.getSheetAt(0);
+		HSSFCell cell = sheet.getRow(0).getCell(0);
+		HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(sheet, wb);
+		CellValue evalResult = fe.evaluate(cell);
+		evalResult.toString();
+	}
 }

src/testcases/org/apache/poi/hssf/record/formula/eval/TestExternalFunction.java

@@ -17,8 +17,11 @@
 
 package org.apache.poi.hssf.record.formula.eval;
 
+import java.io.IOException;
+
 import junit.framework.TestCase;
 
+import org.apache.poi.hssf.HSSFTestDataSamples;
 import org.apache.poi.hssf.usermodel.HSSFCell;
 import org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator;
 import org.apache.poi.hssf.usermodel.HSSFName;
@@ -34,17 +37,30 @@ public final class TestExternalFunction extends TestCase {
 
 	/**
 	 * Checks that an external function can get invoked from the formula evaluator. 
+	 * @throws IOException 
+
 	 */
 	public void testInvoke() {
-        HSSFWorkbook wb = new HSSFWorkbook();
-        HSSFSheet sheet = wb.createSheet();
-        wb.setSheetName(0, "Sheet1");
-        HSSFRow row = sheet.createRow(0);
-        HSSFCell cell = row.createCell(0);
 		
+		HSSFWorkbook wb;
+		HSSFSheet sheet;
+		HSSFCell cell;
+		if (false) {
+			// TODO - this code won't work until we can create user-defined functions directly with POI
+			wb = new HSSFWorkbook();
+			sheet = wb.createSheet();
+			wb.setSheetName(0, "Sheet1");
 			HSSFName hssfName = wb.createName();
 			hssfName.setNameName("myFunc");
 			
+		} else {
+			// This sample spreadsheet already has a VB function called 'myFunc'
+			wb = HSSFTestDataSamples.openSampleWorkbook("testNames.xls");
+			sheet = wb.getSheetAt(0);
+			HSSFRow row = sheet.createRow(0);
+			cell = row.createCell(1);
+		}
+		
 		cell.setCellFormula("myFunc()");
 		String actualFormula=cell.getCellFormula();
 		assertEquals("myFunc()", actualFormula);

src/testcases/org/apache/poi/hssf/usermodel/TestBugs.java

@@ -415,6 +415,9 @@ public final class TestBugs extends TestCase {
         for(int i = 0 ; i < wb.getNumberOfNames(); i++){
           HSSFName name = wb.getNameAt(i);
           name.getNameName();
+          if (name.isFunctionName()) {
+              continue;
+          }
           name.getReference();
         }
     }