Skip to content

Document normalization flags for single-codepoint decomposition #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ac1982 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document normalization flags for single-codepoint decomposition #375

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion utf8proc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,15 +521,24 @@ UTF8PROC_DLLEXPORT const utf8proc_property_t *utf8proc_get_property(utf8proc_int
* @param dst the destination buffer.
* @param bufsize the size of the destination buffer.
* @param options one or more of the following flags:
* - @ref UTF8PROC_DECOMPOSE - apply canonical decomposition
* - @ref UTF8PROC_COMPOSE - also apply canonical decomposition at this stage;
* composition is performed by utf8proc_normalize_utf32()
* - @ref UTF8PROC_REJECTNA - return an error if `codepoint` is unassigned
* - @ref UTF8PROC_IGNORE - strip "default ignorable" codepoints
* - @ref UTF8PROC_CASEFOLD - apply Unicode casefolding
* - @ref UTF8PROC_COMPAT - replace certain codepoints with their
* compatibility decomposition
* compatibility decomposition (requires
* @ref UTF8PROC_DECOMPOSE or @ref UTF8PROC_COMPOSE)
* - @ref UTF8PROC_CHARBOUND - insert 0xFF bytes before each grapheme cluster
* - @ref UTF8PROC_LUMP - lump certain different codepoints together
* - @ref UTF8PROC_STRIPMARK - remove all character marks
* - @ref UTF8PROC_STRIPNA - remove unassigned codepoints
*
* Without @ref UTF8PROC_DECOMPOSE or @ref UTF8PROC_COMPOSE, canonical and
* compatibility decomposition are not performed; other requested transformations
* (such as @ref UTF8PROC_CASEFOLD) still apply.
*
* @param last_boundclass
* Pointer to an integer variable containing
* the previous codepoint's (boundclass + (indic_conjunct_break << 8)) if the @ref UTF8PROC_CHARBOUND
Expand Down