Documentation
¶
Overview ¶
Package analysisutil contains utility functions for the analyses in argot. These functions are in an internal package because they are not important enough to be included in the main library.
Index ¶
- func FieldAddrFieldInfo(fieldAddr *ssa.FieldAddr) (string, bool)
- func FieldFieldInfo(fieldAddr *ssa.Field) (string, bool)
- func FindEltTypePackage(t types.Type, preform string) (string, string, error)
- func FindSafeCalleePkg(n *ssa.CallCommon) fn.Optional[string]
- func FindValuePackage(n ssa.Value) fn.Optional[string]
- func GetFieldInfoFromType(t types.Type, i int) (string, bool)
- func IsEntrypointNode(pointer *pointer.Result, n ssa.Node, f func(config.CodeIdentifier) bool) bool
- func IsExcluded(program *ssa.Program, f *ssa.Function, exclude []string) bool
- func MakeAbsolute(excludeRelative []string) []string
- func ReceiverStr(t types.Type) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FieldAddrFieldInfo ¶
FieldAddrFieldInfo finds the name of a field access in ssa.FieldAddr if it cannot find a proper field name, returns "?". The boolean indicates whether this field is embedded or not.
func FieldFieldInfo ¶
FieldFieldInfo finds the name of a field access in ssa.Field if it cannot find a proper field name, returns "?". The boolean indicates whether this field is embedded or not.
func FindEltTypePackage ¶
FindEltTypePackage finds the package declaring the elements of t or returns an error Returns a package name and the name of the type declared in that package. preform is the formatting of the type of the element; usually %s
func FindSafeCalleePkg ¶
func FindSafeCalleePkg(n *ssa.CallCommon) fn.Optional[string]
FindSafeCalleePkg finds the packages of the callee in the ssa.CallCommon without panicking
func FindValuePackage ¶
FindValuePackage finds the package of n. Returns None if no package was found.
func GetFieldInfoFromType ¶
GetFieldInfoFromType returns the name of field i if t is a struct or pointer to a struct. The boolean indicates whether this field is embedded or not.
func IsEntrypointNode ¶
IsEntrypointNode returns true if n is an entrypoint to the analysis according to f.
func IsExcluded ¶
IsExcluded scans the exclude slices to find out whether f is excluded
func MakeAbsolute ¶
MakeAbsolute takes a slice of relative file paths and converts them to absolute paths. It prepends the current working directory to any non-absolute file paths.
excludeRelative is a slice of relative or absolute file paths to convert.
It returns a new slice containing the absolute paths. Any paths that were already absolute are passed through unchanged.
It returns an error if it cannot determine the current working directory. The result slice may have a different capacity and length than the input.
func ReceiverStr ¶
ReceiverStr returns the string receiver name of t. e.g. *repo/package.Method -> Method TODO refactor to avoid string operations
Types ¶
This section is empty.
Source Files