Skip to content

Make raw pointers work in type-based search #145731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions src/librustdoc/html/render/search_index.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1494,7 +1494,9 @@ pub(crate) fn build_index(
let search_unbox = match id {
RenderTypeId::Mut => false,
RenderTypeId::DefId(defid) => utils::has_doc_flag(tcx, defid, sym::search_unbox),
RenderTypeId::Primitive(PrimitiveType::Reference | PrimitiveType::Tuple) => true,
RenderTypeId::Primitive(
PrimitiveType::Reference | PrimitiveType::RawPointer | PrimitiveType::Tuple,
) => true,
RenderTypeId::Primitive(..) => false,
RenderTypeId::AssociatedType(..) => false,
// this bool is only used by `insert_into_map`, so it doesn't matter what we set here
Expand Down Expand Up @@ -1855,7 +1857,7 @@ fn get_index_type_id(
}
clean::Primitive(p) => Some(RenderTypeId::Primitive(p)),
clean::BorrowedRef { .. } => Some(RenderTypeId::Primitive(clean::PrimitiveType::Reference)),
clean::RawPointer(_, ref type_) => get_index_type_id(type_, rgen),
clean::RawPointer { .. } => Some(RenderTypeId::Primitive(clean::PrimitiveType::RawPointer)),
// The type parameters are converted to generics in `simplify_fn_type`
clean::Slice(_) => Some(RenderTypeId::Primitive(clean::PrimitiveType::Slice)),
clean::Array(_, _) => Some(RenderTypeId::Primitive(clean::PrimitiveType::Array)),
Expand Down Expand Up @@ -2113,7 +2115,8 @@ fn simplify_fn_type<'a, 'tcx>(
generics: Some(ty_generics),
});
}
Type::BorrowedRef { lifetime: _, mutability, ref type_ } => {
Type::BorrowedRef { lifetime: _, mutability, ref type_ }
| Type::RawPointer(mutability, ref type_) => {
let mut ty_generics = Vec::new();
if mutability.is_mut() {
ty_generics.push(RenderType {
Expand Down
95 changes: 65 additions & 30 deletions src/librustdoc/html/static/js/search.js
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,45 @@ function getNextElem(query, parserState, elems, isInGenerics) {
/** @type {rustdoc.ParserQueryElement[]} */
const generics = [];

/** @type {function(string, string): void} */
const handleRefOrPtr = (chr, name) => {
if (parserState.typeFilter !== null && parserState.typeFilter !== "primitive") {
throw [
"Invalid search type: primitive ",
chr,
" and ",
parserState.typeFilter,
" both specified",
];
}
parserState.typeFilter = null;
parserState.pos += 1;
let c = parserState.userQuery[parserState.pos];
while (c === " " && parserState.pos < parserState.length) {
parserState.pos += 1;
c = parserState.userQuery[parserState.pos];
}
const generics = [];
const pos = parserState.pos;
if (parserState.userQuery.slice(pos, pos + 3) === "mut") {
generics.push(makePrimitiveElement("mut", { typeFilter: "keyword" }));
parserState.pos += 3;
c = parserState.userQuery[parserState.pos];
} else if (chr === "*" && parserState.userQuery.slice(pos, pos + 5) === "const") {
// make *const T parse the same as *T
parserState.pos += 5;
c = parserState.userQuery[parserState.pos];
}
while (c === " " && parserState.pos < parserState.length) {
parserState.pos += 1;
c = parserState.userQuery[parserState.pos];
}
if (!isEndCharacter(c) && parserState.pos < parserState.length) {
getFilteredNextElem(query, parserState, generics, isInGenerics);
}
elems.push(makePrimitiveElement(name, { generics }));
};

skipWhitespace(parserState);
let start = parserState.pos;
let end;
Expand Down Expand Up @@ -636,36 +675,9 @@ function getNextElem(query, parserState, elems, isInGenerics) {
elems.push(makePrimitiveElement(name, { bindingName, generics }));
}
} else if (parserState.userQuery[parserState.pos] === "&") {
if (parserState.typeFilter !== null && parserState.typeFilter !== "primitive") {
throw [
"Invalid search type: primitive ",
"&",
" and ",
parserState.typeFilter,
" both specified",
];
}
parserState.typeFilter = null;
parserState.pos += 1;
let c = parserState.userQuery[parserState.pos];
while (c === " " && parserState.pos < parserState.length) {
parserState.pos += 1;
c = parserState.userQuery[parserState.pos];
}
const generics = [];
if (parserState.userQuery.slice(parserState.pos, parserState.pos + 3) === "mut") {
generics.push(makePrimitiveElement("mut", { typeFilter: "keyword" }));
parserState.pos += 3;
c = parserState.userQuery[parserState.pos];
}
while (c === " " && parserState.pos < parserState.length) {
parserState.pos += 1;
c = parserState.userQuery[parserState.pos];
}
if (!isEndCharacter(c) && parserState.pos < parserState.length) {
getFilteredNextElem(query, parserState, generics, isInGenerics);
}
elems.push(makePrimitiveElement("reference", { generics }));
handleRefOrPtr("&", "reference");
} else if (parserState.userQuery[parserState.pos] === "*") {
handleRefOrPtr("*", "pointer");
} else {
const isStringElem = parserState.userQuery[start] === "\"";
// We handle the strings on their own mostly to make code easier to follow.
Expand Down Expand Up @@ -1185,6 +1197,7 @@ class DocSearch {
this.typeNameIdOfUnit = -1;
this.typeNameIdOfTupleOrUnit = -1;
this.typeNameIdOfReference = -1;
this.typeNameIdOfPointer = -1;
this.typeNameIdOfHof = -1;

this.utf8decoder = new TextDecoder();
Expand Down Expand Up @@ -1224,6 +1237,7 @@ class DocSearch {
tupleOrUnit,
// reference matches `&`
reference,
pointer,
// never matches `!`
never,
] = await Promise.all([
Expand All @@ -1239,6 +1253,7 @@ class DocSearch {
nn.search("unit"),
nn.search("()"),
nn.search("reference"),
nn.search("pointer"),
nn.search("never"),
]);
/**
Expand Down Expand Up @@ -1270,6 +1285,7 @@ class DocSearch {
this.typeNameIdOfUnit = await first(unit, TY_PRIMITIVE, "");
this.typeNameIdOfTupleOrUnit = await first(tupleOrUnit, TY_PRIMITIVE, "");
this.typeNameIdOfReference = await first(reference, TY_PRIMITIVE, "");
this.typeNameIdOfPointer = await first(pointer, TY_PRIMITIVE, "");
this.typeNameIdOfHof = await first(hof, TY_PRIMITIVE, "");
this.typeNameIdOfNever = await first(never, TY_PRIMITIVE, "");
}
Expand Down Expand Up @@ -2309,6 +2325,25 @@ class DocSearch {
}, result),
);
return true;
} else if (fnType.id === this.typeNameIdOfPointer) {
pushText({ name: "*", highlighted: fnType.highlighted }, result);
if (fnType.generics.length < 2) {
pushText({ name: "const ", highlighted: fnType.highlighted }, result);
}
let prevHighlighted = false;
await onEachBtwnAsync(
fnType.generics,
async value => {
prevHighlighted = !!value.highlighted;
await writeFn(value, result);
},
// @ts-expect-error
value => pushText({
name: " ",
highlighted: prevHighlighted && value.highlighted,
}, result),
);
return true;
} else if (
fnType.id === this.typeNameIdOfFn ||
fnType.id === this.typeNameIdOfFnMut ||
Expand Down
8 changes: 0 additions & 8 deletions tests/rustdoc-js-std/parser-errors.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,6 @@ const PARSED = [
returned: [],
error: "Found generics without a path",
},
{
query: '-> *',
elems: [],
foundElems: 0,
userQuery: "-> *",
returned: [],
error: "Unexpected `*` after ` ` (not a valid identifier)",
},
{
query: 'a<"P">',
elems: [],
Expand Down
Loading
Loading