/**************************************************************
*
* 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 api.i18n;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Vector;
import com.sun.star.beans.PropertyState;
import com.sun.star.beans.PropertyValue;
import com.sun.star.i18n.Boundary;
import com.sun.star.i18n.LineBreakHyphenationOptions;
import com.sun.star.i18n.LineBreakResults;
import com.sun.star.i18n.LineBreakUserOptions;
import com.sun.star.i18n.ScriptType;
import com.sun.star.i18n.WordType;
import com.sun.star.i18n.XBreakIterator;
import com.sun.star.lang.Locale;
import com.sun.star.lang.XComponent;
import com.sun.star.text.XTextDocument;
import com.sun.star.text.XTextRange;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XComponentContext;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Assert;
import org.junit.Test;
import org.openoffice.test.common.Testspace;
import org.openoffice.test.uno.UnoApp;
/**
* Testing com.sun.star.i18n.XBreakIterator
* interface methods :
*
nextCharacters() previousCharacters() nextWord() previousWord() getWordBoundary() getWordType() isBeginWord() isEndWord() beginOfSentence() endOfSentence() getLineBreak() beginOfScript() endOfScript() nextScript() previousScript() getScriptType() beginOfCharBlock() endOfCharBlock() nextCharBlock() previousCharBlock()* This test needs the following object relations : *
'Locale'
* (of type com.sun.star.lang.Locale):
* this locale is used as locale argument for tested methods.
* 'UnicodeString'
* (of type String): Unicode string which is passed
* to methods except 'CharacterBlock' methods.
* * @see com.sun.star.i18n.XBreakIterator */ public class XBreakIteratorTest { private static final UnoApp app = new UnoApp(); private static final String iteratorPath = "api/i18n/Iterator.sxw"; private static String UnicodeString; private XComponentContext xContext = null; public XBreakIterator oObj = null; Locale locale = null; short wordType = WordType.ANYWORD_IGNOREWHITESPACES; // setup and close connections @BeforeClass public static void setUpConnection() throws Exception { app.start(); UnicodeString = readFileContents(iteratorPath); } @AfterClass public static void tearDownConnection() throws InterruptedException, com.sun.star.uno.Exception { app.close(); } /** * Retrieves object relations. * @throws StatusException If one of relations not found. */ @Before public void before() throws Exception { xContext = app.getComponentContext(); oObj = UnoRuntime.queryInterface( XBreakIterator.class, xContext.getServiceManager().createInstanceWithContext("com.sun.star.i18n.BreakIterator", xContext) ); locale = new Locale("en", "US", ""); } private static String readFileContents(String path) throws Exception { String sample = Testspace.prepareData(path); PropertyValue[] properties = new PropertyValue[1]; properties[0] = new PropertyValue("Hidden", -1, true, PropertyState.DIRECT_VALUE); XComponent docComponent = app.loadDocument(sample, properties); XTextDocument textDocument = (XTextDocument) UnoRuntime.queryInterface(XTextDocument.class, docComponent); XTextRange xTextRange = (XTextRange)textDocument.getText(); return xTextRange.getString(); } /** * Compares returned next character positions with expected values.
* * Has OK status if position after travel and traveled length * has expected values. */ @Test public void _nextCharacters() { short nCharacterIteratorMode = com.sun.star.i18n.CharacterIteratorMode.SKIPCHARACTER; int strLength = UnicodeString.length(); //Start from position : Travel ... chars : // Actual position after : How many chars traveled int[][] nextCharacters = { { 1, 5000, strLength , strLength - 1 }, { 10, 6, 16, 6}}; boolean bRes = true; for(int i = 0; i < nextCharacters.length; i++) { int[] lDone = new int[1]; long lRes = oObj.nextCharacters(UnicodeString, nextCharacters[i][0], locale, nCharacterIteratorMode, nextCharacters[i][1], lDone); System.out.println("Expected result is: lRes = " + nextCharacters[i][2] + "; lDone = " + nextCharacters[i][3] ); System.out.println("Actual result is: lRes = " + lRes + "; lDone = " + lDone[0] ); bRes = bRes && lRes == nextCharacters[i][2]; bRes = bRes && lDone[0] == nextCharacters[i][3]; } Assert.assertTrue("nextCharacters()", bRes); } /** * Compares returned previous character positions with expected values.
* * Has OK status if position after travel and traveled length * has expected values. */ @Test public void _previousCharacters() { short nCharacterIteratorMode = com.sun.star.i18n.CharacterIteratorMode.SKIPCHARACTER; //Start from position : Travel ... chars : Actual position after : //How many chars traveled int[][] previousCharacters = { {5, 5000, 0, 5}, {10, 6, 4, 6}}; boolean bRes = true; for(int i = 0; i < previousCharacters.length; i++) { int[] lDone = new int[1]; int lRes = oObj.previousCharacters(UnicodeString, previousCharacters[i][0], locale, nCharacterIteratorMode, previousCharacters[i][1], lDone); System.out.println("Expected result is: lRes = " + previousCharacters[i][2] + "; lDone = " + previousCharacters[i][3] ); System.out.println("Actual result is: lRes = " + lRes + "; lDone = " + lDone[0]); bRes = bRes && lRes == previousCharacters[i][2]; bRes = bRes && lDone[0] == previousCharacters[i][3]; } Assert.assertTrue("previousCharacters()", bRes); } /** * Saves bounds of all returned words for the future tests.
* Has OK status.
*/
@Test
public void _nextWord() {
ArrayList
* Has OK status if number of word bounds are equal.
*/
@Test
public void _previousWord() {
ArrayList
*
* Has OK status if bounds calculated by
*
* Has OK status if every word has type
* Has OK status if in the first case
*
* Has OK status if in the first case
*
* Has OK status if non-zero break position was found and it is
* less or equal than position we trying to break.
*/
@Test
public void _getLineBreak() {
boolean bRes = true;
LineBreakResults lineBreakResults;
LineBreakHyphenationOptions lineBreakHyphenationOptions =
new LineBreakHyphenationOptions();
LineBreakUserOptions lineBreakUserOptions = new LineBreakUserOptions();
lineBreakUserOptions.applyForbiddenRules = false;
lineBreakUserOptions.allowHyphenateEnglish = false;
int breakPos = 0;
int pos = 0;
while(breakPos == 0 && pos < UnicodeString.length() ) {
lineBreakResults = oObj.getLineBreak(UnicodeString, pos,
locale, 0, lineBreakHyphenationOptions, lineBreakUserOptions);
breakPos = lineBreakResults.breakIndex;
pos++;
}
// finally the position of break must be found in the middle and
// it must be before the break position specified
bRes = breakPos <= pos && breakPos > 0;
if (!bRes) {
System.out.println("The last position was: " + pos
+ ", and the break position was: " + breakPos);
}
Assert.assertTrue("getLineBreak()", bRes);
}
// Asian type script
private static String katakana = new String(new char[] {0x30A1, 0x30A2}) ;
// Weak type script
private static String arrows = new String(new char[] {0x2190, 0x2191}) ;
// Complex type script
private static String arabic = new String(new char[] {0x0641, 0x0642}) ;
/**
* Tries to find the beginning of the nearest script specified
* relatively to position passed.
* Has OK status if the starting position of script is returned.
*/
@Test
public void _beginOfScript() {
String multiScript = "ab" + katakana ;
int pos = oObj.beginOfScript(multiScript, 3, ScriptType.ASIAN) ;
System.out.println("Position = " + pos) ;
Assert.assertTrue("beginOfScript()", pos == 2) ;
}
/**
* Tries to find the end of the nearest script specified
* relatively to position passed.
* Has OK status if the end position of script is returned.
*/
@Test
public void _endOfScript() {
String multiScript = "ab" + katakana + "cd" ;
int pos = oObj.endOfScript(multiScript, 2, ScriptType.ASIAN) ;
System.out.println("Position = " + pos) ;
Assert.assertTrue("endOfScript()", pos == 4) ;
}
/**
* Tries to find the next script starting position specified
* relatively to position passed.
* Has OK status if the appropriate position is returned.
*/
@Test
public void _nextScript() {
String multiScript = "ab" + katakana + "cd" ;
int pos = oObj.nextScript(multiScript, 0, ScriptType.LATIN) ;
System.out.println("Position = " + pos) ;
Assert.assertTrue("nextScript()", pos == 4) ;
}
/**
* Tries to find the previous script starting position specified
* relatively to position passed.
* Has OK status if the appropriate position is returned.
*/
@Test
public void _previousScript() {
String multiScript = "ab" + katakana + "cd" ;
int pos = oObj.previousScript(multiScript, 5, ScriptType.ASIAN) ;
System.out.println("Position = " + pos) ;
Assert.assertTrue("previousScript()", pos == 2) ;
}
/**
* Tries to determine script type (of all four types).
* Has OK status if
*
* Has OK status if the end of each boundary is the same
* as start of the next one and if the start of the first block
* has position 0 and the end of the last block is at the end
* of the whole string.
*/
@Test
public void _beginOfCharBlock() {
Assert.assertTrue("beginOfCharBlock()", beginOfCharBlock());
}
private boolean beginOfCharBlock() {
boolean bCharBlockRes = true;
int iPos = 0;
while( iPos < UnicodeString.length() && iPos > -1) {
short charType = getCharBlockType(iPos);
int startPos = oObj.beginOfCharBlock(UnicodeString, iPos,
locale, charType);
int endPos = oObj.endOfCharBlock(UnicodeString, iPos,
locale, charType);
iPos = endPos;
vCharBlockBounds.add(new Boundary(startPos, endPos));
System.out.println("" + vCharBlockBounds.size() + "). Bounds: ["
+ startPos + "," + endPos + "]; Type = " + charType);
vCharBlockTypes.add(new Short(charType));
}
for(int i = 0; i < vCharBlockBounds.size() - 1; i++) {
int endPos = ((Boundary)vCharBlockBounds.get(i)).endPos;
int startPos = ((Boundary)vCharBlockBounds.get(i + 1)).startPos;
bCharBlockRes &= endPos == startPos;
}
System.out.println("Testing for no intersections : " + bCharBlockRes);
int startPos = ((Boundary)vCharBlockBounds.get(0)).startPos;
bCharBlockRes &= startPos == 0;
int endPos = ((Boundary)vCharBlockBounds.get
(vCharBlockBounds.size() - 1)).endPos;
bCharBlockRes &= endPos == UnicodeString.length();
System.out.println("Regions should starts with 0 and ends with "
+ UnicodeString.length());
return bCharBlockRes;
}
/**
* Testing of this method is performed in
*
* Has the status same as
*
* Has OK status if the start of every block was found and it's
* equal to this block boundary start.
*/
public void _nextCharBlock() {
beginOfCharBlock();
boolean bRes = true;
for(int i = 0; i < vCharBlockBounds.size(); i++) {
Boundary bounds = (Boundary)vCharBlockBounds.get(i);
Short type = (Short)vCharBlockTypes.get(i);
if (bounds.startPos - 1 < 0) continue;
int iPos = oObj.nextCharBlock(UnicodeString, bounds.startPos - 1,
locale, type.shortValue());
if (iPos != bounds.startPos) {
bRes = false;
System.out.println("nextCharBlock(UnicodeString, "
+ (bounds.startPos - 1) + ", locale, " + type
+ ") should return " + bounds.startPos);
System.out.println("... and actual value is " + iPos);
}
}
Assert.assertTrue("nextCharBlock()", bRes);
}
/**
* For every character block obtained in
*
* Has OK status if the start of every block was found and it's
* equal to this block boundary start.
*/
public void _previousCharBlock() {
beginOfCharBlock();
boolean bRes = true;
for(int i = 0; i < vCharBlockBounds.size(); i++) {
Boundary bounds = (Boundary)vCharBlockBounds.get(i);
Short type = (Short)vCharBlockTypes.get(i);
int iPos = oObj.previousCharBlock(UnicodeString,
bounds.endPos + 1, locale, type.shortValue());
if (iPos != bounds.startPos) {
bRes = false;
System.out.println("previousCharBlock(UnicodeString, "
+ (bounds.endPos + 1) + ", locale, " + type
+ ") should return " + bounds.startPos);
System.out.println("... and actual value is " + iPos);
}
}
Assert.assertTrue("previousCharBlock()", bRes);
}
}
nextWord method test
* computes bounds of the word, passing its internal character position.getWordBoundary()
* method are the same as bounds obtained by nextWord method.
*/
@Test
public void _getWordBoundary() {
ArrayListnextWord method test
* get its type, passing its internal character position.WordType.ANY_WORD
*/
@Test
public void _getWordType() {
ArrayListnextWord method test
* tries to determine if the character at a position starts a word.
* First word starting position is passed, then internal character
* position is passed. true
* returned and in the second - false for every word.
*/
@Test
public void _isBeginWord() {
ArrayListnextWord method test
* tries to determine if the character at a position ends a word.
* First word ending position is passed, then internal character
* position is passed. true
* returned and in the second - false for every word.
*/
@Test
public void _isEndWord() {
ArrayListbeginOfSentence() test tries to compute end
* position of a sentence and checks that the end position is
* greater than starting.
* Then wrong position arguments are passed.
*
* Has OK status if the end position of every sentence
* greater than starting and -1 returned for invalid arguments.
*/
@Test
public void _endOfSentence() {
boolean bRes = true;
for(int i = 0; i < vSentenceStart.size(); i++) {
int start = ((Integer)vSentenceStart.get(i)).intValue();
int end = oObj.endOfSentence(UnicodeString, start, locale);
bRes &= end > start;
System.out.println("Sentence " + i + " range is [" + start + ", "
+ end + "]");
}
//test for invalid nStartPosition
boolean bInvRes = oObj.endOfSentence(UnicodeString, -10, locale) == -1;
bInvRes &= oObj.endOfSentence(UnicodeString,
UnicodeString.length() + 1, locale) == -1;
if (!bInvRes) {
System.out.println("When invalid position, returned value isn't equal to -1");
}
Assert.assertTrue("endOfSentence()", bRes && bInvRes);
}
/**
* Tries to break a string in position other than 0 iterating characters
* from the string beginning (Hyphenation is not used for a while). LATIN type returned
* for ASCII character, ASIAN for Katakana Unicode
* codepoints, COMPLEX for Arabic Unicode
* codepoints and WEAK for codepoints from Arrows
* Unicode block.
*/
@Test
public void _getScriptType() {
boolean res = true ;
res &= oObj.getScriptType("abcd", 0) == ScriptType.LATIN ;
res &= oObj.getScriptType(katakana, 0) == ScriptType.ASIAN;
res &= oObj.getScriptType(arabic, 0) == ScriptType.COMPLEX ;
res &= oObj.getScriptType(arrows, 0) == ScriptType.WEAK ;
Assert.assertTrue("getScriptType()", res) ;
}
protected short getCharBlockType(int pos) {
short i = 1;
short cType = 0;
while (i < 31) {
if (oObj.beginOfCharBlock(UnicodeString, pos, locale, i) != -1) {
cType = i;
i = 100;
}
i++;
}
return cType;
}
Vector vCharBlockBounds = new Vector();
Vector vCharBlockTypes = new Vector();
/**
* Creates array of all char blocks with their boundaries and
* types using beginOfCharBlock() and
* endOfCharBlock() methods. beginOfCharBlock()
* method test. beginOfCharBlock() method status.
*/
public void _endOfCharBlock() {
Assert.assertTrue("endOfCharBlock()", beginOfCharBlock());
}
/**
* For every character block obtained in beginOfCharBlock()
* method test (except the first) tries to find its starting position
* by mean of nextCharBlock() method passing as position
* argument the position before the start of a block. beginOfCharBlock()
* method test (except the first) tries to find its starting position
* by mean of previousCharBlock() method passing as position
* argument the position after the end of a block.