Documentation
¶
Index ¶
- Constants
- Variables
- func AddImport(root *dst.File, path string)
- func AddImportForcely(root *dst.File, path string)
- func AddStructField(decl dst.Decl, name string, typ string)
- func AddressOf(expr dst.Expr) *dst.UnaryExpr
- func ArrayType(elem dst.Expr) *dst.ArrayType
- func AssignStmt(lhs, rhs dst.Expr) *dst.AssignStmt
- func Block(stmt dst.Stmt) *dst.BlockStmt
- func BlockStmts(stmts ...dst.Stmt) *dst.BlockStmt
- func BoolFalse() *dst.BasicLit
- func BoolTrue() *dst.BasicLit
- func CallTo(name string, args []dst.Expr) *dst.CallExpr
- func DeferStmt(call *dst.CallExpr) *dst.DeferStmt
- func DefineStmts(lhs, rhs []dst.Expr) *dst.AssignStmt
- func DereferenceOf(expr dst.Expr) dst.Expr
- func EmptyStmt() *dst.EmptyStmt
- func ExprStmt(expr dst.Expr) *dst.ExprStmt
- func Exprs(exprs ...dst.Expr) []dst.Expr
- func ExtractVersion(path string) string
- func FindFuncDecl(root *dst.File, name string) *dst.FuncDecl
- func GetGoModDir() (string, error)
- func GetGoModPath() (string, error)
- func GetInstrumentLogPath(name string) string
- func GetLogPath(name string) string
- func GetPreprocessLogPath(name string) string
- func GetProjRootDir() (string, error)
- func GetTempBuildDir() string
- func GetVarNameOfFunc(fn string) string
- func GuaranteeInInstrument()
- func GuaranteeInPreprocess()
- func HasGoBuildComment(text string) bool
- func HasReceiver(fn *dst.FuncDecl) bool
- func HashStruct(st interface{}) (uint64, error)
- func Ident(name string) *dst.Ident
- func IfNotNilStmt(cond dst.Expr, body, elseBody *dst.BlockStmt) *dst.IfStmt
- func IfStmt(init dst.Stmt, cond dst.Expr, body, elseBody *dst.BlockStmt) *dst.IfStmt
- func InInstrument() bool
- func InPreprocess() bool
- func IndexExpr(x dst.Expr, index dst.Expr) *dst.IndexExpr
- func InitConfig() (err error)
- func IntLit(value int) *dst.BasicLit
- func InterfaceType() *dst.InterfaceType
- func IsCompileCommand(line string) bool
- func IsEllipsis(typ dst.Expr) bool
- func IsExistGoMod() (bool, error)
- func IsGoFile(path string) bool
- func IsGoModFile(path string) bool
- func IsGoSumFile(path string) bool
- func IsGoTestFile(path string) bool
- func IsInterfaceType(typ dst.Expr) bool
- func IsModPath(path string) bool
- func IsStringLit(expr dst.Expr, val string) bool
- func IsUnusedIdent(ident *dst.Ident) bool
- func MakePublic(name string) string
- func MakeUnusedIdent(ident *dst.Ident) *dst.Ident
- func MatchFuncDecl(decl dst.Decl, function string, receiverType string) bool
- func MatchStructDecl(decl dst.Decl, structType string) bool
- func MatchVersion(version string, ruleVersion string) (bool, error)
- func NewField(name string, typ dst.Expr) *dst.Field
- func NewVarDecl(name string, paramTypes *dst.FieldList) *dst.GenDecl
- func ParenExpr(x dst.Expr) *dst.ParenExpr
- func ParseAstFromFile(filePath string) (*dst.File, error)
- func ParseAstFromFileFast(filePath string) (*dst.File, error)
- func ParseAstFromFileOnlyPackage(filePath string) (*dst.File, error)
- func ParseAstFromSnippet(codeSnippnet string) ([]dst.Stmt, error)
- func ParseAstFromSource(source string) (*dst.File, error)
- func RemoveGoBuildComment(text string) string
- func RemoveImport(root *dst.File, path string) *dst.ImportSpec
- func RenamePackage(source, newPkgName string) string
- func ReturnStmt(results []dst.Expr) *dst.ReturnStmt
- func SelectorExpr(x dst.Expr, sel string) *dst.SelectorExpr
- func SplitCmds(input string) []string
- func Stmts(stmts ...dst.Stmt) []dst.Stmt
- func StringLit(value string) *dst.BasicLit
- func SwitchCase(list []dst.Expr, stmts []dst.Stmt) *dst.CaseClause
- func TypeAssertExpr(x dst.Expr, typ dst.Expr) *dst.TypeAssertExpr
- func WriteAstToFile(astRoot *dst.File, filePath string) (string, error)
- type BuildConfig
Constants ¶
const ( IdentNil = "nil" IdentTrue = "true" IdentFalse = "false" IdentIgnore = "_" )
const ( TempBuildDir = ".otel-build" VendorDir = "vendor" BuildModeVendor = "-mod=vendor" BuildModeMod = "-mod=mod" BuildConfFile = "build_conf.json" )
const ( GoBuildIgnoreComment = "//go:build ignore" GoModFile = "go.mod" GoSumFile = "go.sum" GoWorkSumFile = "go.work.sum" DebugLogFile = "debug.log" TInstrument = "instrument" TPreprocess = "preprocess" )
Variables ¶
var TheName = "otelbuild"
var TheVersion = "1.0.0"
This is the version of the tool, which will be printed when the -version flag is passed. This value is specified by the build system.
Functions ¶
func AddImportForcely ¶
func AssignStmt ¶
func AssignStmt(lhs, rhs dst.Expr) *dst.AssignStmt
func DefineStmts ¶
func DefineStmts(lhs, rhs []dst.Expr) *dst.AssignStmt
func ExtractVersion ¶
func GetGoModDir ¶
GetGoModDir returns the directory of go.mod file.
func GetGoModPath ¶
GetGoModPath returns the absolute path of go.mod file, if any.
func GetInstrumentLogPath ¶
func GetLogPath ¶
func GetPreprocessLogPath ¶
func GetProjRootDir ¶
GetProjRootDir returns the root directory of the project. It's an alias of GetGoModDir in the current implementation.
func GetTempBuildDir ¶
func GetTempBuildDir() string
func GetVarNameOfFunc ¶
func GuaranteeInInstrument ¶
func GuaranteeInInstrument()
func GuaranteeInPreprocess ¶
func GuaranteeInPreprocess()
func HasGoBuildComment ¶
func HasReceiver ¶
func HashStruct ¶
func InInstrument ¶
func InInstrument() bool
func InPreprocess ¶
func InPreprocess() bool
func InitConfig ¶
func InitConfig() (err error)
func InterfaceType ¶
func InterfaceType() *dst.InterfaceType
func IsCompileCommand ¶
func IsEllipsis ¶
func IsExistGoMod ¶
func IsGoModFile ¶
func IsGoSumFile ¶
func IsGoTestFile ¶
func IsInterfaceType ¶
func IsUnusedIdent ¶
func MakePublic ¶
func MatchVersion ¶
MatchVersion checks if the version string matches the version range in the rule. The version range is in format [start, end), where start is inclusive and end is exclusive. If the rule version string is empty, it always matches.
func ParseAstFromFile ¶
ParseAstFromFile parses the AST from complete source file.
func ParseAstFromSnippet ¶
ParseAstFromSnippet parses the AST from incomplete source code snippet.
func ParseAstFromSource ¶
ParseAstFromSource parses the AST from complete source code.
func RemoveGoBuildComment ¶
func RemoveImport ¶
func RemoveImport(root *dst.File, path string) *dst.ImportSpec
func RenamePackage ¶
func ReturnStmt ¶
func ReturnStmt(results []dst.Expr) *dst.ReturnStmt
func SelectorExpr ¶
func SelectorExpr(x dst.Expr, sel string) *dst.SelectorExpr
func SplitCmds ¶
SplitCmds splits the command line by space, but keep the quoted part as a whole. For example, "a b" c will be split into ["a b", "c"].
func SwitchCase ¶
func TypeAssertExpr ¶
Types ¶
type BuildConfig ¶
type BuildConfig struct {
// RuleJsonFiles is the name of the rule file. It is used to tell instrument
// tool where to find the instrument rules. Multiple rules are separated by
// comma. e.g. -rule=rule1.json,rule2.json. By default, new rules are appended
// to default rules, i.e. -rule=rule1.json,rule2.json is exactly equivalent to
// -rule=default.json,rule1.json,rule2.json. But if you do want to replace the
// default rules, you can add a "+" prefix to the rule file name, e.g.
// -rule=+rule1.json,rule2.json. In this case, the default rules will be replaced
// by rule1.json, and then rule2.json will be appended to the rules.
RuleJsonFiles string
// InToolexec true means this tool is being invoked in the go build process.
// This flag **SHOULD NOT** be set manually by users.
InToolexec bool
// DebugLog true means debug log is enabled.
DebugLog bool
// Verbose true means print verbose log.
Verbose bool
// Debug true means debug mode.
Debug bool
// Restore true means restore all instrumentations.
Restore bool
// BuildArgs are the arguments to pass to the go build command.
BuildArgs []string
// PrintVersion true means print version.
PrintVersion bool
// contains filtered or unexported fields
}
func GetConf ¶
func GetConf() *BuildConfig
func (*BuildConfig) IsDisableDefaultRules ¶
func (bc *BuildConfig) IsDisableDefaultRules() bool