wcfs: Set package

Lacking generics we have set.go.in and instantiation for Set[int64],
set[string], Set[Oid] and Set[Tid] - that will be used in follow-up
patches.

The set.go.in itself is mostly a generalized copy from git-backup:

https://lab.nexedi.com/kirr/git-backup/blob/c9db60e8/set.go

wcfs/internal/set/gen-set

+#!/bin/bash -e
+# set.go.in -> specialized with concrete types
+# gen-set package KIND VALUE out
+
+# Copyright (C) 2018-2021  Nexedi SA and Contributors.
+#                          Kirill Smelkov <kirr@nexedi.com>
+#
+# This program is free software: you can Use, Study, Modify and Redistribute
+# it under the terms of the GNU General Public License version 3, or (at your
+# option) any later version, as published by the Free Software Foundation.
+#
+# You can also Link and Combine this program with other software covered by
+# the terms of any of the Free Software licenses or any of the Open Source
+# Initiative approved licenses and Convey the resulting work. Corresponding
+# source of such a combination shall include the source code for all other
+# software used.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the implied
+# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# See COPYING file for full licensing terms.
+# See https://www.nexedi.com/licensing for rationale and options.
+
+KIND=$1
+VALUE=$2
+out=$3
+
+input=$(dirname $0)/set.go.in
+
+echo "// Code generated by gen-set $KIND $VALUE; DO NOT EDIT." >$out
+echo >>$out
+
+sed	\
+	-e "s/VALUE/$VALUE/g"		\
+	-e "s/Set/${KIND}/g"		\
+	$input >>$out

wcfs/internal/set/set.go

+// Copyright (C) 2021  Nexedi SA and Contributors.
+//                     Kirill Smelkov <kirr@nexedi.com>
+//
+// This program is free software: you can Use, Study, Modify and Redistribute
+// it under the terms of the GNU General Public License version 3, or (at your
+// option) any later version, as published by the Free Software Foundation.
+//
+// You can also Link and Combine this program with other software covered by
+// the terms of any of the Free Software licenses or any of the Open Source
+// Initiative approved licenses and Convey the resulting work. Corresponding
+// source of such a combination shall include the source code for all other
+// software used.
+//
+// This program is distributed WITHOUT ANY WARRANTY; without even the implied
+// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//
+// See COPYING file for full licensing terms.
+// See https://www.nexedi.com/licensing for rationale and options.
+
+package set
+
+//go:generate ./gen-set I64 int64  zset_i64.go
+//go:generate ./gen-set Str string zset_str.go
+//go:generate ./gen-set Oid _Oid   zset_oid.go
+//go:generate ./gen-set Tid _Tid   zset_tid.go
+
+import (
+	"lab.nexedi.com/kirr/neo/go/zodb"
+)
+
+type _Oid = zodb.Oid
+type _Tid = zodb.Tid

wcfs/internal/set/set.go.in

+// Copyright (C) 2015-2021  Nexedi SA and Contributors.
+//                          Kirill Smelkov <kirr@nexedi.com>
+//
+// This program is free software: you can Use, Study, Modify and Redistribute
+// it under the terms of the GNU General Public License version 3, or (at your
+// option) any later version, as published by the Free Software Foundation.
+//
+// You can also Link and Combine this program with other software covered by
+// the terms of any of the Free Software licenses or any of the Open Source
+// Initiative approved licenses and Convey the resulting work. Corresponding
+// source of such a combination shall include the source code for all other
+// software used.
+//
+// This program is distributed WITHOUT ANY WARRANTY; without even the implied
+// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//
+// See COPYING file for full licensing terms.
+// See https://www.nexedi.com/licensing for rationale and options.
+
+package set
+
+import (
+	"fmt"
+	"sort"
+	"strings"
+)
+
+// Set is a set of VALUE.
+type Set map[VALUE]struct{}
+
+// Add adds v to the set.
+func (s Set) Add(v VALUE) {
+	s[v] = struct{}{}
+}
+
+// Del removes v from the set.
+// it is noop if v was not in the set.
+func (s Set) Del(v VALUE) {
+	delete(s, v)
+}
+
+// Has checks whether the set contains v.
+func (s Set) Has(v VALUE) bool {
+	_, ok := s[v]
+	return ok
+}
+
+// Update adds t values to s.
+func (s Set) Update(t Set) {
+	for v := range t {
+		s.Add(v)
+	}
+}
+
+// Elements returns all elements of set as slice.
+func (s Set) Elements() []VALUE {
+	ev := make([]VALUE, len(s))
+	i := 0
+	for e := range s {
+		ev[i] = e
+		i++
+	}
+	return ev
+}
+
+// Union returns s ∪ t
+func (s Set) Union(t Set) Set {
+	// l = max(len(s), len(t))
+	l := len(s)
+	if lt := len(t); lt > l {
+		l = lt
+	}
+
+	u := make(Set, l)
+
+	for v := range s {
+		u.Add(v)
+	}
+	for v := range t {
+		u.Add(v)
+	}
+	return u
+}
+
+// Intersection returns s ∩ t
+func (s Set) Intersection(t Set) Set {
+	i := Set{}
+	for v := range s {
+		if t.Has(v) {
+			i.Add(v)
+		}
+	}
+	return i
+}
+
+// Difference returns s\t.
+func (s Set) Difference(t Set) Set {
+	d := Set{}
+	for v := range s {
+		if !t.Has(v) {
+			d.Add(v)
+		}
+	}
+	return d
+}
+
+// SymmetricDifference returns s Δ t.
+func (s Set) SymmetricDifference(t Set) Set {
+	d := Set{}
+	for v := range s {
+		if !t.Has(v) {
+			d.Add(v)
+		}
+	}
+	for v := range t {
+		if !s.Has(v) {
+			d.Add(v)
+		}
+	}
+	return d
+}
+
+// Equal returns whether a == b.
+func (a Set) Equal(b Set) bool {
+	if len(a) != len(b) {
+		return false
+	}
+
+	for v := range a {
+		_, ok := b[v]
+		if !ok {
+			return false
+		}
+	}
+
+	return true
+}
+
+// Clone returns copy of the set.
+func (orig Set) Clone() Set {
+	klon := make(Set, len(orig))
+	for v := range orig {
+		klon.Add(v)
+	}
+	return klon
+}
+
+// --------
+
+func (s Set) SortedElements() []VALUE {
+	ev := s.Elements()
+	sort.Slice(ev, func(i, j int) bool {
+		return ev[i] < ev[j]
+	})
+	return ev
+}
+
+func (s Set) String() string {
+	ev := s.SortedElements()
+	strv := make([]string, len(ev))
+	for i, v := range ev {
+		strv[i] = fmt.Sprintf("%v", v)
+	}
+	return "{" + strings.Join(strv, " ") + "}"
+}

wcfs/internal/set/zset_i64.go

