-
Notifications
You must be signed in to change notification settings - Fork 0
/
DebugLogger.h
1432 lines (1226 loc) · 50.3 KB
/
DebugLogger.h
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
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#ifndef INCLUDE_DEBUG_LOGGER_H
#define INCLUDE_DEBUG_LOGGER_H
#include <iostream>
#include <ostream>
#include <map>
#include <string>
#include <string.h>
#include <stdarg.h>
#include <sstream>
#include <math.h>
#include <cmath>
#include "Timer.h"
#if defined(WIN32) | defined(__WIN32) || defined (_WIN32)
#define SPRINTF(buffer, format, value) sprintf_s(buffer, 128, format, value)
#elif defined(__unix__) || defined(__APPLE__)
#define SPRINTF(buffer, format, value) sprintf(buffer, format, value)
#endif
constexpr int OUTPUTFORMAT_DECIMAL = 0;
constexpr int OUTPUTFORMAT_HEX = 1;
constexpr int OUTPUTFORMAT_UPPERHEX = 2;
constexpr int OUTPUTFORMAT_BIN = 3;
constexpr int CAPITALIZEDFORMAT_NONE = 0;
constexpr int CAPITALIZEDFORMAT_CAPS = 1;
constexpr int CAPITALIZEDFORMAT_LOWER = 2;
/**
* Levels for debugging
* NONE: nothing is output
* TRACE: basic trace information
* WARNING: small non-critical errors (code can continue to run without problems)
* ERROR: large potentially problematic issues (code can probably run, but might crash)
* CRITICALERROR: errors that break the program. It should close
* */
enum class Level {
NONE,
LEVEL_TRACE,
LEVEL_WARNING,
LEVEL_ERROR,
CRITICAL_ERROR,
LEVEL_COUNT
};
/**
* all the valid types for debug variables
* INTEGER32: a 32 bit integer
* INTEGER64: a 64 bit integer
* FLOAT32: a 32 bit floating point value
* FLOAT64: a 64 bit floating point value
* STRING: an instance of std::string
* @author Bryce Young 5/19/2021
* */
enum class DebugVarType {
CHAR,
INTEGER32,
INTEGER64,
FLOAT32,
FLOAT64,
STRING,
DEBUGVAR_TYPE_COUNT
};
/**
* Class to interface with the logger
* CFG doc:
*
* Capitalize any output by prefixing with ^
*
* @author Bryce Young 5/20/2021
* */
class DebugLogger {
public:
DebugLogger(const std::string& loggerName = "Debug", Level level = Level::LEVEL_TRACE)
:level(level),
targetStream(&std::cout)
{
this->loggerName = loggerName;
this->level = level;
totalNanoseconds = 0;
for(int i = 0; i <= (int)Level::LEVEL_COUNT; ++i) {
messageCount[i] = 0;
}
levelNames[(int)Level::LEVEL_TRACE] = "TCE";
levelNames[(int)Level::LEVEL_WARNING] = "WNG";
levelNames[(int)Level::LEVEL_ERROR] = "ERR";
levelNames[(int)Level::CRITICAL_ERROR] = "CRT";
levelNames[(int)Level::LEVEL_COUNT] = levelNames[(int)Level::LEVEL_TRACE];
//add default variables
//th = time hours
//tm = time minutes
//ts = time seconds
//tl = time milliseconds
//ti = time microseconds
addInternalVariable("th", timeVars + 0, DebugVarType::FLOAT64);
addInternalVariable("tm", timeVars + 1, DebugVarType::FLOAT64);
addInternalVariable("ts", timeVars + 2, DebugVarType::FLOAT64);
addInternalVariable("tl", timeVars + 3, DebugVarType::FLOAT64);
addInternalVariable("ti", timeVars + 4, DebugVarType::FLOAT64);
//eth = elapsed time hours
//etm = elapsed time minutes
//ets = elapsed time seconds
//etl = elapsed time milliseconds
//eti = elapsed time microseconds
addInternalVariable("eth", elapsedTimeVars + 0, DebugVarType::FLOAT64);
addInternalVariable("etm", elapsedTimeVars + 1, DebugVarType::FLOAT64);
addInternalVariable("ets", elapsedTimeVars + 2, DebugVarType::FLOAT64);
addInternalVariable("etl", elapsedTimeVars + 3, DebugVarType::FLOAT64);
addInternalVariable("eti", elapsedTimeVars + 4, DebugVarType::FLOAT64);
//the name of the logger program
addInternalVariable("pn", &this->loggerName, DebugVarType::STRING);
//the name of the levels
//tn = trace name
//wn = warning name
//en = error name
//cn = critical name
//ln = current level name
addInternalVariable("tn", &this->levelNames[(int)Level::LEVEL_TRACE], DebugVarType::STRING);
addInternalVariable("wn", &this->levelNames[(int)Level::LEVEL_WARNING], DebugVarType::STRING);
addInternalVariable("en", &this->levelNames[(int)Level::LEVEL_ERROR], DebugVarType::STRING);
addInternalVariable("cn", &this->levelNames[(int)Level::CRITICAL_ERROR], DebugVarType::STRING);
addInternalVariable("ln", &this->levelNames[(int)Level::LEVEL_COUNT], DebugVarType::STRING);
//variables for message count
//dmc stands for debug message count
addInternalVariable("dmc", &messageCount[(int)Level::LEVEL_COUNT], DebugVarType::INTEGER64);
//tmc stands for trace message count
//wmc warning message count
//emc error message count
//cmc critical messageCount
addInternalVariable("tmc", &messageCount[(int)Level::LEVEL_TRACE], DebugVarType::INTEGER64);
addInternalVariable("wmc", &messageCount[(int)Level::LEVEL_WARNING], DebugVarType::INTEGER64);
addInternalVariable("emc", &messageCount[(int)Level::LEVEL_ERROR], DebugVarType::INTEGER64);
addInternalVariable("cmc", &messageCount[(int)Level::CRITICAL_ERROR], DebugVarType::INTEGER64);
//level message count
addInternalVariable("lmc", ¤tMessageCount, DebugVarType::INTEGER64);
//helpful characters
addInternalVariable("lbc", &specialCharacters[0], DebugVarType::CHAR);
addInternalVariable("rbc", &specialCharacters[1], DebugVarType::CHAR);
addInternalVariable("lbk", &specialCharacters[2], DebugVarType::CHAR);
addInternalVariable("rbk", &specialCharacters[3], DebugVarType::CHAR);
addInternalVariable("bks", &specialCharacters[4], DebugVarType::CHAR);
//char pnemonics
reserves["char"] = Token::TokenType::SIGNED_CHAR;
reserves["ch"] = Token::TokenType::SIGNED_CHAR;
reserves["c"] = Token::TokenType::SIGNED_CHAR;
//int pnemonics
reserves["int"] = Token::TokenType::SIGNED_INT;
reserves["i"] = Token::TokenType::SIGNED_INT;
reserves["d"] = Token::TokenType::SIGNED_INT;
reserves["uint"] = Token::TokenType::SIGNED_INT;
reserves["ui"] = Token::TokenType::SIGNED_INT;
reserves["u"] = Token::TokenType::SIGNED_INT;
//long pneumonics
reserves["long"] = Token::TokenType::SIGNED_LONG;
reserves["llu"] = Token::TokenType::SIGNED_LONG;
reserves["ulong"] = Token::TokenType::SIGNED_LONG;
reserves["ul"] = Token::TokenType::SIGNED_LONG;
//float pnemoinics
reserves["float"] = Token::TokenType::FLOAT;
reserves["flt"] = Token::TokenType::FLOAT;
reserves["f"] = Token::TokenType::FLOAT;
//str pneumonics
reserves["string"] = Token::TokenType::STRING;
reserves["str"] = Token::TokenType::STRING;
reserves["s"] = Token::TokenType::STRING;
setPrefix("[3ln]~[.2etl] \\[[>05lmc]\\]: ");
timer.reset();
}
~DebugLogger() {
}
void setTargetOutput(std::ostream* outputStream) {
this->targetStream = outputStream;
}
/**
* Returns the level of the debugger
* */
Level getLevel() const {
return level;
}
/**
* Updates level
* @param newLevel: the new level
* */
void setLevel(Level newLevel) {
this->level = newLevel;
}
void setColorTrace(std::ostream& outputStream) {
if(enableColor) {
previousColor = "\033[1m\033[32m"; //dark green
//outputStream << "\033[34m"; //blue
//outputStream << "\033[32m"; //green
//outputStream << "\033[1m\033[34m"; //dark blue
outputStream << previousColor;
}
}
void setColorWarning(std::ostream& outputStream) {
if(enableColor) {
//outputStream << "\033[33m"; //yellow
previousColor = "\033[1m\033[33m"; //dark yellow
outputStream << previousColor;
}
}
void setColorError(std::ostream& outputStream) {
if(enableColor) {
//outputStream << "\033[31m"; //red
previousColor = "\033[1m\033[31m"; //dark red
outputStream << previousColor;
}
}
void setColorCritical(std::ostream& outputStream) {
if(enableColor) {
previousColor = "\033[1m\033[31m"; //dark red
outputStream << previousColor;
}
}
void resetColor(std::ostream& outputStream) {
if (enableColor) {
previousColor = "\033[0m";
outputStream << previousColor;
}
}
void setColorEnabled() {
this->enableColor = true;
}
void setColorDisabled() {
this->enableColor = false;
}
bool getColorEnabled() {
return this->enableColor;
}
/**
* There exist various variables which the prefix uses
* To use a variable, use two braces and write the name of the variable inside; constrast from the {} used for printing parameters passed into the function
* [ var_name ] -> with or without the spaces, it doesn't matter
* Basic formatting options within the braces apply
* Applies the prefix to all levels if @param targetLevel is omitted
* */
void setPrefix(const std::string& prefix, Level targetLevel = Level::LEVEL_COUNT) {
if(targetLevel == Level::LEVEL_COUNT) {
this->prefixFormat[(int)Level::LEVEL_TRACE] = prefix;
this->prefixFormat[(int)Level::LEVEL_WARNING] = prefix;
this->prefixFormat[(int)Level::LEVEL_ERROR] = prefix;
this->prefixFormat[(int)Level::CRITICAL_ERROR] = prefix;
}
else if(targetLevel < Level::LEVEL_COUNT && targetLevel >= Level::LEVEL_TRACE){
this->prefixFormat[(int)targetLevel] = prefix;
}
}
int trace(const char* format, ...) {
int ret = 0;
va_list args;
va_start(args, format);
//set trace vars
if(updateLogger(Level::LEVEL_TRACE)) {
setTrace(*this->targetStream);
ret = logInternal(*this->targetStream, format, args);
}
resetColor(*this->targetStream);
va_end(args);
return ret;
}
int traceToStream(std::ostream& output, const char* format, ...) {
int ret = 0;
va_list args;
va_start(args, format);
//set trace vars
if(updateLogger(Level::LEVEL_TRACE)) {
setTrace(output);
ret = logInternal(output, format, args);
}
resetColor(output);
va_end(args);
return ret;
}
int warning(const char* format, ...) {
int ret = 0;
va_list args;
va_start(args, format);
if(updateLogger(Level::LEVEL_WARNING)) {
setWarning(*this->targetStream);
ret = logInternal(*this->targetStream, format, args);
}
resetColor(*this->targetStream);
va_end(args);
return ret;
}
int warningToStream(std::ostream& output, const char* format, ...) {
int ret = 0;
va_list args;
va_start(args, format);
if(updateLogger(Level::LEVEL_WARNING)) {
setWarning(output);
ret = logInternal(output, format, args);
}
resetColor(output);
va_end(args);
return ret;
}
int error(const char* format, ...) {
int ret = 0;
va_list args;
va_start(args, format);
if(updateLogger(Level::LEVEL_ERROR)) {
setError(*this->targetStream);
ret = logInternal(*this->targetStream, format, args);
}
resetColor(*this->targetStream);
va_end(args);
return ret;
}
int errorToStream(std::ostream& output, const char* format, ...) {
int ret = 0;
va_list args;
va_start(args, format);
if(updateLogger(Level::LEVEL_ERROR)) {
setError(output);
ret = logInternal(output, format, args);
}
resetColor(output);
va_end(args);
return ret;
}
int critical(const char* format, ...) {
int ret = 0;
va_list(args);
va_start(args, format);
if(updateLogger(Level::CRITICAL_ERROR)) {
setCritical(*this->targetStream);
ret = logInternal(*this->targetStream, format, args);
}
resetColor(*this->targetStream);
va_end(args);
return ret;
}
int criticalToStream(std::ostream& output, const char* format, ...) {
int ret = 0;
va_list(args);
va_start(args, format);
if(updateLogger(Level::CRITICAL_ERROR)) {
setCritical(output);
ret = logInternal(output, format, args);
}
resetColor(output);
va_end(args);
return ret;
}
/**
* Updates times and message counts
* */
inline bool updateLogger(Level lev) {
if(this->level <= lev) {
messageCount[(int)lev]++;
messageCount[(int)Level::LEVEL_COUNT]++;
//update timers (hrs, mins, seconds, millis, microseconds)
uint64_t elapsedNanos = timer.nanoseconds();
totalNanoseconds += elapsedNanos;
timeVars[0] = (double)totalNanoseconds / 3.6e12;
timeVars[1] = (double)totalNanoseconds / 6e10;
timeVars[2] = (double)totalNanoseconds / 1e9;
timeVars[3] = (double)totalNanoseconds / 1e6;
timeVars[4] = (double)totalNanoseconds / 1000;
elapsedTimeVars[0] = (double)elapsedNanos / 3.6e12;
elapsedTimeVars[1] = (double)elapsedNanos / 6e10;
elapsedTimeVars[2] = (double)elapsedNanos / 1e9;
elapsedTimeVars[3] = (double)elapsedNanos / 1e6;
elapsedTimeVars[4] = (double)elapsedNanos / 1000;
timer.reset();
return true;
}
return false;
}
inline void setTrace(std::ostream& output) {
//set trace vars
setColorTrace(output);
levelNames[(int)Level::LEVEL_COUNT] = levelNames[(int)Level::LEVEL_TRACE];
currentMessageCount = messageCount[(int)Level::LEVEL_TRACE];
}
inline void setWarning(std::ostream& output) {
setColorWarning(output);
levelNames[(int)Level::LEVEL_COUNT] = levelNames[(int)Level::LEVEL_WARNING];
currentMessageCount = messageCount[(int)Level::LEVEL_WARNING];
}
inline void setError(std::ostream& output) {
setColorError(output);
levelNames[(int)Level::LEVEL_COUNT] = levelNames[(int)Level::LEVEL_ERROR];
currentMessageCount = messageCount[(int)Level::LEVEL_ERROR];
}
inline void setCritical(std::ostream& output) {
setColorCritical(output);
levelNames[(int)Level::LEVEL_COUNT] = levelNames[(int)Level::CRITICAL_ERROR];
currentMessageCount = messageCount[(int)Level::CRITICAL_ERROR];
}
/**
* adds a variable to the debugger
* @param name the name to which the variable will be referred
* @param variable the variable value as a void*
* @param type the variable type, one of the section from the enum
* @return true if the variable was added successfully, false if the variable is conflicting with other variables
* */
bool addVariable(const std::string& name, void* variable, DebugVarType type) {
//validate variable
const char* varName = name.c_str();
int index = 0;
if(isAlpha(varName, index) || varName[0] == '_') {
index++;
while(varName[index] && (isAlpha(varName, index) || varName[index] == '_' || isNum(varName, index))) {
index++;
}
if(index == name.size()) {
if(variables.find(name) == variables.end()) {
variables.emplace(std::pair<std::string, DebugVar>({name, DebugVar(type, variable)}));
return true;
}
}
}
//improper var name or something
return false;
}
/**
* Removes a variable from the list
* @param name the name of the variable to remove
* @return true if the variable existed and is now removed, false if the variable never existed
* */
bool removeVariable(const std::string& name) {
std::map<std::string, DebugVar>::iterator v = variables.find(name);
if(v != variables.end() && !v->second.getReadonly()) {
variables.erase(v);
return true;
}
return false;
}
private:
/**
* Adds a variable that cannot be removed
* */
bool addInternalVariable(const std::string& name, void* variable, DebugVarType type) {
if(variables.find(name) == variables.end()) {
variables.emplace(std::pair<std::string, DebugVar>({name, DebugVar(type, variable, true)}));
return true;
}
return false;
}
/**
* Internal method to handle logging
* @param output the output stream to write to
* @param format the print format
* @param args the va arguments as a reference
* @param level the current log level
* */
inline int logInternal(std::ostream& output, const char* format, va_list& args, bool recursive = false) {
std::stringstream outputLine;
//print prefix to message using only internal variables
if(!recursive) {
printPrefix(outputLine, level, args);
}
//set color (trace color)
int len = (int)strlen(format);
int formatIndex = 0;
int previousFormatIndex = -1;
//process and print arguments
while(printNext(outputLine, format, formatIndex, args) && formatIndex < len && formatIndex != previousFormatIndex) {
previousFormatIndex = formatIndex;
}
if(!recursive) {
outputLine << "\n";
}
output << outputLine.str();
return (int)outputLine.str().size();
}
/**
* contains information representing a token
* */
struct Token {
enum class TokenType {
CAPITAL,
LOWER,
RIGHT,
FORMATTED_STRING,
FILL_ZERO,
ZERO_DECIMALS,
VARIABLE_NAME,
FLOAT,
UNSIGNED_MARK,
SIGNED_CHAR,
SIGNED_SHORT,
SIGNED_INT,
SIGNED_LONG,
STRING,
NUMBER,
DECIMAL,
HEX_MODIFIER,
CAPITAL_HEX_MODIFIER,
BINARY_MODIFIER
};
const char* lexemeStart, *lexemeEnd;
TokenType type;
};
Token currentToken;
/**
* Loads the next identifier
* */
bool getIdentifier(const char* format, int& index) {
if(isAlpha(format, index) || format[index] == '_') {
}
else {
return false;
}
currentToken.type = Token::TokenType::VARIABLE_NAME;
currentToken.lexemeStart = format + index;
while(format[index] && (isAlpha(format, index) || format[index] == '_' || isNum(format, index))) {
index++;
}
currentToken.lexemeEnd = format + index;
return true;
}
/**
* Returns if the character can be part of an identifier or not
* */
bool isPartOfIdentifier(char c) {
return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || c == '_' || (c >= '0' && c <= '9');
}
/**
* Returns the next one or two character token
* */
bool getNextToken(const char* format, int& index, char end) {
skipWhitespace(format, index);
if(format[index] == '^') {
currentToken.type = Token::TokenType::CAPITAL;
currentToken.lexemeStart = format + index;
currentToken.lexemeEnd = format + index + 1;
index++;
return true;
}
if(format[index] == '0') {
currentToken.type = Token::TokenType::FILL_ZERO;
currentToken.lexemeStart = format + index;
currentToken.lexemeEnd = format + index + 1;
index++;
return true;
}
if(format[index] == '$') {
currentToken.type = Token::TokenType::LOWER;
currentToken.lexemeStart = format + index;
currentToken.lexemeEnd = format + index + 1;
index++;
return true;
}
if(format[index] == '>') {
currentToken.type = Token::TokenType::RIGHT;
currentToken.lexemeStart = format + index;
currentToken.lexemeEnd = format + index + 1;
index++;
return true;
}
else if(format[index] == '+') {
currentToken.type = Token::TokenType::UNSIGNED_MARK;
currentToken.lexemeStart = format + index;
currentToken.lexemeEnd = format + index + 1;
index++;
return true;
}
else if(format[index] == '.') {
currentToken.type = Token::TokenType::DECIMAL;
currentToken.lexemeStart = format + index;
currentToken.lexemeEnd = format + index + 1;
index++;
//if its .0, then it counts as a single token
if(format[index] == '0') {
currentToken.type = Token::TokenType::ZERO_DECIMALS;
currentToken.lexemeEnd++;
index++;
}
return true;
}
else if(format[index] == 'x' && !isPartOfIdentifier(format[index + 1])) {
currentToken.type = Token::TokenType::HEX_MODIFIER;
currentToken.lexemeStart = format + index;
currentToken.lexemeEnd = format + index + 1;
index++;
return true;
}
else if(format[index] == 'X' && !isPartOfIdentifier(format[index + 1])) {
currentToken.type = Token::TokenType::CAPITAL_HEX_MODIFIER;
currentToken.lexemeStart = format + index;
currentToken.lexemeEnd = format + index + 1;
index++;
return true;
}
else if(format[index] == 'b' && !isPartOfIdentifier(format[index + 1])) {
currentToken.type = Token::TokenType::BINARY_MODIFIER;
currentToken.lexemeStart = format + index;
currentToken.lexemeEnd = format + index + 1;
index++;
return true;
}
else if(isNum(format, index)) {
getNumber(format, index);
return true;
}
else if(format[index] == '\'') {
char start = (end == ']')? '[' : '{';
//increment index because the start of the string doesn't include the quote
index++;
currentToken.type = Token::TokenType::FORMATTED_STRING;
currentToken.lexemeStart = format + index;
currentToken.lexemeEnd = currentToken.lexemeStart;
//load the string until the closing brace is found
int depth = 1;
while(depth > 0 && format[index]) {
if(format[index] == '\\') {
if(format[index + 1]) {
index++;
}
}
else if(format[index] == end) {
depth--;
}
else if(format[index] == start) {
depth++;
}
index++;
}
//we have to move to the previous close because the program is looking for a close brace
index--;
currentToken.lexemeEnd = format + index;
return true;
}
else if(getIdentifier(format, index)) {
//check to see if the identifier was actually a reserve
std::string v(currentToken.lexemeStart, currentToken.lexemeEnd);
return true;
}
else {
//error of some kind
return false;
}
}
/**
* Returns the next number
* */
void getNumber(const char* format, int& index) {
currentToken.type = Token::TokenType::NUMBER;
currentToken.lexemeStart = format + index;
while(isNum(format, index)) {
index++;
}
currentToken.lexemeEnd = format + index;
}
/**
* Enumerates all formatting options supplied by the user
* */
void collectFormattingOptions(const char* format, int& index, int& capitalized, bool& rightAligned, bool& unsignedValue, std::string& v, int& spaceCount, int& spaceCount_dec, bool& fillZero, int& outputFormat, std::string& formattedString, char end) {
bool foundDecimal = false;
//implement variable grammar here
index++;
while(format[index] != end && format[index]) {
if(!getNextToken(format, index, end)) {
break;
}
if(currentToken.type == Token::TokenType::CAPITAL) {
capitalized = CAPITALIZEDFORMAT_CAPS;
}
else if(currentToken.type == Token::TokenType::LOWER) {
capitalized = CAPITALIZEDFORMAT_LOWER;
}
else if(currentToken.type == Token::TokenType::RIGHT) {
rightAligned = true;
}
else if(currentToken.type == Token::TokenType::FILL_ZERO) {
fillZero = true;
}
else if(currentToken.type == Token::TokenType::NUMBER) {
int value = 0;
std::string lexeme(currentToken.lexemeStart, currentToken.lexemeEnd);
value = std::stoi(lexeme);
if(foundDecimal) {
foundDecimal = false;
spaceCount_dec = value;
}
else {
spaceCount = value;
}
}
else if(currentToken.type == Token::TokenType::ZERO_DECIMALS) {
spaceCount_dec = 0;
}
else if(currentToken.type == Token::TokenType::DECIMAL) {
foundDecimal = true;
}
else if(currentToken.type == Token::TokenType::UNSIGNED_MARK) {
unsignedValue = true;
}
else if(currentToken.type == Token::TokenType::HEX_MODIFIER) {
outputFormat = OUTPUTFORMAT_HEX;
}
else if(currentToken.type == Token::TokenType::CAPITAL_HEX_MODIFIER) {
outputFormat = OUTPUTFORMAT_UPPERHEX;
}
else if(currentToken.type == Token::TokenType::BINARY_MODIFIER) {
outputFormat = OUTPUTFORMAT_BIN;
}
else if(currentToken.type == Token::TokenType::FORMATTED_STRING) {
formattedString = std::string(currentToken.lexemeStart, currentToken.lexemeEnd);
if(formattedString.size() == 0) {
formattedString = " ";
}
}
else {
v = std::string(currentToken.lexemeStart, currentToken.lexemeEnd);
}
skipWhitespace(format, index);
}
}
/**
* Prints the variable
* */
void printVariable(std::ostream& output, const char* format, int& index, va_list& args) {
//0 for no change, 1 for upper, 2 for lower
int capitalized = CAPITALIZEDFORMAT_NONE;
bool rightAligned = false;
bool unsignedValue = false;
std::string variableName;
std::string formattedString;
int setSpaceCount = -1;
int setSpaceCount_dec = -1;
bool fillZero = false;
int outputFormat = OUTPUTFORMAT_DECIMAL;
collectFormattingOptions(format, index, capitalized, rightAligned, unsignedValue, variableName, setSpaceCount, setSpaceCount_dec, fillZero, outputFormat, formattedString, ']');
//now that we have reached the end, we can go ahead and print the variable
//lets check if it exists first
std::map<std::string, DebugVar>::iterator var = variables.find(variableName);
//if the formatted string specifier is set, it overrides the argument specifier
if(formattedString.size() > 0) {
std::stringstream nextOutput;
logInternal(nextOutput, formattedString.c_str(), args, true);
printFormattedString(output, nextOutput.str().c_str(), capitalized, rightAligned, setSpaceCount);
}
else if(var != variables.end()) {
switch(var->second.getType()) {
case DebugVarType::CHAR:
{
char value = var->second.getChar();
printFormattedChar(output, value, capitalized, rightAligned, setSpaceCount);
}
break;
case DebugVarType::INTEGER32:
{
uint32_t value = var->second.getInt32();
printFormattedInteger(output, value, rightAligned, setSpaceCount, outputFormat, unsignedValue, fillZero, false);
}
break;
case DebugVarType::INTEGER64:
{
uint64_t value = var->second.getInt64();
printFormattedInteger(output, value, rightAligned, setSpaceCount, outputFormat, unsignedValue, fillZero, true);
}
break;
case DebugVarType::FLOAT32:
{
float value = var->second.getFloat32();
printFormattedFloat(output, value, rightAligned, setSpaceCount, setSpaceCount_dec, fillZero);
}
break;
case DebugVarType::FLOAT64:
{
double value = var->second.getFloat64();
printFormattedFloat(output, value, rightAligned, setSpaceCount, setSpaceCount_dec, fillZero);
}
break;
case DebugVarType::STRING:
{
const char* value = var->second.getString();
printFormattedString(output, value, capitalized, rightAligned, setSpaceCount);
}
break;
}
}
}
/**
* Reverses a string
* @param buffer the buffer to reverse
* @param len the length of the contents of the string
* */
void reverseString(char* buffer, int len) {
//reverse the string in place
char* begin = buffer, *end = buffer + len - 1;
while(begin < end) {
char tmp = *begin;
*begin = *end;
*end = tmp;
begin++;
end--;
}
}
/**
* Prints hex to a buffer
* @param spaces indicates the min number of digits
* @param fill the character to fill the empty spaces with
* @return the length of the string
* */
int printHexToBuffer(char* buffer, uint64_t value, bool upperFlag) {
char hexChars[] = "0123456789abcdef";
char capHexChars[] = "0123456789ABCDEF";
char* charset = upperFlag? capHexChars : hexChars;
int index = 0;
do{
int digit = value % 16;
buffer[index++] = charset[digit];
value /= 16;
} while(value);
buffer[index] = 0;
reverseString(buffer, index);
return index;
}
int printBinToBuffer(char* buffer, uint64_t value) {
char charset[3] = "01";
int index = 0;
do {
int digit = value % 2;
buffer[index++] = charset[digit];
value /= 2;
} while(value);
buffer[index] = 0;
reverseString(buffer, index);
return index;
}
double powers10[10] = { 10, 100, 1000, 10000, 100000, 1000000, 10000000, 100000000, 1000000000, 10000000000 };
void printFormattedFloat(std::ostream& output, double value, bool right, int spaces, int decSpaces, bool fillZero) {
decSpaces = (decSpaces == -1)? 10 : decSpaces;
int tmpDecSpaces = decSpaces;
decSpaces = std::max(0, decSpaces);
decSpaces = std::min(10, decSpaces);
if(decSpaces > 0) {
double power = powers10[decSpaces - 1];
//truncate the multiplication by the power
value = (value * power);
value = std::trunc((value + .5));
value /= power;
}
else if(decSpaces == 0) {
value = std::trunc((value + .5));
}
decSpaces = tmpDecSpaces;
std::string toPrint(std::to_string(value));
int decLoc = (int)toPrint.find('.');
int len = 0;
if(decLoc != -1) {
len = decLoc + decSpaces + (decSpaces != 0);
}
else {
//if the decimal point doesn't exist in the string, there are no decimal places (not relying on std::to_string to add trailing decimals)
len = (int)toPrint.size();
if(decSpaces != 0) {
len += decSpaces + 1;
toPrint += '.';
}
}
//format it right if necessary
if(right) {
for(int i = 0; i < spaces - len; ++i) {
if(fillZero) {
output << '0';
}
else {