libs/pbd/debug.cc

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <cstring>
  21 #include <cstdlib>
  22 #include <iostream>
  23 #include <map>
  24 #include <vector>
  25 #include <algorithm>
  26
  27 #include <boost/tokenizer.hpp>
  28
  29 #include "pbd/debug.h"
  30
  31 #include "i18n.h"
  32
  33 using namespace std;
  34 using PBD::DebugBits;
  35
  36 static uint64_t _debug_bit = 0;
  37
  38 typedef std::map<const char*,DebugBits> DebugMap;
  39
  40 namespace PBD {
  41         DebugMap & _debug_bit_map()
  42         {
  43                 static DebugMap map;
  44                 return map;
  45         }
  46 }
  47
  48 DebugBits PBD::DEBUG::Stateful = PBD::new_debug_bit ("stateful");
  49 DebugBits PBD::DEBUG::Properties = PBD::new_debug_bit ("properties");
  50 DebugBits PBD::DEBUG::FileManager = PBD::new_debug_bit ("filemanager");
  51 DebugBits PBD::DEBUG::Pool = PBD::new_debug_bit ("pool");
  52 DebugBits PBD::DEBUG::EventLoop = PBD::new_debug_bit ("eventloop");
  53 DebugBits PBD::DEBUG::AbstractUI = PBD::new_debug_bit ("abstractui");
  54 DebugBits PBD::DEBUG::FileUtils = PBD::new_debug_bit ("fileutils");
  55 DebugBits PBD::DEBUG::Configuration = PBD::new_debug_bit ("configuration");
  56 DebugBits PBD::DEBUG::UndoHistory = PBD::new_debug_bit ("undohistory");
  57 DebugBits PBD::DEBUG::Timing = PBD::new_debug_bit ("timing");
  58 DebugBits PBD::DEBUG::Threads = PBD::new_debug_bit ("threads");
  59
  60 /* These are debug bits that are used by backends. Since these are loaded dynamically,
  61    after command-line parsing, defining them in code that is part of the backend
  62    doesn't make them available for command line parsing. Put them here.
  63
  64    This is sort of a hack, because it means that the debug bits aren't defined
  65    with the code in which they are relevant. But providing access to debug bits
  66    from dynamically loaded code, for use in command line parsing, is way above the pay grade
  67    of this debug tracing scheme.
  68 */
  69 DebugBits PBD::DEBUG::WavesMIDI = PBD::new_debug_bit ("WavesMIDI");
  70 DebugBits PBD::DEBUG::WavesAudio = PBD::new_debug_bit ("WavesAudio");
  71
  72 DebugBits PBD::debug_bits;
  73
  74 DebugBits
  75 PBD::new_debug_bit (const char* name)
  76 {
  77         DebugBits ret;
  78         DebugMap::iterator i =_debug_bit_map().find (name);
  79
  80         if (i != _debug_bit_map().end()) {
  81                 return i->second;
  82         }
  83
  84         if (_debug_bit >= debug_bits.size()) {
  85                 cerr << "Too many debug bits defined, offender was " << name << endl;
  86                 abort ();
  87                 /*NOTREACHED*/
  88         }
  89
  90         ret.set (_debug_bit++, 1);
  91         _debug_bit_map().insert (make_pair (name, ret));
  92         return ret;
  93 }
  94
  95 void
  96 PBD::debug_print (const char* prefix, string str)
  97 {
  98         cout << prefix << ": " << str;
  99 }
 100
 101 int
 102 PBD::parse_debug_options (const char* str)
 103 {
 104         string in_str = str;
 105         typedef boost::tokenizer<boost::char_separator<char> > tokenizer;
 106         boost::char_separator<char> sep (",");
 107         tokenizer tokens (in_str, sep);
 108         DebugBits bits;
 109
 110         for (tokenizer::iterator tok_iter = tokens.begin(); tok_iter != tokens.end(); ++tok_iter) {
 111                 if (*tok_iter == "list") {
 112                         list_debug_options ();
 113                         return 1;
 114                 }
 115
 116                 if (*tok_iter == "all") {
 117                         debug_bits.set (); /* sets all bits */
 118                         return 0;
 119                 }
 120
 121                 for (map<const char*,DebugBits>::iterator i = _debug_bit_map().begin(); i != _debug_bit_map().end(); ++i) {
 122                         const char* cstr = (*tok_iter).c_str();
 123
 124                         if (strncasecmp (cstr, i->first, strlen (cstr)) == 0) {
 125                                 bits |= i->second;
 126                                 cout << i->first << " set ... debug bits now set to " << bits << " using " << i->second << endl;
 127                         }
 128                 }
 129         }
 130
 131         debug_bits = bits;
 132
 133         return 0;
 134 }
 135
 136 void
 137 PBD::list_debug_options ()
 138 {
 139         cout << _("The following debug options are available. Separate multiple options with commas.\nNames are case-insensitive and can be abbreviated.") << endl << endl;
 140         cout << '\t' << X_("all") << endl;
 141
 142         vector<string> options;
 143
 144         for (map<const char*,DebugBits>::iterator i = _debug_bit_map().begin(); i != _debug_bit_map().end(); ++i) {
 145                 options.push_back (i->first);
 146         }
 147
 148         sort (options.begin(), options.end());
 149
 150         for (vector<string>::iterator i = options.begin(); i != options.end(); ++i) {
 151                 cout << "\t" << (*i) << endl;
 152         }
 153 }