mirror of
https://github.com/openai/codex.git
synced 2026-11-12 21:20:34 +00:00
## Summary - Make `TextElement` placeholders private and add a text-backed accessor to avoid assuming `Some`. - Since they are optional in the protocol, we want to make sure any accessors properly handle the None case (getting the placeholder using the byte range in the text) - Preserve placeholders during protocol/app-server conversions using the accessor fallback. - Update TUI composer/remap logic and tests to use the new constructor/accessor.
86 lines
2.7 KiB
Rust
86 lines
2.7 KiB
Rust
use schemars::JsonSchema;
|
||
use serde::Deserialize;
|
||
use serde::Serialize;
|
||
use ts_rs::TS;
|
||
|
||
/// User input
|
||
#[non_exhaustive]
|
||
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, TS, JsonSchema)]
|
||
#[serde(tag = "type", rename_all = "snake_case")]
|
||
pub enum UserInput {
|
||
Text {
|
||
text: String,
|
||
/// UI-defined spans within `text` that should be treated as special elements.
|
||
/// These are byte ranges into the UTF-8 `text` buffer and are used to render
|
||
/// or persist rich input markers (e.g., image placeholders) across history
|
||
/// and resume without mutating the literal text.
|
||
#[serde(default)]
|
||
text_elements: Vec<TextElement>,
|
||
},
|
||
/// Pre‑encoded data: URI image.
|
||
Image { image_url: String },
|
||
|
||
/// Local image path provided by the user. This will be converted to an
|
||
/// `Image` variant (base64 data URL) during request serialization.
|
||
LocalImage { path: std::path::PathBuf },
|
||
|
||
/// Skill selected by the user (name + path to SKILL.md).
|
||
Skill {
|
||
name: String,
|
||
path: std::path::PathBuf,
|
||
},
|
||
}
|
||
|
||
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, TS, JsonSchema)]
|
||
pub struct TextElement {
|
||
/// Byte range in the parent `text` buffer that this element occupies.
|
||
pub byte_range: ByteRange,
|
||
/// Optional human-readable placeholder for the element, displayed in the UI.
|
||
placeholder: Option<String>,
|
||
}
|
||
|
||
impl TextElement {
|
||
pub fn new(byte_range: ByteRange, placeholder: Option<String>) -> Self {
|
||
Self {
|
||
byte_range,
|
||
placeholder,
|
||
}
|
||
}
|
||
|
||
pub fn set_placeholder(&mut self, placeholder: Option<String>) {
|
||
self.placeholder = placeholder;
|
||
}
|
||
|
||
/// Returns the stored placeholder without falling back to the text buffer.
|
||
///
|
||
/// This is intended only for protocol conversions where the full text is not
|
||
/// available; prefer `placeholder(text)` for UI logic.
|
||
#[doc(hidden)]
|
||
pub fn _placeholder_for_conversion_only(&self) -> Option<&str> {
|
||
self.placeholder.as_deref()
|
||
}
|
||
|
||
pub fn placeholder<'a>(&'a self, text: &'a str) -> Option<&'a str> {
|
||
self.placeholder
|
||
.as_deref()
|
||
.or_else(|| text.get(self.byte_range.start..self.byte_range.end))
|
||
}
|
||
}
|
||
|
||
#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, TS, JsonSchema)]
|
||
pub struct ByteRange {
|
||
/// Start byte offset (inclusive) within the UTF-8 text buffer.
|
||
pub start: usize,
|
||
/// End byte offset (exclusive) within the UTF-8 text buffer.
|
||
pub end: usize,
|
||
}
|
||
|
||
impl From<std::ops::Range<usize>> for ByteRange {
|
||
fn from(range: std::ops::Range<usize>) -> Self {
|
||
Self {
|
||
start: range.start,
|
||
end: range.end,
|
||
}
|
||
}
|
||
}
|