ide_query_proto

package
v0.0.0-...-067155f Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 10, 2025 License: BSD-3-Clause Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Language_name = map[int32]string{
		0: "LANGUAGE_UNSPECIFIED",
		1: "LANGUAGE_JAVA",
		2: "LANGUAGE_CPP",
	}
	Language_value = map[string]int32{
		"LANGUAGE_UNSPECIFIED": 0,
		"LANGUAGE_JAVA":        1,
		"LANGUAGE_CPP":         2,
	}
)

Enum value maps for Language.

View Source 
var (
	Status_Code_name = map[int32]string{
		0: "OK",
		1: "FAILURE",
	}
	Status_Code_value = map[string]int32{
		"OK":      0,
		"FAILURE": 1,
	}
)

Enum value maps for Status_Code.

View Source 
var (
	AnalysisResult_Status_Code_name = map[int32]string{
		0: "CODE_UNSPECIFIED",
		1: "CODE_OK",
		2: "CODE_NOT_FOUND",
		3: "CODE_BUILD_FAILED",
	}
	AnalysisResult_Status_Code_value = map[string]int32{
		"CODE_UNSPECIFIED":  0,
		"CODE_OK":           1,
		"CODE_NOT_FOUND":    2,
		"CODE_BUILD_FAILED": 3,
	}
)

Enum value maps for AnalysisResult_Status_Code.

View Source 
var File_ide_query_ide_query_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AnalysisError 

type AnalysisError struct {

	// Human readable error message.
	ErrorMessage string `protobuf:"bytes,1,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

func (*AnalysisError) Descriptor deprecated 

func (*AnalysisError) Descriptor() ([]byte, []int)

Deprecated: Use AnalysisError.ProtoReflect.Descriptor instead.

func (*AnalysisError) GetErrorMessage 

func (x *AnalysisError) GetErrorMessage() string

func (*AnalysisError) ProtoMessage 

func (*AnalysisError) ProtoMessage()

func (*AnalysisError) ProtoReflect 

func (x *AnalysisError) ProtoReflect() protoreflect.Message

func (*AnalysisError) Reset 

func (x *AnalysisError) Reset()

func (*AnalysisError) String 

func (x *AnalysisError) String() string

type AnalysisResult 

type AnalysisResult struct {

	// Path to the source file that was queried, relative to repository root.
	SourceFilePath string `protobuf:"bytes,1,opt,name=source_file_path,json=sourceFilePath,proto3" json:"source_file_path,omitempty"`
	// Represents status for this result. e.g. not part of the build graph.
	Status *AnalysisResult_Status `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// ID of buildable unit that contains the source file.
	// The ide_query script can choose the most relevant unit from multiple
	// options.
	UnitId string `protobuf:"bytes,3,opt,name=unit_id,json=unitId,proto3" json:"unit_id,omitempty"`
	// Invalidation rule to check if the result is still valid.
	Invalidation *Invalidation `protobuf:"bytes,4,opt,name=invalidation,proto3" json:"invalidation,omitempty"`
	// contains filtered or unexported fields
}

func (*AnalysisResult) Descriptor deprecated 

func (*AnalysisResult) Descriptor() ([]byte, []int)

Deprecated: Use AnalysisResult.ProtoReflect.Descriptor instead.

func (*AnalysisResult) GetInvalidation 

func (x *AnalysisResult) GetInvalidation() *Invalidation

func (*AnalysisResult) GetSourceFilePath 

func (x *AnalysisResult) GetSourceFilePath() string

func (*AnalysisResult) GetStatus 

func (x *AnalysisResult) GetStatus() *AnalysisResult_Status

func (*AnalysisResult) GetUnitId 

func (x *AnalysisResult) GetUnitId() string

func (*AnalysisResult) ProtoMessage 

func (*AnalysisResult) ProtoMessage()

func (*AnalysisResult) ProtoReflect 

func (x *AnalysisResult) ProtoReflect() protoreflect.Message

func (*AnalysisResult) Reset 

func (x *AnalysisResult) Reset()

func (*AnalysisResult) String 

func (x *AnalysisResult) String() string

type AnalysisResult_Status 

type AnalysisResult_Status struct {
	Code AnalysisResult_Status_Code `protobuf:"varint,1,opt,name=code,proto3,enum=ide_query.AnalysisResult_Status_Code" json:"code,omitempty"`
	// Details about the status, might be displayed to user.
	StatusMessage *string `protobuf:"bytes,2,opt,name=status_message,json=statusMessage,proto3,oneof" json:"status_message,omitempty"`
	// contains filtered or unexported fields
}

