2019-05-08 17:21:18 +08:00
|
|
|
// Copyright 2017 gf Author(https://github.com/gogf/gf). All Rights Reserved.
|
|
|
|
//
|
|
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
|
|
// If a copy of the MIT was not distributed with gm file,
|
|
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
//
|
|
|
|
|
|
|
|
package gmap
|
|
|
|
|
|
|
|
import (
|
2019-07-13 17:48:16 +08:00
|
|
|
"encoding/json"
|
|
|
|
|
2019-09-29 14:27:09 +08:00
|
|
|
"github.com/gogf/gf/internal/empty"
|
2019-07-29 21:01:19 +08:00
|
|
|
"github.com/gogf/gf/internal/rwmutex"
|
|
|
|
"github.com/gogf/gf/util/gconv"
|
2019-05-08 17:21:18 +08:00
|
|
|
)
|
|
|
|
|
|
|
|
type StrIntMap struct {
|
|
|
|
mu *rwmutex.RWMutex
|
|
|
|
data map[string]int
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewStrIntMap returns an empty StrIntMap object.
|
2019-07-23 23:20:27 +08:00
|
|
|
// The parameter <safe> used to specify whether using map in concurrent-safety,
|
|
|
|
// which is false in default.
|
|
|
|
func NewStrIntMap(safe ...bool) *StrIntMap {
|
2019-05-08 17:21:18 +08:00
|
|
|
return &StrIntMap{
|
2019-07-23 23:20:27 +08:00
|
|
|
mu: rwmutex.New(safe...),
|
2019-06-19 09:06:52 +08:00
|
|
|
data: make(map[string]int),
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-05-11 20:47:25 +08:00
|
|
|
// NewStrIntMapFrom returns a hash map from given map <data>.
|
|
|
|
// Note that, the param <data> map will be set as the underlying data map(no deep copy),
|
2019-05-08 17:21:18 +08:00
|
|
|
// there might be some concurrent-safe issues when changing the map outside.
|
2019-07-23 23:20:27 +08:00
|
|
|
func NewStrIntMapFrom(data map[string]int, safe ...bool) *StrIntMap {
|
2019-05-08 17:21:18 +08:00
|
|
|
return &StrIntMap{
|
2019-07-23 23:20:27 +08:00
|
|
|
mu: rwmutex.New(safe...),
|
2019-06-19 09:06:52 +08:00
|
|
|
data: data,
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Iterator iterates the hash map with custom callback function <f>.
|
|
|
|
// If <f> returns true, then it continues iterating; or false to stop.
|
|
|
|
func (m *StrIntMap) Iterator(f func(k string, v int) bool) {
|
|
|
|
m.mu.RLock()
|
|
|
|
defer m.mu.RUnlock()
|
|
|
|
for k, v := range m.data {
|
|
|
|
if !f(k, v) {
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Clone returns a new hash map with copy of current map data.
|
|
|
|
func (m *StrIntMap) Clone() *StrIntMap {
|
2019-09-29 14:27:09 +08:00
|
|
|
return NewStrIntMapFrom(m.MapCopy(), !m.mu.IsSafe())
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
|
2019-09-29 14:27:09 +08:00
|
|
|
// Map returns the underlying data map.
|
|
|
|
// Note that, if it's in concurrent-safe usage, it returns a copy of underlying data,
|
|
|
|
// or else a pointer to the underlying data.
|
|
|
|
func (m *StrIntMap) Map() map[string]int {
|
|
|
|
m.mu.RLock()
|
|
|
|
defer m.mu.RUnlock()
|
|
|
|
if !m.mu.IsSafe() {
|
|
|
|
return m.data
|
|
|
|
}
|
|
|
|
data := make(map[string]int, len(m.data))
|
|
|
|
for k, v := range m.data {
|
|
|
|
data[k] = v
|
|
|
|
}
|
|
|
|
return data
|
2019-09-26 20:01:48 +08:00
|
|
|
}
|
|
|
|
|
2019-09-29 14:27:09 +08:00
|
|
|
// MapCopy returns a copy of the data of the hash map.
|
|
|
|
func (m *StrIntMap) MapCopy() map[string]int {
|
2019-05-08 17:21:18 +08:00
|
|
|
m.mu.RLock()
|
2019-09-29 14:27:09 +08:00
|
|
|
defer m.mu.RUnlock()
|
2019-05-12 21:11:26 +08:00
|
|
|
data := make(map[string]int, len(m.data))
|
2019-05-08 17:21:18 +08:00
|
|
|
for k, v := range m.data {
|
|
|
|
data[k] = v
|
|
|
|
}
|
|
|
|
return data
|
|
|
|
}
|
|
|
|
|
2019-09-29 14:27:09 +08:00
|
|
|
// FilterEmpty deletes all key-value pair of which the value is empty.
|
|
|
|
func (m *StrIntMap) FilterEmpty() {
|
|
|
|
m.mu.Lock()
|
|
|
|
for k, v := range m.data {
|
|
|
|
if empty.IsEmpty(v) {
|
|
|
|
delete(m.data, k)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
m.mu.Unlock()
|
|
|
|
}
|
|
|
|
|
2019-05-08 17:21:18 +08:00
|
|
|
// Set sets key-value to the hash map.
|
|
|
|
func (m *StrIntMap) Set(key string, val int) {
|
|
|
|
m.mu.Lock()
|
|
|
|
m.data[key] = val
|
|
|
|
m.mu.Unlock()
|
|
|
|
}
|
|
|
|
|
|
|
|
// Sets batch sets key-values to the hash map.
|
|
|
|
func (m *StrIntMap) Sets(data map[string]int) {
|
|
|
|
m.mu.Lock()
|
|
|
|
for k, v := range data {
|
|
|
|
m.data[k] = v
|
|
|
|
}
|
|
|
|
m.mu.Unlock()
|
|
|
|
}
|
|
|
|
|
2019-05-10 13:38:06 +08:00
|
|
|
// Search searches the map with given <key>.
|
|
|
|
// Second return parameter <found> is true if key was found, otherwise false.
|
|
|
|
func (m *StrIntMap) Search(key string) (value int, found bool) {
|
|
|
|
m.mu.RLock()
|
|
|
|
value, found = m.data[key]
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2019-05-08 17:21:18 +08:00
|
|
|
// Get returns the value by given <key>.
|
|
|
|
func (m *StrIntMap) Get(key string) int {
|
|
|
|
m.mu.RLock()
|
|
|
|
val, _ := m.data[key]
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return val
|
|
|
|
}
|
|
|
|
|
|
|
|
// doSetWithLockCheck checks whether value of the key exists with mutex.Lock,
|
|
|
|
// if not exists, set value to the map with given <key>,
|
|
|
|
// or else just return the existing value.
|
|
|
|
//
|
|
|
|
// It returns value with given <key>.
|
|
|
|
func (m *StrIntMap) doSetWithLockCheck(key string, value int) int {
|
|
|
|
m.mu.Lock()
|
|
|
|
if v, ok := m.data[key]; ok {
|
|
|
|
m.mu.Unlock()
|
|
|
|
return v
|
|
|
|
}
|
|
|
|
m.data[key] = value
|
|
|
|
m.mu.Unlock()
|
|
|
|
return value
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetOrSet returns the value by key,
|
|
|
|
// or set value with given <value> if not exist and returns this value.
|
|
|
|
func (m *StrIntMap) GetOrSet(key string, value int) int {
|
2019-05-10 13:38:06 +08:00
|
|
|
if v, ok := m.Search(key); !ok {
|
2019-05-08 17:21:18 +08:00
|
|
|
return m.doSetWithLockCheck(key, value)
|
|
|
|
} else {
|
|
|
|
return v
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetOrSetFunc returns the value by key,
|
|
|
|
// or sets value with return value of callback function <f> if not exist
|
|
|
|
// and returns this value.
|
|
|
|
func (m *StrIntMap) GetOrSetFunc(key string, f func() int) int {
|
2019-05-10 13:38:06 +08:00
|
|
|
if v, ok := m.Search(key); !ok {
|
2019-05-08 17:21:18 +08:00
|
|
|
return m.doSetWithLockCheck(key, f())
|
|
|
|
} else {
|
|
|
|
return v
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetOrSetFuncLock returns the value by key,
|
|
|
|
// or sets value with return value of callback function <f> if not exist
|
|
|
|
// and returns this value.
|
|
|
|
//
|
|
|
|
// GetOrSetFuncLock differs with GetOrSetFunc function is that it executes function <f>
|
|
|
|
// with mutex.Lock of the hash map.
|
|
|
|
func (m *StrIntMap) GetOrSetFuncLock(key string, f func() int) int {
|
2019-05-10 13:38:06 +08:00
|
|
|
if v, ok := m.Search(key); !ok {
|
2019-05-08 17:21:18 +08:00
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
2019-05-10 13:38:06 +08:00
|
|
|
if v, ok = m.data[key]; ok {
|
2019-05-08 17:21:18 +08:00
|
|
|
return v
|
|
|
|
}
|
2019-05-10 13:38:06 +08:00
|
|
|
v = f()
|
|
|
|
m.data[key] = v
|
|
|
|
return v
|
2019-05-08 17:21:18 +08:00
|
|
|
} else {
|
2019-05-10 13:38:06 +08:00
|
|
|
return v
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetIfNotExist sets <value> to the map if the <key> does not exist, then return true.
|
|
|
|
// It returns false if <key> exists, and <value> would be ignored.
|
|
|
|
func (m *StrIntMap) SetIfNotExist(key string, value int) bool {
|
|
|
|
if !m.Contains(key) {
|
|
|
|
m.doSetWithLockCheck(key, value)
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetIfNotExistFunc sets value with return value of callback function <f>, then return true.
|
|
|
|
// It returns false if <key> exists, and <value> would be ignored.
|
|
|
|
func (m *StrIntMap) SetIfNotExistFunc(key string, f func() int) bool {
|
|
|
|
if !m.Contains(key) {
|
|
|
|
m.doSetWithLockCheck(key, f())
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetIfNotExistFuncLock sets value with return value of callback function <f>, then return true.
|
|
|
|
// It returns false if <key> exists, and <value> would be ignored.
|
|
|
|
//
|
|
|
|
// SetIfNotExistFuncLock differs with SetIfNotExistFunc function is that
|
|
|
|
// it executes function <f> with mutex.Lock of the hash map.
|
|
|
|
func (m *StrIntMap) SetIfNotExistFuncLock(key string, f func() int) bool {
|
|
|
|
if !m.Contains(key) {
|
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
|
|
|
if _, ok := m.data[key]; !ok {
|
|
|
|
m.data[key] = f()
|
|
|
|
}
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
// Removes batch deletes values of the map by keys.
|
|
|
|
func (m *StrIntMap) Removes(keys []string) {
|
|
|
|
m.mu.Lock()
|
|
|
|
for _, key := range keys {
|
|
|
|
delete(m.data, key)
|
|
|
|
}
|
|
|
|
m.mu.Unlock()
|
|
|
|
}
|
|
|
|
|
|
|
|
// Remove deletes value from map by given <key>, and return this deleted value.
|
|
|
|
func (m *StrIntMap) Remove(key string) int {
|
|
|
|
m.mu.Lock()
|
|
|
|
val, exists := m.data[key]
|
|
|
|
if exists {
|
|
|
|
delete(m.data, key)
|
|
|
|
}
|
|
|
|
m.mu.Unlock()
|
|
|
|
return val
|
|
|
|
}
|
|
|
|
|
|
|
|
// Keys returns all keys of the map as a slice.
|
|
|
|
func (m *StrIntMap) Keys() []string {
|
|
|
|
m.mu.RLock()
|
2019-06-19 09:06:52 +08:00
|
|
|
keys := make([]string, len(m.data))
|
2019-05-12 21:11:26 +08:00
|
|
|
index := 0
|
2019-05-08 17:21:18 +08:00
|
|
|
for key := range m.data {
|
2019-05-12 21:11:26 +08:00
|
|
|
keys[index] = key
|
|
|
|
index++
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return keys
|
|
|
|
}
|
|
|
|
|
|
|
|
// Values returns all values of the map as a slice.
|
|
|
|
func (m *StrIntMap) Values() []int {
|
|
|
|
m.mu.RLock()
|
2019-05-12 21:11:26 +08:00
|
|
|
values := make([]int, len(m.data))
|
2019-06-19 09:06:52 +08:00
|
|
|
index := 0
|
2019-05-08 17:21:18 +08:00
|
|
|
for _, value := range m.data {
|
2019-05-12 21:11:26 +08:00
|
|
|
values[index] = value
|
|
|
|
index++
|
2019-05-08 17:21:18 +08:00
|
|
|
}
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return values
|
|
|
|
}
|
|
|
|
|
|
|
|
// Contains checks whether a key exists.
|
|
|
|
// It returns true if the <key> exists, or else false.
|
|
|
|
func (m *StrIntMap) Contains(key string) bool {
|
|
|
|
m.mu.RLock()
|
|
|
|
_, exists := m.data[key]
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return exists
|
|
|
|
}
|
|
|
|
|
|
|
|
// Size returns the size of the map.
|
|
|
|
func (m *StrIntMap) Size() int {
|
|
|
|
m.mu.RLock()
|
|
|
|
length := len(m.data)
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return length
|
|
|
|
}
|
|
|
|
|
|
|
|
// IsEmpty checks whether the map is empty.
|
|
|
|
// It returns true if map is empty, or else false.
|
|
|
|
func (m *StrIntMap) IsEmpty() bool {
|
|
|
|
m.mu.RLock()
|
|
|
|
empty := len(m.data) == 0
|
|
|
|
m.mu.RUnlock()
|
|
|
|
return empty
|
|
|
|
}
|
|
|
|
|
|
|
|
// Clear deletes all data of the map, it will remake a new underlying data map.
|
|
|
|
func (m *StrIntMap) Clear() {
|
|
|
|
m.mu.Lock()
|
|
|
|
m.data = make(map[string]int)
|
|
|
|
m.mu.Unlock()
|
|
|
|
}
|
|
|
|
|
|
|
|
// LockFunc locks writing with given callback function <f> within RWMutex.Lock.
|
|
|
|
func (m *StrIntMap) LockFunc(f func(m map[string]int)) {
|
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
|
|
|
f(m.data)
|
|
|
|
}
|
|
|
|
|
|
|
|
// RLockFunc locks reading with given callback function <f> within RWMutex.RLock.
|
|
|
|
func (m *StrIntMap) RLockFunc(f func(m map[string]int)) {
|
|
|
|
m.mu.RLock()
|
|
|
|
defer m.mu.RUnlock()
|
|
|
|
f(m.data)
|
|
|
|
}
|
|
|
|
|
2019-05-10 13:38:06 +08:00
|
|
|
// Flip exchanges key-value of the map to value-key.
|
2019-05-08 17:21:18 +08:00
|
|
|
func (m *StrIntMap) Flip() {
|
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
|
|
|
n := make(map[string]int, len(m.data))
|
|
|
|
for k, v := range m.data {
|
|
|
|
n[gconv.String(v)] = gconv.Int(k)
|
|
|
|
}
|
|
|
|
m.data = n
|
|
|
|
}
|
|
|
|
|
|
|
|
// Merge merges two hash maps.
|
|
|
|
// The <other> map will be merged into the map <m>.
|
|
|
|
func (m *StrIntMap) Merge(other *StrIntMap) {
|
|
|
|
m.mu.Lock()
|
|
|
|
defer m.mu.Unlock()
|
|
|
|
if other != m {
|
|
|
|
other.mu.RLock()
|
|
|
|
defer other.mu.RUnlock()
|
|
|
|
}
|
|
|
|
for k, v := range other.data {
|
|
|
|
m.data[k] = v
|
|
|
|
}
|
|
|
|
}
|
2019-07-13 17:48:16 +08:00
|
|
|
|
|
|
|
// MarshalJSON implements the interface MarshalJSON for json.Marshal.
|
|
|
|
func (m *StrIntMap) MarshalJSON() ([]byte, error) {
|
|
|
|
m.mu.RLock()
|
|
|
|
defer m.mu.RUnlock()
|
|
|
|
return json.Marshal(m.data)
|
|
|
|
}
|