DebStream.cc 23.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
// (C) Copyright 2014 by Autodesk, Inc.
//
// The information contained herein is confidential, proprietary
// to Autodesk,  Inc.,  and considered a trade secret as defined
// in section 499C of the penal code of the State of California.
// Use of  this information  by  anyone  other  than  authorized
// employees of Autodesk, Inc.  is granted  only under a written
// non-disclosure agreement,  expressly  prescribing  the  scope
// and manner of such use.

11
#include "DebUtils.hh"
12
#include "Base/Utils/ThrowError.hh"
13
14
15

#ifdef DEB_ON

16
17
18
19
20
#include <string>
#include <fstream>
#include <time.h>
#include <vector>
#include <iostream>
21
#include <map>
22

23
24
namespace { // LOCAL_PROC
bool is_html_filename(const char* const str)
25
{
26
  if (str == nullptr) return false;
27
  const char* dot = strrchr(str, '.');
28
29
  if (dot == nullptr) return false;
  ++dot;
30
  return (!strncmp(dot, "htm", 3)) || (!strncmp(dot, "HTM", 3)) ;
31
}
32
}
33

34
namespace Debug {
35
36

class FunctionCallSequence
37
{
38
  std::string func_name_;
39
  std::vector<Enter*> debs_;  // These may not have sequential counts when multithreaded.
40
41

public:
42
  FunctionCallSequence(const char* _func_name, Enter* _deb)
43
    : func_name_(_func_name)
44
  {
45
46
47
    debs_.push_back(_deb);
  }
  ~FunctionCallSequence() {}
48

49
  bool add(const char* _func_name, Enter* _deb)
50
51
  {
    if (func_name_ == _func_name)
52
    {
53
      debs_.push_back(_deb);
54
      return true;
55
    }
56
57
    return false;
  }
58

59
60
61
  bool pop()
  {
    if (debs_.size() > 1)
62
    {
63
64
      debs_.pop_back();
      return true;
65
    }
66
67
68
    debs_.clear();
    return false;
  }
69

70
71
72
73
74
  int number_calls() const
  {
    if (!this) return 0;
    return (int)debs_.size();
  }
75

76
77
78
79
80
81
  int count(int i = 0) const
  {
    int num = number_calls();
    if (i < num) return debs_[num - 1 - i]->count_;
    return -1;
  }
82

83
84
85
86
  const char* name() const
  {
    return func_name_.c_str();
  }
87

88
89
90
91
92
93
  // Replace interior of < > in function name with . for brevity
  void compact_name(std::string& str) const
  {
    int cnt = 0;
    const char* ptr = func_name_.c_str();
    while (ptr && (*ptr != '\0'))
94
    {
95
96
97
98
      char c = *ptr;
      if (c == '>') --cnt;
      if (cnt == 0) str.append(1, c);
      if (c == '<')
99
      {
100
101
        if (cnt == 0) str.append(".");
        ++cnt;
102
      }
103
      ++ptr;
104
    }
105
  }
106

107
108
109
110
111
112
113
  // Get single call stack element string
  void get(std::string& _str, const bool _strip_angled, bool _with_counts) const
  {
    if (_strip_angled) compact_name(_str);
    else _str.append(name());
    _str.append("[");
    if (_with_counts)
114
    {
115
116
117
118
119
120
121
      int num = number_calls();
      int prev = -2;
      int seq_cnt = 0;
      for (int i = 0; i < num; ++i)
      {
        int cnt = debs_[i]->count_;
        if (cnt != prev + 1)
122
        {
123
          char buffer[64];
124

125
126
127
128
          if (seq_cnt > 0)
          {
            _str.append("-");
            sprintf_s(buffer, sizeof(buffer), "%i", prev);
129
            _str.append(buffer);
130
          }
131
132
133
134
135
136
137
138
139
140
141
142
143
144
          if (i > 0) _str.append(",");
          sprintf_s(buffer, sizeof(buffer), "%i", cnt);
          _str.append(buffer);
          seq_cnt = 0;
        }
        else
          ++seq_cnt;
        prev = cnt;
      } // endfor i
    } // endif _with_counts
    else
      _str.append("*");
    _str.append("]");
  } // endfunc get
145

146
  void get_indent(std::string& _str, File* _dfile, bool _is_html);
147

148
}; // endclass FunctionCallSequence
149
150


151
152
153
154
155
156
157
class CallStack
{
  std::vector<FunctionCallSequence> calls_;
  int depth_;
public:
  CallStack() : depth_(0) {}
  ~CallStack() {}
158

159
  void add(const char* _func_name, Enter* _deb)
160
161
162
163
164
  {
    if (calls_.empty() || !calls_.back().add(_func_name, _deb))
      calls_.push_back(FunctionCallSequence(_func_name, _deb));
    ++depth_;
  }
165

166
167
168
169
170
171
  void pop()
  {
    if (!calls_.back().pop())
      calls_.pop_back();
    --depth_;
  }
172

173
174
175
176
177
178
  const FunctionCallSequence* call(int _up = 0)
  {
    int num = (int)calls_.size();
    if (_up < num) return &calls_[num - 1 - _up];
    return nullptr;
  }
179

180
181
182
183
184
  // Read a particular call stack element
  bool read(int _up, const char*& _funcname, int& _count)
  {
    const FunctionCallSequence* fcs = call(_up);
    if (fcs != nullptr)
185
    {
186
187
188
      _funcname = fcs->name();
      _count = fcs->count(0); // Return most recent deb_enter_count
      return true;
189
    }
190
191
    return false;
  }
192

193
194
195
196
197
198
  // Get a full call stack sting.
  // returns number of call stack function elements
  int get(std::string& _str, bool _with_counts = true) const
  {
    int num = (int)calls_.size();
    for (int i = 0; i < num; ++i)
199
    {
200
201
      if (i > 0) _str.append("->");
      calls_[i].get(_str, true, _with_counts);
202
    }
203
204
    return num;
  }
205

206
207
208
209
  int depth() const
  {
    return depth_;
  }
210

211
  bool get_indent(std::string& _str, File* _dfile, const bool is_html);
212
}; // endclass CallStack
213

214
class File
215
216
{
private:
217
218
219
220
221
  class module_stats
  {
  public:
    int lev_; // Level set for this module
    int col_; // Colour (24 bit RGB, MSB=Red) for this module's DEB_out
222
    module_stats(int _lev = 0) : lev_(_lev), col_(0x808080) {}
223
224
225
226
227
228
    ~module_stats() {}
  };

  std::map<std::string, module_stats> module_map_;
  typedef std::map<std::string, module_stats>::iterator module_map_itr;
  typedef std::map<std::string, module_stats>::const_iterator const_module_map_itr;
229

230
  Stream::StreamType type_;
231
232
  int lev_;
  int num_flush_;
233
  int priority_; // Last permission granted
234
  int indent_size_;
235

236
237
  bool at_line_start_;

238
239
240
241
  std::string current_;
  std::string output_;
  std::string file_name_;
  std::fstream file_stream_;
242
243

  std::string double_format_;
244
  //std::string indent_string_;
245
  Stream* deb_stream_;
246
247
248
249
  CallStack call_stack_;

public:

250
251
252
253
  CallStack& call_stack()
  {
    return call_stack_;
  }
254

255
256
  bool is_kept_open() const
  {
257
    return 0 != (type_ & Stream::StreamType::KEEP_OPEN);
258
259
260
  }
  bool is_html() const
  {
261
    return 0 != (type_ & Stream::StreamType::HTML);
262
263
264
  }
  bool is_retained() const
  {
265
    return 0 != (type_ & Stream::StreamType::RETAIN);
266
267
268
  }
  bool is_appended() const
  {
269
    return 0 != (type_ & Stream::StreamType::APPEND);
270
  }
271
  // Only applies to HTML DEB_out
272
273
274
275
276
277
278
279
  bool is_white_on_black() const
  {
    return true;
  }
  int indent_size()
  {
    return indent_size_;
  }
280

281
282
283
284
285
286
287
288
  bool file_is_open() const
  {
    return file_stream_.is_open();
  }
  int priority() const
  {
    return priority_;
  }
289

290
291
292
293
294
295
296
297
  bool fork_to_cout()
  {
    return false;
  }
  bool fork_to_cerr()
  {
    return true;
  }
298
299


300
  const char* file_name() const
301
  {
302
    if (this && (!file_name_.empty())) return file_name_.c_str();
303
304
    return nullptr;
  }
305

306
307
308
309
310
311
  void clear()
  {
    current_.clear();
    output_.clear();
    file_name_.clear();
  }
312

313
314
315
316
317
318
319
  char prev_char() const
  {
    if (!current_.empty()) return current_.back();
    if (!output_.empty()) return output_.back();
    return '\0';
  }

320

321
  void indent(bool _full_text)
322
  {
323
    std::string str;
324
    if (call_stack().get_indent(str, this,  _full_text && is_html()))
325
      current_.append(str);
326
327
  }

328
  void line_break(bool _with_indent = false)
329
  {
330
    if (is_html()) current_.append("<br>");   // Don't bother with matching </br>
331
332
    current_.append("\n", 1);

333
334
    if (_with_indent) indent(false);
    else at_line_start_ = true;
335
336
  }

337
338
339
340
341
342
  void set_level(int _lev)
  {
    lev_ = _lev;
  }

  void print_direct(const std::string& _s)
343
344
345
346
  {
    current_.append(_s);
  }

347
348
  void print(const char _c)
  {
349
    if (_c == '\n')
350
351
352
353
354
    {
      line_break();
      return;
    }

355
356
    if (at_line_start_)
    {
357
      indent(true);
358
359
360
361
      at_line_start_ = false;
    }


362
363
364
    if (is_html())
    {
      // translate the esoteric characters used in IGM DEB_out
365

366
      if (_c == '')  // -62
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
        return;

      if (_c == '') // 167 = -89
      {
        current_.append("&sect;");
        return;
      }

      if (_c == '') // -80
      {
        current_.append("&deg;");
        return;
      }
    }
    current_.append(&_c, 1);
382
383
  }

384
385
386
387
388
  void print_to_ostream(const char* const _s, std::ostream& os)
  {
    os << _s;
  }

389
  void print(const char* const _s, bool _fork = true)
390
391
392
  {
    if (_s != nullptr)
    {
393
      for (int i = 0; ; ++i)
394
395
      {
        const char c = _s[i];
396
        if (c == '\0') break;
397
398
399
400
        print(c);
      }
      if (_fork)
      {
401
        if (fork_to_cout())
402
          print_to_ostream(_s, std::cout);
403
        if (fork_to_cerr())
404
          print_to_ostream(_s, std::cerr);
405
      }
406
    }
407
408
409
410
411
412
413
414
  }

  void print(int _i)
  {
    char buffer[64];
    sprintf_s(buffer, sizeof(buffer), "%i", _i);
    print(buffer);
  }
415

416

417
  const char* double_format() const
418
419
420
421
422
423
  {
    if (double_format_.empty())
      return "%.17g";
    return double_format_.c_str();
  }

424
  void set_double_format(const char* const str)
425
  {
426
    if (str == nullptr)
427
428
429
430
431
432
      double_format_.clear();
    else
      double_format_ = str;
  }


433
434
435
  void print(double _d)
  {
    char buffer[64];
436
    sprintf_s(buffer, sizeof(buffer), double_format(), _d);
437
438
439
    print(buffer);
  }

440
  void print(const Command& _co)
441
  {
442
443
    switch (_co.com())
    {
444
    case Command::END :
445
      if (is_html()) print_direct("</FONT>");
446
      break;
447
    case Command::END_ERR :
448
449
450
    // Powerdown DEB_error font
    // if (is_html()) print_direct("</BLINK>");
    // fall through
451
    case Command::END_LF :
452
      if (is_html()) print_direct("</FONT>");
453
454
455
456
457
458
459
460
461
      line_break(); 
      
      // line_break() does not fork to cout or cerr
      // so do so explicitly.
      if (fork_to_cout())
         std::cout << "\n";
      if (fork_to_cerr())
         std::cerr << "\n";

462
463
464
465
      break;
    }
  }

466
  Stream& stream()
467
468
469
  {
    return *deb_stream_;
  }
470

471
472
  // Append current asctime to given string
  bool add_time(std::string& str)
473
474
  {
    time_t rawtime;
475
    time(&rawtime);
476
    struct tm timeinfo;
477
    errno_t err = localtime_s(&timeinfo, &rawtime);
478
479
480
481
482
483
    if (err == 0)
    {
      char buffer[256];
      err = asctime_s(buffer, sizeof(buffer), &timeinfo);
      if (err == 0)
      {
484
        str.append(buffer);
485
486
487
488
489
490
        return true;
      }
    }
    return false;
  }

491

492
#if 1
493
  bool hover(std::string& _str, const std::string& _hover, const bool _open)
494
495
496
497
  {
    if (is_html())
    {
      char buffer[1024];
498
499
      if (_open)  sprintf_s(buffer, sizeof(buffer),
                              "<span title=\"%s\">", _hover.c_str());
500
501
502
503
504
505
506
507
      else sprintf_s(buffer, sizeof(buffer), "</span>");
      _str.append(buffer);
      return true;
    }
    return false;
  }
#endif

508
  bool anchor(std::string& _str, const int _id, const char* _tag, const bool _open)
509
510
511
512
513
514
515
516
517
518
519
520
  {
    if (is_html())
    {
      char buffer[1024];
      if (_open)  sprintf_s(buffer, sizeof(buffer), "<A name=\"%08X_%s\">", _id, _tag);
      else sprintf_s(buffer, sizeof(buffer), "</A>");
      _str.append(buffer);
      return true;
    }
    return false;
  }

521
  bool link_to(std::string& _str, const int _id, const char* _tag, const std::string& _hover, const bool _open)
522
523
524
525
526
527
528
529
530
531
  {
    if (is_html())
    {
      char buffer[2048];
      if (_open)
      {
        // HTML title hover text is cropped to 64 char in Firefox but displays
        // OK in Chrome. We could use javascript to avoid this limit but HTML
        // is simpler.
        if (_hover.empty()) sprintf_s(buffer, sizeof(buffer),
532
533
534
                                        "<A href=\"#%08X_%s\">", _id, _tag);
        else sprintf_s(buffer, sizeof(buffer),
                         "<A href=\"#%08X_%s\" title=\"%s\">", _id, _tag, _hover.c_str());
535
536
537
538
539
540
541
542
543
      }
      else sprintf_s(buffer, sizeof(buffer), "</A>");
      _str.append(buffer);
      return true;
    }
    return false;
  }


544
545
546
  void header(std::string& str)
  {
    if (is_html())
547
548
549
550
551
552
553
554
555
    {
      str.append("<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\">");
      str.append("\n<HTML><HEAD>");
      str.append("\n<TITLE>ReForm DEB_out");
      str.append("</TITLE>");
      // javascript lib loads go here
      // stylesheet loads go here
      // within HEAD javascript goes here
      str.append("\n</HEAD>");
556
      if (is_white_on_black())
557
      {
558
        str.append("\n<BODY BGCOLOR=\"#000000\" TEXT=\"#FFFFFF\" LINK=\"#%00FFFF\" VLINK=\"#FFFF00\" >");
559
        //str.append( "\n<BODY BGCOLOR=\"#000000\" TEXT=\"#FFFFFF\"  >");
560
561
562
563
      }
      else
      {
        str.append("\n<BODY BGCOLOR=\"#FFFFFF\" TEXT=\"#000000\" LINK=\"#%FF0000\" VLINK=\"#0000FF\" >");
564
        //str.append( "\n<BODY BGCOLOR=\"#000000\" TEXT=\"#FFFFFF\" >");
565
566
567
568
569
570
      }
      str.append("\n");
    } // endif is_html
    bool date_header = true;
    if (date_header)
    {
571
      if (!file_name_.empty())
572
573
574
575
      {
        str.append(file_name_);
        str.append(" opened ");
      }
576
      add_time(str);
577
      str.append("[ Build: " __TIME__  " " __DATE__  "] ");
578
579
      if (is_html()) str.append("<BR>");
      str.append("\n");
580
    }
581
   }
582
583
584
585
586
587

  void footer()
  {
    bool date_footer = true;
    if (date_footer)
    {
588
      std::string str("\n");
589
      if (!file_name_.empty()) str.append(file_name_);
590
      str.append(" Closed: ");
591
592
      add_time(str);
      stream() << str << "\n";
593
594
595
    }

    if (is_html())
596
      stream().print("\n</BODY></HTML>", false);
597
  }
598

599
600
601
602
  bool is_first_flush()
  {
    return num_flush_ == 0 ;
  }
603

604
605
606
  int flush()
  {
    int res = 0;
607
    if (!current_.empty())
608
    {
609
610
      const char* fname = file_name();
      if ((fname != nullptr) || file_is_open())
611
      {
612
        if (!file_is_open())
613
        {
614
615
616
          file_stream_.open(fname,
                            std::fstream::out | ((is_appended() && !is_first_flush()) ?
                                                 std::fstream::app  :  std::fstream::trunc));
617
618
619
620
621
        }

        if (file_stream_.is_open())
        {
          std::string hdr;
622
623
624
          if (!is_appended())
          {
            // Reoutput entire file
625
626
627
628
629
630
            header(hdr);
            output_.append(hdr);
            file_stream_ << output_;
          }
          else
          {
631
            if (is_first_flush())
632
633
            {
              header(hdr);
634
635
              if (is_retained())
                output_.append(hdr);
636
637
638
639
640
641
              file_stream_ << hdr;
            }
            ++num_flush_;
          }
          file_stream_ << current_;

642
          if (is_retained())
643
644
            output_.append(current_);

645
646
          current_.clear();
          if (!is_kept_open())
647
648
649
650
651
652
            file_stream_.close();
        } // endif fs.is_open
        else
          res = -1;
      }
    } // endif current empty
653
    return res;
654
655
  }  // endfunc flush

656
657
658
659
  // Use with extreme caution.
  const char * string_out() const
 { return current_.c_str(); }

660
661
662
663
664
665
666
  void close()
  {
    footer();
    flush();
  }


667
  void set_file_name(const char* _name)
668
  {
669
    file_name_ = _name ? _name : "";
670
    if (is_html_filename(_name))
671
      type_ = (Stream::StreamType)(type_ | Stream::StreamType::HTML);
672
  }
673
674

  void set_module_level(const char* const _module, const int _lev)
675
  {
676
677
678
    std::pair<module_map_itr, bool> ins =  module_map_.insert(
        std::pair<std::string, module_stats>(_module, module_stats(_lev)));
    if (!ins.second) ins.first->second.lev_ = _lev;
679
680
  }

681
  int module_level(const char* const _module) const
682
683
684
685
686
687
  {
    const_module_map_itr it = module_map_.find(std::string(_module));
    if (it == module_map_.end()) return lev_;
    return it->second.lev_;
  }

688
  void set_module_color(const char* const _module, const int _col)
689
  {
690
691
692
    std::pair<module_map_itr, bool> ins =  module_map_.insert(
        std::pair<std::string, module_stats>(_module, module_stats(lev_)));
    ins.first->second.col_ = _col;
693
694
  }

695
  int get_module_color(const char* const _module) const
696
697
  {
    const_module_map_itr it = module_map_.find(std::string(_module));
698
699
700
701
702
    if (it == module_map_.end())
    {
      if (is_white_on_black()) return 0xFFFFFF;
      else return 0x000000;
    }
703
704
    return it->second.col_;
  }
705
706

  int permission(const int _lev, const int _warn, const char* const _module)
707
708
  {
    _warn;
709
    int lev = module_level(_module);
710
    lev -= _lev;
711
    if (lev < 0) lev = 0;
712
713
714
    if (lev > 0) priority_ = lev;
    return lev;
  }
715
716

  bool is_at_line_start()
717
  {
718
    return at_line_start_;
719
720
721
  }


722
723
724
  File(
    Stream* _deb_stream,
    Stream::StreamType _type = (Stream::StreamType)(Stream::APPEND | Stream::RETAIN),
725
726
    const char* _file_name = nullptr) :
    type_(_type), lev_(5), deb_stream_(_deb_stream), num_flush_(0)
727
728
  {
    set_file_name(_file_name);
729
    indent_size_ = 3;
730
    at_line_start_ = false; // Don't want to indent header
731
732
    //    indent_string_ = ".";
    set_module_color("PARA", 0xFF8000);
733
734
    set_module_color("SOLV", 0x00FF00);
    set_module_color("NSLV", 0xFFFF00);
735
    set_module_color("FELD", 0x0080FF);
736
    set_module_color("CURV", 0x00FFFF);
737
738
    set_module_color("QMGN", 0xFF00FF);
    // Don't set a TEST module colour here because Test is not part of Reform
739
740
741
742
743
744
745
746
747
748
749
750

#if 0  // Such custom setting calls really belong in Test
    set_module_level("PARA", 1);
    set_module_level("CFLD", 0);
    set_module_level("NSLV", 0);
    set_module_level("QMGN", 0);
    set_module_level("CURV", 5);
    set_module_level("SOLV", 0);
    set_module_level("FELD", 0);
#endif


751
  }
752
}; // endclass File
753
754

// =====================================
755
//      Enter member funcs
756
757
// =====================================

758
759
Enter::Enter(const char* const _flnm, const char* const _funcname, const int _count) :
  flnm_(_flnm), deb_outs_(0), deb_lines_(0), count_(_count), module_("")
760
{
761
  // TODO: this might have to be atomic
762
  static int id_cnt = 0;
763
  id_ = ++id_cnt;
764
  stream(0, false).dfile()->call_stack().add(_funcname, this);
765
766
}

767
Enter::~Enter()
768
{
769
  File* impl = stream(0, false).dfile();
770
  impl->call_stack().pop();
771

772
  std::string str;
773
  if (((deb_outs_ > 0) || (deb_lines_ > 0)) && impl->anchor(str, id_, "exit", true))
774
  {
775
    impl->anchor(str, id_, "exit", false);
776
777
    impl->print_direct(str);
  }
778
779
}

780
Stream& Enter::stream(const int _warn, const bool _print)
781
{
782
783
  Stream& ds = Stream::get_global(_warn);
  File* impl = ds.dfile();
784

785
  if (_print)
786
  {
787
788
    if (impl->is_html())
    {
789
      bool is_deb_error = (_warn == 2);
790
      // DEB_error font powerup goes here. BLINK is deprecated sadly.
791
      // if (is_deb_error)  impl->print_direct("<BLINK>");
792
      int col = impl->get_module_color(module_);
793
      if (is_deb_error) col = 0xFF0000; // RED
794
      char buffer[256];
795
796
      sprintf_s(buffer, sizeof(buffer), "<FONT COLOR=\"#%06X\" SIZE=%i>",
                col, impl->priority() + 1);
797
      impl->print_direct(buffer);
798
799
    }

800
    if (deb_outs_ < 1)
801
802
    {
      // First DEB_out in this function so output callstack, and flush.
803
      impl->indent(true);
804
805
806
807
      std::string str;
      bool is_html = impl->is_html();
      if (is_html)
      {
808
        str.append("<FONT SIZE=2><u>");
809
        impl->anchor(str, id_, "enter", true);
810
      }
811
      else
812
813
      {
        // .txt call stack lead in
814
815
816
        str.append("****>");
      }

817
      impl->call_stack().get(str);
818
      if (is_html) str.append("</u></FONT>");
819
820
      impl->print_direct(str.c_str()); // Don't fork callstack to cerr etc.
      impl->line_break();
821
      ds.dfile()->flush();
822
823
824
825
826
827
828
    }
    ++deb_outs_;
  }

  return ds;
}

829
int Enter::permission(const int _lev, const int _warn)
830
{
831
  int res = Stream::get_global().dfile()->permission(_lev, _warn, module_);
832
  return res;
833
834
}

835

836
void FunctionCallSequence::get_indent(std::string& _str, File* _dfile, bool _is_html)
837
838
{
  int num = number_calls();
839
840
  for (int i = 0; i < num; ++i)
  {
841
    Enter* deb = debs_[i];
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
    if (_is_html)
    {
      /* HTML indent element is <L> with span title the name and count
      of the function and with < linking to the entry anchor (if present) and
      > linking to the exit anchor (will be present).
      L is the first letter of the module name */
      char hovert[1024];
      sprintf_s(hovert, sizeof(hovert), "%s[%i]", func_name_.c_str(), deb->count_);
      int col = _dfile->get_module_color(deb->module_);
      char buffer[1024];
      sprintf_s(buffer, sizeof(buffer), "<FONT COLOR=\"#%06X\">.", col);

      _dfile->hover(_str, std::string(hovert), true);

      _str.append(buffer);
      std::string cstk;
      //impl->call_stack().get(cstk);
859
      if ((deb->deb_outs_ > 0) && _dfile->link_to(_str, deb->id_, "enter", cstk, true))
860
861
862
863
864
865
      {
        _str.append("&lt;");
        _dfile->link_to(_str, deb->id_, "enter", cstk,  false);
      }
      else _str.append("&lt;");

866
      _str.append(deb->flnm_, 1);
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882

      if (_dfile->link_to(_str, deb->id_, "exit", cstk, true))
      {
        _str.append("&gt;");
        _dfile->link_to(_str, deb->id_, "exit", cstk,  false);
        ++deb->deb_lines_;
      }

      _dfile->hover(_str, std::string(hovert), false);

      _str.append("</FONT>");
    } // endif html
    else _str.append("  ");
  }
}

883
bool CallStack::get_indent(std::string& _str, File* _dfile, const bool is_html)
884
885
886
887
888
889
890
891
892
893
{

  if (_dfile->indent_size() == 0) return false;
  if (is_html)
  {
    char buffer[64];
    sprintf_s(buffer, sizeof(buffer), "<FONT SIZE=%i>", _dfile->indent_size());
    _str.append(buffer);
  }
  int num = (int)calls_.size();
894
895
  int i0 = 0;
  if (!is_html) ++i0; // Don't waste whitespace on first level indent if .txt
896
  for (int i = i0; i < num; ++i)
897
    calls_[i].get_indent(_str, _dfile,  is_html);
898
899
900
901
902
  if (is_html) _str.append(":&nbsp;</FONT>\n");
  return true;
}


903
// =====================================
904
//        Stream member funcs
905
906
907
// =====================================


908
Stream::Stream(const char* _file_name, StreamType _type)
909
910
{
  // NB. disable DEB_out over this new if new contains DEB_out
911
  dfile_ = new File(this, _type, _file_name);
912
913
}

914
Stream::~Stream()
915
{
916
  if (dfile_ != nullptr)
917
  {
918
919
    dfile()->close();
    dfile()->clear();
920
    // NB. disable DEB_out over this delete if delete contains DEB_out
921
922
    delete dfile_;
    dfile_ = nullptr;
923
924
925
  }
}

926
const char * Stream::string_out() const 
927
928
{ return dfile()->string_out();}

929
Stream& Stream::print(const int _i)
930
{
931
  dfile_->print(_i);
932
933
934
  return *this;
};

935
Stream& Stream::print(const double _d)
936
{
937
  dfile_->print(_d);
938
939
940
  return *this;
};

941
Stream& Stream::print(const char* _s, bool _fork)
942
{
943
  dfile_->print(_s, _fork);
944
945
946
  return *this;
};

947
Stream& Stream::print(const char _c)
948
{
949
950
951
952
  dfile_->print(_c);
  return *this;
};

953
Stream& Stream::print(const Command& _co)
954
955
{
  dfile_->print(_co);
956
957
958
  return *this;
};

959
Stream& Stream::get_global(int _warn)
960
{
961
  _warn;
962
  // TODO: Replace with a Singleton?? ThreadArray??
963
  static Stream g_ds__("reform_deb_out.txt");
964
965
966
  return g_ds__;
}

967
Stream& operator<<(Stream& _ds, const int _i)
968
969
970
{
  return _ds.print(_i);
}
971
Stream& operator<<(Stream& _ds, const double _d)
972
973
974
{
  return _ds.print(_d);
}
975
Stream& operator<<(Stream& _ds, const char* const _s)
976
977
978
{
  return _ds.print(_s);
}
979
Stream& operator<<(Stream& _ds, const char _c)
980
981
982
983
{
  return _ds.print(_c);
}

984
Stream& operator<<(Stream& _ds, const size_t _i)
985
{
986
  return _ds.print((int)_i);
987
}
988
Stream& operator<<(Stream& _ds, const unsigned int _i)
989
{
990
  return _ds.print((int)_i);
991
}
992
Stream& operator<<(Stream& _ds, const float _f)