Skip to content

#1404 Serial Monitor message history #1467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

#1404 Serial Monitor message history #1467

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0c8bc7
Serial Monitor message history #1404
dwightfowler-cd Sep 17, 2022
1dc5e58
Addressed PR#1453 comments
dwightfowler-cd Sep 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 82 additions & 1 deletion arduino-ide-extension/src/browser/serial/monitor/serial-monitor-send-input.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,74 @@ import { BoardsServiceProvider } from '../../boards/boards-service-provider';
import { MonitorModel } from '../../monitor-model';
import { Unknown } from '../../../common/nls';

class RingList {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RingList implies that message history is a cycle.

With the following sent messages:

  • one,
  • two, and
  • three.

I would expect to get three after one. But no, so the class name is wrong.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. I debated with myself over that name. I'm changing it to HistoryStack. It's more descriptive.

private ring: string[];
private size: number;
private begin: number;
private index: number;
private end: number;

constructor(size: number = 100) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be constructor(size = 100) {.

this.init = this.init.bind(this);
this.push = this.push.bind(this);
this.prev = this.prev.bind(this);
this.next = this.next.bind(this);
this.init(size);
}

private init(size: number = 100)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be private init(size = 100) {

Please respect the position of the curly braces.

{
this.ring = [];
this.size = (size > 0) ? size : 1;
this.begin = 0;
this.index = 0;
this.end = -1;
}

push(val: string): number {
this.end++;
if (this.ring.length >= this.size)
{
if (this.end >= this.size)
this.end = 0;
if (this.end === this.begin)
{
this.begin++;
if (this.begin >= this.size)
this.begin = 0;
}
}
this.ring[this.end] = val;
this.index = this.end;

return this.index;
}

prev(): string {
if (this.ring.length < 1) {
return '';
}

if (this.index !== this.begin) {
this.index = (this.index > 0) ? --this.index : this.size - 1;
}

return this.ring[this.index];
}

next(): string {
if (this.ring.length < 1) {
return '';
}

if (this.index !== this.end) {
this.index = (++this.index < this.size) ? this.index : 0;
}

return this.ring[this.index];
}
}

export namespace SerialMonitorSendInput {
export interface Props {
readonly boardsServiceProvider: BoardsServiceProvider;
Expand All @@ -16,6 +84,7 @@ export namespace SerialMonitorSendInput {
export interface State {
text: string;
connected: boolean;
history: RingList;
}
}

Expand All @@ -27,7 +96,7 @@ export class SerialMonitorSendInput extends React.Component<

constructor(props: Readonly<SerialMonitorSendInput.Props>) {
super(props);
this.state = { text: '', connected: true };
this.state = { text: '', connected: true, history: new RingList() };
this.onChange = this.onChange.bind(this);
this.onSend = this.onSend.bind(this);
this.onKeyDown = this.onKeyDown.bind(this);
Expand Down Expand Up @@ -110,7 +179,19 @@ export class SerialMonitorSendInput extends React.Component<
if (keyCode) {
const { key } = keyCode;
if (key === Key.ENTER) {
// NOTE: order of operations is critical here. Push the current state.text
// onto the history stack before sending. After sending, state.text is empty
// and you'd end up pushing '' onto the history stack.
if (this.state.text.length > 0) {
this.state.history.push(this.state.text);
}
this.onSend();
}
else if (key === Key.ARROW_UP) {
this.setState({ text: this.state.history.prev()});
}
else if (key === Key.ARROW_DOWN) {
this.setState({ text: this.state.history.next()});
}
}
}
Expand Down