connectivity/source/drivers/firebird/Util.hxx

   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
  10 #ifndef INCLUDED_CONNECTIVITY_SOURCE_DRIVERS_FIREBIRD_UTIL_HXX
  11 #define INCLUDED_CONNECTIVITY_SOURCE_DRIVERS_FIREBIRD_UTIL_HXX
  12
  13 #include <ibase.h>
  14
  15 #include <rtl/ustring.hxx>
  16 #include <rtl/ustrbuf.hxx>
  17
  18 #include <com/sun/star/sdbc/DataType.hpp>
  19 #include <com/sun/star/sdbc/SQLException.hpp>
  20
  21 #include <vector>
  22
  23 namespace connectivity
  24 {
  25     namespace firebird
  26     {
  27         typedef ::std::vector< OString > OStringVector;
  28         // Type Blob has 2 subtypes values
  29         // 0 for BLOB, 1 for CLOB
  30         // see http://www.firebirdfaq.org/faq48/
  31         enum class BlobSubtype {
  32             Blob = 0,
  33             Clob = 1
  34         };
  35
  36         /**
  37          * Make sure an identifier is safe to use within the databse. Currently
  38          * firebird seems to return identifiers with 93 character (instead of
  39          * 31), whereby the name is simply padded with trailing whitespace.
  40          * This removes all trailing whitespace (i.e. if necessary so that
  41          * the length is below 31 characters). Firebird automatically compensates
  42          * for such shorter strings, however any trailing padding makes the gui
  43          * editing of such names harder, hence we remove all trailing whitespace.
  44          */
  45         OUString sanitizeIdentifier(const OUString& rIdentifier);
  46
  47         inline bool IndicatesError(const ISC_STATUS_ARRAY& rStatusVector)
  48         {
  49             return rStatusVector[0]==1 && rStatusVector[1]; // indicates error;
  50         }
  51
  52         OUString StatusVectorToString(const ISC_STATUS_ARRAY& rStatusVector,
  53                                     const OUString& rCause);
  54
  55         /**
  56          * Evaluate a firebird status vector and throw exceptions as necessary.
  57          * The content of the status vector is included in the thrown exception.
  58          */
  59         void evaluateStatusVector(const ISC_STATUS_ARRAY& rStatusVector,
  60                                   const ::rtl::OUString& aCause,
  61                                   const css::uno::Reference< css::uno::XInterface >& _rxContext)
  62                 throw (css::sdbc::SQLException);
  63
  64         sal_Int32 getColumnTypeFromFBType(short aType, short aSubType);
  65         ::rtl::OUString getColumnTypeNameFromFBType(short aType, short aSubType);
  66
  67         /**
  68          * Internally (i.e. in RDB$FIELD_TYPE) firebird stores the data type
  69          * for a column as defined in blr_*, however in the firebird
  70          * api the SQL_* types are used, hence we need to be able to convert
  71          * between the two when retrieving column metadata.
  72          */
  73         short getFBTypeFromBlrType(short blrType);
  74
  75         void mallocSQLVAR(XSQLDA* pSqlda);
  76
  77         void freeSQLVAR(XSQLDA* pSqlda);
  78
  79         OUString escapeWith( const OUString& sText, const char aKey, const char aEscapeChar);
  80         sal_Int64 pow10Integer( int nDecimalCount );
  81     }
  82 }
  83 #endif // INCLUDED_CONNECTIVITY_SOURCE_DRIVERS_FIREBIRD_UTIL_HXX
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */