use crate::input::DiagnosticInput;
use crate::location::find_prefix_in_source;
use ontocore_core::{
Diagnostic, DiagnosticCode, DiagnosticSeverity, OntologyFormat, ParseStatus, QuickFix,
};
use std::collections::BTreeSet;
use std::path::Path;
pub fn undefined_prefixes(
data: &DiagnosticInput<'_>,
source: &dyn Fn(&Path) -> String,
) -> Vec<Diagnostic> {
let mut diagnostics = Vec::new();
for doc in data.documents {
if doc.parse_status == ParseStatus::Error {
continue;
}
if !matches!(
doc.format,
OntologyFormat::Turtle
| OntologyFormat::TriG
| OntologyFormat::Owl
| OntologyFormat::RdfXml
) {
continue;
}
if matches!(doc.format, OntologyFormat::RdfXml | OntologyFormat::Owl) {
continue;
}
let text = source(&doc.path);
let declared: BTreeSet<&str> = doc.namespaces.keys().map(String::as_str).collect();
let builtins = builtin_prefixes();
let scan_text = strip_comments_and_strings(&text);
for cap in QNAME_RE.captures_iter(&scan_text) {
let full = cap.get(0).map(|m| m.as_str()).unwrap_or("");
if full.contains("://") {
continue;
}
let prefix = cap.get(1).map(|m| m.as_str()).unwrap_or("");
if prefix.eq_ignore_ascii_case("urn") {
continue;
}
if prefix.is_empty() || declared.contains(prefix) || builtins.contains(prefix) {
continue;
}
let range = find_prefix_in_source(&text, prefix);
let message = format!("undefined prefix: {prefix}:");
if diagnostics.iter().any(|d: &Diagnostic| {
d.file == doc.path
&& d.code == DiagnosticCode::UndefinedPrefix
&& d.message == message
&& d.range.line == range.line
}) {
continue;
}
let quick_fix = QuickFix::InsertText {
label: format!("Declare @prefix {prefix}:"),
line: 1,
column: 1,
text: format!("@prefix {prefix}: <http://example.org/{prefix}#> .\n"),
}
.encode();
diagnostics.push(Diagnostic {
code: DiagnosticCode::UndefinedPrefix,
severity: DiagnosticSeverity::Error,
message,
file: doc.path.clone(),
range,
entity_iri: None,
quick_fix,
plugin_id: None,
plugin_code: None,
});
}
}
diagnostics
}
fn strip_comments_and_strings(text: &str) -> String {
let mut out = String::with_capacity(text.len());
let mut chars = text.chars().peekable();
while let Some(c) = chars.next() {
match c {
'#' => {
while chars.next().is_some_and(|ch| ch != '\n') {}
out.push(' ');
}
'"' => {
if chars.peek() == Some(&'"') && chars.nth(1) == Some('"') {
while let Some(ch) = chars.next() {
if ch == '"' && chars.peek() == Some(&'"') {
let _ = chars.next();
if chars.peek() == Some(&'"') {
chars.next();
break;
}
}
}
} else {
#[allow(clippy::while_let_on_iterator)]
while let Some(ch) = chars.next() {
if ch == '"' {
break;
}
if ch == '\\' {
chars.next();
}
}
}
out.push(' ');
}
'\'' => {
#[allow(clippy::while_let_on_iterator)]
while let Some(ch) = chars.next() {
if ch == '\'' {
break;
}
}
out.push(' ');
}
other => out.push(other),
}
}
out
}
fn builtin_prefixes() -> BTreeSet<&'static str> {
["rdf", "rdfs", "owl", "xsd", "xml", "xmlns", "sh", "skos", "dc", "dcterms", "foaf", "schema"]
.into_iter()
.collect()
}
static QNAME_RE: std::sync::LazyLock<regex::Regex> = std::sync::LazyLock::new(|| {
regex::Regex::new(r"([A-Za-z][\w-]*):[A-Za-z_][\w-]*").expect("qname regex")
});
#[cfg(test)]
mod tests {
use super::*;
use crate::input::DiagnosticInput;
use ontocore_core::{
DiagnosticCode, DiagnosticSeverity, OntologyDocument, OntologyFormat, ParseStatus,
};
use std::collections::BTreeMap;
use std::path::Path;
fn source_for(path: &Path) -> String {
match path.to_str() {
Some("live.ttl") => {
"@prefix ex: <http://example.org/live#> .\n@prefix owl: <http://www.w3.org/2002/07/owl#> .\nex:Ok a owl:Class .\nun:Bad a owl:Class .\n".to_string()
}
_ => String::new(),
}
}
#[test]
fn detects_undefined_prefix_in_turtle() {
let documents = vec![OntologyDocument {
id: "doc-1".to_string(),
path: Path::new("live.ttl").to_path_buf(),
format: OntologyFormat::Turtle,
base_iri: Some("http://example.org/live".to_string()),
imports: vec![],
namespaces: BTreeMap::from([(
"ex".to_string(),
"http://example.org/live#".to_string(),
)]),
parse_status: ParseStatus::Ok,
content_hash: "h".to_string(),
modified_time: 0,
parse_message: None,
parse_error_location: None,
}];
let input = DiagnosticInput {
documents: &documents,
entities: &[],
annotations: &[],
axioms: &[],
namespaces: &[],
imports: &[],
};
let diags = undefined_prefixes(&input, &source_for);
assert_eq!(diags.len(), 1);
assert_eq!(diags[0].code, DiagnosticCode::UndefinedPrefix);
assert_eq!(diags[0].severity, DiagnosticSeverity::Error);
assert!(diags[0].message.contains("un:"));
assert!(diags[0].quick_fix.is_some(), "undefined prefix should offer quick fix");
}
#[test]
fn ignores_undefined_prefix_inside_comment() {
let text = "@prefix ex: <http://ex/> .\n# un:Hidden a owl:Class .\nex:Ok a owl:Class .\n";
let documents = vec![OntologyDocument {
id: "doc-1".to_string(),
path: Path::new("ok.ttl").to_path_buf(),
format: OntologyFormat::Turtle,
base_iri: Some("http://ex/".to_string()),
imports: vec![],
namespaces: BTreeMap::from([("ex".to_string(), "http://ex/".to_string())]),
parse_status: ParseStatus::Ok,
content_hash: "h".to_string(),
modified_time: 0,
parse_message: None,
parse_error_location: None,
}];
let input = DiagnosticInput {
documents: &documents,
entities: &[],
annotations: &[],
axioms: &[],
namespaces: &[],
imports: &[],
};
let diags = undefined_prefixes(&input, &|_| text.to_string());
assert!(diags.is_empty(), "commented qname should not lint: {diags:?}");
}
}