🛠️🐜 Antkeeper superbuild with dependencies included https://antkeeper.com
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1686 lines
41 KiB

  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <meta name="description" content="API Reference Documentation for FreeType-2.11.0">
  7. <meta name="author" content="FreeType Contributors">
  8. <link rel="icon" href="images/favico.ico">
  9. <meta name="generator" content="mkdocs-1.2.1, mkdocs-material-7.1.9">
  10. <title>List Processing - FreeType-2.11.0 API Reference</title>
  11. <link rel="stylesheet" href="assets/stylesheets/main.ca7ac06f.min.css">
  12. <link rel="stylesheet" href="assets/stylesheets/palette.f1a3b89f.min.css">
  13. <meta name="theme-color" content="#4cae4f">
  14. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  15. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Noto+Serif:300,400,400i,700%7CRoboto+Mono&display=fallback">
  16. <style>:root{--md-text-font-family:"Noto Serif";--md-code-font-family:"Roboto Mono"}</style>
  17. <link rel="stylesheet" href="stylesheets/extra.css">
  18. </head>
  19. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="green" data-md-color-accent="green">
  20. <script>function __prefix(e){return new URL(".",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#list-processing" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <header class="md-header" data-md-component="header">
  32. <nav class="md-header__inner md-grid" aria-label="Header">
  33. <a href="index.html" title="FreeType-2.11.0 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.11.0 API Reference" data-md-component="logo">
  34. <img src="images/favico.ico" alt="logo">
  35. </a>
  36. <label class="md-header__button md-icon" for="__drawer">
  37. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  38. </label>
  39. <div class="md-header__title" data-md-component="header-title">
  40. <div class="md-header__ellipsis">
  41. <div class="md-header__topic">
  42. <span class="md-ellipsis">
  43. FreeType-2.11.0 API Reference
  44. </span>
  45. </div>
  46. <div class="md-header__topic" data-md-component="header-topic">
  47. <span class="md-ellipsis">
  48. List Processing
  49. </span>
  50. </div>
  51. </div>
  52. </div>
  53. <label class="md-header__button md-icon" for="__search">
  54. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  55. </label>
  56. <div class="md-search" data-md-component="search" role="dialog">
  57. <label class="md-search__overlay" for="__search"></label>
  58. <div class="md-search__inner" role="search">
  59. <form class="md-search__form" name="search">
  60. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
  61. <label class="md-search__icon md-icon" for="__search">
  62. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  64. </label>
  65. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  66. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  67. </button>
  68. </form>
  69. <div class="md-search__output">
  70. <div class="md-search__scrollwrap" data-md-scrollfix>
  71. <div class="md-search-result" data-md-component="search-result">
  72. <div class="md-search-result__meta">
  73. Initializing search
  74. </div>
  75. <ol class="md-search-result__list"></ol>
  76. </div>
  77. </div>
  78. </div>
  79. </div>
  80. </div>
  81. </nav>
  82. </header>
  83. <div class="md-container" data-md-component="container">
  84. <main class="md-main" data-md-component="main">
  85. <div class="md-main__inner md-grid">
  86. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  87. <div class="md-sidebar__scrollwrap">
  88. <div class="md-sidebar__inner">
  89. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  90. <label class="md-nav__title" for="__drawer">
  91. <a href="index.html" title="FreeType-2.11.0 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.11.0 API Reference" data-md-component="logo">
  92. <img src="images/favico.ico" alt="logo">
  93. </a>
  94. FreeType-2.11.0 API Reference
  95. </label>
  96. <ul class="md-nav__list" data-md-scrollfix>
  97. <li class="md-nav__item">
  98. <a href="index.html" class="md-nav__link">
  99. TOC
  100. </a>
  101. </li>
  102. <li class="md-nav__item">
  103. <a href="ft2-index.html" class="md-nav__link">
  104. Index
  105. </a>
  106. </li>
  107. <li class="md-nav__item md-nav__item--nested">
  108. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  109. <label class="md-nav__link" for="__nav_3">
  110. General Remarks
  111. <span class="md-nav__icon md-icon"></span>
  112. </label>
  113. <nav class="md-nav" aria-label="General Remarks" data-md-level="1">
  114. <label class="md-nav__title" for="__nav_3">
  115. <span class="md-nav__icon md-icon"></span>
  116. General Remarks
  117. </label>
  118. <ul class="md-nav__list" data-md-scrollfix>
  119. <li class="md-nav__item">
  120. <a href="ft2-preamble.html" class="md-nav__link">
  121. Preamble
  122. </a>
  123. </li>
  124. <li class="md-nav__item">
  125. <a href="ft2-header_inclusion.html" class="md-nav__link">
  126. FreeType's header inclusion scheme
  127. </a>
  128. </li>
  129. <li class="md-nav__item">
  130. <a href="ft2-user_allocation.html" class="md-nav__link">
  131. User allocation
  132. </a>
  133. </li>
  134. </ul>
  135. </nav>
  136. </li>
  137. <li class="md-nav__item md-nav__item--nested">
  138. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
  139. <label class="md-nav__link" for="__nav_4">
  140. Core API
  141. <span class="md-nav__icon md-icon"></span>
  142. </label>
  143. <nav class="md-nav" aria-label="Core API" data-md-level="1">
  144. <label class="md-nav__title" for="__nav_4">
  145. <span class="md-nav__icon md-icon"></span>
  146. Core API
  147. </label>
  148. <ul class="md-nav__list" data-md-scrollfix>
  149. <li class="md-nav__item">
  150. <a href="ft2-version.html" class="md-nav__link">
  151. FreeType Version
  152. </a>
  153. </li>
  154. <li class="md-nav__item">
  155. <a href="ft2-basic_types.html" class="md-nav__link">
  156. Basic Data Types
  157. </a>
  158. </li>
  159. <li class="md-nav__item">
  160. <a href="ft2-base_interface.html" class="md-nav__link">
  161. Base Interface
  162. </a>
  163. </li>
  164. <li class="md-nav__item">
  165. <a href="ft2-glyph_variants.html" class="md-nav__link">
  166. Unicode Variation Sequences
  167. </a>
  168. </li>
  169. <li class="md-nav__item">
  170. <a href="ft2-color_management.html" class="md-nav__link">
  171. Glyph Color Management
  172. </a>
  173. </li>
  174. <li class="md-nav__item">
  175. <a href="ft2-layer_management.html" class="md-nav__link">
  176. Glyph Layer Management
  177. </a>
  178. </li>
  179. <li class="md-nav__item">
  180. <a href="ft2-glyph_management.html" class="md-nav__link">
  181. Glyph Management
  182. </a>
  183. </li>
  184. <li class="md-nav__item">
  185. <a href="ft2-mac_specific.html" class="md-nav__link">
  186. Mac Specific Interface
  187. </a>
  188. </li>
  189. <li class="md-nav__item">
  190. <a href="ft2-sizes_management.html" class="md-nav__link">
  191. Size Management
  192. </a>
  193. </li>
  194. <li class="md-nav__item">
  195. <a href="ft2-header_file_macros.html" class="md-nav__link">
  196. Header File Macros
  197. </a>
  198. </li>
  199. </ul>
  200. </nav>
  201. </li>
  202. <li class="md-nav__item md-nav__item--nested">
  203. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  204. <label class="md-nav__link" for="__nav_5">
  205. Format-Specific API
  206. <span class="md-nav__icon md-icon"></span>
  207. </label>
  208. <nav class="md-nav" aria-label="Format-Specific API" data-md-level="1">
  209. <label class="md-nav__title" for="__nav_5">
  210. <span class="md-nav__icon md-icon"></span>
  211. Format-Specific API
  212. </label>
  213. <ul class="md-nav__list" data-md-scrollfix>
  214. <li class="md-nav__item">
  215. <a href="ft2-multiple_masters.html" class="md-nav__link">
  216. Multiple Masters
  217. </a>
  218. </li>
  219. <li class="md-nav__item">
  220. <a href="ft2-truetype_tables.html" class="md-nav__link">
  221. TrueType Tables
  222. </a>
  223. </li>
  224. <li class="md-nav__item">
  225. <a href="ft2-type1_tables.html" class="md-nav__link">
  226. Type 1 Tables
  227. </a>
  228. </li>
  229. <li class="md-nav__item">
  230. <a href="ft2-sfnt_names.html" class="md-nav__link">
  231. SFNT Names
  232. </a>
  233. </li>
  234. <li class="md-nav__item">
  235. <a href="ft2-bdf_fonts.html" class="md-nav__link">
  236. BDF and PCF Files
  237. </a>
  238. </li>
  239. <li class="md-nav__item">
  240. <a href="ft2-cid_fonts.html" class="md-nav__link">
  241. CID Fonts
  242. </a>
  243. </li>
  244. <li class="md-nav__item">
  245. <a href="ft2-pfr_fonts.html" class="md-nav__link">
  246. PFR Fonts
  247. </a>
  248. </li>
  249. <li class="md-nav__item">
  250. <a href="ft2-winfnt_fonts.html" class="md-nav__link">
  251. Window FNT Files
  252. </a>
  253. </li>
  254. <li class="md-nav__item">
  255. <a href="ft2-font_formats.html" class="md-nav__link">
  256. Font Formats
  257. </a>
  258. </li>
  259. <li class="md-nav__item">
  260. <a href="ft2-gasp_table.html" class="md-nav__link">
  261. Gasp Table
  262. </a>
  263. </li>
  264. </ul>
  265. </nav>
  266. </li>
  267. <li class="md-nav__item md-nav__item--nested">
  268. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  269. <label class="md-nav__link" for="__nav_6">
  270. Controlling FreeType Modules
  271. <span class="md-nav__icon md-icon"></span>
  272. </label>
  273. <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1">
  274. <label class="md-nav__title" for="__nav_6">
  275. <span class="md-nav__icon md-icon"></span>
  276. Controlling FreeType Modules
  277. </label>
  278. <ul class="md-nav__list" data-md-scrollfix>
  279. <li class="md-nav__item">
  280. <a href="ft2-auto_hinter.html" class="md-nav__link">
  281. The auto-hinter
  282. </a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="ft2-cff_driver.html" class="md-nav__link">
  286. The CFF driver
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="ft2-t1_cid_driver.html" class="md-nav__link">
  291. The Type 1 and CID drivers
  292. </a>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="ft2-tt_driver.html" class="md-nav__link">
  296. The TrueType driver
  297. </a>
  298. </li>
  299. <li class="md-nav__item">
  300. <a href="ft2-pcf_driver.html" class="md-nav__link">
  301. The PCF driver
  302. </a>
  303. </li>
  304. <li class="md-nav__item">
  305. <a href="ft2-properties.html" class="md-nav__link">
  306. Driver properties
  307. </a>
  308. </li>
  309. <li class="md-nav__item">
  310. <a href="ft2-parameter_tags.html" class="md-nav__link">
  311. Parameter Tags
  312. </a>
  313. </li>
  314. <li class="md-nav__item">
  315. <a href="ft2-lcd_rendering.html" class="md-nav__link">
  316. Subpixel Rendering
  317. </a>
  318. </li>
  319. </ul>
  320. </nav>
  321. </li>
  322. <li class="md-nav__item md-nav__item--nested">
  323. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  324. <label class="md-nav__link" for="__nav_7">
  325. Cache Sub-System
  326. <span class="md-nav__icon md-icon"></span>
  327. </label>
  328. <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1">
  329. <label class="md-nav__title" for="__nav_7">
  330. <span class="md-nav__icon md-icon"></span>
  331. Cache Sub-System
  332. </label>
  333. <ul class="md-nav__list" data-md-scrollfix>
  334. <li class="md-nav__item">
  335. <a href="ft2-cache_subsystem.html" class="md-nav__link">
  336. Cache Sub-System
  337. </a>
  338. </li>
  339. </ul>
  340. </nav>
  341. </li>
  342. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  343. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" checked>
  344. <label class="md-nav__link" for="__nav_8">
  345. Support API
  346. <span class="md-nav__icon md-icon"></span>
  347. </label>
  348. <nav class="md-nav" aria-label="Support API" data-md-level="1">
  349. <label class="md-nav__title" for="__nav_8">
  350. <span class="md-nav__icon md-icon"></span>
  351. Support API
  352. </label>
  353. <ul class="md-nav__list" data-md-scrollfix>
  354. <li class="md-nav__item">
  355. <a href="ft2-computations.html" class="md-nav__link">
  356. Computations
  357. </a>
  358. </li>
  359. <li class="md-nav__item md-nav__item--active">
  360. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  361. <label class="md-nav__link md-nav__link--active" for="__toc">
  362. List Processing
  363. <span class="md-nav__icon md-icon"></span>
  364. </label>
  365. <a href="ft2-list_processing.html" class="md-nav__link md-nav__link--active">
  366. List Processing
  367. </a>
  368. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  369. <label class="md-nav__title" for="__toc">
  370. <span class="md-nav__icon md-icon"></span>
  371. Table of contents
  372. </label>
  373. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  374. <li class="md-nav__item">
  375. <a href="#synopsis" class="md-nav__link">
  376. Synopsis
  377. </a>
  378. </li>
  379. <li class="md-nav__item">
  380. <a href="#ft_list" class="md-nav__link">
  381. FT_List
  382. </a>
  383. </li>
  384. <li class="md-nav__item">
  385. <a href="#ft_listnode" class="md-nav__link">
  386. FT_ListNode
  387. </a>
  388. </li>
  389. <li class="md-nav__item">
  390. <a href="#ft_listrec" class="md-nav__link">
  391. FT_ListRec
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="#ft_listnoderec" class="md-nav__link">
  396. FT_ListNodeRec
  397. </a>
  398. </li>
  399. <li class="md-nav__item">
  400. <a href="#ft_list_add" class="md-nav__link">
  401. FT_List_Add
  402. </a>
  403. </li>
  404. <li class="md-nav__item">
  405. <a href="#ft_list_insert" class="md-nav__link">
  406. FT_List_Insert
  407. </a>
  408. </li>
  409. <li class="md-nav__item">
  410. <a href="#ft_list_find" class="md-nav__link">
  411. FT_List_Find
  412. </a>
  413. </li>
  414. <li class="md-nav__item">
  415. <a href="#ft_list_remove" class="md-nav__link">
  416. FT_List_Remove
  417. </a>
  418. </li>
  419. <li class="md-nav__item">
  420. <a href="#ft_list_up" class="md-nav__link">
  421. FT_List_Up
  422. </a>
  423. </li>
  424. <li class="md-nav__item">
  425. <a href="#ft_list_iterate" class="md-nav__link">
  426. FT_List_Iterate
  427. </a>
  428. </li>
  429. <li class="md-nav__item">
  430. <a href="#ft_list_iterator" class="md-nav__link">
  431. FT_List_Iterator
  432. </a>
  433. </li>
  434. <li class="md-nav__item">
  435. <a href="#ft_list_finalize" class="md-nav__link">
  436. FT_List_Finalize
  437. </a>
  438. </li>
  439. <li class="md-nav__item">
  440. <a href="#ft_list_destructor" class="md-nav__link">
  441. FT_List_Destructor
  442. </a>
  443. </li>
  444. </ul>
  445. </nav>
  446. </li>
  447. <li class="md-nav__item">
  448. <a href="ft2-outline_processing.html" class="md-nav__link">
  449. Outline Processing
  450. </a>
  451. </li>
  452. <li class="md-nav__item">
  453. <a href="ft2-quick_advance.html" class="md-nav__link">
  454. Quick retrieval of advance values
  455. </a>
  456. </li>
  457. <li class="md-nav__item">
  458. <a href="ft2-bitmap_handling.html" class="md-nav__link">
  459. Bitmap Handling
  460. </a>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="ft2-raster.html" class="md-nav__link">
  464. Scanline Converter
  465. </a>
  466. </li>
  467. <li class="md-nav__item">
  468. <a href="ft2-glyph_stroker.html" class="md-nav__link">
  469. Glyph Stroker
  470. </a>
  471. </li>
  472. <li class="md-nav__item">
  473. <a href="ft2-system_interface.html" class="md-nav__link">
  474. System Interface
  475. </a>
  476. </li>
  477. <li class="md-nav__item">
  478. <a href="ft2-module_management.html" class="md-nav__link">
  479. Module Management
  480. </a>
  481. </li>
  482. <li class="md-nav__item">
  483. <a href="ft2-gzip.html" class="md-nav__link">
  484. GZIP Streams
  485. </a>
  486. </li>
  487. <li class="md-nav__item">
  488. <a href="ft2-lzw.html" class="md-nav__link">
  489. LZW Streams
  490. </a>
  491. </li>
  492. <li class="md-nav__item">
  493. <a href="ft2-bzip2.html" class="md-nav__link">
  494. BZIP2 Streams
  495. </a>
  496. </li>
  497. <li class="md-nav__item">
  498. <a href="ft2-debugging_apis.html" class="md-nav__link">
  499. External Debugging APIs
  500. </a>
  501. </li>
  502. </ul>
  503. </nav>
  504. </li>
  505. <li class="md-nav__item md-nav__item--nested">
  506. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  507. <label class="md-nav__link" for="__nav_9">
  508. Error Codes
  509. <span class="md-nav__icon md-icon"></span>
  510. </label>
  511. <nav class="md-nav" aria-label="Error Codes" data-md-level="1">
  512. <label class="md-nav__title" for="__nav_9">
  513. <span class="md-nav__icon md-icon"></span>
  514. Error Codes
  515. </label>
  516. <ul class="md-nav__list" data-md-scrollfix>
  517. <li class="md-nav__item">
  518. <a href="ft2-error_enumerations.html" class="md-nav__link">
  519. Error Enumerations
  520. </a>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="ft2-error_code_values.html" class="md-nav__link">
  524. Error Code Values
  525. </a>
  526. </li>
  527. </ul>
  528. </nav>
  529. </li>
  530. <li class="md-nav__item md-nav__item--nested">
  531. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" >
  532. <label class="md-nav__link" for="__nav_10">
  533. Miscellaneous
  534. <span class="md-nav__icon md-icon"></span>
  535. </label>
  536. <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1">
  537. <label class="md-nav__title" for="__nav_10">
  538. <span class="md-nav__icon md-icon"></span>
  539. Miscellaneous
  540. </label>
  541. <ul class="md-nav__list" data-md-scrollfix>
  542. <li class="md-nav__item">
  543. <a href="ft2-gx_validation.html" class="md-nav__link">
  544. TrueTypeGX/AAT Validation
  545. </a>
  546. </li>
  547. <li class="md-nav__item">
  548. <a href="ft2-incremental.html" class="md-nav__link">
  549. Incremental Loading
  550. </a>
  551. </li>
  552. <li class="md-nav__item">
  553. <a href="ft2-truetype_engine.html" class="md-nav__link">
  554. The TrueType Engine
  555. </a>
  556. </li>
  557. <li class="md-nav__item">
  558. <a href="ft2-ot_validation.html" class="md-nav__link">
  559. OpenType Validation
  560. </a>
  561. </li>
  562. </ul>
  563. </nav>
  564. </li>
  565. </ul>
  566. </nav>
  567. </div>
  568. </div>
  569. </div>
  570. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  571. <div class="md-sidebar__scrollwrap">
  572. <div class="md-sidebar__inner">
  573. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  574. <label class="md-nav__title" for="__toc">
  575. <span class="md-nav__icon md-icon"></span>
  576. Table of contents
  577. </label>
  578. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  579. <li class="md-nav__item">
  580. <a href="#synopsis" class="md-nav__link">
  581. Synopsis
  582. </a>
  583. </li>
  584. <li class="md-nav__item">
  585. <a href="#ft_list" class="md-nav__link">
  586. FT_List
  587. </a>
  588. </li>
  589. <li class="md-nav__item">
  590. <a href="#ft_listnode" class="md-nav__link">
  591. FT_ListNode
  592. </a>
  593. </li>
  594. <li class="md-nav__item">
  595. <a href="#ft_listrec" class="md-nav__link">
  596. FT_ListRec
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="#ft_listnoderec" class="md-nav__link">
  601. FT_ListNodeRec
  602. </a>
  603. </li>
  604. <li class="md-nav__item">
  605. <a href="#ft_list_add" class="md-nav__link">
  606. FT_List_Add
  607. </a>
  608. </li>
  609. <li class="md-nav__item">
  610. <a href="#ft_list_insert" class="md-nav__link">
  611. FT_List_Insert
  612. </a>
  613. </li>
  614. <li class="md-nav__item">
  615. <a href="#ft_list_find" class="md-nav__link">
  616. FT_List_Find
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="#ft_list_remove" class="md-nav__link">
  621. FT_List_Remove
  622. </a>
  623. </li>
  624. <li class="md-nav__item">
  625. <a href="#ft_list_up" class="md-nav__link">
  626. FT_List_Up
  627. </a>
  628. </li>
  629. <li class="md-nav__item">
  630. <a href="#ft_list_iterate" class="md-nav__link">
  631. FT_List_Iterate
  632. </a>
  633. </li>
  634. <li class="md-nav__item">
  635. <a href="#ft_list_iterator" class="md-nav__link">
  636. FT_List_Iterator
  637. </a>
  638. </li>
  639. <li class="md-nav__item">
  640. <a href="#ft_list_finalize" class="md-nav__link">
  641. FT_List_Finalize
  642. </a>
  643. </li>
  644. <li class="md-nav__item">
  645. <a href="#ft_list_destructor" class="md-nav__link">
  646. FT_List_Destructor
  647. </a>
  648. </li>
  649. </ul>
  650. </nav>
  651. </div>
  652. </div>
  653. </div>
  654. <div class="md-content" data-md-component="content">
  655. <article class="md-content__inner md-typeset">
  656. <p><a href="https://www.freetype.org">FreeType</a> &raquo; <a href="../">Docs</a> &raquo; <a href="index.html#support-api">Support API</a> &raquo; List Processing</p>
  657. <hr />
  658. <h1 id="list-processing">List Processing<a class="headerlink" href="#list-processing" title="Permanent link">&para;</a></h1>
  659. <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">&para;</a></h2>
  660. <p>This section contains various definitions related to list processing using doubly-linked nodes.</p>
  661. <h2 id="ft_list">FT_List<a class="headerlink" href="#ft_list" title="Permanent link">&para;</a></h2>
  662. <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
  663. <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_ListRec_* <b>FT_List</b>;
  664. </code></pre></div>
  665. <p>A handle to a list record (see <code><a href="ft2-list_processing.html#ft_listrec">FT_ListRec</a></code>).</p>
  666. <hr>
  667. <h2 id="ft_listnode">FT_ListNode<a class="headerlink" href="#ft_listnode" title="Permanent link">&para;</a></h2>
  668. <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
  669. <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_ListNodeRec_* <b>FT_ListNode</b>;
  670. </code></pre></div>
  671. <p>Many elements and objects in FreeType are listed through an <code><a href="ft2-list_processing.html#ft_list">FT_List</a></code> record (see <code><a href="ft2-list_processing.html#ft_listrec">FT_ListRec</a></code>). As its name suggests, an FT_ListNode is a handle to a single list element.</p>
  672. <hr>
  673. <h2 id="ft_listrec">FT_ListRec<a class="headerlink" href="#ft_listrec" title="Permanent link">&para;</a></h2>
  674. <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
  675. <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_ListRec_
  676. {
  677. <a href="ft2-list_processing.html#ft_listnode">FT_ListNode</a> head;
  678. <a href="ft2-list_processing.html#ft_listnode">FT_ListNode</a> tail;
  679. } <b>FT_ListRec</b>;
  680. </code></pre></div>
  681. <p>A structure used to hold a simple doubly-linked list. These are used in many parts of FreeType.</p>
  682. <h4>fields</h4>
  683. <table class="fields">
  684. <tr><td class="val" id="head">head</td><td class="desc">
  685. <p>The head (first element) of doubly-linked list.</p>
  686. </td></tr>
  687. <tr><td class="val" id="tail">tail</td><td class="desc">
  688. <p>The tail (last element) of doubly-linked list.</p>
  689. </td></tr>
  690. </table>
  691. <hr>
  692. <h2 id="ft_listnoderec">FT_ListNodeRec<a class="headerlink" href="#ft_listnoderec" title="Permanent link">&para;</a></h2>
  693. <p>Defined in FT_TYPES_H (freetype/fttypes.h).</p>
  694. <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_ListNodeRec_
  695. {
  696. <a href="ft2-list_processing.html#ft_listnode">FT_ListNode</a> prev;
  697. <a href="ft2-list_processing.html#ft_listnode">FT_ListNode</a> next;
  698. <span class="keyword">void</span>* data;
  699. } <b>FT_ListNodeRec</b>;
  700. </code></pre></div>
  701. <p>A structure used to hold a single list element.</p>
  702. <h4>fields</h4>
  703. <table class="fields">
  704. <tr><td class="val" id="prev">prev</td><td class="desc">
  705. <p>The previous element in the list. <code>NULL</code> if first.</p>
  706. </td></tr>
  707. <tr><td class="val" id="next">next</td><td class="desc">
  708. <p>The next element in the list. <code>NULL</code> if last.</p>
  709. </td></tr>
  710. <tr><td class="val" id="data">data</td><td class="desc">
  711. <p>A typeless pointer to the listed object.</p>
  712. </td></tr>
  713. </table>
  714. <hr>
  715. <h2 id="ft_list_add">FT_List_Add<a class="headerlink" href="#ft_list_add" title="Permanent link">&para;</a></h2>
  716. <p>Defined in FT_LIST_H (freetype/ftlist.h).</p>
  717. <div class = "codehilite"><pre><code> FT_EXPORT( <span class="keyword">void</span> )
  718. <b>FT_List_Add</b>( <a href="ft2-list_processing.html#ft_list">FT_List</a> list,
  719. <a href="ft2-list_processing.html#ft_listnode">FT_ListNode</a> node );
  720. </code></pre></div>
  721. <p>Append an element to the end of a list.</p>
  722. <h4>inout</h4>
  723. <table class="fields">
  724. <tr><td class="val" id="list">list</td><td class="desc">
  725. <p>A pointer to the parent list.</p>
  726. </td></tr>
  727. <tr><td class="val" id="node">node</td><td class="desc">
  728. <p>The node to append.</p>
  729. </td></tr>
  730. </table>
  731. <hr>
  732. <h2 id="ft_list_insert">FT_List_Insert<a class="headerlink" href="#ft_list_insert" title="Permanent link">&para;</a></h2>
  733. <p>Defined in FT_LIST_H (freetype/ftlist.h).</p>
  734. <div class = "codehilite"><pre><code> FT_EXPORT( <span class="keyword">void</span> )
  735. <b>FT_List_Insert</b>( <a href="ft2-list_processing.html#ft_list">FT_List</a> list,
  736. <a href="ft2-list_processing.html#ft_listnode">FT_ListNode</a> node );
  737. </code></pre></div>
  738. <p>Insert an element at the head of a list.</p>
  739. <h4>inout</h4>
  740. <table class="fields">
  741. <tr><td class="val" id="list">list</td><td class="desc">
  742. <p>A pointer to parent list.</p>
  743. </td></tr>
  744. <tr><td class="val" id="node">node</td><td class="desc">
  745. <p>The node to insert.</p>
  746. </td></tr>
  747. </table>
  748. <hr>
  749. <h2 id="ft_list_find">FT_List_Find<a class="headerlink" href="#ft_list_find" title="Permanent link">&para;</a></h2>
  750. <p>Defined in FT_LIST_H (freetype/ftlist.h).</p>
  751. <div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-list_processing.html#ft_listnode">FT_ListNode</a> )
  752. <b>FT_List_Find</b>( <a href="ft2-list_processing.html#ft_list">FT_List</a> list,
  753. <span class="keyword">void</span>* data );
  754. </code></pre></div>
  755. <p>Find the list node for a given listed object.</p>
  756. <h4>input</h4>
  757. <table class="fields">
  758. <tr><td class="val" id="list">list</td><td class="desc">
  759. <p>A pointer to the parent list.</p>
  760. </td></tr>
  761. <tr><td class="val" id="data">data</td><td class="desc">
  762. <p>The address of the listed object.</p>
  763. </td></tr>
  764. </table>
  765. <h4>return</h4>
  766. <p>List node. <code>NULL</code> if it wasn't found.</p>
  767. <hr>
  768. <h2 id="ft_list_remove">FT_List_Remove<a class="headerlink" href="#ft_list_remove" title="Permanent link">&para;</a></h2>
  769. <p>Defined in FT_LIST_H (freetype/ftlist.h).</p>
  770. <div class = "codehilite"><pre><code> FT_EXPORT( <span class="keyword">void</span> )
  771. <b>FT_List_Remove</b>( <a href="ft2-list_processing.html#ft_list">FT_List</a> list,
  772. <a href="ft2-list_processing.html#ft_listnode">FT_ListNode</a> node );
  773. </code></pre></div>
  774. <p>Remove a node from a list. This function doesn't check whether the node is in the list!</p>
  775. <h4>input</h4>
  776. <table class="fields">
  777. <tr><td class="val" id="node">node</td><td class="desc">
  778. <p>The node to remove.</p>
  779. </td></tr>
  780. </table>
  781. <h4>inout</h4>
  782. <table class="fields">
  783. <tr><td class="val" id="list">list</td><td class="desc">
  784. <p>A pointer to the parent list.</p>
  785. </td></tr>
  786. </table>
  787. <hr>
  788. <h2 id="ft_list_up">FT_List_Up<a class="headerlink" href="#ft_list_up" title="Permanent link">&para;</a></h2>
  789. <p>Defined in FT_LIST_H (freetype/ftlist.h).</p>
  790. <div class = "codehilite"><pre><code> FT_EXPORT( <span class="keyword">void</span> )
  791. <b>FT_List_Up</b>( <a href="ft2-list_processing.html#ft_list">FT_List</a> list,
  792. <a href="ft2-list_processing.html#ft_listnode">FT_ListNode</a> node );
  793. </code></pre></div>
  794. <p>Move a node to the head/top of a list. Used to maintain LRU lists.</p>
  795. <h4>inout</h4>
  796. <table class="fields">
  797. <tr><td class="val" id="list">list</td><td class="desc">
  798. <p>A pointer to the parent list.</p>
  799. </td></tr>
  800. <tr><td class="val" id="node">node</td><td class="desc">
  801. <p>The node to move.</p>
  802. </td></tr>
  803. </table>
  804. <hr>
  805. <h2 id="ft_list_iterate">FT_List_Iterate<a class="headerlink" href="#ft_list_iterate" title="Permanent link">&para;</a></h2>
  806. <p>Defined in FT_LIST_H (freetype/ftlist.h).</p>
  807. <div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> )
  808. <b>FT_List_Iterate</b>( <a href="ft2-list_processing.html#ft_list">FT_List</a> list,
  809. <a href="ft2-list_processing.html#ft_list_iterator">FT_List_Iterator</a> iterator,
  810. <span class="keyword">void</span>* user );
  811. </code></pre></div>
  812. <p>Parse a list and calls a given iterator function on each element. Note that parsing is stopped as soon as one of the iterator calls returns a non-zero value.</p>
  813. <h4>input</h4>
  814. <table class="fields">
  815. <tr><td class="val" id="list">list</td><td class="desc">
  816. <p>A handle to the list.</p>
  817. </td></tr>
  818. <tr><td class="val" id="iterator">iterator</td><td class="desc">
  819. <p>An iterator function, called on each node of the list.</p>
  820. </td></tr>
  821. <tr><td class="val" id="user">user</td><td class="desc">
  822. <p>A user-supplied field that is passed as the second argument to the iterator.</p>
  823. </td></tr>
  824. </table>
  825. <h4>return</h4>
  826. <p>The result (a FreeType error code) of the last iterator call.</p>
  827. <hr>
  828. <h2 id="ft_list_iterator">FT_List_Iterator<a class="headerlink" href="#ft_list_iterator" title="Permanent link">&para;</a></h2>
  829. <p>Defined in FT_LIST_H (freetype/ftlist.h).</p>
  830. <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <a href="ft2-basic_types.html#ft_error">FT_Error</a>
  831. (*<b>FT_List_Iterator</b>)( <a href="ft2-list_processing.html#ft_listnode">FT_ListNode</a> node,
  832. <span class="keyword">void</span>* user );
  833. </code></pre></div>
  834. <p>An FT_List iterator function that is called during a list parse by <code><a href="ft2-list_processing.html#ft_list_iterate">FT_List_Iterate</a></code>.</p>
  835. <h4>input</h4>
  836. <table class="fields">
  837. <tr><td class="val" id="node">node</td><td class="desc">
  838. <p>The current iteration list node.</p>
  839. </td></tr>
  840. <tr><td class="val" id="user">user</td><td class="desc">
  841. <p>A typeless pointer passed to <code><a href="ft2-list_processing.html#ft_list_iterate">FT_List_Iterate</a></code>. Can be used to point to the iteration's state.</p>
  842. </td></tr>
  843. </table>
  844. <hr>
  845. <h2 id="ft_list_finalize">FT_List_Finalize<a class="headerlink" href="#ft_list_finalize" title="Permanent link">&para;</a></h2>
  846. <p>Defined in FT_LIST_H (freetype/ftlist.h).</p>
  847. <div class = "codehilite"><pre><code> FT_EXPORT( <span class="keyword">void</span> )
  848. <b>FT_List_Finalize</b>( <a href="ft2-list_processing.html#ft_list">FT_List</a> list,
  849. <a href="ft2-list_processing.html#ft_list_destructor">FT_List_Destructor</a> destroy,
  850. <a href="ft2-system_interface.html#ft_memory">FT_Memory</a> memory,
  851. <span class="keyword">void</span>* user );
  852. </code></pre></div>
  853. <p>Destroy all elements in the list as well as the list itself.</p>
  854. <h4>input</h4>
  855. <table class="fields">
  856. <tr><td class="val" id="list">list</td><td class="desc">
  857. <p>A handle to the list.</p>
  858. </td></tr>
  859. <tr><td class="val" id="destroy">destroy</td><td class="desc">
  860. <p>A list destructor that will be applied to each element of the list. Set this to <code>NULL</code> if not needed.</p>
  861. </td></tr>
  862. <tr><td class="val" id="memory">memory</td><td class="desc">
  863. <p>The current memory object that handles deallocation.</p>
  864. </td></tr>
  865. <tr><td class="val" id="user">user</td><td class="desc">
  866. <p>A user-supplied field that is passed as the last argument to the destructor.</p>
  867. </td></tr>
  868. </table>
  869. <h4>note</h4>
  870. <p>This function expects that all nodes added by <code><a href="ft2-list_processing.html#ft_list_add">FT_List_Add</a></code> or <code><a href="ft2-list_processing.html#ft_list_insert">FT_List_Insert</a></code> have been dynamically allocated.</p>
  871. <hr>
  872. <h2 id="ft_list_destructor">FT_List_Destructor<a class="headerlink" href="#ft_list_destructor" title="Permanent link">&para;</a></h2>
  873. <p>Defined in FT_LIST_H (freetype/ftlist.h).</p>
  874. <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">void</span>
  875. (*<b>FT_List_Destructor</b>)( <a href="ft2-system_interface.html#ft_memory">FT_Memory</a> memory,
  876. <span class="keyword">void</span>* data,
  877. <span class="keyword">void</span>* user );
  878. </code></pre></div>
  879. <p>An <code><a href="ft2-list_processing.html#ft_list">FT_List</a></code> iterator function that is called during a list finalization by <code><a href="ft2-list_processing.html#ft_list_finalize">FT_List_Finalize</a></code> to destroy all elements in a given list.</p>
  880. <h4>input</h4>
  881. <table class="fields">
  882. <tr><td class="val" id="system">system</td><td class="desc">
  883. <p>The current system object.</p>
  884. </td></tr>
  885. <tr><td class="val" id="data">data</td><td class="desc">
  886. <p>The current object to destroy.</p>
  887. </td></tr>
  888. <tr><td class="val" id="user">user</td><td class="desc">
  889. <p>A typeless pointer passed to <code><a href="ft2-list_processing.html#ft_list_iterate">FT_List_Iterate</a></code>. It can be used to point to the iteration's state.</p>
  890. </td></tr>
  891. </table>
  892. <hr>
  893. </article>
  894. </div>
  895. </div>
  896. </main>
  897. <footer class="md-footer">
  898. <nav class="md-footer__inner md-grid" aria-label="Footer">
  899. <a href="ft2-computations.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Computations" rel="prev">
  900. <div class="md-footer__button md-icon">
  901. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  902. </div>
  903. <div class="md-footer__title">
  904. <div class="md-ellipsis">
  905. <span class="md-footer__direction">
  906. Previous
  907. </span>
  908. Computations
  909. </div>
  910. </div>
  911. </a>
  912. <a href="ft2-outline_processing.html" class="md-footer__link md-footer__link--next" aria-label="Next: Outline Processing" rel="next">
  913. <div class="md-footer__title">
  914. <div class="md-ellipsis">
  915. <span class="md-footer__direction">
  916. Next
  917. </span>
  918. Outline Processing
  919. </div>
  920. </div>
  921. <div class="md-footer__button md-icon">
  922. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  923. </div>
  924. </a>
  925. </nav>
  926. <div class="md-footer-meta md-typeset">
  927. <div class="md-footer-meta__inner md-grid">
  928. <div class="md-footer-copyright">
  929. <div class="md-footer-copyright__highlight">
  930. Copyright 2021 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>.
  931. </div>
  932. Made with
  933. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  934. Material for MkDocs
  935. </a>
  936. </div>
  937. </div>
  938. </div>
  939. </footer>
  940. </div>
  941. <div class="md-dialog" data-md-component="dialog">
  942. <div class="md-dialog__inner md-typeset"></div>
  943. </div>
  944. <script id="__config" type="application/json">{"base": ".", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "assets/javascripts/workers/search.477d984a.min.js", "version": null}</script>
  945. <script src="assets/javascripts/bundle.82b56eb2.min.js"></script>
  946. <script src="javascripts/extra.js"></script>
  947. </body>
  948. </html>