doc/libunistring_12.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
   2 <html>
   3 <!-- Created on September, 1 2014 by texi2html 1.78a -->
   4 <!--
   5 Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
   6             Karl Berry  <karl@freefriends.org>
   7             Olaf Bachmann <obachman@mathematik.uni-kl.de>
   8             and many others.
   9 Maintained by: Many creative people.
  10 Send bugs and suggestions to <texi2html-bug@nongnu.org>
  11
  12 -->
  13 <head>
  14 <title>GNU libunistring: 12. Line breaking &lt;unilbrk.h&gt;</title>
  15
  16 <meta name="description" content="GNU libunistring: 12. Line breaking &lt;unilbrk.h&gt;">
  17 <meta name="keywords" content="GNU libunistring: 12. Line breaking &lt;unilbrk.h&gt;">
  18 <meta name="resource-type" content="document">
  19 <meta name="distribution" content="global">
  20 <meta name="Generator" content="texi2html 1.78a">
  21 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  22 <style type="text/css">
  23 <!--
  24 a.summary-letter {text-decoration: none}
  25 pre.display {font-family: serif}
  26 pre.format {font-family: serif}
  27 pre.menu-comment {font-family: serif}
  28 pre.menu-preformatted {font-family: serif}
  29 pre.smalldisplay {font-family: serif; font-size: smaller}
  30 pre.smallexample {font-size: smaller}
  31 pre.smallformat {font-family: serif; font-size: smaller}
  32 pre.smalllisp {font-size: smaller}
  33 span.roman {font-family:serif; font-weight:normal;}
  34 span.sansserif {font-family:sans-serif; font-weight:normal;}
  35 ul.toc {list-style: none}
  36 -->
  37 </style>
  38
  39
  40 </head>
  41
  42 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  43
  44 <table cellpadding="1" cellspacing="1" border="0">
  45 <tr><td valign="middle" align="left">[<a href="libunistring_11.html#SEC44" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
  46 <td valign="middle" align="left">[<a href="libunistring_13.html#SEC48" title="Next chapter"> &gt;&gt; </a>]</td>
  47 <td valign="middle" align="left"> &nbsp; </td>
  48 <td valign="middle" align="left"> &nbsp; </td>
  49 <td valign="middle" align="left"> &nbsp; </td>
  50 <td valign="middle" align="left"> &nbsp; </td>
  51 <td valign="middle" align="left"> &nbsp; </td>
  52 <td valign="middle" align="left">[<a href="libunistring.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
  53 <td valign="middle" align="left">[<a href="libunistring.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
  54 <td valign="middle" align="left">[<a href="libunistring_19.html#SEC77" title="Index">Index</a>]</td>
  55 <td valign="middle" align="left">[<a href="libunistring_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
  56 </tr></table>
  57
  58 <hr size="2">
  59 <a name="unilbrk_002eh"></a>
  60 <a name="SEC47"></a>
  61 <h1 class="chapter"> <a href="libunistring.html#TOC47">12. Line breaking <code>&lt;unilbrk.h&gt;</code></a> </h1>
  62
  63 <p>This include file declares functions for determining where in a string
  64 line breaks could or should be introduced, in order to make the displayed
  65 string fit into a column of given width.
  66 </p>
  67 <p>These functions are locale dependent.  The <var>encoding</var> argument identifies
  68 the encoding (e.g. <code>&quot;ISO-8859-2&quot;</code> for Polish).
  69 </p>
  70 <p>The following enumerated values indicate whether, at a given position, a line
  71 break is possible or not.  Given an string <var>s</var> as an array
  72 <code><var>s</var>[0..<var>n</var>-1]</code> and a position <var>i</var>, the values have the
  73 following meanings:
  74 </p>
  75 <dl>
  76 <dt><u>Constant:</u> int <b>UC_BREAK_MANDATORY</b>
  77 <a name="IDX754"></a>
  78 </dt>
  79 <dd><p>This value indicates that <code><var>s</var>[<var>i</var>]</code> is a line break character.
  80 </p></dd></dl>
  81
  82 <dl>
  83 <dt><u>Constant:</u> int <b>UC_BREAK_POSSIBLE</b>
  84 <a name="IDX755"></a>
  85 </dt>
  86 <dd><p>This value indicates that a line break may be inserted between
  87 <code><var>s</var>[<var>i</var>-1]</code> and <code><var>s</var>[<var>i</var>]</code>.
  88 </p></dd></dl>
  89
  90 <dl>
  91 <dt><u>Constant:</u> int <b>UC_BREAK_HYPHENATION</b>
  92 <a name="IDX756"></a>
  93 </dt>
  94 <dd><p>This value indicates that a hyphen and a line break may be inserted between
  95 <code><var>s</var>[<var>i</var>-1]</code> and <code><var>s</var>[<var>i</var>]</code>.  But beware of language
  96 dependent hyphenation rules.
  97 </p></dd></dl>
  98
  99 <dl>
 100 <dt><u>Constant:</u> int <b>UC_BREAK_PROHIBITED</b>
 101 <a name="IDX757"></a>
 102 </dt>
 103 <dd><p>This value indicates that <code><var>s</var>[<var>i</var>-1]</code> and <code><var>s</var>[<var>i</var>]</code>
 104 must not be separated.
 105 </p></dd></dl>
 106
 107 <dl>
 108 <dt><u>Constant:</u> int <b>UC_BREAK_UNDEFINED</b>
 109 <a name="IDX758"></a>
 110 </dt>
 111 <dd><p>This value is not used as a return value; rather, in the overriding argument of
 112 the <code>u*_width_linebreaks</code> functions, it indicates the absence of an
 113 override.
 114 </p></dd></dl>
 115
 116 <p>The following functions determine the positions at which line breaks are
 117 possible.
 118 </p>
 119 <dl>
 120 <dt><u>Function:</u> void <b>u8_possible_linebreaks</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, const char *<var>encoding</var>, char *<var>p</var>)</i>
 121 <a name="IDX759"></a>
 122 </dt>
 123 <dt><u>Function:</u> void <b>u16_possible_linebreaks</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, const char *<var>encoding</var>, char *<var>p</var>)</i>
 124 <a name="IDX760"></a>
 125 </dt>
 126 <dt><u>Function:</u> void <b>u32_possible_linebreaks</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, const char *<var>encoding</var>, char *<var>p</var>)</i>
 127 <a name="IDX761"></a>
 128 </dt>
 129 <dt><u>Function:</u> void <b>ulc_possible_linebreaks</b><i> (const char *<var>s</var>, size_t <var>n</var>, const char *<var>encoding</var>, char *<var>p</var>)</i>
 130 <a name="IDX762"></a>
 131 </dt>
 132 <dd><p>Determines the line break points in <var>s</var>, and stores the result at
 133 <code><var>p</var>[0..<var>n</var>-1]</code>.  Every <code><var>p</var>[<var>i</var>]</code> is assigned one of
 134 the values <code>UC_BREAK_MANDATORY</code>, <code>UC_BREAK_POSSIBLE</code>,
 135 <code>UC_BREAK_HYPHENATION</code>, <code>UC_BREAK_PROHIBITED</code>.
 136 </p></dd></dl>
 137
 138 <p>The following functions determine where line breaks should be inserted so that
 139 each line fits in a given width, when output to a device that uses
 140 non-proportional fonts.
 141 </p>
 142 <dl>
 143 <dt><u>Function:</u> int <b>u8_width_linebreaks</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, int <var>width</var>, int <var>start_column</var>, int <var>at_end_columns</var>, const char *<var>override</var>, const char *<var>encoding</var>, char *<var>p</var>)</i>
 144 <a name="IDX763"></a>
 145 </dt>
 146 <dt><u>Function:</u> int <b>u16_width_linebreaks</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, int <var>width</var>, int <var>start_column</var>, int <var>at_end_columns</var>, const char *<var>override</var>, const char *<var>encoding</var>, char *<var>p</var>)</i>
 147 <a name="IDX764"></a>
 148 </dt>
 149 <dt><u>Function:</u> int <b>u32_width_linebreaks</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, int <var>width</var>, int <var>start_column</var>, int <var>at_end_columns</var>, const char *<var>override</var>, const char *<var>encoding</var>, char *<var>p</var>)</i>
 150 <a name="IDX765"></a>
 151 </dt>
 152 <dt><u>Function:</u> int <b>ulc_width_linebreaks</b><i> (const char *<var>s</var>, size_t <var>n</var>, int <var>width</var>, int <var>start_column</var>, int <var>at_end_columns</var>, const char *<var>override</var>, const char *<var>encoding</var>, char *<var>p</var>)</i>
 153 <a name="IDX766"></a>
 154 </dt>
 155 <dd><p>Chooses the best line breaks, assuming that every character occupies a width
 156 given by the <code>uc_width</code> function (see <a href="libunistring_9.html#SEC40">Display width <code>&lt;uniwidth.h&gt;</code></a>).
 157 </p>
 158 <p>The string is <code><var>s</var>[0..<var>n</var>-1]</code>.
 159 </p>
 160 <p>The maximum number of columns per line is given as <var>width</var>.
 161 The starting column of the string is given as <var>start_column</var>.
 162 If the algorithm shall keep room after the last piece, this amount of room can
 163 be given as <var>at_end_columns</var>.
 164 </p>
 165 <p><var>override</var> is an optional override; if
 166 <code><var>override</var>[<var>i</var>] != UC_BREAK_UNDEFINED</code>,
 167 <code><var>override</var>[<var>i</var>]</code> takes precedence over <code><var>p</var>[<var>i</var>]</code>
 168 as returned by the <code>u*_possible_linebreaks</code> function.
 169 </p>
 170 <p>The given <var>encoding</var> is used for disambiguating widths in <code>uc_width</code>.
 171 </p>
 172 <p>Returns the column after the end of the string, and stores the result at
 173 <code><var>p</var>[0..<var>n</var>-1]</code>.  Every <code><var>p</var>[<var>i</var>]</code> is assigned one of
 174 the values <code>UC_BREAK_MANDATORY</code>, <code>UC_BREAK_POSSIBLE</code>,
 175 <code>UC_BREAK_HYPHENATION</code>, <code>UC_BREAK_PROHIBITED</code>.  Here the value
 176 <code>UC_BREAK_POSSIBLE</code> indicates that a line break <em>should</em> be inserted.
 177 </p></dd></dl>
 178 <hr size="6">
 179 <table cellpadding="1" cellspacing="1" border="0">
 180 <tr><td valign="middle" align="left">[<a href="libunistring_11.html#SEC44" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
 181 <td valign="middle" align="left">[<a href="libunistring_13.html#SEC48" title="Next chapter"> &gt;&gt; </a>]</td>
 182 <td valign="middle" align="left"> &nbsp; </td>
 183 <td valign="middle" align="left"> &nbsp; </td>
 184 <td valign="middle" align="left"> &nbsp; </td>
 185 <td valign="middle" align="left"> &nbsp; </td>
 186 <td valign="middle" align="left"> &nbsp; </td>
 187 <td valign="middle" align="left">[<a href="libunistring.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
 188 <td valign="middle" align="left">[<a href="libunistring.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
 189 <td valign="middle" align="left">[<a href="libunistring_19.html#SEC77" title="Index">Index</a>]</td>
 190 <td valign="middle" align="left">[<a href="libunistring_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
 191 </tr></table>
 192 <p>
 193  <font size="-1">
 194   This document was generated by <em>Daiki Ueno</em> on <em>September, 1 2014</em> using <a href="http://www.nongnu.org/texi2html/"><em>texi2html 1.78a</em></a>.
 195  </font>
 196  <br>
 197
 198 </p>
 199 </body>
 200 </html>