dynamic

README

XGo/Dynamic

this package provides some dynamic features using reflect and go/ast.

Features

Function Headers

Examples: https://gowalker.org/github.com/Kretech/xgo/dynamic#_ex_btn_GetFuncHeader

Variable Names

https://gowalker.org/github.com/Kretech/xgo/p#VarName

Compact function from Php

https://gowalker.org/github.com/Kretech/xgo/p#Compact

Variable scopes in goroutine

https://gowalker.org/github.com/Kretech/xgo/p#G

Documentation

Index

• func CallerName(short bool) string
• func CallerNameSkip(skip int, short bool) string
• func VarName(args ...interface{}) []string
• func VarNameDepth(skip int, args ...interface{}) []string
• type FuncHeader
  • func GetFuncHeader(originFunc interface{}) (fh FuncHeader, err error)
  • func GetFuncHeaderNoCache(originFunc interface{}) (fh FuncHeader, err error)
  • func (fh *FuncHeader) Encode() string
  • func (fh *FuncHeader) Equals(other *FuncHeader) bool
• type Name
  • func NameOf(x string) Name
  • func (name Name) Compact(args ...interface{}) (paramNames []string, paramAndValues map[string]interface{})
  • func (name Name) DepthCompact(depth int, args ...interface{}) (paramNames []string, paramAndValues map[string]interface{})
  • func (n Name) VarName(args ...interface{}) []string
  • func (n Name) VarNameDepth(skip int, args ...interface{}) (names []string)
• type Parameter

Examples

• GetFuncHeader

Functions

func CallerName

func CallerName(short bool) string

func CallerNameSkip

func CallerNameSkip(skip int, short bool) string

func VarName

func VarName(args ...interface{}) []string

func VarNameDepth

func VarNameDepth(skip int, args ...interface{}) []string

Types

type FuncHeader

type FuncHeader struct {
	Doc  string // docs above func
	Name string
	In   []*Parameter
	Out  []*Parameter
}

FuncHeader contains function info

func GetFuncHeader

func GetFuncHeader(originFunc interface{}) (fh FuncHeader, err error)

GetFuncHeader return function header cached in funcPC @fixme according the comment of reflect/Value.Pointer pc is not unique for simple function

Example

// // Person ...
// type Person struct{}
//
// // comment
// func (this Person) Name() string {
// 	return `noname`
// }
//
// // Say can say something
// func (this Person) Say(c string) string {
// 	return this.Name() + ` : ` + c
// }

h, _ := GetFuncHeader(Person{}.Say)
log.Println(h.Name)
//: Say-fm

log.Println(h.Doc)
//: // Say can say something

for _, param := range append(h.In, h.Out...) {
	log.Println(param.Name, param.RType)
	//: c string
	//:  string
}

func GetFuncHeaderNoCache

func GetFuncHeaderNoCache(originFunc interface{}) (fh FuncHeader, err error)

GetFuncHeaderNoCache return function header in runtime without cache

func (*FuncHeader) Encode

func (fh *FuncHeader) Encode() string

Encode is convenient for json marshal

func (*FuncHeader) Equals

func (fh *FuncHeader) Equals(other *FuncHeader) bool

Equals return two header is equivalent for testing

type Name

type Name struct {

	// X.Y means how user call this function
	// if user called dynamic.VarName(a), X=dynamic Y=VarName
	// if user called dump.Dump(a) X=dump Y=Dump
	// set this variant used to avoid to scanner import alias
	X string
	Y string
}

func NameOf

func NameOf(x string) Name

func (Name) Compact

func (name Name) Compact(args ...interface{}) (paramNames []string, paramAndValues map[string]interface{})

func (Name) DepthCompact

func (name Name) DepthCompact(depth int, args ...interface{}) (paramNames []string, paramAndValues map[string]interface{})

func (Name) VarName

func (n Name) VarName(args ...interface{}) []string

VarName return the variable names VarName(a, b) => []string{"a", "b"}

func (Name) VarNameDepth

func (n Name) VarNameDepth(skip int, args ...interface{}) (names []string)

VarNameDepth return the variable names of args... args is a stub for call this method

how can we do this ? first, get function info by runtime.Caller second, get astFile with ast/parser last, match function parameters in ast and get the code

type Parameter

type Parameter struct {
	Name  string
	RType reflect.Type
}

Parameter contains input and output info of function