parser

Documentation

Index

• type Command
• type CommandList
  • func (list CommandList) ExistCommand(name string) bool
  • func (list CommandList) ExistCommandAttr(name string, attr string) bool
• type Field
• type ImportPathMap
  • func (m ImportPathMap) Keys() []string
  • func (m ImportPathMap) MergeKey(om ImportPathMap) ImportPathMap
• type Info
  • func (info *Info) GetImportPathAndTypeName(full string) (string, string, string)
  • func (info Info) GetNotEmptyImportPathMap() ImportPathMap
  • func (info Info) GetTypNameWithPath(pkgImportPath string) string
  • func (info *Info) InitWithTypes(name, pkgPath, doc, comment string, typ types.Type)
• type Option
• type Parser
  • func New(opt ...Option) *Parser
  • func (p *Parser) ParsePkg(pkg string) (Pkg, error)
• type Pkg
• type Struct

Types

type Command

type Command struct {
	Name string // 名称，如：list
	Attr string // 属性，如: column
}

Command 指令

type CommandList

type CommandList []Command

CommandList 列表

func (CommandList) ExistCommand

func (list CommandList) ExistCommand(name string) bool

ExistCommand 存在指令

func (CommandList) ExistCommandAttr

func (list CommandList) ExistCommandAttr(name string, attr string) bool

ExistCommandAttr 存在指令

type Field

type Field struct {
	Info
}

Field 字段

type ImportPathMap

type ImportPathMap map[string][]string

ImportPathMap 路径映射

func (ImportPathMap) Keys

func (m ImportPathMap) Keys() []string

Keys 键

func (ImportPathMap) MergeKey

func (m ImportPathMap) MergeKey(om ImportPathMap) ImportPathMap

MergeKey 合并，如果有重复键，om里的值将会覆盖m的

type Info

type Info struct {
	Name string // 名称，如：Info

	// 可以使用这个字段来断言到具体的类型，如go/types.Struct
	TypesType types.Type // go/types.Type接口

	// 如果是导入的第三方包，会包含包路径，如：github.com/pkg/errors.fundamental
	Type string // 类型，表面类型

	// 如type Status int的底下类型就是int
	UnderType string // 底下类型

	ImportPath      string // 导入路径
	TypName         string // 类型名，如果是结构体则与Name相同，如果是字段，则是字段的类型
	TypNameWithPath string // 带有导入路径的类型名称，如：parser.Info
	CanUseAsMapKey  bool   // 字段类型是否可作为map的键

	Comment string // 注释
	Doc     string // 文档

	Commands CommandList // 指令，如list, list column, list map, list slicemap等中的一个或多个
}

Info 信息

func (*Info) GetImportPathAndTypeName

func (info *Info) GetImportPathAndTypeName(full string) (
	string,
	string,
	string,
)

GetImportPathAndTypeName 获取导入路径和类型名称

func (Info) GetNotEmptyImportPathMap

func (info Info) GetNotEmptyImportPathMap() ImportPathMap

GetNotEmptyImportPathMap 获取非空导入路径映射

func (Info) GetTypNameWithPath

func (info Info) GetTypNameWithPath(pkgImportPath string) string

GetTypNameWithPath 获取带路径类型名称

func (*Info) InitWithTypes

func (info *Info) InitWithTypes(name, pkgPath, doc, comment string, typ types.Type)

InitWithTypes 初始化

type Option

type Option struct{}

Option 选项

type Parser

type Parser struct {
}

Parser 解析器，用于解析源码

func New

func New(opt ...Option) *Parser

New 新建

func (*Parser) ParsePkg

func (p *Parser) ParsePkg(pkg string) (Pkg, error)

ParsePkg 解析包，如：github.com/pkg/errors，返回包信息

type Pkg

type Pkg struct {
	Name       string // 包名
	Dir        string // 包目录
	ImportPath string // 包导入路径
	Structs    []Struct
}

Pkg 包

type Struct

type Struct struct {
	Info
	Fields []Field
}

Struct 结构体