slot.go

package graphite

import (
	"github.com/benoitkugler/textlayout/fonts"
)

const (
	deleted uint8 = 1 << iota
	inserted
	copied
	positioned
	attached
)

// Slot represents one glyph in a shaped line of text.
// Slots are created from the input string, but may also
// be added or removed by the shaping process.
type Slot struct {
	// Next is the next slot along the segment (that is the next element in the linked list).
	// It is nil at the end of the segment.
	Next *Slot
	prev *Slot // linked list of slots

	// in addition to the main linear linked list, slots are organized
	// in a tree : attached slots form a singly linked list from the parent.
	parent *Slot // parent we are attached to

	// First slot in the children list. Note that this is a reference to another slot that is also in
	// the main segment doubly linked list.
	child   *Slot
	sibling *Slot // next child that attaches to our parent

	justs *slotJustify // pointer to justification parameters

	userAttrs []int16 // with length silf.NumUserDefn

	original int // charinfo that originated this slot (e.g. for feature values)

	// Each slot is associated with a range of characters in the input slice,
	// delimited by [Before, After].
	// Before is also the index of the position of the cursor before this slot.
	// After is also the index of the position of the cursor after this slot.
	Before, After int

	index       int // slot index given to this slot during finalising
	glyphID     GID
	realGlyphID GID // non zero for pseudo glyphs

	// Offset ot the glyph from the start of the segment.
	Position Position
	// Glyph advance for this glyph as adjusted for kerning
	Advance Position

	shift Position // .shift slot attribute

	attach    Position // attachment point on us
	with      Position // attachment point position on parent
	just      float32  // Justification inserted space
	flags     uint8    // holds bit flags
	attLevel  uint8    // attachment level
	bidiCls   int8     // bidirectional class
	bidiLevel uint8    // bidirectional level
}

// GID returns the glyph id to be rendered at the position given by the slot.
// Some slots may have a pseudo glyph, which is unknown to the font, but used during shaping,
// but the returned value is the real glyph and never a pseudo glyph.
func (sl *Slot) GID() fonts.GID {
	if sl.realGlyphID != 0 {
		return sl.realGlyphID
	}
	return sl.glyphID
}

// returns true if the slot has no parent
func (sl *Slot) isBase() bool {
	return sl.parent == nil
}

// move up the tree and return the highest non nil slot
func (is *Slot) findRoot() *Slot {
	for ; is.parent != nil; is = is.parent {
	}
	return is
}

// return true if the slot has `base` in its ancesters
func (is *Slot) isChildOf(base *Slot) bool {
	for p := is.parent; p != nil; p = p.parent {
		if p == base {
			return true
		}
	}
	return false
}

func (is *Slot) nextInCluster(s *Slot) *Slot {
	if s.child != nil {
		return s.child
	} else if s.sibling != nil {
		return s.sibling
	}
	for base := s.parent; base != nil; base = s.parent {
		// if (base.child == s && base.sibling)
		if base.sibling != nil {
			return base.sibling
		}
		s = base
	}
	return nil
}

func (sl *Slot) isDeleted() bool {
	return sl.flags&deleted != 0
}

func (sl *Slot) markDeleted(state bool) {
	if state {
		sl.flags |= deleted
	} else {
		sl.flags &= ^deleted
	}
}

func (sl *Slot) isCopied() bool {
	return sl.flags&copied != 0
}

func (sl *Slot) markCopied(state bool) {
	if state {
		sl.flags |= copied
	} else {
		sl.flags &= ^copied
	}
}

// CanInsertBefore returns whether text may be inserted before this glyph.
//
// This indicates whether a cursor can be put before this slot. It applies to
// base glyphs that have no parent as well as attached glyphs that have the
// .insert attribute explicitly set to true. This is the primary mechanism
// for identifying contiguous sequences of base plus diacritics.
func (sl *Slot) CanInsertBefore() bool {
	return sl.flags&inserted == 0
}

func (sl *Slot) markInsertBefore(state bool) {
	if !state { // notive the negation
		sl.flags |= inserted
	} else {
		sl.flags &= ^inserted
	}
}

// set the position taking `shift` into account
func (sl *Slot) setPosition(pos Position) {
	sl.Position = pos.add(sl.shift)
}

