query

Documentation

Index

• func LowerRegexp(r *syntax.Regexp) *syntax.Regexp
• func VisitAtoms(q Q, v func(q Q))
• type And
  • func (q *And) String() string
• type Branch
  • func (q *Branch) String() string
• type Const
  • func (q *Const) String() string
• type Language
  • func (l *Language) String() string
• type Not
  • func (q *Not) String() string
• type Or
  • func (q *Or) String() string
• type Q
  • func ExpandFileContent(q Q) Q
  • func Map(q Q, f func(q Q) Q) Q
  • func NewAnd(qs ...Q) Q
  • func NewOr(qs ...Q) Q
  • func Parse(qStr string) (Q, error)
  • func RegexpToQuery(r *syntax.Regexp, minTextSize int) (query Q, isEquivalent bool)
  • func Simplify(q Q) Q
• type Regexp
  • func (q *Regexp) String() string
• type Repo
  • func (q *Repo) String() string
• type Substring
  • func (q *Substring) String() string
• type SuggestQueryError
  • func (e *SuggestQueryError) Error() string
• type Symbol
  • func (s *Symbol) String() string

Functions

func LowerRegexp

func LowerRegexp(r *syntax.Regexp) *syntax.Regexp

func VisitAtoms

func VisitAtoms(q Q, v func(q Q))

VisitAtoms runs `v` on all atom queries within `q`.

Types

type And

type And struct {
	Children []Q
}

And is matched when all its children are.

func (*And) String

func (q *And) String() string

type Branch

type Branch struct {
	Pattern string
}

Branch limits search to a specific branch.

func (*Branch) String

func (q *Branch) String() string

type Const

type Const struct {
	Value bool
}

func (*Const) String

func (q *Const) String() string

type Language

type Language struct {
	Language string
}

func (*Language) String

func (l *Language) String() string

type Not

type Not struct {
	Child Q
}

Not inverts the meaning of its child.

func (*Not) String

func (q *Not) String() string

type Or

type Or struct {
	Children []Q
}

Or is matched when any of its children is matched.

func (*Or) String

func (q *Or) String() string

type Q

type Q interface {
	String() string
}

Q is a representation for a possibly hierarchical search query.

func ExpandFileContent

func ExpandFileContent(q Q) Q

Expand expands Substr queries into (OR file_substr content_substr) queries, and the same for Regexp queries..

func Map

func Map(q Q, f func(q Q) Q) Q

Map runs f over the q.

func NewAnd

func NewAnd(qs ...Q) Q

NewAnd is syntactic sugar for constructing And queries.

func NewOr

func NewOr(qs ...Q) Q

NewOr is syntactic sugar for constructing Or queries.

func Parse

func Parse(qStr string) (Q, error)

Parse parses a string into a query.

func RegexpToQuery

func RegexpToQuery(r *syntax.Regexp, minTextSize int) (query Q, isEquivalent bool)

RegexpToQuery tries to distill a substring search query that matches a superset of the regexp. If the returned query is equivalent with the original regexp, it returns true. An equivalent query has the same behaviour as the original regexp and can be used instead.

func Simplify

func Simplify(q Q) Q

type Regexp

type Regexp struct {
	Regexp        *syntax.Regexp
	FileName      bool
	Content       bool
	CaseSensitive bool
}

RegexpQuery is a query looking for regular expressions matches.

func (*Regexp) String

func (q *Regexp) String() string

type Repo

type Repo struct {
	Pattern string
}

func (*Repo) String

func (q *Repo) String() string

type Substring

type Substring struct {
	Pattern       string
	CaseSensitive bool

	// Match only filename
	FileName bool

	// Match only content
	Content bool
}

Substring is the most basic query: a query for a substring.

func (*Substring) String

func (q *Substring) String() string

type SuggestQueryError

type SuggestQueryError struct {
	Message    string
	Suggestion string
}

func (*SuggestQueryError) Error

func (e *SuggestQueryError) Error() string

type Symbol

type Symbol struct {
	Atom *Substring
}

Symbol finds a string that is a symbol.

func (*Symbol) String

func (s *Symbol) String() string