From f29df7cc520d4d67c8aad19d03e275eb7b9c76bf Mon Sep 17 00:00:00 2001 From: Liz Kammer Date: Fri, 2 Apr 2021 13:37:39 -0400 Subject: [PATCH] Move cquery RequestType interface to bazel_handler go idiom is to define the interface where it is used rather than where it is defined. This makes it obvious that ParseResult is not a used part of the interface, removing the need to return an interface{} and cast results. Test: go test soong tests Test: generate & sync bp2build; mixed build libc Change-Id: I0d8d99c1d8d0125588522cc86502286b83c91bf7 --- android/bazel_handler.go | 26 ++++++++++++---- bazel/cquery/request_type.go | 57 +++++++++++++++++++----------------- 2 files changed, 51 insertions(+), 32 deletions(-) diff --git a/android/bazel_handler.go b/android/bazel_handler.go index 5b9d3bfe8..5ac69240a 100644 --- a/android/bazel_handler.go +++ b/android/bazel_handler.go @@ -34,10 +34,26 @@ import ( "android/soong/shared" ) +type cqueryRequest interface { + // Name returns a string name for this request type. Such request type names must be unique, + // and must only consist of alphanumeric characters. + Name() string + + // StarlarkFunctionBody returns a starlark function body to process this request type. + // The returned string is the body of a Starlark function which obtains + // all request-relevant information about a target and returns a string containing + // this information. + // The function should have the following properties: + // - `target` is the only parameter to this function (a configured target). + // - The return value must be a string. + // - The function body should not be indented outside of its own scope. + StarlarkFunctionBody() string +} + // Map key to describe bazel cquery requests. type cqueryKey struct { label string - requestType cquery.RequestType + requestType cqueryRequest archType ArchType } @@ -133,7 +149,7 @@ func (bazelCtx *bazelContext) GetOutputFiles(label string, archType ArchType) ([ var ret []string if ok { bazelOutput := strings.TrimSpace(rawString) - ret = cquery.GetOutputFiles.ParseResult(bazelOutput).([]string) + ret = cquery.GetOutputFiles.ParseResult(bazelOutput) } return ret, ok } @@ -145,7 +161,7 @@ func (bazelCtx *bazelContext) GetOutputFilesAndCcObjectFiles(label string, archT result, ok := bazelCtx.cquery(label, cquery.GetOutputFilesAndCcObjectFiles, archType) if ok { bazelOutput := strings.TrimSpace(result) - returnResult := cquery.GetOutputFilesAndCcObjectFiles.ParseResult(bazelOutput).(cquery.GetOutputFilesAndCcObjectFiles_Result) + returnResult := cquery.GetOutputFilesAndCcObjectFiles.ParseResult(bazelOutput) outputFiles = returnResult.OutputFiles ccObjects = returnResult.CcObjectFiles } @@ -231,7 +247,7 @@ func (context *bazelContext) BazelEnabled() bool { // If the given request was already made (and the results are available), then // returns (result, true). If the request is queued but no results are available, // then returns ("", false). -func (context *bazelContext) cquery(label string, requestType cquery.RequestType, +func (context *bazelContext) cquery(label string, requestType cqueryRequest, archType ArchType) (string, bool) { key := cqueryKey{label, requestType, archType} if result, ok := context.results[key]; ok { @@ -449,7 +465,7 @@ func indent(original string) string { // and grouped by their request type. The data retrieved for each label depends on its // request type. func (context *bazelContext) cqueryStarlarkFileContents() []byte { - requestTypeToCqueryIdEntries := map[cquery.RequestType][]string{} + requestTypeToCqueryIdEntries := map[cqueryRequest][]string{} for val, _ := range context.requests { cqueryId := getCqueryId(val) mapEntryString := fmt.Sprintf("%q : True", cqueryId) diff --git a/bazel/cquery/request_type.go b/bazel/cquery/request_type.go index affb5cead..4a64c510b 100644 --- a/bazel/cquery/request_type.go +++ b/bazel/cquery/request_type.go @@ -5,8 +5,8 @@ import ( ) var ( - GetOutputFiles RequestType = &getOutputFilesRequestType{} - GetOutputFilesAndCcObjectFiles RequestType = &getOutputFilesAndCcObjectFilesType{} + GetOutputFiles = &getOutputFilesRequestType{} + GetOutputFilesAndCcObjectFiles = &getOutputFilesAndCcObjectFilesType{} ) type GetOutputFilesAndCcObjectFiles_Result struct { @@ -14,49 +14,49 @@ type GetOutputFilesAndCcObjectFiles_Result struct { CcObjectFiles []string } -type RequestType interface { - // Name returns a string name for this request type. Such request type names must be unique, - // and must only consist of alphanumeric characters. - Name() string - - // StarlarkFunctionBody returns a straark function body to process this request type. - // The returned string is the body of a Starlark function which obtains - // all request-relevant information about a target and returns a string containing - // this information. - // The function should have the following properties: - // - `target` is the only parameter to this function (a configured target). - // - The return value must be a string. - // - The function body should not be indented outside of its own scope. - StarlarkFunctionBody() string - - // ParseResult returns a value obtained by parsing the result of the request's Starlark function. - // The given rawString must correspond to the string output which was created by evaluating the - // Starlark given in StarlarkFunctionBody. - // The type of this value depends on the request type; it is up to the caller to - // cast to the correct type. - ParseResult(rawString string) interface{} -} - type getOutputFilesRequestType struct{} +// Name returns a string name for this request type. Such request type names must be unique, +// and must only consist of alphanumeric characters. func (g getOutputFilesRequestType) Name() string { return "getOutputFiles" } +// StarlarkFunctionBody returns a starlark function body to process this request type. +// The returned string is the body of a Starlark function which obtains +// all request-relevant information about a target and returns a string containing +// this information. +// The function should have the following properties: +// - `target` is the only parameter to this function (a configured target). +// - The return value must be a string. +// - The function body should not be indented outside of its own scope. func (g getOutputFilesRequestType) StarlarkFunctionBody() string { return "return ', '.join([f.path for f in target.files.to_list()])" } -func (g getOutputFilesRequestType) ParseResult(rawString string) interface{} { +// ParseResult returns a value obtained by parsing the result of the request's Starlark function. +// The given rawString must correspond to the string output which was created by evaluating the +// Starlark given in StarlarkFunctionBody. +func (g getOutputFilesRequestType) ParseResult(rawString string) []string { return strings.Split(rawString, ", ") } type getOutputFilesAndCcObjectFilesType struct{} +// Name returns a string name for this request type. Such request type names must be unique, +// and must only consist of alphanumeric characters. func (g getOutputFilesAndCcObjectFilesType) Name() string { return "getOutputFilesAndCcObjectFiles" } +// StarlarkFunctionBody returns a starlark function body to process this request type. +// The returned string is the body of a Starlark function which obtains +// all request-relevant information about a target and returns a string containing +// this information. +// The function should have the following properties: +// - `target` is the only parameter to this function (a configured target). +// - The return value must be a string. +// - The function body should not be indented outside of its own scope. func (g getOutputFilesAndCcObjectFilesType) StarlarkFunctionBody() string { return ` outputFiles = [f.path for f in target.files.to_list()] @@ -71,7 +71,10 @@ for linker_input in linker_inputs: return ', '.join(outputFiles) + "|" + ', '.join(ccObjectFiles)` } -func (g getOutputFilesAndCcObjectFilesType) ParseResult(rawString string) interface{} { +// ParseResult returns a value obtained by parsing the result of the request's Starlark function. +// The given rawString must correspond to the string output which was created by evaluating the +// Starlark given in StarlarkFunctionBody. +func (g getOutputFilesAndCcObjectFilesType) ParseResult(rawString string) GetOutputFilesAndCcObjectFiles_Result { var outputFiles []string var ccObjects []string