testautomation/framework/tools/includes/i18n_tools.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: i18n_tools.inc,v $
  10 '*
  11 '* $Revision: 1.1 $
  12 '*
  13 '* last change: $Author: jsi $ $Date: 2008-06-16 12:19:06 $
  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 : Tools to ease working with language dependent strings/values
  37 '*
  38 '\******************************************************************************
  39
  40 function hGetI18nData( cSection as string, cLanguage as string ) as string
  41
  42     '///<h3>Retrieve various information about i18n</h3>
  43     '///<i>Uses datafile: framework/tools/input/i18ndata.txt</i><br>
  44     '///<u>Input</u>:
  45     '///<ol>
  46     '///+<li>Section from which to retrieve the data (string)</li>
  47     '///<ul>
  48     '///+<li>Any name of a section existing in the datafile</li>
  49     '///</ul>
  50     '///+<li>Language code as string</li>
  51     '///<ul>
  52     '///+<li>Use hGetTwoDigitLangCode(...) to ensure proper string formatting</li>
  53     '///</ul>
  54     '///</ol>
  55     '///<u>Returns</u>:
  56     '///<ol>
  57     '///+<li>Language identifier (string)</li>
  58     '///</ol>
  59     '///<u>Description</u>:
  60     '///<ul>
  61
  62     '///+<li>Create the path to the datafile</li>
  63     dim cPath as string
  64         cPath = gTesttoolPath & "framework\tools\input\i18ndata.txt"
  65         cPath = convertpath( cPath )
  66
  67     '///+<li>Find out the required size of the array to hold the entire file</li>
  68     dim iFileSize as integer
  69         iFileSize = hListFileGetSize( cPath )
  70
  71     '///+<li>Define an array to hold the datafile</li>
  72     dim aFileContent( iFileSize ) as string
  73
  74     '///+<li>Retrieve the requested section from the datafile</li>
  75     hGetDatafileSection( cPath, aFileContent(), cSection, "", "" )
  76
  77     '///+<li>Isolate the requested language item</li>
  78     hGetI18nData() = hGetValueForKeyAsString( aFileContent(), cLanguage )
  79
  80     '///</ul>
  81
  82 end function
  83
  84 '*******************************************************************************
  85
  86 function hGetTwoDigitLangCode( iLanguage as integer ) as string
  87
  88     '///<h3>Retrieve a two digit language code from integer</h3>
  89     '///<i>Replaces and enhances deprecated sub &quot;siSpracheSetzen&quot;</i><br>
  90     '///<u>Input</u>:
  91     '///<ol>
  92     '///+<li>Language Code (integer)</li>
  93     '///<ul>
  94     '///+<li>Any number between (and including) 1 and 99</li>
  95     '///</ul>
  96     '///</ol>
  97     '///<u>Returns</u>:
  98     '///<ol>
  99     '///+<li>Language Code (string)</li>
 100     '///<ul>
 101     '///+<li>1 - 9 -&gt; &quot;01&quot; - &quot;09&quot;</li>
 102     '///+<li>10 - 99 -&gt; &quot;10&quot; - &quot;99&quot;</li>
 103     '///</ul>
 104     '///</ol>
 105     '///<u>Description</u>:
 106     '///<ul>
 107     dim cLanguage as string
 108
 109     '///+<li>Convert single digit language code to two digit language string</li>
 110     if ( ( iLanguage > 0 ) and ( iLanguage < 10 ) ) then
 111         cLanguage = "0" & iLanguage
 112     else
 113         cLanguage = iLanguage
 114     endif
 115
 116     hGetTwoDigitLangCode() = cLanguage
 117     '///</ul>
 118
 119 end function
 120
 121
 122 '*******************************************************************************
 123
 124 function hTestLocale() as boolean
 125
 126
 127     '///<h3>Test whether we are running on an utf8 locale (Linux only)</h3><br>
 128
 129     '///<u>Parameter(s):</u><br>
 130     '///<ol>
 131     '///+<li>No input parameters</li>
 132     '///</ol>
 133
 134
 135     '///<u>Returns:</u><br>
 136     '///<ol>
 137     '///+<li>Errorcondition (boolean)</li>
 138     '///<ul>
 139     '///+<li>TRUE: Yes, this is a UTF-8 locale</li>
 140     '///+<li>FALSE: Anything else</li>
 141     '///</ul>
 142     '///</ol>
 143
 144     const CFN = "hTestLocale::"
 145     dim brc as boolean 'a multi purpose boolean returnvalue
 146     dim irc as integer
 147         irc = 0
 148
 149     dim lc_all as string
 150     dim lang as string
 151
 152     '///<u>Description:</u>
 153     '///<ul>
 154
 155     if ( gtSysName = "Linux" ) then
 156
 157         '///+<li>Retrieve LANG</li>
 158         lang = environ( "LANG" )
 159         lang = ucase( lang )
 160         if ( instr( lang , "UTF8" ) or instr( lang , "UTF-8" ) ) then
 161             irc = 1
 162         endif
 163
 164         '///+<li>Retrieve LC_ALL (Note that this variable is mostly set but has no value assigned)</li>
 165         lc_all = environ( "LC_ALL" )
 166         lc_all = ucase( lc_all )
 167         if ( instr( lc_all , "UTF8" ) or instr( lc_all , "UTF-8" ) ) then
 168             irc = irc + 1
 169         else
 170             if ( lc_all = "" ) then
 171                 printlog( CFN & "No value set for LC_ALL, assuming UTF-8" )
 172                 irc = irc + 1
 173             else
 174                 printlog( CFN & "LC_ALL is set but has no UTF-8 locale" )
 175             endif
 176         endif
 177
 178     else
 179
 180         irc = 2 ' this is Windows and Solaris - they always can handle weird content
 181
 182     endif
 183
 184     if ( irc = 2 ) then
 185         printlog( CFN & "UTF-8 locale found" )
 186         hTestLocale() = TRUE
 187     else
 188         printlog( CFN & "Please verify that you are running on UTF-8 locale" )
 189         hTestLocale() = FALSE
 190     endif
 191
 192     '///</ul>
 193
 194
 195 end function