//-----------------------------------------------------------------------------
// Copyright © 2003 - Philip Howard - All rights reserved
//
// 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 2
// 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, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//-----------------------------------------------------------------------------
// package	libh/map
// homepage	http://libh.slashusr.org/
//-----------------------------------------------------------------------------
// author	Philip Howard
// email	libh at ipal dot org
// homepage	http://phil.ipal.org/
//-----------------------------------------------------------------------------
// This file is best viewed using a fixed spaced font such as Courier
// and in a display at least 112 columns wide.
//-----------------------------------------------------------------------------

#include "map_ca.h"

__FMACRO_BEGIN__
//-----------------------------------------------------------------------------
// macro	map_str_key_copy
//
// purpose	Get the key of the current member in the mapping, copying it to
//		the specified destination area.
//
// arguments	1 (MAP) mapping handle
//		2 (char *) where to store key
//		3 (size_t) maximum length of storage area
//
// returns	(size_t) length of key being returned (even if not all copied)
//		(size_t) ~0U = error, no map, bad type, no member
//-----------------------------------------------------------------------------
#define map_str_key_copy map_ca_key_copy
__FMACRO_END__

__FMACRO_BEGIN__
//-----------------------------------------------------------------------------
// macro	map_cs_key_copy
//
// purpose	Get the key of the current member in the mapping, copying it to
//		the specified destination area.
//
// arguments	1 (MAP) mapping handle
//		2 (char *) where to store key
//		3 (size_t) maximum length of storage area
//
// returns	(size_t) length of key being returned (even if not all copied)
//		(size_t) ~0U = error, no map, bad type, no member
//-----------------------------------------------------------------------------
#define map_cs_key_copy map_ca_key_copy
__FMACRO_END__

__PROTO_BEGIN__
//-----------------------------------------------------------------------------
// function	map_ca_key_copy
//
// purpose	Get the key of the current member in the mapping, copying it to
//		the specified destination area.
//
// arguments	1 (MAP) mapping handle
//		2 (char *) where to store key
//		3 (size_t) maximum length of storage area
//
// returns	(size_t) length of key being returned (even if not all copied)
//		(size_t) ~0U = error, no map, bad type, no member
//-----------------------------------------------------------------------------
size_t
map_ca_key_copy (
    MAP			arg_map
    ,
    char *		arg_key_ptr
    ,
    size_t		arg_key_len
   )
__PROTO_END__
{
    struct map_node_ca *	node_p	;
    size_t		len	;

    //-- Make sure we have a correct mapping and current node.
    if ( ! arg_map ) return ~ (size_t) 0U;
    if ( arg_map->key_type != MAP_DATA_CA ) return ~ (size_t) 0U;
    if ( ! ( node_p = avl_find( & (arg_map->avl_tree), NULL, 0 ) ) ) return ~ (size_t) 0U;

    //-- Copy the key to the destination, truncated if necessary.
    len = node_p->link.keylen;
    if ( len > arg_key_len ) len = arg_key_len;
    map_ca_copy_array( arg_key_ptr, node_p->link.key, len );

    //-- Return length for convenience.
    return node_p->link.keylen;
}