ast.go

package phpdoc

import "mibk.dev/phpdoc/phptype"

// A Block represents a PHPDoc comment block.
type Block struct {
	Lines         []Line
	Indent        string // … each line
	PreferOneline bool
}

// A Line represents a line in a PHPDoc comment.
type Line interface{ aLine() }

type line struct{}

func (*line) aLine() {}

// A TextLine represents a regular, text-only line in a PHPDoc comment.
type TextLine struct {
	line
	Value string
}

// A Tag represents a tag line in a PHPDoc comment (e.g. @author).
type Tag interface {
	Line
	aTag()
	desc() string
}

type tag struct{ line }

func (*tag) aTag() {}

// A ParamTag represents a @param tag.
type ParamTag struct {
	tag
	Param *phptype.Param
	Desc  string
}

// A ReturnTag represents a @return tag.
type ReturnTag struct {
	tag
	Type phptype.Type
	Desc string
}

// A PropertyTag represents a @property tag, as well as its variants
// @property-read and @property-write.
type PropertyTag struct {
	tag
	ReadOnly, WriteOnly bool
	Type                phptype.Type
	Var                 string
	Desc                string
}

// A MethodTag represents a @method tag.
type MethodTag struct {
	tag
	Static bool
	Result phptype.Type // or nil
	Name   string
	Params []*phptype.Param
	Desc   string
}

// A VarTag represents a @var tag.
type VarTag struct {
	tag
	Type phptype.Type
	Var  string
	Desc string
}

// A ThrowsTag represents a @throws tag.
type ThrowsTag struct {
	tag
	Class phptype.Type
	Desc  string
}

// An ExtendsTag represents an @extends tag.
type ExtendsTag struct {
	tag
	Class phptype.Type
	Desc  string
}

// An ImplementsTag represents an @implements tag.
type ImplementsTag struct {
	tag
	Interface phptype.Type
	Desc      string
}

// A UsesTag represents a @uses tag.
type UsesTag struct {
	tag
	Trait phptype.Type
	Desc  string
}

// A TemplateTag represents a @template tag.
type TemplateTag struct {
	tag
	Param string
	Bound phptype.Type // or nil
	Desc  string
}

// A TemplateTag represents a @phpstan-type tag.
type TypeDefTag struct {
	tag
	Name string
	Type phptype.Type
	Desc string
}

// A OtherTag represents an arbitrary tag without a special meaning.
type OtherTag struct {
	tag
	Name string
	Desc string
}

func (t *ParamTag) desc() string      { return t.Desc }
func (t *ReturnTag) desc() string     { return t.Desc }
func (t *PropertyTag) desc() string   { return t.Desc }
func (t *MethodTag) desc() string     { return t.Desc }
func (t *VarTag) desc() string        { return t.Desc }
func (t *ThrowsTag) desc() string     { return t.Desc }
func (t *ExtendsTag) desc() string    { return t.Desc }
func (t *ImplementsTag) desc() string { return t.Desc }
func (t *UsesTag) desc() string       { return t.Desc }
func (t *TemplateTag) desc() string   { return t.Desc }
func (t *TypeDefTag) desc() string    { return t.Desc }
func (t *OtherTag) desc() string      { return t.Desc }