Source File
	labels.go

Belonging Package
	github.com/pancsta/d2/d2renderers/d2scenebuild

package d2scenebuild

import (
	"fmt"
	"image/color"
	"math"
	"strings"

	"github.com/pancsta/d2/d2renderers/d2scene"
	"github.com/pancsta/d2/d2target"
	"github.com/pancsta/d2/lib/geo"
	"github.com/pancsta/d2/lib/label"
)

// buildConnectionMask creates one diagram-wide label mask. A label belonging
// to one object can cover an unrelated connection beneath it.
func (b *builder) buildConnectionMask(viewBox d2scene.Box) (*d2scene.Mask, error) {
	black := d2scene.SolidPaint{Color: color.NRGBA{A: 0xff}}
	white := d2scene.SolidPaint{Color: color.NRGBA{R: 0xff, G: 0xff, B: 0xff, A: 0xff}}
	holes := make([]*d2scene.Node, 0)

	for _, targetShape := range b.diagram.Shapes {
		if err := b.ctx.Err(); err != nil {
			return nil, err
		}
		position := label.FromString(targetShape.LabelPosition)
		if targetShape.Label == "" || !position.IsBorder() {
			continue
		}
		// Class and table shapes do not participate in the ordinary border-label
		// mask stage.
		if targetShape.Type == d2target.ShapeClass || targetShape.Type == d2target.ShapeSQLTable {
			continue
		}
		box, topLeft := shapeLabelPlacement(targetShape)
		holeBox, ok := borderLabelMaskBox(position, topLeft, targetShape.LabelWidth, targetShape.LabelHeight, box, targetShape.StrokeWidth)
		if !ok || holeBox.Width <= 0 || holeBox.Height <= 0 {
			continue
		}
		hole := d2scene.NewNode(d2scene.Rect{Box: holeBox, Fill: black})
		hole.ID = targetShape.ID + ":border-label-mask-hole"
		holes = append(holes, hole)
	}

	for _, connection := range b.diagram.Connections {
		if err := b.ctx.Err(); err != nil {
			return nil, err
		}
		if connection.Label == "" && connection.Icon == nil {
			continue
		}
		var holeBox d2scene.Box
		position := connection.IconPosition
		if connection.Label != "" {
			topLeft := connection.GetLabelTopLeft()
			if topLeft == nil {
				return nil, invalidField(fmt.Sprintf("connection %q", connection.ID), "labelPosition", connection.LabelPosition, "does not resolve on the route")
			}
			x := math.Round(topLeft.X) - 2
			width := connection.LabelWidth + 4
			if connection.Icon != nil {
				x -= d2target.CONNECTION_ICON_LABEL_GAP + d2target.DEFAULT_ICON_SIZE
				width += d2target.CONNECTION_ICON_LABEL_GAP + d2target.DEFAULT_ICON_SIZE
			}
			holeBox = d2scene.Box{
				X: x, Y: math.Round(topLeft.Y),
				Width: float64(width), Height: float64(connection.LabelHeight),
			}
			position = connection.LabelPosition
		} else {
			topLeft := connection.GetIconPosition()
			if topLeft == nil {
				return nil, invalidField(fmt.Sprintf("connection %q", connection.ID), "iconPosition", connection.IconPosition, "does not resolve on the route")
			}
			holeBox = d2scene.Box{
				X: topLeft.X - 2, Y: topLeft.Y,
				Width: d2target.DEFAULT_ICON_SIZE + 4, Height: d2target.DEFAULT_ICON_SIZE,
			}
		}
		hole := d2scene.NewNode(d2scene.Rect{
			Box:  holeBox,
			Fill: black,
		})
		hole.ID = connection.ID + ":label-mask-hole"
		if !label.FromString(position).IsOnEdge() {
			hole.Opacity = .75
		}
		holes = append(holes, hole)
	}

	if len(holes) == 0 {
		return nil, nil
	}
	root := d2scene.NewNode(nil)
	root.ID = "connection-label-mask"
	base := d2scene.NewNode(d2scene.Rect{Box: viewBox, Fill: white})
	base.ID = "connection-label-mask:base"
	root.Children = append(root.Children, base)
	root.Children = append(root.Children, holes...)
	return &d2scene.Mask{Type: d2scene.MaskLuminance, Root: root, Transform: d2scene.Identity()}, nil
}

