dolt/types/ref.go

// Copyright 2016 The Noms Authors. All rights reserved.
// Licensed under the Apache License, version 2.0:
// http://www.apache.org/licenses/LICENSE-2.0

package types

import (
	"github.com/attic-labs/noms/d"
	"github.com/attic-labs/noms/hash"
)

type Ref struct {
	target hash.Hash
	height uint64
	t      *Type
	hash   *hash.Hash
}

func NewRef(v Value) Ref {
	return Ref{v.Hash(), maxChunkHeight(v) + 1, MakeRefType(v.Type()), &hash.Hash{}}
}

// Constructs a Ref directly from struct properties. This should not be used outside decoding and testing within the types package.
func constructRef(t *Type, target hash.Hash, height uint64) Ref {
	d.Chk.Equal(RefKind, t.Kind())
	d.Chk.NotEqual(ValueType, t.Desc.(CompoundDesc).ElemTypes[0])
	return Ref{target, height, t, &hash.Hash{}}
}

func maxChunkHeight(v Value) (max uint64) {
	if chunks := v.Chunks(); chunks != nil {
		for _, r := range chunks {
			if height := r.Height(); height > max {
				max = height
			}
		}
	}
	return
}

func (r Ref) TargetHash() hash.Hash {
	return r.target
}

func (r Ref) Height() uint64 {
	return r.height
}

func (r Ref) TargetValue(vr ValueReader) Value {
	return vr.ReadValue(r.target)
}

// Value interface
func (r Ref) Equals(other Value) bool {
	return other != nil && r.t.Equals(other.Type()) && r.Hash() == other.Hash()
}

func (r Ref) Less(other Value) bool {
	return valueLess(r, other)
}

func (r Ref) Hash() hash.Hash {
	return EnsureHash(r.hash, r)
}

func (r Ref) ChildValues() []Value {
	return nil
}

func (r Ref) Chunks() (chunks []Ref) {
	return append(chunks, r)
}

func (r Ref) Type() *Type {
	return r.t
}