From 03ccc6094c6c2495ffd8bcaa55866d302b592717 Mon Sep 17 00:00:00 2001 From: a-Sansara Date: Thu, 9 Nov 2017 03:08:41 +0100 Subject: [PATCH] version 0.1.1 - add documentation --- doc/abstractclass.svg | 180 ++++++ doc/abstractmethod.svg | 163 +++++ doc/abstractproperty.svg | 138 +++++ doc/class.svg | 168 +++++ doc/clean.svg | 102 ++++ doc/coll_close.svg | 61 ++ doc/coll_open.svg | 61 ++ doc/constant.svg | 170 ++++++ doc/constructor.svg | 237 +++++++ doc/delegate.svg | 126 ++++ doc/devhelpstyle.css | 578 ++++++++++++++++++ doc/document.svg | 60 ++ doc/enum.svg | 304 +++++++++ doc/enumvalue.svg | 120 ++++ doc/errorcode.svg | 138 +++++ doc/errordomain.svg | 322 ++++++++++ doc/external_link.svg | 50 ++ doc/favicon.ico | Bin 0 -> 16958 bytes doc/field.svg | 170 ++++++ doc/icon.svg | 45 ++ doc/index.html | 34 ++ doc/interface.svg | 42 ++ doc/logo.svg | 35 ++ doc/method.svg | 151 +++++ doc/namespace.svg | 36 ++ doc/package.svg | 40 ++ doc/packages.svg | 83 +++ doc/pluie-echo-0.1/Pluie.Color.Color.html | 73 +++ doc/pluie-echo-0.1/Pluie.Color.bg.html | 53 ++ doc/pluie-echo-0.1/Pluie.Color.bold.html | 53 ++ doc/pluie-echo-0.1/Pluie.Color.fg.html | 53 ++ doc/pluie-echo-0.1/Pluie.Color.html | 108 ++++ doc/pluie-echo-0.1/Pluie.Color.off.html | 53 ++ doc/pluie-echo-0.1/Pluie.Color.s.html | 82 +++ doc/pluie-echo-0.1/Pluie.Color.to_string.html | 53 ++ doc/pluie-echo-0.1/Pluie.ColorConf.@get.html | 66 ++ .../Pluie.ColorConf.ColorConf.html | 58 ++ doc/pluie-echo-0.1/Pluie.ColorConf.html | 80 +++ doc/pluie-echo-0.1/Pluie.ColorConf.param.html | 66 ++ doc/pluie-echo-0.1/Pluie.Dbg.@in.html | 85 +++ doc/pluie-echo-0.1/Pluie.Dbg.@out.html | 85 +++ doc/pluie-echo-0.1/Pluie.Dbg.DBG_ENABLED.html | 58 ++ doc/pluie-echo-0.1/Pluie.Dbg.DBG_ENTER.html | 58 ++ doc/pluie-echo-0.1/Pluie.Dbg.DBG_ERROR.html | 58 ++ doc/pluie-echo-0.1/Pluie.Dbg.DBG_INLINE.html | 58 ++ doc/pluie-echo-0.1/Pluie.Dbg.DBG_LEAVE.html | 58 ++ doc/pluie-echo-0.1/Pluie.Dbg.DBG_WARN.html | 58 ++ doc/pluie-echo-0.1/Pluie.Dbg.error.html | 91 +++ doc/pluie-echo-0.1/Pluie.Dbg.html | 91 +++ doc/pluie-echo-0.1/Pluie.Dbg.init.html | 73 +++ doc/pluie-echo-0.1/Pluie.Dbg.log.html | 59 ++ doc/pluie-echo-0.1/Pluie.Dbg.msg.html | 79 +++ doc/pluie-echo-0.1/Pluie.ECHO.ACTION.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.ARG.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.ARG_SEP.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.COMMENT.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.DATE.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.DEFAULT.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.DONE.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.ENTER.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.ERROR.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.FAIL.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.FILE.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.ITEM.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.KEY.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.LEAVE.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.MICROTIME.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.NUM.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.OPTION.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.OPTION_SEP.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.SECTION.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.SEP.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.TIME.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.TITLE.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.TITLE_ITEM.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.TITLE_SEP.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.VAL.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.WARN.html | 47 ++ doc/pluie-echo-0.1/Pluie.ECHO.html | 106 ++++ doc/pluie-echo-0.1/Pluie.Echo.DATA_PATH.html | 52 ++ .../Pluie.Echo.INSTALL_PATH.html | 52 ++ doc/pluie-echo-0.1/Pluie.Echo.VERSION.html | 52 ++ doc/pluie-echo-0.1/Pluie.Echo.html | 76 +++ doc/pluie-echo-0.1/Pluie.Echo.init.html | 52 ++ doc/pluie-echo-0.1/Pluie.Echo.of.html | 52 ++ ...Pluie.OutputFormatter.OutputFormatter.html | 75 +++ .../Pluie.OutputFormatter.action.html | 82 +++ .../Pluie.OutputFormatter.c.html | 76 +++ .../Pluie.OutputFormatter.conf.html | 64 ++ .../Pluie.OutputFormatter.echo.html | 94 +++ .../Pluie.OutputFormatter.echo_up.html | 82 +++ .../Pluie.OutputFormatter.error.html | 76 +++ doc/pluie-echo-0.1/Pluie.OutputFormatter.html | 175 ++++++ .../Pluie.OutputFormatter.indent.html | 67 ++ .../Pluie.OutputFormatter.keyval.html | 82 +++ .../Pluie.OutputFormatter.move_down.html | 76 +++ .../Pluie.OutputFormatter.move_up.html | 76 +++ .../Pluie.OutputFormatter.rs.html | 88 +++ .../Pluie.OutputFormatter.s_indent.html | 76 +++ .../Pluie.OutputFormatter.state.html | 76 +++ .../Pluie.OutputFormatter.term_width.html | 67 ++ .../Pluie.OutputFormatter.test.html | 64 ++ .../Pluie.OutputFormatter.title.html | 88 +++ .../Pluie.OutputFormatter.title_sep.html | 64 ++ .../Pluie.OutputFormatter.usage_option.html | 100 +++ .../Pluie.OutputFormatter.warn.html | 76 +++ .../Pluie.OutputFormatter.wordwrap.html | 88 +++ doc/pluie-echo-0.1/Pluie.Sys.Cmd.Cmd.html | 53 ++ doc/pluie-echo-0.1/Pluie.Sys.Cmd.error.html | 53 ++ doc/pluie-echo-0.1/Pluie.Sys.Cmd.html | 98 +++ doc/pluie-echo-0.1/Pluie.Sys.Cmd.name.html | 53 ++ doc/pluie-echo-0.1/Pluie.Sys.Cmd.output.html | 53 ++ doc/pluie-echo-0.1/Pluie.Sys.Cmd.run.html | 53 ++ doc/pluie-echo-0.1/Pluie.Sys.Cmd.status.html | 53 ++ doc/pluie-echo-0.1/Pluie.Sys.html | 47 ++ doc/pluie-echo-0.1/Pluie.html | 67 ++ doc/pluie-echo-0.1/img/Pluie.Color.png | Bin 0 -> 1718 bytes doc/pluie-echo-0.1/img/Pluie.ColorConf.png | Bin 0 -> 2080 bytes .../img/Pluie.OutputFormatter.png | Bin 0 -> 2705 bytes doc/pluie-echo-0.1/img/Pluie.Sys.Cmd.png | Bin 0 -> 2485 bytes doc/pluie-echo-0.1/index.htm | 135 ++++ doc/preview.svg | 135 ++++ doc/property.svg | 126 ++++ doc/scripts.js | 56 ++ doc/signal.svg | 116 ++++ doc/staticmethod.svg | 163 +++++ doc/struct.svg | 148 +++++ doc/style.css | 2 + doc/tip.svg | 50 ++ doc/video.svg | 60 ++ doc/virtualmethod.svg | 163 +++++ doc/virtualproperty.svg | 138 +++++ doc/warning.svg | 118 ++++ doc/wikistyle.css | 547 +++++++++++++++++ install.vala.in | 2 +- resources/doc-scripts.js | 56 ++ resources/doc-style.css | 2 + resources/echo.ini | 4 +- src/Pluie.Color.vala | 51 +- src/Pluie.ColorConf.vala | 22 +- src/Pluie.Dbg.vala | 56 +- src/Pluie.OutputFormatter.vala | 176 +++++- src/Pluie.global.vala | 9 +- valadoc.sh | 5 + 144 files changed, 11631 insertions(+), 38 deletions(-) create mode 100644 doc/abstractclass.svg create mode 100644 doc/abstractmethod.svg create mode 100644 doc/abstractproperty.svg create mode 100644 doc/class.svg create mode 100644 doc/clean.svg create mode 100644 doc/coll_close.svg create mode 100644 doc/coll_open.svg create mode 100644 doc/constant.svg create mode 100644 doc/constructor.svg create mode 100644 doc/delegate.svg create mode 100644 doc/devhelpstyle.css create mode 100644 doc/document.svg create mode 100644 doc/enum.svg create mode 100644 doc/enumvalue.svg create mode 100644 doc/errorcode.svg create mode 100644 doc/errordomain.svg create mode 100644 doc/external_link.svg create mode 100644 doc/favicon.ico create mode 100644 doc/field.svg create mode 100644 doc/icon.svg create mode 100644 doc/index.html create mode 100644 doc/interface.svg create mode 100644 doc/logo.svg create mode 100644 doc/method.svg create mode 100644 doc/namespace.svg create mode 100644 doc/package.svg create mode 100644 doc/packages.svg create mode 100644 doc/pluie-echo-0.1/Pluie.Color.Color.html create mode 100644 doc/pluie-echo-0.1/Pluie.Color.bg.html create mode 100644 doc/pluie-echo-0.1/Pluie.Color.bold.html create mode 100644 doc/pluie-echo-0.1/Pluie.Color.fg.html create mode 100644 doc/pluie-echo-0.1/Pluie.Color.html create mode 100644 doc/pluie-echo-0.1/Pluie.Color.off.html create mode 100644 doc/pluie-echo-0.1/Pluie.Color.s.html create mode 100644 doc/pluie-echo-0.1/Pluie.Color.to_string.html create mode 100644 doc/pluie-echo-0.1/Pluie.ColorConf.@get.html create mode 100644 doc/pluie-echo-0.1/Pluie.ColorConf.ColorConf.html create mode 100644 doc/pluie-echo-0.1/Pluie.ColorConf.html create mode 100644 doc/pluie-echo-0.1/Pluie.ColorConf.param.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.@in.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.@out.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.DBG_ENABLED.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.DBG_ENTER.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.DBG_ERROR.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.DBG_INLINE.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.DBG_LEAVE.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.DBG_WARN.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.error.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.init.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.log.html create mode 100644 doc/pluie-echo-0.1/Pluie.Dbg.msg.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.ACTION.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.ARG.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.ARG_SEP.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.COMMENT.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.DATE.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.DEFAULT.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.DONE.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.ENTER.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.ERROR.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.FAIL.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.FILE.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.ITEM.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.KEY.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.LEAVE.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.MICROTIME.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.NUM.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.OPTION.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.OPTION_SEP.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.SECTION.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.SEP.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.TIME.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.TITLE.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.TITLE_ITEM.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.TITLE_SEP.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.VAL.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.WARN.html create mode 100644 doc/pluie-echo-0.1/Pluie.ECHO.html create mode 100644 doc/pluie-echo-0.1/Pluie.Echo.DATA_PATH.html create mode 100644 doc/pluie-echo-0.1/Pluie.Echo.INSTALL_PATH.html create mode 100644 doc/pluie-echo-0.1/Pluie.Echo.VERSION.html create mode 100644 doc/pluie-echo-0.1/Pluie.Echo.html create mode 100644 doc/pluie-echo-0.1/Pluie.Echo.init.html create mode 100644 doc/pluie-echo-0.1/Pluie.Echo.of.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.OutputFormatter.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.action.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.c.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.conf.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.echo.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.echo_up.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.error.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.indent.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.keyval.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.move_down.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.move_up.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.rs.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.s_indent.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.state.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.term_width.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.test.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.title.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.title_sep.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.usage_option.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.warn.html create mode 100644 doc/pluie-echo-0.1/Pluie.OutputFormatter.wordwrap.html create mode 100644 doc/pluie-echo-0.1/Pluie.Sys.Cmd.Cmd.html create mode 100644 doc/pluie-echo-0.1/Pluie.Sys.Cmd.error.html create mode 100644 doc/pluie-echo-0.1/Pluie.Sys.Cmd.html create mode 100644 doc/pluie-echo-0.1/Pluie.Sys.Cmd.name.html create mode 100644 doc/pluie-echo-0.1/Pluie.Sys.Cmd.output.html create mode 100644 doc/pluie-echo-0.1/Pluie.Sys.Cmd.run.html create mode 100644 doc/pluie-echo-0.1/Pluie.Sys.Cmd.status.html create mode 100644 doc/pluie-echo-0.1/Pluie.Sys.html create mode 100644 doc/pluie-echo-0.1/Pluie.html create mode 100644 doc/pluie-echo-0.1/img/Pluie.Color.png create mode 100644 doc/pluie-echo-0.1/img/Pluie.ColorConf.png create mode 100644 doc/pluie-echo-0.1/img/Pluie.OutputFormatter.png create mode 100644 doc/pluie-echo-0.1/img/Pluie.Sys.Cmd.png create mode 100644 doc/pluie-echo-0.1/index.htm create mode 100644 doc/preview.svg create mode 100644 doc/property.svg create mode 100644 doc/scripts.js create mode 100644 doc/signal.svg create mode 100644 doc/staticmethod.svg create mode 100644 doc/struct.svg create mode 100644 doc/style.css create mode 100644 doc/tip.svg create mode 100644 doc/video.svg create mode 100644 doc/virtualmethod.svg create mode 100644 doc/virtualproperty.svg create mode 100644 doc/warning.svg create mode 100644 doc/wikistyle.css create mode 100644 resources/doc-scripts.js create mode 100644 resources/doc-style.css create mode 100755 valadoc.sh diff --git a/doc/abstractclass.svg b/doc/abstractclass.svg new file mode 100644 index 0000000..1c3e080 --- /dev/null +++ b/doc/abstractclass.svg @@ -0,0 +1,180 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/abstractmethod.svg b/doc/abstractmethod.svg new file mode 100644 index 0000000..891d09f --- /dev/null +++ b/doc/abstractmethod.svg @@ -0,0 +1,163 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/abstractproperty.svg b/doc/abstractproperty.svg new file mode 100644 index 0000000..11245d8 --- /dev/null +++ b/doc/abstractproperty.svg @@ -0,0 +1,138 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/class.svg b/doc/class.svg new file mode 100644 index 0000000..c39ba13 --- /dev/null +++ b/doc/class.svg @@ -0,0 +1,168 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/clean.svg b/doc/clean.svg new file mode 100644 index 0000000..46e8eff --- /dev/null +++ b/doc/clean.svg @@ -0,0 +1,102 @@ + + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + diff --git a/doc/coll_close.svg b/doc/coll_close.svg new file mode 100644 index 0000000..8ddd96b --- /dev/null +++ b/doc/coll_close.svg @@ -0,0 +1,61 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + diff --git a/doc/coll_open.svg b/doc/coll_open.svg new file mode 100644 index 0000000..1cf11ae --- /dev/null +++ b/doc/coll_open.svg @@ -0,0 +1,61 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + diff --git a/doc/constant.svg b/doc/constant.svg new file mode 100644 index 0000000..43cd478 --- /dev/null +++ b/doc/constant.svg @@ -0,0 +1,170 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/constructor.svg b/doc/constructor.svg new file mode 100644 index 0000000..2f6caeb --- /dev/null +++ b/doc/constructor.svg @@ -0,0 +1,237 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/delegate.svg b/doc/delegate.svg new file mode 100644 index 0000000..d45e57c --- /dev/null +++ b/doc/delegate.svg @@ -0,0 +1,126 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/devhelpstyle.css b/doc/devhelpstyle.css new file mode 100644 index 0000000..1fb803d --- /dev/null +++ b/doc/devhelpstyle.css @@ -0,0 +1,578 @@ +* { + font-family: 'Times New Roman'; + font-size: 12pt; +} + +ul.external_link { +} + +.main_optional_parameter { + font-style: italic; +} + +.main_diagram { + border-style: none; + display: block; + margin: 0px auto; +} + + +.main_notification { + padding-right: 10px; + padding-left: 60px; + padding-bottom: 5px; + padding-top: 5px; + border-color: #aaaaff; + background-color: #eeeeff; + border-style: solid; + border-width: 1px; + margin: 10px; + min-height: 48px; + background-position: 6px 0.5em; + background-repeat: no-repeat; + background-image: url(warning.png); +} + +.main_table { + border-collapse: collapse; + border: 1px solid #aaaaff; + background: #eeeeff; + margin-right:auto; + margin-left:auto; +} + +.main_source, .main_sourcesample { + padding-right: 10px; + padding-left: 5px; + padding-bottom: 5px; + padding-top: 5px; + margin: 10px; + + border-color: #aaaaff; + background-color: #eeeeff; + border-style: solid; + border-width: 1px; +} + + +input { + border-color: #aaaaff; + border-style: solid; + border-width: 1px; +} + + + + +.site_header { + font-size: 25px; + padding-bottom: 10px; + padding-top: 10px; + background-color: #aaaaff; + width: 100%; +} + + +div { + font-family:'Verdana'; + font-size: 12; +} + + +.site_title { + text-align: left; + font-size: 40; +} + +div.site_footer { + text-align: center; + background-color: #aaaaff; + padding-bottom: 5px; + padding-top: 5px; + width: 100%; + clear: left; +} + + +div.site_body { + font-size: 10; +} + + +.site_content { + font-size: 12px; + margin-left: 5px; + margin-right: 5px; + text-align: left; +} + + +.main_type { + text-decoration: none; + font-style: italic; + color: #000000; +} + +.main_basic_type { + text-decoration: none; + font-weight: bold; + color: #2e8b57; +} + +.main_keyword { + text-decoration: none; + font-weight: bold; + color: #a52a2a; +} + +.main_source .main_literal { + text-decoration: none; + color: #ff0000; +} + +.main_comment { + text-decoration: none; + color: #888a85; +} + +.main_preprocessor { + text-decoration: none; + color: #ad7fa8; +} + +div.main_code_definition { + padding-right: 10px; + padding-left: 10px; + padding-bottom: 5px; + padding-top: 5px; + + font-family: monospace; + border-color: #aaaaff; + background-color: #eeeeff; + border-style: solid; + border-width: 1px; + margin: 10px; +} + +div.main_notification_block { + padding-right: 10px; + padding-left: 10px; + padding-bottom: 5px; + padding-top: 5px; + + border-color: #d08717; + background-color: #fbf2c3; + border-style: solid; + border-width: 1px; + margin: 10px; +} + +span.main_block_headline { + background-image:url(tip.png); + background-repeat:no-repeat; + background-position:center right; + font-weight:bold; + display:block; +} + +div.main_block_content { + margin-left:15px; +} + +span.leaf_code_definition { + font-family: monospace; +} + + +div.leaf_brief_description { + display: block; + margin-left: 40px; +} + + +h1.main_title { + font-size: 20px; + margin-bottom: 0px; +} + +h2.main_title { + margin-bottom: 0px; +} + +h3.main_title { + margin-bottom: 0px; +} + +.main_hr { + border: 0; + color: #aaaaff; + background-color: #aaaaff; + height: 1px; + margin-top: 5px; + margin-bottom: 5px; +} + + + +.main_parameter_table_text, .main_errordomain_table_text, .main_enum_table_text { +} + +.main_parameter_table_unknown_parameter { + color: GREY; +} + +.main_parameter_table_name, .main_errordomain_table_name, .main_enum_table_name { + vertical-align: top; + text-align: right; + font-weight: bold; + width: 120px; + padding-right: 10px; +} + +.main_parameter_table, .main_errordomain_table, .main_enum_table { + margin-weight: 20px; + margin-left: 20px; +} + + + +.description a.constant, .brief_description a.constant { + background-image:url(constant.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.namespace, .brief_description a.namespace { + background-image:url(namespace.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.struct, .brief_description a.struct { + background-image:url(struct.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.interface, .brief_description a.interface { + background-image:url(interface.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.enum, .brief_description a.enum { + background-image:url(enum.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.errordomain, .brief_description a.errordomain { + background-image:url(errordomain.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.delegate, .brief_description a.delegate { + background-image:url(delegate.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.signal, .brief_description a.signal { + background-image:url(signal.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.field, .brief_description a.field { + background-image:url(field.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.enumvalue, .brief_description a.enumvalue { + background-image:url(enumvalue.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.errorcode, .brief_description a.errorcode { + background-image:url(errorcode.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.class, .brief_description a.class { + background-image:url(class.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.abstract_class, .brief_description a.abstract_class { + background-image:url(abstractclass.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; + font-style: italic; +} +.description a.property, .brief_description a.property { + background-image:url(property.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.virtual_property, .brief_description a.virtual_property { + background-image:url(virtualproperty.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.abstract_property, .brief_description a.abstract_property { + background-image:url(abstractproperty.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.method, .brief_description a.method { + background-image:url(method.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.static_method, .brief_description a.static_method { + background-image:url(staticmethod.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.virtual_method, .brief_description a.virtual_method { + background-image:url(virtualmethod.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.abstract_method, .brief_description a.abstract_method { + background-image:url(abstractmethod.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.description a.creation_method, .brief_description a.creation_method { + background-image:url(constructor.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} + +.navi_main .errorcode, .navi_inline .errorcode { + list-style-image:url(errorcode.png); +} +.navi_main .enumvalue, .navi_inline .enumvalue { + list-style-image:url(enumvalue.png); +} +.navi_main .abstract_class, .navi_inline .abstract_class { + list-style-image: url(abstractclass.png); +} +.navi_main .abstract_method, .navi_inline .abstract_method { + list-style-image: url( abstractmethod.png ); +} +.navi_main .creation_method, .navi_inline .creation_method, .main_list_m { + list-style-image: url(constructor.png); +} +.navi_main .static_method, .navi_inline .static_method { + list-style-image: url(staticmethod.png); +} +.navi_main .package_index { + list-style-image: url(packages.png); +} +.navi_main .virtual_method, .navi_inline .virtual_method { + list-style-image: url(virtualmethod.png); +} +.navi_main .errordomain, .navi_inline .errordomain, .main_list_errdom { + list-style-image: url(errordomain.png); +} +.navi_main .namespace, .navi_inline .namespace, .main_list_ns { + list-style-image: url(namespace.png); +} +.navi_main .method, .navi_inline .method { + list-style-image: url(method.png); +} +.navi_main .struct, .navi_inline .struct, .main_list_stru { + list-style-image: url(struct.png); +} +.navi_main .interface, .navi_inline .interface, .main_list_iface { + list-style-image: url(interface.png); +} +.navi_main .field, .navi_inline .field, .main_list_field { + list-style-image: url(field.png); +} +.navi_main .class, .navi_inline .class, .main_list_cl { + list-style-image: url(class.png); +} +.navi_main .enum, .navi_inline .enum, .main_list_en { + list-style-image: url(enum.png); +} +.navi_main .property, .navi_inline .property, .main_list_prop { + list-style-image: url(property.png); +} +.navi_main .abstract_property, .navi_inline .abstract_property { + list-style-image: url(abstractproperty.png); +} +.navi_main .virtual_property, .navi_inline .virtual_property { + list-style-image: url(virtualproperty.png); +} +.navi_main .delegate, .navi_inline .delegate, .main_list_del { + list-style-image: url(delegate.png); +} +.navi_main .signal, .navi_inline .signal, .main_list_sig { + list-style-image: url(signal.png); +} +.navi_main .package, .navi_inline .package { + list-style-image: url(package.png); +} +.navi_main .constant, .navi_inline .constant { + list-style-image: url(constant.png); +} + + +.navi_main { + margin-top: 10px; + margin-bottom: 10px; + padding-left: 30px; +} + +.navi_hr { + border: 0; + color: #aaaaff; + background-color: #aaaaff; + height: 1px; + margin-left: 10px; + margin-right: 10px; + margin-top: 5px; + margin-bottom: 5px; +} + + + +.navi_main a, .navi_inline a, +a.external_link +{ + text-decoration: none; + color: #214b87; +} + +.navi_main .abstract_class > a, .navi_inline .abstract_class > a { + font-style: italic; +} + +a.navi_link:hover, a.external_link:hover { + text-decoration: underline; +} + +ul.no_bullet li { + list-style-type: none; +} + +.main_see_list { +} + +.navi_inline { +} + +.css_content_literal { + font-family: monospace; + color: #ff01ff; +} + +code { + font-family: monospace; +} + +.main_code_definition a, .leaf_code_definition a { + text-decoration: none; + color: inherit; +} + +.main_code_definition a:hover, .leaf_code_definition a:hover { + text-decoration: underline; +} + +.box { +} +.box .headline { + background-image: url("coll_open.png"); + background-position: calc(100% - 1px) center; + background-repeat: no-repeat; + background-color: #eeeeff; + border-color: #aaaaff; + border-style: solid; + border-width: 1px; + margin: auto; + width: 90%; + margin-top: 20px; + font-weight: bold; +} +.box .content { + border-color: #aaaaff; + border-width: 0 1 1 1; + border-style: solid; + overflow: auto; + display: none; + margin: auto; + width: 90%; +} +.box .column { + float: left; + width: 33%; +} + +.namespace_note { +} +.package_note { +} + +.deprecated { + text-decoration:line-through; +} diff --git a/doc/document.svg b/doc/document.svg new file mode 100644 index 0000000..d239314 --- /dev/null +++ b/doc/document.svg @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + + + diff --git a/doc/enum.svg b/doc/enum.svg new file mode 100644 index 0000000..0cd3c62 --- /dev/null +++ b/doc/enum.svg @@ -0,0 +1,304 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/enumvalue.svg b/doc/enumvalue.svg new file mode 100644 index 0000000..984d346 --- /dev/null +++ b/doc/enumvalue.svg @@ -0,0 +1,120 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/errorcode.svg b/doc/errorcode.svg new file mode 100644 index 0000000..fb1d873 --- /dev/null +++ b/doc/errorcode.svg @@ -0,0 +1,138 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/errordomain.svg b/doc/errordomain.svg new file mode 100644 index 0000000..e1bc113 --- /dev/null +++ b/doc/errordomain.svg @@ -0,0 +1,322 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/external_link.svg b/doc/external_link.svg new file mode 100644 index 0000000..2b74911 --- /dev/null +++ b/doc/external_link.svg @@ -0,0 +1,50 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + + elementary Symbolic Icon Theme + + + + + diff --git a/doc/favicon.ico b/doc/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..cbef281b7b53457b8338579c85906616fb4d3f58 GIT binary patch literal 16958 zcmeI4&r2Ik7{^z7=&`r=+++WPoCK+O2)*dVT-Jjv2mwJnq?cTb2Q5e?pjb*S@en+` z1T0j9Kw+U+P>>uXi1x58gcgb=C3=Xb>GPd&%)%u&JquqBfka0PqR8th5bz2pb`VS@D!c3Wbc)agy? zB(vW{PW`s_=S6)T_jP#sLivyBNG82#E&swW*?;?UC_fHNziHUb--+fgACV2DCajdf67=8MjnsdWj=JOT zt>iC)pVcGzaq#u}PvRf3P6mR%VdVdXy+4F(wtkQg48F3Ce=QCDe>L($D*pNkKh~nP z`|^Wz{G|x~dWW&HTOe{FpTfuA*7-nr6#DpGoP*E-*iWa>Zh)HzP)#$?=qK>@PVZ-$cJB8BZI97erfNs)c2G= z(11;(3)b-0UPAxBjr!;OgEO2}`T!bE&D)a?NAY{G{|kQM1L8edI-vcjj1@NEWugC5 zqyD{|lUN#MV zJ~dxd-;Z(8zv$0(`?F#Uw;sViW`?J|f!n`SD&+eIUxW?t_2F5YMCR-+z+{)qmN*52ngEat4tLp^umu&d0_EO#PXt_mmpb zbwLRJ-ncP~IRjt#0PJfjAMRgwZ3ALFJ2;+SI)WYda_F|K^I!M8wHVEjOp<-JKF$PC z_#DP)?;HmBf33d?v{g3*zj^LQ^#O7Hx3Teo68h_%ZVUjEDPQIM8{zzG+-}VLst@4$ z)63y8_O5*ZTn(P9!#l;o-&3Q(emmN=s#)2jr!GeD<6Jck@K`Yzj1_myt=8(F_;nwM;~dE}$)H&c=EGYDr_3GAGrTL$yqt<0_`S4`xDl>@-3RpkVqEM1&$*SS zeoI@-I1l@o869${p<37P5r{->LNX*dA#Re_;nvB z)WZ9k`t#h^c0N7A_BKckZIQ$3+;V%tyLzl!_W?O(eqU@ixi9>`n4MtW#tLg5?6R{H zng{4~W9D`HHmVQc?8%&6b0jyBX}@iJ;(uQkeO>fz;6d9!lD`1}d(yvu!8bs$&8Khq z*}$H<<$J_gwqQ^C_mA>B(Cq}-0azusTE9zx48W)|>%UWU9BmG%*b*DT0;Uv|0Pi31 lj{%;16ZK + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/icon.svg b/doc/icon.svg new file mode 100644 index 0000000..542bea3 --- /dev/null +++ b/doc/icon.svg @@ -0,0 +1,45 @@ + + + + + + + image/svg+xml + + + + + + + + + + diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..ef7f26b --- /dev/null +++ b/doc/index.html @@ -0,0 +1,34 @@ + + + + + pluie-echo-0.1 – Vala Binding Reference + + + +
pluie-echo-0.1 Reference Manual
+
+
+ +
+
+

Packages:

+
+

Content:

+

Packages:

+ +
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/interface.svg b/doc/interface.svg new file mode 100644 index 0000000..58fc2fe --- /dev/null +++ b/doc/interface.svg @@ -0,0 +1,42 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + diff --git a/doc/logo.svg b/doc/logo.svg new file mode 100644 index 0000000..ab16fc0 --- /dev/null +++ b/doc/logo.svg @@ -0,0 +1,35 @@ + + + + + + + image/svg+xml + + + + + + + + + diff --git a/doc/method.svg b/doc/method.svg new file mode 100644 index 0000000..a310e37 --- /dev/null +++ b/doc/method.svg @@ -0,0 +1,151 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/namespace.svg b/doc/namespace.svg new file mode 100644 index 0000000..282b5c3 --- /dev/null +++ b/doc/namespace.svg @@ -0,0 +1,36 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + + elementary Symbolic Icon Theme + + + diff --git a/doc/package.svg b/doc/package.svg new file mode 100644 index 0000000..4ec6ad1 --- /dev/null +++ b/doc/package.svg @@ -0,0 +1,40 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + diff --git a/doc/packages.svg b/doc/packages.svg new file mode 100644 index 0000000..f5d62dd --- /dev/null +++ b/doc/packages.svg @@ -0,0 +1,83 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + go-home + + + + + + + + + diff --git a/doc/pluie-echo-0.1/Pluie.Color.Color.html b/doc/pluie-echo-0.1/Pluie.Color.Color.html new file mode 100644 index 0000000..886f66b --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Color.Color.html @@ -0,0 +1,73 @@ + + + + + Pluie.Color.Color – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Color.Color – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

Color

+
+

Description:

+
public Color (uint8? fg = 15, bool bold = false, uint8? bg = null) +
+
+

Parameters:

+ + + + + + + + + + + + + +
fg +

foreground color code - 0 to 255

+
bold +

bold attribute

+
bg +

background color code - 0 to 255

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Color.bg.html b/doc/pluie-echo-0.1/Pluie.Color.bg.html new file mode 100644 index 0000000..8f12277 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Color.bg.html @@ -0,0 +1,53 @@ + + + + + Pluie.Color.bg – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Color.bg – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

bg

+
+

Description:

+
public uint8? bg { set; get; } +
+
+

background color code - 0 to 255

+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Color.bold.html b/doc/pluie-echo-0.1/Pluie.Color.bold.html new file mode 100644 index 0000000..81d16f8 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Color.bold.html @@ -0,0 +1,53 @@ + + + + + Pluie.Color.bold – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Color.bold – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

bold

+
+

Description:

+
public bool bold { set; get; } +
+
+

enable bold attribute

+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Color.fg.html b/doc/pluie-echo-0.1/Pluie.Color.fg.html new file mode 100644 index 0000000..535c916 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Color.fg.html @@ -0,0 +1,53 @@ + + + + + Pluie.Color.fg – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Color.fg – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

fg

+
+

Description:

+
public uint8? fg { set; get; } +
+
+

foreground color code - 0 to 255

+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Color.html b/doc/pluie-echo-0.1/Pluie.Color.html new file mode 100644 index 0000000..bb7f1cd --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Color.html @@ -0,0 +1,108 @@ + + + + + Pluie.Color – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Color – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+
    +
  • Color
    • +
+
+ +
+
+

Color

+
+

Object Hierarchy:

+ Object hierarchy for Color + + + + + +

Description:

+
public class Color +
+
+

a Class representing an Ansi Extended 8 bit Color with foreground, background and bold attributes

+ 

using Pluie;

int main (string[] args)
{
    var c1 = new Color(37, false);
    var c2 = new Color(204, true);
    var c3 = new Color(15, true, 24);
    stdout.printf ("[%s][%s]  %s  ", c1.s ("oki"), c2.s ("very"), c3.s ("cool"));
    return 0;
}
+

+

valac --pkg pluie-echo-0.1 color.vala

+

+
Namespace: Pluie +
+
Package: pluie-echo-0.1 +
+

Content:

+

Properties:

+
    +
  • public uint8? fg { set; get; } + +
    foreground color code - 0 to 255 +
    • +
  • public uint8? bg { set; get; } + +
    background color code - 0 to 255 +
    • +
  • public bool bold { set; get; } + +
    enable bold attribute +
    • +
+

Static methods:

+
    +
  • public static string off () + +
    disable escape color sequence +
    • +
+

Creation methods:

+
    +
  • public Color (uint8? fg = 15, bool bold = false, uint8? bg = null) + +
    +
    • +
+

Methods:

+
    +
  • public string to_string () + +
    return ansi extended color escape string sequence +
    • +
  • public string s (string? label = null, bool off = true, bool? bold = null) + +
    colorize a string +
    • +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Color.off.html b/doc/pluie-echo-0.1/Pluie.Color.off.html new file mode 100644 index 0000000..ff08173 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Color.off.html @@ -0,0 +1,53 @@ + + + + + Pluie.Color.off – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Color.off – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

off

+
+

Description:

+
public static string off () +
+
+

disable escape color sequence

+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Color.s.html b/doc/pluie-echo-0.1/Pluie.Color.s.html new file mode 100644 index 0000000..557d883 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Color.s.html @@ -0,0 +1,82 @@ + + + + + Pluie.Color.s – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Color.s – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

s

+
+

Description:

+
public string s (string? label = null, bool off = true, bool? bold = null) +
+
+

colorize a string

+

Parameters:

+ + + + + + + + + + + + + +
label +

the string to colorize

+
off +

enable/disable off sequence at end of label

+
bold +

override bold attribute for label

+
+

Returns:

+ + + + +
+

the colorized string with proper ansi escape color sequence

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Color.to_string.html b/doc/pluie-echo-0.1/Pluie.Color.to_string.html new file mode 100644 index 0000000..4a709ab --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Color.to_string.html @@ -0,0 +1,53 @@ + + + + + Pluie.Color.to_string – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Color.to_string – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

to_string

+
+

Description:

+
public string to_string () +
+
+

return ansi extended color escape string sequence

+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ColorConf.@get.html b/doc/pluie-echo-0.1/Pluie.ColorConf.@get.html new file mode 100644 index 0000000..56f6440 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ColorConf.@get.html @@ -0,0 +1,66 @@ + + + + + Pluie.ColorConf.@get – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ColorConf.@get – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

@get

+
+

Description:

+
public weak Color? @get (ECHO name) +
+
+

get specifiyed ECHO color instance

+

Parameters:

+ + + + + +
name +

the choosen color

+
+

Returns:

+ + + + +
+

the corresponding Color instance

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ColorConf.ColorConf.html b/doc/pluie-echo-0.1/Pluie.ColorConf.ColorConf.html new file mode 100644 index 0000000..bcc6d44 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ColorConf.ColorConf.html @@ -0,0 +1,58 @@ + + + + + Pluie.ColorConf.ColorConf – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ColorConf.ColorConf – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

ColorConf

+
+

Description:

+
public ColorConf (string path) +
+
+

see resources/echo.ini file

+

Parameters:

+ + + + + +
path +

config ini file path overriding Pluie.ECHO color values

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ColorConf.html b/doc/pluie-echo-0.1/Pluie.ColorConf.html new file mode 100644 index 0000000..eba4b66 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ColorConf.html @@ -0,0 +1,80 @@ + + + + + Pluie.ColorConf – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ColorConf – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+
    +
  • ColorConf
    • +
+
+ +
+
+

ColorConf

+
+

Object Hierarchy:

+ Object hierarchy for ColorConf + + + + + +

Description:

+
public class ColorConf +
+
+

a Class representing a set of Color mapping ECHO + colors with values coming from the specifyed ini config file

+

+
Namespace: Pluie +
+
Package: pluie-echo-0.1 +
+

Content:

+

Creation methods:

+
    +
  • public ColorConf (string path) + +
    see resources/echo.ini file +
    • +
+

Methods:

+
    +
  • public weak Color? @get (ECHO name) + +
    get specifiyed ECHO color instance +
    • +
  • public int param (string name) + +
    get value for Term parameter +
    • +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ColorConf.param.html b/doc/pluie-echo-0.1/Pluie.ColorConf.param.html new file mode 100644 index 0000000..087bda5 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ColorConf.param.html @@ -0,0 +1,66 @@ + + + + + Pluie.ColorConf.param – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ColorConf.param – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

param

+
+

Description:

+
public int param (string name) +
+
+

get value for Term parameter

+

Parameters:

+ + + + + +
name +

from { "term_width", "indent", "key_maxlen" }

+
+

Returns:

+ + + + +
+

corresponding value define in config file

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.@in.html b/doc/pluie-echo-0.1/Pluie.Dbg.@in.html new file mode 100644 index 0000000..fa95898 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.@in.html @@ -0,0 +1,85 @@ + + + + + Pluie.Dbg.@in – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg.@in – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

@in

+
+

Description:

+
public void @in (string method, string? @params = null, int line = 0, string? file = null) +
+
+

log method entering

+

Parameters:

+ + + + + + + + + + + + + + + + + +
method +

the method name

+
line +

optional current file line

+
file +

optional current file

+
params +

optional parameters string to display on entering

+
+

+
Namespace: Pluie.Dbg +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.@out.html b/doc/pluie-echo-0.1/Pluie.Dbg.@out.html new file mode 100644 index 0000000..682c2df --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.@out.html @@ -0,0 +1,85 @@ + + + + + Pluie.Dbg.@out – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg.@out – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

@out

+
+

Description:

+
public void @out (string method, string? @params = null, int line = 0, string? file = null) +
+
+

log method leaving

+

Parameters:

+ + + + + + + + + + + + + + + + + +
method +

the method name

+
line +

optional current file line

+
file +

optional current file

+
params +

optional parameters string to display on entering

+
+

+
Namespace: Pluie.Dbg +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.DBG_ENABLED.html b/doc/pluie-echo-0.1/Pluie.Dbg.DBG_ENABLED.html new file mode 100644 index 0000000..8ce7acf --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.DBG_ENABLED.html @@ -0,0 +1,58 @@ + + + + + Pluie.Dbg.DBG_ENABLED – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg.DBG_ENABLED – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

DBG_ENABLED

+
+

Description:

+
public bool DBG_ENABLED +
+
+

enable/disable log messages

+

+
Namespace: Pluie.Dbg +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.DBG_ENTER.html b/doc/pluie-echo-0.1/Pluie.Dbg.DBG_ENTER.html new file mode 100644 index 0000000..fbeeec5 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.DBG_ENTER.html @@ -0,0 +1,58 @@ + + + + + Pluie.Dbg.DBG_ENTER – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg.DBG_ENTER – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

DBG_ENTER

+
+

Description:

+
public const int8 DBG_ENTER +

+
Namespace: Pluie.Dbg +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.DBG_ERROR.html b/doc/pluie-echo-0.1/Pluie.Dbg.DBG_ERROR.html new file mode 100644 index 0000000..35d577f --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.DBG_ERROR.html @@ -0,0 +1,58 @@ + + + + + Pluie.Dbg.DBG_ERROR – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg.DBG_ERROR – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

DBG_ERROR

+
+

Description:

+
public const int8 DBG_ERROR +
+
+

type log error

+

+
Namespace: Pluie.Dbg +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.DBG_INLINE.html b/doc/pluie-echo-0.1/Pluie.Dbg.DBG_INLINE.html new file mode 100644 index 0000000..f7b79b9 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.DBG_INLINE.html @@ -0,0 +1,58 @@ + + + + + Pluie.Dbg.DBG_INLINE – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg.DBG_INLINE – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

DBG_INLINE

+
+

Description:

+
public const int8 DBG_INLINE +

+
Namespace: Pluie.Dbg +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.DBG_LEAVE.html b/doc/pluie-echo-0.1/Pluie.Dbg.DBG_LEAVE.html new file mode 100644 index 0000000..708551e --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.DBG_LEAVE.html @@ -0,0 +1,58 @@ + + + + + Pluie.Dbg.DBG_LEAVE – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg.DBG_LEAVE – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

DBG_LEAVE

+
+

Description:

+
public const int8 DBG_LEAVE +

+
Namespace: Pluie.Dbg +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.DBG_WARN.html b/doc/pluie-echo-0.1/Pluie.Dbg.DBG_WARN.html new file mode 100644 index 0000000..5a28afa --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.DBG_WARN.html @@ -0,0 +1,58 @@ + + + + + Pluie.Dbg.DBG_WARN – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg.DBG_WARN – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

DBG_WARN

+
+

Description:

+
public const int8 DBG_WARN +
+
+

type log warn

+

+
Namespace: Pluie.Dbg +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.error.html b/doc/pluie-echo-0.1/Pluie.Dbg.error.html new file mode 100644 index 0000000..7309bef --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.error.html @@ -0,0 +1,91 @@ + + + + + Pluie.Dbg.error – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg.error – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

error

+
+

Description:

+
public void error (string msg, string method, int line = 0, string? file = null, int8 mode = DBG_ERROR) +
+
+

log error

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + +
msg +

the error msg to log

+
method +

the method name logging the error

+
line +

optional current file line

+
file +

optional current file

+
mode +

optional log mode (DBG_ERROR|DBG_WARN)

+
+

+
Namespace: Pluie.Dbg +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.html b/doc/pluie-echo-0.1/Pluie.Dbg.html new file mode 100644 index 0000000..e24a20b --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.html @@ -0,0 +1,91 @@ + + + + + Pluie.Dbg – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+
    +
  • Dbg
    • +
+
+ +
+
+

Pluie.Dbg

+
+

Description:

+

Content:

+

Constants:

+
    +
  • public const int8 DBG_ERROR + +
    type log error +
    • +
  • public const int8 DBG_WARN + +
    type log warn +
    • +
+

Functions:

+
    +
  • public void init (OutputFormatter of, bool debug = false) + +
    initialize logging +
    • +
  • public void @in (string method, string? @params = null, int line = 0, string? file = null) + +
    log method entering +
    • +
  • public void @out (string method, string? @params = null, int line = 0, string? file = null) + +
    log method leaving +
    • +
  • public void msg (string msg, int line = 0, string? file = null) + +
    log a message +
    • +
  • public void error (string msg, string method, int line = 0, string? file = null, int8 mode = DBG_ERROR) + +
    log error +
    • +
+

Fields:

+
    +
  • public bool DBG_ENABLED + +
    enable/disable log messages +
    • +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.init.html b/doc/pluie-echo-0.1/Pluie.Dbg.init.html new file mode 100644 index 0000000..8d1fb02 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.init.html @@ -0,0 +1,73 @@ + + + + + Pluie.Dbg.init – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg.init – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

init

+
+

Description:

+
public void init (OutputFormatter of, bool debug = false) +
+
+

initialize logging

+

Parameters:

+ + + + + + + + + +
of +

the outputFormatter to use for logging

+
debug +

enable disable log messages

+
+

+
Namespace: Pluie.Dbg +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.log.html b/doc/pluie-echo-0.1/Pluie.Dbg.log.html new file mode 100644 index 0000000..22fc8e1 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.log.html @@ -0,0 +1,59 @@ + + + + + Pluie.Dbg.log – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg.log – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

log

+
+

Description:

+
public void log (string msg, int line = 0, int8 mode = DBG_INLINE, string? file = null) +

+
Namespace: Pluie.Dbg +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Dbg.msg.html b/doc/pluie-echo-0.1/Pluie.Dbg.msg.html new file mode 100644 index 0000000..98bc10d --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Dbg.msg.html @@ -0,0 +1,79 @@ + + + + + Pluie.Dbg.msg – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Dbg.msg – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

msg

+
+

Description:

+
public void msg (string msg, int line = 0, string? file = null) +
+
+

log a message

+

Parameters:

+ + + + + + + + + + + + + +
msg +

the msg to log

+
line +

optional current file line

+
file +

optional current file

+
+

+
Namespace: Pluie.Dbg +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.ACTION.html b/doc/pluie-echo-0.1/Pluie.ECHO.ACTION.html new file mode 100644 index 0000000..b8a0e53 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.ACTION.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.ACTION – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.ACTION – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • ACTION
    • +
+
+
    +
+
+
+

ACTION

+
+

Description:

+
ACTION +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.ARG.html b/doc/pluie-echo-0.1/Pluie.ECHO.ARG.html new file mode 100644 index 0000000..e6bb33a --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.ARG.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.ARG – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.ARG – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • ARG
    • +
+
+
    +
+
+
+

ARG

+
+

Description:

+
ARG +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.ARG_SEP.html b/doc/pluie-echo-0.1/Pluie.ECHO.ARG_SEP.html new file mode 100644 index 0000000..cc5759b --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.ARG_SEP.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.ARG_SEP – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.ARG_SEP – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • ARG_SEP
    • +
+
+
    +
+
+
+

ARG_SEP

+
+

Description:

+
ARG_SEP +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.COMMENT.html b/doc/pluie-echo-0.1/Pluie.ECHO.COMMENT.html new file mode 100644 index 0000000..0ab2874 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.COMMENT.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.COMMENT – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.COMMENT – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • COMMENT
    • +
+
+
    +
+
+
+

COMMENT

+
+

Description:

+
COMMENT +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.DATE.html b/doc/pluie-echo-0.1/Pluie.ECHO.DATE.html new file mode 100644 index 0000000..9c02760 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.DATE.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.DATE – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.DATE – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • DATE
    • +
+
+
    +
+
+
+

DATE

+
+

Description:

+
DATE +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.DEFAULT.html b/doc/pluie-echo-0.1/Pluie.ECHO.DEFAULT.html new file mode 100644 index 0000000..a1038d6 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.DEFAULT.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.DEFAULT – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.DEFAULT – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • DEFAULT
    • +
+
+
    +
+
+
+

DEFAULT

+
+

Description:

+
DEFAULT +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.DONE.html b/doc/pluie-echo-0.1/Pluie.ECHO.DONE.html new file mode 100644 index 0000000..94093bf --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.DONE.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.DONE – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.DONE – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • DONE
    • +
+
+
    +
+
+
+

DONE

+
+

Description:

+
DONE +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.ENTER.html b/doc/pluie-echo-0.1/Pluie.ECHO.ENTER.html new file mode 100644 index 0000000..dd6eb6c --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.ENTER.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.ENTER – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.ENTER – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • ENTER
    • +
+
+
    +
+
+
+

ENTER

+
+

Description:

+
ENTER +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.ERROR.html b/doc/pluie-echo-0.1/Pluie.ECHO.ERROR.html new file mode 100644 index 0000000..07a1f7f --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.ERROR.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.ERROR – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.ERROR – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • ERROR
    • +
+
+
    +
+
+
+

ERROR

+
+

Description:

+
ERROR +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.FAIL.html b/doc/pluie-echo-0.1/Pluie.ECHO.FAIL.html new file mode 100644 index 0000000..ded1eb2 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.FAIL.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.FAIL – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.FAIL – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • FAIL
    • +
+
+
    +
+
+
+

FAIL

+
+

Description:

+
FAIL +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.FILE.html b/doc/pluie-echo-0.1/Pluie.ECHO.FILE.html new file mode 100644 index 0000000..7eb12aa --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.FILE.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.FILE – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.FILE – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • FILE
    • +
+
+
    +
+
+
+

FILE

+
+

Description:

+
FILE +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.ITEM.html b/doc/pluie-echo-0.1/Pluie.ECHO.ITEM.html new file mode 100644 index 0000000..9dbdcda --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.ITEM.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.ITEM – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.ITEM – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • ITEM
    • +
+
+
    +
+
+
+

ITEM

+
+

Description:

+
ITEM +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.KEY.html b/doc/pluie-echo-0.1/Pluie.ECHO.KEY.html new file mode 100644 index 0000000..40b30f0 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.KEY.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.KEY – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.KEY – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • KEY
    • +
+
+
    +
+
+
+

KEY

+
+

Description:

+
KEY +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.LEAVE.html b/doc/pluie-echo-0.1/Pluie.ECHO.LEAVE.html new file mode 100644 index 0000000..7371b91 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.LEAVE.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.LEAVE – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.LEAVE – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • LEAVE
    • +
+
+
    +
+
+
+

LEAVE

+
+

Description:

+
LEAVE +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.MICROTIME.html b/doc/pluie-echo-0.1/Pluie.ECHO.MICROTIME.html new file mode 100644 index 0000000..b944ba2 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.MICROTIME.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.MICROTIME – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.MICROTIME – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • MICROTIME
    • +
+
+
    +
+
+
+

MICROTIME

+
+

Description:

+
MICROTIME +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.NUM.html b/doc/pluie-echo-0.1/Pluie.ECHO.NUM.html new file mode 100644 index 0000000..6cb2b92 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.NUM.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.NUM – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.NUM – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • NUM
    • +
+
+
    +
+
+
+

NUM

+
+

Description:

+
NUM +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.OPTION.html b/doc/pluie-echo-0.1/Pluie.ECHO.OPTION.html new file mode 100644 index 0000000..0bb50ab --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.OPTION.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.OPTION – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.OPTION – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • OPTION
    • +
+
+
    +
+
+
+

OPTION

+
+

Description:

+
OPTION +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.OPTION_SEP.html b/doc/pluie-echo-0.1/Pluie.ECHO.OPTION_SEP.html new file mode 100644 index 0000000..3ae488f --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.OPTION_SEP.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.OPTION_SEP – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.OPTION_SEP – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • OPTION_SEP
    • +
+
+
    +
+
+
+

OPTION_SEP

+
+

Description:

+
OPTION_SEP +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.SECTION.html b/doc/pluie-echo-0.1/Pluie.ECHO.SECTION.html new file mode 100644 index 0000000..6aa0b53 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.SECTION.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.SECTION – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.SECTION – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • SECTION
    • +
+
+
    +
+
+
+

SECTION

+
+

Description:

+
SECTION +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.SEP.html b/doc/pluie-echo-0.1/Pluie.ECHO.SEP.html new file mode 100644 index 0000000..64d6c8b --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.SEP.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.SEP – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.SEP – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • SEP
    • +
+
+
    +
+
+
+

SEP

+
+

Description:

+
SEP +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.TIME.html b/doc/pluie-echo-0.1/Pluie.ECHO.TIME.html new file mode 100644 index 0000000..9c23c94 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.TIME.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.TIME – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.TIME – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • TIME
    • +
+
+
    +
+
+
+

TIME

+
+

Description:

+
TIME +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.TITLE.html b/doc/pluie-echo-0.1/Pluie.ECHO.TITLE.html new file mode 100644 index 0000000..ec2bdda --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.TITLE.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.TITLE – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.TITLE – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • TITLE
    • +
+
+
    +
+
+
+

TITLE

+
+

Description:

+
TITLE +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.TITLE_ITEM.html b/doc/pluie-echo-0.1/Pluie.ECHO.TITLE_ITEM.html new file mode 100644 index 0000000..371e045 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.TITLE_ITEM.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.TITLE_ITEM – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.TITLE_ITEM – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • TITLE_ITEM
    • +
+
+
    +
+
+
+

TITLE_ITEM

+
+

Description:

+
TITLE_ITEM +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.TITLE_SEP.html b/doc/pluie-echo-0.1/Pluie.ECHO.TITLE_SEP.html new file mode 100644 index 0000000..b04e190 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.TITLE_SEP.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.TITLE_SEP – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.TITLE_SEP – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • TITLE_SEP
    • +
+
+
    +
+
+
+

TITLE_SEP

+
+

Description:

+
TITLE_SEP +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.VAL.html b/doc/pluie-echo-0.1/Pluie.ECHO.VAL.html new file mode 100644 index 0000000..d3ac4cb --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.VAL.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.VAL – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.VAL – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • VAL
    • +
+
+
    +
+
+
+

VAL

+
+

Description:

+
VAL +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.WARN.html b/doc/pluie-echo-0.1/Pluie.ECHO.WARN.html new file mode 100644 index 0000000..d941785 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.WARN.html @@ -0,0 +1,47 @@ + + + + + Pluie.ECHO.WARN – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO.WARN – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • WARN
    • +
+
+
    +
+
+
+

WARN

+
+

Description:

+
WARN +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.ECHO.html b/doc/pluie-echo-0.1/Pluie.ECHO.html new file mode 100644 index 0000000..e4b280e --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.ECHO.html @@ -0,0 +1,106 @@ + + + + + Pluie.ECHO – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.ECHO – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+
    +
  • ECHO
    • +
+
+ +
+
+

ECHO

+
+

Description:

+
public enum ECHO +
+
+

enumerate predefined Color mapped to default config file see resources/echo.ini

+

+
Namespace: Pluie +
+
Package: pluie-echo-0.1 +
+

Content:

+

Enum values:

+ +
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Echo.DATA_PATH.html b/doc/pluie-echo-0.1/Pluie.Echo.DATA_PATH.html new file mode 100644 index 0000000..5acfa58 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Echo.DATA_PATH.html @@ -0,0 +1,52 @@ + + + + + Pluie.Echo.DATA_PATH – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Echo.DATA_PATH – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

DATA_PATH

+
+

Description:

+
protected const unowned string DATA_PATH +

+
Namespace: Pluie.Echo +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Echo.INSTALL_PATH.html b/doc/pluie-echo-0.1/Pluie.Echo.INSTALL_PATH.html new file mode 100644 index 0000000..4e69c31 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Echo.INSTALL_PATH.html @@ -0,0 +1,52 @@ + + + + + Pluie.Echo.INSTALL_PATH – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Echo.INSTALL_PATH – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

INSTALL_PATH

+
+

Description:

+
protected const unowned string INSTALL_PATH +

+
Namespace: Pluie.Echo +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Echo.VERSION.html b/doc/pluie-echo-0.1/Pluie.Echo.VERSION.html new file mode 100644 index 0000000..5e756fe --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Echo.VERSION.html @@ -0,0 +1,52 @@ + + + + + Pluie.Echo.VERSION – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Echo.VERSION – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

VERSION

+
+

Description:

+
protected const unowned string VERSION +

+
Namespace: Pluie.Echo +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Echo.html b/doc/pluie-echo-0.1/Pluie.Echo.html new file mode 100644 index 0000000..36fbc4a --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Echo.html @@ -0,0 +1,76 @@ + + + + + Pluie.Echo – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Echo – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+
    +
  • Echo
    • +
+
+ +
+
+

Pluie.Echo

+
+

Description:

+

Content:

+

Constants:

+
    +
  • protected const unowned string INSTALL_PATH + +
    +
    • +
  • protected const unowned string DATA_PATH + +
    +
    • +
  • protected const unowned string VERSION + +
    +
    • +
+

Functions:

+ +

Fields:

+ +
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Echo.init.html b/doc/pluie-echo-0.1/Pluie.Echo.init.html new file mode 100644 index 0000000..f611e0f --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Echo.init.html @@ -0,0 +1,52 @@ + + + + + Pluie.Echo.init – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Echo.init – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

init

+
+

Description:

+
public OutputFormatter init (bool debug, string? path = null) +

+
Namespace: Pluie.Echo +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Echo.of.html b/doc/pluie-echo-0.1/Pluie.Echo.of.html new file mode 100644 index 0000000..57ab637 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Echo.of.html @@ -0,0 +1,52 @@ + + + + + Pluie.Echo.of – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Echo.of – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

of

+
+

Description:

+
public OutputFormatter of +

+
Namespace: Pluie.Echo +
+
Package: pluie-echo-0.1 +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.OutputFormatter.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.OutputFormatter.html new file mode 100644 index 0000000..416323b --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.OutputFormatter.html @@ -0,0 +1,75 @@ + + + + + Pluie.OutputFormatter.OutputFormatter – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.OutputFormatter – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

OutputFormatter

+
+

Description:

+
public OutputFormatter (ColorConf conf) +
+
+

Parameters:

+ + + + + +
conf +

the ColorConf to use for printing ansi escape sequences

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.action.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.action.html new file mode 100644 index 0000000..5acbc03 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.action.html @@ -0,0 +1,82 @@ + + + + + Pluie.OutputFormatter.action – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.action – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

action

+
+

Description:

+
public void action (string name, string? val = "") +
+
+

display an action

+

Parameters:

+ + + + + + + + + +
name +

name of current action

+
val +

optional action parameter

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.c.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.c.html new file mode 100644 index 0000000..bc9eb64 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.c.html @@ -0,0 +1,76 @@ + + + + + Pluie.OutputFormatter.c – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.c – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

c

+
+

Description:

+
public weak Color c (ECHO name) +
+
+

get Color instance corresponding to ECHO color

+

Parameters:

+ + + + + +
name +

the ECHO color

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.conf.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.conf.html new file mode 100644 index 0000000..39da55b --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.conf.html @@ -0,0 +1,64 @@ + + + + + Pluie.OutputFormatter.conf – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.conf – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

conf

+
+

Description:

+
protected ColorConf conf +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.echo.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.echo.html new file mode 100644 index 0000000..a3d32b9 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.echo.html @@ -0,0 +1,94 @@ + + + + + Pluie.OutputFormatter.echo – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.echo – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

echo

+
+

Description:

+
public void echo (string? data = "", bool lf = true, bool indent_all = false, ECHO color = DEFAULT, int8 indent_adjust = 0) +
+
+

generic method to display messages

+

Parameters:

+ + + + + + + + + + + + + + + + + +
data +

the message to display

+
lf +

enable line feed

+
indent_all +

enable multiple line indentation

+
color +

use color ECHO to display the message

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.echo_up.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.echo_up.html new file mode 100644 index 0000000..75deb20 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.echo_up.html @@ -0,0 +1,82 @@ + + + + + Pluie.OutputFormatter.echo_up – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.echo_up – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

echo_up

+
+

Description:

+
public void echo_up (int line, string s) +
+
+

display a message up tp x lines

+

Parameters:

+ + + + + + + + + +
line +

number of line to move up

+
s +

the message to display

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.error.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.error.html new file mode 100644 index 0000000..a7b9411 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.error.html @@ -0,0 +1,76 @@ + + + + + Pluie.OutputFormatter.error – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.error – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

error

+
+

Description:

+
public void error (string label, bool warn = false) +
+
+

display an error

+

Parameters:

+ + + + + +
label +

the error message to display

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.html new file mode 100644 index 0000000..0914a83 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.html @@ -0,0 +1,175 @@ + + + + + Pluie.OutputFormatter – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+
    +
  • OutputFormatter
    • +
+
+ +
+
+

OutputFormatter

+
+

Object Hierarchy:

+ Object hierarchy for OutputFormatter + + + + + +

Description:

+
public class OutputFormatter +
+
+

A class managing display on stdout & stderror with Color styles defined by specifiyed + ColorConf

+ 

using GLib;
using Pluie;

errordomain MyError {
    CODE
}

int main (string[] args)
{
    var of = Echo.init (true, "resources/echo.ini");
    Dbg.in (Log.METHOD, null, Log.LINE, Log.FILE);

    of.title ("MyApp", "0.2.2", "a-sansara");

    of.echo ("sample echo\n");

    of.keyval ("path", "/tmp/blob");
    of.keyval ("otherlongoption", "other value");

    of.echo ("\nsample echo\non multiple\nline", true, true);

    of.action ("reading config", "toto.conf");

    of.state (false);

    of.warn ("boloss warning");
    of.echo ();

    var cmd = new Sys.Cmd ("ls -la");

    int status = cmd.run();
    of.action ("running cmd", cmd.name);
    of.echo ("\n%s".printf (cmd.output), true, true);

    of.state (status == 0);

    try {
        throw new MyError.CODE("this is the error message");
    }
    catch (MyError e) {
        of.error (e.message);
    }
    of.rs (true);
    of.rs (true, "ok");
    of.rs (false, "", "exit");

    of.echo();

    string com   = "Vala is syntactically similar to C# and includes several features such as: anonymous functions, signals, properties, generics, assisted memory management, exception handling, type inference, and foreach statements.[3] Its developers Jürg Billeter and Raffaele Sandrini aim to bring these features to the plain C runtime with little overhead and no special runtime support by targeting the GObject object system";
    string mycom = of.wordwrap (com, of.term_width-44);
    int    line  = mycom.split("\n").length;
    of.echo (mycom, true, true, ECHO.COMMENT, 40);

    of.usage_option ("quiet", "q", "SHUTUP", false, line);
    of.echo();

    of.echo (mycom, true, true, ECHO.COMMENT, 40);
    of.usage_option ("record-desktop", "r", "TIME", false, line);

    of.echo();
    Dbg.out (Log.METHOD, null, Log.LINE, Log.FILE);
    return 0;
}
+ valac --pkg pluie-echo-0.1 outputFormatter.vala

+

+
Namespace: Pluie +
+
Package: pluie-echo-0.1 +
+

Content:

+

Creation methods:

+ +

Methods:

+
    +
  • public weak Color c (ECHO name) + +
    get Color instance corresponding to ECHO color +
    • +
  • public string move_up (int line) + +
    get ansi escape sequence moving up lines +
    • +
  • public string move_down (int line) + +
    get ansi escape sequence moving down lines +
    • +
  • protected Color test (bool exp, bool error = false) + +
    +
    • +
  • public string s_indent (int8 adjust = 0) + +
    get an indentation only string +
    • +
  • protected string title_sep () + +
    +
    • +
  • public void title (string label, string? version = null, string? author = null) + +
    display a title +
    • +
  • public void action (string name, string? val = "") + +
    display an action +
    • +
  • public void warn (string label) + +
    display a warning +
    • +
  • public void error (string label, bool warn = false) + +
    display an error +
    • +
  • public void rs (bool test, string done = "done", string fail = "fail") + +
    display a test result +
    • +
  • public void echo_up (int line, string s) + +
    display a message up tp x lines +
    • +
  • public void echo (string? data = "", bool lf = true, bool indent_all = false, ECHO color = DEFAULT, int8 indent_adjust = 0) + +
    generic method to display messages +
    • +
  • public void state (bool test) + +
    display a state for specifiyed test +
    • +
  • public string wordwrap (string str, int width, bool cut = false) + +
    wordwrap paragraph +
    • +
  • public void usage_option (string? name = null, string? shortname = null, string? argname = null, bool val = false, int echo_up = 0) + +
    display usage option +
    • +
  • public void keyval (string key, string val) + +
    display a key value message +
    • +
+

Fields:

+
    +
  • public int indent + +
    number of space defining default indentation +
    • +
  • public int term_width + +
    max terminal with to considerate when printing messages +
    • +
  • protected ColorConf conf + +
    +
    • +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.indent.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.indent.html new file mode 100644 index 0000000..ffcc75d --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.indent.html @@ -0,0 +1,67 @@ + + + + + Pluie.OutputFormatter.indent – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.indent – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

indent

+
+

Description:

+
public int indent +
+
+

number of space defining default indentation

+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.keyval.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.keyval.html new file mode 100644 index 0000000..5b513ab --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.keyval.html @@ -0,0 +1,82 @@ + + + + + Pluie.OutputFormatter.keyval – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.keyval – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

keyval

+
+

Description:

+
public void keyval (string key, string val) +
+
+

display a key value message

+

Parameters:

+ + + + + + + + + +
key +

the key name

+
val +

the key value

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.move_down.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.move_down.html new file mode 100644 index 0000000..9e83252 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.move_down.html @@ -0,0 +1,76 @@ + + + + + Pluie.OutputFormatter.move_down – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.move_down – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

move_down

+
+

Description:

+
public string move_down (int line) +
+
+

get ansi escape sequence moving down lines

+

Parameters:

+ + + + + +
line +

number of line to move down

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.move_up.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.move_up.html new file mode 100644 index 0000000..4d50e34 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.move_up.html @@ -0,0 +1,76 @@ + + + + + Pluie.OutputFormatter.move_up – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.move_up – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

move_up

+
+

Description:

+
public string move_up (int line) +
+
+

get ansi escape sequence moving up lines

+

Parameters:

+ + + + + +
line +

number of line to move up

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.rs.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.rs.html new file mode 100644 index 0000000..fedc9d4 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.rs.html @@ -0,0 +1,88 @@ + + + + + Pluie.OutputFormatter.rs – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.rs – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

rs

+
+

Description:

+
public void rs (bool test, string done = "done", string fail = "fail") +
+
+

display a test result

+

Parameters:

+ + + + + + + + + + + + + +
test +

the result of test

+
done +

the done label to display if test succeed

+
done +

the fail label to display if test fail

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.s_indent.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.s_indent.html new file mode 100644 index 0000000..1a2436d --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.s_indent.html @@ -0,0 +1,76 @@ + + + + + Pluie.OutputFormatter.s_indent – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.s_indent – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

s_indent

+
+

Description:

+
public string s_indent (int8 adjust = 0) +
+
+

get an indentation only string

+

Parameters:

+ + + + + +
adjust +

number of space indentation adjustment

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.state.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.state.html new file mode 100644 index 0000000..8da7136 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.state.html @@ -0,0 +1,76 @@ + + + + + Pluie.OutputFormatter.state – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.state – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

state

+
+

Description:

+
public void state (bool test) +
+
+

display a state for specifiyed test

+

Parameters:

+ + + + + +
test +

the test result

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.term_width.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.term_width.html new file mode 100644 index 0000000..ac4b152 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.term_width.html @@ -0,0 +1,67 @@ + + + + + Pluie.OutputFormatter.term_width – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.term_width – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

term_width

+
+

Description:

+
public int term_width +
+
+

max terminal with to considerate when printing messages

+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.test.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.test.html new file mode 100644 index 0000000..812053b --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.test.html @@ -0,0 +1,64 @@ + + + + + Pluie.OutputFormatter.test – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.test – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

test

+
+

Description:

+
protected Color test (bool exp, bool error = false) +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.title.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.title.html new file mode 100644 index 0000000..db77731 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.title.html @@ -0,0 +1,88 @@ + + + + + Pluie.OutputFormatter.title – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.title – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

title

+
+

Description:

+
public void title (string label, string? version = null, string? author = null) +
+
+

display a title

+

Parameters:

+ + + + + + + + + + + + + +
label +

generally title of program

+
version +

version of program

+
author +

author of program

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.title_sep.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.title_sep.html new file mode 100644 index 0000000..6f54f88 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.title_sep.html @@ -0,0 +1,64 @@ + + + + + Pluie.OutputFormatter.title_sep – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.title_sep – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

title_sep

+
+

Description:

+
protected string title_sep () +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.usage_option.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.usage_option.html new file mode 100644 index 0000000..4a42f51 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.usage_option.html @@ -0,0 +1,100 @@ + + + + + Pluie.OutputFormatter.usage_option – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.usage_option – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

usage_option

+
+

Description:

+
public void usage_option (string? name = null, string? shortname = null, string? argname = null, bool val = false, int echo_up = 0) +
+
+

display usage option

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + +
name +

the option name

+
shortname +

the option shortname

+
argname +

the option argument

+
val +

specifyed optional value argument

+
echo_up +

line to move up on displaying option definition

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.warn.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.warn.html new file mode 100644 index 0000000..479a761 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.warn.html @@ -0,0 +1,76 @@ + + + + + Pluie.OutputFormatter.warn – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.warn – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

warn

+
+

Description:

+
public void warn (string label) +
+
+

display a warning

+

Parameters:

+ + + + + +
label +

the warn message to display

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.OutputFormatter.wordwrap.html b/doc/pluie-echo-0.1/Pluie.OutputFormatter.wordwrap.html new file mode 100644 index 0000000..7d65c9d --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.OutputFormatter.wordwrap.html @@ -0,0 +1,88 @@ + + + + + Pluie.OutputFormatter.wordwrap – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.OutputFormatter.wordwrap – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+
+

wordwrap

+
+

Description:

+
public string wordwrap (string str, int width, bool cut = false) +
+
+

wordwrap paragraph

+

Parameters:

+ + + + + + + + + + + + + +
str +

the paragraph to wordwrap

+
width +

maximum width of each lines

+
cut +

cur word rather than wordwrap [not implemented]

+
+
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Sys.Cmd.Cmd.html b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.Cmd.html new file mode 100644 index 0000000..89c02cd --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.Cmd.html @@ -0,0 +1,53 @@ + + + + + Pluie.Sys.Cmd.Cmd – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Sys.Cmd.Cmd – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+ +
+
+

Cmd

+
+

Description:

+
public Cmd (string name) +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Sys.Cmd.error.html b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.error.html new file mode 100644 index 0000000..0e6bdab --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.error.html @@ -0,0 +1,53 @@ + + + + + Pluie.Sys.Cmd.error – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Sys.Cmd.error – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+ +
+
+

error

+
+

Description:

+
public string error { get; } +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Sys.Cmd.html b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.html new file mode 100644 index 0000000..3918032 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.html @@ -0,0 +1,98 @@ + + + + + Pluie.Sys.Cmd – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Sys.Cmd – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+
    +
  • Cmd
    • +
+
+ +
+
+

Cmd

+
+

Object Hierarchy:

+ Object hierarchy for Cmd + + + + + +

Description:

+
public class Cmd +

+
Namespace: Pluie.Sys +
+
Package: pluie-echo-0.1 +
+

Content:

+

Properties:

+
    +
  • public string output { get; } + +
    +
    • +
  • public string error { get; } + +
    +
    • +
  • public string name { get; } + +
    +
    • +
  • public int status { get; } + +
    +
    • +
+

Creation methods:

+
    +
  • public Cmd (string name) + +
    +
    • +
+

Methods:

+
    +
  • public int run (bool display = false, string? name = null) + +
    +
    • +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Sys.Cmd.name.html b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.name.html new file mode 100644 index 0000000..20724d8 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.name.html @@ -0,0 +1,53 @@ + + + + + Pluie.Sys.Cmd.name – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Sys.Cmd.name – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+ +
+
+

name

+
+

Description:

+
public string name { get; } +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Sys.Cmd.output.html b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.output.html new file mode 100644 index 0000000..657f92e --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.output.html @@ -0,0 +1,53 @@ + + + + + Pluie.Sys.Cmd.output – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Sys.Cmd.output – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+ +
+
+

output

+
+

Description:

+
public string output { get; } +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Sys.Cmd.run.html b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.run.html new file mode 100644 index 0000000..80134be --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.run.html @@ -0,0 +1,53 @@ + + + + + Pluie.Sys.Cmd.run – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Sys.Cmd.run – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+ +
+
+

run

+
+

Description:

+
public int run (bool display = false, string? name = null) +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Sys.Cmd.status.html b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.status.html new file mode 100644 index 0000000..2210834 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Sys.Cmd.status.html @@ -0,0 +1,53 @@ + + + + + Pluie.Sys.Cmd.status – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Sys.Cmd.status – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+ +
+ +
+ +
+
+

status

+
+

Description:

+
public int status { get; } +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.Sys.html b/doc/pluie-echo-0.1/Pluie.Sys.html new file mode 100644 index 0000000..3889981 --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.Sys.html @@ -0,0 +1,47 @@ + + + + + Pluie.Sys – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie.Sys – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+ +
+
    +
  • Sys
    • +
+
+ +
+
+

Pluie.Sys

+
+

Description:

+

Content:

+

Classes:

+ +
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/Pluie.html b/doc/pluie-echo-0.1/Pluie.html new file mode 100644 index 0000000..b799cac --- /dev/null +++ b/doc/pluie-echo-0.1/Pluie.html @@ -0,0 +1,67 @@ + + + + + Pluie – pluie-echo-0.1 – Vala Binding Reference + + + +
Pluie – pluie-echo-0.1 Reference Manual
+
+
+ +
+ +
+
    +
  • Pluie
    • +
+
+ +
+
+

Pluie

+
+

Description:

+

Content:

+

Namespaces:

+ +

Classes:

+
    +
  • ColorConf - a Class representing a set of + Color mapping ECHO colors with values coming + from the specifyed ini config file
    • +
  • Color - a Class representing an Ansi Extended 8 bit Color + with foreground, background and bold attributes
    • +
  • OutputFormatter - A class managing display on + stdout & stderror with Color styles defined by specifiyed + ColorConf
    • +
+

Enums:

+
    +
  • ECHO - enumerate predefined + Color mapped to default config file see resources/echo.ini
    • +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/pluie-echo-0.1/img/Pluie.Color.png b/doc/pluie-echo-0.1/img/Pluie.Color.png new file mode 100644 index 0000000000000000000000000000000000000000..55a5226bf842df297453a493967b5a9b7e8f0894 GIT binary patch literal 1718 zcmah~c`(}v6#i)m;%=>CTUwNLw01+Qt|FqOwrG?(;%E?QRFtMl5ZXH0C@JbbvZzoh z?x?$BRTXvBMnxS#qb1JGvX0v9{IRjeOe;*N(bRK^fog@o#Sg&vPpxH_(^iy+~OavA2!3F@(U85y;{bZMJ&xzc(% z+3fO4Uo>lKI+0jVWt_WPfM0P>;0OtSuH$Ux4RTsdI3}#{YnG|fW${lAj07yOGEk>@ z>GJbGbfN3677t6uj1%Xs6b}!f>w0-tRVlK5XtauA(z`Y>q9p_Zk$wzAO|WCJ`ig+L zg@ph;Xu6<%S&$Umgp^lO0s(K$p6{J=cYwo1Cs?dw=k+@Cs@*D69Sl*3=a5*3^i#3r z;-{|pi4~F&GWggZf@_6YS;~NHdE9-;S9K;#sWjW5KYAh_3rNOmlYMe z3l|KBG0(VM?qo-_nL*Ih&xzd(5(zxP4fSk~%x-9CAob(~UAa?ITZ`CG^PhskH@Xs} z1Yb7%mm{QBR&M|*iG!y&TZfu^vEv3K$D@m|Tfz2oEZ186jj?It&r>pqHi zOjADhBl;eIqt@9%fH&uTzUXvE_@;WYvYF%zXClk{$4BmsxI!Au4x0#5SzKH+zjx1| z)l;|NViXto7$$5Fl>+9>i=iVfVZjF8XC<=_%`P+}=Nu4lKYm*c_ zgt>JKhDNJXsnoR{UcjyKY61Vjf;i`j{JT$lgZnbhSlZi5H8(d8jg1MFjy^87CNq|J zMI9YxUtW=(Qfjk$PBSt3kmHhfA|vy*R;NqtN`0K2<%B^X)XqSwNu_6-(aOlFpooKS zQOL;}pB~hk1{WP<4NBR`UHMnh6^@(4zM#QVp! zP0pZbz)s@@%Aj@WXm5Aov7>;lNAs`NWTjzr-TD%oGE7U@)fcY zAQ0#&g>q1}pKqrDoYdCVrbaPo9zYDge*@aMX6oc5vgGs+Z1NuU?dn$75)Xw!sjQg( z$(Xwtx;iB>!^v?z?d!W|qHk$w`4cxhJRFEwUS59oriAoNWWnT{O7M;WZ+B}Ih{5QS z%uhbWPx6+Ss-V;*GpoxKkHI_w%0|DW{*jxNbrSf>BfQ|gzJFNo zb$mQXQc|+EsVUp7G6UFNo3)JZx&eA?z18lPx=zBdigk&z)s z-1+^n5;=i?^vGIY(KB*lrb<$_wzjTLPTh3+`JH_tfBoG^Ed-v{;rl?Fr>?e^R@oRf zJ2SHHYLN4LRE$wfhP?rX}~?cfq67D=(|6$h(YF z^5P@2w}((Q)pUA>WWvK^XOT1W^S&cFsohb#e<3Ed!4oRI(x5uzWsd}9>k-2cdP9N z0AMe{8RseSd6I3l6C^p)TpWWX4iw^g6bEeoy^6cavjG4+LBQF2T`XKJq&a8LKnLoU zZrpwzk|8uyd^1cuWM}o#m`|Wj;$=S3B!5_|mAhUJH1acAyU^>kffpzu*2e zF;!OmsdPtmBovi@U5zy`M*JO3{9P;Kziua|olrZXBJC)Wjyp=DS_%>%-*@ktK$6a?;k(0ZU0qh0$pEs3?{DM+*7=9wz*y1PwH5EhGNd}~NoPcPZ!-nps@jc?nA^*kOgo1VzYbT6{q z4+yGHgfh>^#+n{Hm~3lnOAQa#ChU`wg8;`7IfE@VrKP3DR#uk>;;=8Krw6}%yI330 zRdBNA4<%+Q3~g&W+}MZ`Z*H0x8q%E1->CBaC^0#%xyZ4>L1t)ZsJeQ+@2%Q>2x>%KYaMtX*yB`3Oz%m8qA+Ve;11jTjNA4s>eJ%$$pnx z2VnP{yglxF$?o0Di4w+uqQC!w*5GovK+^CqQSU)iMr9>pTp&1v#X==X&%c7(+G>Ir z!R(x^!S%@s!SWpsU2;oVDJX(Ul?JG}7Z9LnZDV7C!DPm+3xii*wLInVlKqfHjRP@pu74PCnaV~U{{F0wAH&Bd zCW6<6U874e>FMct$64Lo-R+6nw&4*GpFh2IG_$mvd-~gNYV%^49157}bM9%e?3h`2Sr z_QbxztCH|oJyeO=k94n^Aa-EaxePFIqrb0D9(d5%>8IvSCYSL=mS=@9fPCuI5smDs zxI1_5NZT>ES{+Uifg}T^JzHB_=(9rW2iAJB7FEkZh@9Op6BO#|4Jh_*X{od%nl5Oe z-)nj?KA!UFQ)J{ja7Zk5ruz+rCAk3**FCi!-riu~lStIceA3@91q5_mnkU^p@0O5| zkQEVQorubpJ=dXLQc{B4nA?~5-ldxxlte7=9UUDl9Z|PTI62jLdQVb@&6V2Ow6SIE96!11jq3ROagIj%*;0!x<8ZE+{D}c_MQm0MzCZ zu4&3Gn}-8rWo2RLhW7hjh+Rn(3guz^cZ;UR#tKpuE&IpAht^`T*t48JB@U-hf;~Ls zb6gJV>+7Q}EXe$gzm|@{VX*q{ZlMx0J$*J)QGaFONSYjUVSsf2jlq13ajRXB0fQkx z&y~%PSa#`X*y>N}HOT92mM~X=-ksGe19XrXp({^)AJ*uDCeK zspK~dhi!FXrPvR7#?B7l^Z8TL(-F&c_4POH?d`{xH!fh@;1CH*j?kuCqvoIGTu)CA zI&}(WYHF%uNH1`MOAzK!L;7=ZtmOIAr?dH{XO5sysMWl(!SCV?eF;<21_|!&AC?7m zhxtB!e$-`sOUqmagJFO`H1@Nh*x_r}Kx;ESGa~uyW97upk}8q$+wcDZ-TE@6AmQ70 zV^TYEoe2bcJYFV=$1lL1%QE^FE&qS$%YREy{ueeWdDi>el12^vtfKOdGf@j1!bq8} zzP@8zT!*jknDn;IDU_;2jZD#N7c&%gk|8EM<$nv?PpQbSu}t|NT|eZsJjT&|rZKlA Pk`EB@L|m;y(A9qeu29GX literal 0 HcmV?d00001 diff --git a/doc/pluie-echo-0.1/img/Pluie.OutputFormatter.png b/doc/pluie-echo-0.1/img/Pluie.OutputFormatter.png new file mode 100644 index 0000000000000000000000000000000000000000..f633187e669c7461cf3007986abf68112f5b4892 GIT binary patch literal 2705 zcmai0c{J2*8~%~ds3@{8uUF;uMq?~f49RY?B}EHfTh=kw7ztBZUW5!@WF1N=W+G!O zW8c0(Br`M^V<{s0WJZ>JzyA3C`o43%^PJ~-&U4Ov&htF?b=}u}C0(^KKL(M8003|d zX<>2=+`GYv5ab8f{t}x!aN~EkG&cbbevOjmmze+nF+-XdUdI%yOa`Fr=?Vhtffr^E zr3E}mte62>l0MUfYu!mkJGxEL7ji}YL*Cs9K+xL1)-n%Oz7RyIu?|x9qnP^9C3hV8=efw$l)|XN#kHc)*l+sH z4P%#aB1S$Z&*}n-Xf2$W(I2N(;;!1+IXIX-ZodrFP&vh{O*VTmO!uCSNS4@elCkFUk$h2{ z<)lDQBde#)QCvSH9v5FH0zpC)#r|`l#Wg|v)8`^aib%ycBbT^MxpafH?i7hK3PtvOjt~&E`5B2~ z)Es{C;>9PD|JW;o1$?6Xqi**kZ6~0UddtNnZFbf@D=W)&Yl;4 z;1qAYIB6m#4gb2L0*M&QfA%bFx95xs?+Pumxw*LzsQ074{(Flck>1-`S*a?1>QwyX z!ADCdOiAhSp+kqtmbgO(2cJt#Q+kxTUhTBp-}37UuDxAlI3&liFp{&^>s8OPK%N-W zHbtY)10_vOh$011Qq>*u>{{!=@hGV}G*kCGhcmm+Wu-UTCU!n7E&Uxlr#a@1El;?r z#|5zap{=en9r6Df7?9;+dW>IrBriy&nL1^bR#hDX-UiKdJl!?e|86gNls^EcFE70G z?c2S(F|7*L*4CJfZi$VrW$AtaQ0K6Y+pDzITpwVf%E#QY_m2C>JBa2<6=PfXa^+2OMrnCP3T;xrnq&! z{<+%z;*CvB)t=OolBs4O$F<<_S%!D9shgW33N9nAdJ{W2=>(GT(@MCQgoKj5zFg?S zV0VU+d02H=SXjyP=X`WJ9rN?YLN#W?eQ)O*(JftNGB_cB&Z4^5AokMiMN`xL+lEJT zY|myUT`EqGj*k8neS`F|auD za%3euF%_n-UnnIdbt2tkywGFWw5J#s)-M`<_69bZ@q#E+2u}Xz^qKZ7#S5P4PPj>b&nk+z< ziCjN?_^_dJ!tHVwV{%EI$_7Uv<{(j?q z{HPj(!7yawii!wl+%HE*>$mQ0TH-o|4k#2on`c@ov#^T0!vn$fpUO_CsC2Zv_fUmE zAnOx>t*PEQz#}4FSmDx>rqxEF-gE_p8wTw8_mAm*-ED2aHGBKV9N}Zf+P{S0-@a8Z z$MF27=(gSWJq@w?q0fQfl$0uSVU|{5591QASXsqUJv$PP$pClvRLVZgEmeS49ur^=Xi03eAF@w=;T@%`TF}m9$FA;;!nO29uCLOMEG_0 zgH?NUn)O^SdZ!j0>&jDv!<{5cj*pKA4e4`#gF=M^TYj9y;c#Zm-kS>;y(gB})Dy@* z1ZwvCvd;ktfA!3VHz{!t5vxuCC*U8GM3vuq^d4Uc+-lA2c5nZ_II;oOOZ+l7)AmyP z6DiHB&d&Nv+oeBjKe1TCz|F=m5H)knsfU4afvx)vjxn6&Th2!});oltu0B43{W(y9 z^)(?5LEA;CzqD|!{wk5Ao}k?ga{ma{tPJMfoFW1BOCe!FHRqk4f1l479&S%a;I}E% z%?7ra5v<___VC<>2=K0^#^N}OuRuQv&J(mUPC}tjpJf6mhVK}aYPGD$1-bI_@|t(= z>?MptLp8zR?O}5T-wSJdF$OZy(zzKK?O?L)91WgruTt1HHbr`Q-h&0h0(Gjt3=B}INf$@i3qxR6(7g98xv%evxVX3Bu6ucTh3xNaEiWz(Un1i1 z56#LlyoZX8C3i1|)let}Zyc)Jk;o&KSFY5%b@Del5lR}zlGirB^jB6?%z)5t(;ffv zUExJm2TZ^@9L~otAsb*Bj#y9M+(G;L&Ww}%NgJ;Sg!$nzbK}9(-Z^}?JD!2^0!3F% zT!@Tfbbx4&eB0VwA+ttzZnehfr^_MAQ-^v|WsYFUlOaOFvKQOHMpTrPl*HGToDAV? zZEbW48_>qb==5qbIp=f(NW8Pk%It>%@+I%R=D-ZJ(P-BRP7OFvR~38DUB6YYlO`5b zOXw%s8bN7L%h?{7TSRSqy%h3V7joKBlsJZH&-i;7_gvB&tgn1{z@yF?0J!epkPzKO zs)wb1dyn8bedY|lu1=gpB8kc+ODg>+|3Ciae;J(XOQJ|YHbIWzxl2TkJ=jF65|vKO zdX*Qk4TtQP$4Np>5o>9SByFQfRnUgH!SnCk16%G_SpWb4 literal 0 HcmV?d00001 diff --git a/doc/pluie-echo-0.1/img/Pluie.Sys.Cmd.png b/doc/pluie-echo-0.1/img/Pluie.Sys.Cmd.png new file mode 100644 index 0000000000000000000000000000000000000000..ae175025ff40fba1803afb8cc648dc3e661b274f GIT binary patch literal 2485 zcma);`#+QYAIC3;98)U_FW3A1x?Zp6=kupC#$HZFSq1e(v#pYTP+*?P{;Or4XnFB*>vvX4cImso5y(M0yM%ZtD7pKSVf&169@xM} zPHEmfjENU>V|$y85R7J&N4pJuVo9>pEUv_rA_NG5+5GkQ)FWsq@zd9XmjUs_!`6nP z94WTctc^-`P7cjkQ_2eBq6mR>rKQPelMH_&-MM4aEUD$tt91fXTsxSm9u^!N3;?n5 z@d0n{LmNku87cXCevfNw_W@Wqxq4Cg&mQa8SmVq?h!2eqq)l~tv()l!1JY3`yXxd0 z%fCUUB9Ev*mH!A!2^Rks8=KXSX>@uDhSDiq<0n#lIvB&l!!P=bVF#EEp`)j6ef89Y z$QT3WpykD=Skp2-(^J#Wraia^&ik^w7Q@8_y27Fluj}+G0BD*8RbVrMD+Lfhk->* zFHJP5n%vM36BVV7@;L(oR@sJRW`AGbVf>O8A^LZRH@mdKw)p{!6S6nT@$ zWZGT649$c2e3*sk-9|7G)2FfDXVJoqje(Jo+{(&IkEOPUrCZzED(3L;@b{(Wp~Kha`U^c~LJXB}@js9n z8XA~Ag@uLan3x#RN3OKlQuFxW(}nbLy6?+uAa z{^&FJs*z%on@=DU<@Q-)G&f3S;gF}pJgbDaw8R9p&&$m{6C&7VHW`hMk1H!H(}lb> z;qfe=Vhg;G_`EG%ka=^Sm7B@$>grnQB<^*^pFh9FCmWi48pX*RfO=|ay_Y*ByJ3G6Di6*@br&W(*aQHfL1{CA#r&g8j z?(UWKb>yW>hx2qVYK_F-zHMDKa@4>;;n}5DQ8WYs!G8QZ(v@r;zuw;6y-W6>Zi;tx z4@jY@xw)WGKW-adBw^y##z?3HaN)uzGThAE+{MR7o5Ol&xffXZ@uNP3|9RkclQ8R} zJovMbad9sv z@nu;;b=P;2aBI^b>6*6cJ0l7$(#G1l!geG6+hjAb1QFwq=#%aFd7{bi*s;n7RM1^h zU%uRpn0)2MIj^;Uj#ZN08ZS7it}cc~qdnHZQju0x0ILK+RJYG;$DM|rIWtnT%p0Nv z3_SXMtPPL2#2|zViWd2NGNeRRr>ecBrR6}@h(_a0B?6QZCtN)#GSJ&g;oORjj&?nL z1*)r?2^16+^-1nMe4YQHdJySOAXtFjmy-|^skP5KticHXO}M!!4}fecC@Ep)YF}_I zXQSe}Uq$mb-dpa}wzL#$c=`A^0>xnd`#tAfG^ZQ*8hoE_H;d5re-WFzNY%DD;ON}Fw{TPH?i=5`kAhi05t;%<9St7Oa(oRF{>JSy)_j0208k)(hTPlaIf? z-CCM+;#{5(Ea3g(G|Y^!Rp4Fi5t3h8$`UMd>*@52kcJ`W(+I@;PZD^r~&cwyAs z>}>6;S4HpgU^&8YPTgHF&^mg0^C{8_RCg`jmoMF3^+Epu0iMmM_GudI?Ir46YPlZ< zhV%q*J2v)|sc8`iyWM;DUI81-89k_=5D?R(2-w)zyo{VdV#sikzP|pT-1B*|1}N{) z;Gi*KD|Y?cBzar7Hj^YG_P2kxOqCM@Jf3yEU!(#Hv$I{G$yY!~4a%UZMnI^iDJdxp z&evTXI{qua8gU@W_Z%|)OIKHSRUnw}A*m?I%XgUEoLiahPA7S!uW!JrC_6{hED1Q! zH2lTIal~I-O!Jb|4)5!DgRFP;0Z@XaLk`5pZ`FVeA2xrjz&swFfmH7gGWf=2a6dt# zjk|Js?$umuevLiV-q9gqpQ-vgh?ogP#U5hp;Mf2oG0_Y!e9_vuFpzqJWCj2Kl>?`4 ztA3xf@84`#G+qmvGWy3+(dD0v@0~^hUtixar(}kzkCWl;hsU+GWx+EPW}0_&V|gD0 zB2GdE1iCp>ZH_2Bkdpo1SJabcmJX$Sem|YKIjs?(XmQXVyoUj3JB)3OH8%ObK>^32 literal 0 HcmV?d00001 diff --git a/doc/pluie-echo-0.1/index.htm b/doc/pluie-echo-0.1/index.htm new file mode 100644 index 0000000..9ac76dc --- /dev/null +++ b/doc/pluie-echo-0.1/index.htm @@ -0,0 +1,135 @@ + + + + + pluie-echo-0.1 – Vala Binding Reference + + + +
pluie-echo-0.1 Reference Manual
+
+
+ +
+
    +
  • pluie-echo-0.1
    • +
+
+ +
+
+

pluie-echo-0.1

+
+

Description:

+

Content:

+

Namespaces:

+
    +
  • Pluie
    • +

    Classes:

    +
      +
    • ColorConf - a Class representing a set of + Color mapping ECHO colors with values coming + from the specifyed ini config file
      • +
    • Color - a Class representing an Ansi Extended 8 bit Color + with foreground, background and bold attributes
      • +
    • OutputFormatter - A class managing display on + stdout & stderror with Color styles defined by specifiyed + ColorConf
      • +
    +

    Enums:

    +
      +
    • ECHO - enumerate predefined + Color mapped to default config file see resources/echo.ini
      • +
    +
  • Dbg
    • +

    Constants:

    +
      +
    • public const int8 DBG_ERROR + +
      type log error +
      • +
    • public const int8 DBG_WARN + +
      type log warn +
      • +
    +

    Methods:

    +
      +
    • public void init (OutputFormatter of, bool debug = false) + +
      initialize logging +
      • +
    • public void @in (string method, string? @params = null, int line = 0, string? file = null) + +
      log method entering +
      • +
    • public void @out (string method, string? @params = null, int line = 0, string? file = null) + +
      log method leaving +
      • +
    • public void msg (string msg, int line = 0, string? file = null) + +
      log a message +
      • +
    • public void error (string msg, string method, int line = 0, string? file = null, int8 mode = DBG_ERROR) + +
      log error +
      • +
    +

    Fields:

    +
      +
    • public bool DBG_ENABLED + +
      enable/disable log messages +
      • +
    +
  • Echo
    • +

    Constants:

    +
      +
    • protected const unowned string INSTALL_PATH + +
      +
      • +
    • protected const unowned string DATA_PATH + +
      +
      • +
    • protected const unowned string VERSION + +
      +
      • +
    +

    Methods:

    + +

    Fields:

    + +
  • Sys
    • +

    Classes:

    + +
+
+

+
Generated by Valadoc +
+ + \ No newline at end of file diff --git a/doc/preview.svg b/doc/preview.svg new file mode 100644 index 0000000..dcbbd80 --- /dev/null +++ b/doc/preview.svg @@ -0,0 +1,135 @@ + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + Valadoc + Valadoc + diff --git a/doc/property.svg b/doc/property.svg new file mode 100644 index 0000000..724345d --- /dev/null +++ b/doc/property.svg @@ -0,0 +1,126 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/scripts.js b/doc/scripts.js new file mode 100644 index 0000000..94b15b0 --- /dev/null +++ b/doc/scripts.js @@ -0,0 +1,56 @@ +/* markupwriter.vala + * + * Copyright (C) 2008-2009 Florian Brosch + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + * + * Author: + * Florian Brosch + */ + +function get_path (path) { + var pos = path.lastIndexOf ('/'); + if (pos < 0) { + return ''; + } + + return path.substring (pos, -1) + '/'; +} + +function toggle_box (self, id) { + var element = document.getElementById (id); + if (element == null) { + return ; + } + + var style = self.currentStyle || window.getComputedStyle (self, false); + var orig_path = /url[ \t]*\(('(.*)'|"(.*)")\)/.exec (style.backgroundImage)[1].slice(1, -1); + var orig_dir = get_path (orig_path); + if (element.style.display == 'block') { + element.style.display = 'none'; + self.style.backgroundImage = "url('" + orig_dir + 'coll_open.svg' + "')"; + } else { + element.style.display = 'block'; + self.style.backgroundImage = "url('" + orig_dir + 'coll_close.svg' + "')"; + } +} + +window.onload = function() { + var nav = document.querySelector('.site_navigation'); + nav.innerHTML = '
'+nav.innerHTML+'
'; + var header = document.querySelector('.site_header'); + var data = header.innerHTML.split("–"); + header.innerHTML = data[0] + (data[1] ? '
'+data[1]+'
' : ''); +} diff --git a/doc/signal.svg b/doc/signal.svg new file mode 100644 index 0000000..210ea33 --- /dev/null +++ b/doc/signal.svg @@ -0,0 +1,116 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/staticmethod.svg b/doc/staticmethod.svg new file mode 100644 index 0000000..a251483 --- /dev/null +++ b/doc/staticmethod.svg @@ -0,0 +1,163 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/struct.svg b/doc/struct.svg new file mode 100644 index 0000000..56a0e2d --- /dev/null +++ b/doc/struct.svg @@ -0,0 +1,148 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/style.css b/doc/style.css new file mode 100644 index 0000000..8782a82 --- /dev/null +++ b/doc/style.css @@ -0,0 +1,2 @@ +@import url('https://fonts.googleapis.com/css?family=family=Open+Sans:300,400%7CDroid+Serif:400%7CRoboto+Mono:400,500,700,400italic'); +*{font-family:"Open Sans","Droid Sans",Helvetica,sans-serif}a{outline:none!important}h2,h3{font-family:"Droid Serif",serif;font-weight:300}h3{font-size:15px;font-weight:300}body{margin:0}.main_optional_parameter{font-style:italic}.main_diagram{border-style:none;display:block;margin:0 auto}.site_navi{text-align:right}.main_notification{padding-right:10px;padding-left:60px;padding-bottom:5px;padding-top:5px;border-color:#aaf;background-color:#eef;border-style:solid;border-width:1px;margin:10px;min-height:48px;background-position:6px .5em;background-repeat:no-repeat;background-image:url(warning.svg)}.main_table{border-collapse:collapse;border:1px solid #aaf;background:#eef;margin-right:auto;margin-left:auto}.main_source,.main_sourcesample{background-color:#FAFAFA;border-radius:6px;font-family:"Roboto Mono",monospace;margin:12px;padding:12px}input{border-color:#aaf;border-style:solid;border-width:1px}.site_header{align-items:center;background-color:#403757;box-shadow:0 1px 3px rgba(0,0,0,.12),0 1px 2px rgba(0,0,0,.24);display:flex;font-size:24px;justify-content:space-between;padding:9px 6px;position:fixed;top:0;width:100%;z-index:1000;color:white}div{font-size:14px}.site_title{text-align:left;font-size:40px}div.site_footer{position:fixed;bottom:0;text-align:center;padding-bottom:5px;padding-top:5px;width:100%;background-color:#fafafa}div.site_body{font-size:10;margin-top:50px}#nav_content{overflow:auto;position:fixed;height:100%;width:240px;font-size:16px;background-color:#f7f6f8}div.site_navigation{float:left;width:240px;border-color:#eceaf0;border-style:solid;border-width:1px;margin-bottom:40px;background-color:#f7f6f8}.site_content{font-size:14px;margin-left:300px;margin-right:5px;padding-top:20px;text-align:left}.main_type{text-decoration:none;font-style:italic;color:#000}.main_basic_type{text-decoration:none;font-weight:700;color:#2B9C5D}.main_keyword{text-decoration:none;font-weight:700;color:brown}.main_escape{text-decoration:none;color:#6a5acd}.xml_cdata{text-decoration:none;font-weight:400;color:#a020f0}.xml_escape{text-decoration:none;font-weight:400;color:#a020f0}.xml_element{text-decoration:none;font-weight:400;color:#008a8c}.xml_attribute{text-decoration:none;font-weight:700;color:#6a5acd}.xml_attribute_value{text-decoration:none;font-weight:400;color:#f0f}.xml_comment{text-decoration:none;font-weight:400;color:#0202ff}.main_source .main_literal{text-decoration:none;color:#2ba199}.main_comment{text-decoration:none;color:#888a85}.main_preprocessor{text-decoration:none;color:#ad7fa8}div.main_code_definition{background-color:#eee;border-radius:6px;font-family:"Roboto Mono",monospace;margin:12px;padding:12px}div.main_notification_block{padding-right:10px;padding-left:10px;padding-bottom:5px;padding-top:5px;border-color:#d08717;background-color:#fbf2c3;border-style:solid;border-width:1px;margin:10px}span.main_block_headline{background-image:url(tip.svg);background-repeat:no-repeat;background-position:center right;font-weight:700;display:block}div.main_block_content{margin-left:15px}span.leaf_code_definition{font-family:"Roboto Mono",monospace;font-size:15px;font-weight:200}div.leaf_brief_description{display:block;margin-left:40px}h1.main_title{font-size:20px;margin-bottom:0}h2.main_title{margin-bottom:0}h3.main_title{margin-bottom:0}.main_hr{border:0;color:#b4a0c1;background-color:#b4a0c1;height:1px;margin-top:6px;margin-bottom:6px}.main_parameter_table_unknown_parameter{color:GREY}.main_parameter_table_name,.main_errordomain_table_name,.main_enum_table_name{vertical-align:top;text-align:right;font-weight:700;width:120px;padding-right:10px}.main_parameter_table,.main_errordomain_table,.main_enum_table{margin-weight:20px;margin-left:20px}.description a.constant,.brief_description a.constant{background-image:url(constant.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.namespace,.brief_description a.namespace{background-image:url(namespace.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.struct,.brief_description a.struct{background-image:url(struct.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.interface,.brief_description a.interface{background-image:url(interface.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.enum,.brief_description a.enum{background-image:url(enum.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.errordomain,.brief_description a.errordomain{background-image:url(errordomain.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.delegate,.brief_description a.delegate{background-image:url(delegate.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.signal,.brief_description a.signal{background-image:url(signal.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.field,.brief_description a.field{background-image:url(field.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.enumvalue,.brief_description a.enumvalue{background-image:url(enumvalue.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.errorcode,.brief_description a.errorcode{background-image:url(errorcode.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.class,.brief_description a.class{background-image:url(class.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}a.abstract_class,.description a.abstract_class,.brief_description a.abstract_class{background-image:url(abstractclass.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0;font-style:italic}.description a.property,.brief_description a.property{background-image:url(property.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.virtual_property,.brief_description a.virtual_property{background-image:url(virtualproperty.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.abstract_property,.brief_description a.abstract_property{background-image:url(abstractproperty.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.method,.brief_description a.method{background-image:url(method.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.static_method,.brief_description a.static_method{background-image:url(staticmethod.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}a.virtual_method,.description a.virtual_method,.brief_description a.virtual_method{background-image:url(virtualmethod.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.abstract_method,.brief_description a.abstract_method{background-image:url(abstractmethod.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.creation_method,.brief_description a.creation_method{background-image:url(constructor.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.navi_main li,.navi_inline li{background-image:url(method.svg);background-repeat:no-repeat!important;background-position:left center!important;background-color:transparent;vertical-align:middle;list-style-type:none;margin:0;padding:0 0 0 20px;transition:all 0.5s ease-out}.navi_inline li{background-position:left 12px!important;padding:10px 0 10px 20px}.navi_main li.errorcode,.navi_inline li.errorcode{background-image:url(errorcode.svg)}.navi_main li.enumvalue,.navi_inline li.enumvalue{background-image:url(enumvalue.svg)}.navi_main li.abstract_class,.navi_inline li.abstract_class{background-image:url(abstractclass.svg)}.navi_main li.abstract_method,.navi_inline li.abstract_method{background-image:url(abstractmethod.svg)}.navi_main li.creation_method,.navi_inline li.creation_method,.main_list_m{background-image:url(constructor.svg)}.navi_main li.static_method,.navi_inline li.static_method{background-image:url(staticmethod.svg)}.navi_main li.package_index{background-image:url(packages.svg)}.navi_main li.virtual_method,.navi_inline li.virtual_method{background-image:url(virtualmethod.svg)}.navi_main li.errordomain,.navi_inline li.errordomain,.main_list_errdom{background-image:url(errordomain.svg)}.navi_main li.namespace,.navi_inline li.namespace,.main_list_ns{background-image:url(namespace.svg)}.navi_main li.method,.navi_inline li.method{background-image:url(method.svg)}.navi_main li.struct,.navi_inline li.struct,.main_list_stru{background-image:url(struct.svg)}.navi_main li.interface,.navi_inline li.interface,.main_list_iface{background-image:url(interface.svg)}.navi_main li.field,.navi_inline li.field,.main_list_field{background-image:url(field.svg)}.navi_main li.class,.navi_inline li.class,.main_list_cl{background-image:url(class.svg)}.navi_main li.enum,.navi_inline li.enum,.main_list_en{background-image:url(enum.svg)}.navi_main li.property,.navi_inline li.property,.main_list_prop{background-image:url(property.svg)}.navi_main li.abstract_property,.navi_inline li.abstract_property{background-image:url(abstractproperty.svg)}.navi_main li.virtual_property,.navi_inline li.virtual_property{background-image:url(virtualproperty.svg)}.navi_main li.delegate,.navi_inline li.delegate,.main_list_del{background-image:url(delegate.svg)}.navi_main li.signal,.navi_inline li.signal,.main_list_sig{background-image:url(signal.svg)}.navi_main li.package,.navi_inline li.package{background-image:url(package.svg)}.navi_main li.constant,.navi_inline li.constant{background-image:url(constant.svg)}.navi_main{margin-top:10px;margin-bottom:10px;padding-left:5px}.navi_main:last-child{padding-left:5px}.navi_hr{background-color:#dedede;border:0;border-top-width:0;border-bottom-width:0;border-top-style:none;border-bottom-style:none;border-top-color:currentcolor;border-bottom-color:currentcolor;border-bottom:1px solid #fff;border-top:1px solid #dedede;height:0;margin:6px 0}.navi_main a{text-decoration:none;color:#887E9C;line-height:26px;width:100%;display:inline-block;padding-left:0}a,.navi_inline a,a.external_link{text-decoration:none;color:#50A3BE;transition:all 0.5s ease-out}.navi_main li:hover{background-color:rgba(0,0,0,.1)}div.site_content .navi_main li:hover{background-color:transparent}a:hover,.navi_inline a:hover,a.external_link:hover,div.site_content .navi_main li a:hover{text-decoration:underline;color:#6A6576}.navi_main li:hover a{text-decoration:none}.navi_main .abstract_class>a,.navi_inline .abstract_class>a{font-style:italic}a.navi_link:hover,a.external_link:hover{text-decoration:underline}ul.no_bullet li{list-style-type:none}.navi_inline{}.css_content_literal{font-family:monospace;color:#ff01ff}code{font-family:monospace}.main_code_definition a,.leaf_code_definition a{text-decoration:none;color:inherit}.main_code_definition a:hover,.leaf_code_definition a:hover{text-decoration:underline}.box .headline{background-image:url(coll_open.svg);background-position:calc(100% - 1px) center;background-repeat:no-repeat;background-color:#eef;border-color:#aaf;border-style:solid;border-width:1px;margin:auto;width:90%;margin-top:20px;font-weight:700}.box .content{border-color:#aaf;border-width:0 1 1 1;border-style:solid;overflow:auto;display:none;margin:auto;width:90%}.box .column{float:left;width:33%}.package_note{}.deprecated{text-decoration:line-through} diff --git a/doc/tip.svg b/doc/tip.svg new file mode 100644 index 0000000..0effdb1 --- /dev/null +++ b/doc/tip.svg @@ -0,0 +1,50 @@ + + + + + + + image/svg+xml + + + + + + + + + + + + + diff --git a/doc/video.svg b/doc/video.svg new file mode 100644 index 0000000..bdd25b4 --- /dev/null +++ b/doc/video.svg @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + + + diff --git a/doc/virtualmethod.svg b/doc/virtualmethod.svg new file mode 100644 index 0000000..ec720df --- /dev/null +++ b/doc/virtualmethod.svg @@ -0,0 +1,163 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/virtualproperty.svg b/doc/virtualproperty.svg new file mode 100644 index 0000000..a115d6d --- /dev/null +++ b/doc/virtualproperty.svg @@ -0,0 +1,138 @@ + + + + + + image/svg+xml + + elementary Symbolic Icon Theme + + + + elementary Symbolic Icon Theme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/warning.svg b/doc/warning.svg new file mode 100644 index 0000000..180f361 --- /dev/null +++ b/doc/warning.svg @@ -0,0 +1,118 @@ + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/wikistyle.css b/doc/wikistyle.css new file mode 100644 index 0000000..459f91a --- /dev/null +++ b/doc/wikistyle.css @@ -0,0 +1,547 @@ +ul.external_link { +} + +.main_optional_parameter { + font-style: italic; +} + +.main_diagram { + border-style: none; + display: block; + margin: 0px auto; + width: 100px; +} + +.site_navi { + text-align: right; +} + +.main_notification { + padding-right: 10px; + padding-left: 60px; + padding-bottom: 5px; + padding-top: 5px; + border-color: #aaaaff; + background-color: #eeeeff; + border-style: solid; + border-width: 1px; + margin: 10px; + min-height: 48px; + background-position: 6px 0.5em; + background-repeat: no-repeat; + background-image: url(warning.png); +} + +div.main_notification_block { + padding-right: 10px; + padding-left: 10px; + padding-bottom: 5px; + padding-top: 5px; + + border-color: #d08717; + background-color: #fbf2c3; + border-style: solid; + border-width: 1px; + margin: 10px; +} + +span.main_block_headline { + background-image:url(tip.png); + background-repeat:no-repeat; + background-position:center right; + font-weight:bold; + display:block; +} + +div.main_block_content { + margin-left:15px; +} + +.main_source, .main_sourcesample { + padding-right: 10px; + padding-left: 5px; + padding-bottom: 5px; + padding-top: 5px; + margin: 10px; + + border-color: #aaaaff; + background-color: #eeeeff; + border-style: solid; + border-width: 1px; +} + +input { + border-color: #aaaaff; + border-style: solid; + border-width: 1px; +} + +.main_table { + border-collapse: collapse; + border: 1px solid #aaaaff; + background: #eeeeff; + margin-right:auto; + margin-left:auto; +} + +.site_header { + font-size: 25px; + padding-bottom: 10px; + padding-top: 10px; + background-color: #aaaaff; + width: 100%; +} + + +div { + font-family:'Verdana'; + font-size: 12; +} + + +.site_title { + text-align: left; + font-size: 40; +} + +div.site_footer { + text-align: center; + background-color: #aaaaff; + padding-bottom: 5px; + padding-top: 5px; + width: 100%; + clear: left; +} + + +div.site_body { + font-size: 10; +} + + +div.site_navigation { + float: left; + + width: 240px; + border-color: #aaaaff; + border-style: solid; + border-width: 1px; + background-color: #eeeeff; +} + + +.site_content { + font-size: 12px; + margin-left: 5px; + margin-right: 5px; + text-align: left; +} + + +.main_type { + text-decoration: none; + font-style: italic; + color: #000000; +} + +.main_basic_type { + text-decoration: none; + font-weight: bold; + color: #2e8b57; +} + +.main_keyword { + text-decoration: none; + font-weight: bold; + color: #a52a2a; +} + +.main_source .main_literal { + text-decoration: none; + color: #ff0000; +} + +.main_comment { + text-decoration: none; + color: #888a85; +} + +.main_preprocessor { + text-decoration: none; + color: #ad7fa8; +} + +div.main_code_definition { + padding-right: 10px; + padding-left: 10px; + padding-bottom: 5px; + padding-top: 5px; + + font-family: monospace; + font-size: 10; + border-color: #aaaaff; + background-color: #eeeeff; + border-style: solid; + border-width: 1px; + margin: 10px; +} + + + + + +h1.main_title { + font-size: 20px; + margin-bottom: 0px; +} + +h2.main_title { + margin-bottom: 0px; +} + +h3.main_title { + margin-bottom: 0px; +} + +.main_hr { + border: 0; + color: #aaaaff; + background-color: #aaaaff; + height: 1px; + margin-top: 5px; + margin-bottom: 5px; +} + + + +.main_parameter_table_text, .main_errordomain_table_text, .main_enum_table_text { +} + +.main_parameter_table_unknown_parameter { + color: GREY; +} + +.main_parameter_table_name, .main_errordomain_table_name, .main_enum_table_name { + vertical-align: top; + text-align: right; + font-weight: bold; + width: 120px; + padding-right: 10px; +} + +.main_parameter_table, .main_errordomain_table, .main_enum_table { + margin-weight: 20px; + margin-left: 20px; +} + + + + +.main_inline_navigation_virtual_property { + list-style-image: url(virtualproperty.png); +} +.main_inline_navigation_abstract_property { + list-style-image: url(abstractproperty.png); +} +.navi_abstract_prop { + list-style-image: url(abstractproperty.png); +} +.navi_virtual_prop { + list-style-image: url(virtualproperty.png); +} + + + +.css_content_link_constant { + background-image:url(constant.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_namespace { + background-image:url(namespace.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_struct { + background-image:url(struct.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_interface { + background-image:url(interface.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_enum { + background-image:url(enum.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_errordomain { + background-image:url(errordomain.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_delegate { + background-image:url(delegate.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_signal { + background-image:url(signal.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_field { + background-image:url(field.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_enumvalue { + background-image:url(enumvalue.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_errorcode { + background-image:url(errorcode.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_class { + background-image:url(class.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_abstract_class { + background-image:url(abstractclass.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_property { + background-image:url(property.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_virtual_property { + background-image:url(virtualproperty.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_abstract_property { + background-image:url(abstractproperty.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_method { + background-image:url(method.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_static_method { + background-image:url(staticmethod.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_virtual_method { + background-image:url(virtualmethod.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_abstract_method { + background-image:url( abstractmethod.png ); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} +.css_content_link_construction_method { + background-image:url(constructor.png); + display:inline-block; + padding-right:17px; + background-repeat:no-repeat; + background-position:center right; + border:0px; +} + +.main_inline_navigation_virtual_method { + list-style-image:url(virtualmethod.png); +} +.main_inline_navigation_errorcode { + list-style-image:url(errorcode.png); +} +.main_inline_navigation_enumvalue { + list-style-image:url(enumvalue.png); +} +.navi_abstract_class, .main_inline_navigation_abstract_class { + list-style-image: url(abstractclass.png); +} +.main_inline_navigation_abstract_method, .navi_abstract_method { + list-style-image: url( abstractmethod.png ); +} +.navi_construction_method, .main_list_m, .main_inline_navigation_construction_method { + list-style-image: url(constructor.png); +} +.navi_static_method, .main_inline_navigation_static_method { + list-style-image: url(staticmethod.png); +} + +.navi_package_index, .main_inline_navigation_package { + list-style-image: url(packages.png); +} +.main_navi_enval { + list-style-image: url(enumvalue.png); +} +.main_navi_errdomcode { + list-style-image: url(errorcode.png); +} +.navi_error_domain, .main_list_errdom, .main_inline_navigation_errordomain { + list-style-image: url(errordomain.png); +} +.navi_namespace, .main_list_ns, .main_inline_navigation_namespace { + list-style-image: url(namespace.png); +} +.navi_method, .main_inline_navigation_method { + list-style-image: url(method.png); +} +.navi_virtual_method { + list-style-image: url(virtualmethod.png); +} +.navi_struct, .main_list_stru, .main_inline_navigation_struct { + list-style-image: url(struct.png); +} +.navi_iface, .main_navigation_interface, .main_list_iface { + list-style-image: url(interface.png); +} +.navi_field, .main_inline_navigation_fields, .main_list_field { + list-style-image: url(field.png); +} +.navi_class, .main_inline_navigation_class, .main_list_cl { + list-style-image: url(class.png); +} +.navi_enum, .main_list_en, .main_inline_navigation_enum { + list-style-image: url(enum.png); +} +.navi_prop, .main_inline_navigation_property, .main_list_prop { + list-style-image: url(property.png); +} +.navi_del, .main_list_del, .main_inline_navigation_delegate { + list-style-image: url(delegate.png); +} +.navi_sig, .main_inline_navigation_signal, .main_list_sig { + list-style-image: url(signal.png); +} +.navi_package, .main_inline_navigation_package { + list-style-image: url(package.png); +} + +.main_inline_navigation_constant, .navi_constant { + list-style-image: url(constant.png); +} + + +.navi_main { + margin-top: 10px; + margin-bottom: 10px; + padding-left: 30px; +} + +.navi_hr { + border: 0; + color: #aaaaff; + background-color: #aaaaff; + height: 1px; + margin-left: 10px; + margin-right: 10px; + margin-top: 5px; + margin-bottom: 5px; +} + +a.navi_link, a.external_link { + text-decoration: none; + color: #214b87; +} + +a.navi_link:hover, a.external_link:hover { + text-decoration: underline; +} + +ul.no_bullet li { + list-style-type: none; +} + +.main_see_list { +} + +.main_inline_navigation { +} + +.css_content_literal { + font-family: monospace; + color: #ff01ff; +} + +code { + font-family: monospace; +} + +.deprecated { + text-decoration:line-through; +} diff --git a/install.vala.in b/install.vala.in index ee82108..2b61e5c 100644 --- a/install.vala.in +++ b/install.vala.in @@ -1,7 +1,7 @@ namespace Pluie { namespace Echo - { + { protected const string INSTALL_PATH = "@INSTALL_PATH@"; protected const string DATA_PATH = "@DATA_PATH@"; protected const string VERSION = "@VERSION@"; diff --git a/resources/doc-scripts.js b/resources/doc-scripts.js new file mode 100644 index 0000000..94b15b0 --- /dev/null +++ b/resources/doc-scripts.js @@ -0,0 +1,56 @@ +/* markupwriter.vala + * + * Copyright (C) 2008-2009 Florian Brosch + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + * + * Author: + * Florian Brosch + */ + +function get_path (path) { + var pos = path.lastIndexOf ('/'); + if (pos < 0) { + return ''; + } + + return path.substring (pos, -1) + '/'; +} + +function toggle_box (self, id) { + var element = document.getElementById (id); + if (element == null) { + return ; + } + + var style = self.currentStyle || window.getComputedStyle (self, false); + var orig_path = /url[ \t]*\(('(.*)'|"(.*)")\)/.exec (style.backgroundImage)[1].slice(1, -1); + var orig_dir = get_path (orig_path); + if (element.style.display == 'block') { + element.style.display = 'none'; + self.style.backgroundImage = "url('" + orig_dir + 'coll_open.svg' + "')"; + } else { + element.style.display = 'block'; + self.style.backgroundImage = "url('" + orig_dir + 'coll_close.svg' + "')"; + } +} + +window.onload = function() { + var nav = document.querySelector('.site_navigation'); + nav.innerHTML = '
'+nav.innerHTML+'
'; + var header = document.querySelector('.site_header'); + var data = header.innerHTML.split("–"); + header.innerHTML = data[0] + (data[1] ? '
'+data[1]+'
' : ''); +} diff --git a/resources/doc-style.css b/resources/doc-style.css new file mode 100644 index 0000000..8782a82 --- /dev/null +++ b/resources/doc-style.css @@ -0,0 +1,2 @@ +@import url('https://fonts.googleapis.com/css?family=family=Open+Sans:300,400%7CDroid+Serif:400%7CRoboto+Mono:400,500,700,400italic'); +*{font-family:"Open Sans","Droid Sans",Helvetica,sans-serif}a{outline:none!important}h2,h3{font-family:"Droid Serif",serif;font-weight:300}h3{font-size:15px;font-weight:300}body{margin:0}.main_optional_parameter{font-style:italic}.main_diagram{border-style:none;display:block;margin:0 auto}.site_navi{text-align:right}.main_notification{padding-right:10px;padding-left:60px;padding-bottom:5px;padding-top:5px;border-color:#aaf;background-color:#eef;border-style:solid;border-width:1px;margin:10px;min-height:48px;background-position:6px .5em;background-repeat:no-repeat;background-image:url(warning.svg)}.main_table{border-collapse:collapse;border:1px solid #aaf;background:#eef;margin-right:auto;margin-left:auto}.main_source,.main_sourcesample{background-color:#FAFAFA;border-radius:6px;font-family:"Roboto Mono",monospace;margin:12px;padding:12px}input{border-color:#aaf;border-style:solid;border-width:1px}.site_header{align-items:center;background-color:#403757;box-shadow:0 1px 3px rgba(0,0,0,.12),0 1px 2px rgba(0,0,0,.24);display:flex;font-size:24px;justify-content:space-between;padding:9px 6px;position:fixed;top:0;width:100%;z-index:1000;color:white}div{font-size:14px}.site_title{text-align:left;font-size:40px}div.site_footer{position:fixed;bottom:0;text-align:center;padding-bottom:5px;padding-top:5px;width:100%;background-color:#fafafa}div.site_body{font-size:10;margin-top:50px}#nav_content{overflow:auto;position:fixed;height:100%;width:240px;font-size:16px;background-color:#f7f6f8}div.site_navigation{float:left;width:240px;border-color:#eceaf0;border-style:solid;border-width:1px;margin-bottom:40px;background-color:#f7f6f8}.site_content{font-size:14px;margin-left:300px;margin-right:5px;padding-top:20px;text-align:left}.main_type{text-decoration:none;font-style:italic;color:#000}.main_basic_type{text-decoration:none;font-weight:700;color:#2B9C5D}.main_keyword{text-decoration:none;font-weight:700;color:brown}.main_escape{text-decoration:none;color:#6a5acd}.xml_cdata{text-decoration:none;font-weight:400;color:#a020f0}.xml_escape{text-decoration:none;font-weight:400;color:#a020f0}.xml_element{text-decoration:none;font-weight:400;color:#008a8c}.xml_attribute{text-decoration:none;font-weight:700;color:#6a5acd}.xml_attribute_value{text-decoration:none;font-weight:400;color:#f0f}.xml_comment{text-decoration:none;font-weight:400;color:#0202ff}.main_source .main_literal{text-decoration:none;color:#2ba199}.main_comment{text-decoration:none;color:#888a85}.main_preprocessor{text-decoration:none;color:#ad7fa8}div.main_code_definition{background-color:#eee;border-radius:6px;font-family:"Roboto Mono",monospace;margin:12px;padding:12px}div.main_notification_block{padding-right:10px;padding-left:10px;padding-bottom:5px;padding-top:5px;border-color:#d08717;background-color:#fbf2c3;border-style:solid;border-width:1px;margin:10px}span.main_block_headline{background-image:url(tip.svg);background-repeat:no-repeat;background-position:center right;font-weight:700;display:block}div.main_block_content{margin-left:15px}span.leaf_code_definition{font-family:"Roboto Mono",monospace;font-size:15px;font-weight:200}div.leaf_brief_description{display:block;margin-left:40px}h1.main_title{font-size:20px;margin-bottom:0}h2.main_title{margin-bottom:0}h3.main_title{margin-bottom:0}.main_hr{border:0;color:#b4a0c1;background-color:#b4a0c1;height:1px;margin-top:6px;margin-bottom:6px}.main_parameter_table_unknown_parameter{color:GREY}.main_parameter_table_name,.main_errordomain_table_name,.main_enum_table_name{vertical-align:top;text-align:right;font-weight:700;width:120px;padding-right:10px}.main_parameter_table,.main_errordomain_table,.main_enum_table{margin-weight:20px;margin-left:20px}.description a.constant,.brief_description a.constant{background-image:url(constant.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.namespace,.brief_description a.namespace{background-image:url(namespace.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.struct,.brief_description a.struct{background-image:url(struct.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.interface,.brief_description a.interface{background-image:url(interface.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.enum,.brief_description a.enum{background-image:url(enum.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.errordomain,.brief_description a.errordomain{background-image:url(errordomain.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.delegate,.brief_description a.delegate{background-image:url(delegate.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.signal,.brief_description a.signal{background-image:url(signal.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.field,.brief_description a.field{background-image:url(field.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.enumvalue,.brief_description a.enumvalue{background-image:url(enumvalue.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.errorcode,.brief_description a.errorcode{background-image:url(errorcode.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.class,.brief_description a.class{background-image:url(class.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}a.abstract_class,.description a.abstract_class,.brief_description a.abstract_class{background-image:url(abstractclass.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0;font-style:italic}.description a.property,.brief_description a.property{background-image:url(property.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.virtual_property,.brief_description a.virtual_property{background-image:url(virtualproperty.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.abstract_property,.brief_description a.abstract_property{background-image:url(abstractproperty.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.method,.brief_description a.method{background-image:url(method.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.static_method,.brief_description a.static_method{background-image:url(staticmethod.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}a.virtual_method,.description a.virtual_method,.brief_description a.virtual_method{background-image:url(virtualmethod.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.abstract_method,.brief_description a.abstract_method{background-image:url(abstractmethod.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.description a.creation_method,.brief_description a.creation_method{background-image:url(constructor.svg);display:inline-block;padding-right:17px;background-repeat:no-repeat;background-position:center right;border:0}.navi_main li,.navi_inline li{background-image:url(method.svg);background-repeat:no-repeat!important;background-position:left center!important;background-color:transparent;vertical-align:middle;list-style-type:none;margin:0;padding:0 0 0 20px;transition:all 0.5s ease-out}.navi_inline li{background-position:left 12px!important;padding:10px 0 10px 20px}.navi_main li.errorcode,.navi_inline li.errorcode{background-image:url(errorcode.svg)}.navi_main li.enumvalue,.navi_inline li.enumvalue{background-image:url(enumvalue.svg)}.navi_main li.abstract_class,.navi_inline li.abstract_class{background-image:url(abstractclass.svg)}.navi_main li.abstract_method,.navi_inline li.abstract_method{background-image:url(abstractmethod.svg)}.navi_main li.creation_method,.navi_inline li.creation_method,.main_list_m{background-image:url(constructor.svg)}.navi_main li.static_method,.navi_inline li.static_method{background-image:url(staticmethod.svg)}.navi_main li.package_index{background-image:url(packages.svg)}.navi_main li.virtual_method,.navi_inline li.virtual_method{background-image:url(virtualmethod.svg)}.navi_main li.errordomain,.navi_inline li.errordomain,.main_list_errdom{background-image:url(errordomain.svg)}.navi_main li.namespace,.navi_inline li.namespace,.main_list_ns{background-image:url(namespace.svg)}.navi_main li.method,.navi_inline li.method{background-image:url(method.svg)}.navi_main li.struct,.navi_inline li.struct,.main_list_stru{background-image:url(struct.svg)}.navi_main li.interface,.navi_inline li.interface,.main_list_iface{background-image:url(interface.svg)}.navi_main li.field,.navi_inline li.field,.main_list_field{background-image:url(field.svg)}.navi_main li.class,.navi_inline li.class,.main_list_cl{background-image:url(class.svg)}.navi_main li.enum,.navi_inline li.enum,.main_list_en{background-image:url(enum.svg)}.navi_main li.property,.navi_inline li.property,.main_list_prop{background-image:url(property.svg)}.navi_main li.abstract_property,.navi_inline li.abstract_property{background-image:url(abstractproperty.svg)}.navi_main li.virtual_property,.navi_inline li.virtual_property{background-image:url(virtualproperty.svg)}.navi_main li.delegate,.navi_inline li.delegate,.main_list_del{background-image:url(delegate.svg)}.navi_main li.signal,.navi_inline li.signal,.main_list_sig{background-image:url(signal.svg)}.navi_main li.package,.navi_inline li.package{background-image:url(package.svg)}.navi_main li.constant,.navi_inline li.constant{background-image:url(constant.svg)}.navi_main{margin-top:10px;margin-bottom:10px;padding-left:5px}.navi_main:last-child{padding-left:5px}.navi_hr{background-color:#dedede;border:0;border-top-width:0;border-bottom-width:0;border-top-style:none;border-bottom-style:none;border-top-color:currentcolor;border-bottom-color:currentcolor;border-bottom:1px solid #fff;border-top:1px solid #dedede;height:0;margin:6px 0}.navi_main a{text-decoration:none;color:#887E9C;line-height:26px;width:100%;display:inline-block;padding-left:0}a,.navi_inline a,a.external_link{text-decoration:none;color:#50A3BE;transition:all 0.5s ease-out}.navi_main li:hover{background-color:rgba(0,0,0,.1)}div.site_content .navi_main li:hover{background-color:transparent}a:hover,.navi_inline a:hover,a.external_link:hover,div.site_content .navi_main li a:hover{text-decoration:underline;color:#6A6576}.navi_main li:hover a{text-decoration:none}.navi_main .abstract_class>a,.navi_inline .abstract_class>a{font-style:italic}a.navi_link:hover,a.external_link:hover{text-decoration:underline}ul.no_bullet li{list-style-type:none}.navi_inline{}.css_content_literal{font-family:monospace;color:#ff01ff}code{font-family:monospace}.main_code_definition a,.leaf_code_definition a{text-decoration:none;color:inherit}.main_code_definition a:hover,.leaf_code_definition a:hover{text-decoration:underline}.box .headline{background-image:url(coll_open.svg);background-position:calc(100% - 1px) center;background-repeat:no-repeat;background-color:#eef;border-color:#aaf;border-style:solid;border-width:1px;margin:auto;width:90%;margin-top:20px;font-weight:700}.box .content{border-color:#aaf;border-width:0 1 1 1;border-style:solid;overflow:auto;display:none;margin:auto;width:90%}.box .column{float:left;width:33%}.package_note{}.deprecated{text-decoration:line-through} diff --git a/resources/echo.ini b/resources/echo.ini index ef3ff2f..d039266 100644 --- a/resources/echo.ini +++ b/resources/echo.ini @@ -12,9 +12,9 @@ option = 37,1 option_sep = 158 arg = 97,1 arg_sep = 147,1 -title = 15,1,97 +title = 15,1,24 title_item = 220,1 -title_sep = 97,1 +title_sep = 24,1 section = 37 sep = 59 item = 215,1 diff --git a/src/Pluie.Color.vala b/src/Pluie.Color.vala index d5636e8..080df7f 100644 --- a/src/Pluie.Color.vala +++ b/src/Pluie.Color.vala @@ -1,11 +1,42 @@ +/** + * a Class representing an Ansi Extended 8 bit Color + * with foreground, background and bold attributes + * + * {{{ + * using Pluie; + * + * int main (string[] args) + * { + * var c1 = new Color(37, false); + * var c2 = new Color(204, true); + * var c3 = new Color(15, true, 24); + * stdout.printf ("[%s][%s] %s ", c1.s ("oki"), c2.s ("very"), c3.s ("cool")); + * return 0; + * } + * }}} + * + * valac --pkg pluie-echo-0.1 color.vala + **/ public class Pluie.Color { - + /** + * foreground color code - 0 to 255 + **/ public uint8? fg { get; set; default = 15; } + /** + * background color code - 0 to 255 + **/ public uint8? bg { get; set; default = null; } + /** + * enable bold attribute + **/ public bool bold { get; set; default = false; } - + /** + * @param fg foreground color code - 0 to 255 + * @param bold bold attribute + * @param bg background color code - 0 to 255 + **/ public Color (uint8? fg = 15, bool bold = false, uint8? bg = null) { this.fg = fg; @@ -13,7 +44,9 @@ public class Pluie.Color this.bold = bold; } - + /** + * return ansi extended color escape string sequence + **/ public string to_string () { string s = "\033[%s%sm".printf ( @@ -25,7 +58,13 @@ public class Pluie.Color return s; } - + /** + * colorize a string + * @param label the string to colorize + * @param off enable/disable off sequence at end of label + * @param bold override bold attribute for label + * @return the colorized string with proper ansi escape color sequence + **/ public string s (string? label = null, bool off = true, bool? bold = null) { bool prevbold = this.bold; @@ -45,7 +84,9 @@ public class Pluie.Color return "%s%s%s".printf (this.to_string (), label, off ? Color.off() : ""); } - + /** + * disable escape color sequence + **/ public static string off () { return "\033[m"; diff --git a/src/Pluie.ColorConf.vala b/src/Pluie.ColorConf.vala index d24647c..6791709 100644 --- a/src/Pluie.ColorConf.vala +++ b/src/Pluie.ColorConf.vala @@ -1,6 +1,11 @@ using GLib; using Pluie; +/** + * a Class representing a set of {@link Color} + * mapping {@link ECHO} colors with values coming from + * the specifyed ini config file + **/ public class Pluie.ColorConf { @@ -11,7 +16,10 @@ public class Pluie.ColorConf string[] keys; Array colors = new Array (); - + /** + * see resources/echo.ini file + * @param path config ini file path overriding Pluie.ECHO color values + **/ public ColorConf(string path) { Dbg.in (Log.METHOD, "path:'%s'".printf (path), Log.LINE, Log.FILE); @@ -20,7 +28,11 @@ public class Pluie.ColorConf Dbg.out (Log.METHOD, null, Log.LINE, Log.FILE); } - + /** + * get specifiyed ECHO color instance + * @param name the choosen color + * @return the corresponding Color instance + **/ public new unowned Color? @get (ECHO name) { unowned Color c = this.colors.index ((int)name); @@ -64,7 +76,11 @@ public class Pluie.ColorConf return v; } - + /** + * get value for Term parameter + * @param name from { "term_width", "indent", "key_maxlen" } + * @return corresponding value define in config file + **/ public int param (string name) { string[] plist = { "term_width", "indent", "key_maxlen" }; diff --git a/src/Pluie.Dbg.vala b/src/Pluie.Dbg.vala index 79f5863..94e1b17 100644 --- a/src/Pluie.Dbg.vala +++ b/src/Pluie.Dbg.vala @@ -4,15 +4,28 @@ namespace Pluie.Dbg { static OutputFormatter o; + /** + * enable/disable log messages + **/ public static bool DBG_ENABLED = false; - public const int8 DBG_ENTER = 1; - public const int8 DBG_LEAVE = 2; - public const int8 DBG_INLINE = 0; + const int8 DBG_ENTER = 1; + const int8 DBG_LEAVE = 2; + const int8 DBG_INLINE = 0; + /** + * type log error + **/ public const int8 DBG_ERROR = 8; + /** + * type log warn + **/ public const int8 DBG_WARN = 9; - - public void init (OutputFormatter of, bool debug = false) + /** + * initialize logging + * @param of the outputFormatter to use for logging + * @param debug enable disable log messages + **/ + public static void init (OutputFormatter of, bool debug = false) { o = of; Pluie.Dbg.DBG_ENABLED = debug; @@ -35,24 +48,49 @@ namespace Pluie.Dbg return str; } + /** + * log method entering + * @param method the method name + * @param params optional parameters string to display on entering + * @param line optional current file line + * @param file optional current file + **/ public static void @in(string method, string? params = null, int line = 0, string? file = null) { Dbg.log ("%s (%s)".printf (method, Dbg.parse_params(params)), line, DBG_ENTER, file); } - + /** + * log method leaving + * @param method the method name + * @param params optional parameters string to display on entering + * @param line optional current file line + * @param file optional current file + **/ public static void @out(string method, string? params = null, int line = 0, string? file = null) { Dbg.log ("%s (%s)".printf (method, Dbg.parse_params(params)), line, DBG_LEAVE, file); } - + /** + * log a message + * @param msg the msg to log + * @param line optional current file line + * @param file optional current file + **/ public static void msg(string msg, int line = 0, string? file = null) { Dbg.log (msg, line, DBG_INLINE, file); } - + /** + * log error + * @param msg the error msg to log + * @param method the method name logging the error + * @param line optional current file line + * @param file optional current file + * @param mode optional log mode (DBG_ERROR|DBG_WARN) + **/ public static void @error(string msg, string method, int line = 0, string? file = null, int8 mode = DBG_ERROR) { Dbg.log (file != null ? "%s %s (in %s)".printf (msg, Color.off (), method) : msg, line, mode, file == null ? "%s".printf (method) : file); @@ -73,7 +111,7 @@ namespace Pluie.Dbg } - public static void log (string msg, int line = 0, int8 mode = DBG_INLINE, string? file = null) + private static void log (string msg, int line = 0, int8 mode = DBG_INLINE, string? file = null) { if (DBG_ENABLED) { var time = new DateTime.now_local (); diff --git a/src/Pluie.OutputFormatter.vala b/src/Pluie.OutputFormatter.vala index 56f4ac7..cfcbb0f 100644 --- a/src/Pluie.OutputFormatter.vala +++ b/src/Pluie.OutputFormatter.vala @@ -1,18 +1,101 @@ using GLib; using Pluie; +/** + * A class managing display on stdout & stderror with {@link Color} styles defined by + * specifiyed {@link ColorConf} + * + * {{{ + * using GLib; + * using Pluie; + * + * errordomain MyError { + * CODE + * } + * + * int main (string[] args) + * { + * var of = Echo.init (true, "resources/echo.ini"); + * Dbg.in (Log.METHOD, null, Log.LINE, Log.FILE); + * + * of.title ("MyApp", "0.2.2", "a-sansara"); + * + * of.echo ("sample echo\n"); + * + * of.keyval ("path", "/tmp/blob"); + * of.keyval ("otherlongoption", "other value"); + * + * of.echo ("\nsample echo\non multiple\nline", true, true); + * + * of.action ("reading config", "toto.conf"); + * + * of.state (false); + * + * of.warn ("boloss warning"); + * of.echo (); + * + * var cmd = new Sys.Cmd ("ls -la"); + * + * int status = cmd.run(); + * of.action ("running cmd", cmd.name); + * of.echo ("\n%s".printf (cmd.output), true, true); + * + * of.state (status == 0); + * + * try { + * throw new MyError.CODE("this is the error message"); + * } + * catch (MyError e) { + * of.error (e.message); + * } + * of.rs (true); + * of.rs (true, "ok"); + * of.rs (false, "", "exit"); + * + * of.echo(); + * + * string com = "Vala is syntactically similar to C# and includes several features such as: anonymous functions, signals, properties, generics, assisted memory management, exception handling, type inference, and foreach statements.[3] Its developers Jürg Billeter and Raffaele Sandrini aim to bring these features to the plain C runtime with little overhead and no special runtime support by targeting the GObject object system"; + * string mycom = of.wordwrap (com, of.term_width-44); + * int line = mycom.split("\n").length; + * of.echo (mycom, true, true, ECHO.COMMENT, 40); + * + * of.usage_option ("quiet", "q", "SHUTUP", false, line); + * of.echo(); + * + * of.echo (mycom, true, true, ECHO.COMMENT, 40); + * of.usage_option ("record-desktop", "r", "TIME", false, line); + * + * of.echo(); + * Dbg.out (Log.METHOD, null, Log.LINE, Log.FILE); + * return 0; + * } + * + * }}} + * valac --pkg pluie-echo-0.1 outputFormatter.vala + **/ public class Pluie.OutputFormatter { string sep = "──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────"; string space = " "; string symbol = "➤"; + /** + * number of space defining default indentation + **/ public int indent; + /** + * max terminal with to considerate when printing messages + **/ public int term_width; + /** + * max padding to use for keys in {@see OutputFormatter.keyval} method + **/ int key_maxlen; protected ColorConf conf; - + /** + * @param conf the ColorConf to use for printing ansi escape sequences + **/ public OutputFormatter (ColorConf conf) { this.conf = conf; @@ -21,20 +104,29 @@ public class Pluie.OutputFormatter this.key_maxlen = conf.param("key_maxlen"); } - + /** + * get Color instance corresponding to ECHO color + * @param name the ECHO color + **/ public unowned Color c (ECHO name) { unowned Color color = this.conf.get (name); return color; } - + /** + * get ansi escape sequence moving up lines + * @param line number of line to move up + **/ public string move_up (int line) { return "\033[%dA".printf (line); } - + /** + * get ansi escape sequence moving down lines + * @param line number of line to move down + **/ public string move_down (int line) { return "\033[%dB".printf (line); @@ -46,7 +138,10 @@ public class Pluie.OutputFormatter return !error ? (exp ? this.c (ECHO.DONE) : this.c (ECHO.FAIL)) : (exp ? this.c (ECHO.ERROR) : this.c (ECHO.WARN)); } - + /** + * get an indentation only string + * @param adjust number of space indentation adjustment + **/ public string s_indent (int8 adjust = 0) { return "%.*s".printf (this.indent+adjust, this.space); @@ -58,7 +153,12 @@ public class Pluie.OutputFormatter return this.c (ECHO.TITLE_SEP).s (" %.*s".printf ((this.term_width-1)*3, this.sep)); } - + /** + * display a title + * @param label generally title of program + * @param version version of program + * @param author author of program + **/ public void title (string label, string? version = null, string? author = null) { string s = version == null ? " " : this.c (ECHO.TITLE_ITEM).s (" v" + version+" ", false); @@ -75,7 +175,11 @@ public class Pluie.OutputFormatter ); } - + /** + * display an action + * @param name name of current action + * @param val optional action parameter + **/ public void action (string name, string? val = "") { stdout.printf ( @@ -87,13 +191,19 @@ public class Pluie.OutputFormatter ); } - + /** + * display a warning + * @param label the warn message to display + **/ public void warn (string label) { this.error (label, true); } - + /** + * display an error + * @param label the error message to display + **/ public void error (string label, bool warn = false) { stderr.printf ( @@ -103,7 +213,12 @@ public class Pluie.OutputFormatter ); } - + /** + * display a test result + * @param test the result of test + * @param done the done label to display if test succeed + * @param done the fail label to display if test fail + **/ public void rs (bool test, string done = "done", string fail = "fail") { stdout.printf ( @@ -113,13 +228,23 @@ public class Pluie.OutputFormatter ); } - + /** + * display a message up tp x lines + * @param line number of line to move up + * @param s the message to display + **/ public void echo_up (int line, string s) { stdout.printf ("%s\r%s%s\r", this.move_up(line), s, this.move_down(line)); } - + /** + * generic method to display messages + * @param data the message to display + * @param lf enable line feed + * @param indent_all enable multiple line indentation + * @param color use color ECHO to display the message + **/ public void echo (string? data = "", bool lf = true, bool indent_all = false, ECHO color = ECHO.DEFAULT, int8 indent_adjust = 0) { string s; @@ -144,7 +269,10 @@ public class Pluie.OutputFormatter ); } - + /** + * display a state for specifiyed test + * @param test the test result + **/ public void state (bool test) { int len = (this.term_width)*3 - 14 - this.indent-3; @@ -157,7 +285,12 @@ public class Pluie.OutputFormatter ); } - + /** + * wordwrap paragraph + * @param str the paragraph to wordwrap + * @param width maximum width of each lines + * @param cut cur word rather than wordwrap [not implemented] + **/ public string wordwrap (string str, int width, bool cut = false) { unichar c; @@ -187,7 +320,14 @@ public class Pluie.OutputFormatter return sb.str; } - + /** + * display usage option + * @param name the option name + * @param shortname the option shortname + * @param argname the option argument + * @param val specifyed optional value argument + * @param echo_up line to move up on displaying option definition + **/ public void usage_option (string? name = null, string? shortname=null, string? argname = null, bool val = false, int echo_up = 0) { string opt = ""; @@ -217,7 +357,11 @@ public class Pluie.OutputFormatter } } - + /** + * display a key value message + * @param key the key name + * @param val the key value + **/ public void keyval (string key, string val) { int len = this.key_maxlen - (int) key.length; diff --git a/src/Pluie.global.vala b/src/Pluie.global.vala index 29089a6..86a5a13 100644 --- a/src/Pluie.global.vala +++ b/src/Pluie.global.vala @@ -3,6 +3,10 @@ using Pluie; namespace Pluie { + /** + * enumerate predefined {@link Color} mapped to default config file + * see resources/echo.ini + **/ public enum ECHO { DEFAULT, @@ -32,12 +36,13 @@ namespace Pluie WARN, ERROR; } - + + namespace Echo { public static OutputFormatter of; - public OutputFormatter init (bool debug, string? path = null) + public static OutputFormatter init (bool debug, string? path = null) { var conf = new ColorConf (path ?? Path.build_filename (DATA_PATH, "echo.ini")); Echo.of = new OutputFormatter (conf); diff --git a/valadoc.sh b/valadoc.sh new file mode 100755 index 0000000..b8467a4 --- /dev/null +++ b/valadoc.sh @@ -0,0 +1,5 @@ +#!/bin/bash +valadoc --package-name=pluie-echo-0.1 --verbose --force -o ./doc --pkg glib-2.0 ./src/*.vala ./build/install.vala +rm doc/*.png +cp resources/doc-scripts.js ./doc/scripts.js +cp resources/doc-style.css ./doc/style.css