aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README41
1 files changed, 22 insertions, 19 deletions
diff --git a/README b/README
index a2d4f56..b56105f 100644
--- a/README
+++ b/README
@@ -10,16 +10,16 @@ This does not aim to be a LibC replacement, but rather a supplimentary
library. It is a C23 library with no plans to support older standards.
The headers as of now are:
- • alloc.h — allocators and memory allocation functions
- • bitset.h — bitset implementation
- • cli.h — CLI-option parsing functions
- • dynarr.h — dynamic array implementation
- • errors.h — err.h-inspired diagnostics functions
- • macros.h — miscellaneous utility macros (MIN/MAX/lengthof/etc.)
- • mbio.h — multibyte file I/O
- • mbstring.h — multibyte-strings
- • rune.h — inttypes.h but for runes
- • unicode/prop.h — unicode character properties
+ • alloc.h — allocators and memory allocation functions
+ • bitset.h — bitset implementation
+ • cli.h — CLI-option parsing functions
+ • dynarr.h — dynamic array implementation
+ • errors.h — err.h-inspired diagnostics functions
+ • macros.h — miscellaneous utility macros (MIN/MAX/lengthof/etc.)
+ • mbio.h — multibyte file I/O
+ • mbstring.h — multibyte-strings
+ • rune.h — inttypes.h but for runes
+ • unicode/prop.h — unicode character properties
• unicode/string.h — unicode string functions
@@ -93,7 +93,8 @@ FEATURES:
• macros.h
• MIN()/MAX()/CLAMP()
• Better assertion macro
- • More readable strcmp()/memcmp()/etc. wrappers for equality checking
+ • More readable strcmp()/memcmp()/etc. wrappers for equality
+ checking
• Static array length macro
• STR() and CONCAT() to aid metaprogramming
• mbio.h
@@ -104,6 +105,7 @@ FEATURES:
• Count UTF-8 codepoints
• UTF-8 validation
• Various string.h analogues with UTF-8 support
+ • UTF-8 string cutting/splitting
• Random utility macros and -constants
• rune.h
• Format string macros for the printf() and scanf() families of
@@ -115,22 +117,23 @@ FEATURES:
• Properties related to case-mapping are context-aware (via a
context-struct argument)
• unicode/string.h
- • Iteration and counting of graphemes and words in a string
- • Unicode-aware case-mapping of strings with custom allocator
- support
• Case-mapping supports optional language-specific quirks for
Azeri, Dutch, German, Lithuanian, and Turkish.
+ • Iteration and counting of graphemes, words, and human-precieved
+ words in a string
+ • NFD string normalization
+ • Unicode-aware case-mapping of strings with custom allocator
+ support
PLANNED FEATURES:
- • Custom allocator support (dynarr.h)
- • Line- and sentence segmentation (unicode/string.h)
- • String collation (unicode/string.h)
- • Unicode normalization (unicode/string.h)
+ • Line- and sentence segmentation (unicode/string.h)
+ • String collation (unicode/string.h)
+ • NFC-, NFKC-, and NFKD string normalization (unicode/string.h)
BUGS:
- • Unicode Name Aliases (Name_Alias property) is not supported
+ • Unicode Name Aliases (Name_Alias property) are not supported
• Unihan properties are not supported (e.g. Unicode_Radical_Stroke)