source: mainline/uspace/lib/c/include/adt/char_map.h@ 88a1bb9

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 88a1bb9 was 2544442, checked in by Jakub Jermar <jakub@…>, 15 years ago

Fix doxygen doc groups (libc vs. net) and header guards.

  • Property mode set to 100644
File size: 2.9 KB
Line 
1/*
2 * Copyright (c) 2009 Lukas Mejdrech
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libc
30 * @{
31 */
32
33/** @file
34 * Character string to integer map.
35 */
36
37#ifndef LIBC_CHAR_MAP_H_
38#define LIBC_CHAR_MAP_H_
39
40#include <libarch/types.h>
41
42/** Invalid assigned value used also if an&nbsp;entry does not exist. */
43#define CHAR_MAP_NULL (-1)
44
45/** Type definition of the character string to integer map.
46 * @see char_map
47 */
48typedef struct char_map char_map_t;
49
50/** Type definition of the character string to integer map pointer.
51 * @see char_map
52 */
53typedef char_map_t *char_map_ref;
54
55/** Character string to integer map item.
56 *
57 * This structure recursivelly contains itself as a character by character tree.
58 * The actually mapped character string consists of all the parent characters
59 * and the actual one.
60 */
61struct char_map {
62 /** Actually mapped character. */
63 char c;
64 /** Stored integral value. */
65 int value;
66 /** Next character array size. */
67 int size;
68 /** First free position in the next character array. */
69 int next;
70 /** Next character array. */
71 char_map_ref *items;
72 /** Consistency check magic value. */
73 int magic;
74};
75
76extern int char_map_initialize(char_map_ref);
77extern void char_map_destroy(char_map_ref);
78extern int char_map_exclude(char_map_ref, const char *, size_t);
79extern int char_map_add(char_map_ref, const char *, size_t, const int);
80extern int char_map_find(const char_map_ref, const char *, size_t);
81extern int char_map_update(char_map_ref, const char *, size_t, const int);
82
83#endif
84
85/** @}
86 */
Note: See TracBrowser for help on using the repository browser.