Source File
	spacings.go

Belonging Package
	github.com/d2lang/elk-go/internal/layered

// Copyright (c) 2015 Kiel University and others.
// Copyright (c) 2020 Kiel University and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0.
//
// SPDX-License-Identifier: EPL-2.0

package layered

import (
	"sync"

	basegraph "github.com/d2lang/elk-go/internal/graph"
)

type spacingTables struct {
	horizontal [6][6]*basegraph.Property[float64]
	vertical   [6][6]*basegraph.Property[float64]
}

var (
	spacingsOnce sync.Once
	spacingsData spacingTables
)

func layeredSpacingTables() *spacingTables {
	spacingsOnce.Do(func() {
		both := func(first, second NodeType, vertical, horizontal *basegraph.Property[float64]) {
			spacingsData.vertical[first][second] = vertical
			spacingsData.vertical[second][first] = vertical
			spacingsData.horizontal[first][second] = horizontal
			spacingsData.horizontal[second][first] = horizontal
		}
		vertical := func(first, second NodeType, property *basegraph.Property[float64]) {
			spacingsData.vertical[first][second] = property
			spacingsData.vertical[second][first] = property
		}

		both(NormalNode, NormalNode, &SpacingNodeNode, &SpacingNodeNodeBetweenLayers)
		both(NormalNode, LongEdgeNode, &SpacingEdgeNode, &SpacingEdgeNodeBetweenLayers)
		vertical(NormalNode, NorthSouthPortNode, &SpacingEdgeNode)
		vertical(NormalNode, ExternalPortNode, &SpacingEdgeNode)
		both(NormalNode, LabelNode, &SpacingNodeNode, &SpacingNodeNodeBetweenLayers)

		both(LongEdgeNode, LongEdgeNode, &SpacingEdgeEdge, &SpacingEdgeEdgeBetweenLayers)
		vertical(LongEdgeNode, NorthSouthPortNode, &SpacingEdgeEdge)
		vertical(LongEdgeNode, ExternalPortNode, &SpacingEdgeEdge)
		both(LongEdgeNode, LabelNode, &SpacingEdgeNode, &SpacingEdgeNodeBetweenLayers)

		vertical(NorthSouthPortNode, NorthSouthPortNode, &SpacingEdgeEdge)
		vertical(NorthSouthPortNode, ExternalPortNode, &SpacingEdgeEdge)
		vertical(NorthSouthPortNode, LabelNode, &SpacingLabelNode)

		vertical(ExternalPortNode, ExternalPortNode, &SpacingPortPort)
		both(ExternalPortNode, LabelNode, &SpacingLabelPortVertical, &SpacingLabelPortHorizontal)

		both(LabelNode, LabelNode, &SpacingEdgeEdge, &SpacingEdgeEdge)

		both(BreakingPointNode, BreakingPointNode, &SpacingEdgeEdge, &SpacingEdgeEdgeBetweenLayers)
		both(BreakingPointNode, NormalNode, &SpacingEdgeNode, &SpacingEdgeNodeBetweenLayers)
		both(BreakingPointNode, LabelNode, &SpacingEdgeNode, &SpacingEdgeNodeBetweenLayers)
		both(BreakingPointNode, LongEdgeNode, &SpacingEdgeNode, &SpacingEdgeNodeBetweenLayers)
	})
	return &spacingsData
}

func individualOrDefault(
	arena *LGraphArena,
	nodeID LNodeID,
	property *basegraph.Property[float64],
) float64 {
	node := arena.Node(nodeID)
	if individual, found := basegraph.TryGet(&node.Properties, SpacingIndividual); found {
		if value, explicit := basegraph.TryGet(&individual.Properties, *property); explicit {
			return value
		}
	}
	return basegraph.Get(&arena.Graph(arena.NodeGraph(nodeID)).Properties, *property)
}

// IndividualOrDefault exposes LayeredSpacings.getIndividualOrDefault to
// source-shaped phase implementations.
func IndividualOrDefault(
	arena *LGraphArena,
	nodeID LNodeID,
	property *basegraph.Property[float64],
) float64 {
	return individualOrDefault(arena, nodeID, property)
}

func nodeSpacing(
	arena *LGraphArena,
	first, second LNodeID,
	table *[6][6]*basegraph.Property[float64],
) float64 {
	firstType, secondType := arena.Node(first).Type, arena.Node(second).Type
	property := table[firstType][secondType]
	if property == nil {
		panic("layered: unspecified spacing between node types")
	}
	firstValue := individualOrDefault(arena, first, property)
	secondValue := individualOrDefault(arena, second, property)
	if firstValue > secondValue {
		return firstValue
	}
	return secondValue
}

func HorizontalSpacing(arena *LGraphArena, first, second LNodeID) float64 {
	return nodeSpacing(arena, first, second, &layeredSpacingTables().horizontal)
}

func VerticalSpacing(arena *LGraphArena, first, second LNodeID) float64 {
	return nodeSpacing(arena, first, second, &layeredSpacingTables().vertical)
}

func HorizontalSpacingByType(arena *LGraphArena, graphID LGraphID, first, second NodeType) float64 {
	property := layeredSpacingTables().horizontal[first][second]
	if property == nil {
		panic("layered: unspecified horizontal spacing between node types")
	}
	return basegraph.Get(&arena.Graph(graphID).Properties, *property)
}

func VerticalSpacingByType(arena *LGraphArena, graphID LGraphID, first, second NodeType) float64 {
	property := layeredSpacingTables().vertical[first][second]
	if property == nil {
		panic("layered: unspecified vertical spacing between node types")
	}
	return basegraph.Get(&arena.Graph(graphID).Properties, *property)
}

// ApplySpacingBaseValue reproduces LayeredSpacings.withBaseValue. Explicit
// values remain authoritative; all absent dependent spacings are scaled by
// their ELK 0.8.1 default-to-nodeNode-default ratio.
func ApplySpacingBaseValue(properties *basegraph.PropertyMap, base float64) {
	baseDefault := basegraph.Get(&basegraph.PropertyMap{}, SpacingNodeNode)
	basegraph.Set(properties, SpacingNodeNode, base)
	dependents := []*basegraph.Property[float64]{
		&SpacingComponentComponent,
		&SpacingEdgeEdge,
		&SpacingEdgeLabel,
		&SpacingEdgeNode,
		&SpacingLabelLabel,
		&SpacingLabelNode,
		&SpacingLabelPortHorizontal,
		&SpacingLabelPortVertical,
		&SpacingNodeSelfLoop,
		&SpacingPortPort,
		&SpacingEdgeEdgeBetweenLayers,
		&SpacingEdgeNodeBetweenLayers,
		&SpacingNodeNodeBetweenLayers,
	}
	for _, property := range dependents {
		if basegraph.Has(properties, *property) {
			continue
		}
		defaultValue := basegraph.Get(&basegraph.PropertyMap{}, *property)
		basegraph.Set(properties, *property, base*defaultValue/baseDefault)
	}
}

The pages are generated with Golds v0.8.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.