sites

public wiki contents of suckless.org
git clone git://git.suckless.org/sites
Log | Files | Refs

index.md (1380B)

      1 GRAPHEME\_NEXT\_CHARACTER\_BREAK(3) - Library Functions Manual
      2 
      3 # NAME
      4 
      5 **grapheme\_next\_character\_break** - determine codepoint-offset to next grapheme cluster break
      6 
      7 # SYNOPSIS
      8 
      9 **#include <grapheme.h>**
     10 
     11 *size\_t*  
     12 **grapheme\_next\_character\_break**(*const uint\_least32\_t \*str*, *size\_t len*);
     13 
     14 # DESCRIPTION
     15 
     16 The
     17 **grapheme\_next\_character\_break**()
     18 function computes the offset (in codepoints) to the next grapheme cluster
     19 break (see
     20 libgrapheme(7))
     21 in the codepoint array
     22 *str*
     23 of length
     24 *len*.
     25 If a grapheme cluster begins at
     26 *str*
     27 this offset is equal to the length of said grapheme cluster.
     28 
     29 If
     30 *len*
     31 is set to
     32 `SIZE_MAX`
     33 (stdint.h is already included by grapheme.h) the string
     34 *str*
     35 is interpreted to be NUL-terminated and processing stops when
     36 a codepoint with the value 0 is encountered.
     37 
     38 For UTF-8-encoded input
     39 data
     40 grapheme\_next\_character\_break\_utf8(3)
     41 can be used instead.
     42 
     43 # RETURN VALUES
     44 
     45 The
     46 **grapheme\_next\_character\_break**()
     47 function returns the offset (in codepoints) to the next grapheme cluster
     48 break in
     49 *str*
     50 or 0 if
     51 *str*
     52 is
     53 `NULL`.
     54 
     55 # SEE ALSO
     56 
     57 grapheme\_is\_character\_break(3),
     58 grapheme\_next\_character\_break\_utf8(3),
     59 libgrapheme(7)
     60 
     61 # STANDARDS
     62 
     63 **grapheme\_next\_character\_break**()
     64 is compliant with the Unicode 15.0.0 specification.
     65 
     66 # AUTHORS
     67 
     68 Laslo Hunhold ([dev@frign.de](mailto:dev@frign.de))
     69 
     70 suckless.org - 2022-10-06