gsd

type Corpus struct {
	Path string

	// Packages is all packages cache
	Packages map[string]*Package

	// Tree is packages tree struct
	// - a
	// 	- a-a
	// - b
	//
	Tree Packages

	EnablePrivateIndent bool
	// contains filtered or unexported fields
}

type Field struct {
	*ast.Field
	Type *Type
}

type FieldsPage struct {
	Package *Package
	Fields  []*Field
	Expand  bool
}

type Func struct {

	// doc.Func
	Doc  string
	Name string
	Decl *ast.FuncDecl

	// methods
	// (for functions, these fields have the respective zero value)
	Recv  string // actual   receiver "T" or "*T"
	Orig  string // original receiver "T" or "*T"
	Level int    // embedding level; 0 means not embedded

	Examples []*doc.Example

	// interface type
	Field    *ast.Field
	FuncType *ast.FuncType

	// ast.FuncType fields
	Params  *ast.FieldList // (incoming) parameters; non-nil
	Results *ast.FieldList // (outgoing) results; or nil
}

type LinkWriter func(w io.Writer, offs int, start bool)

type Module struct {
	Path      string       `json:",omitempty"` // module path
	Version   string       `json:",omitempty"` // module version
	Versions  []string     `json:",omitempty"` // available module versions
	Replace   *Module      `json:",omitempty"` // replaced by this module
	Time      *time.Time   `json:",omitempty"` // time version was created
	Update    *Module      `json:",omitempty"` // available update (with -u)
	Main      bool         `json:",omitempty"` // is this the main module?
	Indirect  bool         `json:",omitempty"` // module is only indirectly needed by main module
	Dir       string       `json:",omitempty"` // directory holding local copy of files, if any
	GoMod     string       `json:",omitempty"` // path to go.mod file describing module, if any
	GoVersion string       `json:",omitempty"` // go version used in module
	Error     *ModuleError `json:",omitempty"` // error loading module
}

type ModuleError struct {
	Err string // error text
}

type Package struct {
	Dir           string  // !important: directory containing package sources
	ImportPath    string  // !important: import path of package in dir
	ImportComment string  // path in import comment on package statement
	Name          string  // package name
	Doc           string  // package documentation string
	Module        *Module // info about package's module, if any
	Stale         bool    // would 'go install' do anything for this package?
	StaleReason   string  // why is Stale true?

	// declarations
	Imports   []string               // import paths used by this package
	Filenames []string               // all files
	Notes     map[string][]*doc.Note // nil if no package Notes, or contains Buts, etc...
	Consts    []*doc.Value
	Types     []*Type
	Vars      []*doc.Value
	Funcs     []*Func

	// Examples is a sorted list of examples associated with
	// the package. Examples are extracted from _test.go files provided to NewFromFiles.
	Examples []*doc.Example // nil if no example code

	ParentImportPath string     // parent package ImportPath
	Parent           *Package   `json:"-"` // parent package, important: json must ignore, prevent cycle parsing
	SubPackages      []*Package // subpackages

	Dirname string // directory containing the package
	Err     error  // error or nil

	// package info
	FSet       *token.FileSet       // nil if no package documentation
	DocPackage *doc.Package         // nil if no package documentation
	PAst       map[string]*ast.File // nil if no AST with package exports
	IsMain     bool                 // true for package main
}

type PackagePublic struct {
	Dir           string   `json:",omitempty"` // directory containing package sources
	ImportPath    string   `json:",omitempty"` // import path of package in dir
	ImportComment string   `json:",omitempty"` // path in import comment on package statement
	Name          string   `json:",omitempty"` // package name
	Doc           string   `json:",omitempty"` // package documentation string
	Target        string   `json:",omitempty"` // installed target for this package (may be executable)
	Shlib         string   `json:",omitempty"` // the shared library that contains this package (only set when -linkshared)
	Root          string   `json:",omitempty"` // Go root, Go path dir, or module root dir containing this package
	ConflictDir   string   `json:",omitempty"` // Dir is hidden by this other directory
	ForTest       string   `json:",omitempty"` // package is only for use in named test
	Export        string   `json:",omitempty"` // file containing export data (set by go list -export)
	Module        *Module  `json:",omitempty"` // info about package's module, if any
	Match         []string `json:",omitempty"` // command-line patterns matching this package
	Goroot        bool     `json:",omitempty"` // is this package found in the Go root?
	Standard      bool     `json:",omitempty"` // is this package part of the standard Go library?
	DepOnly       bool     `json:",omitempty"` // package is only as a dependency, not explicitly listed
	BinaryOnly    bool     `json:",omitempty"` // package cannot be recompiled
	Incomplete    bool     `json:",omitempty"` // was there an error loading this package or dependencies?

	// Stale and StaleReason remain here *only* for the list command.
	// They are only initialized in preparation for list execution.
	// The regular build determines staleness on the fly during action execution.
	Stale       bool   `json:",omitempty"` // would 'go install' do anything for this package?
	StaleReason string `json:",omitempty"` // why is Stale true?

	// Dependency information
	Imports   []string          `json:",omitempty"` // import paths used by this package
	ImportMap map[string]string `json:",omitempty"` // map from source import to ImportPath (identity entries omitted)
	Deps      []string          `json:",omitempty"` // all (recursively) imported dependencies

	// Test information
	// If you add to this list you MUST add to p.AllFiles (below) too.
	// Otherwise file name security lists will not apply to any new additions.
	TestGoFiles  []string `json:",omitempty"` // _test.go files in package
	TestImports  []string `json:",omitempty"` // imports from TestGoFiles
	XTestGoFiles []string `json:",omitempty"` // _test.go files outside package
	XTestImports []string `json:",omitempty"` // imports from XTestGoFiles
}

type Packages []*Package

type Page struct {
	Corpus  *Corpus
	Package *Package
	Type    *Type
	Func    *Func

	PageType PageType

	LayoutHTML  *template.Template
	SidebarHTML *template.Template
	PackageHTML *template.Template
	TypeHTML    *template.Template
	FuncHTML    *template.Template
	FieldsHTML  *template.Template
	ExampleHTML *template.Template

	Title string

	// TabWidth optionally specifies the tab width.
	TabWidth int

	ShowPlayground bool
	DeclLinks      bool

	Sidebar []byte // Sidebar content
	Body    []byte // Main content
	// contains filtered or unexported fields
}

type PageType string

type Segment struct {
	// contains filtered or unexported fields
}

type SegmentWriter func(w io.Writer, text []byte, selections int)

type Selection func() Segment

type SpotInfo uint32

type SpotKind uint32

type Type struct {

	// doc.Type
	Doc  string
	Name string
	Decl *ast.GenDecl

	// associated declarations
	Consts []*doc.Value // sorted list of constants of (mostly) this type
	Vars   []*doc.Value // sorted list of variables of (mostly) this type

	Funcs   []*Func // sorted list of functions returning this type
	Methods []*Func // sorted list of methods (including embedded ones) of this type

	// Examples is a sorted list of examples associated with
	// this type. Examples are extracted from _test.go files
	// provided to NewFromFiles.
	Examples []*doc.Example

	Fields *ast.FieldList
}