X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=binapigen%2Fgenerate.go;h=2ad3eb3074ad8e15a936d7ee7e6265f1ccb42e54;hb=a5739cb7160349f96c428995049ff61411689ea0;hp=698c798d31c113fd31867d267fae5e7ad14e1147;hpb=ff0a39377533365e128c3364395c6bfbae8d5b1a;p=govpp.git

diff --git a/binapigen/generate.go b/binapigen/generate.go
index 698c798..2ad3eb3 100644
--- a/binapigen/generate.go
+++ b/binapigen/generate.go
@@ -41,6 +41,19 @@ const (
 	fieldUnionData = "XXX_UnionData" // name for the union data field
 )
 
+// option keys
+const (
+	msgStatus     = "status"
+	msgDeprecated = "deprecated"
+	msgInProgress = "in_progress"
+)
+
+// generated option messages
+const (
+	deprecatedMsg = "the message will be removed in the future versions"
+	inProgressMsg = "the message form may change in the future versions"
+)
+
 func GenerateAPI(gen *Generator, file *File) *GenFile {
 	logf("----------------------------")
 	logf(" Generate API - %s", file.Desc.Name)
@@ -145,6 +158,23 @@ func genTypeComment(g *GenFile, goName string, vppName string, objKind string) {
 	g.P("// ", goName, " defines ", objKind, " '", vppName, "'.")
 }
 
+func genTypeOptionComment(g *GenFile, options map[string]string) {
+	// all messages for API versions < 1.0.0 are in_progress by default
+	if msg, ok := options[msgInProgress]; ok || options[msgStatus] == msgInProgress ||
+		len(g.file.Version) > 1 && g.file.Version[0:2] == "0." {
+		if msg == "" {
+			msg = inProgressMsg
+		}
+		g.P("// InProgress: ", msg)
+	}
+	if msg, ok := options[msgDeprecated]; ok || options[msgStatus] == msgDeprecated {
+		if msg == "" {
+			msg = deprecatedMsg
+		}
+		g.P("// Deprecated: ", msg)
+	}
+}
+
 func genEnum(g *GenFile, enum *Enum) {
 	logf("gen ENUM %s (%s) - %d entries", enum.GoName, enum.Name, len(enum.Entries))
 
@@ -178,7 +208,7 @@ func genEnum(g *GenFile, enum *Enum) {
 	g.P(")")
 	g.P()
 
-	if isEnumFlag(enum) {
+	if enum.IsFlag || isEnumFlag(enum) {
 		size := BaseTypeSizes[enum.Type] * 8
 		g.P("func (x ", enum.GoName, ") String() string {")
 		g.P("	s, ok := ", enum.GoName, "_name[", gotype, "(x)]")
@@ -246,6 +276,8 @@ func genAlias(g *GenFile, alias *Alias) {
 		genAddressWithPrefixConversion(g, alias.GoName)
 	case "mac_address":
 		genMacAddressConversion(g, alias.GoName)
+	case "timestamp":
+		genTimestampConversion(g, alias.GoName)
 	}
 }
 
@@ -285,8 +317,10 @@ func genUnion(g *GenFile, union *Union) {
 
 	g.P("type ", union.GoName, " struct {")
 
+	// generate field comments
+	g.P("// ", union.GoName, " can be one of:")
 	for _, field := range union.Fields {
-		g.P("// ", field.GoName, " *", getFieldType(g, field))
+		g.P("// - ", field.GoName, " *", getFieldType(g, field))
 	}
 
 	// generate data field
@@ -299,22 +333,23 @@ func genUnion(g *GenFile, union *Union) {
 
 	// generate methods for fields
 	for _, field := range union.Fields {
-		genUnionFieldMethods(g, union.GoName, field)
+		genUnionField(g, union, field)
 	}
 	g.P()
 }
 
-func genUnionFieldMethods(g *GenFile, structName string, field *Field) {
-	getterStruct := fieldGoType(g, field)
+func genUnionField(g *GenFile, union *Union, field *Field) {
+	fieldType := fieldGoType(g, field)
+	constructorName := union.GoName + field.GoName
 
 	// Constructor
-	g.P("func ", structName, field.GoName, "(a ", getterStruct, ") (u ", structName, ") {")
+	g.P("func ", constructorName, "(a ", fieldType, ") (u ", union.GoName, ") {")
 	g.P("	u.Set", field.GoName, "(a)")
 	g.P("	return")
 	g.P("}")
 
 	// Setter
-	g.P("func (u *", structName, ") Set", field.GoName, "(a ", getterStruct, ") {")
+	g.P("func (u *", union.GoName, ") Set", field.GoName, "(a ", fieldType, ") {")
 	g.P("	buf := ", govppCodecPkg.Ident("NewBuffer"), "(u.", fieldUnionData, "[:])")
 	encodeField(g, field, "a", func(name string) string {
 		return "a." + name
@@ -322,16 +357,24 @@ func genUnionFieldMethods(g *GenFile, structName string, field *Field) {
 	g.P("}")
 
 	// Getter
-	g.P("func (u *", structName, ") Get", field.GoName, "() (a ", getterStruct, ") {")
+	g.P("func (u *", union.GoName, ") Get", field.GoName, "() (a ", fieldType, ") {")
 	g.P("	buf := ", govppCodecPkg.Ident("NewBuffer"), "(u.", fieldUnionData, "[:])")
 	decodeField(g, field, "a", func(name string) string {
 		return "a." + name
 	}, 0)
 	g.P("	return")
 	g.P("}")
+
 	g.P()
 }
 
+func withSuffix(s string, suffix string) string {
+	if strings.HasSuffix(s, suffix) {
+		return s
+	}
+	return s + suffix
+}
+
 func genField(g *GenFile, fields []*Field, i int) {
 	field := fields[i]
 
@@ -440,6 +483,7 @@ func genMessage(g *GenFile, msg *Message) {
 	logf("gen MESSAGE %s (%s) - %d fields", msg.GoName, msg.Name, len(msg.Fields))
 
 	genTypeComment(g, msg.GoIdent.GoName, msg.Name, "message")
+	genTypeOptionComment(g, msg.Options)
 
 	// generate message definition
 	if len(msg.Fields) == 0 {