parser

type Comment struct {
	// Raw includes a comment syntax like // and /* */.
	Raw string
	// Meta is the meta information.
	Meta meta.Meta
}

type ConfigOption func(*Parser)

type EmptyStatement struct {
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
}

type Enum struct {
	EnumName string
	// EnumBody can have options and enum fields.
	// The element of this is the union of an option, enumField, reserved, and emptyStatement.
	EnumBody []Visitee

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// InlineCommentBehindLeftCurly is the optional one placed behind a left curly.
	InlineCommentBehindLeftCurly *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type EnumField struct {
	Ident            string
	Number           string
	EnumValueOptions []*EnumValueOption

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type EnumValueOption struct {
	OptionName string
	Constant   string
}

type Extend struct {
	MessageType string
	// ExtendBody can have fields and emptyStatements
	ExtendBody []Visitee

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// InlineCommentBehindLeftCurly is the optional one placed behind a left curly.
	InlineCommentBehindLeftCurly *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type Extensions struct {
	Ranges []*Range

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type Field struct {
	IsRepeated   bool
	IsRequired   bool // proto2 only
	IsOptional   bool // proto2 only
	Type         string
	FieldName    string
	FieldNumber  string
	FieldOptions []*FieldOption

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type FieldOption struct {
	OptionName string
	Constant   string
}

type GroupField struct {
	IsRepeated bool
	IsRequired bool
	IsOptional bool
	// GroupName must begin with capital letter.
	GroupName string
	// MessageBody can have fields, nested enum definitions, nested message definitions,
	// options, oneofs, map fields, extends, reserved, and extensions statements.
	MessageBody []Visitee
	FieldNumber string

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// InlineCommentBehindLeftCurly is the optional one placed behind a left curly.
	InlineCommentBehindLeftCurly *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type HasInlineCommentSetter interface {
	SetInlineComment(comment *Comment)
}

type Import struct {
	Modifier ImportModifier
	Location string

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type ImportModifier uint

type MapField struct {
	KeyType      string
	Type         string
	MapName      string
	FieldNumber  string
	FieldOptions []*FieldOption

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type Message struct {
	MessageName string
	// MessageBody can have fields, nested enum definitions, nested message definitions,
	// options, oneofs, map fields, group fields(proto2 only), extends, reserved, and extensions(proto2 only) statements.
	MessageBody []Visitee

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// InlineCommentBehindLeftCurly is the optional one placed behind a left curly.
	InlineCommentBehindLeftCurly *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type Oneof struct {
	OneofFields []*OneofField
	OneofName   string

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// InlineCommentBehindLeftCurly is the optional one placed behind a left curly.
	InlineCommentBehindLeftCurly *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type OneofField struct {
	Type         string
	FieldName    string
	FieldNumber  string
	FieldOptions []*FieldOption

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type Option struct {
	OptionName string
	Constant   string

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type Package struct {
	Name string

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

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

type Proto struct {
	Syntax *Syntax
	// ProtoBody is a slice of sum type consisted of *Import, *Package, *Option, *Message, *Enum, *Service, *Extend and *EmptyStatement.
	ProtoBody []Visitee
	Meta      *ProtoMeta
}

type ProtoMeta struct {
	// Filename is a name of file, if any.
	Filename string
}

type RPC struct {
	RPCName     string
	RPCRequest  *RPCRequest
	RPCResponse *RPCResponse
	Options     []*Option

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type RPCRequest struct {
	IsStream    bool
	MessageType string

	// Meta is the meta information.
	Meta meta.Meta
}

type RPCResponse struct {
	IsStream    bool
	MessageType string

	// Meta is the meta information.
	Meta meta.Meta
}

type Range struct {
	Begin string
	End   string
}

type Reserved struct {
	Ranges     []*Range
	FieldNames []string

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type Service struct {
	ServiceName string
	// ServiceBody can have options and rpcs.
	ServiceBody []Visitee

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// InlineCommentBehindLeftCurly is the optional one placed behind a left curly.
	InlineCommentBehindLeftCurly *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type Syntax struct {
	ProtobufVersion string

	// Comments are the optional ones placed at the beginning.
	Comments []*Comment
	// InlineComment is the optional one placed at the ending.
	InlineComment *Comment
	// Meta is the meta information.
	Meta meta.Meta
}

type Visitee interface {
	Accept(v Visitor)
}

type Visitor interface {
	VisitComment(*Comment)
	VisitEmptyStatement(*EmptyStatement) (next bool)
	VisitEnum(*Enum) (next bool)
	VisitEnumField(*EnumField) (next bool)
	VisitExtend(*Extend) (next bool)
	VisitExtensions(*Extensions) (next bool)
	VisitField(*Field) (next bool)
	VisitGroupField(*GroupField) (next bool)
	VisitImport(*Import) (next bool)
	VisitMapField(*MapField) (next bool)
	VisitMessage(*Message) (next bool)
	VisitOneof(*Oneof) (next bool)
	VisitOneofField(*OneofField) (next bool)
	VisitOption(*Option) (next bool)
	VisitPackage(*Package) (next bool)
	VisitReserved(*Reserved) (next bool)
	VisitRPC(*RPC) (next bool)
	VisitService(*Service) (next bool)
	VisitSyntax(*Syntax) (next bool)
}