forks
/
D-Scanner
mirror of https://github.com/dlang-community/D-Scanner.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add syntax highlighting to the readme (#478)

This commit is contained in:
clYd3r 2017-06-24 14:40:18 +02:00 committed by Petar Kirov
parent 7de68bf5f9
commit 721f2bc907
1 changed files with 89 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

171
README.md
View File

@ -21,11 +21,13 @@ compilers instead of DMD. To install, simply place the generated binary (in the
# Usage # Usage
The following examples assume that we are analyzing a simple file called helloworld.d The following examples assume that we are analyzing a simple file called helloworld.d
import std.stdio; ```d
void main(string[] args) import std.stdio;
{ void main(string[] args)
writeln("Hello World"); {
} writeln("Hello World");
}
```
### Token Count ### Token Count
The "--tokenCount" or "-t" option prints the number of tokens in the given file The "--tokenCount" or "-t" option prints the number of tokens in the given file
@ -214,83 +216,88 @@ If a `dscanner.ini` file is locate in the working directory or any of it's paren
The "--ast" or "--xml" options will dump the complete abstract syntax tree of The "--ast" or "--xml" options will dump the complete abstract syntax tree of
the given source file to standard output in XML format. the given source file to standard output in XML format.
$ dscanner --ast helloworld.d ```sh
<module> $ dscanner --ast helloworld.d
<declaration> ```
<importDeclaration>
<singleImport> ```xml
<identifierChain> <module>
<identifier>std</identifier> <declaration>
<identifier>stdio</identifier> <importDeclaration>
</identifierChain> <singleImport>
</singleImport> <identifierChain>
</importDeclaration> <identifier>std</identifier>
</declaration> <identifier>stdio</identifier>
<declaration> </identifierChain>
<functionDeclaration line="3"> </singleImport>
<name>main</name> </importDeclaration>
<type pretty="void"> </declaration>
<type2> <declaration>
void <functionDeclaration line="3">
</type2> <name>main</name>
</type> <type pretty="void">
<parameters> <type2>
<parameter> void
<name>args</name> </type2>
<type pretty="string[]"> </type>
<type2> <parameters>
<symbol> <parameter>
<identifierOrTemplateChain> <name>args</name>
<identifierOrTemplateInstance> <type pretty="string[]">
<identifier>string</identifier> <type2>
</identifierOrTemplateInstance> <symbol>
</identifierOrTemplateChain> <identifierOrTemplateChain>
</symbol> <identifierOrTemplateInstance>
</type2> <identifier>string</identifier>
<typeSuffix type="[]"/> </identifierOrTemplateInstance>
</type> </identifierOrTemplateChain>
<identifier>args</identifier> </symbol>
</parameter> </type2>
</parameters> <typeSuffix type="[]"/>
<functionBody> </type>
<blockStatement> <identifier>args</identifier>
<declarationsAndStatements> </parameter>
<declarationOrStatement> </parameters>
<statement> <functionBody>
<statementNoCaseNoDefault> <blockStatement>
<expressionStatement> <declarationsAndStatements>
<expression> <declarationOrStatement>
<assignExpression> <statement>
<functionCallExpression> <statementNoCaseNoDefault>
<unaryExpression> <expressionStatement>
<primaryExpression> <expression>
<identifierOrTemplateInstance> <assignExpression>
<identifier>writeln</identifier> <functionCallExpression>
</identifierOrTemplateInstance> <unaryExpression>
</primaryExpression> <primaryExpression>
</unaryExpression> <identifierOrTemplateInstance>
<arguments> <identifier>writeln</identifier>
<argumentList> </identifierOrTemplateInstance>
<assignExpression> </primaryExpression>
<primaryExpression> </unaryExpression>
<stringLiteral>Hello World</stringLiteral> <arguments>
</primaryExpression> <argumentList>
</assignExpression> <assignExpression>
</argumentList> <primaryExpression>
</arguments> <stringLiteral>Hello World</stringLiteral>
</functionCallExpression> </primaryExpression>
</assignExpression> </assignExpression>
</expression> </argumentList>
</expressionStatement> </arguments>
</statementNoCaseNoDefault> </functionCallExpression>
</statement> </assignExpression>
</declarationOrStatement> </expression>
</declarationsAndStatements> </expressionStatement>
</blockStatement> </statementNoCaseNoDefault>
</functionBody> </statement>
</functionDeclaration> </declarationOrStatement>
</declaration> </declarationsAndStatements>
</module> </blockStatement>
</functionBody>
</functionDeclaration>
</declaration>
</module>
```
For more readable output, pipe the command through [xmllint](http://xmlsoft.org/xmllint.html) For more readable output, pipe the command through [xmllint](http://xmlsoft.org/xmllint.html)
using its formatting switch. using its formatting switch.