specgen

Documentation

Overview

Package specgen generates Java API YAML specs from .class files using javap.

Index

• Variables
• func GenerateFromRefDir(refDir string, extraClassPath string, outputDir string, goModule string) error
• type JavapClass
  • func RunJavap(classPath string, className string) (*JavapClass, error)
• type JavapConstant
• type JavapMethod
• type JavapParam
• type PackageMapping
• type SpecCallback
• type SpecCallbackMethod
• type SpecClass
• type SpecConstant
• type SpecField
• type SpecFile
  • func GenerateSpec(classPath string, className string, pkgMapping PackageMapping, goModule string) (*SpecFile, error)
• type SpecMethod
• type SpecParam

Variables

var AndroidServiceName = map[string]string{
	"android.app.AlarmManager":                        "alarm",
	"android.app.KeyguardManager":                     "keyguard",
	"android.app.NotificationManager":                 "notification",
	"android.app.admin.DevicePolicyManager":           "device_policy",
	"android.app.blob.BlobStoreManager":               "blob_store",
	"android.app.job.JobScheduler":                    "jobscheduler",
	"android.app.role.RoleManager":                    "role",
	"android.app.usage.UsageStatsManager":             "usagestats",
	"android.bluetooth.BluetoothManager":              "bluetooth",
	"android.companion.CompanionDeviceManager":        "companiondevice",
	"android.content.ClipboardManager":                "clipboard",
	"android.hardware.ConsumerIrManager":              "consumer_ir",
	"android.hardware.camera2.CameraManager":          "camera",
	"android.hardware.lights.LightsManager":           "lights",
	"android.location.LocationManager":                "location",
	"android.media.AudioManager":                      "audio",
	"android.media.RingtoneManager":                   "",
	"android.media.projection.MediaProjectionManager": "media_projection",
	"android.media.session.MediaSessionManager":       "media_session",
	"android.net.ConnectivityManager":                 "connectivity",
	"android.net.wifi.WifiManager":                    "wifi",
	"android.net.wifi.p2p.WifiP2pManager":             "wifip2p",
	"android.net.wifi.rtt.WifiRttManager":             "wifirtt",
	"android.nfc.NfcManager":                          "nfc",
	"android.os.BatteryManager":                       "batterymanager",
	"android.os.PowerManager":                         "power",
	"android.os.Vibrator":                             "vibrator",
	"android.os.storage.StorageManager":               "storage",
	"android.print.PrintManager":                      "print",
	"android.se.omapi.SEService":                      "",
	"android.telecom.TelecomManager":                  "telecom",
	"android.telephony.TelephonyManager":              "phone",
	"android.view.WindowManager":                      "window",
	"android.view.inputmethod.InputMethodManager":     "input_method",
}

AndroidServiceName maps known manager class names to their Android Context.getSystemService() constant names.

Functions

func GenerateFromRefDir

func GenerateFromRefDir(
	refDir string,
	extraClassPath string,
	outputDir string,
	goModule string,
) error

GenerateFromRefDir scans ref/ for .class files and generates one YAML spec per top-level class (inner classes are grouped with their parent). extraClassPath is appended to the javap -cp argument.

Types

type JavapClass

type JavapClass struct {
	FullName    string // e.g. "android.app.KeyguardManager"
	IsInterface bool
	IsAbstract  bool
	IsFinal     bool
	Constants   []JavapConstant
	Methods     []JavapMethod
	Implements  []string
}

JavapClass holds the parsed output of javap for one class.

func RunJavap

func RunJavap(classPath string, className string) (*JavapClass, error)

RunJavap executes javap and parses the output for a single class. classPath can contain multiple entries separated by ":". Uses -verbose to extract constant values from ConstantValue attributes.

type JavapConstant

type JavapConstant struct {
	Name     string // e.g. "ERROR_BAD_VALUE"
	JavaType string // e.g. "int", "java.lang.String"
	Value    string // e.g. "1", "gps" — extracted from ConstantValue attribute
}

JavapConstant is a public static final field.

type JavapMethod

type JavapMethod struct {
	Name       string
	ReturnType string // "void", "int", "boolean", "java.lang.String", etc.
	Params     []JavapParam
	IsStatic   bool
	Throws     bool
}

JavapMethod is a public method parsed from javap output.

type JavapParam

type JavapParam struct {
	JavaType string
}

JavapParam is a method parameter.

type PackageMapping

type PackageMapping struct {
	JavaPrefix string // e.g. "android.app.admin"
	Package    string // e.g. "admin"
	GoImport   string // e.g. "github.com/AndroidGoLab/jni/app/admin"
}

PackageMapping defines how a Java package maps to a Go package.

type SpecCallback

type SpecCallback struct {
	JavaInterface string               `yaml:"java_interface"`
	GoType        string               `yaml:"go_type"`
	Methods       []SpecCallbackMethod `yaml:"methods"`
}

SpecCallback is a callback interface in the YAML spec.

type SpecCallbackMethod

type SpecCallbackMethod struct {
	JavaMethod string   `yaml:"java_method"`
	Params     []string `yaml:"params"`
	GoField    string   `yaml:"go_field"`
}

SpecCallbackMethod is a callback method in the YAML spec.

type SpecClass

type SpecClass struct {
	JavaClass     string       `yaml:"java_class"`
	GoType        string       `yaml:"go_type"`
	Obtain        string       `yaml:"obtain,omitempty"`
	ServiceName   string       `yaml:"service_name,omitempty"`
	Kind          string       `yaml:"kind,omitempty"`
	Close         bool         `yaml:"close,omitempty"`
	Methods       []SpecMethod `yaml:"methods,omitempty"`
	StaticMethods []SpecMethod `yaml:"static_methods,omitempty"`
	Fields        []SpecField  `yaml:"fields,omitempty"`
}

SpecClass is a class in the YAML spec.

type SpecConstant

type SpecConstant struct {
	GoName string `yaml:"go_name"`
	Value  string `yaml:"value"`
	GoType string `yaml:"go_type"`
}

SpecConstant is a constant in the YAML spec.

type SpecField

type SpecField struct {
	JavaMethod string `yaml:"java_method"`
	Returns    string `yaml:"returns"`
	GoName     string `yaml:"go_name"`
	GoType     string `yaml:"go_type"`
}

SpecField is a data class field in the YAML spec.

type SpecFile

type SpecFile struct {
	Package   string         `yaml:"package"`
	GoImport  string         `yaml:"go_import"`
	Classes   []SpecClass    `yaml:"classes"`
	Callbacks []SpecCallback `yaml:"callbacks,omitempty"`
	Constants []SpecConstant `yaml:"constants,omitempty"`
}

SpecFile is the YAML output structure.

func GenerateSpec

func GenerateSpec(
	classPath string,
	className string,
	pkgMapping PackageMapping,
	goModule string,
) (*SpecFile, error)

GenerateSpec generates a YAML spec from .class files in a directory by running javap on each class.

type SpecMethod

type SpecMethod struct {
	JavaMethod string      `yaml:"java_method"`
	GoName     string      `yaml:"go_name"`
	Params     []SpecParam `yaml:"params,omitempty"`
	Returns    string      `yaml:"returns"`
	Error      bool        `yaml:"error"`
}

SpecMethod is a method in the YAML spec.

type SpecParam

type SpecParam struct {
	JavaType string `yaml:"java_type"`
	GoName   string `yaml:"go_name"`
}

SpecParam is a method parameter in the YAML spec.