func (sl *Slot) setGlyph(seg *Segment, glyphID GID) {
	sl.glyphID = glyphID
	sl.bidiCls = -1
	theGlyph := seg.face.getGlyph(glyphID)
	if theGlyph == nil {
		sl.realGlyphID = 0
		sl.Advance = Position{}
		return

	}
	sl.realGlyphID = GID(theGlyph.attrs.get(uint16(seg.silf.attrPseudo)))
	if int(sl.realGlyphID) > len(seg.face.glyphs) {
		sl.realGlyphID = 0
	}
	aGlyph := theGlyph
	if sl.realGlyphID != 0 {
		aGlyph = seg.face.getGlyph(sl.realGlyphID)
		if aGlyph == nil {
			aGlyph = theGlyph
		}
	}
	sl.Advance = Position{X: float32(aGlyph.advance.x), Y: 0.}
	if seg.silf.attrSkipPasses != 0 {
		seg.mergePassBits(uint32(theGlyph.attrs.get(uint16(seg.silf.attrSkipPasses))))
		if len(seg.silf.passes) > 16 {
			seg.mergePassBits(uint32(theGlyph.attrs.get(uint16(seg.silf.attrSkipPasses)+1)) << 16)
		}
	}
}

func (sl *Slot) removeChild(ap *Slot) bool {
	if sl == ap || sl.child == nil || ap == nil {
		return false
	} else if ap == sl.child {
		nSibling := sl.child.sibling
		sl.child.sibling = nil
		sl.child = nSibling
		return true
	}
	for p := sl.child; p != nil; p = p.sibling {
		if p.sibling != nil && p.sibling == ap {
			p.sibling = p.sibling.sibling
			ap.sibling = nil
			return true
		}
	}
	return false
}

func (sl *Slot) setSibling(ap *Slot) bool {
	if sl == ap {
		return false
	} else if ap == sl.sibling {
		return true
	} else if sl.sibling == nil || ap == nil {
		sl.sibling = ap
	} else {
		return sl.sibling.setSibling(ap)
	}
	return true
}

func (sl *Slot) setChild(ap *Slot) bool {
	if sl == ap {
		return false
	} else if ap == sl.child {
		return true
	} else if sl.child == nil {
		sl.child = ap
	} else {
		return sl.child.setSibling(ap)
	}
	return true
}

func (sl *Slot) getJustify(seg *Segment, level uint8, subindex int) int16 {
	if level != 0 && int(level) >= len(seg.silf.justificationLevels) {
		return 0
	}

	if sl.justs != nil {
		return sl.justs.values[level][subindex]
	}

	if int(level) >= len(seg.silf.justificationLevels) {
		return 0
	}
	jAttrs := seg.silf.justificationLevels[level]

	switch subindex {
	case 0:
		return seg.face.getGlyphAttr(sl.glyphID, uint16(jAttrs.AttrStretch))
	case 1:
		return seg.face.getGlyphAttr(sl.glyphID, uint16(jAttrs.AttrShrink))
	case 2:
		return seg.face.getGlyphAttr(sl.glyphID, uint16(jAttrs.AttrStep))
	case 3:
		return seg.face.getGlyphAttr(sl.glyphID, uint16(jAttrs.AttrWeight))
	case 4:
		return 0 // not been set yet, so clearly 0
	}
	return 0
}

