mirror of
https://github.com/typst/typst
synced 2025-08-18 00:48:34 +08:00
Compare commits
4 Commits
8cb178176c
...
36ac46b5c3
Author | SHA1 | Date | |
---|---|---|---|
|
36ac46b5c3 | ||
|
0264534928 | ||
|
70710deb2b | ||
|
73340f70a6 |
@ -1,3 +1,5 @@
|
||||
use std::collections::HashSet;
|
||||
|
||||
use comemo::Track;
|
||||
use ecow::{eco_vec, EcoString, EcoVec};
|
||||
use typst::foundations::{Label, Styles, Value};
|
||||
@ -66,14 +68,22 @@ pub fn analyze_import(world: &dyn IdeWorld, source: &LinkedNode) -> Option<Value
|
||||
/// - All labels and descriptions for them, if available
|
||||
/// - A split offset: All labels before this offset belong to nodes, all after
|
||||
/// belong to a bibliography.
|
||||
///
|
||||
/// Note: When multiple labels in the document have the same identifier,
|
||||
/// this only returns the first one.
|
||||
pub fn analyze_labels(
|
||||
document: &PagedDocument,
|
||||
) -> (Vec<(Label, Option<EcoString>)>, usize) {
|
||||
let mut output = vec![];
|
||||
let mut seen_labels = HashSet::new();
|
||||
|
||||
// Labels in the document.
|
||||
for elem in document.introspector.all() {
|
||||
let Some(label) = elem.label() else { continue };
|
||||
if !seen_labels.insert(label) {
|
||||
continue;
|
||||
}
|
||||
|
||||
let details = elem
|
||||
.to_packed::<FigureElem>()
|
||||
.and_then(|figure| match figure.caption.as_option() {
|
||||
|
@ -76,7 +76,7 @@ pub struct Completion {
|
||||
}
|
||||
|
||||
/// A kind of item that can be completed.
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
pub enum CompletionKind {
|
||||
/// A syntactical structure.
|
||||
@ -130,7 +130,14 @@ fn complete_markup(ctx: &mut CompletionContext) -> bool {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Start of a reference: "@|" or "@he|".
|
||||
// Start of a reference: "@|".
|
||||
if ctx.leaf.kind() == SyntaxKind::Text && ctx.before.ends_with("@") {
|
||||
ctx.from = ctx.cursor;
|
||||
ctx.label_completions();
|
||||
return true;
|
||||
}
|
||||
|
||||
// An existing reference: "@he|".
|
||||
if ctx.leaf.kind() == SyntaxKind::RefMarker {
|
||||
ctx.from = ctx.leaf.offset() + 1;
|
||||
ctx.label_completions();
|
||||
@ -1564,7 +1571,7 @@ mod tests {
|
||||
|
||||
use typst::layout::PagedDocument;
|
||||
|
||||
use super::{autocomplete, Completion};
|
||||
use super::{autocomplete, Completion, CompletionKind};
|
||||
use crate::tests::{FilePos, TestWorld, WorldLike};
|
||||
|
||||
/// Quote a string.
|
||||
@ -1644,6 +1651,19 @@ mod tests {
|
||||
test_with_doc(world, pos, doc.as_ref())
|
||||
}
|
||||
|
||||
#[track_caller]
|
||||
fn test_with_addition(
|
||||
initial_text: &str,
|
||||
addition: &str,
|
||||
pos: impl FilePos,
|
||||
) -> Response {
|
||||
let mut world = TestWorld::new(initial_text);
|
||||
let doc = typst::compile(&world).output.ok();
|
||||
let end = world.main.text().len();
|
||||
world.main.edit(end..end, addition);
|
||||
test_with_doc(&world, pos, doc.as_ref())
|
||||
}
|
||||
|
||||
#[track_caller]
|
||||
fn test_with_doc(
|
||||
world: impl WorldLike,
|
||||
@ -1709,6 +1729,30 @@ mod tests {
|
||||
.must_exclude(["bib"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_autocomplete_ref_function() {
|
||||
test_with_addition("x<test>", " #ref(<)", -2).must_include(["test"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_autocomplete_ref_shorthand() {
|
||||
test_with_addition("x<test>", " @", -1).must_include(["test"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_autocomplete_ref_shorthand_with_partial_identifier() {
|
||||
test_with_addition("x<test>", " @te", -1).must_include(["test"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_autocomplete_ref_identical_labels_returns_single_completion() {
|
||||
let result = test_with_addition("x<test> y<test>", " @t", -1);
|
||||
let completions = result.completions();
|
||||
let label_count =
|
||||
completions.iter().filter(|c| c.kind == CompletionKind::Label).count();
|
||||
assert_eq!(label_count, 1);
|
||||
}
|
||||
|
||||
/// Test what kind of brackets we autocomplete for function calls depending
|
||||
/// on the function and existing parens.
|
||||
#[test]
|
||||
|
92
crates/typst-library/src/introspection/count.rs
Normal file
92
crates/typst-library/src/introspection/count.rs
Normal file
@ -0,0 +1,92 @@
|
||||
use comemo::Tracked;
|
||||
|
||||
use crate::diag::HintedStrResult;
|
||||
use crate::engine::Engine;
|
||||
use crate::foundations::{func, Array, Context, IntoValue, LocatableSelector, Selector};
|
||||
|
||||
/// Counts element in the document.
|
||||
///
|
||||
/// The `count` function lets you count elements in your document of a
|
||||
/// particular type or with a particular label. It also allows to count them
|
||||
/// in a hierachical way. To use it, you first need to ensure that [context]
|
||||
/// is available.
|
||||
///
|
||||
/// Always returns an array of integers, even if called with just a single
|
||||
/// target.
|
||||
|
||||
/// # Counting elements - simple
|
||||
///
|
||||
/// To just count elements of a single type/label up to the current location,
|
||||
/// pass the selector you want to count:
|
||||
/// ```example
|
||||
/// = Heading
|
||||
///
|
||||
/// = Another Heading
|
||||
///
|
||||
/// #context count(heading)
|
||||
///
|
||||
/// = Third Heading
|
||||
/// ```
|
||||
///
|
||||
/// Note that it will not return an integer, but an array with a single integer
|
||||
/// entry.
|
||||
|
||||
/// # Counting elements - hierarchical
|
||||
///
|
||||
/// If you pass multiple targets, then it starts by counting the first target.
|
||||
/// Then the second target is counted _starting only from the last counted
|
||||
/// element of the first target_.
|
||||
///
|
||||
/// ```example
|
||||
/// = Some Heading
|
||||
///
|
||||
/// == Some Subheading
|
||||
///
|
||||
/// = Another Heading
|
||||
///
|
||||
/// == Some Subheading
|
||||
///
|
||||
/// #context count(heading.where(level: 1), heading.where(level: 2))
|
||||
///
|
||||
/// == Another Subheading
|
||||
/// ```
|
||||
#[func(contextual)]
|
||||
pub fn count(
|
||||
/// The engine.
|
||||
engine: &mut Engine,
|
||||
/// The callsite context.
|
||||
context: Tracked<Context>,
|
||||
/// Each target can be
|
||||
/// - an element function like a `heading` or `figure`,
|
||||
/// - a `{<label>}`,
|
||||
/// - a more complex selector like `{heading.where(level: 1)}`,
|
||||
/// - or `{selector(heading).before(here())}`.
|
||||
///
|
||||
/// Only [locatable]($location/#locatable) element functions are supported.
|
||||
#[variadic]
|
||||
targets: Vec<LocatableSelector>,
|
||||
/// When passing this argument, it will count everything only from a
|
||||
/// certain location on.
|
||||
/// The selector must match exactly one element in the document. The most
|
||||
/// useful kinds of selectors for this are [labels]($label) and
|
||||
/// [locations]($location).
|
||||
// TODO remove Option as soon as there is a special `start` location
|
||||
#[named]
|
||||
after: Option<LocatableSelector>,
|
||||
) -> HintedStrResult<Array> {
|
||||
// NOTE this could be made more efficient
|
||||
// one could directly get a slice &[Selector] from Vec<LocatableSelector>
|
||||
// by using #[repr(transparent)] on LocatableSelector
|
||||
let selectors: Vec<Selector> = targets.into_iter().map(|sel| sel.0).collect();
|
||||
// TODO add argument "at" with default value "here"
|
||||
// and compute `before` accordingly
|
||||
let before = Some(context.location()?);
|
||||
let after = match after {
|
||||
Some(selector) => Some(selector.resolve_unique(engine.introspector, context)?),
|
||||
None => None,
|
||||
};
|
||||
|
||||
let nums = engine.introspector.count(&selectors, after, before);
|
||||
|
||||
Ok(nums.into_iter().map(IntoValue::into_value).collect())
|
||||
}
|
@ -238,6 +238,60 @@ impl Introspector {
|
||||
}
|
||||
}
|
||||
|
||||
/// Count hierarchically.
|
||||
pub fn count(
|
||||
&self,
|
||||
selectors: &[Selector],
|
||||
// TODO remove Option as soon as there is a special `start` location
|
||||
after: Option<Location>,
|
||||
// TODO remove Option as soon as there is a special `end` location
|
||||
before: Option<Location>,
|
||||
) -> SmallVec<[usize; 3]> {
|
||||
let mut nums = SmallVec::with_capacity(selectors.len());
|
||||
|
||||
// can't write `mut` directly into function parameters because not supported by comemo
|
||||
let mut after = after;
|
||||
|
||||
for selector in selectors.iter() {
|
||||
let list = self.query(selector);
|
||||
|
||||
// count how many elements in `list` are between after and end
|
||||
let index_start = if let Some(after) = after {
|
||||
if let Some(after) = self.get_by_loc(&after) {
|
||||
match self.binary_search(&list, after) {
|
||||
Ok(i) => i, // TODO if after is exclusive then must add 1 here
|
||||
Err(i) => i,
|
||||
}
|
||||
} else {
|
||||
0
|
||||
}
|
||||
} else {
|
||||
0
|
||||
};
|
||||
let index_end = if let Some(before) = before {
|
||||
if let Some(before) = self.get_by_loc(&before) {
|
||||
match self.binary_search(&list, before) {
|
||||
Ok(i) => i + 1,
|
||||
Err(i) => i,
|
||||
}
|
||||
} else {
|
||||
list.len()
|
||||
}
|
||||
} else {
|
||||
list.len()
|
||||
};
|
||||
nums.push(index_end - index_start);
|
||||
|
||||
// the next level should be counted only from
|
||||
// the last element of the previous level on
|
||||
if index_end != 0 {
|
||||
after = Some(list[index_end - 1].location().unwrap());
|
||||
}
|
||||
}
|
||||
|
||||
nums
|
||||
}
|
||||
|
||||
/// The total number pages.
|
||||
pub fn pages(&self) -> NonZeroUsize {
|
||||
NonZeroUsize::new(self.pages).unwrap_or(NonZeroUsize::ONE)
|
||||
|
@ -1,5 +1,7 @@
|
||||
//! Interaction between document parts.
|
||||
|
||||
#[path = "count.rs"]
|
||||
mod count_;
|
||||
mod counter;
|
||||
#[path = "here.rs"]
|
||||
mod here_;
|
||||
@ -14,6 +16,7 @@ mod query_;
|
||||
mod state;
|
||||
mod tag;
|
||||
|
||||
pub use self::count_::*;
|
||||
pub use self::counter::*;
|
||||
pub use self::here_::*;
|
||||
pub use self::introspector::*;
|
||||
@ -36,6 +39,7 @@ pub fn define(global: &mut Scope) {
|
||||
global.define_elem::<MetadataElem>();
|
||||
global.define_func::<here>();
|
||||
global.define_func::<query>();
|
||||
global.define_func::<count>();
|
||||
global.define_func::<locate>();
|
||||
global.reset_category();
|
||||
}
|
||||
|
Loading…
x
Reference in New Issue
Block a user