+// Code generated by gen-set I64 int64; DO NOT EDIT.
+
+// Copyright (C) 2015-2021  Nexedi SA and Contributors.
+//                          Kirill Smelkov <kirr@nexedi.com>
+//
+// This program is free software: you can Use, Study, Modify and Redistribute
+// it under the terms of the GNU General Public License version 3, or (at your
+// option) any later version, as published by the Free Software Foundation.
+//
+// You can also Link and Combine this program with other software covered by
+// the terms of any of the Free Software licenses or any of the Open Source
+// Initiative approved licenses and Convey the resulting work. Corresponding
+// source of such a combination shall include the source code for all other
+// software used.
+//
+// This program is distributed WITHOUT ANY WARRANTY; without even the implied
+// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//
+// See COPYING file for full licensing terms.
+// See https://www.nexedi.com/licensing for rationale and options.
+
+package set
+
+import (
+	"fmt"
+	"sort"
+	"strings"
+)
+
+// I64 is a set of int64.
+type I64 map[int64]struct{}
+
+// Add adds v to the set.
+func (s I64) Add(v int64) {
+	s[v] = struct{}{}
+}
+
+// Del removes v from the set.
+// it is noop if v was not in the set.
+func (s I64) Del(v int64) {
+	delete(s, v)
+}
+
+// Has checks whether the set contains v.
+func (s I64) Has(v int64) bool {
+	_, ok := s[v]
+	return ok
+}
+
+// Update adds t values to s.
+func (s I64) Update(t I64) {
+	for v := range t {
+		s.Add(v)
+	}
+}
+
+// Elements returns all elements of set as slice.
+func (s I64) Elements() []int64 {
+	ev := make([]int64, len(s))
+	i := 0
+	for e := range s {
+		ev[i] = e
+		i++
+	}
+	return ev
+}
+
+// Union returns s ∪ t
+func (s I64) Union(t I64) I64 {
+	// l = max(len(s), len(t))
+	l := len(s)
+	if lt := len(t); lt > l {
+		l = lt
+	}
+
+	u := make(I64, l)
+
+	for v := range s {
+		u.Add(v)
+	}
+	for v := range t {
+		u.Add(v)
+	}
+	return u
+}
+
+// Intersection returns s ∩ t
+func (s I64) Intersection(t I64) I64 {
+	i := I64{}
+	for v := range s {
+		if t.Has(v) {
+			i.Add(v)
+		}
+	}
+	return i
+}
+
+// Difference returns s\t.
+func (s I64) Difference(t I64) I64 {
+	d := I64{}
+	for v := range s {
+		if !t.Has(v) {
+			d.Add(v)
+		}
+	}
+	return d
+}
+
+// SymmetricDifference returns s Δ t.
+func (s I64) SymmetricDifference(t I64) I64 {
+	d := I64{}
+	for v := range s {
+		if !t.Has(v) {
+			d.Add(v)
+		}
+	}
+	for v := range t {
+		if !s.Has(v) {
+			d.Add(v)
+		}
+	}
+	return d
+}
+
+// Equal returns whether a == b.
+func (a I64) Equal(b I64) bool {
+	if len(a) != len(b) {
+		return false
+	}
+
+	for v := range a {
+		_, ok := b[v]
+		if !ok {
+			return false
+		}
+	}
+
+	return true
+}
+
+// Clone returns copy of the set.
+func (orig I64) Clone() I64 {
+	klon := make(I64, len(orig))
+	for v := range orig {
+		klon.Add(v)
+	}
+	return klon
+}
+
+// --------
+
+func (s I64) SortedElements() []int64 {
+	ev := s.Elements()
+	sort.Slice(ev, func(i, j int) bool {
+		return ev[i] < ev[j]
+	})
+	return ev
+}
+
+func (s I64) String() string {
+	ev := s.SortedElements()
+	strv := make([]string, len(ev))
+	for i, v := range ev {
+		strv[i] = fmt.Sprintf("%v", v)
+	}
+	return "{" + strings.Join(strv, " ") + "}"
+}

wcfs/internal/set/zset_oid.go