func (sl *Slot) getAttr(seg *Segment, ind attrCode, subindex int) int32 {
	if ind >= acJStretch && ind < acJStretch+20 && ind != acJWidth {
		indx := int(ind - acJStretch)
		return int32(sl.getJustify(seg, uint8(indx/numJustParams), indx%numJustParams))
	}

	switch ind {
	case acAdvX:
		return int32(sl.Advance.X)
	case acAdvY:
		return int32(sl.Advance.Y)
	case acAttTo:
		return boolToInt(sl.parent != nil)
	case acAttX:
		return int32(sl.attach.X)
	case acAttY:
		return int32(sl.attach.Y)
	case acAttXOff, acAttYOff:
		return 0
	case acAttWithX:
		return int32(sl.with.X)
	case acAttWithY:
		return int32(sl.with.Y)
	case acAttWithXOff, acAttWithYOff:
		return 0
	case acAttLevel:
		return int32(sl.attLevel)
	case acBreak:
		return int32(seg.getCharInfo(sl.original).breakWeight)
	case acCompRef:
		return 0
	case acDir:
		return int32(seg.dir & 1)
	case acInsert:
		return boolToInt(sl.CanInsertBefore())
	case acPosX:
		return int32(sl.Position.X) // but need to calculate it
	case acPosY:
		return int32(sl.Position.Y)
	case acShiftX:
		return int32(sl.shift.X)
	case acShiftY:
		return int32(sl.shift.Y)
	case acMeasureSol:
		return -1 // err what's this?
	case acMeasureEol:
		return -1
	case acJWidth:
		return int32(sl.just)
	case acUserDefnV1:
		subindex = 0
		fallthrough
	case acUserDefn:
		if subindex < int(seg.silf.userAttibutes) {
			return int32(sl.userAttrs[subindex])
		}
	case acSegSplit:
		return int32(seg.getCharInfo(sl.original).flags & 3)
	case acBidiLevel:
		return int32(sl.bidiLevel)
	case acColFlags:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.flags)
		}
	case acColLimitblx:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.limit.bl.X)
		}
	case acColLimitbly:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.limit.bl.Y)
		}
	case acColLimittrx:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.limit.tr.X)
		}
	case acColLimittry:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.limit.tr.Y)
		}
	case acColShiftx:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.offset.X)
		}
	case acColShifty:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.offset.Y)
		}
	case acColMargin:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.margin)
		}
	case acColMarginWt:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.marginWt)
		}
	case acColExclGlyph:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.exclGlyph)
		}
	case acColExclOffx:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.exclOffset.X)
		}
	case acColExclOffy:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.exclOffset.Y)
		}
	case acSeqClass:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.seqClass)
		}
	case acSeqProxClass:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.seqProxClass)
		}
	case acSeqOrder:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.seqOrder)
		}
	case acSeqAboveXoff:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.seqAboveXoff)
		}
	case acSeqAboveWt:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.seqAboveWt)
		}
	case acSeqBelowXlim:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.seqBelowXlim)
		}
	case acSeqBelowWt:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.seqBelowWt)
		}
	case acSeqValignHt:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.seqValignHt)
		}
	case acSeqValignWt:
		if c := seg.getCollisionInfo(sl); c != nil {
			return int32(c.seqValignWt)
		}
	}
	return 0
}

func (sl *Slot) setJustify(seg *Segment, level uint8, subindex int, value int16) {
	if level != 0 && int(level) >= len(seg.silf.justificationLevels) {
		return
	}
	if sl.justs == nil {
		j := seg.newJustify()
		if j == nil {
			return
		}
		j.loadSlot(sl, seg)
		sl.justs = j
	}
	sl.justs.values[level][subindex] = value
}

