Fork of yml2 for pypi maintenance
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
Claudio Luck ea62dd37c2
use system-specific path separators
3 years ago
debian wip: add setup.py, README.md and debian packaging 5 years ago
samples make PyPI package 3 years ago
vim/syntax correcting «…» problems in parantheses 7 years ago
yml2 use system-specific path separators 3 years ago
.hgignore Merge 2.6.3 3 years ago
.hgtags Merge 2.6.3 3 years ago
COPYING.txt make PyPI package 3 years ago
LICENSE.txt make PyPI package 3 years ago
MANIFEST.in Merge 2.6.3 3 years ago
Makefile read version from setup.cfg 3 years ago
README.md Add a README. 3 years ago
README.rst make PyPI package 3 years ago
features.en.yhtml2 docs: Include files are always searched at standard location, too. 3 years ago
format.css initial commit 7 years ago
heading.en.yhtml2 Bump version to 2.6.3. 3 years ago
hello.en.yhtml2 initial commit 7 years ago
homepage.en.yhtml2 initial commit 7 years ago
index.en.yhtml2 initial commit 7 years ago
programming.en.yhtml2 initial commit 7 years ago
setup.cfg Merge 2.6.3 3 years ago
setup.py Merge 2.6.3 3 years ago
toolchain.en.yhtml2 docs: Include files are always searched at standard location, too. 3 years ago
yml2c Merge 2.6.3 3 years ago
yml2proc Merge 2.6.3 3 years ago
yslt.en.yhtml2 initial commit 7 years ago

README.md

What is YML?

Well, it's the idea not to need to define a grammar first when you want to use a Domain Specific Language. For that purpose, YML is being translated into XML. Let's make an example.

Everything which comes close to a C like language, parses without a grammar definition:

This:

template< class T > T max(T a, T b);

Parses to:

<?xml version='1.0' encoding='UTF-8'?>
<template>
  <generic>
    <class/>
    <T/>
  </generic>
  <T>
    <max>
      <parm>
        <T/>
        <a/>
      </parm>
      <parm>
        <T/>
        <b/>
      </parm>
    </max>
  </T>
</template>

Instead of defining grammars, you test out and play around until the results are matching your needs. If the resulting tree does not fit what you're expecting, change it by patching the grammar with decl:

This:

module A {
    interface B {
        attribute long n;
    };
};

Parses to:

<?xml version='1.0' encoding='UTF-8'?>
<module>
  <A>
    <interface>
      <B>
        <attribute>
          <long>
            <n/>
          </long>
        </attribute>
      </B>
    </interface>
  </A>
</module>

This does not look like what we want. So we tell YML that we have a module name after the module, an interface name after the interface and type and name after the attribute:

This:

decl module @name;
decl interface @name;
decl attribute @type @name;

module A {
    interface B {
        attribute long n;
    };
};

Parses to:

<?xml version='1.0' encoding='UTF-8'?>
<module name="A">
  <interface name="B">
    <attribute type="long" name="n"/>
  </interface>
</module>

What can I do with YML?

With YML you can:

  • use a C-like DSL without writing a grammar first
  • generate code out of this DSL using YSLT
  • generate code out of UML using YSLT on XMI
  • generate code out of any XML based language like SVG using YSLT
  • define a wiki like language in just a few lines like YHTML does
  • replace bad designed and complicated XML languages with simpler C-like ones
  • ... and much more.

How it works: Replacing angle brackets with some Python

Just writing down what I wanted to have instead of XML for a sample:

<list name="List of goods">
    <head>
        <columTitle>
            Goods
        </columnTitle>
        <columnTitle>
            Price
        </columnTitle>
    </head>
    <row>
        <value>
            Beer
        </value>
        <value>
            20
        </value>
    </row>
    <row>
        <value>
            Wine
        </value>
        <value>
            30
        </value>
    </row>
</list>

Something like that should be more easy, say, like this:

list "List of goods" {
    head title "Goods", title "Price";
    row value "Beer", value 20;
    row value "Wine", value 30;
}

Y Languages

The latter is what I call an Y language a language specified in YML. How could this be achieved? Well, what's to do? To have the required information, how to build XML from the script above, we need:

  • the information, that “list of goods” is an attribute named name, while Goods is the text value of a tag
  • title shout be written out as columnTitle

How to do that? Let's invent a simple definition language for that information:

decl list(name);
decl title alias columnTitle;