Source code
Revision control
Copy as Markdown
Other Tools
// This file is part of ICU4X. For terms of use, please see the file
// called LICENSE at the top level of the ICU4X source tree
//! 🚧 \[Unstable\] Data provider struct definitions for this ICU4X component.
//!
//! <div class="stab unstable">
//! 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
//! including in SemVer minor releases. While the serde representation of data structs is guaranteed
//! to be stable, their Rust representation might not be. Use with caution.
//! </div>
//!
//! Read more about data providers: [`icu_provider`]
// Provider structs must be stable
#![allow(clippy::exhaustive_structs, clippy::exhaustive_enums)]
mod lstm;
pub use lstm::*;
use crate::WordType;
use icu_collections::codepointtrie::CodePointTrie;
use icu_provider::prelude::*;
use zerovec::ZeroVec;
#[cfg(feature = "compiled_data")]
#[derive(Debug)]
/// Baked data
///
/// <div class="stab unstable">
/// 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. In particular, the `DataProvider` implementations are only
/// guaranteed to match with this version's `*_unstable` providers. Use with caution.
/// </div>
pub struct Baked;
#[cfg(feature = "compiled_data")]
const _: () = {
pub mod icu {
pub use crate as segmenter;
pub use icu_collections as collections;
}
icu_segmenter_data::make_provider!(Baked);
icu_segmenter_data::impl_segmenter_dictionary_w_auto_v1!(Baked);
icu_segmenter_data::impl_segmenter_dictionary_wl_ext_v1!(Baked);
icu_segmenter_data::impl_segmenter_grapheme_v1!(Baked);
icu_segmenter_data::impl_segmenter_line_v1!(Baked);
#[cfg(feature = "lstm")]
icu_segmenter_data::impl_segmenter_lstm_wl_auto_v1!(Baked);
icu_segmenter_data::impl_segmenter_sentence_v1!(Baked);
icu_segmenter_data::impl_segmenter_word_v1!(Baked);
};
#[cfg(feature = "datagen")]
/// The latest minimum set of keys required by this component.
pub const KEYS: &[DataKey] = &[
DictionaryForWordLineExtendedV1Marker::KEY,
DictionaryForWordOnlyAutoV1Marker::KEY,
GraphemeClusterBreakDataV1Marker::KEY,
LineBreakDataV1Marker::KEY,
LstmForWordLineAutoV1Marker::KEY,
SentenceBreakDataV1Marker::KEY,
WordBreakDataV1Marker::KEY,
];
/// Pre-processed Unicode data in the form of tables to be used for rule-based breaking.
///
/// <div class="stab unstable">
/// 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. While the serde representation of data structs is guaranteed
/// to be stable, their Rust representation might not be. Use with caution.
/// </div>
#[icu_provider::data_struct(
marker(LineBreakDataV1Marker, "segmenter/line@1", singleton),
marker(WordBreakDataV1Marker, "segmenter/word@1", singleton),
marker(GraphemeClusterBreakDataV1Marker, "segmenter/grapheme@1", singleton),
marker(SentenceBreakDataV1Marker, "segmenter/sentence@1", singleton)
)]
#[derive(Debug, PartialEq, Clone)]
#[cfg_attr(
feature = "datagen",
derive(serde::Serialize,databake::Bake),
databake(path = icu_segmenter::provider),
)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
pub struct RuleBreakDataV1<'data> {
/// Property table.
#[cfg_attr(feature = "serde", serde(borrow))]
pub property_table: CodePointTrie<'data, u8>,
/// Break state table.
#[cfg_attr(feature = "serde", serde(borrow))]
pub break_state_table: ZeroVec<'data, BreakState>,
/// Word type table. Only used for word segmenter.
#[cfg_attr(feature = "serde", serde(borrow, rename = "rule_status_table"))]
pub word_type_table: ZeroVec<'data, WordType>,
/// Number of properties; should be the square root of the length of [`Self::break_state_table`].
pub property_count: u8,
/// The index of the last simple state for [`Self::break_state_table`]. (A simple state has no
/// `left` nor `right` in SegmenterProperty).
pub last_codepoint_property: u8,
/// The index of SOT (start of text) state for [`Self::break_state_table`].
pub sot_property: u8,
/// The index of EOT (end of text) state [`Self::break_state_table`].
pub eot_property: u8,
/// The index of "SA" state (or 127 if the complex language isn't handled) for
/// [`Self::break_state_table`].
pub complex_property: u8,
}
/// char16trie data for dictionary break
///
/// <div class="stab unstable">
/// 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. While the serde representation of data structs is guaranteed
/// to be stable, their Rust representation might not be. Use with caution.
/// </div>
#[icu_provider::data_struct(
DictionaryForWordOnlyAutoV1Marker = "segmenter/dictionary/w_auto@1",
DictionaryForWordLineExtendedV1Marker = "segmenter/dictionary/wl_ext@1"
)]
#[derive(Debug, PartialEq, Clone)]
#[cfg_attr(
feature = "datagen",
derive(serde::Serialize,databake::Bake),
databake(path = icu_segmenter::provider),
)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
pub struct UCharDictionaryBreakDataV1<'data> {
/// Dictionary data of char16trie.
#[cfg_attr(feature = "serde", serde(borrow))]
pub trie_data: ZeroVec<'data, u16>,
}
pub(crate) struct UCharDictionaryBreakDataV1Marker;
impl DataMarker for UCharDictionaryBreakDataV1Marker {
type Yokeable = UCharDictionaryBreakDataV1<'static>;
}
#[derive(Clone, Copy, PartialEq, Debug)]
#[cfg_attr(
feature = "datagen",
derive(databake::Bake),
databake(path = icu_segmenter::provider),
)]
/// Break state
///
/// <div class="stab unstable">
/// 🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. In particular, the `DataProvider` implementations are only
/// guaranteed to match with this version's `*_unstable` providers. Use with caution.
/// </div>
pub enum BreakState {
/// Break
Break,
/// Keep rule
Keep,
/// Non-matching rule
NoMatch,
/// We have to look ahead one more character.
Intermediate(u8),
/// Index of a state.
Index(u8),
}
#[cfg(feature = "datagen")]
impl serde::Serialize for BreakState {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
// would be nice to use the derive serde for JSON, but can't break serialization
if serializer.is_human_readable() {
i8::from_le_bytes([zerovec::ule::AsULE::to_unaligned(*self)]).serialize(serializer)
} else {
zerovec::ule::AsULE::to_unaligned(*self).serialize(serializer)
}
}
}
#[cfg(feature = "serde")]
impl<'de> serde::Deserialize<'de> for BreakState {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
if deserializer.is_human_readable() {
Ok(zerovec::ule::AsULE::from_unaligned(
i8::deserialize(deserializer)?.to_le_bytes()[0],
))
} else {
u8::deserialize(deserializer).map(zerovec::ule::AsULE::from_unaligned)
}
}
}
impl zerovec::ule::AsULE for BreakState {
type ULE = u8;
fn to_unaligned(self) -> Self::ULE {
match self {
BreakState::Break => 128,
BreakState::Keep => 255,
BreakState::NoMatch => 254,
BreakState::Intermediate(i) => i | 64,
BreakState::Index(i) => i,
}
}
fn from_unaligned(unaligned: Self::ULE) -> Self {
match unaligned {
128 => BreakState::Break,
255 => BreakState::Keep,
254 => BreakState::NoMatch,
i if i & 64 != 0 => BreakState::Intermediate(i & !64),
i => BreakState::Index(i),
}
}
}
#[cfg(feature = "datagen")]
impl serde::Serialize for WordType {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
if serializer.is_human_readable() {
(*self as u8).serialize(serializer)
} else {
unreachable!("only used as ULE")
}
}
}
#[cfg(feature = "datagen")]
impl databake::Bake for WordType {
fn bake(&self, _crate_env: &databake::CrateEnv) -> databake::TokenStream {
unreachable!("only used as ULE")
}
}
#[cfg(feature = "serde")]
impl<'de> serde::Deserialize<'de> for WordType {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
if deserializer.is_human_readable() {
use serde::de::Error;
match u8::deserialize(deserializer) {
Ok(0) => Ok(WordType::None),
Ok(1) => Ok(WordType::Number),
Ok(2) => Ok(WordType::Letter),
Ok(_) => Err(D::Error::custom("invalid value")),
Err(e) => Err(e),
}
} else {
unreachable!("only used as ULE")
}
}
}