-
Notifications
You must be signed in to change notification settings - Fork 0
/
serialterminal.cpp
699 lines (548 loc) · 22.9 KB
/
serialterminal.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
/***************************************************************************//**
* @file
* Serial Terminal
*
* @version @n 1.0
* @date @n 10/17/2013
*
* @author @n Kwabena W. Agyeman
* @copyright @n (c) 2013 Kwabena W. Agyeman
* @n All rights reserved - Please see the end of the file for the terms of use
*
* @par Update History:
* @n v1.0 - Original release - 10/17/2013
*******************************************************************************/
#include "serialterminal.h"
#include "ui_serialterminal.h"
SerialTerminal::SerialTerminal(const QString &title,
QSettings *settings, QWidget *parent) :
SerialWindow(title, settings, parent), m_ui(new Ui::SerialTerminal)
{
m_ui->setupUi(this); m_ui->statusBar->hide();
m_ui->rx->setMaximumBlockCount(TERMINAL_MAX_LINE_SIZE);
m_textCursor = m_ui->rx->textCursor(); m_brushColor = Qt::black;
m_stateMachine = ASCII; m_shiftReg = QByteArray(); getTabWidth();
connect(m_ui->tx, SIGNAL(returnPressed()),
this, SLOT(returnPressed()));
connect(m_ui->actionClear_Screen, SIGNAL(triggered()),
this, SLOT(clearScreen()));
connect(m_ui->actionSend_Text_File, SIGNAL(triggered()),
this, SLOT(sendTextFile()));
connect(m_ui->actionSave_Text_File, SIGNAL(triggered()),
this, SLOT(saveTextFile()));
connect(m_ui->actionClose_Window, SIGNAL(triggered()),
this, SLOT(close()));
connect(m_ui->actionGeneral_Help, SIGNAL(triggered()),
this, SLOT(generalHelp()));
connect(m_ui->actionTerminal_Help, SIGNAL(triggered()),
this, SLOT(terminalHelp()));
restoreState();
}
SerialTerminal::~SerialTerminal()
{
delete m_ui;
}
bool SerialTerminal::importExportEnabled() const
{
return false;
}
QString SerialTerminal::keyGroup() const
{
return SERIAL_TERMINAL_KEY_GROUP;
}
QString SerialTerminal::keyState() const
{
return SERIAL_TERMINAL_KEY_STATE;
}
QString SerialTerminal::keyGeometry() const
{
return SERIAL_TERMINAL_KEY_GEOMETRY;
}
void SerialTerminal::setTabWidth(int tabWidth)
{
QSettings settings(settingsFileName(), settingsFormat());
settings.beginGroup(keyGroup());
settings.beginGroup(windowTitle());
settings.setValue(SERIAL_TERMINAL_KEY_TAB_WIDTH, m_tabWidth = tabWidth);
}
int SerialTerminal::getTabWidth()
{
QSettings settings(settingsFileName(), settingsFormat());
settings.beginGroup(keyGroup());
settings.beginGroup(windowTitle());
return m_tabWidth =
settings.value(SERIAL_TERMINAL_KEY_TAB_WIDTH, TERMINAL_TAB_WIDTH).toInt();
}
void SerialTerminal::receive(const QByteArray &bytes)
{
QByteArray buffer; int column = m_textCursor.columnNumber();
for(int i = 0, j = bytes.size(); i < j; i++)
{
if((m_stateMachine == UTF8) && ((bytes.at(i) & 0xC0) != 0x80))
{
emit errorMessage(QString(metaObject()->className()) +
"::" + __FUNCTION__ + "[" + windowTitle() + "] -> " +
tr("Received invalid UTF8 character 0x%L1").
arg(QString(m_shiftReg.toHex())));
m_stateMachine = ASCII;
}
if((m_stateMachine == EXIT_0) && ((bytes.at(i) & 0xFF) != 0x00))
{
emit errorMessage(QString(metaObject()->className()) +
"::" + __FUNCTION__ + "[" + windowTitle() + "] -> " +
tr("Received invalid exit sequence 0x%L1").
arg(QString(m_shiftReg.toHex())));
m_stateMachine = ASCII;
}
switch(m_stateMachine)
{
case ASCII:
{
if(((bytes.at(i) & 0xE0) == 0xC0)
|| ((bytes.at(i) & 0xF0) == 0xE0)
|| ((bytes.at(i) & 0xF8) == 0xF0)
|| ((bytes.at(i) & 0xFC) == 0xF8)
|| ((bytes.at(i) & 0xFE) == 0xFC)) // UTF8
{
m_stateMachine = UTF8;
m_shiftReg.clear();
}
else if(!(bytes.at(i) & 128)) // ASCII
{
switch(bytes.at(i))
{
case CC_NULL: break;
case CC_HOME_CURSOR:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(QTextCursor::Start);
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_END_CURSOR:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(QTextCursor::End);
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_MOVE_CURSOR_LEFT:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(QTextCursor::Left);
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_MOVE_CURSOR_RIGHT:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(QTextCursor::Right);
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_MOVE_CURSOR_UP:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(QTextCursor::Up);
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_MOVE_CURSOR_DOWN:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(QTextCursor::Down);
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_BEEP_SPEAKER:
{
insertText(buffer); buffer.clear();
QApplication::beep(); break;
}
case CC_BACKSPACE:
{
insertText(buffer); buffer.clear();
m_textCursor.deletePreviousChar();
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_TAB:
{
for(int k=m_tabWidth-(column%m_tabWidth); k>0; k--)
{
buffer.append(' '); column += 1;
}
break;
}
case CC_LINE_FEED:
{
if(m_shiftReg.isEmpty()
|| (!m_shiftReg.endsWith('\r')))
{
buffer.append('\n'); column = 0;
}
break;
}
case CC_CLEAR_TO_END_OF_LINE:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(
QTextCursor::EndOfLine, QTextCursor::KeepAnchor);
m_textCursor.removeSelectedText();
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_CLEAR_LINES_BELOW:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(
QTextCursor::End, QTextCursor::KeepAnchor);
m_textCursor.removeSelectedText();
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_CARRIAGE_RETURN:
{
buffer.append('\n'); column = 0; break;
}
case CC_CLEAR_TO_START_OF_LINE:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(
QTextCursor::StartOfLine, QTextCursor::KeepAnchor);
m_textCursor.removeSelectedText();
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_CLEAR_LINES_ABOVE:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(
QTextCursor::Start, QTextCursor::KeepAnchor);
m_textCursor.removeSelectedText();
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_CLEAR_SCREEN:
{
insertText(buffer); buffer.clear();
m_ui->rx->clear();
m_textCursor = m_ui->rx->textCursor();
column = m_textCursor.columnNumber(); break;
}
case CC_XON: break;
case CC_SET_FOREGROUND_TO_GRAY:
{
insertText(buffer); buffer.clear();
m_brushColor = Qt::gray; break;
}
case CC_XOFF: break;
case CC_SET_FOREGROUND_TO_BLACK:
{
insertText(buffer); buffer.clear();
m_brushColor = Qt::black; break;
}
case CC_SET_FOREGROUND_TO_BLUE:
{
insertText(buffer); buffer.clear();
m_brushColor = Qt::blue; break;
}
case CC_SET_FOREGROUND_TO_RED:
{
insertText(buffer); buffer.clear();
m_brushColor = Qt::red; break;
}
case CC_SET_FOREGROUND_TO_GREEN:
{
insertText(buffer); buffer.clear();
m_brushColor = Qt::green; break;
}
case CC_SET_FOREGROUND_TO_MAGENTA:
{
insertText(buffer); buffer.clear();
m_brushColor = Qt::magenta; break;
}
case CC_SET_FOREGROUND_TO_CYAN:
{
insertText(buffer); buffer.clear();
m_brushColor = Qt::cyan; break;
}
case CC_SET_FOREGROUND_TO_YELLOW:
{
insertText(buffer); buffer.clear();
m_brushColor = Qt::yellow; break;
}
case CC_ESCAPE: break;
case CC_MOVE_TO_START_OF_LINE:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(
QTextCursor::StartOfLine);
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_MOVE_TO_END_OF_LINE:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(
QTextCursor::EndOfLine);
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_MOVE_TO_PREVIOUS_START_OF_LINE:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(
QTextCursor::PreviousBlock);
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_MOVE_TO_NEXT_START_OF_LINE:
{
insertText(buffer); buffer.clear();
m_textCursor.movePosition(
QTextCursor::NextBlock);
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
case CC_DELETE:
{
insertText(buffer); buffer.clear();
m_textCursor.deleteChar();
m_ui->rx->setTextCursor(m_textCursor);
column = m_textCursor.columnNumber(); break;
}
default:
{
buffer.append(bytes.at(i)); column += 1; break;
}
}
}
else if((bytes.at(i) & 0xFF) == 0xFF)
{
m_stateMachine = EXIT_0;
m_shiftReg.clear();
}
else
{
QByteArray buff = QByteArray().append(bytes.at(i));
emit errorMessage(QString(metaObject()->className()) +
"::" + __FUNCTION__ + "[" + windowTitle() + "] -> " +
tr("Received invalid ASCII character 0x%L1").
arg(QString(buff.toHex())));
}
break;
}
case UTF8:
{
if((((m_shiftReg.at(0)&0xE0)==0xC0)&&(m_shiftReg.size()>=1))
|| (((m_shiftReg.at(0)&0xF0)==0xE0)&&(m_shiftReg.size()>=2))
|| (((m_shiftReg.at(0)&0xF8)==0xF0)&&(m_shiftReg.size()>=3))
|| (((m_shiftReg.at(0)&0xFC)==0xF8)&&(m_shiftReg.size()>=4))
|| (((m_shiftReg.at(0)&0xFE)==0xFC)&&(m_shiftReg.size()>=5)))
{
buffer.append(m_shiftReg + bytes.at(i)); column += 1;
m_stateMachine = ASCII;
}
break;
}
case EXIT_0:
{
m_stateMachine = EXIT_1;
break;
}
case EXIT_1:
{
if(bytes.at(i))
{
QByteArray buff = QByteArray().append(bytes.at(i));
emit errorMessage(QString(metaObject()->className()) +
"::" + __FUNCTION__ + "[" + windowTitle() + "] -> " +
tr("Received exit failure status 0x%L1").
arg(QString(buff.toHex())));
}
break;
}
}
if(m_shiftReg.size() >= TERMINAL_SHIFT_REG)
{
for(int k = 1; k <= TERMINAL_SHIFT_REG; k++)
{
m_shiftReg[k - 1] =
(k == TERMINAL_SHIFT_REG) ? bytes.at(i) : m_shiftReg.at(k);
}
}
else
{
m_shiftReg.append(bytes.at(i));
}
}
insertText(buffer); buffer.clear();
}
void SerialTerminal::userReset()
{
clearScreen(); m_brushColor = Qt::black;
m_stateMachine = ASCII; m_shiftReg = QByteArray();
}
void SerialTerminal::returnPressed()
{
QString text = m_ui->tx->text() + "\r\n";
emit transmit(text.toUtf8(), this);
QBrush temp = m_brushColor; m_brushColor = Qt::black; insertText(text);
m_brushColor = temp; m_ui->tx->clear();
}
void SerialTerminal::clearScreen()
{
m_ui->rx->clear();
m_textCursor = m_ui->rx->textCursor();
}
void SerialTerminal::sendTextFile()
{
QSettings settings(settingsFileName(), settingsFormat());
settings.beginGroup(keyGroup());
settings.beginGroup(windowTitle());
QString openFile = settings.value(SERIAL_TERMINAL_KEY_OPEN_FILE,
QDir::homePath()).toString();
QString fileName = QFileDialog::getOpenFileName(this, tr("Send Text File"),
openFile, tr("Text Files (*.txt);;All Files (*)"));
if(!fileName.isEmpty())
{
QFileInfo fileInfo(fileName);
if(fileInfo.size() <= TERMINAL_MAX_FILE_SIZE)
{
QFile file(fileName);
if(file.open(QIODevice::ReadOnly | QIODevice::Text))
{
QByteArray data = file.readAll();
data.replace(CC_XON, "");
data.replace(CC_XOFF, "");
data.replace(CC_ESCAPE, "");
emit transmit(data, this);
settings.setValue(SERIAL_TERMINAL_KEY_OPEN_FILE,
fileInfo.canonicalFilePath());
}
else
{
QMessageBox::critical(this, tr("Send Text File Error"),
file.errorString());
}
}
else
{
QString title = tr("Send Text File Error"); QString text;
if(TERMINAL_MAX_FILE_SIZE >= ONE_GIGABYTE)
{
text = tr("The selected file size (%L1 GB(s)) is greater "
"than the maximum supported file size of %L2 GB(s)").
arg(double(fileInfo.size()) / ONE_GIGABYTE).
arg(double(TERMINAL_MAX_FILE_SIZE) / ONE_GIGABYTE);
}
else if(TERMINAL_MAX_FILE_SIZE >= ONE_MEGABYTE)
{
text = tr("The selected file size (%L1 MB(s)) is greater "
"than the maximum supported file size of %L2 MB(s)").
arg(double(fileInfo.size()) / ONE_MEGABYTE).
arg(double(TERMINAL_MAX_FILE_SIZE) / ONE_MEGABYTE);
}
else if(TERMINAL_MAX_FILE_SIZE >= ONE_KILOBYTE)
{
text = tr("The selected file size (%L1 KB(s)) is greater "
"than the maximum supported file size of %L2 KB(s)").
arg(double(fileInfo.size()) / ONE_KILOBYTE).
arg(double(TERMINAL_MAX_FILE_SIZE) / ONE_KILOBYTE);
}
else // if(TERMINAL_MAX_FILE_SIZE >= ONE_BYTE)
{
text = tr("The selected file size (%L1 byte(s)) is greater "
"than the maximum supported file size of %L2 byte(s)").
arg(double(fileInfo.size()) / ONE_BYTE).
arg(double(TERMINAL_MAX_FILE_SIZE) / ONE_BYTE);
}
QMessageBox::critical(this, title, text);
}
}
}
void SerialTerminal::saveTextFile()
{
QSettings settings(settingsFileName(), settingsFormat());
settings.beginGroup(keyGroup());
settings.beginGroup(windowTitle());
QString saveFile = settings.value(SERIAL_TERMINAL_KEY_SAVE_FILE,
QDir::homePath()).toString();
QString fileName = QFileDialog::getSaveFileName(this, tr("Save Text File"),
saveFile, tr("Text Files (*.txt);;All Files (*)"));
if(!fileName.isEmpty())
{
QFile file(fileName);
if(file.open(QIODevice::WriteOnly | QIODevice::Text))
{
QByteArray utf8 = m_ui->rx->toPlainText().toUtf8();
if(file.write(utf8) == utf8.size())
{
QFileInfo fileInfo(fileName);
settings.setValue(SERIAL_TERMINAL_KEY_SAVE_FILE,
fileInfo.canonicalFilePath());
}
else
{
QMessageBox::critical(this, tr("Save Text File Error"),
file.errorString());
}
}
else
{
QMessageBox::critical(this, tr("Save Text File Error"),
file.errorString());
}
}
}
void SerialTerminal::generalHelp()
{
if(!QDesktopServices::openUrl(QUrl("http://" PROJECT_DOMAIN_NAME_STR "/"
"help/general/")))
{
QMessageBox::critical(this, tr("Open General Help Error"),
tr("Unable to open the URL to the General Help page"));
}
}
void SerialTerminal::terminalHelp()
{
if(!QDesktopServices::openUrl(QUrl("http://" PROJECT_DOMAIN_NAME_STR "/"
"help/widgets/terminal/")))
{
QMessageBox::critical(this, tr("Open Terminal Help Error"),
tr("Unable to open the URL to the Terminal Help page"));
}
}
void SerialTerminal::insertText(const QString &text)
{
if(!text.isEmpty())
{
QTextCharFormat format = m_textCursor.charFormat();
format.setForeground(m_brushColor);
m_textCursor.setCharFormat(format);
m_textCursor.insertText(text);
m_ui->rx->setTextCursor(m_textCursor);
}
}
/***************************************************************************//**
* @file
* @par MIT License - TERMS OF USE:
* @n Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* @n
* @n The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
* @n
* @n THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*******************************************************************************/