diff --git a/.gitignore b/.gitignore index 991570e..19d7cbb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,8 @@ *~ *.o *.so -*.html *.src.rock /ChangeLog -/doc /build-aux/config.ld /luacov.*.out /lyaml-*.tar.gz diff --git a/NEWS.md b/NEWS.md index 03f0f77..94e6dfa 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,8 +1,5 @@ # lyaml NEWS - User visible changes -## Noteworthy changes in release ?.? (????-??-??) [?] - - ## Noteworthy changes in release 6.2.2 (2018-03-28) [stable] ### Bug fixes diff --git a/README.md b/README.md index 90accf6..d71310f 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ LYAML Copyright (C) 2013-2018 Gary V. Vaughan [![License](https://img.shields.io/:license-mit-blue.svg)](https://mit-license.org) -[![travis-ci status](https://secure.travis-ci.org/gvvaughan/lyaml.png)](http://travis-ci.org/gvvaughan/lyaml/builds) -[![codecov.io](https://codecov.io/github/lua-stdlib/strict/coverage.svg?branch=master)](https://codecov.io/github/lua-stdlib/strict?branch=master) +[![travis-ci status](https://secure.travis-ci.org/gvvaughan/lyaml.png?branch=release-v6.2.2)](http://travis-ci.org/gvvaughan/lyaml/builds) +[![codecov.io](https://codecov.io/github/lua-stdlib/strict/coverage.svg?branch=release-v6.2.2)](https://codecov.io/github/lua-stdlib/strict?branch=master) [![Stories in Ready](https://badge.waffle.io/gvvaughan/lyaml.png?label=ready&title=Ready)](https://waffle.io/gvvaughan/lyaml) [LibYAML] binding for [Lua], with a fast C implementation diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..3ca3780 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,97 @@ + + + + + lyaml 6.2.2 Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ + +

+

LYAML binding for Lua

+ +

This is a Lua binding for the fast libYAML C library for converting +between %YAML 1.1 and Lua tables, with a flexible Lua language +API to load and save YAML documents.

+ +

It works with Lua 5.1 (including LuaJIT), 5.2 and 5.3.

+ +

LICENSE

+ +

The code is copyright by its respective authors, and released under the +MIT license (the same license as Lua itself). There is no warranty.

+ + + +

Modules

