OpenDiablo2/d2common/text_dictionary.go

package d2common

import (
	"log"
	"strconv"
)

type textDictionaryHashEntry struct {
	IsActive    bool
	Index       uint16
	HashValue   uint32
	IndexString uint32
	NameString  uint32
	NameLength  uint16
}

var lookupTable map[string]string //nolint:gochecknoglobals // currently global by design

const (
	crcByteCount = 2
)

// TranslateString returns the translation of the given string
func TranslateString(key string) string {
	result, ok := lookupTable[key]
	if !ok {
		// Fix to allow v.setDescLabels("#123") to be bypassed for a patch in issue #360. Reenable later.
		// log.Panicf("Could not find a string for the key '%s'", key)
		return key
	}

	return result
}

// LoadTextDictionary loads the text dictionary from the given data
func LoadTextDictionary(dictionaryData []byte) {
	if lookupTable == nil {
		lookupTable = make(map[string]string)
	}

	br := CreateStreamReader(dictionaryData)

	// skip past the CRC
	br.ReadBytes(crcByteCount)

	numberOfElements := br.GetUInt16()
	hashTableSize := br.GetUInt32()

	// Version (always 0)
	if _, err := br.ReadByte(); err != nil {
		log.Fatal("Error reading Version record")
	}

	br.GetUInt32() // StringOffset
	br.GetUInt32() // When the number of times you have missed a match with a hash key equals this value, you give up because it is not there.
	br.GetUInt32() // FileSize

	elementIndex := make([]uint16, numberOfElements)
	for i := 0; i < int(numberOfElements); i++ {
		elementIndex[i] = br.GetUInt16()
	}

	hashEntries := make([]textDictionaryHashEntry, hashTableSize)
	for i := 0; i < int(hashTableSize); i++ {
		hashEntries[i] = textDictionaryHashEntry{
			br.GetByte() == 1,
			br.GetUInt16(),
			br.GetUInt32(),
			br.GetUInt32(),
			br.GetUInt32(),
			br.GetUInt16(),
		}
	}

	for idx, hashEntry := range hashEntries {
		if !hashEntry.IsActive {
			continue
		}

		br.SetPosition(uint64(hashEntry.NameString))
		nameVal := br.ReadBytes(int(hashEntry.NameLength - 1))
		value := string(nameVal)

		br.SetPosition(uint64(hashEntry.IndexString))

		key := ""

		for {
			b := br.GetByte()
			if b == 0 {
				break
			}

			key += string(b)
		}

		if key == "x" || key == "X" {
			key = "#" + strconv.Itoa(idx)
		}

		_, exists := lookupTable[key]
		if !exists {
			lookupTable[key] = value
		}
	}
}