diff --git a/src/routes/demos/demoDir/KeyValueQueryLanguage.tsx b/src/routes/demos/demoDir/KeyValueQueryLanguage.tsx index 35348eb..935a264 100644 --- a/src/routes/demos/demoDir/KeyValueQueryLanguage.tsx +++ b/src/routes/demos/demoDir/KeyValueQueryLanguage.tsx @@ -1,115 +1,106 @@ -import type { QueryLanguage } from "./QueryLanguage"; - import classes from "./KeyValueQueryLanguage.module.css"; -export const literalBackslashPlaceholder = "\u{E005C}"; +export const filterKeys = [ + "type", + "event", + "name", + "map", + "player", + "tag", + "has", +] as const; + +export type FilterKey = (typeof filterKeys)[number]; -export type Token = +export type Token = { raw: string } & ( | { type: "text"; value: string } | { type: "filter"; value: { key: string; value: string } } - | { type: "invalid-filter"; value: { key: string; value: string } }; - -export type Parameters = { - filterPatterns: Record; -}; - -export const backslashEscape = (value: string) => - value - .replaceAll("\\", "\\\\") - .replaceAll(" ", "\\ ") - .replaceAll(literalBackslashPlaceholder, "\\"); + | { type: "invalid-filter"; value: { key: string; value: string } } +); -export const keyValueQueryLanguage: QueryLanguage = { - tokenizer: (query: string) => { - let escapeNextSymbol = false; - let currentToken = ""; - const tokens: string[] = []; +export function tokenizeQuery(query: string): string[] { + const tokens: string[] = []; + let start = 0; + let quoted = false; + let escaped = false; - for (const symbol of query) { - switch (symbol) { - case " ": - if (escapeNextSymbol) { - currentToken += " "; - escapeNextSymbol = false; - } else { - tokens.push(currentToken); - currentToken = ""; - } - break; - case "\\": - if (escapeNextSymbol) { - currentToken += "\\"; - escapeNextSymbol = false; - } else { - escapeNextSymbol = true; - } - break; - default: - if (escapeNextSymbol) { - currentToken += literalBackslashPlaceholder; - escapeNextSymbol = false; - } - currentToken += symbol; - } + for (let index = 0; index < query.length; index++) { + const symbol = query[index]; + if (escaped) { + escaped = false; + } else if (symbol === "\\") { + escaped = true; + } else if (symbol === '"') { + quoted = !quoted; + } else if (symbol === " " && !quoted) { + tokens.push(query.slice(start, index)); + start = index + 1; } + } - if (escapeNextSymbol) { - currentToken += literalBackslashPlaceholder; - } - tokens.push(currentToken); + tokens.push(query.slice(start)); + return tokens; +} - return tokens; - }, - parser: (token: string, { filterPatterns }): Token => { - const matches = /^(!?[a-zA-Z0-9-_]+):(.*)$/.exec(token); - if (matches !== null) { - const [_, key, value] = matches; +export function parseToken(token: string): Token { + const matches = /^(!?[a-zA-Z0-9-_]+):(.*)$/.exec(token); + if (matches !== null) { + const [_, key, rawValue] = matches; + const value = decodeQueryValue(rawValue); - if (Object.keys(filterPatterns).includes(key.replace(/^!/, ""))) { - return { type: "filter", value: { key, value } }; - } else { - return { type: "invalid-filter", value: { key, value } }; - } + if (filterKeys.some((filterKey) => filterKey === key.replace(/^!/, ""))) { + return { type: "filter", raw: token, value: { key, value } }; + } else { + return { type: "invalid-filter", raw: token, value: { key, value } }; } - return { type: "text", value: token }; - }, - renderTokens: (tokens: Token[]) => - tokens - .map((token, index) => { - switch (token.type) { - case "filter": - return ( - - - {backslashEscape(token.value.key)} - - : - - {backslashEscape(token.value.value)} - + } + return { type: "text", raw: token, value: decodeQueryValue(token) }; +} + +export const renderTokens = (tokens: Token[]) => + tokens + .map((token, index) => { + switch (token.type) { + case "filter": + return ( + + {token.value.key}: + + {token.raw.slice(token.value.key.length + 1)} - ); - case "invalid-filter": - return ( - - - {backslashEscape(token.value.key)} - - : - - {backslashEscape(token.value.value)} - + + ); + case "invalid-filter": + return ( + + {token.value.key}: + + {token.raw.slice(token.value.key.length + 1)} - ); - default: - return backslashEscape(token.value); - } - }) - .intersperse(" "), -}; + + ); + default: + return token.raw; + } + }) + .intersperse(" "); + +export const highlight = (value: string) => + renderTokens(tokenizeQuery(value).map(parseToken)); + +export const decodeQueryValue = (value: string) => + value.replace( + /\\([\\ "])|"/g, + (_match, escaped: string | undefined) => escaped ?? "" + ); + +export const quoteQueryValue = (value: string) => + /[\s"\\]/.test(value) + ? `"${value.replaceAll("\\", "\\\\").replaceAll('"', '\\"')}"` + : value; diff --git a/src/routes/demos/demoDir/QueryLanguage.tsx b/src/routes/demos/demoDir/QueryLanguage.tsx deleted file mode 100644 index 7f1ad29..0000000 --- a/src/routes/demos/demoDir/QueryLanguage.tsx +++ /dev/null @@ -1,7 +0,0 @@ -import type { ReactNode } from "react"; - -export type QueryLanguage = { - tokenizer(query: string, parameters: Parameters): string[]; - parser(token: string, parameters: Parameters): Token; - renderTokens(token: Token[], parameters: Parameters): ReactNode; -}; diff --git a/src/routes/demos/demoDir/SearchInput.tsx b/src/routes/demos/demoDir/SearchInput.tsx index a83662d..8fcaaf9 100644 --- a/src/routes/demos/demoDir/SearchInput.tsx +++ b/src/routes/demos/demoDir/SearchInput.tsx @@ -1,29 +1,34 @@ import { useEffect, useState } from "react"; -import { Combobox, Input, useCombobox } from "@mantine/core"; +import { + Anchor, + Combobox, + Input, + ScrollArea, + useCombobox, +} from "@mantine/core"; import { useDebouncedValue } from "@mantine/hooks"; import { IconSearch } from "@tabler/icons-react"; -import StyledInput, { type QueryLanguageProp } from "./StyledInput"; +import { highlight } from "./KeyValueQueryLanguage"; +import StyledInput from "./StyledInput"; import { useAutocomplete } from "./useAutocomplete"; import classes from "./SearchInput.module.css"; -type SearchInputProps = { +type SearchInputProps = { query: string; setQuery(newQuery: string): void; debounceInterval: number; filterPatterns: Record; -} & QueryLanguageProp; +}; -export default function SearchInput({ +export default function SearchInput({ query, setQuery, debounceInterval, filterPatterns, - queryLanguage, - queryLanguageParameters, -}: SearchInputProps) { +}: SearchInputProps) { const combobox = useCombobox(); const [rawQueryText, setRawQueryText] = useState(query); @@ -72,26 +77,36 @@ export default function SearchInput({ }} placeholder="Search..." component={StyledInput} - queryLanguage={queryLanguage} - queryLanguageParameters={queryLanguageParameters} + highlight={highlight} inputRef={inputRef} /> - {dropdownItems.length === 0 ? ( - Nothing found - ) : ( - dropdownItems.map((dropdownItem, index) => ( - - {dropdownItem} - - )) - )} + + {dropdownItems.length === 0 ? ( + Nothing found + ) : ( + dropdownItems.map((dropdownItem, index) => ( + + {dropdownItem} + + )) + )} + + + Supports special search syntax{" "} + + learn more + + ); diff --git a/src/routes/demos/demoDir/StyledInput/index.tsx b/src/routes/demos/demoDir/StyledInput/index.tsx index 247b237..3b36022 100644 --- a/src/routes/demos/demoDir/StyledInput/index.tsx +++ b/src/routes/demos/demoDir/StyledInput/index.tsx @@ -2,43 +2,33 @@ import { useCallback, useEffect, useRef } from "react"; import { useMergedRef } from "@mantine/hooks"; -import type { QueryLanguage } from "../QueryLanguage"; - import classes from "./StyledInput.module.css"; export type InputRefProp = { inputRef?: React.RefObject; }; -export type QueryLanguageProp = { - queryLanguage: QueryLanguage; - queryLanguageParameters: Parameters; -}; - -type StyledInputProps = React.ComponentProps<"input"> & - InputRefProp & - QueryLanguageProp; +type StyledInputProps = React.ComponentProps<"input"> & + InputRefProp & { + value: string; + highlight(value: string): React.ReactNode; + }; -export default ({ +export default ({ value, style, className, ref, inputRef: inputRefProp, - queryLanguage, - queryLanguageParameters, + highlight, ...otherProps -}: StyledInputProps) => { +}: StyledInputProps) => { const inputRef = useRef(null); const sizerRef = useRef(null); const highlightRef = useRef(null); const mergedInputRef = useMergedRef(inputRef, inputRefProp); - const tokens = queryLanguage - .tokenizer(value as string, queryLanguageParameters) - .map((token) => queryLanguage.parser(token, queryLanguageParameters)); - const updateSizer = useCallback((input: string) => { if (sizerRef.current !== null && inputRef.current !== null) { sizerRef.current.innerText = input; @@ -47,7 +37,7 @@ export default ({ }, []); useEffect(() => { - updateSizer(value as string); + updateSizer(value); }, [updateSizer, value]); return ( @@ -60,7 +50,7 @@ export default ({ >
- {queryLanguage.renderTokens(tokens, queryLanguageParameters)} + {highlight(value)}
diff --git a/src/routes/demos/demoDir/index.tsx b/src/routes/demos/demoDir/index.tsx index f3af0f2..8e96033 100644 --- a/src/routes/demos/demoDir/index.tsx +++ b/src/routes/demos/demoDir/index.tsx @@ -23,9 +23,10 @@ import useLocationState from "@/hooks/useLocationState"; import type { Path } from "@/store"; import DemoList from "./DemoList"; import { - keyValueQueryLanguage, - literalBackslashPlaceholder, + type FilterKey, + parseToken, type Token, + tokenizeQuery, } from "./KeyValueQueryLanguage"; import SearchInput from "./SearchInput"; import { SortControl } from "./SortControl"; @@ -39,21 +40,9 @@ type DemoListLoaderArgs = { onDemosChanged(): void; }; -type FilterPatternKey = - | "type" - | "event" - | "name" - | "map" - | "player" - | "tag" - | "has"; - const reassembleFilter = (filter: { key: string; value: string }) => `${filter.key}:${filter.value}`; -const replaceBackslashPlaceholder = (value: string) => - value.replaceAll(literalBackslashPlaceholder, "\\"); - function tokenToDemoFilter(token: Token): DemoFilter | null { switch (token.type) { case "filter": @@ -69,29 +58,23 @@ function tokenToDemoFilter(token: Token): DemoFilter | null { return filter === null ? null : { not: filter }; } - switch (token.value.key as FilterPatternKey | string) { + switch (token.value.key) { case "type": - return { demo_type: replaceBackslashPlaceholder(token.value.value) }; + return { demo_type: token.value.value }; case "event": - return { event: replaceBackslashPlaceholder(token.value.value) }; + return { event: token.value.value }; case "name": - return { file_name: replaceBackslashPlaceholder(token.value.value) }; + return { file_name: token.value.value }; case "map": - return { map_name: replaceBackslashPlaceholder(token.value.value) }; + return { map_name: token.value.value }; case "player": - return { - player_name: replaceBackslashPlaceholder(token.value.value), - }; + return { player_name: token.value.value }; case "tag": - return { tag_name: replaceBackslashPlaceholder(token.value.value) }; + return { tag_name: token.value.value }; case "has": - return { has: replaceBackslashPlaceholder(token.value.value) }; + return { has: token.value.value }; default: - return { - free_text: replaceBackslashPlaceholder( - reassembleFilter(token.value) - ), - }; + return { free_text: reassembleFilter(token.value) }; } case "text": if (token.value === "") { @@ -168,31 +151,28 @@ export default () => { const asyncKnownTags = useAsync(() => getKnownTags(), [revision]); const knownTags = asyncKnownTags.result ?? []; - const { filterPatterns, queryLanguageParameters, filters } = useMemo(() => { - const filterPatterns = { - type: ["stv", "pov"], - event: knownEvents, - name: knownDemoNames, - map: knownMaps, - player: knownPlayers, - tag: knownTags, - has: ["events", "tags"], - } satisfies Record; - - const queryLanguageParameters = { filterPatterns }; - - const tokens = keyValueQueryLanguage - .tokenizer(query, queryLanguageParameters) - .map((tokenString) => - keyValueQueryLanguage.parser(tokenString, queryLanguageParameters) - ); - - const filters = tokens - .map(tokenToDemoFilter) - .filter((filter) => filter !== null); + const filterPatterns = useMemo( + () => + ({ + type: ["stv", "pov"], + event: knownEvents, + name: knownDemoNames, + map: knownMaps, + player: knownPlayers, + tag: knownTags, + has: ["events", "tags"], + }) satisfies Record, + [knownEvents, knownDemoNames, knownMaps, knownPlayers, knownTags] + ); - return { filterPatterns, queryLanguageParameters, filters }; - }, [query, knownEvents, knownDemoNames, knownMaps, knownPlayers, knownTags]); + const filters = useMemo( + () => + tokenizeQuery(query) + .map(parseToken) + .map(tokenToDemoFilter) + .filter((filter) => filter !== null), + [query] + ); return ( <> @@ -203,8 +183,6 @@ export default () => { setQuery={setQuery} debounceInterval={500} filterPatterns={filterPatterns} - queryLanguage={keyValueQueryLanguage} - queryLanguageParameters={queryLanguageParameters} /> } right={ diff --git a/src/routes/demos/demoDir/useAutocomplete.tsx b/src/routes/demos/demoDir/useAutocomplete.tsx index 465e2f6..d7be589 100644 --- a/src/routes/demos/demoDir/useAutocomplete.tsx +++ b/src/routes/demos/demoDir/useAutocomplete.tsx @@ -2,62 +2,67 @@ import { type ReactEventHandler, useCallback, useEffect, + useLayoutEffect, useMemo, useRef, useState, } from "react"; +import { + filterKeys, + parseToken, + quoteQueryValue, + tokenizeQuery, +} from "./KeyValueQueryLanguage"; + export const useAutocomplete = ( queryText: string, setQueryText: (value: string) => void, filterPatterns: Record ) => { const inputRef = useRef(null); + const completionCursor = useRef(null); const [cursorIndex, setCursorIndex] = useState(0); const [dropdownItems, setDropdownItems] = useState([]); - const { - beforeCurrentToken, - currentToken, - currentTokenKeyValue, - afterCursor, - } = useMemo(() => { - const [beforeCursor, afterCursor] = queryText.splitAt(cursorIndex); - const lastTokenBoundary = beforeCursor.lastIndexOf(" ") + 1; - const [beforeCurrentToken, currentToken] = - beforeCursor.splitAt(lastTokenBoundary); - - const currentTokenColonIndex = currentToken.indexOf(":"); - const currentTokenKeyValue = - currentTokenColonIndex === -1 - ? null - : ([ - currentToken.slice(0, currentTokenColonIndex), - currentToken.slice(currentTokenColonIndex + 1), - ] as const); + const { beforeCurrentToken, currentToken, currentTokenKeyValue, afterToken } = + useMemo(() => { + const beforeCursor = queryText.slice(0, cursorIndex); + const currentToken = tokenizeQuery(beforeCursor).at(-1) ?? ""; + const start = beforeCursor.length - currentToken.length; + const fullToken = tokenizeQuery(queryText.slice(start))[0]; + const token = parseToken(currentToken); + const currentTokenKeyValue = + token.type === "text" + ? null + : ([token.value.key, token.value.value] as const); - return { - beforeCurrentToken, - currentToken, - currentTokenKeyValue, - afterCursor, - }; - }, [queryText, cursorIndex]); + return { + beforeCurrentToken: queryText.slice(0, start), + currentToken, + currentTokenKeyValue, + afterToken: queryText.slice(start + fullToken.length), + }; + }, [queryText, cursorIndex]); - useEffect(() => { - if ( - inputRef.current !== undefined && - inputRef.current !== null && - inputRef.current.selectionEnd !== null - ) { - setCursorIndex(inputRef.current.selectionEnd); + useLayoutEffect(() => { + const input = inputRef.current; + if (completionCursor.current !== null) { + input?.setSelectionRange( + completionCursor.current, + completionCursor.current + ); + completionCursor.current = null; + } + if (input?.selectionEnd !== null && input?.selectionEnd !== undefined) { + setCursorIndex(input.selectionEnd); } }, [queryText]); useEffect(() => { if (currentTokenKeyValue === null) { - const keys = Object.keys(filterPatterns) + const keys = filterKeys .map((key) => (currentToken.startsWith("!") ? `!${key}` : key)) .filter((key) => key.includes(currentToken)) .map((key) => `${key}:`); @@ -68,8 +73,11 @@ export const useAutocomplete = ( const values = filterPatterns[currentTokenKey.replace(/^!/, "")]; if (values !== undefined) { + const lowercaseTokenValue = currentTokenValue.toLocaleLowerCase(); setDropdownItems( - values.filter((value) => value.includes(currentTokenValue)) + values.filter((value) => + value.toLocaleLowerCase().includes(lowercaseTokenValue) + ) ); } else { setDropdownItems([]); @@ -79,19 +87,32 @@ export const useAutocomplete = ( const onOptionSubmit = useCallback( (optionValue: string) => { - const escapedValue = optionValue - .replaceAll("\\", "\\\\") - .replaceAll(" ", "\\ "); - if (currentTokenKeyValue !== null) { - const [currentTokenKey, _currentTokenValue] = currentTokenKeyValue; - setQueryText( - `${beforeCurrentToken}${currentTokenKey}:${escapedValue} ${afterCursor}` - ); + const completion = + currentTokenKeyValue === null + ? optionValue + : `${currentTokenKeyValue[0]}:${quoteQueryValue(optionValue)} `; + const suffix = + currentTokenKeyValue !== null && afterToken.startsWith(" ") + ? afterToken.slice(1) + : afterToken; + const nextQuery = beforeCurrentToken + completion + suffix; + const nextCursor = beforeCurrentToken.length + completion.length; + + if (nextQuery === queryText) { + inputRef.current?.setSelectionRange(nextCursor, nextCursor); + setCursorIndex(nextCursor); } else { - setQueryText(beforeCurrentToken + escapedValue + afterCursor); + completionCursor.current = nextCursor; + setQueryText(nextQuery); } }, - [setQueryText, currentTokenKeyValue, afterCursor, beforeCurrentToken] + [ + setQueryText, + queryText, + currentTokenKeyValue, + afterToken, + beforeCurrentToken, + ] ); const onSelect: ReactEventHandler = useCallback((event) => {