summaryrefslogtreecommitdiffstats
path: root/binapigen/generate.go
diff options
context:
space:
mode:
authorVladimir Lavor <vlavor@cisco.com>2021-03-11 10:13:17 +0100
committerVladimir Lavor <vlavor@cisco.com>2021-04-22 11:32:58 +0200
commita6607d9c1ba37320984c13580c932076cbff6dd6 (patch)
treea8a7dba6b40114788c1295197c1b4bd8010f22c0 /binapigen/generate.go
parentd0b973030fe07dc7875da72f5ebe42d8bd9544b1 (diff)
added api message options
In case the API message contains option of type deprecated or in-progress, the information is displayed in the generated code in a form of additional comment: // InProgress: <info> // Deprecated: <info> In case the <info> is not provided, a generic message is shown. Possible future use to automatically search whether such messages are in use. Change-Id: Icf87cc9a2fe6bf31f7555320255c9f0736add6e1 Signed-off-by: Vladimir Lavor <vlavor@cisco.com>
Diffstat (limited to 'binapigen/generate.go')
-rw-r--r--binapigen/generate.go31
1 files changed, 31 insertions, 0 deletions
diff --git a/binapigen/generate.go b/binapigen/generate.go
index a2f941a..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))
@@ -453,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 {