Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kill the struct wrapper around generated Struct types. #283

Merged
merged 1 commit into from
Aug 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion capnpc-go/capnpc-go_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ func nodeListString(n []*node) string {
if i > 0 {
b.WriteByte(' ')
}
e.Encode(0xe682ab4cf923a417, nn.Struct)
e.Encode(0xe682ab4cf923a417, capnp.Struct(nn.Node))
}
b.WriteByte(']')
return b.String()
Expand Down
2 changes: 1 addition & 1 deletion capnpc-go/templates/_checktag
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{if .Field.HasDiscriminant -}}
if s.Struct.Uint16({{.Node.DiscriminantOffset}}) != {{.Field.DiscriminantValue}} {
if capnp.Struct(s).Uint16({{.Node.DiscriminantOffset}}) != {{.Field.DiscriminantValue}} {
panic({{printf "Which() != %s" .Field.Name | printf "%q"}})
}
{{end -}}
4 changes: 2 additions & 2 deletions capnpc-go/templates/_hasfield
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
func (s {{.Node.Name}}) Has{{.Field.Name|title}}() bool {
{{if .Field.HasDiscriminant -}}
if s.Struct.Uint16({{.Node.DiscriminantOffset}}) != {{.Field.DiscriminantValue}} {
if capnp.Struct(s).Uint16({{.Node.DiscriminantOffset}}) != {{.Field.DiscriminantValue}} {
return false
}
{{end -}}
return s.Struct.HasPtr({{.Field.Slot.Offset}})
return capnp.Struct(s).HasPtr({{.Field.Slot.Offset}})
}
4 changes: 2 additions & 2 deletions capnpc-go/templates/_settag
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{{if .Field.HasDiscriminant -}}
s.Struct.SetUint16({{.Node.DiscriminantOffset}}, {{.Field.DiscriminantValue}})
{{end -}}
capnp.Struct(s).SetUint16({{.Node.DiscriminantOffset}}, {{.Field.DiscriminantValue}})
{{end -}}
18 changes: 13 additions & 5 deletions capnpc-go/templates/baseStructFuncs
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,33 @@

func New{{.Node.Name}}(s *capnp.Segment) ({{.Node.Name}}, error) {
st, err := capnp.NewStruct(s, {{.G.ObjectSize .Node}})
return {{.Node.Name}}{st}, err
return {{.Node.Name}}(st), err
}

func NewRoot{{.Node.Name}}(s *capnp.Segment) ({{.Node.Name}}, error) {
st, err := capnp.NewRootStruct(s, {{.G.ObjectSize .Node}})
return {{.Node.Name}}{st}, err
return {{.Node.Name}}(st), err
}

func ReadRoot{{.Node.Name}}(msg *capnp.Message) ({{.Node.Name}}, error) {
root, err := msg.Root()
return {{.Node.Name}}{root.Struct()}, err
return {{.Node.Name}}(root.Struct()), err
}
{{if .StringMethod}}
func (s {{.Node.Name}}) String() string {
str, _ := {{.G.Imports.Text}}.Marshal({{.Node.Id|printf "%#x"}}, s.Struct)
str, _ := {{.G.Imports.Text}}.Marshal({{.Node.Id|printf "%#x"}}, capnp.Struct(s))
return str
}
{{end}}

func (s {{.Node.Name}}) EncodeAsPtr(seg *capnp.Segment) capnp.Ptr {
return capnp.Struct(s).EncodeAsPtr(seg)
}

func ({{.Node.Name}}) DecodeFromPtr(p capnp.Ptr) {{.Node.Name}} {
return {{.Node.Name}}{ Struct: capnp.Struct{}.DecodeFromPtr(p) }
return {{.Node.Name}}(capnp.Struct{}.DecodeFromPtr(p))
}

func (s {{.Node.Name}}) ToPtr() capnp.Ptr {
return capnp.Struct(s).ToPtr()
}
2 changes: 1 addition & 1 deletion capnpc-go/templates/interfaceClient
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ func (c {{$.Node.Name}}) {{.Name|title}}(ctx {{$.G.Imports.Context}}.Context, pa
}
if params != nil {
s.ArgsSize = {{$.G.ObjectSize .Params}}
s.PlaceArgs = func(s capnp.Struct) error { return params({{$.G.RemoteNodeName .Params $.Node}}{Struct: s}) }
s.PlaceArgs = func(s capnp.Struct) error { return params({{$.G.RemoteNodeName .Params $.Node}}(s)) }
}
ans, release := capnp.Client(c).SendCall(ctx, s)
return {{$.G.RemoteNodeName .Results $.Node}}_Future{Future: ans.Future()}, release
Expand Down
4 changes: 2 additions & 2 deletions capnpc-go/templates/interfaceServer
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ type {{$.Node.Name}}_{{.Name}} struct {

// Args returns the call's arguments.
func (c {{$.Node.Name}}_{{.Name}}) Args() {{$.G.RemoteNodeName .Params $.Node}} {
return {{$.G.RemoteNodeName .Params $.Node}}{Struct: c.Call.Args()}
return {{$.G.RemoteNodeName .Params $.Node}}(c.Call.Args())
}

// AllocResults allocates the results struct.
func (c {{$.Node.Name}}_{{.Name}}) AllocResults() ({{$.G.RemoteNodeName .Results $.Node}}, error) {
r, err := c.Call.AllocResults({{$.G.ObjectSize .Results}})
return {{$.G.RemoteNodeName .Results $.Node}}{Struct: r}, err
return {{$.G.RemoteNodeName .Results $.Node}}(r), err
}
{{end}}
{{- end}}
2 changes: 1 addition & 1 deletion capnpc-go/templates/promise
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ type {{.Node.Name}}_Future struct { *capnp.Future }

func (p {{.Node.Name}}_Future) Struct() ({{.Node.Name}}, error) {
s, err := p.Future.Struct()
return {{.Node.Name}}{s}, err
return {{.Node.Name}}(s), err
}

4 changes: 2 additions & 2 deletions capnpc-go/templates/structBoolField
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
func (s {{.Node.Name}}) {{.Field.Name|title}}() bool {
{{template "_checktag" . -}}
return {{if .Default}}!{{end}}s.Struct.Bit({{.Field.Slot.Offset}})
return {{if .Default}}!{{end}}capnp.Struct(s).Bit({{.Field.Slot.Offset}})
}

func (s {{.Node.Name}}) Set{{.Field.Name|title}}(v bool) {
{{template "_settag" . -}}
s.Struct.SetBit({{.Field.Slot.Offset}}, {{if .Default}}!{{end}}v)
capnp.Struct(s).SetBit({{.Field.Slot.Offset}}, {{if .Default}}!{{end}}v)
}

6 changes: 3 additions & 3 deletions capnpc-go/templates/structCapabilityField
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
func (s {{.Node.Name}}) {{.Field.Name|title}}() {{.FieldType}} {
{{template "_checktag" . -}}
p, _ := s.Struct.Ptr({{.Field.Slot.Offset}})
p, _ := capnp.Struct(s).Ptr({{.Field.Slot.Offset}})
return p.Interface().Client()
}

Expand All @@ -9,9 +9,9 @@ func (s {{.Node.Name}}) {{.Field.Name|title}}() {{.FieldType}} {
func (s {{.Node.Name}}) Set{{.Field.Name|title}}(c {{.FieldType}}) error {
{{template "_settag" . -}}
if !c.IsValid() {
return s.Struct.SetPtr({{.Field.Slot.Offset}}, capnp.Ptr{})
return capnp.Struct(s).SetPtr({{.Field.Slot.Offset}}, capnp.Ptr{})
}
seg := s.Segment()
in := capnp.NewInterface(seg, seg.Message().AddCap(c))
return s.Struct.SetPtr({{.Field.Slot.Offset}}, in.ToPtr())
return capnp.Struct(s).SetPtr({{.Field.Slot.Offset}}, in.ToPtr())
}
4 changes: 2 additions & 2 deletions capnpc-go/templates/structDataField
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
func (s {{.Node.Name}}) {{.Field.Name|title}}() ({{.FieldType}}, error) {
{{template "_checktag" . -}}
p, err := s.Struct.Ptr({{.Field.Slot.Offset}})
p, err := capnp.Struct(s).Ptr({{.Field.Slot.Offset}})
{{with .Default -}}
return {{$.FieldType}}(p.DataDefault({{printf "%#v" .}})), err
{{- else -}}
Expand All @@ -17,6 +17,6 @@ func (s {{.Node.Name}}) Set{{.Field.Name|title}}(v {{.FieldType}}) error {
v = []byte{}
}
{{end -}}
return s.Struct.SetData({{.Field.Slot.Offset}}, v)
return capnp.Struct(s).SetData({{.Field.Slot.Offset}}, v)
}

4 changes: 2 additions & 2 deletions capnpc-go/templates/structFloatField
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
func (s {{.Node.Name}}) {{.Field.Name|title}}() float{{.Bits}} {
{{template "_checktag" . -}}
return {{.G.Imports.Math}}.Float{{.Bits}}frombits(s.Struct.Uint{{.Bits}}({{.Offset}}){{with .Default}} ^ {{printf "%#x" .}}{{end}})
return {{.G.Imports.Math}}.Float{{.Bits}}frombits(capnp.Struct(s).Uint{{.Bits}}({{.Offset}}){{with .Default}} ^ {{printf "%#x" .}}{{end}})
}

func (s {{.Node.Name}}) Set{{.Field.Name|title}}(v float{{.Bits}}) {
{{template "_settag" . -}}
s.Struct.SetUint{{.Bits}}({{.Offset}}, {{.G.Imports.Math}}.Float{{.Bits}}bits(v){{with .Default}}^{{printf "%#x" .}}{{end}})
capnp.Struct(s).SetUint{{.Bits}}({{.Offset}}, {{.G.Imports.Math}}.Float{{.Bits}}bits(v){{with .Default}}^{{printf "%#x" .}}{{end}})
}

14 changes: 13 additions & 1 deletion capnpc-go/templates/structFuncs
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
{{if gt .Node.StructNode.DiscriminantCount 0}}
func (s {{.Node.Name}}) Which() {{.Node.Name}}_Which {
return {{.Node.Name}}_Which(s.Struct.Uint16({{.Node.DiscriminantOffset}}))
return {{.Node.Name}}_Which(capnp.Struct(s).Uint16({{.Node.DiscriminantOffset}}))
}
{{end -}}

func (s {{.Node.Name}}) IsValid() bool {
return capnp.Struct(s).IsValid()
}

func (s {{.Node.Name}}) Message() *capnp.Message {
return capnp.Struct(s).Message()
}

func (s {{.Node.Name}}) Segment() *capnp.Segment {
return capnp.Struct(s).Segment()
}
4 changes: 2 additions & 2 deletions capnpc-go/templates/structIntField
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
func (s {{.Node.Name}}) {{.Field.Name|title}}() {{.ReturnType}} {
{{template "_checktag" . -}}
return {{.ReturnType}}(s.Struct.Uint{{.Bits}}({{.Offset}}){{with .Default}} ^ {{.}}{{end}})
return {{.ReturnType}}(capnp.Struct(s).Uint{{.Bits}}({{.Offset}}){{with .Default}} ^ {{.}}{{end}})
}

func (s {{.Node.Name}}) Set{{.Field.Name|title}}(v {{.ReturnType}}) {
{{template "_settag" . -}}
s.Struct.SetUint{{.Bits}}({{.Offset}}, uint{{.Bits}}(v){{with .Default}}^{{.}}{{end}})
capnp.Struct(s).SetUint{{.Bits}}({{.Offset}}, uint{{.Bits}}(v){{with .Default}}^{{.}}{{end}})
}

6 changes: 3 additions & 3 deletions capnpc-go/templates/structInterfaceField
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
func (s {{.Node.Name}}) {{.Field.Name|title}}() {{.FieldType}} {
{{template "_checktag" . -}}
p, _ := s.Struct.Ptr({{.Field.Slot.Offset}})
p, _ := capnp.Struct(s).Ptr({{.Field.Slot.Offset}})
return {{.FieldType}}(p.Interface().Client())
}

Expand All @@ -9,10 +9,10 @@ func (s {{.Node.Name}}) {{.Field.Name|title}}() {{.FieldType}} {
func (s {{.Node.Name}}) Set{{.Field.Name|title}}(v {{.FieldType}}) error {
{{template "_settag" . -}}
if !v.IsValid() {
return s.Struct.SetPtr({{.Field.Slot.Offset}}, capnp.Ptr{})
return capnp.Struct(s).SetPtr({{.Field.Slot.Offset}}, capnp.Ptr{})
}
seg := s.Segment()
in := capnp.NewInterface(seg, seg.Message().AddCap(capnp.Client(v)))
return s.Struct.SetPtr({{.Field.Slot.Offset}}, in.ToPtr())
return capnp.Struct(s).SetPtr({{.Field.Slot.Offset}}, in.ToPtr())
}

8 changes: 4 additions & 4 deletions capnpc-go/templates/structListField
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
func (s {{.Node.Name}}) {{.Field.Name|title}}() ({{.FieldType}}, error) {
{{template "_checktag" . -}}
p, err := s.Struct.Ptr({{.Field.Slot.Offset}})
p, err := capnp.Struct(s).Ptr({{.Field.Slot.Offset}})
{{if .Default.IsValid -}}
if err != nil {
return {{.FieldType}}{}, err
Expand All @@ -16,18 +16,18 @@ func (s {{.Node.Name}}) {{.Field.Name|title}}() ({{.FieldType}}, error) {

func (s {{.Node.Name}}) Set{{.Field.Name|title}}(v {{.FieldType}}) error {
{{template "_settag" . -}}
return s.Struct.SetPtr({{.Field.Slot.Offset}}, v.List.ToPtr())
return capnp.Struct(s).SetPtr({{.Field.Slot.Offset}}, v.List.ToPtr())
}

// New{{.Field.Name|title}} sets the {{.Field.Name}} field to a newly
// allocated {{.FieldType}}, preferring placement in s's segment.
func (s {{.Node.Name}}) New{{.Field.Name|title}}(n int32) ({{.FieldType}}, error) {
{{template "_settag" . -}}
l, err := {{.G.RemoteTypeNew .Field.Slot.Type .Node}}(s.Struct.Segment(), n)
l, err := {{.G.RemoteTypeNew .Field.Slot.Type .Node}}(capnp.Struct(s).Segment(), n)
if err != nil {
return {{.FieldType}}{}, err
}
err = s.Struct.SetPtr({{.Field.Slot.Offset}}, l.List.ToPtr())
err = capnp.Struct(s).SetPtr({{.Field.Slot.Offset}}, l.List.ToPtr())
return l, err
}

6 changes: 3 additions & 3 deletions capnpc-go/templates/structPointerField
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
func (s {{.Node.Name}}) {{.Field.Name|title}}() (capnp.Ptr, error) {
{{template "_checktag" . -}}
{{if .Default.IsValid -}}
p, err := s.Struct.Ptr({{.Field.Slot.Offset}})
p, err := capnp.Struct(s).Ptr({{.Field.Slot.Offset}})
if err != nil {
return nil, err
}
return p.Default({{.Default}})
{{- else -}}
return s.Struct.Ptr({{.Field.Slot.Offset}})
return capnp.Struct(s).Ptr({{.Field.Slot.Offset}})
{{- end}}
}

{{template "_hasfield" .}}

func (s {{.Node.Name}}) Set{{.Field.Name|title}}(v capnp.Ptr) error {
{{template "_settag" . -}}
return s.Struct.SetPtr({{.Field.Slot.Offset}}, v)
return capnp.Struct(s).SetPtr({{.Field.Slot.Offset}}, v)
}

12 changes: 6 additions & 6 deletions capnpc-go/templates/structStructField
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
func (s {{.Node.Name}}) {{.Field.Name|title}}() ({{.FieldType}}, error) {
{{template "_checktag" . -}}
p, err := s.Struct.Ptr({{.Field.Slot.Offset}})
p, err := capnp.Struct(s).Ptr({{.Field.Slot.Offset}})
{{if .Default.IsValid -}}
if err != nil {
return {{.FieldType}}{}, err
}
ss, err := p.StructDefault({{.Default}})
return {{.FieldType}}{Struct: ss}, err
return {{.FieldType}}(ss), err
{{- else -}}
return {{.FieldType}}{Struct: p.Struct()}, err
return {{.FieldType}}(p.Struct()), err
{{- end}}
}

{{template "_hasfield" .}}

func (s {{.Node.Name}}) Set{{.Field.Name|title}}(v {{.FieldType}}) error {
{{template "_settag" . -}}
return s.Struct.SetPtr({{.Field.Slot.Offset}}, v.Struct.ToPtr())
return capnp.Struct(s).SetPtr({{.Field.Slot.Offset}}, capnp.Struct(v).ToPtr())
}

// New{{.Field.Name|title}} sets the {{.Field.Name}} field to a newly
// allocated {{.FieldType}} struct, preferring placement in s's segment.
func (s {{.Node.Name}}) New{{.Field.Name|title}}() ({{.FieldType}}, error) {
{{template "_settag" . -}}
ss, err := {{.G.RemoteNodeNew .TypeNode .Node}}(s.Struct.Segment())
ss, err := {{.G.RemoteNodeNew .TypeNode .Node}}(capnp.Struct(s).Segment())
if err != nil {
return {{.FieldType}}{}, err
}
err = s.Struct.SetPtr({{.Field.Slot.Offset}}, ss.Struct.ToPtr())
err = capnp.Struct(s).SetPtr({{.Field.Slot.Offset}}, capnp.Struct(ss).ToPtr())
return ss, err
}

8 changes: 4 additions & 4 deletions capnpc-go/templates/structTextField
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
func (s {{.Node.Name}}) {{.Field.Name|title}}() (string, error) {
{{template "_checktag" . -}}
p, err := s.Struct.Ptr({{.Field.Slot.Offset}})
p, err := capnp.Struct(s).Ptr({{.Field.Slot.Offset}})
{{with .Default -}}
return p.TextDefault({{printf "%q" .}}), err
{{- else -}}
Expand All @@ -11,7 +11,7 @@ func (s {{.Node.Name}}) {{.Field.Name|title}}() (string, error) {
{{template "_hasfield" .}}

func (s {{.Node.Name}}) {{.Field.Name|title}}Bytes() ([]byte, error) {
p, err := s.Struct.Ptr({{.Field.Slot.Offset}})
p, err := capnp.Struct(s).Ptr({{.Field.Slot.Offset}})
{{with .Default -}}
return p.TextBytesDefault({{printf "%q" .}}), err
{{- else -}}
Expand All @@ -22,9 +22,9 @@ func (s {{.Node.Name}}) {{.Field.Name|title}}Bytes() ([]byte, error) {
func (s {{.Node.Name}}) Set{{.Field.Name|title}}(v string) error {
{{template "_settag" . -}}
{{if .Default -}}
return s.Struct.SetNewText({{.Field.Slot.Offset}}, v)
return capnp.Struct(s).SetNewText({{.Field.Slot.Offset}}, v)
{{- else -}}
return s.Struct.SetText({{.Field.Slot.Offset}}, v)
return capnp.Struct(s).SetText({{.Field.Slot.Offset}}, v)
{{- end}}
}

2 changes: 1 addition & 1 deletion capnpc-go/templates/structTypes
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// {{.}}
{{end -}}
type {{.Node.Name}} {{if .IsBase -}}
struct{ capnp.Struct }
capnp.Struct
{{- else -}}
{{.BaseNode.Name}}
{{- end}}
4 changes: 2 additions & 2 deletions capnpc-go/templates/structUintField
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
func (s {{.Node.Name}}) {{.Field.Name|title}}() uint{{.Bits}} {
{{template "_checktag" . -}}
return s.Struct.Uint{{.Bits}}({{.Offset}}){{with .Default}} ^ {{.}}{{end}}
return capnp.Struct(s).Uint{{.Bits}}({{.Offset}}){{with .Default}} ^ {{.}}{{end}}
}

func (s {{.Node.Name}}) Set{{.Field.Name|title}}(v uint{{.Bits}}) {
{{template "_settag" . -}}
s.Struct.SetUint{{.Bits}}({{.Offset}}, v{{with .Default}}^{{.}}{{end}})
capnp.Struct(s).SetUint{{.Bits}}({{.Offset}}, v{{with .Default}}^{{.}}{{end}})
}

2 changes: 1 addition & 1 deletion capnpc-go/templates/structValue
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
{{.G.RemoteNodeName .Typ .Node}}{Struct: capnp.MustUnmarshalRoot({{.Value}}).Struct()}
{{.G.RemoteNodeName .Typ .Node}}(capnp.MustUnmarshalRoot({{.Value}}).Struct())
{{- /* no EOL */ -}}
Loading