aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/binapi-generator/main.go
blob: e30aaf21db590861ed39c8ef50983d72d7f2c074 (plain)
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
// Copyright (c) 2018 Cisco and/or its affiliates.
//
// 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 main

import (
	"flag"
	"fmt"
	"os"

	"github.com/sirupsen/logrus"

	"git.fd.io/govpp.git/binapigen"
	"git.fd.io/govpp.git/binapigen/vppapi"
	"git.fd.io/govpp.git/version"
)

func init() {
	flag.Usage = func() {
		fmt.Fprintf(flag.CommandLine.Output(), "Usage: %s [OPTION]... [API]...\n", os.Args[0])
		fmt.Fprintln(flag.CommandLine.Output(), "Generate code for each API.")
		fmt.Fprintf(flag.CommandLine.Output(), "Example: %s -output-dir=binapi acl interface l2\n", os.Args[0])
		fmt.Fprintln(flag.CommandLine.Output())
		fmt.Fprintln(flag.CommandLine.Output(), "Options:")
		flag.CommandLine.PrintDefaults()
	}
}

func main() {
	var (
		theInputFile = flag.String("input-file", "", "Input VPP API file. (DEPRECATED: Use program arguments to define VPP API files)")
		theApiDir    = flag.String("input-dir", vppapi.DefaultAPIDir, "Directory with VPP API files.")
		theOutputDir = flag.String("output-dir", ".", "Output directory where code will be generated.")

		importPrefix       = flag.String("import-prefix", "", "Define import path prefix to be used to import types.")
		importTypes        = flag.Bool("import-types", true, "Generate packages for imported types.")
		includeAPIVer      = flag.Bool("include-apiver", true, "Include APIVersion constant for each module.")
		includeServices    = flag.Bool("include-services", true, "Include RPC service api and client implementation.")
		includeComments    = flag.Bool("include-comments", false, "Include JSON API source in comments for each object.")
		includeBinapiNames = flag.Bool("include-binapi-names", true, "Include binary API names in struct tag.")
		includeVppVersion  = flag.Bool("include-vpp-version", true, "Include version of the VPP that provided input files.")

		debugMode    = flag.Bool("debug", os.Getenv("DEBUG_GOVPP") != "", "Enable debug mode.")
		printVersion = flag.Bool("version", false, "Prints version and exits.")
	)
	flag.Parse()
	if *printVersion {
		fmt.Fprintln(os.Stdout, version.Info())
		os.Exit(0)
	}
	if flag.NArg() == 1 && flag.Arg(0) == "version" {
		fmt.Fprintln(os.Stdout, version.Verbose())
		os.Exit(0)
	}

	// prepare options
	var opts binapigen.Options
	if *theInputFile != "" {
		if flag.NArg() > 0 {
			fmt.Fprintln(os.Stderr, "input-file cannot be combined with files to generate in arguments")
			os.Exit(1)
		}
		opts.FilesToGenerate = append(opts.FilesToGenerate, *theInputFile)
	} else {
		opts.FilesToGenerate = append(opts.FilesToGenerate, flag.Args()...)
	}
	if ver := os.Getenv("VPP_API_VERSION"); ver != "" {
		// use version from env var if set
		opts.VPPVersion = ver
	} else {
		opts.VPPVersion = ResolveVppVersion(*theApiDir)
	}
	opts.IncludeAPIVersion = *includeAPIVer
	opts.IncludeComments = *includeComments
	opts.IncludeBinapiNames = *includeBinapiNames
	opts.IncludeServices = *includeServices
	opts.IncludeVppVersion = *includeVppVersion
	opts.ImportPrefix = *importPrefix
	opts.ImportTypes = *importTypes

	if *debugMode {
		logrus.SetLevel(logrus.DebugLevel)
		logrus.Debug("debug mode enabled")
	}

	apiDir := *theApiDir
	outputDir := *theOutputDir

	binapigen.Run(apiDir, opts, func(g *binapigen.Generator) error {
		for _, file := range g.Files {
			if !file.Generate {
				continue
			}
			binapigen.GenerateBinapi(g, file, outputDir)
			if g.IncludeServices && file.Service != nil {
				binapigen.GenerateRPC(g, file, outputDir)
			}
		}
		return nil
	})
}