visitor

Documentation

Index

• func RunVisitor(visitor HasExtendedVisitor, proto *parser.Proto, ruleID string) ([]report.Failure, error)
• func RunVisitorAutoDisable(visitor HasExtendedVisitor, proto *parser.Proto, ruleID string, ...) ([]report.Failure, error)
• type BaseAddVisitor
  • func NewBaseAddVisitor(ruleID string, severity string) *BaseAddVisitor
  • func (v *BaseAddVisitor) AddFailuref(pos meta.Position, format string, a ...interface{})
  • func (v *BaseAddVisitor) AddFailurefWithProtoMeta(p *parser.ProtoMeta, format string, a ...interface{})
  • func (v *BaseAddVisitor) Failures() []report.Failure
• type BaseFixableVisitor
  • func NewBaseFixableVisitor(ruleID string, fixMode bool, proto *parser.Proto, severity string) (*BaseFixableVisitor, error)
  • func (v *BaseFixableVisitor) Finally() error
• type BaseVisitor
  • func (BaseVisitor) Finally() error
  • func (BaseVisitor) OnStart(*parser.Proto) error
  • func (BaseVisitor) VisitComment(*parser.Comment)
  • func (BaseVisitor) VisitEdition(*parser.Edition) (next bool)
  • func (BaseVisitor) VisitEmptyStatement(*parser.EmptyStatement) (next bool)
  • func (BaseVisitor) VisitEnum(*parser.Enum) (next bool)
  • func (BaseVisitor) VisitEnumField(*parser.EnumField) (next bool)
  • func (BaseVisitor) VisitExtend(*parser.Extend) (next bool)
  • func (BaseVisitor) VisitExtensions(*parser.Extensions) bool
  • func (BaseVisitor) VisitField(*parser.Field) (next bool)
  • func (BaseVisitor) VisitGroupField(*parser.GroupField) bool
  • func (BaseVisitor) VisitImport(*parser.Import) (next bool)
  • func (BaseVisitor) VisitMapField(*parser.MapField) (next bool)
  • func (BaseVisitor) VisitMessage(*parser.Message) (next bool)
  • func (BaseVisitor) VisitOneof(*parser.Oneof) (next bool)
  • func (BaseVisitor) VisitOneofField(*parser.OneofField) (next bool)
  • func (BaseVisitor) VisitOption(*parser.Option) (next bool)
  • func (BaseVisitor) VisitPackage(*parser.Package) (next bool)
  • func (BaseVisitor) VisitRPC(*parser.RPC) (next bool)
  • func (BaseVisitor) VisitReserved(*parser.Reserved) (next bool)
  • func (BaseVisitor) VisitService(*parser.Service) (next bool)
  • func (BaseVisitor) VisitSyntax(*parser.Syntax) (next bool)
• type HasExtendedVisitor

Functions

func RunVisitor

func RunVisitor(
	visitor HasExtendedVisitor,
	proto *parser.Proto,
	ruleID string,
) ([]report.Failure, error)

RunVisitor dispatches the call to the visitor.

func RunVisitorAutoDisable

func RunVisitorAutoDisable(
	visitor HasExtendedVisitor,
	proto *parser.Proto,
	ruleID string,
	autodisableType autodisable.PlacementType,
) ([]report.Failure, error)

RunVisitorAutoDisable dispatches the call to the visitor.

Types

type BaseAddVisitor

type BaseAddVisitor struct {
	BaseVisitor
	// contains filtered or unexported fields
}

BaseAddVisitor represents a base visitor which can accumulate failures.

func NewBaseAddVisitor

func NewBaseAddVisitor(ruleID string, severity string) *BaseAddVisitor

NewBaseAddVisitor creates a BaseAddVisitor.

func (*BaseAddVisitor) AddFailuref

func (v *BaseAddVisitor) AddFailuref(
	pos meta.Position,
	format string,
	a ...interface{},
)

AddFailuref adds to the internal buffer and the formatting works like fmt.Sprintf.

func (*BaseAddVisitor) AddFailurefWithProtoMeta

func (v *BaseAddVisitor) AddFailurefWithProtoMeta(
	p *parser.ProtoMeta,
	format string,
	a ...interface{},
)

AddFailurefWithProtoMeta adds to the internal buffer and the formatting works like fmt.Sprintf.

func (*BaseAddVisitor) Failures

func (v *BaseAddVisitor) Failures() []report.Failure