+ + + + + + + + + + + + + + + + + +
lyaml + +
lyaml.explicit + +
lyaml.functional + +
lyaml.implicit + +
+ +
+
+
+generated by LDoc 1.4.6 +Last updated 2018-03-28 22:03:57 +
+
+ + diff --git a/doc/ldoc.css b/doc/ldoc.css new file mode 100644 index 0000000..52c4ad2 --- /dev/null +++ b/doc/ldoc.css @@ -0,0 +1,303 @@ +/* BEGIN RESET + +Copyright (c) 2010, Yahoo! Inc. All rights reserved. +Code licensed under the BSD License: +http://developer.yahoo.com/yui/license.html +version: 2.8.2r1 +*/ +html { + color: #000; + background: #FFF; +} +body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td { + margin: 0; + padding: 0; +} +table { + border-collapse: collapse; + border-spacing: 0; +} +fieldset,img { + border: 0; +} +address,caption,cite,code,dfn,em,strong,th,var,optgroup { + font-style: inherit; + font-weight: inherit; +} +del,ins { + text-decoration: none; +} +li { + margin-left: 20px; +} +caption,th { + text-align: left; +} +h1,h2,h3,h4,h5,h6 { + font-size: 100%; + font-weight: bold; +} +q:before,q:after { + content: ''; +} +abbr,acronym { + border: 0; + font-variant: normal; +} +sup { + vertical-align: baseline; +} +sub { + vertical-align: baseline; +} +legend { + color: #000; +} +input,button,textarea,select,optgroup,option { + font-family: inherit; + font-size: inherit; + font-style: inherit; + font-weight: inherit; +} +input,button,textarea,select {*font-size:100%; +} +/* END RESET */ + +body { + margin-left: 1em; + margin-right: 1em; + font-family: arial, helvetica, geneva, sans-serif; + background-color: #ffffff; margin: 0px; +} + +code, tt { font-family: monospace; font-size: 1.1em; } +span.parameter { font-family:monospace; } +span.parameter:after { content:":"; } +span.types:before { content:"("; } +span.types:after { content:")"; } +.type { font-weight: bold; font-style:italic } + +body, p, td, th { font-size: .95em; line-height: 1.2em;} + +p, ul { margin: 10px 0 0 0px;} + +strong { font-weight: bold;} + +em { font-style: italic;} + +h1 { + font-size: 1.5em; + margin: 20px 0 20px 0; +} +h2, h3, h4 { margin: 15px 0 10px 0; } +h2 { font-size: 1.25em; } +h3 { font-size: 1.15em; } +h4 { font-size: 1.06em; } + +a:link { font-weight: bold; color: #004080; text-decoration: none; } +a:visited { font-weight: bold; color: #006699; text-decoration: none; } +a:link:hover { text-decoration: underline; } + +hr { + color:#cccccc; + background: #00007f; + height: 1px; +} + +blockquote { margin-left: 3em; } + +ul { list-style-type: disc; } + +p.name { + font-family: "Andale Mono", monospace; + padding-top: 1em; +} + +pre { + background-color: rgb(245, 245, 245); + border: 1px solid #C0C0C0; /* silver */ + padding: 10px; + margin: 10px 0 10px 0; + overflow: auto; + font-family: "Andale Mono", monospace; +} + +pre.example { + font-size: .85em; +} + +table.index { border: 1px #00007f; } +table.index td { text-align: left; vertical-align: top; } + +#container { + margin-left: 1em; + margin-right: 1em; + background-color: #f0f0f0; +} + +#product { + text-align: center; + border-bottom: 1px solid #cccccc; + background-color: #ffffff; +} + +#product big { + font-size: 2em; +} + +#main { + background-color: #f0f0f0; + border-left: 2px solid #cccccc; +} + +#navigation { + float: left; + width: 14em; + vertical-align: top; + background-color: #f0f0f0; + overflow: visible; +} + +#navigation h2 { + background-color:#e7e7e7; + font-size:1.1em; + color:#000000; + text-align: left; + padding:0.2em; + border-top:1px solid #dddddd; + border-bottom:1px solid #dddddd; +} + +#navigation ul +{ + font-size:1em; + list-style-type: none; + margin: 1px 1px 10px 1px; +} + +#navigation li { + text-indent: -1em; + display: block; + margin: 3px 0px 0px 22px; +} + +#navigation li li a { + margin: 0px 3px 0px -1em; +} + +#content { + margin-left: 14em; + padding: 1em; + width: 700px; + border-left: 2px solid #cccccc; + border-right: 2px solid #cccccc; + background-color: #ffffff; +} + +#about { + clear: both; + padding: 5px; + border-top: 2px solid #cccccc; + background-color: #ffffff; +} + +@media print { + body { + font: 12pt "Times New Roman", "TimeNR", Times, serif; + } + a { font-weight: bold; color: #004080; text-decoration: underline; } + + #main { + background-color: #ffffff; + border-left: 0px; + } + + #container { + margin-left: 2%; + margin-right: 2%; + background-color: #ffffff; + } + + #content { + padding: 1em; + background-color: #ffffff; + } + + #navigation { + display: none; + } + pre.example { + font-family: "Andale Mono", monospace; + font-size: 10pt; + page-break-inside: avoid; + } +} + +table.module_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.module_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.module_list td.name { background-color: #f0f0f0; min-width: 200px; } +table.module_list td.summary { width: 100%; } + + +table.function_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.function_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.function_list td.name { background-color: #f0f0f0; min-width: 200px; } +table.function_list td.summary { width: 100%; } + +ul.nowrap { + overflow:auto; + white-space:nowrap; +} + +dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;} +dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;} +dl.table h3, dl.function h3 {font-size: .95em;} + +/* stop sublists from having initial vertical space */ +ul ul { margin-top: 0px; } +ol ul { margin-top: 0px; } +ol ol { margin-top: 0px; } +ul ol { margin-top: 0px; } + +/* make the target distinct; helps when we're navigating to a function */ +a:target + * { + background-color: #FF9; +} + + +/* styles for prettification of source */ +pre .comment { color: #558817; } +pre .constant { color: #a8660d; } +pre .escape { color: #844631; } +pre .keyword { color: #aa5050; font-weight: bold; } +pre .library { color: #0e7c6b; } +pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; } +pre .string { color: #8080ff; } +pre .number { color: #f8660d; } +pre .operator { color: #2239a8; font-weight: bold; } +pre .preprocessor, pre .prepro { color: #a33243; } +pre .global { color: #800080; } +pre .user-keyword { color: #800080; } +pre .prompt { color: #558817; } +pre .url { color: #272fc2; text-decoration: underline; } + diff --git a/doc/modules/lyaml.explicit.html b/doc/modules/lyaml.explicit.html new file mode 100644 index 0000000..bfe9e41 --- /dev/null +++ b/doc/modules/lyaml.explicit.html @@ -0,0 +1,267 @@ + + + + + lyaml 6.2.2 Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module lyaml.explicit

+

+ +

+

+ +

+ + +

Functions

+ + + + + + + + + + + + + + + + + + + + + +
bool (value)Parse the value following an explicit !!bool tag.
float (value)Parse the value following an explicit !!float tag.
int (value)Parse the value following an explicit !!int tag.
null ()Parse an explicit !!null tag.
str (value)Parse the value following an explicit !!str tag.
+ +
+
+ + +

Functions

+ +
+
+ + bool (value) +
+
+ Parse the value following an explicit !!bool tag. + + +

Parameters:

+
    +
  • value + token +
    • +
+ +

Returns:

+
    + + bool + boolean equivalent, if a valid value was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_bool = explicit.bool(tagarg)
    +
+ +
+
+ + float (value) +
+
+ Parse the value following an explicit !!float tag. + + +

Parameters:

+
    +
  • value + token +
    • +
+ +

Returns:

+
    + + number + float equivalent, if a valid value was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_float = explicit.float(tagarg)
    +
+ +
+
+ + int (value) +
+
+ Parse the value following an explicit !!int tag. + + +

Parameters:

+
    +
  • value + token +
    • +
+ +

Returns:

+
    + + int + integer equivalent, if a valid value was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_int = explicit.int(tagarg)
    +
+ +
+
+ + null () +
+
+ Parse an explicit !!null tag. + + + +

Returns:

+
    + + lyaml.null + + + +
+ + + +

Usage:

+
    + 
    null = explicit.null(tagarg)
    +
+ +
+
+ + str (value) +
+
+ Parse the value following an explicit !!str tag. + + +

Parameters:

+
    +
  • value + string + token +
    • +
+ +

Returns:

+
    + + string + value which was a string already +
+ + + +

Usage:

+
    + 
    tagarg = explicit.str(tagarg)
    +
+ +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2018-03-28 22:03:57 +
+
+ + diff --git a/doc/modules/lyaml.functional.html b/doc/modules/lyaml.functional.html new file mode 100644 index 0000000..7341c4c --- /dev/null +++ b/doc/modules/lyaml.functional.html @@ -0,0 +1,236 @@ + + + + + lyaml 6.2.2 Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module lyaml.functional

+

+ +

+

+ +

+ + +

Functions

+ + + + + + + + + + + + + + + + + +
isnull (x)lyaml.null predicate.
iscallable (x)Callable predicate.
anyof (fns)Compose a function to try each callable with supplied args.
id (...)Return arguments unchanged.
+

Tables

+ + + + + +
NULLlyaml.null value.
+ +
+
+ + +

Functions

+ +
+
+ + isnull (x) +
+
+ lyaml.null predicate. + + +

Parameters:

+
    +
  • x + operand +
    • +
+ +

Returns:

+
    + + bool + true if x is lyaml.null. +
+ + + + +
+
+ + iscallable (x) +
+
+ Callable predicate. + + +

Parameters:

+
    +
  • x + operand +
    • +
+ +

Returns:

+
    + + bool + true if x is a function has a __call metamethod +
+ + + +

Usage:

+
    + 
    r = iscallable(x) and x(...)
    +
+ +
+
+ + anyof (fns) +
+
+ Compose a function to try each callable with supplied args. + + +

Parameters:

+
    +
  • fns + table + list of functions to try +
    • +
+ +

Returns:

+
    + + function + +

    a new function to call ... functions, stopping

    +
    and returning the first non-nil result, if any
+
    + +
+ + + + +
+
+ + id (...) +
+
+ Return arguments unchanged. + + +

Parameters:

+
    +
  • ... + arguments +
    • +
+ +

Returns:

+
    + + ... +
+ + + + +
+
+

Tables

+ +
+
+ + NULL +
+
+ lyaml.null value. + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2018-03-28 22:03:57 +
+
+ + diff --git a/doc/modules/lyaml.html b/doc/modules/lyaml.html new file mode 100644 index 0000000..672a530 --- /dev/null +++ b/doc/modules/lyaml.html @@ -0,0 +1,224 @@ + + + + + lyaml 6.2.2 Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module lyaml

+

+ +

+

+ +

+ + +

Functions

+ + + + + + + + + +
dump (documents[, opts])Dump a list of Lua tables to an equivalent YAML stream.
load (s[, opts])Load a YAML stream into a Lua table.
+

Tables

+ + + + + + + + + +
dumper_optsDump options table.
loader_optsLoad options table.
+ +
+
+ + +

Functions

+ +
+
+ + dump (documents[, opts]) +
+
+ Dump a list of Lua tables to an equivalent YAML stream. + + +

Parameters:

+
    +
  • documents + table + a sequence of Lua tables. +
    • +
  • opts + dumper_opts + initialisation options + (optional) +
    • +
+ +

Returns:

+
    + + string + equivalest YAML stream +
+ + + + +
+
+ + load (s[, opts]) +
+
+ Load a YAML stream into a Lua table. + + +

Parameters:

+
    +
  • s + string + YAML stream +
    • +
  • opts + loader_opts + initialisation options + (optional) +
    • +
+ +

Returns:

+
    + + table + Lua table equivalent of stream s +
+ + + + +
+
+

Tables

+ +
+
+ + dumper_opts +
+
+ Dump options table. + + +

Fields:

+
    +
  • anchors + table + map initial anchor names to values +
    • +
  • implicit_scalar + function + parse implicit scalar values +
    • +
+ + + + + +
+
+ + loader_opts +
+
+ Load options table. + + +

Fields:

+
    +
  • all + boolean + load all documents from the stream +
    • +
  • explicit_scalar + table + map full tag-names to parser functions +
    • +
  • implicit_scalar + function + parse implicit scalar values +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2018-03-28 22:03:57 +
+
+ + diff --git a/doc/modules/lyaml.implicit.html b/doc/modules/lyaml.implicit.html new file mode 100644 index 0000000..7b92c8e --- /dev/null +++ b/doc/modules/lyaml.implicit.html @@ -0,0 +1,533 @@ + + + + + lyaml 6.2.2 Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module lyaml.implicit

+

+ +

+

+ +

+ + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
null (value)Parse a null token to a null value.
bool (value)Parse a boolean token to the equivalent value.
binary (value)Parse a binary token, such as '0b1010_0111_0100_1010_1110'.
octal (value)Parse an octal token, such as '012345'.
decimal (value)Parse a decimal token, such as '0' or '12345'.
hexadecimal (value)Parse a hexadecimal token, such as '0xdeadbeef'.
sexagesimal (value)Parse a sexagesimal token, such as '190:20:30'.
nan (value)Parse a nan token.
inf (value)Parse a signed inf token.
float (value)Parse a floating point number token, such as '1e-3' or '-0.12'.
sexfloat (value)Parse a sexagesimal float, such as '190:20:30.15'.
+ +
+
+ + +

Functions

+ +
+
+ + null (value) +
+
+ Parse a null token to a null value. + + +

Parameters:

+
    +
  • value + token +
    • +
+ +

Returns:

+
    + + lyaml.null, for an empty string or literal ~ +
+

Or

+
    + + nil otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_null = implicit.null(token)
    +
+ +
+
+ + bool (value) +
+
+ Parse a boolean token to the equivalent value. + Treats capilalized, lower and upper-cased variants of true/false, + yes/no or on/off tokens as boolean true and false values. + + +

Parameters:

+
    +
  • value + token +
    • +
+ +

Returns:

+
    + + bool + if a valid boolean token was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_bool = implicit.bool(token)
    +
+ +
+
+ + binary (value) +
+
+ Parse a binary token, such as '0b1010_0111_0100_1010_1110'. + + +

Parameters:

+
    +
  • value + string + token +
    • +
+ +

Returns:

+
    + + int + integer equivalent, if a valid token was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_int = implicit.binary(value)
    +
+ +
+
+ + octal (value) +
+
+ Parse an octal token, such as '012345'. + + +

Parameters:

+
    +
  • value + string + token +
    • +
+ +

Returns:

+
    + + int + integer equivalent, if a valid token was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_int = implicit.octal(value)
    +
+ +
+
+ + decimal (value) +
+
+ Parse a decimal token, such as '0' or '12345'. + + +

Parameters:

+
    +
  • value + string + token +
    • +
+ +

Returns:

+
    + + int + integer equivalent, if a valid token was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_int = implicit.decimal(value)
    +
+ +
+
+ + hexadecimal (value) +
+
+ Parse a hexadecimal token, such as '0xdeadbeef'. + + +

Parameters:

+
    +
  • value + string + token +
    • +
+ +

Returns:

+
    + + int + integer equivalent, if a valid token was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_int = implicit.hexadecimal(value)
    +
+ +
+
+ + sexagesimal (value) +
+
+ Parse a sexagesimal token, such as '190:20:30'. + Useful for times and angles. + + +

Parameters:

+
    +
  • value + string + token +
    • +
+ +

Returns:

+
    + + int + integer equivalent, if a valid token was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_int = implicit.sexagesimal(value)
    +
+ +
+
+ + nan (value) +
+
+ Parse a nan token. + + +

Parameters:

+
    +
  • value + string + token +
    • +
+ +

Returns:

+
    + + nan + not-a-number, if a valid token was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_nan = implicit.nan(value)
    +
+ +
+
+ + inf (value) +
+
+ Parse a signed inf token. + + +

Parameters:

+
    +
  • value + string + token +
    • +
+ +

Returns:

+
    + + number + plus/minus-infinity, if a valid token was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_inf = implicit.inf(value)
    +
+ +
+
+ + float (value) +
+
+ Parse a floating point number token, such as '1e-3' or '-0.12'. + + +

Parameters:

+
    +
  • value + string + token +
    • +
+ +

Returns:

+
    + + number + float equivalent, if a valid token was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_float = implicit.float(value)
    +
+ +
+
+ + sexfloat (value) +
+
+ Parse a sexagesimal float, such as '190:20:30.15'. + Useful for times and angles. + + +

Parameters:

+
    +
  • value + string + token +
    • +
+ +

Returns:

+
    + + number + float equivalent, if a valid token was recognized +
+

Or

+
    + + nil + otherwise, nil +
+ + + +

Usage:

+
    + 
    maybe_float = implicit.sexfloat(value)
    +
+ +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2018-03-28 22:03:57 +
+
+ + diff --git a/lyaml-git-1.rockspec b/lyaml-6.2.2-1.rockspec similarity index 97% rename from lyaml-git-1.rockspec rename to lyaml-6.2.2-1.rockspec index 385e73f..f9210f1 100644 --- a/lyaml-git-1.rockspec +++ b/lyaml-6.2.2-1.rockspec @@ -1,4 +1,4 @@ -local _MODREV, _SPECREV = 'git', '-1' +local _MODREV, _SPECREV = '6.2.2', '-1' package = 'lyaml' version = _MODREV .. _SPECREV