testautomation/global/tools/includes/optional/t_stringtools.inc

   1 'encoding UTF-8  Do not remove or change this line!
   2 '**************************************************************************
   3 '* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 '*
   5 '* Copyright 2008 by Sun Microsystems, Inc.
   6 '*
   7 '* OpenOffice.org - a multi-platform office productivity suite
   8 '*
   9 '* $RCSfile: t_stringtools.inc,v $
  10 '*
  11 '* $Revision: 1.1 $
  12 '*
  13 '* last change: $Author: jsk $ $Date: 2008-06-20 07:59:14 $
  14 '*
  15 '* This file is part of OpenOffice.org.
  16 '*
  17 '* OpenOffice.org is free software: you can redistribute it and/or modify
  18 '* it under the terms of the GNU Lesser General Public License version 3
  19 '* only, as published by the Free Software Foundation.
  20 '*
  21 '* OpenOffice.org is distributed in the hope that it will be useful,
  22 '* but WITHOUT ANY WARRANTY; without even the implied warranty of
  23 '* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24 '* GNU Lesser General Public License version 3 for more details
  25 '* (a copy is included in the LICENSE file that accompanied this code).
  26 '*
  27 '* You should have received a copy of the GNU Lesser General Public License
  28 '* version 3 along with OpenOffice.org.  If not, see
  29 '* <http://www.openoffice.org/license.html>
  30 '* for a copy of the LGPLv3 License.
  31 '*
  32 '/************************************************************************
  33 '*
  34 '*  owner : joerg.skottke@sun.com
  35 '*
  36 '*  short description : Functions for manipulation of strings
  37 '*
  38 '\******************************************************************************
  39
  40 function hRemoveLineBreaks( cString as string ) as string
  41
  42     '///<h3>Remove linebreaks and tabs from a string</h3>
  43     '///<i>Used to &quot;beautify&quot; content of messageboxes when printed to the log</i><br><br>
  44     '///<u>Parameter(s):</u>
  45     '///<ol>
  46     '///+<li>Content of a messagebox as captured with .getText() (string)</li>
  47     '///</ol>
  48     '///<u>Returns</u>:
  49     '///<ol>
  50     '///+<li>A string without tabs, linebreaks and linefeed (string)</li>
  51     '///</ol>
  52     '///<u>Description</u>:
  53     '///<ul>
  54     '///+<li>Walk through the string, replace linebreaks, tabs etc. with spaces</li>
  55
  56     ' Function (undocumented) to remove LF and CR from strings.
  57     ' When a messagebox appears with multiple lines of text this usually
  58     ' breaks the output of the printlog into multiple lines making it
  59     ' hard to read. So this function puts the entire text in one line.
  60
  61     dim iCharPos as integer
  62     dim cCurrentChar as string
  63     dim cNewString as string
  64
  65     ' walk through the string character by character and replace those
  66     ' characters that break the line. Tabs and linebreaks become spaces
  67     for iCharPos = 1 to len( cString )
  68
  69         cCurrentChar = mid( cString , iCharPos , 1 )
  70
  71         select case cCurrentChar
  72         case CHR$(13) : cNewString = cNewString & " " ' replace linebreak
  73         case CHR$(10) : ' Simply ignore linefeed
  74         case CHR$(09) : cNewString = cNewString & " " ' replace tab with space
  75         case else     : cNewString = cNewString & cCurrentChar ' append char
  76         end select
  77
  78      next iCharPos
  79
  80      hRemoveLineBreaks() = cNewString
  81      '///</ul>
  82
  83 end function
  84
  85 '*******************************************************************************
  86
  87 function hCompareSubStrings( cRef as string, cSub as string ) as integer
  88
  89     '///<h3>Find substring in a reference string</h3>
  90     '///<i>Used to determine that we are on &quot;The first doc!&quot;</i><br><br>
  91     '///<u>Parameter(s):</u>
  92     '///<ol>
  93     '///+<li>Term to search for (string)</li>
  94     '///+<li>Term to be searched (string)</li>
  95     '///</ol>
  96     '///<u>Returns</u>:
  97     '///<ol>
  98     '///+<li>Errorcode (integer)</li>
  99     '///<ul>
 100     '///+<li>-1: Invalid parameter(s)</li>
 101     '///+<li>0: Strings do not match</li>
 102     '///+<li>1: Term is exact match</li>
 103     '///+<li>2: Term is a substring</li>
 104     '///</ul>
 105     '///</ol>
 106     '///<u>Description</u>:
 107     '///<ul>
 108
 109     const CFN = "hCompareSubStrings::"
 110
 111     '///+<li>Test function parameters</li>
 112     if ( ( cRef = "" ) or ( cSub = "" ) ) then
 113         warnlog( CFN & "invalid parameter(s): Empty string passed." )
 114         hCompareSubStrings() = -1
 115         exit function
 116     endif
 117
 118     dim irc as integer
 119
 120     '///+<li>Test if we have a substring</li>
 121     if ( instr( cRef, cSub ) > 0 ) then
 122         irc = 2
 123     else
 124         irc = 0
 125     endif
 126
 127     '///+<li>Test if we have an exact match</li>
 128     if ( irc = 2 ) then
 129         if ( ( cRef = cSub ) and ( len( cRef ) = len( cSub ) ) ) then
 130             irc = 1
 131         endif
 132     endif
 133
 134     select case irc
 135     case 0 : printlog( CFN & "No matching substring found" )
 136     case 1 : printlog( CFN & "Strings are identical" )
 137     case 2 : printlog( CFN & "String is substring" )
 138     end select
 139
 140     hCompareSubStrings() = irc
 141     '///</ul>
 142
 143 end function
 144
 145 '******************************************************************************
 146
 147 function hGetDirTreeLevel( cFullPath as string ) as integer
 148
 149     '///<h3>Count the numbers of pathseparators in a path-string</h3>
 150     '///<i>Used to find the level of current directory within the directory tree.<br>
 151     '///+The function prints a warning when no pathseparators were found</i><br><br>
 152     '///<u>Parameter(s):</u>
 153     '///<ol>
 154     '///+<li>Path (string) with <b>no trailing pathseparator</b></li>
 155     '///</ol>
 156     '///<u>Returns</u>:
 157     '///<ol>
 158     '///+<li>Number of Pathseparators within the string (integer)</li>
 159     '///<ul>
 160     '///+<li>0 = failure</li>
 161     '///+<li>&gt; 0 = level</li>
 162     '///</ul>
 163     '///</ol>
 164     '///<u>Description</u>:
 165     '///<ul>
 166
 167     const CFN = "hGetDirTreeLevel::"
 168
 169     dim iCurrentChar as integer
 170     dim cCurrentChar as string
 171     dim iSeparatorCount as integer
 172         iSeparatorCount = 0
 173
 174     '///+<li>Walk through the string</li>
 175     '///<ul>
 176     for iCurrentChar = 1 to len( cFullPath )
 177
 178         '///+<li>Get the next character</li>
 179         cCurrentChar = mid( cFullPath , iCurrentChar , 1 )
 180
 181         '///+<li>If it is a separtator, increase the counter</li>
 182         if ( cCurrentChar = gPathSigne ) then
 183             iSeparatorCount = iSeparatorCount + 1
 184         endif
 185
 186     next iCurrentChar
 187     '///</ul>
 188
 189     '///+<li>Print a warning if no separators were found</li>
 190     if ( iSeparatorCount = 0 ) then
 191         warnlog( CFN & "Did not find any separators in given string: " & cFullPath )
 192     endif
 193     '///</ul>
 194
 195     hGetDirTreeLevel() = iSeparatorCount
 196
 197 end function
 198
 199
 200 '*******************************************************************************
 201
 202 function hGetStringFromStaticTextField( oControl as object ) as string
 203
 204     use "global\tools\includes\optional\t_accels.inc"
 205
 206     '///<h3>Get the string from a static textfield</h3>
 207
 208     '///<i>Static textfields like those in the document properties dialog are
 209     '///+ in certain places designed in a way that the string can be selected
 210     '///+ and copied to the clipboard. This has been introduced with SRC680m212
 211     '///+ (9156). This function uses keyboard shortcuts for &quot;Select All&quot;
 212     '///+ and &quot;Copy&quot; to get the string into the clipboard as .uno.Copy
 213     '///+ is not enabled.</i><br><br>
 214
 215     '///<u>Parameter(s):</u><br>
 216     '///<ol>
 217
 218     '///+<li>Name of the control (Object)</li>
 219     '///<ul>
 220     '///+<li>The object must exist in the current context</li>
 221     '///</ul>
 222
 223     '///</ol>
 224
 225
 226     '///<u>Returns:</u><br>
 227     '///<ol>
 228     '///+<li>Content of the field (String)</li>
 229     '///<ul>
 230     '///+<li>Blank if string is empty</li>
 231     '///</ul>
 232     '///</ol>
 233
 234     const CFN = "hGetStringFromStaticTextField::"
 235     dim brc as boolean 'a multi purpose boolean returnvalue
 236
 237     dim cSelectAll as string
 238     dim cCopy as string
 239     dim cText as string
 240
 241     printlog( CFN & "Enter" )
 242
 243     '///<u>Description:</u>
 244     '///<ul>
 245     '///+<li>Verify that the object exists</li>
 246     '///+<li>Get the accelerator for SelectAll and Copy</li>
 247     '///+<li>Execute SelectAll and Copy on control</li>
 248     '///+<li>Get the string from the clipboard</li>
 249     if ( oControl.exists() ) then
 250         if ( oControl.isVisible() ) then
 251             cSelectAll = hGetAccel( "SelectAll" )
 252             cCopy      = hGetAccel( "Copy"      )
 253
 254             oControl.typeKeys( "<right>" )
 255             oControl.typeKeys( cSelectAll )
 256             oControl.typeKeys(   cCopy    )
 257
 258             cText = getClipboardText()
 259             printlog( CFN & "Exit with result: " & cText )
 260         else
 261             ctext = ""
 262             qaerrorlog( CFN & "Exit: Control exists but is not visible" )
 263         endif
 264     else
 265         cText = ""
 266         qaerrorlog( CFN & "Exit: Control does not exist in this context" )
 267     endif
 268
 269     '///</ul>
 270
 271     hGetStringFromStaticTextField() = cText
 272
 273 end function
 274
 275
 276 '*******************************************************************************
 277
 278 function hConvertStringToLong( cValue as string ) as long
 279
 280
 281     '///<h3>Convert a stringvalue to long int</h3>
 282
 283     '///<i>The purpose of this function is to isolate the filesize from a string
 284     '///+ of the type &quot;1.345 Bytes&quot; by removing the thousands-separator
 285     '///+ and the trailing unit. The result is then a filesize as long integer
 286     '///+ which then can be compared to the result from the BASIC function
 287     '///+ FileLen( FileSpec )</i><br><br>
 288
 289     '///<u>Parameter(s):</u><br>
 290     '///<ol>
 291
 292     '///+<li>String containing a long integer value (String)</li>
 293     '///<ul>
 294     '///+<li>No floating point values allowed</li>
 295     '///+<li>Numeric value must be at the beginning of the string (no leading characters/spaces)</li>
 296     '///+<li>Negative values are allowed</li>
 297     '///+<li>Leading &quot;+&quot; is not allowed</li>
 298     '///</ul>
 299
 300     '///</ol>
 301
 302
 303     '///<u>Returns:</u><br>
 304     '///<ol>
 305     '///+<li>Value of the string as long integer (Long)</li>
 306     '///<ul>
 307     '///+<li>Thousands separator (. or ,) have been removed</li>
 308     '///+<li>Decimal separators (though not allowed) have been removed</li>
 309     '///</ul>
 310     '///</ol>
 311
 312     const CFN = "hConvertStringToLong::"
 313     printlog( CFN & "Enter with option: " & cValue )
 314     dim brc as boolean 'a multi purpose boolean returnvalue
 315
 316     dim iLen as integer
 317         iLen = len( cValue )
 318
 319     dim iChar as integer
 320     dim cChar as string
 321
 322     dim cStringValue as string
 323         cStringValue = ""
 324
 325     '///<u>Description:</u>
 326     '///<ul>
 327     '///+<li>Walk through the single chars of the string</li>
 328     '///<ul>
 329     for iChar = 1 to iLen
 330
 331         '///+<li>Get the current character</li>
 332         cChar = mid( cValue , iChar , 1 )
 333
 334         '///+<li>Copy valid characters to temporary string, drop invalid, exit on first space or other character</li>
 335         select case cChar
 336         case "-" : cStringValue = cStringValue & cChar
 337         case "1" : cStringValue = cStringValue & cChar
 338         case "2" : cStringValue = cStringValue & cChar
 339         case "3" : cStringValue = cStringValue & cChar
 340         case "4" : cStringValue = cStringValue & cChar
 341         case "5" : cStringValue = cStringValue & cChar
 342         case "6" : cStringValue = cStringValue & cChar
 343         case "7" : cStringValue = cStringValue & cChar
 344         case "8" : cStringValue = cStringValue & cChar
 345         case "9" : cStringValue = cStringValue & cChar
 346         case "0" : cStringValue = cStringValue & cChar
 347         case else: ' do nothing
 348         end select
 349
 350     next iChar
 351     '///</ul>
 352
 353     printlog( CFN & "Exit with value: " & cStringValue )
 354
 355     '///+<li>Convert string to long integer and return to calling function</li>
 356     hConvertStringToLong() = val( cStringValue )
 357     '///</ul>
 358
 359 end function