+// Code generated by gen-set Oid _Oid; DO NOT EDIT.
+
+// Copyright (C) 2015-2021  Nexedi SA and Contributors.
+//                          Kirill Smelkov <kirr@nexedi.com>
+//
+// This program is free software: you can Use, Study, Modify and Redistribute
+// it under the terms of the GNU General Public License version 3, or (at your
+// option) any later version, as published by the Free Software Foundation.
+//
+// You can also Link and Combine this program with other software covered by
+// the terms of any of the Free Software licenses or any of the Open Source
+// Initiative approved licenses and Convey the resulting work. Corresponding
+// source of such a combination shall include the source code for all other
+// software used.
+//
+// This program is distributed WITHOUT ANY WARRANTY; without even the implied
+// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//
+// See COPYING file for full licensing terms.
+// See https://www.nexedi.com/licensing for rationale and options.
+
+package set
+
+import (
+	"fmt"
+	"sort"
+	"strings"
+)
+
+// Oid is a set of _Oid.
+type Oid map[_Oid]struct{}
+
+// Add adds v to the set.
+func (s Oid) Add(v _Oid) {
+	s[v] = struct{}{}
+}
+
+// Del removes v from the set.
+// it is noop if v was not in the set.
+func (s Oid) Del(v _Oid) {
+	delete(s, v)
+}
+
+// Has checks whether the set contains v.
+func (s Oid) Has(v _Oid) bool {
+	_, ok := s[v]
+	return ok
+}
+
+// Update adds t values to s.
+func (s Oid) Update(t Oid) {
+	for v := range t {
+		s.Add(v)
+	}
+}
+
+// Elements returns all elements of set as slice.
+func (s Oid) Elements() []_Oid {
+	ev := make([]_Oid, len(s))
+	i := 0
+	for e := range s {
+		ev[i] = e
+		i++
+	}
+	return ev
+}
+
+// Union returns s ∪ t
+func (s Oid) Union(t Oid) Oid {
+	// l = max(len(s), len(t))
+	l := len(s)
+	if lt := len(t); lt > l {
+		l = lt
+	}
+
+	u := make(Oid, l)
+
+	for v := range s {
+		u.Add(v)
+	}
+	for v := range t {
+		u.Add(v)
+	}
+	return u
+}
+
+// Intersection returns s ∩ t
+func (s Oid) Intersection(t Oid) Oid {
+	i := Oid{}
+	for v := range s {
+		if t.Has(v) {
+			i.Add(v)
+		}
+	}
+	return i
+}
+
+// Difference returns s\t.
+func (s Oid) Difference(t Oid) Oid {
+	d := Oid{}
+	for v := range s {
+		if !t.Has(v) {
+			d.Add(v)
+		}
+	}
+	return d
+}
+
+// SymmetricDifference returns s Δ t.
+func (s Oid) SymmetricDifference(t Oid) Oid {
+	d := Oid{}
+	for v := range s {
+		if !t.Has(v) {
+			d.Add(v)
+		}
+	}
+	for v := range t {
+		if !s.Has(v) {
+			d.Add(v)
+		}
+	}
+	return d
+}
+
+// Equal returns whether a == b.
+func (a Oid) Equal(b Oid) bool {
+	if len(a) != len(b) {
+		return false
+	}
+
+	for v := range a {
+		_, ok := b[v]
+		if !ok {
+			return false
+		}
+	}
+
+	return true
+}
+
+// Clone returns copy of the set.
+func (orig Oid) Clone() Oid {
+	klon := make(Oid, len(orig))
+	for v := range orig {
+		klon.Add(v)
+	}
+	return klon
+}
+
+// --------
+
+func (s Oid) SortedElements() []_Oid {
+	ev := s.Elements()
+	sort.Slice(ev, func(i, j int) bool {
+		return ev[i] < ev[j]
+	})
+	return ev
+}
+
+func (s Oid) String() string {
+	ev := s.SortedElements()
+	strv := make([]string, len(ev))
+	for i, v := range ev {
+		strv[i] = fmt.Sprintf("%v", v)
+	}
+	return "{" + strings.Join(strv, " ") + "}"
+}

wcfs/internal/set/zset_str.go

