Implement Debug for data structure as a feature

pull/221/head
notoria 3 years ago committed by Blaž Hrastnik
parent aebdef8257
commit 1a3a924634

@ -10,6 +10,7 @@ license = "MPL-2.0"
[features]
embed_runtime = ["rust-embed"]
debug = []
[dependencies]
helix-syntax = { path = "../helix-syntax" }
@ -17,7 +18,7 @@ helix-syntax = { path = "../helix-syntax" }
ropey = "1.2"
smallvec = "1.4"
tendril = "0.4.2"
unicode-segmentation = "1.6"
unicode-segmentation = { git = "https://github.com/unicode-rs/unicode-segmentation.git" }
unicode-width = "0.1"
unicode-general-category = "0.4.0"
# slab = "0.4.2"

@ -1,3 +1,4 @@
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(Eq, PartialEq)]
pub enum Severity {
Error,
@ -6,10 +7,13 @@ pub enum Severity {
Hint,
}
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Range {
pub start: usize,
pub end: usize,
}
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Diagnostic {
pub range: Range,
pub line: usize,

@ -147,6 +147,7 @@ pub fn is_grapheme_boundary(slice: RopeSlice, char_idx: usize) -> bool {
}
/// An iterator over the graphemes of a `RopeSlice`.
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(Clone)]
pub struct RopeGraphemes<'a> {
text: RopeSlice<'a>,

@ -2,6 +2,7 @@ use crate::{ChangeSet, Rope, State, Transaction};
use smallvec::{smallvec, SmallVec};
/// Undo-tree style history store.
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct History {
revisions: Vec<Revision>,
cursor: usize,

@ -1,6 +1,7 @@
use crate::graphemes::{nth_next_grapheme_boundary, nth_prev_grapheme_boundary, RopeGraphemes};
use crate::{coords_at_pos, pos_at_coords, ChangeSet, Position, Range, Rope, RopeSlice, Selection};
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(Copy, Clone, PartialEq, Eq)]
pub enum Direction {
Forward,

@ -1,6 +1,7 @@
use crate::{Rope, Selection};
/// A state represents the current editor state of a single buffer.
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(Clone)]
pub struct State {
pub doc: Rope,

@ -1,6 +1,8 @@
use crate::{regex::Regex, Change, Rope, RopeSlice, Transaction};
pub use helix_syntax::{get_language, get_language_name, Lang};
#[cfg(feature = "debug")]
use std::fmt;
use std::{
borrow::Cow,
cell::RefCell,
@ -12,12 +14,14 @@ use std::{
use once_cell::sync::{Lazy, OnceCell};
use serde::{Deserialize, Serialize};
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(Serialize, Deserialize)]
pub struct Configuration {
pub language: Vec<LanguageConfiguration>,
}
// largely based on tree-sitter/cli/src/loader.rs
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct LanguageConfiguration {
@ -46,6 +50,7 @@ pub struct LanguageConfiguration {
pub(crate) indent_query: OnceCell<Option<IndentQuery>>,
}
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct LanguageServerConfiguration {
@ -55,6 +60,7 @@ pub struct LanguageServerConfiguration {
pub args: Vec<String>,
}
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct IndentationConfiguration {
@ -62,6 +68,7 @@ pub struct IndentationConfiguration {
pub unit: String,
}
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct IndentQuery {
@ -189,6 +196,7 @@ impl LanguageConfiguration {
pub static LOADER: OnceCell<Loader> = OnceCell::new();
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Loader {
// highlight_names ?
language_configs: Vec<Arc<LanguageConfiguration>>,
@ -256,6 +264,13 @@ pub struct TsParser {
cursors: Vec<QueryCursor>,
}
#[cfg(feature = "debug")]
impl fmt::Debug for TsParser {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("TsParser").finish_non_exhaustive()
}
}
// could also just use a pool, or a single instance?
thread_local! {
pub static PARSER: RefCell<TsParser> = RefCell::new(TsParser {
@ -264,6 +279,7 @@ thread_local! {
})
}
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Syntax {
config: Arc<HighlightConfiguration>,
@ -444,6 +460,7 @@ impl Syntax {
// buffer_range_for_scope_at_pos
}
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct LanguageLayer {
// mode
// grammar
@ -752,6 +769,7 @@ pub enum HighlightEvent {
/// Contains the data neeeded to higlight code written in a particular language.
///
/// This struct is immutable and can be shared between threads.
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct HighlightConfiguration {
pub language: Grammar,
pub query: Query,
@ -782,6 +800,7 @@ struct LocalScope<'a> {
local_defs: Vec<LocalDef<'a>>,
}
#[cfg_attr(feature = "debug", derive(Debug))]
struct HighlightIter<'a, 'tree: 'a, F>
where
F: FnMut(&str) -> Option<&'a HighlightConfiguration> + 'a,
@ -807,6 +826,13 @@ struct HighlightIterLayer<'a, 'tree: 'a> {
depth: usize,
}
#[cfg(feature = "debug")]
impl<'a, 'tree: 'a> fmt::Debug for HighlightIterLayer<'a, 'tree> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("HighlightIterLayer").finish_non_exhaustive()
}
}
impl HighlightConfiguration {
/// Creates a `HighlightConfiguration` for a given `Grammar` and set of highlighting
/// queries.

@ -15,6 +15,7 @@ pub enum Operation {
Insert(Tendril),
}
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(Copy, Clone, PartialEq, Eq)]
pub enum Assoc {
Before,

@ -7,6 +7,9 @@ license = "MPL-2.0"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[features]
debug = ["helix-core/debug"]
[dependencies]
helix-core = { path = "../helix-core" }

@ -16,6 +16,7 @@ use tokio::{
sync::mpsc::{channel, UnboundedReceiver, UnboundedSender},
};
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Client {
_process: Child,
server_tx: UnboundedSender<Payload>,

@ -172,6 +172,7 @@ impl Notification {
}
}
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Registry {
inner: HashMap<LanguageId, Arc<Client>>,

@ -31,6 +31,7 @@ enum ServerMessage {
Call(jsonrpc::Call),
}
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Transport {
client_tx: UnboundedSender<jsonrpc::Call>,
client_rx: UnboundedReceiver<Payload>,

@ -1 +1 @@
Subproject commit 237f4eb4417c28f643a29d795ed227246afb66f9
Subproject commit 004f2709c460d95fbfd1061f8efc98f36e33c03c

@ -10,6 +10,7 @@ license = "MPL-2.0"
[features]
embed_runtime = ["helix-core/embed_runtime"]
debug = ["helix-core/debug", "helix-view/debug"]
[[bin]]
name = "hx"

@ -10,6 +10,7 @@ license = "MPL-2.0"
[features]
default = ["crossterm"]
debug = []
[dependencies]
bitflags = "1.0"

@ -10,6 +10,7 @@ license = "MPL-2.0"
[features]
term = ["tui", "crossterm"]
default = ["term"]
debug = ["helix-core/debug", "helix-lsp/debug"]
[dependencies]
anyhow = "1"

@ -13,6 +13,7 @@ use crate::{DocumentId, ViewId};
use std::collections::HashMap;
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(Copy, Clone, PartialEq, Eq, Hash)]
pub enum Mode {
Normal,
@ -52,6 +53,31 @@ pub struct Document {
language_server: Option<Arc<helix_lsp::Client>>,
}
#[cfg(feature = "debug")]
use std::fmt;
#[cfg(feature = "debug")]
impl fmt::Debug for Document {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Document")
.field("id", &self.id)
.field("text", &self.text)
.field("selections", &self.selections)
.field("path", &self.path)
.field("mode", &self.mode)
.field("restore_cursor", &self.restore_cursor)
.field("syntax", &self.syntax)
.field("language", &self.language)
.field("changes", &self.changes)
.field("old_state", &self.old_state)
// .field("history", &self.history)
.field("last_saved_revision", &self.last_saved_revision)
.field("version", &self.version)
.field("diagnostics", &self.diagnostics)
// .field("language_server", &self.language_server)
.finish_non_exhaustive()
}
}
/// Like std::mem::replace() except it allows the replacement value to be mapped from the
/// original value.
fn take_with<T, F>(mut_ref: &mut T, closure: F)

@ -9,6 +9,7 @@ use anyhow::Error;
pub use helix_core::diagnostic::Severity;
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Editor {
pub tree: Tree,
pub documents: SlotMap<DocumentId, Document>,
@ -20,6 +21,7 @@ pub struct Editor {
pub status_msg: Option<(String, Severity)>,
}
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(Copy, Clone)]
pub enum Action {
Replace,

@ -4,6 +4,7 @@ use tui::layout::Rect;
// the dimensions are recomputed on windo resize/tree change.
//
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Tree {
root: ViewId,
// (container, index inside the container)
@ -17,11 +18,13 @@ pub struct Tree {
stack: Vec<(ViewId, Rect)>,
}
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Node {
parent: ViewId,
content: Content,
}
#[cfg_attr(feature = "debug", derive(Debug))]
pub enum Content {
View(Box<View>),
Container(Box<Container>),
@ -45,6 +48,7 @@ impl Node {
// TODO: screen coord to container + container coordinate helpers
#[cfg_attr(feature = "debug", derive(Debug))]
#[derive(PartialEq, Eq)]
pub enum Layout {
Horizontal,
@ -52,6 +56,7 @@ pub enum Layout {
// could explore stacked/tabbed
}
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Container {
layout: Layout,
children: Vec<ViewId>,
@ -432,6 +437,7 @@ impl Tree {
}
}
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Traverse<'a> {
tree: &'a Tree,
stack: Vec<ViewId>, // TODO: reuse the one we use on update

@ -12,6 +12,7 @@ pub const PADDING: usize = 5;
type Jump = (DocumentId, Selection);
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct JumpList {
jumps: Vec<Jump>,
current: usize,
@ -58,6 +59,7 @@ impl JumpList {
}
}
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct View {
pub id: ViewId,
pub doc: DocumentId,

Loading…
Cancel
Save