Lob.hpp

/*
 * OCILIB - C Driver for Oracle (C Wrapper for Oracle OCI)
 *
 * Website: http://www.ocilib.net
 *
 * Copyright (c) 2007-2023 Vincent ROGIER <vince.rogier@ocilib.net>
 *
 * Licensed 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
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include "ocilibcpp/types.hpp"
 
// ReSharper disable CppClangTidyHicppUseEqualsDefault
// ReSharper disable CppClangTidyModernizeUseEqualsDefault
// ReSharper disable CppClangTidyHicppUseAuto
// ReSharper disable CppClangTidyModernizeUseAuto
// ReSharper disable CppClangTidyMiscMisplacedConst
 
namespace ocilib
{
 
template<class T, int U>
inline Lob<T, U>::Lob()
{
}
 
template<class T, int U>
Lob<T, U>::Lob(const Connection &connection)
{
    AcquireAllocated
    (
        core::Check(OCI_LobCreate(connection, U)),
        connection.GetHandle()
    );
}
 
template<class T, int U>
Lob<T, U>::Lob(OCI_Lob *pLob, core::Handle *parent)
{
    AcquireTransient(pLob, parent);
}
 
template<>
inline ostring Lob<ostring, LobCharacter>::Read(unsigned int length)
{
    core::ManagedBuffer<otext> buffer(static_cast<size_t>(Environment::GetCharMaxSize() * (length + 1)));
 
    unsigned int charCount = length;
    unsigned int byteCount = 0;
 
    if (core::Check(OCI_LobRead2(*this, static_cast<AnyPointer>(buffer), &charCount, &byteCount)))
    {
        length = byteCount / sizeof(otext);
    }
 
    return core::MakeString(static_cast<const otext *>(buffer), static_cast<int>(length));
}
 
template<>
inline ostring Lob<ostring, LobNationalCharacter>::Read(unsigned int length)
{
    core::ManagedBuffer<otext> buffer(static_cast<size_t>(Environment::GetCharMaxSize() * (length + 1)));
 
    unsigned int charCount = length;
    unsigned int byteCount = 0;
 
    if (core::Check(OCI_LobRead2(*this, static_cast<AnyPointer>(buffer), &charCount, &byteCount)))
    {
        length = byteCount / sizeof(otext);
    }
 
    return core::MakeString(static_cast<const otext *>(buffer), static_cast<int>(length));
 
}
 
template<>
inline Raw Lob<Raw, LobBinary>::Read(unsigned int length)
{
    core::ManagedBuffer<unsigned char> buffer(length + 1);
 
    length = core::Check(OCI_LobRead(*this, static_cast<AnyPointer>(buffer), length));
 
    return core::MakeRaw(buffer, length);
}
 
template<class T, int U>
unsigned int Lob<T, U>::Write(const T& content)
{
    if (content.empty())
    {
        return 0;
    }
 
    unsigned int res = 0;
    unsigned int charCount = 0;
    unsigned int byteCount = static_cast<unsigned int>(content.size() * sizeof(typename T::value_type));
    const AnyPointer buffer = static_cast<AnyPointer>(const_cast<typename T::value_type *>(&content[0]));
 
    if (core::Check(OCI_LobWrite2(*this, buffer, &charCount, &byteCount)))
    {
        res = U == LobBinary ? byteCount : charCount;
    }
 
    return res;
}
 
template<class T, int U>
void Lob<T, U>::Append(const Lob& other)
{
    core::Check(OCI_LobAppendLob(*this, other));
}
 
template<class T, int U>
unsigned int Lob<T, U>::Append(const T& content)
{
    if (content.empty())
    {
        return 0;
    }
 
    const AnyPointer data = static_cast<AnyPointer>(const_cast<typename T::value_type*>(&content[0]));
 
    return core::Check(OCI_LobAppend(*this, data, static_cast<unsigned int>(content.size())));
}
 
template<class T, int U>
bool Lob<T, U>::Seek(SeekMode seekMode, big_uint offset)
{
    return (core::Check(OCI_LobSeek(*this, offset, seekMode)) == TRUE);
}
 
template<class T, int U>
Lob<T, U> Lob<T, U>::Clone() const
{
    Lob result(GetConnection());
 
    core::Check(OCI_LobAssign(result, *this));
 
    return result;
}
 
template<class T, int U>
bool Lob<T, U>::Equals(const Lob &other) const
{
    return (core::Check(OCI_LobIsEqual(*this, other)) == TRUE);
}
 
template<class T, int U>
LobType Lob<T, U>::GetType() const
{
    return LobType(static_cast<LobType::Type>(core::Check(OCI_LobGetType(*this))));
}
 
template<class T, int U>
big_uint Lob<T, U>::GetOffset() const
{
    return core::Check(OCI_LobGetOffset(*this));
}
 
template<class T, int U>
big_uint Lob<T, U>::GetLength() const
{
    return core::Check(OCI_LobGetLength(*this));
}
 
template<class T, int U>
big_uint Lob<T, U>::GetMaxSize() const
{
    return core::Check(OCI_LobGetMaxSize(*this));
}
 
template<class T, int U>
big_uint Lob<T, U>::GetChunkSize() const
{
    return core::Check(OCI_LobGetChunkSize(*this));
}
 
template<class T, int U>
Connection Lob<T, U>::GetConnection() const
{
    return Connection
    (
        core::Check(OCI_LobGetConnection(*this)), 
        Environment::GetEnvironmentHandle()
    );
}
 
template<class T, int U>
void Lob<T, U>::Truncate(big_uint length)
{
    core::Check(OCI_LobTruncate(*this, length));
}
 
template<class T, int U>
big_uint Lob<T, U>::Erase(big_uint offset, big_uint length)
{
    return core::Check(OCI_LobErase(*this, offset, length));
}
 
template<class T, int U>
void Lob<T, U>::Copy(Lob &dest, big_uint offset, big_uint offsetDest, big_uint length) const
{
    core::Check(OCI_LobCopy(dest, *this, offsetDest, offset, length));
}
 
template<class T, int U>
bool Lob<T, U>::IsTemporary() const
{
    return (core::Check(OCI_LobIsTemporary(*this)) == TRUE);
}
 
template<class T, int U>
bool Lob<T, U>::IsRemote() const
{
    return (core::Check(OCI_LobIsRemote(*this)) == TRUE);
}
 
template<class T, int U>
void Lob<T, U>::Open(OpenMode mode)
{
    core::Check(OCI_LobOpen(*this, mode));
}
 
template<class T, int U>
void Lob<T, U>::Flush()
{
    core::Check(OCI_LobFlush(*this));
}
 
template<class T, int U>
void Lob<T, U>::Close()
{
    core::Check(OCI_LobClose(*this));
}
 
template<class T, int U>
void Lob<T, U>::EnableBuffering(bool value)
{
    core::Check(OCI_LobEnableBuffering(*this, value));
}
 
template<class T, int U>
Lob<T, U>& Lob<T, U>::operator += (const Lob<T, U>& other)
{
    Append(other);
    return *this;
}
 
template<class T, int U>
bool Lob<T, U>::operator == (const Lob<T, U>& other) const
{
    return Equals(other);
}
 
template<class T, int U>
bool Lob<T, U>::operator != (const Lob<T, U>& other) const
{
    return !(*this == other);
}
 
}