hash_key.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef UCX_HASH_KEY_H
#define UCX_HASH_KEY_H
 
#include "common.h"
#include "string.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct cx_hash_key_s {
    const void *data;
    size_t len;
    unsigned hash;
};
 
typedef struct cx_hash_key_s CxHashKey;
 
cx_attr_nonnull
cx_attr_export
void cx_hash_murmur(CxHashKey *key);
 
cx_attr_nodiscard
cx_attr_cstr_arg(1)
cx_attr_export
CxHashKey cx_hash_key_str(const char *str);
 
cx_attr_nodiscard
cx_attr_access_r(1, 2)
cx_attr_export
CxHashKey cx_hash_key_bytes(
        const unsigned char *bytes,
        size_t len
);
 
cx_attr_nodiscard
cx_attr_access_r(1, 2)
cx_attr_export
CxHashKey cx_hash_key(
        const void *obj,
        size_t len
);
 
cx_attr_nodiscard
static inline CxHashKey cx_hash_key_cxstr(cxstring str) {
    return cx_hash_key(str.ptr, str.length);
}
 
#define cx_hash_key_cxstr(str) cx_hash_key_cxstr(cx_strcast(str))
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // UCX_HASH_KEY_H