Initial commit of source code for the DSL parser.

Author: simonbrowndotje

.gitignore

@@ -21,3 +21,8 @@
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
+
+.gradle
+.idea
+build
+out

build.gradle

@@ -0,0 +1,25 @@
+apply plugin: 'java'
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    compile 'com.structurizr:structurizr-client:1.4.3'
+
+    testCompile 'org.junit.jupiter:junit-jupiter-engine:5.6.2'
+}
+
+compileJava.options.encoding = 'UTF-8'
+compileTestJava.options.encoding = 'UTF-8'
+
+sourceCompatibility = 1.8
+targetCompatibility = 1.8
+
+description = 'Structurizr DSL'
+group = 'com.structurizr'
+version = '1.0.0'
+
+test {
+    useJUnitPlatform()
+}

docs/language-reference.md

@@ -66,7 +66,7 @@ See [https://structurizr.com/dsl](https://structurizr.com/dsl) for a demo of the
 - Opening curly brace symbols (```{```) must be on the same line (i.e. the last token of the statement, not on a line of their own).
 - Closing curly brace symbols (```}```) must be on a line of their own.
 - Use ```""``` as a placeholder for an earlier optional property that you'd like to skip.
-- Each view must have a unique "key".
+- Each view must have a unique "key" (this is autogenerated if not specified).
 - See [Structurizr - Notation](https://structurizr.com/help/notation) for details of how tags and styling works.
 
 ## Comments
@@ -179,42 +179,42 @@ workspace [name] [description] {
          
     views {
 
-        systemLandscape <key> [description] {
+        systemLandscape [key] [description] {
         	include <*|identifier> [identifier...]
             exclude <identifier> [identifier...]
             autoLayout [tb|bt|lr|rl] [rankSeparation] [nodeSeparation]
             animationStep <identifier> [identifier...]
         }
 
-        systemContext <software system identifier> <key> [description] {
+        systemContext <software system identifier> [key] [description] {
             include <*|identifier> [identifier...]
             exclude <identifier> [identifier...]
             autoLayout [tb|bt|lr|rl] [rankSeparation] [nodeSeparation]
             animationStep <identifier> [identifier...]
         }
 
-        container <software system identifier> <key> [description] {
+        container <software system identifier> [key] [description] {
             include <*|identifier> [identifier...]
             exclude <identifier> [identifier...]
             autoLayout [tb|bt|lr|rl] [rankSeparation] [nodeSeparation]
             animationStep <identifier> [identifier...]
         }
 
-        component <container identifier> <key> [description] {
+        component <container identifier> [key] [description] {
             include <*|identifier> [identifier...]
             exclude <identifier> [identifier...]
             autoLayout [tb|bt|lr|rl] [rankSeparation] [nodeSeparation]
             animationStep <identifier> [identifier...]
         }
 
-        filtered <baseKey> <include|exclude> <tags> <key> [description]
+        filtered <baseKey> <include|exclude> <tags> [key] [description]
 
-        dynamic <*|software system identifier|container identifier> <key> [description] {
+        dynamic <*|software system identifier|container identifier> [key] [description] {
             <identifier> -> <identifier> [description]
             autoLayout [tb|bt|lr|rl] [rankSeparation] [nodeSeparation]
         }
 
-        deployment <*|software system identifier> <environment name> <key> [description] {
+        deployment <*|software system identifier> <environment name> [key] [description] {
             include <*|identifier> [identifier...]
 			exclude <identifier> [identifier...]
             autoLayout [tb|bt|lr|rl] [rankSeparation] [nodeSeparation]
@@ -434,7 +434,7 @@ The ```views``` block can contain the following:
 The ```systemLandscape``` keyword is used to define a [System Landscape view](https://c4model.com/#SystemLandscapeDiagram).
 
 ```
-systemLandscape <key> [description] {
+systemLandscape [key] [description] {
 	...
 }
 ```
@@ -451,7 +451,7 @@ The following keywords can be used within the ```systemLandscape``` block:
 The ```systemContext``` keyword is used to define a [System Context view](https://c4model.com/#SystemContextDiagram) for the specified software system.
 
 ```
-systemContext <software system identifier> <key> [description] {
+systemContext <software system identifier> [key] [description] {
 	...
 }
 ```
@@ -468,7 +468,7 @@ The following keywords can be used within the ```systemContext``` block:
 The ```container``` keyword is used to define a [Container view](https://c4model.com/#ContainerDiagram) for the specified software system.
 
 ```
-container <software system identifier> <key> [description] {
+container <software system identifier> [key] [description] {
 	...
 }
 ```
@@ -485,7 +485,7 @@ The following keywords can be used within the ```container``` block:
 The ```component``` keyword is used to define a [Component view](https://c4model.com/#ComponentDiagram) for the specified container.
 
 ```
-component <container identifier> <key> [description] {
+component <container identifier> [key] [description] {
 	...
 }
 ```
@@ -502,7 +502,7 @@ The following keywords can be used within the ```component``` block:
 The ```filtered``` keyword is used to define a [Filtered view](https://structurizr.com/help/filtered-views) on top of the specified view.
 
 ```
-filtered <baseKey> <include|exclude> <tags> <key> [description]
+filtered <baseKey> <include|exclude> <tags> [key] [description]
 ```
 
 The ```baseKey``` specifies the key of the System Landscape, System Context, Container, or Component view on which this filtered view should be based. The mode (```include``` or ```exclude```) defines whether the view should include or exclude elements/relationships based upon the ```tags``` provided.
@@ -512,7 +512,7 @@ The ```baseKey``` specifies the key of the System Landscape, System Context, Con
 The ```dynamic``` keyword defines a [Dynamic view](https://c4model.com/#DynamicDiagram) for the specified scope.
 
 ```
-dynamic <*|software system identifier|container identifier> <key> [description] {
+dynamic <*|software system identifier|container identifier> [key] [description] {
 	...
 }
 ```
@@ -540,7 +540,7 @@ The following keywords can also be used within the ```dynamic``` block:
 The ```deployment``` keyword defines a [Deployment view](https://c4model.com/#DeploymentDiagram) for the specified scope and deployment environment.
 
 ```
-deployment <*|software system identifier> <environment name> <key> [description] {
+deployment <*|software system identifier> <environment name> [key] [description] {
 	...
 }
 ```

examples/amazon-web-services.dsl

@@ -7,7 +7,7 @@ workspace "Amazon Web Services Example" "An example AWS deployment architecture.
 
         webApplication -> database "Reads from and writes to", "JDBC/SSL"
 
-        deploymentEnvironment {
+        deploymentEnvironment "Live" {
             deploymentNode "Amazon Web Services" "" "" "Amazon Web Services - Cloud" {
                 deploymentNode "US-East-1" "" "" "Amazon Web Services - Region" {
                     route53 = infrastructureNode "Route 53" "" "" "Amazon Web Services - Route 53"
@@ -34,7 +34,7 @@ workspace "Amazon Web Services Example" "An example AWS deployment architecture.
     }
 
     views {
-        deployment springPetClinic "Default" "AmazonWebServicesDeployment" {
+        deployment springPetClinic "Live" "AmazonWebServicesDeployment" {
             include *
             autolayout lr
         }

examples/logo.png

@@ -0,0 +1,104 @@
+workspace "Name" "Description" {
+
+    model {
+
+        user = person "User" "Description" "Tag"
+        enterprise "Enterprise" {
+            softwareSystem = softwareSystem "Software System" "Description"  "Tag" {
+                webApplication = container "Web Application" "Description" "Technology" "Tag" {
+                    homePageController = component "HomePageController" "Description" "Spring MVC Controller" "Tag"
+                }
+            }
+            softwareSystem "E-mail System" "Description" "Tag"
+        }
+
+        user -> HomePageController "Visits" "HTTPS" "Tag"
+
+        deploymentEnvironment "Live" {
+            deploymentNode "Amazon Web Services" "Description" "Technology" "Tag" {
+                infrastructureNode "Elastic Load Balancer" "Description" "Technology" "Tag"
+                deploymentNode "Amazon Web Services - EC2" "Description" "Technology" "Tag" {
+                    containerInstance webApplication
+                }
+            }
+        }
+    }
+         
+    views {
+
+        systemLandscape "SystemLandscape" "Description" {
+            include *
+            autoLayout
+        }
+
+        systemContext softwareSystem "SystemContext" "Description" {
+            include *
+            autoLayout
+        }
+
+        container softwareSystem "Containers" "Description" {
+            include *
+            autoLayout
+        }
+
+        component webApplication "Components" "Description" {
+            include *
+            autoLayout
+        }
+
+        dynamic webApplication "Dynamic" "Description" {
+            user -> homePageController "Requests via web browser"
+            autoLayout
+        }
+
+        deployment * "Live" "Deployment-Live" "Description" {
+            include *
+            autoLayout
+        }
+
+        styles {
+            element "Element" {
+                shape roundedbox
+                icon logo.png
+                width 450
+                height 300
+                background #ffffff
+                color #000000
+                colour #000000
+                stroke #777777
+                fontSize 24
+                border solid
+                opacity 50
+                metadata false
+                description false
+            }
+
+            relationship "Relationship" {
+                thickness 2
+                color #777777
+                colour #777777
+                dashed true
+                routing curved
+                fontSize 24
+                width 400
+                position 50
+                opacity 50
+            }
+        }
+
+        themes https://example.com/theme1 https://example.com/theme2 https://example.com/theme3
+
+        branding {
+            logo logo.png
+            font "Example" https://example/com/font
+        }
+    }
+
+    /**
+        multi-line comment
+    */
+
+    # single line comment
+    // single line comment
+
+}