mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-03-30 07:26:53 +08:00
87 lines
24 KiB
HTML
87 lines
24 KiB
HTML
<!-- HTML header for doxygen 1.8.13-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>openNURBS SDK Help: D:/BuildAgent/work/d8e3bf9e94f4c621/src4/bin/opennurbs_public/opennurbs_base32.h Source File</title>
|
|
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
|
|
<!-- <script type="text/javascript" src="../../jquery.js"></script> -->
|
|
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
|
|
<script type="text/javascript" src="../../dynsections.js"></script>
|
|
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../customdoxygen.css" rel="stylesheet" type="text/css"/>
|
|
<!-- bootstrap -->
|
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
|
|
<!-- smartmenus -->
|
|
<link href="../../jquery.smartmenus.bootstrap.css" rel="stylesheet">
|
|
<script type="text/javascript" src="../../jquery.smartmenus.js"></script>
|
|
<script type="text/javascript" src="../../jquery.smartmenus.bootstrap.js"></script>
|
|
</head>
|
|
<body>
|
|
<!-- <div class="version-banner">
|
|
Go back to the <a href="/">main site</a>...
|
|
</div> -->
|
|
<div class="container">
|
|
<!-- navbar -->
|
|
<nav class="navbar navbar-default">
|
|
<div class="container-fluid">
|
|
<a class="navbar-brand" href="#">openNURBS SDK Help</a>
|
|
<div class="navbar-collapse collapse" id="main-nav-placeholder">
|
|
<!-- <p class="navbar-text navbar-right">v6.0</p> -->
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li class="dropdown">
|
|
<a class="dropdown-toggle" href="#">v6.0 <span class="caret"></span></a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="#">Latest (6.x)</a></li>
|
|
<li class="disabled"><a href="#">WIP (7.x)</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div class="page-content">
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('../../',false,false,'search.php','Search');
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="../../dir_2ea30aa2956a8db99dd22aa5e597f384.html">bin</a></li><li class="navelem"><a class="el" href="../../dir_7a6cfee8d318bd47c162fe536aecd3a7.html">opennurbs_public</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">opennurbs_base32.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* $NoKeywords: $ */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (c) 1993-2012 Robert McNeel & Associates. All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// OpenNURBS, Rhinoceros, and Rhino3D are registered trademarks of Robert</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// McNeel & Associates.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// MERCHANTABILITY ARE HEREBY DISCLAIMED.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// </span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// For complete openNURBS copyright information see <http://www.opennurbs.org>.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">//</span><span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span>*/</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#if !defined(ON_BASE32_INC_)</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define ON_BASE32_INC_</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/*</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">Description:</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> Convert a number into base32 digits.</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">Parameters:</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> x - [in]</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> x_count - [in]</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> x[] is an array of length x_count and represents the value</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> x[0]*2^(8*(x_count-1)) + ... + x[x_count-2]*256 + x[x_count-1].</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> base32_digits - [out]</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> When base32_digits is not a dynamic array, base32_digits[] </span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> must a be an array of length at least</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> ((8*x_count)/5) + (((8*x_count)%5)?1:0) or 1, </span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> whichever is greater.</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> The base32_digits[] array will be filled in with base32 digit </span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> values (0 to 31) so that the value</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> b[0]*32^(b_count-1) + ... + b[b_count-2]*32 + b[b_count-1]</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> is the same as that defined by the x[] array.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">Returns</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> The number of base 32 digits in the base32_digits[] array.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> If 0 is returned, the input is not valid.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">*/</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> ON_DECL</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">int</span> ON_GetBase32Digits( <span class="keyword">const</span> <a class="code" href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray<unsigned char></a>& x, <a class="code" href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray<unsigned char></a>& base32_digits );</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> ON_DECL</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">int</span> ON_GetBase32Digits( <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* x, <span class="keywordtype">int</span> x_count, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* base32_digits );</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">/*</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">Description:</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> Convert a list of base32 digits into a string form.</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">Parameters:</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> base32_digits - [in]</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> base32_digit_count - [in]</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> base32_digits[] is an array of length base32_digit_count. </span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> Each element is in the range 0 to 31.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> sBase32 - [out]</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> sBase32[] must be an array of length base32_digit_count+1 or 2,</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> whichever is greater. The string representation of the base 32</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> number will be put in this string. A hash mark symbol (#) is</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> used to indicate an error in the input value. The returned</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> string is null terminated.</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">Returns</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> True if the input is valid. False if the input is not valid,</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> in which case hash marks indicate the invalid entries.</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">*/</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> ON_DECL</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">bool</span> ON_Base32ToString( <span class="keyword">const</span> <a class="code" href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray<unsigned char></a>& base32_digits, <a class="code" href="../../d2/d3b/class_o_n___string.html">ON_String</a>& sBase32 );</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> ON_DECL</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keywordtype">bool</span> ON_Base32ToString( <span class="keyword">const</span> <a class="code" href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray<unsigned char></a>& base32_digits, <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>& sBase32 );</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> ON_DECL</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">bool</span> ON_Base32ToString( <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* base32_digits, <span class="keywordtype">int</span> base32_digit_count, <span class="keywordtype">char</span>* sBase32 );</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">/*</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">Description:</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> Fixt a common typos in sBase32 string. Lower case letters are</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> converted to upper case. The letters 'I', 'L', 'O' and 'S' are</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> converted to '1' (one), '1' (one) '0' zero and '5' (five).</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">Parameters:</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> sBase32 - [in]</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> sBase32clean - [out]</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> (can be the same string as sBase32)</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">Returns:</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> If the input is valid, the length of the converted string is returned.</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> If the input is not valid, 0 is returned.</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">*/</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> ON_DECL</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">int</span> ON_CorrectBase32StringTypos( <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* sBase32, <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>& sBase32clean );</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> ON_DECL</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">int</span> ON_CorrectBase32StringTypos( <span class="keyword">const</span> <span class="keywordtype">char</span>* sBase32, <a class="code" href="../../d2/d3b/class_o_n___string.html">ON_String</a>& sBase32clean );</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> ON_DECL</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">int</span> ON_CorrectBase32StringTypos( <span class="keyword">const</span> <span class="keywordtype">char</span>* sBase32, <span class="keywordtype">char</span>* sBase32clean );</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">/*</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">Description:</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> Convert a null terminate string containing the 32 symbols </span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> 0 1 2 3 4 5 6 7 8 9 A B C D E F G H J K M N P Q R T U V W X Y Z</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> (I,L,O and S are missing) into a list of base 32 digits.</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">Parameters:</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> sBase32 - [in]</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> String with base 32 digits</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> base32_digits - [out]</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> base32_digits[] is an array of length strlen(sBase32). </span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> The returned array, element will be in the range 0 to 31.</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> sBase32[] must be an array of length base32_digit_count+1 or 2,</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> whichever is greater. The string representation of the base 32</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> number will be put in this string. A hash mark symbol (#) is</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> used to indicate an error in the input value. The returned</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> string is null terminated.</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">Returns</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> True if the input is valid. False if the input is not valid,</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> in which case hash marks indicate the invalid entries.</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">*/</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> ON_DECL</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="keywordtype">int</span> ON_StringToBase32(<span class="keyword">const</span> <a class="code" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>& sBase32, <a class="code" href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray<unsigned char></a>& base32_digits );</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> ON_DECL</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keywordtype">int</span> ON_StringToBase32(<span class="keyword">const</span> <a class="code" href="../../d2/d3b/class_o_n___string.html">ON_String</a>& sBase32, <a class="code" href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray<unsigned char></a>& base32_digits );</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> ON_DECL</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keywordtype">int</span> ON_StringToBase32(<span class="keyword">const</span> <span class="keywordtype">char</span>* sBase32, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* base32_digits );</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_o_n___simple_array_html"><div class="ttname"><a href="../../dc/dfe/class_o_n___simple_array.html">ON_SimpleArray</a></div><div class="ttdef"><b>Definition:</b> opennurbs_array.h:36</div></div>
|
|
<div class="ttc" id="class_o_n__w_string_html"><div class="ttname"><a href="../../d1/d11/class_o_n__w_string.html">ON_wString</a></div><div class="ttdef"><b>Definition:</b> opennurbs_string.h:2020</div></div>
|
|
<div class="ttc" id="class_o_n___string_html"><div class="ttname"><a href="../../d2/d3b/class_o_n___string.html">ON_String</a></div><div class="ttdef"><b>Definition:</b> opennurbs_string.h:852</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.13-->
|
|
<!-- start footer part -->
|
|
</div> <!-- page-content -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Feb 3 2018 11:08:26 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
|
|
<!-- <img class="footer" src="../../doxygen.png" alt="doxygen"/> -->
|
|
Doxygen
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</div> <!-- container -->
|
|
<!-- doxy-boot -->
|
|
<script type="text/javascript" src="../../doxy-boot.js"></script>
|
|
</body>
|
|
</html>
|