Rename ProgramDescription => ProgramState

Author: simonrw

debugger/src/internals.rs

@@ -10,7 +10,7 @@ use transport::{
 
 use crate::{
     debugger::InitialiseArguments,
-    state::{DebuggerState, ProgramDescription},
+    state::{DebuggerState, ProgramState},
     types::{Breakpoint, BreakpointId, PausedFrame},
     Event,
 };
@@ -75,7 +75,7 @@ impl DebuggerInternals {
         let paused_frame = self
             .compute_paused_frame(chosen_stack_frame)
             .context("computing paused frame")?;
-        self.emit(Event::ScopeChange(ProgramDescription {
+        self.emit(Event::ScopeChange(ProgramState {
             stack: stack_frames,
             breakpoints: self.breakpoints.values().cloned().collect(),
             paused_frame,

debugger/src/lib.rs

@@ -8,5 +8,5 @@ pub mod utils;
 
 pub use debugger::{Debugger, InitialiseArguments};
 pub use internals::FileSource;
-pub use state::{AttachArguments, Event, Language, LaunchArguments, ProgramDescription};
+pub use state::{AttachArguments, Event, Language, LaunchArguments, ProgramState};
 pub use types::{Breakpoint, EvaluateResult, PausedFrame};

debugger/src/state.rs

@@ -21,7 +21,7 @@ pub(crate) enum DebuggerState {
 
 /// Represents the current program state
 #[derive(Debug, Clone)]
-pub struct ProgramDescription {
+pub struct ProgramState {
     pub stack: Vec<types::StackFrame>,
     pub breakpoints: Vec<types::Breakpoint>,
     pub paused_frame: types::PausedFrame,
@@ -31,8 +31,8 @@ pub struct ProgramDescription {
 pub enum Event {
     Uninitialised,
     Initialised,
-    Paused(ProgramDescription),
-    ScopeChange(ProgramDescription),
+    Paused(ProgramState),
+    ScopeChange(ProgramState),
     Running,
     Ended,
 }
@@ -46,7 +46,7 @@ impl<'a> From<&'a DebuggerState> for Event {
                 paused_frame,
                 breakpoints,
                 ..
-            } => Event::Paused(ProgramDescription {
+            } => Event::Paused(ProgramState {
                 stack: stack.clone(),
                 paused_frame: *paused_frame.clone(),
                 breakpoints: breakpoints.clone(),

debugger/tests/debugger.rs

@@ -1,4 +1,4 @@
-use debugger::{Debugger, PausedFrame, ProgramDescription};
+use debugger::{Debugger, PausedFrame, ProgramState};
 use eyre::WrapErr;
 use std::{io::IsTerminal, thread, time::Duration};
 use tracing_subscriber::EnvFilter;
@@ -85,7 +85,7 @@ fn test_remote_attach() -> eyre::Result<()> {
         matches!(e, debugger::Event::Running { .. })
     });
 
-    let debugger::Event::Paused(ProgramDescription { paused_frame, .. }) =
+    let debugger::Event::Paused(ProgramState { paused_frame, .. }) =
         wait_for_event("paused event", &drx, |e| {
             matches!(e, debugger::Event::Paused { .. })
         })
@@ -159,7 +159,7 @@ fn test_debugger() -> eyre::Result<()> {
         matches!(e, debugger::Event::Running { .. })
     });
 
-    let debugger::Event::Paused(ProgramDescription { paused_frame, .. }) =
+    let debugger::Event::Paused(ProgramState { paused_frame, .. }) =
         wait_for_event("paused event", &drx, |e| {
             matches!(e, debugger::Event::Paused { .. })
         })

gui/src/main.rs

@@ -7,7 +7,7 @@ use std::{
 };
 
 use clap::Parser;
-use debugger::{AttachArguments, Debugger, LaunchArguments, PausedFrame, ProgramDescription};
+use debugger::{AttachArguments, Debugger, LaunchArguments, PausedFrame, ProgramState};
 use eframe::egui::{self, Visuals};
 use eyre::WrapErr;
 use launch_configuration::{ChosenLaunchConfiguration, Debugpy, LaunchConfiguration};
@@ -64,7 +64,7 @@ impl From<debugger::Event> for State {
     fn from(event: debugger::Event) -> Self {
         match event {
             debugger::Event::Initialised => State::Running,
-            debugger::Event::Paused(ProgramDescription {
+            debugger::Event::Paused(ProgramState {
                 stack,
                 paused_frame,
                 breakpoints,
@@ -76,7 +76,7 @@ impl From<debugger::Event> for State {
             debugger::Event::Running => State::Running,
             debugger::Event::Ended => State::Terminated,
             debugger::Event::Uninitialised => State::Initialising,
-            debugger::Event::ScopeChange(ProgramDescription {
+            debugger::Event::ScopeChange(ProgramState {
                 stack,
                 breakpoints,
                 paused_frame,

gui2/src/lib.rs

@@ -5,7 +5,7 @@ use clap::Parser;
 use code_view::{CodeViewer, CodeViewerAction};
 use color_eyre::eyre::{self, Context};
 use dark_light::Mode;
-use debugger::{AttachArguments, Debugger, Event, ProgramDescription};
+use debugger::{AttachArguments, Debugger, Event, ProgramState};
 use iced::keyboard::{Key, Modifiers};
 use iced::widget::{button, column, container, row, text, text_editor, Container};
 use iced::{
@@ -283,7 +283,7 @@ impl Application for DebuggerApp {
                 Message::DebuggerMessage(event) => match *event {
                     Event::Uninitialised => todo!(),
                     Event::Initialised => todo!(),
-                    Event::Paused(ProgramDescription {
+                    Event::Paused(ProgramState {
                         breakpoints, stack, ..
                     }) => {
                         self.state = AppState::Paused {

pythondap/src/debugger.rs

@@ -1,4 +1,4 @@
-use debugger::{AttachArguments, Event, LaunchArguments, PausedFrame, ProgramDescription};
+use debugger::{AttachArguments, Event, LaunchArguments, PausedFrame};
 use launch_configuration::{ChosenLaunchConfiguration, LaunchConfiguration};
 use pyo3::exceptions::PyRuntimeError;
 use pyo3::prelude::*;
@@ -264,7 +264,7 @@ impl Debugger {
         match self.internal_debugger.wait_for_event(|evt| {
             matches!(evt, Event::Paused { .. }) || matches!(evt, Event::Ended)
         }) {
-            Event::Paused(ProgramDescription {
+            Event::Paused(debugger::ProgramState {
                 stack,
                 paused_frame,
                 ..
@@ -291,7 +291,7 @@ impl Debugger {
         match self.internal_debugger.wait_for_event(|evt| {
             matches!(evt, Event::Paused { .. }) || matches!(evt, Event::Ended)
         }) {
-            Event::Paused(ProgramDescription {
+            Event::Paused(debugger::ProgramState {
                 stack,
                 paused_frame,
                 ..

repl/src/main.rs

@@ -5,14 +5,12 @@ use std::{io::Write, path::PathBuf};
 use clap::Parser;
 use color_eyre::eyre::{self, Context};
 use crossbeam_channel::Receiver;
-use debugger::Breakpoint;
-use debugger::Debugger;
-use debugger::ProgramDescription;
+use debugger::{Breakpoint, Debugger, ProgramState};
 use tracing_subscriber::filter::EnvFilter;
 
 struct App {
     debugger: Debugger,
-    program_description: Option<ProgramDescription>,
+    program_description: Option<ProgramState>,
     debugger_events: Receiver<debugger::Event>,
     input_rx: Receiver<String>,