Skip to content

Commit

Permalink
Update and rename printbugger_docs.md to probelog_docs.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JoeAtHPI committed May 9, 2023
1 parent fcd4f37 commit 9c796eb
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions printbugger_docs.md → probelog_docs.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Interactions

## Open
- Execute `BPPrintbugger open`
- In a `BPBrowser`, click on `side pane`>`BPPrintbugger`
- Execute `BPProbeLog open`
- In a `BPBrowser`, click on `side pane`>`BPProbeLog`
- Click on an example's extented menu (...)

## Adding & Removing Examples
Expand Down Expand Up @@ -49,23 +49,23 @@ Detailed documentation on the classes can be found in their responding class com
![image](https://user-images.githubusercontent.com/33000454/158612243-583c1bd5-92b5-4174-8713-e46ca7b2069c.png)


## BPPrintbugger
Left to right collection of all `BPPrintbuggerColumnMorphs`. Has a global context with `BPPrintbuggerContext`
## BPProbeLog
Left to right collection of all `BPBPProbeLogColumnMorphs`. Has a global context with `BPBPProbeLogContext`

## BPPrintbuggerContext
## BPBPProbeLogContext
Saves all methods of multiple traces to have a consistent color mapping for the flame graphs used by `BPSwimlaneLineMorph`. Also knows which annotations of an example should be hidden in the visualization.

## BPPrintbuggerColumnMorph
One column in the Printbugger, containing a button and a `BPSwimlane`. Responsible for the switch logic, for example, displaying the selected example from the menu as a swimlane or deleting itself when `none` is selected.
## BPBPProbeLogColumnMorph
One column in the BPProbeLog, containing a button and a `BPSwimlane`. Responsible for the switch logic, for example, displaying the selected example from the menu as a swimlane or deleting itself when `none` is selected.

## BPNilExample
The `none` option for the displayed menu when selecting an example in `BPPrintbuggerColumnMorph`. Doesn't result in a swimlane and might delete a `BPPrintbuggerColumnMorph` when excessive.
The `none` option for the displayed menu when selecting an example in `BPBPProbeLogColumnMorph`. Doesn't result in a swimlane and might delete a `BPBPProbeLogColumnMorph` when excessive.

## BPSwimlane
Display of an example's trace values in chronological order. Listens to the given example trace's update events and updates accordingly. A top to bottom collection of `BPSwimlaneLineMorph`. Has a `BPPrintbuggerContext` to pass on.
Display of an example's trace values in chronological order. Listens to the given example trace's update events and updates accordingly. A top to bottom collection of `BPSwimlaneLineMorph`. Has a `BPBPProbeLogContext` to pass on.

## BPSwimlaneLineMorph
Responsible for displaying a trace value and creating the UI for its possible interactions / additional information. The halt button, method call stacks, label, filter etc.. Sets flame graph colors and hides values using the `BPPrintbuggerContext` of its belonging `BPSwimlane`.
Responsible for displaying a trace value and creating the UI for its possible interactions / additional information. The halt button, method call stacks, label, filter etc.. Sets flame graph colors and hides values using the `BPBPProbeLogContext` of its belonging `BPSwimlane`.

## BPLabelMorph
The label of a trace value extended with deletion, a backup label and downsize (when filtered) logic.

0 comments on commit 9c796eb

Please sign in to comment.