2017-11-09 02:08:41 +00:00
|
|
|
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8"/>
|
2017-11-17 22:01:08 +00:00
|
|
|
<title>pluie-echo-0.2 – Vala Binding Reference</title>
|
2017-11-09 02:08:41 +00:00
|
|
|
<link href="../style.css" rel="stylesheet" type="text/css"/><script src="../scripts.js" type="text/javascript">
|
|
|
|
|
</script>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
2017-11-17 22:01:08 +00:00
|
|
|
<div class="site_header">pluie-echo-0.2 Reference Manual</div>
|
2017-11-09 02:08:41 +00:00
|
|
|
<div class="site_body">
|
|
|
|
|
<div class="site_navigation">
|
|
|
|
|
<ul class="navi_main">
|
|
|
|
|
<li class="package_index"><a href="../index.html">Packages</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<hr class="navi_hr"/>
|
|
|
|
|
<ul class="navi_main">
|
2017-11-17 22:01:08 +00:00
|
|
|
<li class="package">pluie-echo-0.2</li>
|
2017-11-09 02:08:41 +00:00
|
|
|
</ul>
|
|
|
|
|
<hr class="navi_hr"/>
|
|
|
|
|
<ul class="navi_main">
|
|
|
|
|
<li class="namespace"><a href="Pluie.html">Pluie</a></li>
|
|
|
|
|
<li class="namespace"><a href="Pluie.Dbg.html">Pluie.Dbg</a></li>
|
|
|
|
|
<li class="namespace"><a href="Pluie.Echo.html">Pluie.Echo</a></li>
|
|
|
|
|
<li class="namespace"><a href="Pluie.Sys.html">Pluie.Sys</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="site_content">
|
2017-11-17 22:01:08 +00:00
|
|
|
<h1 class="main_title" id="pluie-echo-0.2">pluie-echo-0.2</h1>
|
2017-11-09 02:08:41 +00:00
|
|
|
<hr class="main_hr"/>
|
|
|
|
|
<h2 class="main_title">Description:</h2>
|
|
|
|
|
<h2 class="main_title">Content:</h2>
|
|
|
|
|
<h3 class="main_title">Namespaces:</h3>
|
|
|
|
|
<ul class="navi_inline">
|
2017-11-17 22:01:08 +00:00
|
|
|
<li class="namespace"><a href="Pluie.html">Pluie</a> - <span class="brief_description">root namespace of various pluie library</span></li>
|
2017-11-09 02:08:41 +00:00
|
|
|
<h3 class="main_title">Classes:</h3>
|
|
|
|
|
<ul class="navi_inline">
|
|
|
|
|
<li class="class"><a href="Pluie.ColorConf.html">ColorConf</a> - <span class="brief_description">a Class representing a set of
|
|
|
|
|
<a href="Pluie.Color.html" class="class">Color</a> mapping <a href="Pluie.ECHO.html" class="enum">ECHO</a> colors with values coming
|
|
|
|
|
from the specifyed ini config file</span></li>
|
|
|
|
|
<li class="class"><a href="Pluie.Color.html">Color</a> - <span class="brief_description">a Class representing an Ansi Extended 8 bit Color
|
|
|
|
|
with foreground, background and bold attributes</span></li>
|
|
|
|
|
<li class="class"><a href="Pluie.OutputFormatter.html">OutputFormatter</a> - <span class="brief_description">A class managing display on
|
|
|
|
|
stdout & stderror with <a href="Pluie.Color.html" class="class">Color</a> styles defined by specifiyed
|
|
|
|
|
<a href="Pluie.ColorConf.html" class="class">ColorConf</a></span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h3 class="main_title">Enums:</h3>
|
|
|
|
|
<ul class="navi_inline">
|
|
|
|
|
<li class="enum"><a href="Pluie.ECHO.html">ECHO</a> - <span class="brief_description">enumerate predefined
|
|
|
|
|
<a href="Pluie.Color.html" class="class">Color</a> mapped to default config file see resources/echo.ini</span></li>
|
|
|
|
|
</ul>
|
2017-11-17 22:01:08 +00:00
|
|
|
<h3 class="main_title">Fields:</h3>
|
|
|
|
|
<ul class="navi_inline">
|
|
|
|
|
<li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Pluie.OutputFormatter.html" class="class">OutputFormatter</a></span> <b><a href="Pluie.of.html" class="field">of</a></b>
|
|
|
|
|
</span>
|
|
|
|
|
<div class="leaf_brief_description"><span class="brief_description">default OutputFormatter</span>
|
|
|
|
|
</div></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<li class="namespace"><a href="Pluie.Dbg.html">Dbg</a> - <span class="brief_description">Dbg namespace with convenient static methods used
|
|
|
|
|
to display traces</span></li>
|
2017-11-09 02:08:41 +00:00
|
|
|
<h3 class="main_title">Constants:</h3>
|
|
|
|
|
<ul class="navi_inline">
|
|
|
|
|
<li class="constant"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">const</span> <span class="main_basic_type"><span class="struct">int8</span></span> <b><a href="Pluie.Dbg.DBG_ERROR.html" class="constant">DBG_ERROR</a></b>
|
|
|
|
|
</span>
|
|
|
|
|
<div class="leaf_brief_description"><span class="brief_description">type log error</span>
|
|
|
|
|
</div></li>
|
|
|
|
|
<li class="constant"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">const</span> <span class="main_basic_type"><span class="struct">int8</span></span> <b><a href="Pluie.Dbg.DBG_WARN.html" class="constant">DBG_WARN</a></b>
|
|
|
|
|
</span>
|
|
|
|
|
<div class="leaf_brief_description"><span class="brief_description">type log warn</span>
|
|
|
|
|
</div></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h3 class="main_title">Methods:</h3>
|
|
|
|
|
<ul class="navi_inline">
|
2017-11-17 22:01:08 +00:00
|
|
|
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">void</span> <b><a href="Pluie.Dbg.init.html" class="method">init</a></b> (<span class="main_basic_type"><span class="struct">bool</span></span> debug = <span class="main_literal">false</span>)
|
2017-11-09 02:08:41 +00:00
|
|
|
</span>
|
|
|
|
|
<div class="leaf_brief_description"><span class="brief_description">initialize logging</span>
|
|
|
|
|
</div></li>
|
2017-11-17 22:01:08 +00:00
|
|
|
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">void</span> <b><a href="Pluie.Dbg.@in.html" class="method">@in</a></b> (<span class="main_basic_type"><span class="class">string</span></span> method, <span class="main_basic_type"><span class="class">string</span></span>? parameters = <span class="main_literal">null</span>, <span class="main_basic_type"><span class="struct">int</span></span> line = <span class="main_literal">0</span>, <span class="main_basic_type"><span class="class">string</span></span>? file = <span class="main_literal">null</span>)
|
2017-11-09 02:08:41 +00:00
|
|
|
</span>
|
|
|
|
|
<div class="leaf_brief_description"><span class="brief_description">log method entering</span>
|
|
|
|
|
</div></li>
|
2017-11-17 22:01:08 +00:00
|
|
|
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">void</span> <b><a href="Pluie.Dbg.@out.html" class="method">@out</a></b> (<span class="main_basic_type"><span class="class">string</span></span> method, <span class="main_basic_type"><span class="class">string</span></span>? parameters = <span class="main_literal">null</span>, <span class="main_basic_type"><span class="struct">int</span></span> line = <span class="main_literal">0</span>, <span class="main_basic_type"><span class="class">string</span></span>? file = <span class="main_literal">null</span>)
|
2017-11-09 02:08:41 +00:00
|
|
|
</span>
|
|
|
|
|
<div class="leaf_brief_description"><span class="brief_description">log method leaving</span>
|
|
|
|
|
</div></li>
|
|
|
|
|
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">void</span> <b><a href="Pluie.Dbg.msg.html" class="method">msg</a></b> (<span class="main_basic_type"><span class="class">string</span></span> msg, <span class="main_basic_type"><span class="struct">int</span></span> line = <span class="main_literal">0</span>, <span class="main_basic_type"><span class="class">string</span></span>? file = <span class="main_literal">null</span>)
|
|
|
|
|
</span>
|
|
|
|
|
<div class="leaf_brief_description"><span class="brief_description">log a message</span>
|
|
|
|
|
</div></li>
|
|
|
|
|
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">void</span> <b><a href="Pluie.Dbg.error.html" class="method">error</a></b> (<span class="main_basic_type"><span class="class">string</span></span> msg, <span class="main_basic_type"><span class="class">string</span></span> method, <span class="main_basic_type"><span class="struct">int</span></span> line = <span class="main_literal">0</span>, <span class="main_basic_type"><span class="class">string</span></span>? file = <span class="main_literal">null</span>, <span class="main_basic_type"><span class="struct">int8</span></span> mode = <b><a href="Pluie.Dbg.DBG_ERROR.html" class="constant">DBG_ERROR</a></b>)
|
|
|
|
|
</span>
|
|
|
|
|
<div class="leaf_brief_description"><span class="brief_description">log error</span>
|
|
|
|
|
</div></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h3 class="main_title">Fields:</h3>
|
|
|
|
|
<ul class="navi_inline">
|
|
|
|
|
<li class="field"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="struct">bool</span></span> <b><a href="Pluie.Dbg.DBG_ENABLED.html" class="field">DBG_ENABLED</a></b>
|
|
|
|
|
</span>
|
|
|
|
|
<div class="leaf_brief_description"><span class="brief_description">enable/disable log messages</span>
|
|
|
|
|
</div></li>
|
|
|
|
|
</ul>
|
2017-11-17 22:01:08 +00:00
|
|
|
<li class="namespace"><a href="Pluie.Echo.html">Echo</a> - <span class="brief_description">Echo namespace</span></li>
|
2017-11-09 02:08:41 +00:00
|
|
|
<h3 class="main_title">Constants:</h3>
|
|
|
|
|
<ul class="navi_inline">
|
|
|
|
|
<li class="constant"><span class="leaf_code_definition"><span class="main_keyword">protected</span> <span class="main_keyword">const</span> <span class="main_keyword">unowned</span> <span class="main_basic_type"><span class="class">string</span></span> <b><a href="Pluie.Echo.INSTALL_PATH.html" class="constant">INSTALL_PATH</a></b>
|
|
|
|
|
</span>
|
|
|
|
|
<div class="leaf_brief_description">
|
|
|
|
|
</div></li>
|
|
|
|
|
<li class="constant"><span class="leaf_code_definition"><span class="main_keyword">protected</span> <span class="main_keyword">const</span> <span class="main_keyword">unowned</span> <span class="main_basic_type"><span class="class">string</span></span> <b><a href="Pluie.Echo.DATA_PATH.html" class="constant">DATA_PATH</a></b>
|
|
|
|
|
</span>
|
|
|
|
|
<div class="leaf_brief_description">
|
|
|
|
|
</div></li>
|
|
|
|
|
<li class="constant"><span class="leaf_code_definition"><span class="main_keyword">protected</span> <span class="main_keyword">const</span> <span class="main_keyword">unowned</span> <span class="main_basic_type"><span class="class">string</span></span> <b><a href="Pluie.Echo.VERSION.html" class="constant">VERSION</a></b>
|
|
|
|
|
</span>
|
|
|
|
|
<div class="leaf_brief_description">
|
|
|
|
|
</div></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h3 class="main_title">Methods:</h3>
|
|
|
|
|
<ul class="navi_inline">
|
|
|
|
|
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Pluie.OutputFormatter.html" class="class">OutputFormatter</a></span> <b><a href="Pluie.Echo.init.html" class="method">init</a></b> (<span class="main_basic_type"><span class="struct">bool</span></span> debug, <span class="main_basic_type"><span class="class">string</span></span>? path = <span class="main_literal">null</span>)
|
|
|
|
|
</span>
|
2017-11-17 22:01:08 +00:00
|
|
|
<div class="leaf_brief_description"><span class="brief_description">initialize lib pluie-echo</span>
|
2017-11-09 02:08:41 +00:00
|
|
|
</div></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<li class="namespace"><a href="Pluie.Sys.html">Sys</a></li>
|
|
|
|
|
<h3 class="main_title">Classes:</h3>
|
|
|
|
|
<ul class="navi_inline">
|
2017-11-17 22:01:08 +00:00
|
|
|
<li class="class"><a href="Pluie.Sys.Cmd.html">Cmd</a> - <span class="brief_description">A class spawning synchronous command line</span>
|
|
|
|
|
</li>
|
2017-11-09 02:08:41 +00:00
|
|
|
</ul>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</div><br/>
|
|
|
|
|
<div class="site_footer">Generated by <a href="http://www.valadoc.org/">Valadoc</a>
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
