sc/source/ui/dbgui/asciiopt.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <global.hxx>
  21 #include <asciiopt.hxx>
  22 #include <comphelper/string.hxx>
  23 #include <osl/thread.h>
  24 #include <o3tl/string_view.hxx>
  25 #include <sfx2/objsh.hxx>
  26
  27 constexpr std::u16string_view pStrFix = u"FIX";
  28 constexpr std::u16string_view pStrMrg = u"MRG";
  29 constexpr std::u16string_view pStrDet = u"DETECT";
  30
  31 ScAsciiOptions::ScAsciiOptions() :
  32     bFixedLen       ( false ),
  33     aFieldSeps      ( OUString(';') ),
  34     bMergeFieldSeps ( false ),
  35     bRemoveSpace    ( false ),
  36     bQuotedFieldAsText(false),
  37     bDetectSpecialNumber(false),
  38     bDetectScientificNumber(true),
  39     bEvaluateFormulas(true),
  40     bSkipEmptyCells(false),
  41     bSaveAsShown(true),
  42     bSaveFormulas(false),
  43     bIncludeBOM(false),
  44     cTextSep        ( cDefaultTextSep ),
  45     eCharSet        ( osl_getThreadTextEncoding() ),
  46     eLang           ( LANGUAGE_SYSTEM ),
  47     bCharSetSystem  ( false ),
  48     nStartRow       ( 1 )
  49 {
  50 }
  51
  52 void ScAsciiOptions::SetColumnInfo( const ScCsvExpDataVec& rDataVec )
  53 {
  54     sal_uInt16 nInfoCount = static_cast< sal_uInt16 >( rDataVec.size() );
  55     mvColStart.resize(nInfoCount);
  56     mvColFormat.resize(nInfoCount);
  57     for( sal_uInt16 nIx = 0; nIx < nInfoCount; ++nIx )
  58     {
  59         mvColStart[ nIx ] = rDataVec[ nIx ].mnIndex;
  60         mvColFormat[ nIx ] = rDataVec[ nIx ].mnType;
  61     }
  62 }
  63
  64 static OUString lcl_decodeSepString( std::u16string_view rSepNums, bool & o_bMergeFieldSeps )
  65 {
  66     if ( rSepNums.empty() )
  67         return OUString();
  68
  69     OUStringBuffer aFieldSeps;
  70     sal_Int32 nPos = 0;
  71     do
  72     {
  73         const std::u16string_view aCode = o3tl::getToken(rSepNums, 0, '/', nPos );
  74         if ( aCode == pStrMrg )
  75             o_bMergeFieldSeps = true;
  76         else
  77         {
  78             sal_Int32 nVal = o3tl::toInt32(aCode);
  79             if ( nVal )
  80                 aFieldSeps.append(sal_Unicode(nVal));
  81         }
  82     }
  83     while ( nPos >= 0 );
  84
  85     return aFieldSeps.makeStringAndClear();
  86 }
  87
  88 // The options string must not contain semicolons (because of the pick list),
  89 // use comma as separator.
  90
  91 void ScAsciiOptions::ReadFromString( std::u16string_view rString, SvStream* pStream4Detect )
  92 {
  93     sal_Int32 nPos = rString.empty() ? -1 : 0;
  94     bool bDetectSep = false;
  95
  96     // Token 0: Field separator.
  97     if ( nPos >= 0 )
  98     {
  99         bFixedLen = bMergeFieldSeps = false;
 100
 101         const std::u16string_view aToken = o3tl::getToken(rString, 0, ',', nPos);
 102         if ( aToken == pStrDet)
 103             bDetectSep = true;
 104         else
 105         {
 106             if ( aToken == pStrFix )
 107                 bFixedLen = true;
 108             aFieldSeps = lcl_decodeSepString( aToken, bMergeFieldSeps);
 109         }
 110     }
 111
 112     // Token 1: Text separator.
 113     if ( nPos >= 0 )
 114     {
 115         const sal_Int32 nVal = o3tl::toInt32(o3tl::getToken(rString, 0, ',', nPos));
 116         cTextSep = static_cast<sal_Unicode>(nVal);
 117     }
 118
 119     // Token 2: Text encoding.
 120     if ( nPos >= 0 )
 121     {
 122         const std::u16string_view aToken = o3tl::getToken(rString, 0, ',', nPos);
 123         SvStreamEndian endian;
 124         bool bDetectCharSet = aToken == pStrDet;
 125         if ( bDetectCharSet && pStream4Detect )
 126         {
 127             SfxObjectShell::DetectCharSet(*pStream4Detect, eCharSet, endian);
 128             if (eCharSet == RTL_TEXTENCODING_UNICODE)
 129                 pStream4Detect->SetEndian(endian);
 130         }
 131         else if (!bDetectCharSet)
 132             eCharSet = ScGlobal::GetCharsetValue( aToken );
 133     }
 134
 135     if (bDetectSep && pStream4Detect)
 136         SfxObjectShell::DetectCsvSeparators(*pStream4Detect, eCharSet, aFieldSeps, cTextSep);
 137
 138     // Token 3: Number of start row.
 139     if ( nPos >= 0 )
 140     {
 141         nStartRow = o3tl::toInt32(o3tl::getToken(rString, 0, ',', nPos));
 142     }
 143
 144     // Token 4: Column info.
 145     if ( nPos >= 0 )
 146     {
 147         const std::u16string_view aToken = o3tl::getToken(rString, 0, ',', nPos);
 148         const sal_Int32 nInfoCount = comphelper::string::getTokenCount(aToken, '/')/2;
 149         mvColStart.resize(nInfoCount);
 150         mvColFormat.resize(nInfoCount);
 151         sal_Int32 nP = 0;
 152         for (sal_Int32 nInfo=0; nInfo<nInfoCount; ++nInfo)
 153         {
 154             mvColStart[nInfo]  = o3tl::toInt32(o3tl::getToken(aToken, 0, '/', nP));
 155             mvColFormat[nInfo] = static_cast<sal_uInt8>(o3tl::toInt32(o3tl::getToken(aToken, 0, '/', nP)));
 156         }
 157     }
 158
 159     // Token 5: Language.
 160     if (nPos >= 0)
 161     {
 162         eLang = static_cast<LanguageType>(o3tl::toInt32(o3tl::getToken(rString, 0, ',', nPos)));
 163     }
 164
 165     // Token 6: Import quoted field as text.
 166     if (nPos >= 0)
 167     {
 168         bQuotedFieldAsText = o3tl::getToken(rString, 0, ',', nPos) == u"true";
 169     }
 170
 171     // Token 7: Detect special numbers.
 172     if (nPos >= 0)
 173     {
 174         bDetectSpecialNumber = o3tl::getToken(rString, 0, ',', nPos) == u"true";
 175     }
 176     else
 177         bDetectSpecialNumber = true;    // default of versions that didn't add the parameter
 178
 179     // Token 8: used for "Save as shown" in export options
 180     if ( nPos >= 0 )
 181     {
 182         bSaveAsShown = o3tl::getToken(rString, 0, ',', nPos) == u"true";
 183     }
 184     else
 185         bSaveAsShown = true;    // default value
 186
 187     // Token 9: used for "Save cell formulas" in export options
 188     if ( nPos >= 0 )
 189     {
 190         bSaveFormulas = o3tl::getToken(rString, 0, ',', nPos) == u"true";
 191     }
 192     else
 193         bSaveFormulas = false;
 194
 195     // Token 10: Boolean for Trim spaces.
 196     if (nPos >= 0)
 197     {
 198         bRemoveSpace = o3tl::getToken(rString, 0, ',', nPos) == u"true";
 199     }
 200     else
 201         bRemoveSpace = false;
 202
 203     // Token 11: sheet to export for --convert-to csv
 204     // Does not need to be evaluated here but may be present.
 205     if (nPos >= 0)
 206     {
 207         o3tl::getToken(rString, 0, ',', nPos);
 208     }
 209
 210     // Token 12: evaluate formulas.
 211     if (nPos >= 0)
 212     {
 213         // If present, defaults to "false".
 214         bEvaluateFormulas = o3tl::getToken(rString, 0, ',', nPos) == u"true";
 215     }
 216     else
 217         bEvaluateFormulas = true;   // default of versions that didn't add the parameter
 218
 219     // Token 13: include BOM.
 220     bIncludeBOM = nPos >= 0 && o3tl::getToken(rString, 0, ',', nPos) == u"true";
 221
 222     // Token 14: Detect scientific numbers.
 223     if (nPos >= 0)
 224     {
 225         bDetectScientificNumber = o3tl::getToken(rString, 0, ',', nPos) == u"true";
 226     }
 227     else
 228         bDetectScientificNumber = true;    // default of versions that didn't add the parameter
 229
 230 }
 231
 232 OUString ScAsciiOptions::WriteToString() const
 233 {
 234     OUStringBuffer aOutStr;
 235
 236     // Token 0: Field separator.
 237     if ( bFixedLen )
 238         aOutStr.append(pStrFix);
 239     else if ( aFieldSeps.isEmpty() )
 240         aOutStr.append("0");
 241     else
 242     {
 243         sal_Int32 nLen = aFieldSeps.getLength();
 244         for (sal_Int32 i=0; i<nLen; i++)
 245         {
 246             if (i)
 247                 aOutStr.append("/");
 248             aOutStr.append(OUString::number(aFieldSeps[i]));
 249         }
 250         if ( bMergeFieldSeps )
 251         {
 252             aOutStr.append(OUString::Concat("/") + pStrMrg);
 253         }
 254     }
 255
 256     // Token 1: Text Quote character.
 257     aOutStr.append("," + OUString::number(cTextSep) + ",");
 258
 259     //Token 2: Text encoding.
 260     if ( bCharSetSystem )           // force "SYSTEM"
 261         aOutStr.append(ScGlobal::GetCharsetString( RTL_TEXTENCODING_DONTKNOW ));
 262     else
 263         aOutStr.append(ScGlobal::GetCharsetString( eCharSet ));
 264
 265     //Token 3: Number of start row.
 266     aOutStr.append("," + OUString::number(nStartRow) + ",");
 267
 268     //Token 4: Column info.
 269     for (size_t nInfo=0; nInfo<mvColStart.size(); nInfo++)
 270     {
 271         if (nInfo)
 272             aOutStr.append("/");
 273         aOutStr.append(OUString::number(mvColStart[nInfo]) +
 274                 "/" +
 275                OUString::number(mvColFormat[nInfo]));
 276     }
 277
 278     // #i112025# the options string is used in macros and linked sheets,
 279     // so new options must be added at the end, to remain compatible
 280     // Always keep in sync with ScImportOptions.
 281
 282     aOutStr.append("," +
 283                // Token 5: Language
 284                OUString::number(static_cast<sal_uInt16>(eLang)) + "," +
 285                // Token 6: Import quoted field as text.
 286                OUString::boolean( bQuotedFieldAsText ) + "," +
 287                // Token 7: Detect special numbers.
 288                OUString::boolean( bDetectSpecialNumber ) + "," +
 289                // Token 8: used for "Save as shown" in export options
 290                OUString::boolean( bSaveAsShown ) +"," +
 291                // Token 9: used for "Save cell formulas" in export options
 292                OUString::boolean( bSaveFormulas ) + "," +
 293                // Token 10: Trim Space
 294                OUString::boolean( bRemoveSpace ) +
 295                // Token 11: sheet to export, always 0 for current sheet
 296                ",0," +
 297                // Token 12: evaluate formulas in import
 298                OUString::boolean( bEvaluateFormulas ) + "," +
 299                // Token 13: include BOM
 300                OUString::boolean(bIncludeBOM) + "," +
 301                // Token 14: Detect scientific numbers.
 302                OUString::boolean( bDetectScientificNumber )
 303             );
 304     return aOutStr.makeStringAndClear();
 305 }
 306
 307 // static
 308 sal_Unicode ScAsciiOptions::GetWeightedFieldSep( const OUString & rFieldSeps, bool bDecodeNumbers )
 309 {
 310     bool bMergeFieldSeps = false;
 311     OUString aFieldSeps( bDecodeNumbers ? lcl_decodeSepString( rFieldSeps, bMergeFieldSeps) : rFieldSeps);
 312     if (aFieldSeps.isEmpty())
 313     {
 314         return 0;
 315     }
 316     else if (aFieldSeps.getLength() == 1)
 317         return aFieldSeps[0];
 318     else
 319     {
 320         // There can be only one separator for output. See also fdo#53449
 321         if (aFieldSeps.indexOf(',') != -1)
 322             return ',';
 323         else if (aFieldSeps.indexOf('\t') != -1)
 324             return '\t';
 325         else if (aFieldSeps.indexOf(';') != -1)
 326             return ';';
 327         else if (aFieldSeps.indexOf(' ') != -1)
 328             return ' ';
 329         else
 330             return aFieldSeps[0];
 331     }
 332 }
 333
 334 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */