qadevOOo/tests/java/mod/_sw/SwXTextCursor.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18 package mod._sw;
  19
  20 import java.io.PrintWriter;
  21 import java.util.ArrayList;
  22 import java.util.Arrays;
  23
  24 import lib.TestCase;
  25 import lib.TestEnvironment;
  26 import lib.TestParameters;
  27 import util.SOfficeFactory;
  28
  29 import com.sun.star.beans.Property;
  30 import com.sun.star.beans.PropertyAttribute;
  31 import com.sun.star.beans.XPropertySet;
  32 import com.sun.star.text.ControlCharacter;
  33 import com.sun.star.text.XParagraphCursor;
  34 import com.sun.star.text.XSimpleText;
  35 import com.sun.star.text.XTextCursor;
  36 import com.sun.star.text.XTextDocument;
  37 import com.sun.star.uno.UnoRuntime;
  38 import com.sun.star.uno.XInterface;
  39
  40
  41 /**
  42  * Test for object which is represented by service
  43  * <code>com.sun.star.text.TextCursor</code>. <p>
  44  * Object implements the following interfaces :
  45  * <ul>
  46  *  <li> <code>com::sun::star::text::XTextCursor</code></li>
  47  *  <li> <code>com::sun::star::text::XWordCursor</code></li>
  48  *  <li> <code>com::sun::star::style::CharacterPropertiesComplex</code></li>
  49  *  <li> <code>com::sun::star::text::XTextRange</code></li>
  50  *  <li> <code>com::sun::star::beans::XPropertySet</code></li>
  51  *  <li> <code>com::sun::star::container::XContentEnumerationAccess</code></li>
  52  *  <li> <code>com::sun::star::beans::XPropertyState</code></li>
  53  *  <li> <code>com::sun::star::style::CharacterProperties</code></li>
  54  *  <li> <code>com::sun::star::text::XSentenceCursor</code></li>
  55  *  <li> <code>com::sun::star::style::ParagraphProperties</code></li>
  56  *  <li> <code>com::sun::star::text::XParagraphCursor</code></li>
  57  *  <li> <code>com::sun::star::document::XDocumentInsertable</code></li>
  58  *  <li> <code>com::sun::star::util::XSortable</code></li>
  59  *  <li> <code>com::sun::star::style::CharacterPropertiesAsian</code></li>
  60  * </ul> <p>
  61  * This object test <b> is NOT </b> designed to be run in several
  62  * threads concurrently.
  63  * @see com.sun.star.text.XTextCursor
  64  * @see com.sun.star.text.XWordCursor
  65  * @see com.sun.star.style.CharacterPropertiesComplex
  66  * @see com.sun.star.text.XTextRange
  67  * @see com.sun.star.beans.XPropertySet
  68  * @see com.sun.star.container.XContentEnumerationAccess
  69  * @see com.sun.star.beans.XPropertyState
  70  * @see com.sun.star.style.CharacterProperties
  71  * @see com.sun.star.text.XSentenceCursor
  72  * @see com.sun.star.style.ParagraphProperties
  73  * @see com.sun.star.text.XParagraphCursor
  74  * @see com.sun.star.document.XDocumentInsertable
  75  * @see com.sun.star.util.XSortable
  76  * @see com.sun.star.style.CharacterPropertiesAsian
  77  * @see ifc.text._XTextCursor
  78  * @see ifc.text._XWordCursor
  79  * @see ifc.style._CharacterPropertiesComplex
  80  * @see ifc.text._XTextRange
  81  * @see ifc.beans._XPropertySet
  82  * @see ifc.container._XContentEnumerationAccess
  83  * @see ifc.beans._XPropertyState
  84  * @see ifc.style._CharacterProperties
  85  * @see ifc.text._XSentenceCursor
  86  * @see ifc.style._ParagraphProperties
  87  * @see ifc.text._XParagraphCursor
  88  * @see ifc.document._XDocumentInsertable
  89  * @see ifc.util._XSortable
  90  * @see ifc.style._CharacterPropertiesAsian
  91  */
  92 public class SwXTextCursor extends TestCase {
  93     XTextDocument xTextDoc;
  94
  95     /**
  96     * Creates text document.
  97     */
  98     @Override
  99     protected void initialize(TestParameters tParam, PrintWriter log) throws Exception {
 100         SOfficeFactory SOF = SOfficeFactory.getFactory( tParam.getMSF());
 101         log.println("creating a textdocument");
 102         xTextDoc = SOF.createTextDoc(null);
 103     }
 104
 105     /**
 106     * Disposes text document.
 107     */
 108     @Override
 109     protected void cleanup(TestParameters tParam, PrintWriter log) {
 110         log.println("    disposing xTextDoc ");
 111         util.DesktopTools.closeDoc(xTextDoc);
 112     }
 113
 114     /**
 115     * Creating a TestEnvironment for the interfaces to be tested. After major
 116     * text of text document is obtained, text cursor is created and several
 117     * paragraphs within the text are inserted to a text document. Finally,
 118     * text cursor is returned as a test component.
 119     *     Object relations created :
 120     * <ul>
 121     *  <li> <code>'XTEXT'</code> for
 122     *      {@link ifc.text._XTextRange} : major text of text document</li>
 123     * </ul>
 124     */
 125     @Override
 126     protected TestEnvironment createTestEnvironment(TestParameters Param,
 127                                                                  PrintWriter log) {
 128         XInterface oObj = null;
 129
 130         log.println("creating a test environment");
 131
 132
 133         // get the bodytext of textdocument here
 134         log.println("getting the TextCursor");
 135
 136         final XSimpleText aText = xTextDoc.getText();
 137         final XTextCursor textCursor = aText.createTextCursor();
 138         oObj = textCursor;
 139
 140         log.println("inserting some text");
 141
 142         try {
 143             for (int i = 0; i < 3; i++) {
 144                 aText.insertString(textCursor, "" + (3 - i), false);
 145
 146                 for (int j = 0; j < 5; j++) {
 147                     aText.insertString(textCursor, "XTextCursor,XTextCursor",
 148                                        false);
 149                     aText.insertString(textCursor, "The quick brown fox ",
 150                                        false);
 151                     aText.insertString(textCursor, "jumps over the lazy dog ",
 152                                        false);
 153                 }
 154
 155                 aText.insertControlCharacter(textCursor,
 156                                              ControlCharacter.PARAGRAPH_BREAK,
 157                                              false);
 158                 aText.insertControlCharacter(textCursor,
 159                                              ControlCharacter.LINE_BREAK,
 160                                              false);
 161             }
 162         } catch (com.sun.star.lang.IllegalArgumentException e) {
 163             log.println("Error, insert text to text document.");
 164             e.printStackTrace(log);
 165         }
 166
 167         log.println("creating a new environment for SwXTextCursor object");
 168
 169         TestEnvironment tEnv = new TestEnvironment(oObj);
 170
 171         tEnv.addObjRelation("XTEXT", xTextDoc.getText());
 172
 173         XPropertySet xCursorProp = UnoRuntime.queryInterface(
 174                                            XPropertySet.class, oObj);
 175
 176         String[] skipNames = { "ParaBackGraphicURL" };
 177         String[] propertyNames = getPropertyNames(xCursorProp, skipNames);
 178
 179         tEnv.addObjRelation("PropertyNames", propertyNames);
 180         tEnv.addObjRelation("SkipProperties", propertyNames);
 181
 182         //Adding relation for util.XSortable
 183         final XParagraphCursor paragrCursor = UnoRuntime.queryInterface(
 184                                                       XParagraphCursor.class,
 185                                                       oObj);
 186         final PrintWriter finalLog = log;
 187
 188         tEnv.addObjRelation("SORTCHECKER",
 189                             new ifc.util._XSortable.XSortChecker() {
 190             PrintWriter out = finalLog;
 191
 192             public void setPrintWriter(PrintWriter log) {
 193                 out = log;
 194             }
 195
 196             public void prepareToSort() {
 197                 textCursor.gotoEnd(false);
 198
 199                 try {
 200                     aText.insertControlCharacter(textCursor,
 201                                                  ControlCharacter.PARAGRAPH_BREAK,
 202                                                  false);
 203                     aText.insertString(textCursor, "4", false);
 204                     aText.insertControlCharacter(textCursor,
 205                                                  ControlCharacter.PARAGRAPH_BREAK,
 206                                                  false);
 207                     aText.insertString(textCursor, "b", false);
 208                     aText.insertControlCharacter(textCursor,
 209                                                  ControlCharacter.PARAGRAPH_BREAK,
 210                                                  false);
 211                     aText.insertString(textCursor, "3", false);
 212                     aText.insertControlCharacter(textCursor,
 213                                                  ControlCharacter.PARAGRAPH_BREAK,
 214                                                  false);
 215                     aText.insertString(textCursor, "a", false);
 216                     aText.insertControlCharacter(textCursor,
 217                                                  ControlCharacter.PARAGRAPH_BREAK,
 218                                                  false);
 219                     aText.insertString(textCursor, "23", false);
 220                     aText.insertControlCharacter(textCursor,
 221                                                  ControlCharacter.PARAGRAPH_BREAK,
 222                                                  false);
 223                     aText.insertString(textCursor, "ab", false);
 224                     aText.insertControlCharacter(textCursor,
 225                                                  ControlCharacter.PARAGRAPH_BREAK,
 226                                                  false);
 227                 } catch (com.sun.star.lang.IllegalArgumentException e) {
 228                     out.println("Unexpected exception:" + e);
 229                 }
 230
 231                 out.println(
 232                         "Preparing cursor to sorting. Text before sorting:");
 233                 paragrCursor.gotoEnd(true);
 234
 235                 for (int i = 0; i < 6; i++) {
 236                     paragrCursor.gotoPreviousParagraph(true);
 237                 }
 238
 239                 out.println(textCursor.getString());
 240             }
 241
 242             public boolean checkSort(boolean isSortNumbering,
 243                                      boolean isSortAscending) {
 244                 out.println("Sort checking...");
 245
 246                 String ls = System.getProperty("line.separator");
 247
 248                 String text = paragrCursor.getString();
 249                 out.println("Text after sorting:\n" + text);
 250
 251                 boolean res = false;
 252
 253                 if (isSortNumbering) {
 254                     if (isSortAscending) {
 255                         res = text.endsWith(ls+"3"+ls+"4"+ls+"23");
 256
 257                         if (!res) {
 258                             out.println("Text must ends by:\n" + "\r\n3\r\n4\r\n23\r\n");
 259                         }
 260                     } else {
 261                         res = text.startsWith("23"+ls+"4"+ls+"3"+ls);
 262
 263                         if (!res) {
 264                             out.println("Text must starts with:\n" + "23\r\n4\r\n3\r\n");
 265                         }
 266                     }
 267                 } else {
 268                     if (isSortAscending) {
 269                         res = text.equals(ls+"23"+ls+"3"+ls+"4"+ls+"a"+ls+"ab"+ls+"b");
 270
 271                         if (!res) {
 272                             out.println("Text must be equal to:\n" + "\r\n23\r\n3\r\n4\r\na\r\nab\r\nb\r\n");
 273                         }
 274                     } else {
 275                         res = text.endsWith("b"+ls+"ab"+ls+"a"+ls+"4"+ls+"3"+ls+"23"+ls);
 276
 277                         if (!res) {
 278                             out.println("Text must be equal to:\n" + "b\r\nab\r\na\r\n4\r\n3\r\n23\r\n");
 279                         }
 280                     }
 281                 }
 282
 283                 if (res) {
 284                     out.println("Sorted correctly");
 285                 }
 286
 287                 return res;
 288             }
 289         });
 290
 291         return tEnv;
 292     } // finish method getTestEnvironment
 293
 294     public String[] getPropertyNames(XPropertySet props, String[] skipList) {
 295         Property[] the_props = props.getPropertySetInfo().getProperties();
 296         ArrayList<String> names = new ArrayList<String>();
 297
 298         for (int i = 0; i < the_props.length; i++) {
 299             boolean isWritable = ((the_props[i].Attributes & PropertyAttribute.READONLY) == 0);
 300             if (isWritable && !Arrays.asList(skipList).contains(the_props[i].Name)) {
 301                 names.add(the_props[i].Name);
 302             }
 303         }
 304
 305         return names.toArray(new String[names.size()]);
 306     }
 307 } // finish class SwXTextCursor