/*

 * Copyright © 2018  Google, Inc.

 *

 *  This is part of HarfBuzz, a text shaping library.

 *

 * Permission is hereby granted, without written agreement and without

 * license or royalty fees, to use, copy, modify, and distribute this

 * software and its documentation for any purpose, provided that the

 * above copyright notice and the following two paragraphs appear in

 * all copies of this software.

 *

 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR

 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES

 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN

 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH

 * DAMAGE.

 *

 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,

 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND

 * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS

 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO

 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

 *

 * Google Author(s): Behdad Esfahbod

 */

#ifndef HB_H_IN

#error "Include <hb.h> instead."

#endif

#ifndef HB_MAP_H

#define HB_MAP_H

#include "hb-common.h"

HB_BEGIN_DECLS

/*

 * Since: 1.7.7

 */

#define HB_MAP_VALUE_INVALID ((hb_codepoint_t) -1)

typedef struct hb_map_t hb_map_t;

HB_EXTERN hb_map_t *

hb_map_create (void);

HB_EXTERN hb_map_t *

hb_map_get_empty (void);

HB_EXTERN hb_map_t *

hb_map_reference (hb_map_t *map);

HB_EXTERN void

hb_map_destroy (hb_map_t *map);

HB_EXTERN hb_bool_t

hb_map_set_user_data (hb_map_t           *map,

                      hb_user_data_key_t *key,

                      void *              data,

                      hb_destroy_func_t   destroy,

                      hb_bool_t           replace);

HB_EXTERN void *

hb_map_get_user_data (hb_map_t           *map,

                      hb_user_data_key_t *key);

/* Returns false if allocation has failed before */

HB_EXTERN hb_bool_t

hb_map_allocation_successful (const hb_map_t *map);

HB_EXTERN void

hb_map_clear (hb_map_t *map);

HB_EXTERN hb_bool_t

hb_map_is_empty (const hb_map_t *map);

HB_EXTERN unsigned int

hb_map_get_population (const hb_map_t *map);

HB_EXTERN void

hb_map_set (hb_map_t       *map,

            hb_codepoint_t  key,

            hb_codepoint_t  value);

HB_EXTERN hb_codepoint_t

hb_map_get (const hb_map_t *map,

            hb_codepoint_t  key);

HB_EXTERN void

hb_map_del (hb_map_t       *map,

            hb_codepoint_t  key);

HB_EXTERN hb_bool_t

hb_map_has (const hb_map_t *map,

            hb_codepoint_t  key);

HB_END_DECLS

#endif /* HB_MAP_H */