view OrthancServer/Plugins/Engine/PluginMemoryBuffer32.cpp @ 6291:04a31dbf8a60

TODO
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 29 Aug 2025 09:00:39 +0200
parents b91b5759f8dc
children
line wrap: on
line source

/**
 * Orthanc - A Lightweight, RESTful DICOM Store
 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
 * Department, University Hospital of Liege, Belgium
 * Copyright (C) 2017-2023 Osimis S.A., Belgium
 * Copyright (C) 2024-2025 Orthanc Team SRL, Belgium
 * Copyright (C) 2021-2025 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 **/


#include "../../Sources/PrecompiledHeadersServer.h"
#include "PluginMemoryBuffer32.h"

#include "../../../OrthancFramework/Sources/OrthancException.h"
#include "../../../OrthancFramework/Sources/Toolbox.h"

#define ERROR_MESSAGE_64BIT "A 64bit version of the Orthanc SDK is necessary to use buffers > 4GB, but is currently not available"


namespace Orthanc
{
  void PluginMemoryBuffer32::Clear()
  {
    if (buffer_.size != 0)
    {
      ::free(buffer_.data);
    }

    buffer_.data = NULL;
    buffer_.size = 0;
  }


  void PluginMemoryBuffer32::SanityCheck() const
  {
    if ((buffer_.data == NULL && buffer_.size != 0) ||
        (buffer_.data != NULL && buffer_.size == 0))
    {
      throw OrthancException(ErrorCode_Plugin);
    }
  }


  PluginMemoryBuffer32::PluginMemoryBuffer32()
  {
    buffer_.size = 0;
    buffer_.data = NULL;
  }


  void PluginMemoryBuffer32::MoveToString(std::string& target)
  {
    SanityCheck();

    target.resize(buffer_.size);

    if (buffer_.size != 0)
    {
      memcpy(&target[0], buffer_.data, buffer_.size);
    }

    Clear();
  }


  const void* PluginMemoryBuffer32::GetData() const
  {
    SanityCheck();

    if (buffer_.size == 0)
    {
      return NULL;
    }
    else
    {
      return buffer_.data;
    }
  }


  size_t PluginMemoryBuffer32::GetSize() const
  {
    SanityCheck();
    return buffer_.size;
  }


  void PluginMemoryBuffer32::Release(OrthancPluginMemoryBuffer* target)
  {
    SanityCheck();

    if (target == NULL)
    {
      throw OrthancException(ErrorCode_NullPointer);
    }

    target->data = buffer_.data;
    target->size = buffer_.size;

    buffer_.data = NULL;
    buffer_.size = 0;
  }


  void PluginMemoryBuffer32::Release(OrthancPluginMemoryBuffer64* target)
  {
    SanityCheck();

    if (target == NULL)
    {
      throw OrthancException(ErrorCode_NullPointer);
    }

    target->data = buffer_.data;
    target->size = buffer_.size;

    buffer_.data = NULL;
    buffer_.size = 0;
  }


  void PluginMemoryBuffer32::Resize(size_t size)
  {
    if (static_cast<size_t>(static_cast<uint32_t>(size)) != size)
    {
      throw OrthancException(ErrorCode_NotEnoughMemory, ERROR_MESSAGE_64BIT);
    }

    if (size != buffer_.size)
    {
      Clear();

      if (size == 0)
      {
        buffer_.data = NULL;
      }
      else
      {
        buffer_.data = ::malloc(size);

        if (buffer_.data == NULL)
        {
          throw OrthancException(ErrorCode_NotEnoughMemory);
        }
      }

      buffer_.size = size;
    }
  }


  void PluginMemoryBuffer32::Assign(const void* data,
                                    size_t size)
  {
    Resize(size);

    if (size != 0)
    {
      memcpy(buffer_.data, data, size);
    }
  }


  void PluginMemoryBuffer32::Assign(const std::string& data)
  {
    if (data.empty())
    {
      Assign(NULL, 0);
    }
    else
    {
      Assign(data.c_str(), data.size());
    }
  }


  void PluginMemoryBuffer32::ToJsonObject(Json::Value& target) const
  {
    SanityCheck();

    if (!Toolbox::ReadJson(target, buffer_.data, buffer_.size) ||
        target.type() != Json::objectValue)
    {
      throw OrthancException(ErrorCode_Plugin, "The plugin has not provided a valid JSON object");
    }
  }
}