libs/pbd/debug.cc

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