+// Code generated by gen-set Str string; DO NOT EDIT.
+
+// Copyright (C) 2015-2021  Nexedi SA and Contributors.
+//                          Kirill Smelkov <kirr@nexedi.com>
+//
+// This program is free software: you can Use, Study, Modify and Redistribute
+// it under the terms of the GNU General Public License version 3, or (at your
+// option) any later version, as published by the Free Software Foundation.
+//
+// You can also Link and Combine this program with other software covered by
+// the terms of any of the Free Software licenses or any of the Open Source
+// Initiative approved licenses and Convey the resulting work. Corresponding
+// source of such a combination shall include the source code for all other
+// software used.
+//
+// This program is distributed WITHOUT ANY WARRANTY; without even the implied
+// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//
+// See COPYING file for full licensing terms.
+// See https://www.nexedi.com/licensing for rationale and options.
+
+package set
+
+import (
+	"fmt"
+	"sort"
+	"strings"
+)
+
+// Str is a set of string.
+type Str map[string]struct{}
+
+// Add adds v to the set.
+func (s Str) Add(v string) {
+	s[v] = struct{}{}
+}
+
+// Del removes v from the set.
+// it is noop if v was not in the set.
+func (s Str) Del(v string) {
+	delete(s, v)
+}
+
+// Has checks whether the set contains v.
+func (s Str) Has(v string) bool {
+	_, ok := s[v]
+	return ok
+}
+
+// Update adds t values to s.
+func (s Str) Update(t Str) {
+	for v := range t {
+		s.Add(v)
+	}
+}
+
+// Elements returns all elements of set as slice.
+func (s Str) Elements() []string {
+	ev := make([]string, len(s))
+	i := 0
+	for e := range s {
+		ev[i] = e
+		i++
+	}
+	return ev
+}
+
+// Union returns s ∪ t
+func (s Str) Union(t Str) Str {
+	// l = max(len(s), len(t))
+	l := len(s)
+	if lt := len(t); lt > l {
+		l = lt
+	}
+
+	u := make(Str, l)
+
+	for v := range s {
+		u.Add(v)
+	}
+	for v := range t {
+		u.Add(v)
+	}
+	return u
+}
+
+// Intersection returns s ∩ t
+func (s Str) Intersection(t Str) Str {
+	i := Str{}
+	for v := range s {
+		if t.Has(v) {
+			i.Add(v)
+		}
+	}
+	return i
+}
+
+// Difference returns s\t.
+func (s Str) Difference(t Str) Str {
+	d := Str{}
+	for v := range s {
+		if !t.Has(v) {
+			d.Add(v)
+		}
+	}
+	return d
+}
+
+// SymmetricDifference returns s Δ t.
+func (s Str) SymmetricDifference(t Str) Str {
+	d := Str{}
+	for v := range s {
+		if !t.Has(v) {
+			d.Add(v)
+		}
+	}
+	for v := range t {
+		if !s.Has(v) {
+			d.Add(v)
+		}
+	}
+	return d
+}
+
+// Equal returns whether a == b.
+func (a Str) Equal(b Str) bool {
+	if len(a) != len(b) {
+		return false
+	}
+
+	for v := range a {
+		_, ok := b[v]
+		if !ok {
+			return false
+		}
+	}
+
+	return true
+}
+
+// Clone returns copy of the set.
+func (orig Str) Clone() Str {
+	klon := make(Str, len(orig))
+	for v := range orig {
+		klon.Add(v)
+	}
+	return klon
+}
+
+// --------
+
+func (s Str) SortedElements() []string {
+	ev := s.Elements()
+	sort.Slice(ev, func(i, j int) bool {
+		return ev[i] < ev[j]
+	})
+	return ev
+}
+
+func (s Str) String() string {
+	ev := s.SortedElements()
+	strv := make([]string, len(ev))
+	for i, v := range ev {
+		strv[i] = fmt.Sprintf("%v", v)
+	}
+	return "{" + strings.Join(strv, " ") + "}"
+}

wcfs/internal/set/zset_tid.go

