1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
|
// Copyright 2014 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package proptools
import (
"fmt"
"reflect"
"sync"
)
// CloneProperties takes a reflect.Value of a pointer to a struct and returns a reflect.Value
// of a pointer to a new struct that copies of the values for its fields. It recursively clones
// struct pointers and interfaces that contain struct pointers.
func CloneProperties(structValue reflect.Value) reflect.Value {
if !isStructPtr(structValue.Type()) {
panic(fmt.Errorf("CloneProperties expected *struct, got %s", structValue.Type()))
}
result := reflect.New(structValue.Type().Elem())
copyProperties(result.Elem(), structValue.Elem())
return result
}
// CopyProperties takes destination and source reflect.Values of a pointer to structs and returns
// copies each field from the source into the destination. It recursively copies struct pointers
// and interfaces that contain struct pointers.
func CopyProperties(dstValue, srcValue reflect.Value) {
if !isStructPtr(dstValue.Type()) {
panic(fmt.Errorf("CopyProperties expected dstValue *struct, got %s", dstValue.Type()))
}
if !isStructPtr(srcValue.Type()) {
panic(fmt.Errorf("CopyProperties expected srcValue *struct, got %s", srcValue.Type()))
}
copyProperties(dstValue.Elem(), srcValue.Elem())
}
func copyProperties(dstValue, srcValue reflect.Value) {
typ := dstValue.Type()
if srcValue.Type() != typ {
panic(fmt.Errorf("can't copy mismatching types (%s <- %s)",
dstValue.Kind(), srcValue.Kind()))
}
for i, field := range typeFields(typ) {
if field.PkgPath != "" {
panic(fmt.Errorf("can't copy a private field %q", field.Name))
}
srcFieldValue := srcValue.Field(i)
dstFieldValue := dstValue.Field(i)
dstFieldInterfaceValue := reflect.Value{}
origDstFieldValue := dstFieldValue
switch srcFieldValue.Kind() {
case reflect.Bool, reflect.String, reflect.Int, reflect.Uint:
dstFieldValue.Set(srcFieldValue)
case reflect.Struct:
copyProperties(dstFieldValue, srcFieldValue)
case reflect.Slice:
if !srcFieldValue.IsNil() {
if srcFieldValue != dstFieldValue {
newSlice := reflect.MakeSlice(field.Type, srcFieldValue.Len(),
srcFieldValue.Len())
reflect.Copy(newSlice, srcFieldValue)
dstFieldValue.Set(newSlice)
}
} else {
dstFieldValue.Set(srcFieldValue)
}
case reflect.Interface:
if srcFieldValue.IsNil() {
dstFieldValue.Set(srcFieldValue)
break
}
srcFieldValue = srcFieldValue.Elem()
if !isStructPtr(srcFieldValue.Type()) {
panic(fmt.Errorf("can't clone field %q: expected interface to contain *struct, found %s",
field.Name, srcFieldValue.Type()))
}
if dstFieldValue.IsNil() || dstFieldValue.Elem().Type() != srcFieldValue.Type() {
// We can't use the existing destination allocation, so
// clone a new one.
newValue := reflect.New(srcFieldValue.Type()).Elem()
dstFieldValue.Set(newValue)
dstFieldInterfaceValue = dstFieldValue
dstFieldValue = newValue
} else {
dstFieldValue = dstFieldValue.Elem()
}
fallthrough
case reflect.Ptr:
if srcFieldValue.IsNil() {
origDstFieldValue.Set(srcFieldValue)
break
}
switch srcFieldValue.Elem().Kind() {
case reflect.Struct:
if !dstFieldValue.IsNil() {
// Re-use the existing allocation.
copyProperties(dstFieldValue.Elem(), srcFieldValue.Elem())
break
} else {
newValue := CloneProperties(srcFieldValue)
if dstFieldInterfaceValue.IsValid() {
dstFieldInterfaceValue.Set(newValue)
} else {
origDstFieldValue.Set(newValue)
}
}
case reflect.Bool, reflect.Int64, reflect.String:
newValue := reflect.New(srcFieldValue.Elem().Type())
newValue.Elem().Set(srcFieldValue.Elem())
origDstFieldValue.Set(newValue)
default:
panic(fmt.Errorf("can't clone pointer field %q type %s",
field.Name, srcFieldValue.Type()))
}
default:
panic(fmt.Errorf("unexpected type for property struct field %q: %s",
field.Name, srcFieldValue.Type()))
}
}
}
// ZeroProperties takes a reflect.Value of a pointer to a struct and replaces all of its fields
// with zero values, recursing into struct, pointer to struct and interface fields.
func ZeroProperties(structValue reflect.Value) {
if !isStructPtr(structValue.Type()) {
panic(fmt.Errorf("ZeroProperties expected *struct, got %s", structValue.Type()))
}
zeroProperties(structValue.Elem())
}
func zeroProperties(structValue reflect.Value) {
typ := structValue.Type()
for i, field := range typeFields(typ) {
if field.PkgPath != "" {
// The field is not exported so just skip it.
continue
}
fieldValue := structValue.Field(i)
switch fieldValue.Kind() {
case reflect.Bool, reflect.String, reflect.Slice, reflect.Int, reflect.Uint:
fieldValue.Set(reflect.Zero(fieldValue.Type()))
case reflect.Interface:
if fieldValue.IsNil() {
break
}
// We leave the pointer intact and zero out the struct that's
// pointed to.
fieldValue = fieldValue.Elem()
if !isStructPtr(fieldValue.Type()) {
panic(fmt.Errorf("can't zero field %q: expected interface to contain *struct, found %s",
field.Name, fieldValue.Type()))
}
fallthrough
case reflect.Ptr:
switch fieldValue.Type().Elem().Kind() {
case reflect.Struct:
if fieldValue.IsNil() {
break
}
zeroProperties(fieldValue.Elem())
case reflect.Bool, reflect.Int64, reflect.String:
fieldValue.Set(reflect.Zero(fieldValue.Type()))
default:
panic(fmt.Errorf("can't zero field %q: points to a %s",
field.Name, fieldValue.Elem().Kind()))
}
case reflect.Struct:
zeroProperties(fieldValue)
default:
panic(fmt.Errorf("unexpected kind for property struct field %q: %s",
field.Name, fieldValue.Kind()))
}
}
}
// CloneEmptyProperties takes a reflect.Value of a pointer to a struct and returns a reflect.Value
// of a pointer to a new struct that has the zero values for its fields. It recursively clones
// struct pointers and interfaces that contain struct pointers.
func CloneEmptyProperties(structValue reflect.Value) reflect.Value {
if !isStructPtr(structValue.Type()) {
panic(fmt.Errorf("CloneEmptyProperties expected *struct, got %s", structValue.Type()))
}
result := reflect.New(structValue.Type().Elem())
cloneEmptyProperties(result.Elem(), structValue.Elem())
return result
}
func cloneEmptyProperties(dstValue, srcValue reflect.Value) {
typ := srcValue.Type()
for i, field := range typeFields(typ) {
if field.PkgPath != "" {
// The field is not exported so just skip it.
continue
}
srcFieldValue := srcValue.Field(i)
dstFieldValue := dstValue.Field(i)
dstFieldInterfaceValue := reflect.Value{}
switch srcFieldValue.Kind() {
case reflect.Bool, reflect.String, reflect.Slice, reflect.Int, reflect.Uint:
// Nothing
case reflect.Struct:
cloneEmptyProperties(dstFieldValue, srcFieldValue)
case reflect.Interface:
if srcFieldValue.IsNil() {
break
}
srcFieldValue = srcFieldValue.Elem()
if !isStructPtr(srcFieldValue.Type()) {
panic(fmt.Errorf("can't clone empty field %q: expected interface to contain *struct, found %s",
field.Name, srcFieldValue.Type()))
}
newValue := reflect.New(srcFieldValue.Type()).Elem()
dstFieldValue.Set(newValue)
dstFieldInterfaceValue = dstFieldValue
dstFieldValue = newValue
fallthrough
case reflect.Ptr:
switch srcFieldValue.Type().Elem().Kind() {
case reflect.Struct:
if srcFieldValue.IsNil() {
break
}
newValue := CloneEmptyProperties(srcFieldValue)
if dstFieldInterfaceValue.IsValid() {
dstFieldInterfaceValue.Set(newValue)
} else {
dstFieldValue.Set(newValue)
}
case reflect.Bool, reflect.Int64, reflect.String:
// Nothing
default:
panic(fmt.Errorf("can't clone empty field %q: points to a %s",
field.Name, srcFieldValue.Elem().Kind()))
}
default:
panic(fmt.Errorf("unexpected kind for property struct field %q: %s",
field.Name, srcFieldValue.Kind()))
}
}
}
var typeFieldCache sync.Map
func typeFields(typ reflect.Type) []reflect.StructField {
// reflect.Type.Field allocates a []int{} to hold the index every time it is called, which ends up
// being a significant portion of the GC pressure. It can't reuse the same one in case a caller
// modifies the backing array through the slice. Since we don't modify it, cache the result
// locally to reduce allocations.
// Fast path
if typeFields, ok := typeFieldCache.Load(typ); ok {
return typeFields.([]reflect.StructField)
}
// Slow path
typeFields := make([]reflect.StructField, typ.NumField())
for i := range typeFields {
typeFields[i] = typ.Field(i)
}
typeFieldCache.Store(typ, typeFields)
return typeFields
}
|