Indicates the success/failure for the query.

func (*AnalysisResult_Status) Descriptor deprecated 

func (*AnalysisResult_Status) Descriptor() ([]byte, []int)

Deprecated: Use AnalysisResult_Status.ProtoReflect.Descriptor instead.

func (*AnalysisResult_Status) GetCode 

func (x *AnalysisResult_Status) GetCode() AnalysisResult_Status_Code

func (*AnalysisResult_Status) GetStatusMessage 

func (x *AnalysisResult_Status) GetStatusMessage() string

func (*AnalysisResult_Status) ProtoMessage 

func (*AnalysisResult_Status) ProtoMessage()

func (*AnalysisResult_Status) ProtoReflect 

func (x *AnalysisResult_Status) ProtoReflect() protoreflect.Message

func (*AnalysisResult_Status) Reset 

func (x *AnalysisResult_Status) Reset()

func (*AnalysisResult_Status) String 

func (x *AnalysisResult_Status) String() string

type AnalysisResult_Status_Code 

type AnalysisResult_Status_Code int32
const (
	AnalysisResult_Status_CODE_UNSPECIFIED  AnalysisResult_Status_Code = 0
	AnalysisResult_Status_CODE_OK           AnalysisResult_Status_Code = 1
	AnalysisResult_Status_CODE_NOT_FOUND    AnalysisResult_Status_Code = 2 // no target or module found for the source file.
	AnalysisResult_Status_CODE_BUILD_FAILED AnalysisResult_Status_Code = 3
)

func (AnalysisResult_Status_Code) Descriptor 

func (AnalysisResult_Status_Code) Descriptor() protoreflect.EnumDescriptor

func (AnalysisResult_Status_Code) Enum 

func (x AnalysisResult_Status_Code) Enum() *AnalysisResult_Status_Code

func (AnalysisResult_Status_Code) EnumDescriptor deprecated 

func (AnalysisResult_Status_Code) EnumDescriptor() ([]byte, []int)

Deprecated: Use AnalysisResult_Status_Code.Descriptor instead.

func (AnalysisResult_Status_Code) Number 

func (x AnalysisResult_Status_Code) Number() protoreflect.EnumNumber

func (AnalysisResult_Status_Code) String 

func (x AnalysisResult_Status_Code) String() string

func (AnalysisResult_Status_Code) Type 

func (AnalysisResult_Status_Code) Type() protoreflect.EnumType

type BuildableUnit 

type BuildableUnit struct {

	// Unique identifier of the buildable unit.
	//
	// Examples:
	//   - Java: module or target name, e.g. "framework-bluetooth" or
	//   "//third_party/hamcrest:hamcrest_java"
	//   - C++: source file, e.g. "path/to/file.cc"
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Language of the unit.
	// Required for buildable units directly referenced by the AnalysisResult,
	// e.g. the unit associated with the compilation stage for the source file.
	Language Language `protobuf:"varint,2,opt,name=language,proto3,enum=ide_query.Language" json:"language,omitempty"`
	// Source files that are part of this unit.
	// Path to the file relative to working_dir.
	SourceFilePaths []string `protobuf:"bytes,3,rep,name=source_file_paths,json=sourceFilePaths,proto3" json:"source_file_paths,omitempty"`
	// Compiler arguments to compile the source files.
	CompilerArguments []string `protobuf:"bytes,4,rep,name=compiler_arguments,json=compilerArguments,proto3" json:"compiler_arguments,omitempty"`
	// List of generated files produced by this unit.
	GeneratedFiles []*GeneratedFile `protobuf:"bytes,5,rep,name=generated_files,json=generatedFiles,proto3" json:"generated_files,omitempty"`
	// List of other BuildableUnits this unit depend on.
	DependencyIds []string `protobuf:"bytes,6,rep,name=dependency_ids,json=dependencyIds,proto3" json:"dependency_ids,omitempty"`
	// contains filtered or unexported fields
}

func (*BuildableUnit) Descriptor deprecated 

func (*BuildableUnit) Descriptor() ([]byte, []int)

Deprecated: Use BuildableUnit.ProtoReflect.Descriptor instead.

func (*BuildableUnit) GetCompilerArguments 

