diff options
Diffstat (limited to 'classpw__utils.html')
| -rw-r--r-- | classpw__utils.html | 311 |
1 files changed, 311 insertions, 0 deletions
diff --git a/classpw__utils.html b/classpw__utils.html new file mode 100644 index 00000000..5c3318f8 --- /dev/null +++ b/classpw__utils.html @@ -0,0 +1,311 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.15"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>PipeWire: pw_utils Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(initResizable); +/* @license-end */</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">PipeWire +  <span id="projectnumber">0.2.9</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.15 --> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',false,false,'search.php','Search'); +}); +/* @license-end */</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('classpw__utils.html','');}); +/* @license-end */ +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-types">Public Types</a> | +<a href="#pub-methods">Public Member Functions</a> </div> + <div class="headertitle"> +<div class="title">pw_utils Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Various utility functions. + <a href="classpw__utils.html#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:a40eebfe720dbba23dbc86347dd95ba0b"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__utils.html#a40eebfe720dbba23dbc86347dd95ba0b">pw_destroy_t</a>) (void *object)</td></tr> +<tr class="memdesc:a40eebfe720dbba23dbc86347dd95ba0b"><td class="mdescLeft"> </td><td class="mdescRight">a function to destroy an item <a href="#a40eebfe720dbba23dbc86347dd95ba0b">More...</a><br /></td></tr> +<tr class="separator:a40eebfe720dbba23dbc86347dd95ba0b"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a3dae48f70b92a377a5ba0bd1060382ce"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__utils.html#a3dae48f70b92a377a5ba0bd1060382ce">pw_split_walk</a> (const char *str, const char *delimiter, size_t *len, const char **state)</td></tr> +<tr class="memdesc:a3dae48f70b92a377a5ba0bd1060382ce"><td class="mdescLeft"> </td><td class="mdescRight">Split a string based on delimiters. <a href="#a3dae48f70b92a377a5ba0bd1060382ce">More...</a><br /></td></tr> +<tr class="separator:a3dae48f70b92a377a5ba0bd1060382ce"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a49b83deb0d19e23830facddb1e03bae1"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__utils.html#a49b83deb0d19e23830facddb1e03bae1">pw_split_strv</a> (const char *str, const char *delimiter, int max_tokens, int *n_tokens)</td></tr> +<tr class="memdesc:a49b83deb0d19e23830facddb1e03bae1"><td class="mdescLeft"> </td><td class="mdescRight">Split a string based on delimiters. <a href="#a49b83deb0d19e23830facddb1e03bae1">More...</a><br /></td></tr> +<tr class="separator:a49b83deb0d19e23830facddb1e03bae1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adfbe5fb619ea56867116d16fa27c2076"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__utils.html#adfbe5fb619ea56867116d16fa27c2076">pw_free_strv</a> (char **str)</td></tr> +<tr class="memdesc:adfbe5fb619ea56867116d16fa27c2076"><td class="mdescLeft"> </td><td class="mdescRight">Free a NULL terminated array of strings. <a href="#adfbe5fb619ea56867116d16fa27c2076">More...</a><br /></td></tr> +<tr class="separator:adfbe5fb619ea56867116d16fa27c2076"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac50c6fcfe11d26670d97203e84892f69"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__utils.html#ac50c6fcfe11d26670d97203e84892f69">pw_strip</a> (char *str, const char *whitespace)</td></tr> +<tr class="memdesc:ac50c6fcfe11d26670d97203e84892f69"><td class="mdescLeft"> </td><td class="mdescRight">Strip all whitespace before and after a string. <a href="#ac50c6fcfe11d26670d97203e84892f69">More...</a><br /></td></tr> +<tr class="separator:ac50c6fcfe11d26670d97203e84892f69"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Various utility functions. </p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="a40eebfe720dbba23dbc86347dd95ba0b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a40eebfe720dbba23dbc86347dd95ba0b">◆ </a></span>pw_destroy_t</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef void(* pw_destroy_t) (void *object)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>a function to destroy an item </p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="adfbe5fb619ea56867116d16fa27c2076"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adfbe5fb619ea56867116d16fa27c2076">◆ </a></span>pw_free_strv()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT void pw_free_strv </td> + <td>(</td> + <td class="paramtype">char ** </td> + <td class="paramname"><em>str</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Free a NULL terminated array of strings. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">str</td><td>a NULL terminated array of string</td></tr> + </table> + </dd> +</dl> +<p>Free all the strings in the array and the array </p> + +</div> +</div> +<a id="a49b83deb0d19e23830facddb1e03bae1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a49b83deb0d19e23830facddb1e03bae1">◆ </a></span>pw_split_strv()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT char ** pw_split_strv </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>str</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>delimiter</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>max_tokens</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int * </td> + <td class="paramname"><em>n_tokens</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Split a string based on delimiters. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir"></td><td class="paramname">str</td><td>a string to split </td></tr> + <tr><td class="paramdir"></td><td class="paramname">delimiter</td><td>delimiter characters to split on </td></tr> + <tr><td class="paramdir"></td><td class="paramname">max_tokens</td><td>the max number of tokens to split </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">n_tokens</td><td>the number of tokens </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a NULL terminated array of strings that should be freed with <a class="el" href="classpw__utils.html#adfbe5fb619ea56867116d16fa27c2076">pw_free_strv</a>. </dd></dl> + +<p class="reference">References <a class="el" href="structpw__array.html#ab0929cdf2f7acb291f2f17be299b8ea5">pw_array::data</a>, <a class="el" href="structpw__array.html#a8d035221a3657cf9d2ede737a62a7c77">pw_array::pw_array_add_ptr</a>, <a class="el" href="structpw__array.html#a41905dd179bcee03cceef47579e0a22e">pw_array::pw_array_init()</a>, and <a class="el" href="classpw__utils.html#a3dae48f70b92a377a5ba0bd1060382ce">pw_split_walk()</a>.</p> + +<p class="reference">Referenced by <a class="el" href="classpw__module.html#a6162cea8c99d7ac59d4479e3204bb0d4">pw_module::pw_module_load()</a>.</p> + +</div> +</div> +<a id="a3dae48f70b92a377a5ba0bd1060382ce"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3dae48f70b92a377a5ba0bd1060382ce">◆ </a></span>pw_split_walk()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT const char * pw_split_walk </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>str</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>delimiter</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t * </td> + <td class="paramname"><em>len</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char ** </td> + <td class="paramname"><em>state</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Split a string based on delimiters. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir"></td><td class="paramname">str</td><td>a string to split </td></tr> + <tr><td class="paramdir"></td><td class="paramname">delimiter</td><td>delimiter characters to split on </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">len</td><td>the length of the current string </td></tr> + <tr><td class="paramdir">[in,out]</td><td class="paramname">state</td><td>a state variable </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a string or NULL when the end is reached</dd></dl> +<p>Repeatedly call this function to split <em>str</em> into all substrings delimited by <em>delimiter</em>. <em>state</em> should be set to NULL on the first invocation and passed to the function until NULL is returned. </p> + +<p class="reference">Referenced by <a class="el" href="classpw__utils.html#a49b83deb0d19e23830facddb1e03bae1">pw_split_strv()</a>.</p> + +</div> +</div> +<a id="ac50c6fcfe11d26670d97203e84892f69"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac50c6fcfe11d26670d97203e84892f69">◆ </a></span>pw_strip()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT char * pw_strip </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>str</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>whitespace</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Strip all whitespace before and after a string. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">str</td><td>a string to strip </td></tr> + <tr><td class="paramname">whitespace</td><td>characters to strip </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the stripped part of <em>str</em> </dd></dl> +<p>Strip whitespace before and after <em>str</em>. <em>str</em> will be modified. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="utils_8h_source.html">utils.h</a></li> +<li><a class="el" href="utils_8c.html">utils.c</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="classpw__utils.html">pw_utils</a></li> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> + </ul> +</div> +</body> +</html> |