func (sl *Slot) setAttr(map_ *slotMap, ind attrCode, subindex int, value int16) {
	seg := map_.segment
	if ind == acUserDefnV1 {
		ind = acUserDefn
		subindex = 0
		if seg.silf.userAttibutes == 0 {
			return
		}
	} else if ind >= acJStretch && ind < acJStretch+20 && ind != acJWidth {
		indx := int(ind - acJStretch)
		sl.setJustify(seg, uint8(indx/numJustParams), indx%numJustParams, value)
		return
	}

	switch ind {
	case acAdvX:
		sl.Advance.X = float32(value)
	case acAdvY:
		sl.Advance.Y = float32(value)
	case acAttTo:
		idx := int(uint16(value))
		if idx < map_.size && map_.get(idx) != nil {
			other := map_.get(idx)
			if other == sl || other == sl.parent || other.isCopied() {
				break
			}
			if sl.parent != nil {
				sl.parent.removeChild(sl)
				sl.parent = nil
			}
			pOther := other
			count := 0
			foundOther := false
			for pOther != nil {
				count++
				if pOther == sl {
					foundOther = true
				}
				pOther = pOther.parent
			}
			for pOther = sl.child; pOther != nil; pOther = pOther.child {
				count++
			}
			for pOther = sl.sibling; pOther != nil; pOther = pOther.sibling {
				count++
			}
			if count < 100 && !foundOther && other.setChild(sl) {
				sl.parent = other
				if map_.isRTL != (idx > subindex) {
					sl.with = Position{sl.Advance.X, 0}
				} else { // normal match to previous root
					sl.attach = Position{other.Advance.X, 0}
				}
			}
		}
	case acAttX:
		sl.attach.X = float32(value)
	case acAttY:
		sl.attach.Y = float32(value)
	case acAttXOff, acAttYOff:
	case acAttWithX:
		sl.with.X = float32(value)
	case acAttWithY:
		sl.with.Y = float32(value)
	case acAttWithXOff, acAttWithYOff:
	case acAttLevel:
		sl.attLevel = byte(value)
	case acBreak:
		seg.getCharInfo(sl.original).breakWeight = value
	case acCompRef:
		// not sure what to do here
	case acDir:
	case acInsert:
		sl.markInsertBefore(value != 0)
	case acPosX:
		// can't set these here
	case acPosY:
	case acShiftX:
		sl.shift.X = float32(value)
	case acShiftY:
		sl.shift.Y = float32(value)
	case acMeasureSol, acMeasureEol:
	case acJWidth:
		sl.just = float32(value)
	case acSegSplit:
		seg.getCharInfo(sl.original).addFlags(uint8(value & 3))
	case acUserDefn:
		sl.userAttrs[subindex] = value
	case acColFlags:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.flags = uint16(value)
		}
	case acColLimitblx:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			s := c.limit
			c.limit = rect{Position{float32(value), s.bl.Y}, s.tr}
			c.flags = c.flags & ^collKNOWN
		}
	case acColLimitbly:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			s := c.limit
			c.limit = rect{Position{s.bl.X, float32(value)}, s.tr}
			c.flags = c.flags & ^collKNOWN
		}
	case acColLimittrx:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			s := c.limit
			c.limit = rect{s.bl, Position{float32(value), s.tr.Y}}
			c.flags = c.flags & ^collKNOWN
		}
	case acColLimittry:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			s := c.limit
			c.limit = rect{s.bl, Position{s.tr.X, float32(value)}}
			c.flags = c.flags & ^collKNOWN
		}
	case acColMargin:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.margin = uint16(value)
			c.flags = c.flags & ^collKNOWN
		}
	case acColMarginWt:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.marginWt = uint16(value)
			c.flags = c.flags & ^collKNOWN
		}
	case acColExclGlyph:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.exclGlyph = GID(value)
			c.flags = c.flags & ^collKNOWN
		}
	case acColExclOffx:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			s := c.exclOffset
			c.exclOffset = Position{float32(value), s.Y}
			c.flags = c.flags & ^collKNOWN
		}
	case acColExclOffy:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			s := c.exclOffset
			c.exclOffset = Position{s.X, float32(value)}
			c.flags = c.flags & ^collKNOWN
		}
	case acSeqClass:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.seqClass = uint16(value)
			c.flags = c.flags & ^collKNOWN
		}
	case acSeqProxClass:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.seqProxClass = uint16(value)
			c.flags = c.flags & ^collKNOWN
		}
	case acSeqOrder:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.seqOrder = uint16(value)
			c.flags = c.flags & ^collKNOWN
		}
	case acSeqAboveXoff:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.seqAboveXoff = value
			c.flags = c.flags & ^collKNOWN
		}
	case acSeqAboveWt:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.seqAboveWt = uint16(value)
			c.flags = c.flags & ^collKNOWN
		}
	case acSeqBelowXlim:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.seqBelowXlim = value
			c.flags = c.flags & ^collKNOWN
		}
	case acSeqBelowWt:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.seqBelowWt = uint16(value)
			c.flags = c.flags & ^collKNOWN
		}
	case acSeqValignHt:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.seqValignHt = uint16(value)
			c.flags = c.flags & ^collKNOWN
		}
	case acSeqValignWt:
		c := seg.getCollisionInfo(sl)
		if c != nil {
			c.seqValignWt = uint16(value)
			c.flags = c.flags & ^collKNOWN
		}
	}
}

