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

Jump to bottom

Include completions for items from the same file; Clean up completions generation for callables #1863

Merged
merged 4 commits into from
Aug 20, 2024
Merged

Include completions for items from the same file; Clean up completions generation for callables #1863

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b49333
it works
sezna Aug 20, 2024
98dad2a
finalize changes
sezna Aug 20, 2024
ea8be16
fmt
sezna Aug 20, 2024
1dacb68
update comment formatting
sezna Aug 20, 2024
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
166 changes: 75 additions & 91 deletions language_service/src/completion.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -738,7 +738,7 @@ fn package_item_to_completion_item(

match &item.kind {
ItemKind::Callable(callable_decl) => {
return callable_decl_to_completion_item(
return Some(callable_decl_to_completion_item(
callable_decl,
current_namespace_name,
display,
Expand All @@ -747,7 +747,7 @@ fn package_item_to_completion_item(
imports,
insert_open_at,
indent,
)
))
}
_ => return None,
}
Expand All @@ -765,105 +765,89 @@ fn callable_decl_to_completion_item(
package_alias_from_manifest: &Option<Arc<str>>,
callable_namespace: &qsc::hir::Idents,
imports: &[ImportItem],
insert_open_at: Option<Range>,
insert_import_at: Option<Range>,
indent: &String,
) -> Option<(CompletionItem, SortPriority)> {
) -> (CompletionItem, SortPriority) {
sezna marked this conversation as resolved.
Show resolved Hide resolved
let name = callable_decl.name.name.as_ref();
// details used when rendering the completion item
let detail = Some(display.hir_callable_decl(callable_decl).to_string());
// Everything that starts with a __ goes last in the list
let sort_group = u32::from(name.starts_with("__"));

// buffer to be filled up with an edit that would need to
// be applied if this completion item is selected
let mut additional_edits = vec![];

match &current_namespace_name {
// if there is no package alias for this callable (i.e. it
// is not the user package or stdlib) and
// if the current namespace is the same as the callable
// namespace
Some(curr_ns)
if package_alias_from_manifest.is_none()
&& *curr_ns == Into::<Vec<_>>::into(callable_namespace) =>
{
None
}
_ => {
// calculate the qualification that goes before the import
// item
// if an exact import already exists, or if that namespace
// is glob imported, then there is no qualification

// If there is no matching import or glob import, then the
// qualification is the full namespace name

// an exact import is an import that matches the namespace
// and item name exactly
let namespace_as_strs = Into::<Vec<_>>::into(callable_namespace);
let preexisting_exact_import = imports.iter().any(|import_item| {
let import_item_namespace = &import_item.path[..import_item.path.len() - 1];
let import_item_name = import_item.path.last().map(|x| &**x);
*import_item_namespace == namespace_as_strs[..] && import_item_name == Some(name)
});
// calculate the qualification that goes before the import
// item
// if an exact import already exists, or if that namespace
// is glob imported, then there is no qualification

// If there is no matching import or glob import, then the
// qualification is the full namespace name

// an exact import is an import that matches the namespace
sezna marked this conversation as resolved.
Show resolved Hide resolved
// and item name exactly
let namespace_as_strs = Into::<Vec<_>>::into(callable_namespace);
let preexisting_exact_import = imports.iter().any(|import_item| {
let import_item_namespace = &import_item.path[..import_item.path.len() - 1];
let import_item_name = import_item.path.last().map(|x| &**x);
*import_item_namespace == namespace_as_strs[..] && import_item_name == Some(name)
});

let preexisting_glob_import = imports.iter().any(|import_item| {
import_item.path == namespace_as_strs[..] && import_item.is_glob
});
let preexisting_glob_import = imports
.iter()
.any(|import_item| import_item.path == namespace_as_strs[..] && import_item.is_glob);

let preexisting_namespace_alias = imports.iter().find_map(|import_item| {
if import_item.path == namespace_as_strs[..] {
import_item.alias.as_ref().map(|x| vec![x.clone()])
} else {
None
}
});
let preexisting_namespace_alias = imports.iter().find_map(|import_item| {
if import_item.path == namespace_as_strs[..] {
import_item.alias.as_ref().map(|x| vec![x.clone()])
} else {
None
}
});

match (
preexisting_exact_import,
preexisting_glob_import,
insert_open_at,
) {
// If there is already an import of this exact item,
// or if there is already a glob import of this namespace,
// then we don't need any additional text edits.
(true, _, _) | (_, true, _) => (),
// If there is no exact import or glob import of the alias, then
// we need to add an import statement of this item.
(_, _, Some(start)) if preexisting_namespace_alias.is_none() => {
let import_text = format_external_name(
package_alias_from_manifest,
&Into::<Vec<_>>::into(callable_namespace),
Some(name),
);
additional_edits.push(TextEdit {
new_text: format!("import {import_text};{indent}",),
range: start,
});
}
_ => (),
};
// this conditional is kind of gnarly, but it boils down to:
// do we need to add an import statement for this item, or is it already accessible?
// If so, what edit?
// The first condition is if we are in the same namespace,
// the second is if there is already an exact import or glob import of this item. In these
// cases, we do not need to add an import statement.
// The third condition is if there is no existing imports, and no existing package alias (a
// form of import), then we need to add an import statement.
let additional_text_edit =
// first condition
if current_namespace_name == Some(namespace_as_strs.as_slice()) ||
// second condition
(preexisting_exact_import || preexisting_glob_import) { None }
// third condition
else if preexisting_namespace_alias.is_none() {
// if there is no place to insert an import, then we can't add an import.
if let Some(range) = insert_import_at {
let import_text = format_external_name(
package_alias_from_manifest,
&Into::<Vec<_>>::into(callable_namespace),
Some(name),
);
Some(TextEdit {
new_text: format!("import {import_text};{indent}",),
range,
})
} else { None }
} else {
None
};

let label = if let Some(qualification) = preexisting_namespace_alias {
format_external_name(package_alias_from_manifest, &qualification, Some(name))
} else {
name.to_owned()
};
let label = if let Some(qualification) = preexisting_namespace_alias {
format_external_name(package_alias_from_manifest, &qualification, Some(name))
} else {
name.to_owned()
};

Some((
CompletionItem {
label,
kind: CompletionItemKind::Function,
sort_text: None, // This will get filled in during `push_sorted_completions`
detail,
additional_text_edits: if additional_edits.is_empty() {
None
} else {
Some(additional_edits)
},
},
sort_group,
))
}
}
(
CompletionItem {
label,
kind: CompletionItemKind::Function,
sort_text: None, // This will get filled in during `push_sorted_completions`
detail,
additional_text_edits: additional_text_edit.map(|x| vec![x]),
},
sort_group,
)
}
31 changes: 31 additions & 0 deletions language_service/src/completion/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1456,3 +1456,34 @@ fn dont_import_if_already_directly_imported() {
"#]],
);
}

#[test]
fn callable_from_same_file() {
check(
r#"
namespace Test {
function MyCallable() : Unit {}
operation Main() : Unit {
MyCall↘
}
}"#,
&["MyCallable"],
&expect![[r#"
[
Some(
CompletionItem {
label: "MyCallable",
kind: Function,
sort_text: Some(
"0600MyCallable",
),
detail: Some(
"function MyCallable() : Unit",
),
additional_text_edits: None,
},
),
]
"#]],
);
}
Loading