Failures returns the accumulated failures.

type BaseFixableVisitor

type BaseFixableVisitor struct {
	*BaseAddVisitor

	Fixer fixer.Fixer
	// contains filtered or unexported fields
}

BaseFixableVisitor represents a base visitor which can fix failures.

func NewBaseFixableVisitor

func NewBaseFixableVisitor(
	ruleID string,
	fixMode bool,
	proto *parser.Proto,
	severity string,
) (*BaseFixableVisitor, error)

NewBaseFixableVisitor creates a BaseFixableVisitor.

func (*BaseFixableVisitor) Finally

func (v *BaseFixableVisitor) Finally() error

Finally fixes the proto file by overwriting it.

type BaseVisitor

type BaseVisitor struct{}

BaseVisitor represents a base visitor with noop logic.

func (BaseVisitor) Finally

func (BaseVisitor) Finally() error

Finally works noop.

func (BaseVisitor) OnStart

func (BaseVisitor) OnStart(*parser.Proto) error

OnStart works noop.

func (BaseVisitor) VisitComment

func (BaseVisitor) VisitComment(*parser.Comment)

VisitComment works noop.

func (BaseVisitor) VisitEdition

func (BaseVisitor) VisitEdition(*parser.Edition) (next bool)

VisitEdition works noop.

func (BaseVisitor) VisitEmptyStatement

func (BaseVisitor) VisitEmptyStatement(*parser.EmptyStatement) (next bool)

VisitEmptyStatement works noop.

func (BaseVisitor) VisitEnum

func (BaseVisitor) VisitEnum(*parser.Enum) (next bool)

VisitEnum works noop.

func (BaseVisitor) VisitEnumField

func (BaseVisitor) VisitEnumField(*parser.EnumField) (next bool)

VisitEnumField works noop.

func (BaseVisitor) VisitExtend

func (BaseVisitor) VisitExtend(*parser.Extend) (next bool)

VisitExtend works noop.

func (BaseVisitor) VisitExtensions

func (BaseVisitor) VisitExtensions(*parser.Extensions) bool

VisitExtensions works noop.

func (BaseVisitor) VisitField

func (BaseVisitor) VisitField(*parser.Field) (next bool)

VisitField works noop.

func (BaseVisitor) VisitGroupField

func (BaseVisitor) VisitGroupField(*parser.GroupField) bool

VisitGroupField works noop.

func (BaseVisitor) VisitImport

func (BaseVisitor) VisitImport(*parser.Import) (next bool)

VisitImport works noop.

func (BaseVisitor) VisitMapField

func (BaseVisitor) VisitMapField(*parser.MapField) (next bool)

VisitMapField works noop.

func (BaseVisitor) VisitMessage

func (BaseVisitor) VisitMessage(*parser.Message) (next bool)

VisitMessage works noop.

func (BaseVisitor) VisitOneof

func (BaseVisitor) VisitOneof(*parser.Oneof) (next bool)

VisitOneof works noop.

func (BaseVisitor) VisitOneofField

func (BaseVisitor) VisitOneofField(*parser.OneofField) (next bool)

VisitOneofField works noop.

func (BaseVisitor) VisitOption

func (BaseVisitor) VisitOption(*parser.Option) (next bool)

VisitOption works noop.

func (BaseVisitor) VisitPackage

func (BaseVisitor) VisitPackage(*parser.Package) (next bool)

VisitPackage works noop.

func (BaseVisitor) VisitRPC

func (BaseVisitor) VisitRPC(*parser.RPC) (next bool)

VisitRPC works noop.

func (BaseVisitor) VisitReserved

func (BaseVisitor) VisitReserved(*parser.Reserved) (next bool)

VisitReserved works noop.

func (BaseVisitor) VisitService

func (BaseVisitor) VisitService(*parser.Service) (next bool)

VisitService works noop.

func (BaseVisitor) VisitSyntax

func (BaseVisitor) VisitSyntax(*parser.Syntax) (next bool)

VisitSyntax works noop.

type HasExtendedVisitor

type HasExtendedVisitor interface {
	parser.Visitor

	// OnStart is called when visiting is started.
	OnStart(*parser.Proto) error
	// Finally is called when visiting is done.
	Finally() error
	// Failures returns the accumulated failures.
	Failures() []report.Failure
}

HasExtendedVisitor is a required interface given to RunVisitor.