func (sl *Slot) finalise(seg *Segment, font *FontOptions, base Position, bbox *rect, attrLevel uint8, clusterMin *float32, rtl, isFinal bool, depth int) Position {
	if depth > 100 || (attrLevel != 0 && sl.attLevel > attrLevel) {
		return Position{}
	}
	var scale float32 = 1

	shift := Position{sl.shift.X*(float32(boolToInt(rtl)*-2+1)) + sl.just, sl.shift.Y}
	tAdvance := sl.Advance.X + sl.just
	if coll := seg.getCollisionInfo(sl); isFinal && coll != nil {
		collshift := coll.offset
		if coll.flags&collKERN == 0 || rtl {
			shift = shift.add(collshift)
		}
	}
	glyphFace := seg.face.getGlyph(sl.glyphID)
	if font != nil {
		scale = font.scale
		shift = shift.scale(scale)
		tAdvance *= scale
	}
	var res Position

	sl.Position = base.add(shift)
	if sl.parent == nil {
		res = base.add(Position{tAdvance, sl.Advance.Y * scale})
		*clusterMin = sl.Position.X
	} else {
		sl.Position = sl.Position.add(sl.attach.sub(sl.with).scale(scale))
		var tAdv float32
		if sl.Advance.X >= 0.5 {
			tAdv = sl.Position.X + tAdvance - shift.X
		}
		res = Position{tAdv, 0}
		if (sl.Advance.X >= 0.5 || sl.Position.X < 0) && sl.Position.X < *clusterMin {
			*clusterMin = sl.Position.X
		}
	}

	if glyphFace != nil {
		ourBbox := glyphFace.bbox.scale(scale).addPosition(sl.Position)
		*bbox = bbox.widen(ourBbox)
	}

	if sl.child != nil && sl.child != sl && sl.child.parent == sl {
		tRes := sl.child.finalise(seg, font, sl.Position, bbox, attrLevel, clusterMin, rtl, isFinal, depth+1)
		if (sl.parent == nil || sl.Advance.X >= 0.5) && tRes.X > res.X {
			res = tRes
		}
	}

	if sl.parent != nil && sl.sibling != nil && sl.sibling != sl && sl.sibling.parent == sl.parent {
		tRes := sl.sibling.finalise(seg, font, base, bbox, attrLevel, clusterMin, rtl, isFinal, depth+1)
		if tRes.X > res.X {
			res = tRes
		}
	}

	if sl.parent == nil && *clusterMin < base.X {
		adj := Position{sl.Position.X - *clusterMin, 0.}
		res = res.add(adj)
		sl.Position = sl.Position.add(adj)
		if sl.child != nil {
			sl.child.floodShift(adj, 0)
		}
	}
	return res
}

func (sl *Slot) floodShift(adj Position, depth int) {
	if depth > 100 {
		return
	}
	sl.Position = sl.Position.add(adj)
	if sl.child != nil {
		sl.child.floodShift(adj, depth+1)
	}
	if sl.sibling != nil {
		sl.sibling.floodShift(adj, depth+1)
	}
}

func (sl *Slot) clusterMetric(seg *Segment, metric, attrLevel uint8, rtl bool) int32 {
	if int(sl.glyphID) >= len(seg.face.glyphs) {
		return 0
	}
	bbox := seg.face.getGlyph(sl.glyphID).bbox
	var clusterMin float32

	res := sl.finalise(seg, nil, Position{}, &bbox, attrLevel, &clusterMin, rtl, false, 0)

	switch metric {
	case kgmetLsb:
		return int32(bbox.bl.X)
	case kgmetRsb:
		return int32(res.X - bbox.tr.X)
	case kgmetBbTop:
		return int32(bbox.tr.Y)
	case kgmetBbBottom:
		return int32(bbox.bl.Y)
	case kgmetBbLeft:
		return int32(bbox.bl.X)
	case kgmetBbRight:
		return int32(bbox.tr.X)
	case kgmetBbWidth:
		return int32(bbox.tr.X - bbox.bl.X)
	case kgmetBbHeight:
		return int32(bbox.tr.Y - bbox.bl.Y)
	case kgmetAdvWidth:
		return int32(res.X)
	case kgmetAdvHeight:
		return int32(res.Y)
	default:
		return 0
	}
}

const numJustParams = 5

type slotJustify struct {
	values [][numJustParams]int16 // with length levels
}

func (sj *slotJustify) loadSlot(s *Slot, seg *Segment) {
	sj.values = make([][numJustParams]int16, len(seg.silf.justificationLevels))
	for i, justs := range seg.silf.justificationLevels {
		v := &sj.values[i]
		v[0] = seg.face.getGlyphAttr(s.glyphID, uint16(justs.AttrStretch))
		v[1] = seg.face.getGlyphAttr(s.glyphID, uint16(justs.AttrShrink))
		v[2] = seg.face.getGlyphAttr(s.glyphID, uint16(justs.AttrStep))
		v[3] = seg.face.getGlyphAttr(s.glyphID, uint16(justs.AttrWeight))
	}
}