func (x *BuildableUnit) GetCompilerArguments() []string

func (*BuildableUnit) GetDependencyIds 

func (x *BuildableUnit) GetDependencyIds() []string

func (*BuildableUnit) GetGeneratedFiles 

func (x *BuildableUnit) GetGeneratedFiles() []*GeneratedFile

func (*BuildableUnit) GetId 

func (x *BuildableUnit) GetId() string

func (*BuildableUnit) GetLanguage 

func (x *BuildableUnit) GetLanguage() Language

func (*BuildableUnit) GetSourceFilePaths 

func (x *BuildableUnit) GetSourceFilePaths() []string

func (*BuildableUnit) ProtoMessage 

func (*BuildableUnit) ProtoMessage()

func (*BuildableUnit) ProtoReflect 

func (x *BuildableUnit) ProtoReflect() protoreflect.Message

func (*BuildableUnit) Reset 

func (x *BuildableUnit) Reset()

func (*BuildableUnit) String 

func (x *BuildableUnit) String() string

type GeneratedFile 

type GeneratedFile struct {

	// Path to the file relative to build_out_dir.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// The text of the generated file, if not provided contents will be read
	// from the path above in user's workstation.
	Contents []byte `protobuf:"bytes,2,opt,name=contents,proto3,oneof" json:"contents,omitempty"`
	// contains filtered or unexported fields
}

func (*GeneratedFile) Descriptor deprecated 

func (*GeneratedFile) Descriptor() ([]byte, []int)

Deprecated: Use GeneratedFile.ProtoReflect.Descriptor instead.

func (*GeneratedFile) GetContents 

func (x *GeneratedFile) GetContents() []byte

func (*GeneratedFile) GetPath 

func (x *GeneratedFile) GetPath() string

func (*GeneratedFile) ProtoMessage 

func (*GeneratedFile) ProtoMessage()

func (*GeneratedFile) ProtoReflect 

func (x *GeneratedFile) ProtoReflect() protoreflect.Message

func (*GeneratedFile) Reset 

func (x *GeneratedFile) Reset()

func (*GeneratedFile) String 

func (x *GeneratedFile) String() string

type IdeAnalysis 

