view wiki/main.wiki @ 805:a3fab8b74a7d

Updated wiki pages. Added new page mercurial.wiki.
author Aziz K?ksal <aziz.koeksal@gmail.com>
date Sat, 08 Mar 2008 22:09:59 +0100
parents c89ffd930727
children
line wrap: on
line source

=Purpose=
dil is a hand-crafted compiler implementation for the D programming language written in D 1.0 using the [http://dsource.org/projects/tango Tango] standard library. The lexer and the parser are fully implemented. Semantic analysis is being worked on. The backend will most probably be gcc or [http://llvm.org LLVM].

What dil can do at the present:
  * dil is fully internationalized and can output compiler messages in English, German, Turkish and Finnish. You can determine which language to use with a setting in config.d.
  * Generate documentation from DDoc comments. In comparison to dmd, dil has fewer bugs and also offers a few goodies. Example: documentation of [http://dil.googlecode.com/files/Tango_doc_0.99.5.zip Tango].
    * Unicode alphas are supported in macro, section and parameter names.
    * Every symbol can be linked to its source location.
    * Protection, linkage and storage class attributes are shown in brackets.
    * Reports warnings for undefined macros and unterminated macros (missing closing ')'.)
    * Every token in a code section is highlighted (customizable via html_map.d.)
    * Undocumented symbols can be included in the documentation using the '-i'-switch.
    * Shortcomings: symbols aren't highlighted in comment texts (rather for practical reasons;) variables/parameters with a !DeclaratorSuffix (e.g. `int a[]`) are slightly problematic; sometimes it shows that semantic info is lacking.
  * Generate XML or HTML documents. You can choose to generate tags for tokens only or you can also have the whole parse tree unparsed. The whitespace of the original source file is preserved. You can view the HTML documents in any browser you like. The XML documents can only be viewed in W3C-standards compatible browsers(`*`) in combination with an XML formatting CSS document. dil provides two ordinary CSS documents (for XML/HTML) which can be customized to one's heart's content. Example: dil's source code in [http://dil.googlecode.com/files/xml_rev709.zip XML] or [http://dil.googlecode.com/files/html_rev709.zip HTML]. (`*`Note: Internet Explorer is the only browser that spectacularly fails at this job.)
  * Produce module dependency graphs using the graphviz dot format. For example, see the [http://dil.googlecode.com/files/main.2.dot dot file] of dil: rendered in [http://dil.googlecode.com/files/main.2.svg SVG], [http://dil.googlecode.com/files/main.2.png PNG] (2.7MB) or [http://dil.googlecode.com/files/main.2.gif GIF]. Cyclic edges (import statements) and nodes (modules) are highlighted in red. The edges of public imports are bold.
  * Output code statistics (lines of code, count syntax tree nodes and tokens, number of whitespace characters etc.) When dil has advanced enough [http://www.aivosto.com/project/help/pm-oo-ck.html OO-metrics] will be supported. Example: [http://dil.googlecode.com/files/stats_dstress_r1835_2.txt dstress] (1.5MB text; totals are at the bottom)

  * dil can parse D 2.0 additions:
    * Delimited and token [http://www.digitalmars.com/d/lex.html#StringLiteral string literals].
    * [http://www.digitalmars.com/d/statement.html#ForeachRangeStatement ForeachRangeStatement].
    * Optional [http://www.digitalmars.com/d/expression.html#IsExpression TemplateParameterList in IsExpression].
    * const and invariant in !IsExpressions.
    * [http://www.digitalmars.com/d/template.html#TemplateThisParameter TemplateThisParameter].
    * Cast expressions: `cast(const)` and `cast(invariant)`.
    * Type constructors: `const(Type)` and `invariant(Type)`.
    * const and invariant attributes after the parameter list of a function (C++ style.)
    * `typeof(return)`.
    * Traits expressions: `__traits(Identifier)` and `__traits(Identifier, TemplateArguments)`.
    * const/invariant/final/scope/static as storage classes in parameter lists (e.g. `void func(ref const Foo f);`).
    * invariant as a storage class for declarations (e.g. `invariant Foo f;`).
    * The identifier `__EOF__` is interpreted as the end of file.

Features you will or might see in dil:
  * Refactoring (renaming symbols, modules; changing the type of a symbol etc.)
  * Coding rules enforcement.
  * Code search.
  * Code analysis (lint-like).
  * Code formatting.
  * Translate D code to other languages.
  * Port D 1.0 code to D 2.0.

*Meaning:*

The word dil comes from the Turkish language and means among other things a) tongue or b) language.
It is a very fitting name for this project because of its meaning and because it starts with the letter d and for the reason that the project owner has Turkish origins.

===Contact===
Feel free to join my channel, #dil, which I've set up on freenode.net.
You can also send me a plain e-Mail if you have questions regarding my project.

===License===
Some people might not like the license under which dil is currently being developed.
In fact, it could be off-putting for some programmers who would like to contribute to it or make use of it as a client.
However, please keep in mind that a lot of hours were spent in order to come up with a compiler that is well documented and has a solid design.
It is not unlikely that the author will put the project under a less restrictive license one time or another.
It could be LGPL3 or even BSD.
It very much depends on how many cookies and apple pies somebody might be willing to stuff the author with.

==Download==
There are no downloadable binaries yet.
If you have [http://dsource.org/projects/dsss DSSS] you can use the fetch command, "`dsss net fetch dil.zip`", to get the latest revision of the source code.
Click the "Source"-tab to find out how to get the sources using Mercurial.