ACC SHELL
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
<head>
<title>Unknown YCP Module</title>
<style type="text/css">body { background-color: #c8c8c8 }
h1 { color: #e00000 }
table { width: 100%/ border: none }
img { border: 0px }
.sigbox { background-color: #ffc080; border: solid thin #f96500 }
.sig { font: larger monospace }
.padtbl { background-color: #ffc080; padding: 10px; margin: 10px }
/* arrow */
.a { color: #606060 }
/* type, parameter */
.t, .p { color: #c05000 }
.pbox { width: 20% }
.descbox { }
.right { align: right }
.header {}
.footer { clear: both}
.menu { width: 10%; float: left }
.main { width: 90%; float: left }
</style>
</head>
<body>
<div class="header">
<i>YaST2 Developers Documentation:</i>
<a href="index.html">
<b>Unknown YCP Module</b>
</a>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
<hr />
</div>
<div class="menu">
<img alt="YaST" src="/usr/share/doc/packages/yast2-devtools/images/yast2-half.png" />
<br />
<br />
<a href="index.html">functions</a>
<br />
<a href="files.html">files</a>
<br />
<a href="intro.html">intro</a>
</div>
<div class="main">
<div class="sigbox">
<table class="padtbl">
<tr>
<td>
<h1>Unknown YCP Module</h1>
</td>
<td class="filecell">routines.ycp
</td>
</tr>
<tr>
<td></td>
</tr>
<tr>
<td>
<ul>
<li>Ladislav Slezak <lslezak@suse.cz></li>
</ul>
</td>
</tr>
<tr>
<td>
<p>This module has an unstable interface.</p>
</td>
</tr>
</table>
<table class="padtbl">
<tr>
<td>
Functions used in hwinfo and in init_hwinfo modules.
<h1>Imports</h1>
<ul>
<li>Report</li>
</ul>
<h1>Includes</h1>
<ul>
<li>hwinfo/classnames.ycp</li>
</ul>
<h1>Local Variables</h1>
<ul>
<li>
<a href="#representant_order">representant_order</a>
</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#classtostring">classtostring (any a, map<string,any> m)</a>
</li>
<li>
<a href="#expandTree">expandTree (any node)</a>
</li>
<li>
<a href="#get_representant">get_representant (map<string,any> m)</a>
</li>
<li>
<a href="#icon">icon (string str)</a>
</li>
<li>
<a href="#mount_device">mount_device (string device)</a>
</li>
<li>
<a href="#resolution">resolution (any a, map m)</a>
</li>
<li>
<a href="#save_hwinfo">save_hwinfo (string file)</a>
</li>
<li>
<a href="#save_hwinfo_to_file">save_hwinfo_to_file (string target_file_name)</a>
</li>
<li>
<a href="#scalar">scalar (any node)</a>
</li>
<li>
<a href="#trans_bool">trans_bool (any b)</a>
</li>
<li>
<a href="#trans_str">trans_str (string str)</a>
</li>
<li>
<a href="#translate_hw_entry">translate_hw_entry (map<string,any> hw)</a>
</li>
<li>
<a href="#umount_device">umount_device (string mount_point)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="resolution">local
<b>resolution (any a, map m)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
reads values from map and creates formatted label for monitor resolution data</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">a</span>
</td>
<td class="descbox">dummy parameter?</td>
</tr>
<tr>
<td class="pbox">
<span class="p">m</span>
</td>
<td class="descbox">device info</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">formatted label</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="translate_hw_entry">local
<b>translate_hw_entry (map<string,any> hw)
<span class="a"> -> </span>
<span class="t">map<string,any></span>
</b>
</span>
</div>
<p>
tries to determine hardware name by class_id and sub_class_id
and substitues them in given map. returns modified map</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">hw</span>
</td>
<td class="descbox">device info</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">device info with translated class information</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="classtostring">local
<b>classtostring (any a, map<string,any> m)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Translate subclass identification of the device</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">a</span>
</td>
<td class="descbox">dummy parameter?</td>
</tr>
<tr>
<td class="pbox">
<span class="p">m</span>
</td>
<td class="descbox">device information</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">translated subclass name</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="representant_order">local
<b>representant_order
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
order table: list of lists.
first item of nested list is key name
second is term that should be used for formating the key- takes key name as first argument
if third item is true, the whole map will be passed to term as second argument</p>
<div class="sigbox">
<span class="sig" id="trans_str">local
<b>trans_str (string str)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
translate string - looks to the translation table and returns value</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">str</span>
</td>
<td class="descbox">string to translate</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">translated string or original string if translation is unknown</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="icon">local
<b>icon (string str)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
icon for path - looks to the translation table and returns value</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">str</span>
</td>
<td class="descbox">string of the path</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">icon name or nil if not found</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="trans_bool">local
<b>trans_bool (any b)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
translate boolean to Yes/No</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">b</span>
</td>
<td class="descbox">any value</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">parameter b converted to string, if b is boolean then Yes/No is returned</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="scalar">local
<b>scalar (any node)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
evals to true if given value is scalar (not map or term or list)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">node</span>
</td>
<td class="descbox">any value</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if parameter node is a scalar value (it isn't a list or a map)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_representant">local
<b>get_representant (map<string,any> m)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
if expandTree function tries to explore list, it should use some
label for each item. it tree items are maps, this function decides
which value from map will be used as label</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">m</span>
</td>
<td class="descbox">device info</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">name of the selected representant for whole map</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="expandTree">local
<b>expandTree (any node)
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
Recursively converts (scalar/nested) lists and maps to tree datastructure</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">node</span>
</td>
<td class="descbox">any value</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">list of items (content of tree widget)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="save_hwinfo">local
<b>save_hwinfo (string file)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Save hwinfo output to the specified file</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">file</span>
</td>
<td class="descbox">Target file</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">True if saving was successful</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="save_hwinfo_to_file">local
<b>save_hwinfo_to_file (string target_file_name)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Save hwinfo output to the specified file, progress popup is displayed.
Display error message when saving failed.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">target_file_name</span>
</td>
<td class="descbox">Target file</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">True if saving was successful</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="mount_device">local
<b>mount_device (string device)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Mount specified device</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">device</span>
</td>
<td class="descbox">device name to mount</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">mount point where device was mounted (in /tmp subdirectory)
or nil when mount failed</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="umount_device">local
<b>umount_device (string mount_point)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Unmount device</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">mount_point</span>
</td>
<td class="descbox">directory where device is mounted</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true on success</td>
</tr>
</table>
</dd>
</dl>
</div>
<div class="footer">
<hr />
<i>YaST2 Developers Documentation</i>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
</div>
</body>
</html>
ACC SHELL 2018