office-gobmx/connectivity/source/inc/odbc/ODatabaseMetaDataResultSet.hxx
Noel Grandin 6e1207c9de loplugin:passstuffbyref in chart2..connectivity
Change-Id: Ic2c6606ea0ce1d5c3089bc4c1a879fed3f2c7aff
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/176180
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2024-11-07 10:03:52 +01:00

256 lines
15 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#pragma once
#include <com/sun/star/sdbc/ResultSetType.hpp>
#include <com/sun/star/sdbc/FetchDirection.hpp>
#include <com/sun/star/sdbc/ResultSetConcurrency.hpp>
#include <com/sun/star/sdbc/XResultSet.hpp>
#include <com/sun/star/sdbc/XRow.hpp>
#include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
#include <com/sun/star/sdbc/XCloseable.hpp>
#include <com/sun/star/sdbc/XColumnLocate.hpp>
#include <com/sun/star/util/XCancellable.hpp>
#include <com/sun/star/sdbc/XWarningsSupplier.hpp>
#include <com/sun/star/sdbc/XResultSetUpdate.hpp>
#include <com/sun/star/sdbc/XRowUpdate.hpp>
#include <cppuhelper/compbase.hxx>
#include <cppuhelper/basemutex.hxx>
#include <comphelper/proparrhlp.hxx>
#include <odbc/OStatement.hxx>
#include <odbc/ODatabaseMetaData.hxx>
#include <odbc/odbcbasedllapi.hxx>
#include <memory>
#include <string_view>
namespace connectivity::odbc
{
class OResultSetMetaData;
/*
** java_sql_ResultSet
*/
typedef ::cppu::WeakComponentImplHelper< css::sdbc::XResultSet,
css::sdbc::XRow,
css::sdbc::XResultSetMetaDataSupplier,
css::util::XCancellable,
css::sdbc::XWarningsSupplier,
css::sdbc::XCloseable,
css::sdbc::XColumnLocate> ODatabaseMetaDataResultSet_BASE;
class ODatabaseMetaDataResultSet :
public cppu::BaseMutex,
public ODatabaseMetaDataResultSet_BASE,
public ::cppu::OPropertySetHelper,
public ::comphelper::OPropertyArrayUsageHelper<ODatabaseMetaDataResultSet>
{
std::vector< sal_Int32> m_aColMapping; // pos 0 is unused so we don't have to decrement 1 every time
std::map<sal_Int32, ::std::map<sal_Int32,sal_Int32> >
m_aValueRange;
std::map<sal_Int32,SWORD> m_aODBCColumnTypes;
SQLHANDLE m_aStatementHandle; // ... until freed
css::uno::WeakReferenceHelper m_aStatement;
rtl::Reference<OResultSetMetaData> m_xMetaData;
std::unique_ptr<SQLUSMALLINT[]> m_pRowStatusArray;
rtl::Reference<OConnection> m_pConnection;
rtl_TextEncoding m_nTextEncoding;
sal_Int32 m_nRowPos;
sal_Int32 m_nDriverColumnCount; // column count of the driver which can sometimes be less than the metadata count
SQLRETURN m_nCurrentFetchState;
bool m_bWasNull;
bool m_bEOF; // after last record
// set the columncount of the driver
void checkColumnCount();
static sal_Int32 getFetchDirection() { return css::sdbc::FetchDirection::FORWARD; }
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
static sal_Int32 getFetchSize();
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
static const OUString & getCursorName();
SWORD impl_getColumnType_nothrow(sal_Int32 columnIndex);
sal_Int32 mapColumn (sal_Int32 column);
protected:
// OPropertyArrayUsageHelper
virtual ::cppu::IPropertyArrayHelper* createArrayHelper( ) const override;
// OPropertySetHelper
virtual ::cppu::IPropertyArrayHelper & SAL_CALL getInfoHelper() override;
virtual sal_Bool SAL_CALL convertFastPropertyValue(
css::uno::Any & rConvertedValue,
css::uno::Any & rOldValue,
sal_Int32 nHandle,
const css::uno::Any& rValue ) override;
virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const css::uno::Any& rValue ) override;
virtual void SAL_CALL getFastPropertyValue( css::uno::Any& rValue, sal_Int32 nHandle ) const override;
virtual ~ODatabaseMetaDataResultSet() override;
template < typename T, SQLSMALLINT sqlTypeId > T getInteger ( sal_Int32 columnIndex );
public:
// A ctor needed for returning the object
ODatabaseMetaDataResultSet(OConnection* _pConnection);
const Functions& functions() const { return m_pConnection->functions(); }
// ::cppu::OComponentHelper
virtual void SAL_CALL disposing() override;
// XInterface
virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) override;
virtual void SAL_CALL acquire() noexcept override;
virtual void SAL_CALL release() noexcept override;
//XTypeProvider
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes( ) override;
// XPropertySet
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo( ) override;
css::uno::Reference< css::uno::XInterface > operator *()
{
return css::uno::Reference< css::uno::XInterface >(*static_cast<ODatabaseMetaDataResultSet_BASE*>(this));
}
// XResultSet
virtual sal_Bool SAL_CALL next( ) override;
virtual sal_Bool SAL_CALL isBeforeFirst( ) override;
virtual sal_Bool SAL_CALL isAfterLast( ) override;
virtual sal_Bool SAL_CALL isFirst( ) override;
virtual sal_Bool SAL_CALL isLast( ) override;
virtual void SAL_CALL beforeFirst( ) override;
virtual void SAL_CALL afterLast( ) override;
virtual sal_Bool SAL_CALL first( ) override;
virtual sal_Bool SAL_CALL last( ) override;
virtual sal_Int32 SAL_CALL getRow( ) override;
virtual sal_Bool SAL_CALL absolute( sal_Int32 row ) override;
virtual sal_Bool SAL_CALL relative( sal_Int32 rows ) override;
virtual sal_Bool SAL_CALL previous( ) override;
virtual void SAL_CALL refreshRow( ) override;
virtual sal_Bool SAL_CALL rowUpdated( ) override;
virtual sal_Bool SAL_CALL rowInserted( ) override;
virtual sal_Bool SAL_CALL rowDeleted( ) override;
virtual css::uno::Reference< css::uno::XInterface > SAL_CALL getStatement( ) override;
// XRow
virtual sal_Bool SAL_CALL wasNull( ) override;
virtual OUString SAL_CALL getString( sal_Int32 columnIndex ) override;
virtual sal_Bool SAL_CALL getBoolean( sal_Int32 columnIndex ) override;
virtual sal_Int8 SAL_CALL getByte( sal_Int32 columnIndex ) override;
virtual sal_Int16 SAL_CALL getShort( sal_Int32 columnIndex ) override;
virtual sal_Int32 SAL_CALL getInt( sal_Int32 columnIndex ) override;
virtual sal_Int64 SAL_CALL getLong( sal_Int32 columnIndex ) override;
virtual float SAL_CALL getFloat( sal_Int32 columnIndex ) override;
virtual double SAL_CALL getDouble( sal_Int32 columnIndex ) override;
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getBytes( sal_Int32 columnIndex ) override;
virtual css::util::Date SAL_CALL getDate( sal_Int32 columnIndex ) override;
virtual css::util::Time SAL_CALL getTime( sal_Int32 columnIndex ) override;
virtual css::util::DateTime SAL_CALL getTimestamp( sal_Int32 columnIndex ) override;
virtual css::uno::Reference< css::io::XInputStream > SAL_CALL getBinaryStream( sal_Int32 columnIndex ) override;
virtual css::uno::Reference< css::io::XInputStream > SAL_CALL getCharacterStream( sal_Int32 columnIndex ) override;
virtual css::uno::Any SAL_CALL getObject( sal_Int32 columnIndex, const css::uno::Reference< css::container::XNameAccess >& typeMap ) override;
virtual css::uno::Reference< css::sdbc::XRef > SAL_CALL getRef( sal_Int32 columnIndex ) override;
virtual css::uno::Reference< css::sdbc::XBlob > SAL_CALL getBlob( sal_Int32 columnIndex ) override;
virtual css::uno::Reference< css::sdbc::XClob > SAL_CALL getClob( sal_Int32 columnIndex ) override;
virtual css::uno::Reference< css::sdbc::XArray > SAL_CALL getArray( sal_Int32 columnIndex ) override;
// XResultSetMetaDataSupplier
virtual css::uno::Reference< css::sdbc::XResultSetMetaData > SAL_CALL getMetaData( ) override;
// XCancellable
virtual void SAL_CALL cancel( ) override;
// XCloseable
virtual void SAL_CALL close( ) override;
// XWarningsSupplier
virtual css::uno::Any SAL_CALL getWarnings( ) override;
virtual void SAL_CALL clearWarnings( ) override;
// XColumnLocate
virtual sal_Int32 SAL_CALL findColumn( const OUString& columnName ) override;
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openTablesTypes( );
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openTypeInfo();
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openCatalogs();
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openSchemas();
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openTables(const css::uno::Any& catalog, const OUString& schemaPattern,
const OUString& tableNamePattern, const css::uno::Sequence< OUString >& types );
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openColumnPrivileges( const css::uno::Any& catalog, const OUString& schema,
const OUString& table, const OUString& columnNamePattern );
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openColumns( const css::uno::Any& catalog, const OUString& schemaPattern,
const OUString& tableNamePattern, const OUString& columnNamePattern );
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openProcedureColumns( const css::uno::Any& catalog, const OUString& schemaPattern,
const OUString& procedureNamePattern,const OUString& columnNamePattern );
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openProcedures( const css::uno::Any& catalog, const OUString& schemaPattern,
const OUString& procedureNamePattern);
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openVersionColumns(const css::uno::Any& catalog, const OUString& schema,
const OUString& table);
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openBestRowIdentifier( const css::uno::Any& catalog, const OUString& schema,
const OUString& table,sal_Int32 scope, bool nullable );
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openForeignKeys( const css::uno::Any& catalog, const OUString* schema,const OUString* table,
const css::uno::Any& catalog2, const OUString* schema2,const OUString* table2);
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openExportedKeys(const css::uno::Any& catalog, const OUString& schema,const OUString& table);
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openImportedKeys(const css::uno::Any& catalog, const OUString& schema,const OUString& table);
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openPrimaryKeys(const css::uno::Any& catalog, const OUString& schema,const OUString& table);
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openTablePrivileges(const css::uno::Any& catalog, const OUString& schemaPattern,
const OUString& tableNamePattern);
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openSpecialColumns(bool _bRowVer,const css::uno::Any& catalog, const OUString& schema,
const OUString& table,sal_Int32 scope, bool nullable );
/// @throws css::sdbc::SQLException
/// @throws css::uno::RuntimeException
void openIndexInfo( const css::uno::Any& catalog, const OUString& schema,
const OUString& table,bool unique,bool approximate );
protected:
using OPropertySetHelper::getFastPropertyValue;
};
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */