arunkumar9t2/compose-dot

Experimental Graphviz code generation POC built with Jetpack Compose compiler/runtime.

Compose Dot

Experimental proof of concept to generate GraphViz dot code via Jetpack Compose's tree management. Valid dot file content can be generated simply by provided @Composable functions like SubGraph or Cluster etc.

Project Structure

• app - Runnable sample
• dot - Pure Kotlin constructs for representing Dot statements
• compose-dot - Provides @Composable functions to construct dot statements using Compose Compiler Plugin.

Usage

For example, usage in Kotlin as follows.

DirectedGraph("Hello") {
    node {
        "shape" `=` "rectangle"
    }
    Cluster("Container A") {
        "Item 1" link "Item 2"
    }
    Cluster("Container B") {
        "Item 3" link "Item 4"
    }
    Cluster("Container C") {
        "Item 5" {
            "color" `=` "blue"
        }
        Cluster("Inner Container") {
            "Item 6" {
                "color" `=` "red"
            }
        }
    }
    "Item 1" link "Item 4"
    "Item 2" link "Item 5"
    "Item 6" link "Item 3"
}

Will generate the following .dot source code.

digraph "Hello" {
  node [shape="rectangle"]
  "Item 1" -> "Item 4"
  "Item 2" -> "Item 5"
  "Item 6" -> "Item 3"
  subgraph "cluster_Container A" {
    graph [label="Container A"]
    "Item 1" -> "Item 2"
  }
  subgraph "cluster_Container B" {
    graph [label="Container B"]
    "Item 3" -> "Item 4"
  }
  subgraph "cluster_Container C" {
    graph [label="Container C"]
    "Item 5" [color="blue"]
    subgraph "cluster_Inner Container" {
      graph [label="Inner Container"]
      "Item 6" [color="red"]
    }
  }
}

Visualized via dot command

Further reading

• Jetpack Compose for Non UI - Tree construction and source code generation

Motivation

• Dot file generation was initially implemented using standard Kotlin API for https://github.com/arunkumar9t2/scabbard

License

Copyright 2021 Arunkumar

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.