func borderLabelMaskBox(position label.Position, topLeft *geo.Point, labelWidth, labelHeight int, shapeBox *geo.Box, strokeWidth int) (d2scene.Box, bool) {
	effectiveStrokeWidth := float64(strokeWidth)
	var box d2scene.Box
	switch position {
	case label.BorderTopLeft, label.BorderTopCenter, label.BorderTopRight:
		box = d2scene.Box{
			X: topLeft.X - 2, Y: shapeBox.TopLeft.Y - effectiveStrokeWidth/2,
			Width: float64(labelWidth + 4), Height: effectiveStrokeWidth,
		}
	case label.BorderBottomLeft, label.BorderBottomCenter, label.BorderBottomRight:
		box = d2scene.Box{
			X: topLeft.X - 2, Y: shapeBox.TopLeft.Y + shapeBox.Height - effectiveStrokeWidth/2,
			Width: float64(labelWidth + 4), Height: effectiveStrokeWidth,
		}
	case label.BorderLeftTop, label.BorderLeftMiddle, label.BorderLeftBottom:
		box = d2scene.Box{
			X: shapeBox.TopLeft.X - effectiveStrokeWidth/2, Y: topLeft.Y - 2,
			Width: effectiveStrokeWidth, Height: float64(labelHeight + 4),
		}
	case label.BorderRightTop, label.BorderRightMiddle, label.BorderRightBottom:
		box = d2scene.Box{
			X: shapeBox.TopLeft.X + shapeBox.Width - effectiveStrokeWidth/2, Y: topLeft.Y - 2,
			Width: effectiveStrokeWidth, Height: float64(labelHeight + 4),
		}
	default:
		return d2scene.Box{}, false
	}
	return box, true
}

func shapeLabelPlacement(targetShape d2target.Shape) (*geo.Box, *geo.Point) {
	geometry := targetGeometry(targetShape)
	position := label.FromString(targetShape.LabelPosition)
	var box *geo.Box
	if position.IsOutside() || position.IsBorder() {
		box = geometry.GetBox().Copy()
		if targetShape.ThreeDee {
			offsetY := d2target.THREE_DEE_OFFSET
			if targetShape.Type == d2target.ShapeHexagon {
				offsetY /= 2
			}
			box.TopLeft.Y -= float64(offsetY)
			box.Height += float64(offsetY)
			box.Width += float64(d2target.THREE_DEE_OFFSET)
		} else if targetShape.Multiple {
			box.TopLeft.Y -= float64(d2target.MULTIPLE_OFFSET)
			box.Height += float64(d2target.MULTIPLE_OFFSET)
			box.Width += float64(d2target.MULTIPLE_OFFSET)
		}
	} else {
		box = geometry.GetInnerBox()
	}
	topLeft := position.GetPointOnBox(box, label.PADDING, float64(targetShape.LabelWidth), float64(targetShape.LabelHeight))
	return box, topLeft
}

