/*

 * The range functions

 *

 * Copyright (C) 2010-2024, Joachim Metz <joachim.metz@gmail.com>

 *

 * Refer to AUTHORS for acknowledgements.

 *

 * This program is free software: you can redistribute it and/or modify

 * it under the terms of the GNU Lesser 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 Lesser General Public License

 * along with this program.  If not, see <https://www.gnu.org/licenses/>.

 */

#include <common.h>

#include <memory.h>

#include <types.h>

#include "libfdata_libcerror.h"

#include "libfdata_range.h"

/* Creates a range

 * Make sure the value range is referencing, is set to NULL

 * Returns 1 if successful or -1 on error

 */

int libfdata_range_initialize(

     libfdata_range_t **range,

     libcerror_error_t **error )

{

  static char *function = "libfdata_range_initialize";

  if( range == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid range.",

     function );

    return( -1 );

  }

  if( *range != NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,

     "%s: invalid range value already set.",

     function );

    return( -1 );

  }

  *range = memory_allocate_structure(

            libfdata_range_t );

  if( *range == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create range.",

     function );

    goto on_error;

  }

  if( memory_set(

       *range,

       0,

       sizeof( libfdata_range_t ) ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_SET_FAILED,

     "%s: unable to clear range.",

     function );

    goto on_error;

  }

  ( *range )->file_index = -1;

  ( *range )->offset     = (off64_t) -1;

  return( 1 );

on_error:

  if( *range != NULL )

  {

    memory_free(

     *range );

    *range = NULL;

  }

  return( -1 );

}

/* Frees a range

 * Returns 1 if successful or -1 on error

 */

int libfdata_range_free(

     libfdata_range_t **range,

     libcerror_error_t **error )

{

  static char *function = "libfdata_range_free";

  if( range == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid range.",

     function );

    return( -1 );

  }

  if( *range != NULL )

  {

    memory_free(

     *range );

    *range = NULL;

  }

  return( 1 );

}

/* Clones (duplicates) the range

 * Returns 1 if successful or -1 on error

 */

int libfdata_range_clone(

     libfdata_range_t **destination_range,

     libfdata_range_t *source_range,

     libcerror_error_t **error )

{

  static char *function = "libfdata_range_clone";

  if( destination_range == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid destination range.",

     function );

    return( -1 );

  }

  if( *destination_range != NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,

     "%s: invalid destination range value already set.",

     function );

    return( -1 );

  }

  if( source_range == NULL )

  {

    *destination_range = NULL;

    return( 1 );

  }

  *destination_range = memory_allocate_structure(

                        libfdata_range_t );

  if( *destination_range == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create destination range.",

     function );

    goto on_error;

  }

  if( memory_copy(

       *destination_range,

       source_range,

       sizeof( libfdata_range_t ) ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_COPY_FAILED,

     "%s: unable to copy source to destination range.",

     function );

    goto on_error;

  }

  return( 1 );

on_error:

  if( *destination_range != NULL )

  {

    memory_free(

     *destination_range );

    *destination_range = NULL;

  }

  return( -1 );

}

/* Retrieves the range values

 * Returns 1 if successful or -1 on error

 */

int libfdata_range_get(

     libfdata_range_t *range,

     int *file_index,

     off64_t *offset,

     size64_t *size,

     uint32_t *flags,

     libcerror_error_t **error )

{

  static char *function = "libfdata_range_get";

  if( range == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid range.",

     function );

    return( -1 );

  }

  if( file_index == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid file index.",

     function );

    return( -1 );

  }

  if( offset == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid offset.",

     function );

    return( -1 );

  }

  if( size == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid size.",

     function );

    return( -1 );

  }

  if( flags == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid flags.",

     function );

    return( -1 );

  }

  *file_index = range->file_index;

  *offset     = range->offset;

  *size       = range->size;

  *flags      = range->flags;

  return( 1 );

}

/* Retrieves the size

 * Returns 1 if successful or -1 on error

 */

int libfdata_range_get_size(

     libfdata_range_t *range,

     size64_t *size,

     libcerror_error_t **error )

{

  static char *function = "libfdata_range_get_size";

  if( range == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid range.",

     function );

    return( -1 );

  }

  if( size == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid size.",

     function );

    return( -1 );

  }

  *size = range->size;

  return( 1 );

}

/* Sets the range values

 * Returns 1 if successful or -1 on error

 */

int libfdata_range_set(

     libfdata_range_t *range,

     int file_index,

     off64_t offset,

     size64_t size,

     uint32_t flags,

     libcerror_error_t **error )

{

  static char *function = "libfdata_range_set";

  if( range == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid range.",

     function );

    return( -1 );

  }

  range->file_index = file_index;

  range->offset     = offset;

  range->size       = size;

  range->flags      = flags;

  return( 1 );

}