debian-packages/dyaml
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Final changes for the 0.2 release (hopefully).

Browse source
This commit is contained in:
Ferdinand Majerech 2011-10-15 18:28:34 +02:00
parent 210091a75f
commit 5547f62176
13 changed files with 71 additions and 63 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
CHANGES.txt Normal file
View file

@ -0,0 +1,19 @@
0.2.0:
- FEATURES/IMPROVEMENTS:
- Implemented YAML emitter, and related unittests/documentation.
- Tags are now stored in nodes, allowing D:YAML to be closer to the
specification.
- Loader API has been broken to make it more extensible in future -
Representer and Constructor are no more specified in the constructor,
and the load() shortcut functions have been removed, as all that's needed to
load a YAML document now is Loader("file.yaml").load() .
- BUGFIXES:
- Fixed many bugs in the parser, scanner, composer and constructor.

26
README.html
View file

@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
<title>D:YAML 0.1</title>
<title>D:YAML 0.2</title>
<style type="text/css">
/*
@ -310,22 +310,20 @@ ul.auto-toc {
</style>
</head>
<body>
<div class="document" id="d-yaml-0-1">
<h1 class="title">D:YAML 0.1</h1>
<div class="document" id="d-yaml-0-2">
<h1 class="title">D:YAML 0.2</h1>
<div class="section" id="introduction">
<h1>Introduction</h1>
<p>D:YAML is an open source YAML parser library for the D programming language.
It is
<p>D:YAML is an open source YAML parser and emitter library for the D programming
language. It is
(<a class="reference external" href="https://github.com/kiith-sa/D-YAML/wiki/Differences-between-D:YAML-and-the-YAML-specification">almost</a>)
compliant to the YAML 1.1 specification. Much of D:YAML code is based on
<a class="reference external" href="http://www.pyyaml.org">PyYAML</a> created by Kirill Simonov. D:YAML has no
external dependencies, all it needs is a D compiler and Phobos (standard
library). It is written in D2 and there are no plans for D1 or Tango support.</p>
<p>At the moment, D:YAML can only read, not write YAML files. This will change in
the following releases. D:YAML is designed to be as easy to use as possible while
supporting the full feature set of YAML. To start using it in your project,
see the
<p>D:YAML is designed to be as easy to use as possible while supporting the full
feature set of YAML. To start using it in your project, see the
<a class="reference external" href="https://github.com/kiith-sa/D-YAML/wiki/Getting-Started">Getting Started</a>
tutorial.</p>
<p>D:YAML is still a work in progress. Its API is still not stable and there might
@ -341,7 +339,7 @@ to be rewritten in future and D:YAML will change accordingly.</p>
<li>No external dependencies.</li>
<li>Supports all YAML 1.1 constructs. All examples from the YAML 1.1 specification
are parsed correctly.</li>
<li>Read from YAML files as well as from memory or user defined streams.</li>
<li>Read and write from/to YAML files as well as memory or user defined streams.</li>
<li>UTF-8, UTF-16 and UTF-32 encodings are supported, both big and little endian
(plain ASCII also works as it is a subset of UTF-8).</li>
<li>Support for both block (Python-like, based on indentation) and flow
@ -349,11 +347,10 @@ are parsed correctly.</li>
<li>Support for YAML anchors and aliases.</li>
<li>Support for default values in mappings.</li>
<li>Support for custom tags (data types), and implicit tag resolution for custom
tags.</li>
scalar tags.</li>
<li>All tags (data types) described at <a class="reference external" href="http://yaml.org/type/">http://yaml.org/type/</a> are supported, with
the exception of <tt class="docutils literal">tag:yaml.org,2002:yaml</tt>, which is used to represent YAML
code in YAML.</li>
<li>Cannot write YAML at the moment. This will change in the future.</li>
<li>There is no support for recursive data structures.
There are no plans to implement this at the moment.</li>
</ul>
@ -445,11 +442,6 @@ DEALINGS IN THE SOFTWARE.
<p>D:YAML was created using Vim and DMD on Debian and Ubuntu Linux as a YAML parsing
library for the <a class="reference external" href="http://www.d-programming-language.org">D programming language</a>.</p>
</div>
</div>
<div class="footer">
<hr class="footer" />
Generated on: 2011-08-16 20:07 UTC.
</div>
</body>
</html>

23
README.rst
View file

@ -1,23 +1,21 @@
==========
D:YAML 0.1
D:YAML 0.2
==========
------------
Introduction
------------
D:YAML is an open source YAML parser library for the D programming language.
It is
D:YAML is an open source YAML parser and emitter library for the D programming
language. It is
(`almost <https://github.com/kiith-sa/D-YAML/wiki/Differences-between-D:YAML-and-the-YAML-specification>`_)
compliant to the YAML 1.1 specification. Much of D:YAML code is based on
`PyYAML <http://www.pyyaml.org>`_ created by Kirill Simonov. D:YAML has no
external dependencies, all it needs is a D compiler and Phobos (standard
library). It is written in D2 and there are no plans for D1 or Tango support.
At the moment, D:YAML can only read, not write YAML files. This will change in
the following releases. D:YAML is designed to be as easy to use as possible while
supporting the full feature set of YAML. To start using it in your project,
see the
D:YAML is designed to be as easy to use as possible while supporting the full
feature set of YAML. To start using it in your project, see the
`Getting Started <https://github.com/kiith-sa/D-YAML/wiki/Getting-Started>`_
tutorial.
@ -36,7 +34,7 @@ Features
* No external dependencies.
* Supports all YAML 1.1 constructs. All examples from the YAML 1.1 specification
are parsed correctly.
* Read from YAML files as well as from memory or user defined streams.
* Read and write from/to YAML files as well as memory or user defined streams.
* UTF-8, UTF-16 and UTF-32 encodings are supported, both big and little endian
(plain ASCII also works as it is a subset of UTF-8).
* Support for both block (Python-like, based on indentation) and flow
@ -44,11 +42,10 @@ Features
* Support for YAML anchors and aliases.
* Support for default values in mappings.
* Support for custom tags (data types), and implicit tag resolution for custom
tags.
scalar tags.
* All tags (data types) described at http://yaml.org/type/ are supported, with
the exception of ``tag:yaml.org,2002:yaml``, which is used to represent YAML
code in YAML.
* Cannot write YAML at the moment. This will change in the future.
* There is no support for recursive data structures.
There are no plans to implement this at the moment.
@ -57,16 +54,16 @@ Features
Directory structure
-------------------
=============== ======================================================================
=============== =======================================================================
Directory Contents
=============== ======================================================================
=============== =======================================================================
``./`` This README file, utility scripts, D:YAML sources outside any packages.
``./doc`` Documentation.
``./docsrc`` Documentation sources.
``./dyaml`` D:YAML source code.
``./examples/`` Example D:YAML code.
``./test`` Unittest code and inputs.
=============== ======================================================================
=============== =======================================================================
-----------------------

BIN
doc/doctrees/environment.pickle
View file

Binary file not shown.

2
doc/html/.buildinfo
View file

@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: bc848a1b422611af46aa082001644165
config: 3b89228da749be7cd7bc0e0980432c5f
tags: fbb0d17656682115ca4d033fb2f83ba1

10
doc/html/articles/spec_differences.html
View file

@ -7,13 +7,13 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Differences between D:YAML and the YAML specification &mdash; D:YAML v0.1 documentation</title>
<title>Differences between D:YAML and the YAML specification &mdash; D:YAML v0.2 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.1',
VERSION: '0.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -22,7 +22,7 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="D:YAML v0.1 documentation" href="../index.html" />
<link rel="top" title="D:YAML v0.2 documentation" href="../index.html" />
<link rel="prev" title="YAML syntax" href="../tutorials/yaml_syntax.html" />
</head>
<body>
@ -32,7 +32,7 @@
<li class="right" style="margin-right: 10px">
<a href="../tutorials/yaml_syntax.html" title="YAML syntax"
accesskey="P">previous</a></li>
<li><a href="../index.html">D:YAML v0.1 documentation</a> &raquo;</li>
<li><a href="../index.html">D:YAML v0.2 documentation</a> &raquo;</li>
</ul>
</div>
@ -133,7 +133,7 @@ struct appears in Phobos.</p>
<li class="right" style="margin-right: 10px">
<a href="../tutorials/yaml_syntax.html" title="YAML syntax"
>previous</a></li>
<li><a href="../index.html">D:YAML v0.1 documentation</a> &raquo;</li>
<li><a href="../index.html">D:YAML v0.2 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

10
doc/html/index.html
View file

@ -7,13 +7,13 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to D:YAML documentation! &mdash; D:YAML v0.1 documentation</title>
<title>Welcome to D:YAML documentation! &mdash; D:YAML v0.2 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.1',
VERSION: '0.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -22,7 +22,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="D:YAML v0.1 documentation" href="#" />
<link rel="top" title="D:YAML v0.2 documentation" href="#" />
<link rel="next" title="Getting started" href="tutorials/getting_started.html" />
</head>
<body>
@ -32,7 +32,7 @@
<li class="right" style="margin-right: 10px">
<a href="tutorials/getting_started.html" title="Getting started"
accesskey="N">next</a></li>
<li><a href="#">D:YAML v0.1 documentation</a> &raquo;</li>
<li><a href="#">D:YAML v0.2 documentation</a> &raquo;</li>
</ul>
</div>
@ -99,7 +99,7 @@
<li class="right" style="margin-right: 10px">
<a href="tutorials/getting_started.html" title="Getting started"
>next</a></li>
<li><a href="#">D:YAML v0.1 documentation</a> &raquo;</li>
<li><a href="#">D:YAML v0.2 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

BIN
doc/html/objects.inv
View file

Binary file not shown.

10
doc/html/search.html
View file

@ -7,13 +7,13 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; D:YAML v0.1 documentation</title>
<title>Search &mdash; D:YAML v0.2 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.1',
VERSION: '0.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="D:YAML v0.1 documentation" href="index.html" />
<link rel="top" title="D:YAML v0.2 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
@ -34,7 +34,7 @@
<div class="related">
<h3>Navigation</h3>
<ul>
<li><a href="index.html">D:YAML v0.1 documentation</a> &raquo;</li>
<li><a href="index.html">D:YAML v0.2 documentation</a> &raquo;</li>
</ul>
</div>
@ -82,7 +82,7 @@
<div class="related">
<h3>Navigation</h3>
<ul>
<li><a href="index.html">D:YAML v0.1 documentation</a> &raquo;</li>
<li><a href="index.html">D:YAML v0.2 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

10
doc/html/tutorials/custom_types.html
View file

@ -7,13 +7,13 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Custom YAML data types &mdash; D:YAML v0.1 documentation</title>
<title>Custom YAML data types &mdash; D:YAML v0.2 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.1',
VERSION: '0.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -22,7 +22,7 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="D:YAML v0.1 documentation" href="../index.html" />
<link rel="top" title="D:YAML v0.2 documentation" href="../index.html" />
<link rel="next" title="YAML syntax" href="yaml_syntax.html" />
<link rel="prev" title="Getting started" href="getting_started.html" />
</head>
@ -36,7 +36,7 @@
<li class="right" >
<a href="getting_started.html" title="Getting started"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">D:YAML v0.1 documentation</a> &raquo;</li>
<li><a href="../index.html">D:YAML v0.2 documentation</a> &raquo;</li>
</ul>
</div>
@ -375,7 +375,7 @@ directory of the D:YAML package.</p>
<li class="right" >
<a href="getting_started.html" title="Getting started"
>previous</a> |</li>
<li><a href="../index.html">D:YAML v0.1 documentation</a> &raquo;</li>
<li><a href="../index.html">D:YAML v0.2 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

10
doc/html/tutorials/getting_started.html
View file

@ -7,13 +7,13 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Getting started &mdash; D:YAML v0.1 documentation</title>
<title>Getting started &mdash; D:YAML v0.2 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.1',
VERSION: '0.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -22,7 +22,7 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="D:YAML v0.1 documentation" href="../index.html" />
<link rel="top" title="D:YAML v0.2 documentation" href="../index.html" />
<link rel="next" title="Custom YAML data types" href="custom_types.html" />
<link rel="prev" title="Welcome to D:YAML documentation!" href="../index.html" />
</head>
@ -36,7 +36,7 @@
<li class="right" >
<a href="../index.html" title="Welcome to D:YAML documentation!"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">D:YAML v0.1 documentation</a> &raquo;</li>
<li><a href="../index.html">D:YAML v0.2 documentation</a> &raquo;</li>
</ul>
</div>
@ -232,7 +232,7 @@ example in the <tt class="docutils literal"><span class="pre">example/getting_st
<li class="right" >
<a href="../index.html" title="Welcome to D:YAML documentation!"
>previous</a> |</li>
<li><a href="../index.html">D:YAML v0.1 documentation</a> &raquo;</li>
<li><a href="../index.html">D:YAML v0.2 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

10
doc/html/tutorials/yaml_syntax.html
View file

@ -7,13 +7,13 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>YAML syntax &mdash; D:YAML v0.1 documentation</title>
<title>YAML syntax &mdash; D:YAML v0.2 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.1',
VERSION: '0.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -22,7 +22,7 @@
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="D:YAML v0.1 documentation" href="../index.html" />
<link rel="top" title="D:YAML v0.2 documentation" href="../index.html" />
<link rel="next" title="Differences between D:YAML and the YAML specification" href="../articles/spec_differences.html" />
<link rel="prev" title="Custom YAML data types" href="custom_types.html" />
</head>
@ -36,7 +36,7 @@
<li class="right" >
<a href="custom_types.html" title="Custom YAML data types"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">D:YAML v0.1 documentation</a> &raquo;</li>
<li><a href="../index.html">D:YAML v0.2 documentation</a> &raquo;</li>
</ul>
</div>
@ -325,7 +325,7 @@ Some of these might change in the future (especially !!map and !!set).</p>
<li class="right" >
<a href="custom_types.html" title="Custom YAML data types"
>previous</a> |</li>
<li><a href="../index.html">D:YAML v0.1 documentation</a> &raquo;</li>
<li><a href="../index.html">D:YAML v0.2 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

4
docsrc/conf.py
View file

@ -49,9 +49,9 @@ copyright = (u'2011, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org '
# built documents.
#
# The short X.Y version.
version = '0.1'
version = '0.2'
# The full version, including alpha/beta/rc tags.
release = '0.1'
release = '0.2'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.