From a7c8dca597839bac25432f50121509bfcdcb3c2d Mon Sep 17 00:00:00 2001
From: Nick Burch <nick@apache.org>
Date: Sun, 6 Jul 2008 21:16:05 +0000
Subject: [PATCH] Shuffle the HDGF chunks_parse_cmds.tbl off into resources
 where it more properly belongs, and correctly update the legal notice file to
 match

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@674348 13f79535-47bb-0310-9956-ffa450edef68
---
 build.xml                                             | 11 +++++------
 legal/NOTICE                                          | 11 +++++++++++
 .../org/apache/poi/hdgf}/chunks_parse_cmds.tbl        |  0
 .../src/org/apache/poi/hdgf/chunks/ChunkFactory.java  |  7 +++++--
 4 files changed, 21 insertions(+), 8 deletions(-)
 rename src/{scratchpad/src/org/apache/poi/hdgf/chunks => resources/scratchpad/org/apache/poi/hdgf}/chunks_parse_cmds.tbl (100%)

diff --git a/build.xml b/build.xml
index b3331e59e..485fe1d77 100644
--- a/build.xml
+++ b/build.xml
@@ -85,6 +85,7 @@ under the License.
   <property name="junit.jar1.url" value="${repository}/junit/jars/junit-3.8.1.jar"/>
 
   <!-- Scratchpad: -->
+  <property name="scratchpad.resource1.dir" value="src/resources/scratchpad"/>
   <property name="scratchpad.src" location="src/scratchpad/src"/>
   <property name="scratchpad.src.test" location="src/scratchpad/testcases"/>
   <property name="scratchpad.lib" location="src/scratchpad/lib"/>
@@ -152,6 +153,7 @@ under the License.
     <path id="scratchpad.classpath">
         <path refid="main.classpath"/>
         <pathelement location="${main.output.dir}"/>
+        <pathelement location="${scratchpad.resource1.dir}"/>
     </path>
 
     <path id="contrib.classpath">
@@ -338,12 +340,9 @@ under the License.
 	</copy>
 
 	<!-- Copy HDGF Resources over -->
-	<property name="hdgf.chunks" value="org/apache/poi/hdgf/chunks" />
-	<copy todir="${scratchpad.output.dir}/${hdgf.chunks}">
-		<fileset dir="${scratchpad.src}/${hdgf.chunks}">
-			<include name="*.tbl" />
-		</fileset>
-	</copy>
+    <copy todir="${scratchpad.output.dir}">
+      <fileset dir="${scratchpad.resource1.dir}"/>
+    </copy>
   </target>
 
   <target name="compile-contrib" depends="init">
diff --git a/legal/NOTICE b/legal/NOTICE
index 848c767bc..e3fd880aa 100644
--- a/legal/NOTICE
+++ b/legal/NOTICE
@@ -11,6 +11,17 @@ Common Public License Version 1.0:
 See http://www.junit.org/
 
 
+A single resource file of the POI scratchpad component HDGF is taken from 
+ VSDump, and is under the GNU General Public Licence version 3 (GPL v3):
+	http://gplv3.fsf.org/
+Since this is a data file, and has no compiled version (the original
+ file is distributed in both source and binary versions of POI), there should
+ be little difference in licencing requirements compared to the ASL.
+For those wishing to avoid this component, the HDGF part of the POI 
+ scratchpad should be omitted.
+See http://www.gnome.ru/projects/vsdump_en.html
+
+
 The Office Open XML experimental support had additional dependencies,
 with their own licensing:
  * XML Beans - http://xmlbeans.apache.org/
diff --git a/src/scratchpad/src/org/apache/poi/hdgf/chunks/chunks_parse_cmds.tbl b/src/resources/scratchpad/org/apache/poi/hdgf/chunks_parse_cmds.tbl
similarity index 100%
rename from src/scratchpad/src/org/apache/poi/hdgf/chunks/chunks_parse_cmds.tbl
rename to src/resources/scratchpad/org/apache/poi/hdgf/chunks_parse_cmds.tbl
diff --git a/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkFactory.java b/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkFactory.java
index bb6f918d1..bb58933de 100644
--- a/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkFactory.java
+++ b/src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkFactory.java
@@ -41,9 +41,12 @@ public class ChunkFactory {
 	 * Key is a Chunk's type, value is an array of its CommandDefinitions
 	 */
 	private Hashtable chunkCommandDefinitions = new Hashtable();
-	/** What the name is of the chunk table */
+	/** 
+	 * What the name is of the chunk table definitions file? 
+	 * This file comes from the scratchpad resources directory.
+	 */
 	private static String chunkTableName = 
-		"/org/apache/poi/hdgf/chunks/chunks_parse_cmds.tbl";
+		"/org/apache/poi/hdgf/chunks_parse_cmds.tbl";
 	
 	/** For logging problems we spot with the file */
 	private POILogger logger = POILogFactory.getLogger(ChunkFactory.class);