ZealOS/docs/System/Utils/DocUtils.CC.html
TomAwezome d0cafb0198 Allow OS Upgrade feature on VMs.
Update and fix more documentation.
Alter Splash messages and logo color.
2021-07-05 15:23:13 -04:00

183 lines
18 KiB
HTML
Executable file

<!DOCTYPE HTML>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=US-ASCII">
<meta name="generator" content="ZealOS V0.06">
<style type="text/css">
body {background-color:#000000;}
.cF0{color:#ffffff;background-color:#000000;}
.cF1{color:#3465a4;background-color:#000000;}
.cF2{color:#4e9a06;background-color:#000000;}
.cF3{color:#06989a;background-color:#000000;}
.cF4{color:#a24444;background-color:#000000;}
.cF5{color:#75507b;background-color:#000000;}
.cF6{color:#ce982f;background-color:#000000;}
.cF7{color:#bcc0b9;background-color:#000000;}
.cF8{color:#555753;background-color:#000000;}
.cF9{color:#729fcf;background-color:#000000;}
.cFA{color:#82bc49;background-color:#000000;}
.cFB{color:#34e2e2;background-color:#000000;}
.cFC{color:#ac3535;background-color:#000000;}
.cFD{color:#ad7fa8;background-color:#000000;}
.cFE{color:#fce94f;background-color:#000000;}
.cFF{color:#000000;background-color:#000000;}
</style>
</head>
<body>
<pre style="font-family:monospace;font-size:12pt">
<a name="l1"></a><span class=cF0>#</span><span class=cF1>help_index</span><span class=cF0> </span><span class=cF6>&quot;DolDoc/Cmd Line (Typically)&quot;</span><span class=cF0>
<a name="l2"></a>
<a name="l3"></a></span><span class=cF1>U0</span><span class=cF0> </span><span class=cF5>CursorRemFile</span><span class=cF0>(</span><span class=cF1>U8</span><span class=cF0> *filename)
<a name="l4"></a>{</span><span class=cF2>//Remove ASCII 5 cursor from one file.</span><span class=cF0>
<a name="l5"></a> </span><span class=cF9>CDoc</span><span class=cF0> *doc = </span><span class=cF5>DocRead</span><span class=cF0>(filename, </span><span class=cF3>DOCF_PLAIN_TEXT</span><span class=cF0> | </span><span class=cF3>DOCF_NO_CURSOR</span><span class=cF0>);
<a name="l6"></a>
<a name="l7"></a> </span><span class=cF5>DocWrite</span><span class=cF0>(doc);
<a name="l8"></a> </span><span class=cF5>DocDel</span><span class=cF0>(doc);
<a name="l9"></a>}
<a name="l10"></a></span><span class=cF1>public</span><span class=cF0> </span><span class=cF1>U0</span><span class=cF0> </span><span class=cF5>CursorRemove</span><span class=cF0>(</span><span class=cF1>U8</span><span class=cF0> *files_find_mask=</span><span class=cF6>&quot;*&quot;</span><span class=cF0>)
<a name="l11"></a>{</span><span class=cF2>//Remove ASCII 5 cursor.</span><span class=cF0>
<a name="l12"></a> </span><span class=cF9>I64</span><span class=cF0> fuf_flags = </span><span class=cFE>0</span><span class=cF0>;
<a name="l13"></a>
<a name="l14"></a> </span><span class=cF5>FlagsScan</span><span class=cF0>(&amp;fuf_flags, </span><span class=cF5>Define</span><span class=cF7>(</span><span class=cF6>&quot;ST_FILE_UTIL_FLAGS&quot;</span><span class=cF7>)</span><span class=cF0>, </span><span class=cF6>&quot;+r+T+f+F+O&quot;</span><span class=cF0>);
<a name="l15"></a>
<a name="l16"></a> </span><span class=cF9>CDirEntry</span><span class=cF0> *tmpde = </span><span class=cF5>FilesFind</span><span class=cF0>(files_find_mask, fuf_flags), *tmpde1 = tmpde;
<a name="l17"></a>
<a name="l18"></a> </span><span class=cF1>while</span><span class=cF0> (tmpde)
<a name="l19"></a> </span><span class=cF7>{</span><span class=cF0>
<a name="l20"></a> </span><span class=cF5>CursorRemFile</span><span class=cF0>(tmpde-&gt;full_name);
<a name="l21"></a> </span><span class=cF5>Touch</span><span class=cF0>(tmpde-&gt;full_name, </span><span class=cF6>&quot;&quot;</span><span class=cF0>,, tmpde-&gt;datetime);
<a name="l22"></a> tmpde = tmpde-&gt;next;
<a name="l23"></a> </span><span class=cF7>}</span><span class=cF0>
<a name="l24"></a> </span><span class=cF5>DirTreeDel</span><span class=cF0>(tmpde1);
<a name="l25"></a>}
<a name="l26"></a>
<a name="l27"></a></span><span class=cF1>U0</span><span class=cF0> </span><span class=cF5>CollapseFile</span><span class=cF0>(</span><span class=cF1>U8</span><span class=cF0> *filename, </span><span class=cF1>Bool</span><span class=cF0> collapse=</span><span class=cF3>TRUE</span><span class=cF0>)
<a name="l28"></a>{</span><span class=cF2>//Collapse </span><a href="https://tomawezome.github.io/ZealOS/Doc/DolDocOverview.DD.html#l1"><span class=cF4>DolDoc</span></a><span class=cF2> trees in one file.</span><span class=cF0>
<a name="l29"></a> </span><span class=cF9>CDoc</span><span class=cF0> *doc = </span><span class=cF5>DocRead</span><span class=cF0>(filename, </span><span class=cF3>DOCF_NO_CURSOR</span><span class=cF0>);
<a name="l30"></a>
<a name="l31"></a> </span><span class=cF5>DocCollapse</span><span class=cF0>(collapse, doc);
<a name="l32"></a> </span><span class=cF5>DocWrite</span><span class=cF0>(doc);
<a name="l33"></a> </span><span class=cF5>DocDel</span><span class=cF0>(doc);
<a name="l34"></a>}
<a name="l35"></a></span><span class=cF1>public</span><span class=cF0> </span><span class=cF1>U0</span><span class=cF0> </span><span class=cF5>Collapse</span><span class=cF0>(</span><span class=cF1>U8</span><span class=cF0> *files_find_mask=</span><span class=cF6>&quot;*&quot;</span><span class=cF0>, </span><span class=cF1>Bool</span><span class=cF0> collapse=</span><span class=cF3>TRUE</span><span class=cF0>, </span><span class=cF1>U8</span><span class=cF0> *fu_flags=</span><span class=cF3>NULL</span><span class=cF0>)
<a name="l36"></a>{</span><span class=cF2>//Collapse </span><a href="https://tomawezome.github.io/ZealOS/Doc/DolDocOverview.DD.html#l1"><span class=cF4>DolDoc</span></a><span class=cF2> trees.</span><span class=cF0>
<a name="l37"></a> </span><span class=cF9>I64</span><span class=cF0> fuf_flags = </span><span class=cFE>0</span><span class=cF0>;
<a name="l38"></a>
<a name="l39"></a> </span><span class=cF5>FlagsScan</span><span class=cF0>(&amp;fuf_flags, </span><span class=cF5>Define</span><span class=cF7>(</span><span class=cF6>&quot;ST_FILE_UTIL_FLAGS&quot;</span><span class=cF7>)</span><span class=cF0>, </span><span class=cF6>&quot;+r+f+F+$+O&quot;</span><span class=cF0>);
<a name="l40"></a> </span><span class=cF5>FlagsScan</span><span class=cF0>(&amp;fuf_flags, </span><span class=cF5>Define</span><span class=cF7>(</span><span class=cF6>&quot;ST_FILE_UTIL_FLAGS&quot;</span><span class=cF7>)</span><span class=cF0>, fu_flags);
<a name="l41"></a>
<a name="l42"></a> </span><span class=cF9>CDirEntry</span><span class=cF0> *tmpde = </span><span class=cF5>FilesFind</span><span class=cF0>(files_find_mask, fuf_flags), *tmpde1 = tmpde;
<a name="l43"></a>
<a name="l44"></a> </span><span class=cF1>while</span><span class=cF0> (tmpde &amp;&amp; !</span><span class=cF5>Bt</span><span class=cF7>(</span><span class=cF0>&amp;fuf_flags, </span><span class=cF3>FUf_CANCEL</span><span class=cF7>)</span><span class=cF0>)
<a name="l45"></a> </span><span class=cF7>{</span><span class=cF0>
<a name="l46"></a> </span><span class=cF5>CollapseFile</span><span class=cF0>(tmpde-&gt;full_name, collapse);
<a name="l47"></a> </span><span class=cF5>Touch</span><span class=cF0>(tmpde-&gt;full_name, </span><span class=cF6>&quot;&quot;</span><span class=cF0>,, tmpde-&gt;datetime);
<a name="l48"></a> tmpde = tmpde-&gt;next;
<a name="l49"></a> </span><span class=cF7>}</span><span class=cF0>
<a name="l50"></a> </span><span class=cF5>DirTreeDel</span><span class=cF0>(tmpde1);
<a name="l51"></a>}
<a name="l52"></a>
<a name="l53"></a></span><span class=cF9>I64</span><span class=cF0> </span><span class=cF5>DocOptEntry</span><span class=cF0>(</span><span class=cF9>CDoc</span><span class=cF0> *,</span><span class=cF9>CDocEntry</span><span class=cF0> *doc_e)
<a name="l54"></a>{
<a name="l55"></a> </span><span class=cF1>U8</span><span class=cF0> **_dst;
<a name="l56"></a> </span><span class=cF9>I64</span><span class=cF0> res = </span><span class=cFE>0</span><span class=cF0>;
<a name="l57"></a>
<a name="l58"></a> </span><span class=cF1>if</span><span class=cF0> (doc_e-&gt;de_flags &amp; </span><span class=cF3>DOCEF_LINK</span><span class=cF0> &amp;&amp; doc_e-&gt;de_flags &amp; </span><span class=cF7>(</span><span class=cF3>DOCEF_AUX_STR</span><span class=cF0> | </span><span class=cF3>DOCEF_TAG</span><span class=cF7>)</span><span class=cF0>)
<a name="l59"></a> </span><span class=cF7>{</span><span class=cF0>
<a name="l60"></a> </span><span class=cF1>if</span><span class=cF0> (doc_e-&gt;de_flags &amp; </span><span class=cF3>DOCEF_AUX_STR</span><span class=cF0> &amp;&amp; doc_e-&gt;de_flags &amp; </span><span class=cF3>DOCEF_TAG</span><span class=cF0> &amp;&amp;
<a name="l61"></a> !</span><span class=cF5>MemCompare</span><span class=cF7>(</span><span class=cF0>doc_e-&gt;aux_str, </span><span class=cF6>&quot;FI:&quot;</span><span class=cF0>, </span><span class=cFE>3</span><span class=cF7>)</span><span class=cF0> &amp;&amp;
<a name="l62"></a> !</span><span class=cF5>StrCompare</span><span class=cF7>(</span><span class=cF0>doc_e-&gt;aux_str + </span><span class=cFE>3</span><span class=cF0>, doc_e-&gt;tag</span><span class=cF7>)</span><span class=cF0>)
<a name="l63"></a> {
<a name="l64"></a> </span><span class=cF5>Free</span><span class=cF0>(doc_e-&gt;aux_str);
<a name="l65"></a> doc_e-&gt;aux_str = </span><span class=cF3>NULL</span><span class=cF0>;
<a name="l66"></a> doc_e-&gt;de_flags &amp;= ~</span><span class=cF3>DOCEF_AUX_STR</span><span class=cF0>;
<a name="l67"></a> res++;
<a name="l68"></a> }
<a name="l69"></a> </span><span class=cF1>if</span><span class=cF0> (doc_e-&gt;de_flags &amp; </span><span class=cF3>DOCEF_AUX_STR</span><span class=cF0>)
<a name="l70"></a> _dst = &amp;doc_e-&gt;aux_str;
<a name="l71"></a> </span><span class=cF1>else</span><span class=cF0>
<a name="l72"></a> _dst = &amp;doc_e-&gt;tag;
<a name="l73"></a> </span><span class=cF7>}</span><span class=cF0>
<a name="l74"></a>
<a name="l75"></a> </span><span class=cF1>return</span><span class=cF0> res;
<a name="l76"></a>}
<a name="l77"></a></span><span class=cF9>I64</span><span class=cF0> </span><span class=cF5>DocOptDoc</span><span class=cF0>(</span><span class=cF9>CDoc</span><span class=cF0> *doc)
<a name="l78"></a>{</span><span class=cF2>//Optimize Doc.</span><span class=cF0>
<a name="l79"></a> </span><span class=cF1>Bool</span><span class=cF0> unlock = </span><span class=cF5>DocLock</span><span class=cF0>(doc);
<a name="l80"></a> </span><span class=cF9>I64</span><span class=cF0> res = </span><span class=cFE>0</span><span class=cF0>;
<a name="l81"></a> </span><span class=cF9>CDocEntry</span><span class=cF0> *doc_e, *doc_e1, *doc_e_last;
<a name="l82"></a>
<a name="l83"></a> </span><span class=cF5>DocRecalc</span><span class=cF0>(doc);
<a name="l84"></a> doc_e_last = </span><span class=cF3>NULL</span><span class=cF0>;
<a name="l85"></a> doc_e = doc-&gt;head.next;
<a name="l86"></a> </span><span class=cF1>while</span><span class=cF0> (doc_e != doc)
<a name="l87"></a> </span><span class=cF7>{</span><span class=cF0>
<a name="l88"></a> doc_e1 = doc_e-&gt;next;
<a name="l89"></a> </span><span class=cF1>if</span><span class=cF0> (res += </span><span class=cF5>DocOptEntry</span><span class=cF7>(</span><span class=cF0>doc, doc_e</span><span class=cF7>)</span><span class=cF0>)
<a name="l90"></a> res += </span><span class=cF5>DocOptEntry</span><span class=cF0>(doc, doc_e);
<a name="l91"></a> </span><span class=cF1>if</span><span class=cF0> (doc_e_last &amp;&amp; doc_e_last-&gt;type &amp; ~</span><span class=cFE>0xFF00</span><span class=cF0> == doc_e-&gt;type &amp; ~</span><span class=cFE>0xFF00</span><span class=cF0> &amp;&amp; doc_e_last-&gt;de_flags == doc_e-&gt;de_flags &amp;&amp;
<a name="l92"></a> </span><span class=cF5>Bt</span><span class=cF7>(</span><span class=cFB>doldoc</span><span class=cF0>.type_flags_chk_dup, doc_e-&gt;type_u8</span><span class=cF7>)</span><span class=cF0> &amp;&amp; doc_e_last-&gt;attr == doc_e-&gt;attr)
<a name="l93"></a> {
<a name="l94"></a> </span><span class=cF5>DocEntryDel</span><span class=cF0>(doc, doc_e);
<a name="l95"></a> res++;
<a name="l96"></a> }
<a name="l97"></a> </span><span class=cF1>else</span><span class=cF0>
<a name="l98"></a> doc_e_last = doc_e;
<a name="l99"></a> doc_e = doc_e1;
<a name="l100"></a> </span><span class=cF7>}</span><span class=cF0>
<a name="l101"></a> </span><span class=cF5>DocRecalc</span><span class=cF0>(doc);
<a name="l102"></a> </span><span class=cF1>if</span><span class=cF0> (unlock)
<a name="l103"></a> </span><span class=cF5>DocUnlock</span><span class=cF0>(doc);
<a name="l104"></a>
<a name="l105"></a> </span><span class=cF1>return</span><span class=cF0> res;
<a name="l106"></a>}
<a name="l107"></a></span><span class=cF9>I64</span><span class=cF0> </span><span class=cF5>DocOptFile</span><span class=cF0>(</span><span class=cF1>U8</span><span class=cF0> *filename)
<a name="l108"></a>{</span><span class=cF2>//Optimize file.</span><span class=cF0>
<a name="l109"></a> </span><span class=cF9>I64</span><span class=cF0> res;
<a name="l110"></a> </span><span class=cF9>CDoc</span><span class=cF0> *doc = </span><span class=cF5>DocRead</span><span class=cF0>(filename);
<a name="l111"></a>
<a name="l112"></a> </span><span class=cF1>if</span><span class=cF0> (res = </span><span class=cF5>DocOptDoc</span><span class=cF7>(</span><span class=cF0>doc</span><span class=cF7>)</span><span class=cF0>)
<a name="l113"></a> </span><span class=cF7>{</span><span class=cF0>
<a name="l114"></a> </span><span class=cF6>&quot;-%d:%s\n&quot;</span><span class=cF0>, res, doc-&gt;filename.name;
<a name="l115"></a> </span><span class=cF5>DocWrite</span><span class=cF0>(doc);
<a name="l116"></a> </span><span class=cF7>}</span><span class=cF0>
<a name="l117"></a> </span><span class=cF5>DocDel</span><span class=cF0>(doc);
<a name="l118"></a>
<a name="l119"></a> </span><span class=cF1>return</span><span class=cF0> res;
<a name="l120"></a>}
<a name="l121"></a></span><span class=cF9>I64</span><span class=cF0> </span><span class=cF5>DocOptList</span><span class=cF0>(</span><span class=cF9>CDirEntry</span><span class=cF0> *tmpde)
<a name="l122"></a>{
<a name="l123"></a> </span><span class=cF9>I64</span><span class=cF0> res = </span><span class=cFE>0</span><span class=cF0>;
<a name="l124"></a> </span><span class=cF9>CDirEntry</span><span class=cF0> *tmpde1;
<a name="l125"></a>
<a name="l126"></a> </span><span class=cF1>while</span><span class=cF0> (tmpde)
<a name="l127"></a> </span><span class=cF7>{</span><span class=cF0>
<a name="l128"></a> tmpde1 = tmpde-&gt;next;
<a name="l129"></a> </span><span class=cF1>if</span><span class=cF0> (tmpde-&gt;attr &amp; </span><span class=cF3>RS_ATTR_DIR</span><span class=cF0>)
<a name="l130"></a> {
<a name="l131"></a> </span><span class=cF1>if</span><span class=cF0> (tmpde-&gt;sub)
<a name="l132"></a> </span><span class=cF7>{</span><span class=cF0>
<a name="l133"></a> </span><span class=cF6>&quot;Scanning Directory: %s\n&quot;</span><span class=cF0>, tmpde-&gt;full_name;
<a name="l134"></a> res += </span><span class=cF5>DocOptList</span><span class=cF0>(tmpde-&gt;sub);
<a name="l135"></a> </span><span class=cF7>}</span><span class=cF0>
<a name="l136"></a> }
<a name="l137"></a> </span><span class=cF1>else</span><span class=cF0>
<a name="l138"></a> res += </span><span class=cF5>DocOptFile</span><span class=cF0>(tmpde-&gt;full_name);
<a name="l139"></a> </span><span class=cF5>DirEntryDel</span><span class=cF0>(tmpde);
<a name="l140"></a> tmpde = tmpde1;
<a name="l141"></a> </span><span class=cF7>}</span><span class=cF0>
<a name="l142"></a>
<a name="l143"></a> </span><span class=cF1>return</span><span class=cF0> res;
<a name="l144"></a>}
<a name="l145"></a></span><span class=cF1>public</span><span class=cF0> </span><span class=cF9>I64</span><span class=cF0> </span><span class=cF5>DocOpt</span><span class=cF0>(</span><span class=cF1>U8</span><span class=cF0> *files_find_mask=</span><span class=cF6>&quot;*&quot;</span><span class=cF0>, </span><span class=cF1>U8</span><span class=cF0> *fu_flags=</span><span class=cF3>NULL</span><span class=cF0>)
<a name="l146"></a>{</span><span class=cF2>//Optimize </span><a href="https://tomawezome.github.io/ZealOS/Doc/DolDocOverview.DD.html#l1"><span class=cF4>DolDoc</span></a><span class=cF2> files, eliminating aux_str's and .Z's.</span><span class=cF0>
<a name="l147"></a></span><span class=cF2>//+R flag for aggressively risky.</span><span class=cF0>
<a name="l148"></a> </span><span class=cF9>I64</span><span class=cF0> fuf_flags = </span><span class=cFE>0</span><span class=cF0>;
<a name="l149"></a>
<a name="l150"></a> </span><span class=cF5>FlagsScan</span><span class=cF0>(&amp;fuf_flags, </span><span class=cF5>Define</span><span class=cF7>(</span><span class=cF6>&quot;ST_FILE_UTIL_FLAGS&quot;</span><span class=cF7>)</span><span class=cF0>, </span><span class=cF6>&quot;+r+$&quot;</span><span class=cF0>);
<a name="l151"></a> </span><span class=cF5>FlagsScan</span><span class=cF0>(&amp;fuf_flags, </span><span class=cF5>Define</span><span class=cF7>(</span><span class=cF6>&quot;ST_FILE_UTIL_FLAGS&quot;</span><span class=cF7>)</span><span class=cF0>, fu_flags);
<a name="l152"></a>
<a name="l153"></a> </span><span class=cF1>return</span><span class=cF0> </span><span class=cF5>DocOptList</span><span class=cF0>(</span><span class=cF5>FilesFind</span><span class=cF7>(</span><span class=cF0>files_find_mask, fuf_flags &amp; </span><span class=cF3>FUG_FILES_FIND</span><span class=cF7>)</span><span class=cF0>);
<a name="l154"></a>}
</span></pre></body>
</html>