Skip to content

feat: increment suggested module tags #111

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

Merged
ViTeXFTW merged 2 commits into from
Sep 1, 2026
Merged

feat: increment suggested module tags #111

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b15f244
feat: increment suggested module tags
ViTeXFTW Sep 1, 2026
542b1e2
fix: include nested module tags in suggestions
ViTeXFTW Sep 1, 2026
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
111 changes: 106 additions & 5 deletions crates/analysis/src/completion.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,10 @@ pub fn complete(
index,
(file, offset),
),
PosContext::ModuleName { slot_accepts } => module_name_completions(analyzer, &slot_accepts),
PosContext::ModuleName {
scope_node,
slot_accepts,
} => module_name_completions(analyzer, &scope_node, &slot_accepts),
PosContext::SubBlockArg { argument_type } => {
completions_for_type(analyzer, &argument_type, 0, None, None, index)
}
Expand All @@ -93,8 +96,10 @@ enum PosContext {
first_token: Option<String>,
},
/// Completing a module type name after a slot `=`. Carries the slot's
/// accepted interfaces so completions can be filtered to valid modules only.
/// enclosing scope so its snippet can choose an unused-looking module tag,
/// and accepted interfaces so candidates can be filtered to valid modules.
ModuleName {
scope_node: SyntaxNode,
slot_accepts: Vec<String>,
},
/// Completing the argument of a sub-block header.
Expand Down Expand Up @@ -189,7 +194,8 @@ fn classify_position(analyzer: &Analyzer, root: &SyntaxNode, offset: u32) -> Pos
// (before any nested field/scope) and after `=`, and the slot is a real
// module slot of the parent block.
if on_header_line(&module_node, offset) && after_equals(&module_node, offset) {
let parent = enclosing_scope(&module_node).map(|p| scope_schema(analyzer, &p));
let scope_node = enclosing_scope(&module_node);
let parent = scope_node.as_ref().map(|p| scope_schema(analyzer, p));
let slot = Module(module_node.clone()).slot();
let slot_accepts = slot.as_ref().and_then(|s| {
parent.as_ref().and_then(|p| {
Expand All @@ -201,6 +207,7 @@ fn classify_position(analyzer: &Analyzer, root: &SyntaxNode, offset: u32) -> Pos
});
if let Some(accepts) = slot_accepts {
return PosContext::ModuleName {
scope_node: scope_node.unwrap_or_else(|| root.clone()),
slot_accepts: accepts,
};
}
Expand Down Expand Up @@ -790,7 +797,12 @@ fn top_level_completions(analyzer: &Analyzer) -> Vec<Completion> {
.collect()
}

fn module_name_completions(analyzer: &Analyzer, slot_accepts: &[String]) -> Vec<Completion> {
fn module_name_completions(
analyzer: &Analyzer,
scope_node: &SyntaxNode,
slot_accepts: &[String],
) -> Vec<Completion> {
let tag = next_module_tag(analyzer, scope_node);
analyzer
.schema()
.modules
Expand All @@ -801,7 +813,7 @@ fn module_name_completions(analyzer: &Analyzer, slot_accepts: &[String]) -> Vec<
.map(|m| {
// Snippet: module name + placeholder tag + indented body + End.
// Also satisfies missing-module-tag in one accept.
let insert = Some(format!("{} ${{1:ModuleTag_01}}\n\t$0\nEnd", m.name));
let insert = Some(format!("{} ${{1:{tag}}}\n\t$0\nEnd", m.name));
Completion {
label: m.name.clone(),
kind: CompletionKind::Module,
Expand All @@ -812,6 +824,49 @@ fn module_name_completions(analyzer: &Analyzer, slot_accepts: &[String]) -> Vec<
.collect()
}

/// Suggest the next numeric tag used by module slots in the enclosing Object.
///
/// Descriptive tags (such as `ModuleTag_Draw`) deliberately do not affect the
/// numeric sequence. Only genuine module slots are considered: sub-block
/// headers can also have several arguments, but those arguments are not tags.
fn next_module_tag(analyzer: &Analyzer, scope_node: &SyntaxNode) -> String {
const PREFIX: &str = "ModuleTag_";
let object_node = scope_node
.ancestors()
.find(|node| {
Block(node.clone())
.keyword()
.is_some_and(|keyword| keyword.text().eq_ignore_ascii_case("Object"))
})
.unwrap_or_else(|| scope_node.clone());
let highest = object_node
.descendants()
.filter_map(Module::cast)
.filter(|module| {
let parent = enclosing_scope(&module.0);
let module_slots = parent
.as_ref()
.map(|parent| scope_schema(analyzer, parent).module_slots())
.unwrap_or_default();
module.slot().is_some_and(|slot| {
module_slots
.iter()
.any(|module_slot| module_slot.keyword.eq_ignore_ascii_case(slot.text()))
})
})
.filter_map(|module| module.tag())
.filter_map(|tag| {
let text = tag.text();
text.get(..PREFIX.len())
.filter(|prefix| prefix.eq_ignore_ascii_case(PREFIX))
.and_then(|_| text.get(PREFIX.len()..))
.and_then(|number| number.parse::<u64>().ok())
})
.max()
.unwrap_or(0);
format!("ModuleTag_{:02}", highest + 1)
}

// --- position helpers ---

fn ancestor_of_kind(node: &SyntaxNode, kind: SyntaxKind) -> Option<SyntaxNode> {
Expand Down Expand Up @@ -1007,6 +1062,52 @@ mod tests {
assert!(out.contains(&"ActiveBody".to_string()), "{out:?}");
}

#[test]
fn module_snippet_uses_next_numeric_tag_in_object() {
let src = "Object Tank\n Draw = W3DTankDraw ModuleTag_01\n End\n Behavior = SlowDeathBehavior MODULETAG_03\n End\n Behavior = \nEnd\n";
let offset = "Object Tank\n Draw = W3DTankDraw ModuleTag_01\n End\n Behavior = SlowDeathBehavior MODULETAG_03\n End\n Behavior = ".len() as u32;
let completion = item(src, offset, "AutoHealBehavior");
assert_eq!(
completion.insert.as_deref(),
Some("AutoHealBehavior ${1:ModuleTag_04}\n\t$0\nEnd")
);
}

#[test]
fn module_snippet_ignores_descriptive_tags_and_sub_block_arguments() {
let src = "Object Tank\n Draw = W3DTankDraw ModuleTag_Draw\n ConditionState = DAMAGED REALLYDAMAGED\n End\n End\n Behavior = \nEnd\n";
let offset = "Object Tank\n Draw = W3DTankDraw ModuleTag_Draw\n ConditionState = DAMAGED REALLYDAMAGED\n End\n End\n Behavior = ".len() as u32;
let completion = item(src, offset, "AutoHealBehavior");
assert_eq!(
completion.insert.as_deref(),
Some("AutoHealBehavior ${1:ModuleTag_01}\n\t$0\nEnd")
);
}

#[test]
fn module_snippet_in_reentrant_scope_uses_object_wide_sequence() {
let src = "Object Tank\n AddModule\n Behavior = SlowDeathBehavior ModuleTag_04\n End\n Behavior = \n End\nEnd\n";
let offset = "Object Tank\n AddModule\n Behavior = SlowDeathBehavior ModuleTag_04\n End\n Behavior = ".len() as u32;
let completion = item(src, offset, "AutoHealBehavior");
assert_eq!(
completion.insert.as_deref(),
Some("AutoHealBehavior ${1:ModuleTag_05}\n\t$0\nEnd")
);
}

#[test]
fn module_snippet_continues_past_u32_tag_values() {
let src = "Object Tank\n Behavior = SlowDeathBehavior ModuleTag_4294967295\n End\n Behavior = \nEnd\n";
let offset =
"Object Tank\n Behavior = SlowDeathBehavior ModuleTag_4294967295\n End\n Behavior = "
.len() as u32;
let completion = item(src, offset, "AutoHealBehavior");
assert_eq!(
completion.insert.as_deref(),
Some("AutoHealBehavior ${1:ModuleTag_4294967296}\n\t$0\nEnd")
);
}

#[test]
fn model_asset_completions_use_index() {
let a = Analyzer::embedded();
Expand Down