/*

 * Balanced tree node functions

 *

 * Copyright (C) 2006-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 "libcdata_array.h"

#include "libcdata_btree_node.h"

#include "libcdata_btree_values_list.h"

#include "libcdata_definitions.h"

#include "libcdata_libcerror.h"

#include "libcdata_list.h"

#include "libcdata_list_element.h"

#include "libcdata_tree_node.h"

#include "libcdata_types.h"

/* Retrieves the sub node for the specific value

 *

 * Uses the value_compare_function to determine the similarity of the entries

 * The value_compare_function should return LIBCDATA_COMPARE_LESS,

 * LIBCDATA_COMPARE_EQUAL, LIBCDATA_COMPARE_GREATER if successful or -1 on error

 *

 * If value_compare_function is NULL the pointer of the value is used to check for a match

 *

 * Returns 1 if successful, 0 if the value does not exist or -1 on error

 * If there was no possible sub match values_list_element is set to NULL

 * it there is a possible sub match values_list_element is set but 0 is returned

 * If the node is a leaf node sub_node is not set to NULL

 */

int libcdata_btree_node_get_sub_node_by_value(

     libcdata_tree_node_t *node,

     intptr_t *value,

     int (*value_compare_function)(

            intptr_t *first_value,

            intptr_t *second_value,

            libcerror_error_t **error ),

     libcdata_tree_node_t **sub_node,

     libcdata_list_element_t **values_list_element,

     libcerror_error_t **error )

{

  libcdata_list_t *values_list                      = NULL;

  libcdata_list_element_t *safe_values_list_element = NULL;

  libcdata_tree_node_t *safe_sub_node               = NULL;

  intptr_t *values_list_value                       = NULL;

  static char *function                             = "libcdata_btree_node_get_sub_node_by_value";

  int number_of_sub_nodes                           = 0;

  int number_of_values_list_elements                = 0;

  int result                                        = 0;

  int sub_node_index                                = 0;

  int values_list_element_index                     = 0;

  if( node == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid node.",

     function );

    return( -1 );

  }

  if( value == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid value.",

     function );

    return( -1 );

  }

  if( sub_node == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid sub node.",

     function );

    return( -1 );

  }

  if( values_list_element == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid values list element.",

     function );

    return( -1 );

  }

  *sub_node            = NULL;

  *values_list_element = NULL;

  if( libcdata_tree_node_get_value(

       node,

       (intptr_t **) &values_list,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve values list.",

     function );

    return( -1 );

  }

  if( values_list != NULL )

  {

    if( libcdata_list_get_number_of_elements(

         values_list,

         &number_of_values_list_elements,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_GET_FAILED,

       "%s: unable to retrieve number of values list elements.",

       function );

      return( -1 );

    }

  }

  if( libcdata_tree_node_get_number_of_sub_nodes(

       node,

       &number_of_sub_nodes,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve number of sub nodes.",

     function );

    return( -1 );

  }

  if( ( number_of_sub_nodes != 0 )

   && ( ( number_of_values_list_elements + 1 ) != number_of_sub_nodes ) )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_VALUE_OUT_OF_BOUNDS,

     "%s: invalid number of values list elements value out of bounds.",

     function );

    return( -1 );

  }

  if( number_of_values_list_elements == 0 )

  {

    return( 0 );

  }

  if( libcdata_list_get_first_element(

       values_list,

       &safe_values_list_element,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve first values list element.",

     function );

    return( -1 );

  }

  if( number_of_sub_nodes != 0 )

  {

    if( libcdata_tree_node_get_sub_node_by_index(

         node,

         0,

         &safe_sub_node,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_GET_FAILED,

       "%s: unable to retrieve sub node: 0.",

       function );

      return( -1 );

    }

  }

  for( values_list_element_index = 0;

       values_list_element_index < number_of_values_list_elements;

       values_list_element_index++ )

  {

    if( libcdata_list_element_get_value(

         safe_values_list_element,

         &values_list_value,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_GET_FAILED,

       "%s: unable to retrieve value from values list element: %d.",

       function,

       values_list_element_index );

      return( -1 );

    }

    if( values_list_value == NULL )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_VALUE_MISSING,

       "%s: invalid values list element: %d - missing value.",

       function,

       values_list_element_index );

      return( -1 );

    }

    if( value_compare_function != NULL )

    {

      result = value_compare_function(

                value,

                values_list_value,

                error );

    }

    else if( value == values_list_value )

    {

      result = LIBCDATA_COMPARE_EQUAL;

    }

    else

    {

      result = LIBCDATA_COMPARE_GREATER;

    }

    if( result == -1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_GET_FAILED,

       "%s: unable to compare value with values list value: %d.",

       function,

       values_list_element_index );

      return( -1 );

    }

    else if( result == LIBCDATA_COMPARE_EQUAL )

    {

      *sub_node            = safe_sub_node;

      *values_list_element = safe_values_list_element;

      return( 1 );

    }

    else if( result == LIBCDATA_COMPARE_LESS )

    {

      break;

    }

    else if( result != LIBCDATA_COMPARE_GREATER )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

       LIBCERROR_ARGUMENT_ERROR_UNSUPPORTED_VALUE,

       "%s: unsupported value compare function return value: %d.",

       function,

       result );

      return( -1 );

    }

    if( libcdata_list_element_get_next_element(

         safe_values_list_element,

         &safe_values_list_element,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_GET_FAILED,

       "%s: unable to retrieve next element from values list element: %d.",

       function,

       values_list_element_index );

      return( -1 );

    }

    if( number_of_sub_nodes != 0 )

    {

      if( libcdata_tree_node_get_next_node(

           safe_sub_node,

           &safe_sub_node,

           error ) != 1 )

      {

        libcerror_error_set(

         error,

         LIBCERROR_ERROR_DOMAIN_RUNTIME,

         LIBCERROR_RUNTIME_ERROR_GET_FAILED,

         "%s: unable to retrieve next node from sub node: %d.",

         function,

         sub_node_index );

        return( -1 );

      }

      sub_node_index++;

    }

  }

  *sub_node            = safe_sub_node;

  *values_list_element = safe_values_list_element;

  return( 0 );

}