func (b *builder) buildConnectionLabels(connection d2target.Connection) ([]*d2scene.Node, error) {
	nodes := make([]*d2scene.Node, 0, 5)
	if connection.Label != "" {
		topLeft := connection.GetLabelTopLeft()
		if topLeft == nil {
			return nil, invalidField(fmt.Sprintf("connection %q", connection.ID), "labelPosition", connection.LabelPosition, "does not resolve on the route")
		}
		topLeft = geo.NewPoint(math.Round(topLeft.X), math.Round(topLeft.Y))
		if connection.Language == "latex" {
			latex, err := b.buildLatexLabelNode(
				fmt.Sprintf("connection %q", connection.ID), connection.ID+":label:0",
				connection.Label, connection.Color, topLeft,
			)
			if err != nil {
				return nil, err
			}
			nodes = append(nodes, latex)
		} else if connection.Language == "markdown" {
			markdown, err := b.buildConnectionMarkdown(connection, topLeft)
			if err != nil {
				return nil, err
			}
			nodes = append(nodes, markdown)
		} else if connection.Language != "" {
			object := fmt.Sprintf("connection %q", connection.ID)
			codeStyle, err := b.activeCodeStyle(object)
			if err != nil {
				return nil, err
			}
			runs, err := b.buildCodeTextRuns(
				object, connection.ID+":code", connection.Text, codeStyle,
				d2scene.Point{X: topLeft.X, Y: topLeft.Y},
			)
			if err != nil {
				return nil, err
			}
			nodes = append(nodes, runs...)
		} else {
			if connection.Fill != "" {
				fill, err := b.paint(connection.Fill, fmt.Sprintf("connection %q label fill", connection.ID))
				if err != nil {
					return nil, err
				}
				background := d2scene.NewNode(d2scene.Rect{
					Box: d2scene.Box{
						X: topLeft.X - 4, Y: topLeft.Y - 3,
						Width: float64(connection.LabelWidth + 8), Height: float64(connection.LabelHeight + 6),
					},
					RadiusX: 10, RadiusY: 10, Fill: fill,
				})
				background.ID = connection.ID + ":label-fill"
				nodes = append(nodes, background)
			}
			font, err := b.font(connection.Text)
			if err != nil {
				return nil, fmt.Errorf("scene: connection %q label: %w", connection.ID, err)
			}
			fontColor := connection.GetFontColor()
			underline := connection.Underline
			if connection.Link != "" {
				// Linked connection labels are underlined and use unvisited-link blue.
				fontColor = "blue"
				underline = true
			}
			fill, err := b.paint(fontColor, fmt.Sprintf("connection %q label color", connection.ID))
			if err != nil {
				return nil, err
			}
			nodes = append(nodes, centeredTextRuns(
				connection.ID+":label", connection.Label, topLeft,
				connection.LabelWidth, connection.LabelHeight, connection.FontSize,
				font, fill, underline,
			)...)
		}
	}

	for _, endpoint := range []struct {
		name  string
		text  *d2target.Text
		isDst bool
	}{
		{name: "src", text: connection.SrcLabel},
		{name: "dst", text: connection.DstLabel, isDst: true},
	} {
		if endpoint.text == nil || endpoint.text.Label == "" {
			continue
		}
		fontText := connection.Text
		fontText.Bold = false
		fontText.Italic = true
		fontText.Underline = false
		// Arrowhead labels use the primary italic face independently of the main
		// connection label's optional mono face.
		fontText.FontFamily = "default"
		font, err := b.font(fontText)
		if err != nil {
			return nil, fmt.Errorf("scene: connection %q %s arrowhead label: %w", connection.ID, endpoint.name, err)
		}
		colorValue := d2target.FG_COLOR
		if endpoint.text.Color != "" {
			colorValue = endpoint.text.Color
		}
		fill, err := b.paint(colorValue, fmt.Sprintf("connection %q %s arrowhead label color", connection.ID, endpoint.name))
		if err != nil {
			return nil, err
		}
		topLeft := connection.GetArrowheadLabelPosition(endpoint.isDst)
		nodes = append(nodes, centeredTextRuns(
			fmt.Sprintf("%s:%s-label", connection.ID, endpoint.name), endpoint.text.Label, topLeft,
			endpoint.text.LabelWidth, endpoint.text.LabelHeight, connection.FontSize,
			font, fill, false,
		)...)
	}
	return nodes, nil
}

func centeredTextRuns(idPrefix, text string, topLeft *geo.Point, width, height, fontSize int, font d2scene.Font, fill d2scene.Paint, underline bool) []*d2scene.Node {
	lines := strings.Split(text, "\n")
	lineAdvance := float64(height) / float64(len(lines))
	nodes := make([]*d2scene.Node, 0, len(lines))
	for index, line := range lines {
		lineTop := topLeft.Y + float64(index)*lineAdvance
		run := d2scene.TextRun{
			Text: line,
			Origin: d2scene.Point{
				X: topLeft.X + float64(width)/2,
				Y: topLeft.Y + float64(fontSize) + float64(index)*lineAdvance,
			},
			Anchor:    d2scene.AnchorMiddle,
			Font:      font,
			Fill:      fill,
			Underline: underline,
			Ink:       d2scene.NewBounds(topLeft.X, lineTop, topLeft.X+float64(width), lineTop+lineAdvance),
		}
		node := d2scene.NewNode(run)
		node.ID = fmt.Sprintf("%s:%d", idPrefix, index)
		nodes = append(nodes, node)
	}
	return nodes
}

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.