type IdeAnalysis struct {

	// Directory that contains build outputs generated by the build system.
	// Relative to repository root.
	BuildOutDir string `protobuf:"bytes,1,opt,name=build_out_dir,json=buildOutDir,proto3" json:"build_out_dir,omitempty"`
	// Working directory used by the build system.
	// Relative to repository root.
	WorkingDir string `protobuf:"bytes,4,opt,name=working_dir,json=workingDir,proto3" json:"working_dir,omitempty"`
	// Only set if the whole query failed.
	Error *AnalysisError `protobuf:"bytes,5,opt,name=error,proto3,oneof" json:"error,omitempty"`
	// List of results, one per queried file.
	Results []*AnalysisResult `protobuf:"bytes,6,rep,name=results,proto3" json:"results,omitempty"`
	// List of buildable units directly or indirectly references by the results.
	Units []*BuildableUnit `protobuf:"bytes,7,rep,name=units,proto3" json:"units,omitempty"`
	// Deprecated: Do not use.
	Sources []*SourceFile `protobuf:"bytes,2,rep,name=sources,proto3" json:"sources,omitempty"`
	// Status representing overall analysis.
	// Should fail only when no analysis can be performed.
	//
	// Deprecated: Do not use.
	Status *Status `protobuf:"bytes,3,opt,name=status,proto3,oneof" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*IdeAnalysis) Descriptor deprecated 

func (*IdeAnalysis) Descriptor() ([]byte, []int)

Deprecated: Use IdeAnalysis.ProtoReflect.Descriptor instead.

func (*IdeAnalysis) GetBuildOutDir 

func (x *IdeAnalysis) GetBuildOutDir() string

func (*IdeAnalysis) GetError 

func (x *IdeAnalysis) GetError() *AnalysisError

func (*IdeAnalysis) GetResults 

func (x *IdeAnalysis) GetResults() []*AnalysisResult

func (*IdeAnalysis) GetSources deprecated 

func (x *IdeAnalysis) GetSources() []*SourceFile

Deprecated: Do not use.

func (*IdeAnalysis) GetStatus deprecated 

func (x *IdeAnalysis) GetStatus() *Status

Deprecated: Do not use.

func (*IdeAnalysis) GetUnits 

func (x *IdeAnalysis) GetUnits() []*BuildableUnit

func (*IdeAnalysis) GetWorkingDir 

func (x *IdeAnalysis) GetWorkingDir() string

func (*IdeAnalysis) ProtoMessage 

func (*IdeAnalysis) ProtoMessage()

func (*IdeAnalysis) ProtoReflect 

func (x *IdeAnalysis) ProtoReflect() protoreflect.Message

func (*IdeAnalysis) Reset 

func (x *IdeAnalysis) Reset()

func (*IdeAnalysis) String 

func (x *IdeAnalysis) String() string

type Invalidation 

type Invalidation struct {

	// If any of these files change the result may become invalid.
	// Path to the file relative to repository root.
	FilePaths []string `protobuf:"bytes,1,rep,name=file_paths,json=filePaths,proto3" json:"file_paths,omitempty"`
	// If any of these rules match a changed file the result may become invalid.
	Wildcards []*Invalidation_Wildcard `protobuf:"bytes,4,rep,name=wildcards,proto3" json:"wildcards,omitempty"`
	// contains filtered or unexported fields
}

Invalidation rule to check if the result is still valid. This should contain files/dirs that are not directly part of the build graph but still affect the result. For example BUILD files, directory to the toolchain or config files etc.

func (*Invalidation) Descriptor deprecated 

func (*Invalidation) Descriptor() ([]byte, []int)

Deprecated: Use Invalidation.ProtoReflect.Descriptor instead.

func (*Invalidation) GetFilePaths 

func (x *Invalidation) GetFilePaths() []string

func (*Invalidation) GetWildcards 

func (x *Invalidation) GetWildcards() []*Invalidation_Wildcard

func (*Invalidation) ProtoMessage 

func (*Invalidation) ProtoMessage()

func (*Invalidation) ProtoReflect 

func (x *Invalidation) ProtoReflect() protoreflect.Message

func (*Invalidation) Reset 

func (x *Invalidation) Reset()

func (*Invalidation) String 

func (x *Invalidation) String() string

type Invalidation_Wildcard 

type Invalidation_Wildcard struct {

	// Prefix of the file path (e.g. "path/to/")
	Prefix *string `protobuf:"bytes,1,opt,name=prefix,proto3,oneof" json:"prefix,omitempty"`
	// Suffix of the file path (e.g. "Android.bp")
	Suffix *string `protobuf:"bytes,2,opt,name=suffix,proto3,oneof" json:"suffix,omitempty"`
	// If false, the part of the path between the given `prefix` and `suffix`
	// should not contain directory separators ('/').
	CanCrossFolder *bool `protobuf:"varint,3,opt,name=can_cross_folder,json=canCrossFolder,proto3,oneof" json:"can_cross_folder,omitempty"`
	// contains filtered or unexported fields
}

func (*Invalidation_Wildcard) Descriptor deprecated 

func (*Invalidation_Wildcard) Descriptor() ([]byte, []int)

Deprecated: Use Invalidation_Wildcard.ProtoReflect.Descriptor instead.

func (*Invalidation_Wildcard) GetCanCrossFolder 

func (x *Invalidation_Wildcard) GetCanCrossFolder() bool

func (*Invalidation_Wildcard) GetPrefix 

func (x *Invalidation_Wildcard) GetPrefix() string

func (*Invalidation_Wildcard) GetSuffix 

func (x *Invalidation_Wildcard) GetSuffix() string

func (*Invalidation_Wildcard) ProtoMessage 

func (*Invalidation_Wildcard) ProtoMessage()

func (*Invalidation_Wildcard) ProtoReflect 

func (x *Invalidation_Wildcard) ProtoReflect() protoreflect.Message

func (*Invalidation_Wildcard) Reset 

func (x *Invalidation_Wildcard) Reset()

func (*Invalidation_Wildcard) String 

func (x *Invalidation_Wildcard) String() string

type Language 

type Language int32
const (
	Language_LANGUAGE_UNSPECIFIED Language = 0
	Language_LANGUAGE_JAVA        Language = 1 // also includes Kotlin
	Language_LANGUAGE_CPP         Language = 2
)

func (Language) Descriptor 

func (Language) Descriptor() protoreflect.EnumDescriptor

func (Language) Enum 

func (x Language) Enum() *Language

func (Language) EnumDescriptor deprecated 

func (Language) EnumDescriptor() ([]byte, []int)

Deprecated: Use Language.Descriptor instead.

func (Language) Number 

func (x Language) Number() protoreflect.EnumNumber

func (Language) String 

func (x Language) String() string

func (Language) Type 

func (Language) Type() protoreflect.EnumType

type SourceFile deprecated 

type SourceFile struct {

	// Path to the source file relative to repository root.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Working directory used by the build system. All the relative
	// paths in compiler_arguments should be relative to this path.
	// Relative to repository root.
	WorkingDir string `protobuf:"bytes,2,opt,name=working_dir,json=workingDir,proto3" json:"working_dir,omitempty"`
	// Compiler arguments to compile the source file. If multiple variants
	// of the module being compiled are possible, the query script will choose
	// one.
	CompilerArguments []string `protobuf:"bytes,3,rep,name=compiler_arguments,json=compilerArguments,proto3" json:"compiler_arguments,omitempty"`
	// Any generated files that are used in compiling the file.
	Generated []*GeneratedFile `protobuf:"bytes,4,rep,name=generated,proto3" json:"generated,omitempty"`
	// Paths to all of the sources, like build files, code generators,
	// proto files etc. that were used during analysis. Used to figure
	// out when a set of build artifacts are stale and the query tool
	// must be re-run.
	// Relative to repository root.
	Deps []string `protobuf:"bytes,5,rep,name=deps,proto3" json:"deps,omitempty"`
	// Represents analysis status for this particular file. e.g. not part
	// of the build graph.
	Status *Status `protobuf:"bytes,6,opt,name=status,proto3,oneof" json:"status,omitempty"`
	// contains filtered or unexported fields
}

Deprecated: Do not use.

func (*SourceFile) Descriptor deprecated 

func (*SourceFile) Descriptor() ([]byte, []int)

Deprecated: Use SourceFile.ProtoReflect.Descriptor instead.

func (*SourceFile) GetCompilerArguments 

func (x *SourceFile) GetCompilerArguments() []string

func (*SourceFile) GetDeps 

func (x *SourceFile) GetDeps() []string

func (*SourceFile) GetGenerated 

func (x *SourceFile) GetGenerated() []*GeneratedFile

func (*SourceFile) GetPath 

func (x *SourceFile) GetPath() string

func (*SourceFile) GetStatus 

func (x *SourceFile) GetStatus() *Status

func (*SourceFile) GetWorkingDir 

func (x *SourceFile) GetWorkingDir() string

func (*SourceFile) ProtoMessage 

func (*SourceFile) ProtoMessage()

func (*SourceFile) ProtoReflect 

func (x *SourceFile) ProtoReflect() protoreflect.Message

func (*SourceFile) Reset 

func (x *SourceFile) Reset()

func (*SourceFile) String 

func (x *SourceFile) String() string

type Status deprecated 

type Status struct {
	Code Status_Code `protobuf:"varint,1,opt,name=code,proto3,enum=ide_query.Status_Code" json:"code,omitempty"`
	// Details about the status, might be displayed to user.
	Message *string `protobuf:"bytes,2,opt,name=message,proto3,oneof" json:"message,omitempty"`
	// contains filtered or unexported fields
}

Indicates the success/failure for analysis.

Deprecated: Do not use.

func (*Status) Descriptor deprecated 

func (*Status) Descriptor() ([]byte, []int)

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetCode 

func (x *Status) GetCode() Status_Code

func (*Status) GetMessage 

func (x *Status) GetMessage() string

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) ProtoReflect 

func (x *Status) ProtoReflect() protoreflect.Message

func (*Status) Reset 

func (x *Status) Reset()

func (*Status) String 

func (x *Status) String() string

type Status_Code 

type Status_Code int32
const (
	Status_OK      Status_Code = 0
	Status_FAILURE Status_Code = 1
)

func (Status_Code) Descriptor 

func (Status_Code) Descriptor() protoreflect.EnumDescriptor

func (Status_Code) Enum 

func (x Status_Code) Enum() *Status_Code

func (Status_Code) EnumDescriptor deprecated 

func (Status_Code) EnumDescriptor() ([]byte, []int)

Deprecated: Use Status_Code.Descriptor instead.

func (Status_Code) Number 

func (x Status_Code) Number() protoreflect.EnumNumber

func (Status_Code) String 

func (x Status_Code) String() string

func (Status_Code) Type 

func (Status_Code) Type() protoreflect.EnumType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.