/* Retrieves the upper node for the specific value

 *

 * Uses the value_compare_function to determine the similarity of the entries

 * The value_compare_function should return LIBCDATA_COMPARE_LESS,

 * LIBCDATA_COMPARE_EQUAL, LIBCDATA_COMPARE_GREATER if successful or -1 on error

 *

 * Returns 1 if successful, 0 if the value does not exist or -1 on error

 */

int libcdata_btree_node_get_upper_node_by_value(

     libcdata_tree_node_t *node,

     intptr_t *value,

     int (*value_compare_function)(

            intptr_t *first_value,

            intptr_t *second_value,

            libcerror_error_t **error ),

     libcdata_tree_node_t **upper_node,

     libcdata_list_element_t **values_list_element,

     libcerror_error_t **error )

{

  libcdata_list_element_t *sub_values_list_element = NULL;

  libcdata_tree_node_t *sub_node                   = NULL;

  static char *function                            = "libcdata_btree_node_get_upper_node_by_value";

  int result                                       = 0;

  if( node == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid node.",

     function );

    return( -1 );

  }

  if( value == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid value.",

     function );

    return( -1 );

  }

  if( value_compare_function == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid value compare function.",

     function );

    return( -1 );

  }

  if( upper_node == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid upper node.",

     function );

    return( -1 );

  }

  if( values_list_element == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid values list element.",

     function );

    return( -1 );

  }

  *upper_node          = NULL;

  *values_list_element = NULL;

  result = libcdata_btree_node_get_sub_node_by_value(

            node,

            value,

            value_compare_function,

            &sub_node,

            &sub_values_list_element,

            error );

  if( result == -1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve sub node by value.",

     function );

    return( -1 );

  }

  else if( sub_node != NULL )

  {

    result = libcdata_btree_node_get_upper_node_by_value(

              sub_node,

              value,

              value_compare_function,

              upper_node,

              values_list_element,

              error );

    if( result == -1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_GET_FAILED,

       "%s: unable to retrieve upper node in sub node.",

       function );

      return( -1 );

    }

  }

  else if( result != 0 )

  {

    *values_list_element = sub_values_list_element;

  }

  if( *upper_node == NULL )

  {

    *upper_node = node;

  }

  return( result );

}

