Package: github.com/rsteube/carapace-shlex

package shlex Import Path github.com/rsteube/carapace-shlex (on go.dev) Dependency Relation imports 7 packages, and imported by 3 packages

Involved Source Files shlex.go tokenslice.go wordbreak.go

Package-Level Type Names (total 5)

/* sort by: alphabet | popularity */

type LexerState int (basic type) the internal state used by the lexer state machine Methods (only one) ( LexerState) MarshalJSON() ([]byte, error) Implements (at least 2) LexerState : github.com/goccy/go-json.Marshaler LexerState : encoding/json.Marshaler As Types Of (total 8) const COMMENT_STATE const ESCAPING_QUOTED_STATE const ESCAPING_STATE const IN_WORD_STATE const QUOTING_ESCAPING_STATE const QUOTING_STATE const START_STATE const WORDBREAK_STATE

type Token (struct) Token is a (type, value) pair representing a lexographical token. Fields (total 7) Index int RawValue string State LexerState Type TokenType Value string WordbreakIndex int // index of last opening quote in Value (only correct when in quoting state) WordbreakType WordbreakType Methods (only one) (*Token) Equal(other *Token) bool Equal reports whether tokens a, and b, are equal. Two tokens are equal if both their types and values are equal. A nil token can never be equal to another token. As Outputs Of (at least one exported) func TokenSlice.CurrentToken() (token Token) As Inputs Of (at least one exported) func (*Token).Equal(other *Token) bool

type TokenSlice ([]) Methods (total 7) ( TokenSlice) CurrentPipeline() TokenSlice ( TokenSlice) CurrentToken() (token Token) ( TokenSlice) FilterRedirects() TokenSlice ( TokenSlice) Pipelines() []TokenSlice ( TokenSlice) Strings() []string ( TokenSlice) WordbreakPrefix() string ( TokenSlice) Words() TokenSlice As Outputs Of (at least 5) func Split(s string) (TokenSlice, error) func TokenSlice.CurrentPipeline() TokenSlice func TokenSlice.FilterRedirects() TokenSlice func TokenSlice.Pipelines() []TokenSlice func TokenSlice.Words() TokenSlice

type TokenType int (basic type) TokenType is a top-level token classification: A word, space, comment, unknown. Methods (only one) ( TokenType) MarshalJSON() ([]byte, error) Implements (at least 2) TokenType : github.com/goccy/go-json.Marshaler TokenType : encoding/json.Marshaler As Types Of (total 5) const COMMENT_TOKEN const SPACE_TOKEN const UNKNOWN_TOKEN const WORD_TOKEN const WORDBREAK_TOKEN

Package-Level Functions (only one)

func Split(s string) (TokenSlice, error) Split partitions of a string into tokens.

Package-Level Constants (total 30)

const BASH_WORDBREAKS = " \t\r\n\"'><=;|&(:"

const COMMENT_STATE LexerState = 6 // we are within a comment (everything following an unquoted or unescaped # Lexer state machine states

const COMMENT_TOKEN TokenType = 3 Classes of lexographic token

const ESCAPING_QUOTED_STATE LexerState = 3 // we have just consumed an escape rune within a quoted string Lexer state machine states

const ESCAPING_STATE LexerState = 2 // we have just consumed an escape rune; the next rune is literal Lexer state machine states

const IN_WORD_STATE LexerState = 1 // processing regular runes in a word Lexer state machine states

const QUOTING_ESCAPING_STATE LexerState = 4 // we are within a quoted string that supports escaping ("...") Lexer state machine states

const QUOTING_STATE LexerState = 5 // we are within a string that does not support escaping ('...') Lexer state machine states

const SPACE_TOKEN TokenType = 2 Classes of lexographic token

const START_STATE LexerState = 0 // no runes have been seen Lexer state machine states

const UNKNOWN_TOKEN TokenType = 0 Classes of lexographic token

const WORD_TOKEN TokenType = 1 Classes of lexographic token

const WORDBREAK_CUSTOM WordbreakType = 15 COMP_WORDBREAKS

const WORDBREAK_LIST_AND WordbreakType = 13

const WORDBREAK_LIST_ASYNC WordbreakType = 11 https://www.gnu.org/software/bash/manual/html_node/Lists.html)

const WORDBREAK_LIST_OR WordbreakType = 14

const WORDBREAK_LIST_SEQUENTIAL WordbreakType = 12

const WORDBREAK_PIPE WordbreakType = 9 https://www.gnu.org/software/bash/manual/html_node/Pipelines.html

const WORDBREAK_PIPE_WITH_STDERR WordbreakType = 10

const WORDBREAK_REDIRECT_INPUT WordbreakType = 1 https://www.gnu.org/software/bash/manual/html_node/Redirections.html

const WORDBREAK_REDIRECT_INPUT_DUPLICATE WordbreakType = 7

const WORDBREAK_REDIRECT_INPUT_OUTPUT WordbreakType = 8

const WORDBREAK_REDIRECT_INPUT_STRING WordbreakType = 6

const WORDBREAK_REDIRECT_OUTPUT WordbreakType = 2

const WORDBREAK_REDIRECT_OUTPUT_APPEND WordbreakType = 3

const WORDBREAK_REDIRECT_OUTPUT_BOTH WordbreakType = 4

const WORDBREAK_REDIRECT_OUTPUT_BOTH_APPEND WordbreakType = 5

const WORDBREAK_STATE LexerState = 7 // we have just consumed a wordbreak rune Lexer state machine states

const WORDBREAK_TOKEN TokenType = 4 Classes of lexographic token

const WORDBREAK_UNKNOWN WordbreakType = 0