+// Code generated by gen-set Tid _Tid; DO NOT EDIT.
+
+// Copyright (C) 2015-2021  Nexedi SA and Contributors.
+//                          Kirill Smelkov <kirr@nexedi.com>
+//
+// This program is free software: you can Use, Study, Modify and Redistribute
+// it under the terms of the GNU General Public License version 3, or (at your
+// option) any later version, as published by the Free Software Foundation.
+//
+// You can also Link and Combine this program with other software covered by
+// the terms of any of the Free Software licenses or any of the Open Source
+// Initiative approved licenses and Convey the resulting work. Corresponding
+// source of such a combination shall include the source code for all other
+// software used.
+//
+// This program is distributed WITHOUT ANY WARRANTY; without even the implied
+// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//
+// See COPYING file for full licensing terms.
+// See https://www.nexedi.com/licensing for rationale and options.
+
+package set
+
+import (
+	"fmt"
+	"sort"
+	"strings"
+)
+
+// Tid is a set of _Tid.
+type Tid map[_Tid]struct{}
+
+// Add adds v to the set.
+func (s Tid) Add(v _Tid) {
+	s[v] = struct{}{}
+}
+
+// Del removes v from the set.
+// it is noop if v was not in the set.
+func (s Tid) Del(v _Tid) {
+	delete(s, v)
+}
+
+// Has checks whether the set contains v.
+func (s Tid) Has(v _Tid) bool {
+	_, ok := s[v]
+	return ok
+}
+
+// Update adds t values to s.
+func (s Tid) Update(t Tid) {
+	for v := range t {
+		s.Add(v)
+	}
+}
+
+// Elements returns all elements of set as slice.
+func (s Tid) Elements() []_Tid {
+	ev := make([]_Tid, len(s))
+	i := 0
+	for e := range s {
+		ev[i] = e
+		i++
+	}
+	return ev
+}
+
+// Union returns s ∪ t
+func (s Tid) Union(t Tid) Tid {
+	// l = max(len(s), len(t))
+	l := len(s)
+	if lt := len(t); lt > l {
+		l = lt
+	}
+
+	u := make(Tid, l)
+
+	for v := range s {
+		u.Add(v)
+	}
+	for v := range t {
+		u.Add(v)
+	}
+	return u
+}
+
+// Intersection returns s ∩ t
+func (s Tid) Intersection(t Tid) Tid {
+	i := Tid{}
+	for v := range s {
+		if t.Has(v) {
+			i.Add(v)
+		}
+	}
+	return i
+}
+
+// Difference returns s\t.
+func (s Tid) Difference(t Tid) Tid {
+	d := Tid{}
+	for v := range s {
+		if !t.Has(v) {
+			d.Add(v)
+		}
+	}
+	return d
+}
+
+// SymmetricDifference returns s Δ t.
+func (s Tid) SymmetricDifference(t Tid) Tid {
+	d := Tid{}
+	for v := range s {
+		if !t.Has(v) {
+			d.Add(v)
+		}
+	}
+	for v := range t {
+		if !s.Has(v) {
+			d.Add(v)
+		}
+	}
+	return d
+}
+
+// Equal returns whether a == b.
+func (a Tid) Equal(b Tid) bool {
+	if len(a) != len(b) {
+		return false
+	}
+
+	for v := range a {
+		_, ok := b[v]
+		if !ok {
+			return false
+		}
+	}
+
+	return true
+}
+
+// Clone returns copy of the set.
+func (orig Tid) Clone() Tid {
+	klon := make(Tid, len(orig))
+	for v := range orig {
+		klon.Add(v)
+	}
+	return klon
+}
+
+// --------
+
+func (s Tid) SortedElements() []_Tid {
+	ev := s.Elements()
+	sort.Slice(ev, func(i, j int) bool {
+		return ev[i] < ev[j]
+	})
+	return ev
+}
+
+func (s Tid) String() string {
+	ev := s.SortedElements()
+	strv := make([]string, len(ev))
+	for i, v := range ev {
+		strv[i] = fmt.Sprintf("%v", v)
+	}
+	return "{" + strings.Join(strv, " ") + "}"
+}