/* Appends a value into a tree node

 * Returns 1 if successful or -1 on error

 */

int libcdata_btree_node_append_value(

     libcdata_tree_node_t *node,

     intptr_t *value,

     libcerror_error_t **error )

{

  libcdata_list_t *values_list = NULL;

  static char *function        = "libcdata_btree_node_append_value";

  if( libcdata_tree_node_get_value(

       node,

       (intptr_t **) &values_list,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve values list.",

     function );

    return( -1 );

  }

  if( values_list == NULL )

  {

    if( libcdata_list_initialize(

         &values_list,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,

       "%s: unable to create values list.",

       function );

      return( -1 );

    }

    if( libcdata_tree_node_set_value(

         node,

         (intptr_t *) values_list,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_SET_FAILED,

       "%s: unable to set values list.",

       function );

      libcdata_list_free(

       &values_list,

       NULL,

       NULL );

      return( -1 );

    }

  }

  if( libcdata_list_append_value(

       values_list,

       value,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_APPEND_FAILED,

     "%s: unable to append value to values list.",

     function );

    return( -1 );

  }

  return( 1 );

}

/* Inserts a value into a tree node

 * The tree node must be the most upper node (leaf)

 *

 * Uses the value_compare_function to determine the order of the entries

 * The value_compare_function should return LIBCDATA_COMPARE_LESS,

 * LIBCDATA_COMPARE_EQUAL, LIBCDATA_COMPARE_GREATER if successful or -1 on error

 *

 * Returns 1 if successful, 0 if the value already exists or -1 on error

 */

int libcdata_btree_node_insert_value(

     libcdata_tree_node_t *node,

     intptr_t *value,

     int (*value_compare_function)(

            intptr_t *first_value,

            intptr_t *second_value,

            libcerror_error_t **error ),

     libcerror_error_t **error )

{

  libcdata_list_t *values_list = NULL;

  static char *function        = "libcdata_btree_node_insert_value";

  int number_of_sub_nodes      = 0;

  int result                   = 0;

  if( libcdata_tree_node_get_number_of_sub_nodes(

       node,

       &number_of_sub_nodes,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve number of sub nodes.",

     function );

    return( -1 );

  }

  if( number_of_sub_nodes != 0 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_UNSUPPORTED_VALUE,

     "%s: cannot insert value in node with sub nodes.",

     function );

    return( -1 );

  }

  if( libcdata_tree_node_get_value(

       node,

       (intptr_t **) &values_list,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve values list.",

     function );

    return( -1 );

  }

  if( values_list == NULL )

  {

    if( libcdata_list_initialize(

         &values_list,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,

       "%s: unable to create values list.",

       function );

      return( -1 );

    }

    if( libcdata_tree_node_set_value(

         node,

         (intptr_t *) values_list,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_SET_FAILED,

       "%s: unable to set values list.",

       function );

      libcdata_list_free(

       &values_list,

       NULL,

       NULL );

      return( -1 );

    }

  }

  result = libcdata_list_insert_value(

            values_list,

            value,

            value_compare_function,

            LIBCDATA_INSERT_FLAG_UNIQUE_ENTRIES,

            error );

  if( result == -1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_APPEND_FAILED,

     "%s: unable to insert value in values list.",

     function );

    return( -1 );

  }

  return( result );

}

/* Replaces a value in the tree node

 * The tree node must be the most upper node (leaf) in the first call

 * Returns 1 if successful or -1 on error

 */

int libcdata_btree_node_replace_value(

     libcdata_tree_node_t *node,

     intptr_t *value,

     intptr_t *replacement_value,

     libcerror_error_t **error )

