Unit test from bug #45001, and new replaceText method (no test yet)

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

src/scratchpad/src/org/apache/poi/hwpf/usermodel/Range.java

@@ -632,6 +632,50 @@ public class Range
     return (ListEntry)insertAfter(props, styleIndex);
   }
 
+  /**
+   * Replace (one instance of) a piece of text with another...
+   *
+   * @param pPlaceHolder    The text to be replaced (e.g., "${company}")
+   * @param pValue          The replacement text (e.g., "Cognocys, Inc.")
+   * @param pDocument       The <code>HWPFDocument</code> in which the placeholder was found
+   * @param pStartOffset    The offset or index where the <code>CharacterRun</code> begins
+   * @param pPlaceHolderIndex   The offset or index of the placeholder, 
+   *  relative to the <code>CharacterRun</code> where 
+   *  <code>pPlaceHolder</code> was found
+   */
+  protected void replaceText(String pPlaceHolder, String pValue, 
+        int pStartOffset, int pPlaceHolderIndex, HWPFDocument pDocument) {
+    int absPlaceHolderIndex = pStartOffset + pPlaceHolderIndex;
+    Range subRange = new Range(
+                absPlaceHolderIndex, 
+                (absPlaceHolderIndex + pPlaceHolder.length()), pDocument
+    );
+    if (subRange.usesUnicode()) {
+            absPlaceHolderIndex = pStartOffset + (pPlaceHolderIndex * 2);
+            subRange = new Range(
+                      absPlaceHolderIndex, 
+                      (absPlaceHolderIndex + (pPlaceHolder.length() * 2)), 
+                      pDocument
+            );
+    }
+
+    subRange.insertBefore(pValue);
+
+    // re-create the sub-range so we can delete it
+    subRange = new Range(
+            (absPlaceHolderIndex + pValue.length()),
+            (absPlaceHolderIndex + pPlaceHolder.length() + pValue.length()), 
+            pDocument
+    );
+    if (subRange.usesUnicode())
+            subRange = new Range(
+                      (absPlaceHolderIndex + (pValue.length() * 2)),
+                      (absPlaceHolderIndex + (pPlaceHolder.length() * 2) + 
+                      (pValue.length() * 2)), pDocument
+            );
+
+    subRange.delete();
+  }
 
   /**
    * Gets the character run at index. The index is relative to this range.

src/scratchpad/testcases/org/apache/poi/hwpf/usermodel/TestRangeInsertion.java

@@ -0,0 +1,120 @@
+
+/* ====================================================================
+   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.hwpf.usermodel;
+
+import java.io.ByteArrayOutputStream;
+import java.io.FileInputStream;
+import java.util.List;
+
+import org.apache.poi.hwpf.HWPFDocument;
+import org.apache.poi.hwpf.model.PicturesTable;
+import org.apache.poi.hwpf.usermodel.Picture;
+
+import junit.framework.TestCase;
+
+/**
+ *	Test to see if Range.insertBefore() works even if the Range contains a
+ *	CharacterRun that uses Unicode characters.
+ */
+public class TestRangeInsertion extends TestCase {
+
+	// u201c and u201d are "smart-quotes"
+	private String originalText =
+		"It is used to confirm that text insertion works even if Unicode characters (such as \u201c\u2014\u201d (U+2014), \u201c\u2e8e\u201d (U+2E8E), or \u201c\u2714\u201d (U+2714)) are present.\r";
+	private String textToInsert = "Look at me!  I'm cool!  ";
+	private int insertionPoint = 244;
+
+	private String illustrativeDocFile;
+
+	protected void setUp() throws Exception {
+
+		String dirname = System.getProperty("HWPF.testdata.path");
+
+		illustrativeDocFile = dirname + "/testRangeInsertion.doc";
+	}
+
+	/**
+	 * Test just opening the files
+	 */
+	public void testOpen() throws Exception {
+
+		HWPFDocument docA = new HWPFDocument(new FileInputStream(illustrativeDocFile));
+	}
+
+	/**
+	 * Test (more "confirm" than test) that we have the general structure that we expect to have.
+	 */
+	public void testDocStructure() throws Exception {
+
+		HWPFDocument daDoc = new HWPFDocument(new FileInputStream(illustrativeDocFile));
+
+		Range range = daDoc.getRange();
+
+		assertEquals(1, range.numSections());
+		Section section = range.getSection(0);
+
+		assertEquals(3, section.numParagraphs());
+		Paragraph para = section.getParagraph(2);
+
+		assertEquals(3, para.numCharacterRuns());
+		String text = para.getCharacterRun(0).text() + para.getCharacterRun(1).text() +
+			para.getCharacterRun(2).text();
+
+		assertEquals(originalText, text);
+	}
+
+	/**
+	 * Test that we can insert text in our CharacterRun with Unicode text.
+	 */
+	public void testRangeInsertion() throws Exception {
+
+		HWPFDocument daDoc = new HWPFDocument(new FileInputStream(illustrativeDocFile));
+
+		/*
+			Range range = daDoc.getRange();
+			Section section = range.getSection(0);
+			Paragraph para = section.getParagraph(2);
+			String text = para.getCharacterRun(0).text() + para.getCharacterRun(1).text() +
+			para.getCharacterRun(2).text();
+
+			System.out.println(text);
+		*/
+
+		Range range = new Range(insertionPoint, (insertionPoint + 2), daDoc);
+		range.insertBefore(textToInsert);
+
+		// we need to let the model re-calculate the Range before we evaluate it
+		range = daDoc.getRange();
+
+		assertEquals(1, range.numSections());
+		Section section = range.getSection(0);
+
+		assertEquals(3, section.numParagraphs());
+		Paragraph para = section.getParagraph(2);
+
+		assertEquals(3, para.numCharacterRuns());
+		String text = para.getCharacterRun(0).text() + para.getCharacterRun(1).text() +
+			para.getCharacterRun(2).text();
+
+		// System.out.println(text);
+
+		assertEquals((textToInsert + originalText), text);
+
+	}
+}