/*

 * Input/Output (IO) handle 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 <byte_stream.h>

#include <memory.h>

#include <system_string.h>

#include <types.h>

#include "libfsext_debug.h"

#include "libfsext_io_handle.h"

#include "libfsext_libbfio.h"

#include "libfsext_libcerror.h"

#include "libfsext_libcnotify.h"

/* Creates an IO handle

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

 * Returns 1 if successful or -1 on error

 */

int libfsext_io_handle_initialize(

     libfsext_io_handle_t **io_handle,

     libcerror_error_t **error )

{

  static char *function = "libfsext_io_handle_initialize";

  if( io_handle == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid IO handle.",

     function );

    return( -1 );

  }

  if( *io_handle != NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,

     "%s: invalid IO handle value already set.",

     function );

    return( -1 );

  }

  *io_handle = memory_allocate_structure(

                libfsext_io_handle_t );

  if( *io_handle == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create IO handle.",

     function );

    goto on_error;

  }

  if( memory_set(

       *io_handle,

       0,

       sizeof( libfsext_io_handle_t ) ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_SET_FAILED,

     "%s: unable to clear IO handle.",

     function );

    goto on_error;

  }

  return( 1 );

on_error:

  if( *io_handle != NULL )

  {

    memory_free(

     *io_handle );

    *io_handle = NULL;

  }

  return( -1 );

}

/* Frees an IO handle

 * Returns 1 if successful or -1 on error

 */

int libfsext_io_handle_free(

     libfsext_io_handle_t **io_handle,

     libcerror_error_t **error )

{

  static char *function = "libfsext_io_handle_free";

  int result            = 1;

  if( io_handle == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid IO handle.",

     function );

    return( -1 );

  }

  if( *io_handle != NULL )

  {

    memory_free(

     *io_handle );

    *io_handle = NULL;

  }

  return( result );

}

/* Clears the IO handle

 * Returns 1 if successful or -1 on error

 */

int libfsext_io_handle_clear(

     libfsext_io_handle_t *io_handle,

     libcerror_error_t **error )

{

  static char *function = "libfsext_io_handle_clear";

  if( io_handle == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid IO handle.",

     function );

    return( -1 );

  }

  if( memory_set(

       io_handle,

       0,

       sizeof( libfsext_io_handle_t ) ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_SET_FAILED,

     "%s: unable to clear IO handle.",

     function );

    return( -1 );

  }

  return( 1 );

}