{

  libcdata_list_element_t *values_list_element = NULL;

  libcdata_tree_node_t *parent_node            = NULL;

  libcdata_tree_node_t *sub_node               = NULL;

  static char *function                        = "libcdata_btree_node_replace_value";

  int result                                   = 0;

  if( value == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid value.",

     function );

    return( -1 );

  }

  if( replacement_value == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid replacement value.",

     function );

    return( -1 );

  }

  result = libcdata_btree_node_get_sub_node_by_value(

            node,

            value,

            NULL,

            &sub_node,

            &values_list_element,

            error );

  if( result == -1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve sub node by value.",

     function );

    return( -1 );

  }

  else if( result != 0 )

  {

    if( libcdata_list_element_set_value(

         values_list_element,

         replacement_value,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_SET_FAILED,

       "%s: unable to set value in values list element.",

       function );

      return( -1 );

    }

  }

  if( libcdata_tree_node_get_parent_node(

       node,

       &parent_node,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve parent node.",

     function );

    return( -1 );

  }

  if( parent_node != NULL )

  {

    if( libcdata_btree_node_replace_value(

         parent_node,

         value,

         replacement_value,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_SET_FAILED,

       "%s: unable to replace value in parent node.",

       function );

      return( -1 );

    }

  }

  return( 1 );

}

/* Flattens a tree node and its sub node

 * Returns 1 if successful or -1 on error

 */

int libcdata_btree_node_flatten_node(

     libcdata_tree_node_t **node,

     libcerror_error_t **error )

{

  libcdata_tree_node_t *sub_node = NULL;

  static char *function          = "libcdata_btree_node_flatten_node";

  if( node == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid node.",

     function );

    return( -1 );

  }

  if( libcdata_tree_node_get_first_sub_node(

       *node,

       &sub_node,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve first sub node.",

     function );

    return( -1 );

  }

  if( libcdata_tree_node_remove_node(

       *node,

       sub_node,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_REMOVE_FAILED,

     "%s: unable to remove sub node from node.",

     function );

    return( -1 );

  }

  if( libcdata_tree_node_replace_node(

       *node,

       sub_node,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_SET_FAILED,

     "%s: unable to replace node with sub node.",

     function );

    libcdata_tree_node_append_node(

     *node,

     sub_node,

     NULL );

    return( -1 );

  }

  if( libcdata_tree_node_free(

       node,

       (int (*)(intptr_t **, libcerror_error_t **)) &libcdata_btree_values_list_free,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_FINALIZE_FAILED,

     "%s: unable to free node.",

     function );

    return( -1 );

  }

  *node = sub_node;

  return( 1 );

}

/* Removes a sub node from the B-tree node

 * Returns 1 if successful or -1 on error

 */

int libcdata_btree_node_remove_sub_node(

     libcdata_tree_node_t *node,

     libcdata_tree_node_t **sub_node,

     libcerror_error_t **error )

{

  static char *function = "libcdata_btree_node_remove_sub_node";

  if( node == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid node.",

     function );

    return( -1 );

  }

  if( sub_node == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid sub node.",

     function );

    return( -1 );

  }

  if( libcdata_tree_node_remove_node(

       node,

       *sub_node,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_REMOVE_FAILED,

     "%s: unable to remove sub node from node.",

     function );

    return( -1 );

  }

  if( libcdata_tree_node_free(

       sub_node,

       (int (*)(intptr_t **, libcerror_error_t **)) &libcdata_btree_values_list_free,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_FINALIZE_FAILED,

     "%s: unable to free sub node.",

     function );

    return( -1 );

  }

  return( 1 );

}

/* Removes a value from the tree node

 * The tree node must be the most upper node (leaf) in the first call

 * Returns 1 if successful, 0 if no such value or -1 on error

 */

int libcdata_btree_node_remove_value(

     libcdata_tree_node_t *node,

     intptr_t *value,

     intptr_t *replacement_value,

     libcerror_error_t **error )

{

  libcdata_list_t *sub_node_values_list        = NULL;

  libcdata_list_t *values_list                 = NULL;

  libcdata_list_element_t *values_list_element = NULL;

  libcdata_tree_node_t *parent_node            = NULL;

  libcdata_tree_node_t *sub_node               = NULL;

  static char *function                        = "libcdata_btree_node_remove_value";

  int number_of_sub_nodes                      = 0;

  int number_of_values_list_elements           = 0;

  int result                                   = 0;

  int sub_node_number_of_sub_nodes             = 0;