1 // Protocol Buffers for Go with Gadgets
3 // Copyright (c) 2013, The GoGo Authors. All rights reserved.
4 // http://github.com/gogo/protobuf
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions are
10 // * Redistributions of source code must retain the above copyright
11 // notice, this list of conditions and the following disclaimer.
12 // * Redistributions in binary form must reproduce the above
13 // copyright notice, this list of conditions and the following disclaimer
14 // in the documentation and/or other materials provided with the
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 type extensionsBytes interface {
44 ExtensionRangeArray() []ExtensionRange
45 GetExtensions() *[]byte
48 type slowExtensionAdapter struct {
52 func (s slowExtensionAdapter) extensionsWrite() map[int32]Extension {
53 panic("Please report a bug to github.com/gogo/protobuf if you see this message: Writing extensions is not supported for extensions stored in a byte slice field.")
56 func (s slowExtensionAdapter) extensionsRead() (map[int32]Extension, sync.Locker) {
57 b := s.GetExtensions()
58 m, err := BytesToExtensionsMap(*b)
65 func GetBoolExtension(pb Message, extension *ExtensionDesc, ifnotset bool) bool {
66 if reflect.ValueOf(pb).IsNil() {
69 value, err := GetExtension(pb, extension)
76 if value.(*bool) == nil {
79 return *(value.(*bool))
82 func (this *Extension) Equal(that *Extension) bool {
83 if err := this.Encode(); err != nil {
86 if err := that.Encode(); err != nil {
89 return bytes.Equal(this.enc, that.enc)
92 func (this *Extension) Compare(that *Extension) int {
93 if err := this.Encode(); err != nil {
96 if err := that.Encode(); err != nil {
99 return bytes.Compare(this.enc, that.enc)
102 func SizeOfInternalExtension(m extendableProto) (n int) {
103 info := getMarshalInfo(reflect.TypeOf(m))
104 return info.sizeV1Extensions(m.extensionsWrite())
107 type sortableMapElem struct {
112 func newSortableExtensionsFromMap(m map[int32]Extension) sortableExtensions {
113 s := make(sortableExtensions, 0, len(m))
114 for k, v := range m {
115 s = append(s, &sortableMapElem{field: k, ext: v})
120 type sortableExtensions []*sortableMapElem
122 func (this sortableExtensions) Len() int { return len(this) }
124 func (this sortableExtensions) Swap(i, j int) { this[i], this[j] = this[j], this[i] }
126 func (this sortableExtensions) Less(i, j int) bool { return this[i].field < this[j].field }
128 func (this sortableExtensions) String() string {
130 ss := make([]string, len(this))
131 for i := range this {
132 ss[i] = fmt.Sprintf("%d: %v", this[i].field, this[i].ext)
134 return "map[" + strings.Join(ss, ",") + "]"
137 func StringFromInternalExtension(m extendableProto) string {
138 return StringFromExtensionsMap(m.extensionsWrite())
141 func StringFromExtensionsMap(m map[int32]Extension) string {
142 return newSortableExtensionsFromMap(m).String()
145 func StringFromExtensionsBytes(ext []byte) string {
146 m, err := BytesToExtensionsMap(ext)
150 return StringFromExtensionsMap(m)
153 func EncodeInternalExtension(m extendableProto, data []byte) (n int, err error) {
154 return EncodeExtensionMap(m.extensionsWrite(), data)
157 func EncodeExtensionMap(m map[int32]Extension, data []byte) (n int, err error) {
159 for _, e := range m {
160 if err := e.Encode(); err != nil {
163 n := copy(data[o:], e.enc)
165 return 0, io.ErrShortBuffer
172 func GetRawExtension(m map[int32]Extension, id int32) ([]byte, error) {
174 if err := e.Encode(); err != nil {
180 func size(buf []byte, wire int) (int, error) {
183 _, n := DecodeVarint(buf)
188 v, n := DecodeVarint(buf)
189 return int(v) + n, nil
195 u, n := DecodeVarint(buf[offset:])
196 fwire := int(u & 0x7)
198 if fwire == WireEndGroup {
201 s, err := size(buf[offset:], wire)
208 return 0, fmt.Errorf("proto: can't get size for unknown wire type %d", wire)
211 func BytesToExtensionsMap(buf []byte) (map[int32]Extension, error) {
212 m := make(map[int32]Extension)
215 tag, n := DecodeVarint(buf[i:])
217 return nil, fmt.Errorf("unable to decode varint")
219 fieldNum := int32(tag >> 3)
220 wireType := int(tag & 0x7)
221 l, err := size(buf[i+n:], wireType)
225 end := i + int(l) + n
226 m[int32(fieldNum)] = Extension{enc: buf[i:end]}
232 func NewExtension(e []byte) Extension {
233 ee := Extension{enc: make([]byte, len(e))}
238 func AppendExtension(e Message, tag int32, buf []byte) {
239 if ee, eok := e.(extensionsBytes); eok {
240 ext := ee.GetExtensions()
241 *ext = append(*ext, buf...)
244 if ee, eok := e.(extendableProto); eok {
245 m := ee.extensionsWrite()
246 ext := m[int32(tag)] // may be missing
247 ext.enc = append(ext.enc, buf...)
252 func encodeExtension(extension *ExtensionDesc, value interface{}) ([]byte, error) {
253 u := getMarshalInfo(reflect.TypeOf(extension.ExtendedType))
254 ei := u.getExtElemInfo(extension)
256 p := toAddrPointer(&v, ei.isptr)
257 siz := ei.sizer(p, SizeVarint(ei.wiretag))
258 buf := make([]byte, 0, siz)
259 return ei.marshaler(buf, p, ei.wiretag, false)
262 func decodeExtensionFromBytes(extension *ExtensionDesc, buf []byte) (interface{}, error) {
265 tag, n := DecodeVarint((buf)[o:])
266 fieldNum := int32(tag >> 3)
267 wireType := int(tag & 0x7)
269 return nil, fmt.Errorf("unable to decode extension")
271 l, err := size((buf)[o+n:], wireType)
275 if int32(fieldNum) == extension.Field {
276 if o+n+l > len(buf) {
277 return nil, fmt.Errorf("unable to decode extension")
279 v, err := decodeExtension((buf)[o:o+n+l], extension)
287 return defaultExtensionValue(extension)
290 func (this *Extension) Encode() error {
293 this.enc, err = encodeExtension(this.desc, this.value)
301 func (this Extension) GoString() string {
302 if err := this.Encode(); err != nil {
303 return fmt.Sprintf("error encoding extension: %v", err)
305 return fmt.Sprintf("proto.NewExtension(%#v)", this.enc)
308 func SetUnsafeExtension(pb Message, fieldNum int32, value interface{}) error {
309 typ := reflect.TypeOf(pb).Elem()
310 ext, ok := extensionMaps[typ]
312 return fmt.Errorf("proto: bad extended type; %s is not extendable", typ.String())
314 desc, ok := ext[fieldNum]
316 return errors.New("proto: bad extension number; not in declared ranges")
318 return SetExtension(pb, desc, value)
321 func GetUnsafeExtension(pb Message, fieldNum int32) (interface{}, error) {
322 typ := reflect.TypeOf(pb).Elem()
323 ext, ok := extensionMaps[typ]
325 return nil, fmt.Errorf("proto: bad extended type; %s is not extendable", typ.String())
327 desc, ok := ext[fieldNum]
329 return nil, fmt.Errorf("unregistered field number %d", fieldNum)
331 return GetExtension(pb, desc)
334 func NewUnsafeXXX_InternalExtensions(m map[int32]Extension) XXX_InternalExtensions {
335 x := &XXX_InternalExtensions{
338 extensionMap map[int32]Extension
345 func GetUnsafeExtensionsMap(extendable Message) map[int32]Extension {
346 pb := extendable.(extendableProto)
347 return pb.extensionsWrite()
350 func deleteExtension(pb extensionsBytes, theFieldNum int32, offset int) int {
351 ext := pb.GetExtensions()
352 for offset < len(*ext) {
353 tag, n1 := DecodeVarint((*ext)[offset:])
354 fieldNum := int32(tag >> 3)
355 wireType := int(tag & 0x7)
356 n2, err := size((*ext)[offset+n1:], wireType)
360 newOffset := offset + n1 + n2
361 if fieldNum == theFieldNum {
362 *ext = append((*ext)[:offset], (*ext)[newOffset:]...)