Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dlang-community/SDLang-D

An SDLang (Simple Declarative Language) library for D
https://github.com/dlang-community/SDLang-D

Last synced: less than a minute ago
JSON representation

An SDLang (Simple Declarative Language) library for D

Awesome Lists containing this project

README

        

SDLang-D [![Build Status](https://travis-ci.org/Abscissa/SDLang-D.svg?branch=master)](https://travis-ci.org/Abscissa/SDLang-D/branches) [![Build status](https://ci.appveyor.com/api/projects/status/ffwp6rlabawodmup/branch/master?svg=true)](https://ci.appveyor.com/project/Abscissa/sdlang-d/branch/master)
========

An [SDLang (Simple Declarative Language)](http://sdlang.org/) library for
[D](http://dlang.org), to read and write SDLang. Both a
[DOM](https://github.com/Abscissa/SDLang-D/blob/master/HOWTO.md) and a
[Pull Parser](http://semitwist.com/sdlang-d/sdlang/parser/pullParseSource.html)
are provided.

Officially supported compiler versions are shown in
[.travis.yml](https://github.com/Abscissa/SDLang-D/blob/master/.travis.yml).

SDL is a data language like JSON, XML or YAML, except it's:
* Less verbose than JSON and XML.
* [Type](http://semitwist.com/sdl-mirror/Language+Guide.html#LanguageGuide-literals)-aware.
* Easier to learn and read than YAML.

This is what SDL looks like (some of these examples, and more, are from
[the original SDL site](http://semitwist.com/sdl-mirror/Language+Guide.html):
```
// A couple basic values
first "Joe"
last "Coder"

// Supports values, named attributes, and various data types
numbers 12 53 2 635
names "Sally" "Frank N. Stein"
pets chihuahua="small" dalmation="hyper" mastiff="big"

mixed 34.7f "Tim" somedate=2010/08/14

// Supports child tags
folder "myFiles" color="yellow" protection=on {
folder "my images" {
file "myHouse.jpg" color=true date=2005/11/05
file "myCar.jpg" color=false date=2002/01/05
}
folder "my documents" {
document "resume.pdf"
}
}
```

Tags are of this form:
```
[tag name] [values] [attributes] [children]
```

Attributes are simply values with names.

Tag and attribute names can optionally include a namespace prefix (ie,
```namespace:name```). All parts are optional, the only exception being
that an anonymous (ie, no name) tag must have at least one value.

Also:
* Tags are separated by either newline or semicolon.
* Whitespace and indentation is not significant (other than newlines).
* The line-continuation operator is ```\``` (backslash). This can be used
to split a tag across multiple lines.
* Line comments start with either ```#```, ```//``` or ```--```.
* Block comments start with ```/*``` and end with the first occurrence
of ```*/``` (ie, they do *not* nest).
* Values always come before the attributes.
* All the data types and syntax details are described in the
[Language Guide](https://github.com/Abscissa/SDLang-D/wiki/Language-Guide).
* Note that, unlike C-based languages, opening curly braces must be on the
*same* line, not the next line. [Why?](https://github.com/Abscissa/SDLang-D/blob/master/FAQ.md).

For more details on the langauge, see the
[Language Guide](https://github.com/Abscissa/SDLang-D/wiki/Language-Guide).

Differences from original Java implementation
---------------------------------------------

* License is zlib/libpng, not LGPL. (No source from the Java or Ruby
implementations was used or looked at. The libraries were *used* to
test compatibility, but the actual source code was not viewed.)
* [API](http://semitwist.com/sdlang-d/sdlang.html) is completely redesigned for D.
* Anonymous tags are named ```""``` (empty string) not ```"content"```.
* Dates with unknown or invalid time zones use a special type indicating
"unknown time zone" (```DateTimeFracUnknownZone```) instead of assuming GMT.

Documentation
-------------

* [Language Guide](https://github.com/Abscissa/SDLang-D/wiki/Language-Guide)
* [How to use SDLang-D (Tutorial / DOM API Overview)](https://github.com/Abscissa/SDLang-D/blob/master/HOWTO.md)
* [Pull Parse SDLang](http://semitwist.com/sdlang-d/sdlang/parser/pullParseSource.html)
* [API Reference](http://semitwist.com/sdlang-d/sdlang.html)
* [Changelog](https://github.com/Abscissa/SDLang-D/blob/master/CHANGELOG.md)
* [SDLang Wiki](https://github.com/Abscissa/SDLang-D/wiki)
* [SDLang-D FAQ](https://github.com/Abscissa/SDLang-D/blob/master/FAQ.md)
* [SDLang Language FAQ](https://github.com/Abscissa/SDLang-D/wiki/FAQ)
* [Included tools and scripts](https://github.com/Abscissa/SDLang-D/blob/master/TOOLS.md)
* [License](https://github.com/Abscissa/SDLang-D/blob/master/LICENSE.txt) (zlib/libpng)
* [Old Official SDL Site](http://sdl.ikayzo.org/display/SDL/Home) [[mirror](http://semitwist.com/sdl-mirror/Home.html)]