Skip to content
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.

Sign up for GitHub

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

use more efficient _readdirx for tab completion #53540

Merged
merged 1 commit into from
Mar 1, 2024
Merged

use more efficient _readdirx for tab completion #53540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 18 additions & 17 deletions stdlib/REPL/src/REPLCompletions.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ using Core: Const
const CC = Core.Compiler
using Base.Meta
using Base: propertynames, something, IdSet
using Base.Filesystem: _readdirx

abstract type Completion end

Expand Down Expand Up @@ -317,8 +318,8 @@ function cache_PATH()
continue
end

filesinpath = try
readdir(pathdir)
path_entries = try
_readdirx(pathdir)
catch e
# Bash allows dirs in PATH that can't be read, so we should as well.
if isa(e, Base.IOError) || isa(e, Base.ArgumentError)
Expand All @@ -328,13 +329,13 @@ function cache_PATH()
rethrow()
end
end
for file in filesinpath
for entry in path_entries
# In a perfect world, we would filter on whether the file is executable
# here, or even on whether the current user can execute the file in question.
try
if isfile(joinpath(pathdir, file))
@lock PATH_cache_lock push!(PATH_cache, file)
push!(this_PATH_cache, file)
if isfile(entry)
@lock PATH_cache_lock push!(PATH_cache, entry.name)
push!(this_PATH_cache, entry.name)
end
catch e
# `isfile()` can throw in rare cases such as when probing a
Expand Down Expand Up @@ -378,11 +379,11 @@ function complete_path(path::AbstractString;
else
dir, prefix = splitdir(path)
end
files = try
entries = try
if isempty(dir)
readdir()
_readdirx()
elseif isdir(dir)
readdir(dir)
_readdirx(dir)
else
return Completion[], dir, false
end
Expand All @@ -392,11 +393,10 @@ function complete_path(path::AbstractString;
end

matches = Set{String}()
for file in files
if startswith(file, prefix)
p = joinpath(dir, file)
is_dir = try isdir(p) catch ex; ex isa Base.IOError ? false : rethrow() end
push!(matches, is_dir ? file * "/" : file)
for entry in entries
if startswith(entry.name, prefix)
is_dir = try isdir(entry) catch ex; ex isa Base.IOError ? false : rethrow() end
push!(matches, is_dir ? entry.name * "/" : entry.name)
end
end

Expand Down Expand Up @@ -1349,14 +1349,15 @@ function completions(string::String, pos::Int, context_module::Module=Main, shif
append!(suggestions, project_deps_get_completion_candidates(s, dir))
end
isdir(dir) || continue
for pname in readdir(dir)
for entry in _readdirx(dir)
pname = entry.name
if pname[1] != '.' && pname != "METADATA" &&
pname != "REQUIRE" && startswith(pname, s)
# Valid file paths are
# <Mod>.jl
# <Mod>/src/<Mod>.jl
# <Mod>.jl/src/<Mod>.jl
if isfile(joinpath(dir, pname))
if isfile(entry)
endswith(pname, ".jl") && push!(suggestions,
PackageCompletion(pname[1:prevind(pname, end-2)]))
else
Expand All @@ -1365,7 +1366,7 @@ function completions(string::String, pos::Int, context_module::Module=Main, shif
else
pname
end
if isfile(joinpath(dir, pname, "src",
if isfile(joinpath(entry, "src",
"$mod_name.jl"))
push!(suggestions, PackageCompletion(mod_name))
end
Expand Down
8 changes: 5 additions & 3 deletions stdlib/REPL/src/docview.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import Base.Docs: doc, formatdoc, parsedoc, apropos

using Base: with_output_color, mapany, isdeprecated, isexported

using Base.Filesystem: _readdirx

import REPL

using InteractiveUtils: subtypes
Expand Down Expand Up @@ -379,9 +381,9 @@ function find_readme(m::Module)::Union{String, Nothing}
path = dirname(mpath)
top_path = pkgdir(m)
while true
for file in readdir(path; join=true, sort=true)
isfile(file) && (basename(lowercase(file)) in ["readme.md", "readme"]) || continue
return file
for entry in _readdirx(path; sort=true)
isfile(entry) && (lowercase(entry.name) in ["readme.md", "readme"]) || continue
return entry.path
end
path == top_path && break # go no further than pkgdir
path = dirname(path) # work up through nested modules
Expand Down