eventloop and abstractui debugging, lots more commenting on abstractui/eventloop...
[ardour.git] / 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 "pbd/debug.h"
28
29 #include "i18n.h"
30
31 using namespace std;
32 static uint64_t _debug_bit = 1;
33 static std::map<const char*,uint64_t> _debug_bit_map;
34
35 uint64_t PBD::DEBUG::Stateful = PBD::new_debug_bit ("stateful");
36 uint64_t PBD::DEBUG::Properties = PBD::new_debug_bit ("properties");
37 uint64_t PBD::DEBUG::FileManager = PBD::new_debug_bit ("filemanager");
38 uint64_t PBD::DEBUG::Pool = PBD::new_debug_bit ("pool");
39 uint64_t PBD::DEBUG::EventLoop = PBD::new_debug_bit ("eventloop");
40 uint64_t PBD::DEBUG::AbstractUI = PBD::new_debug_bit ("abstractui");
41
42 uint64_t PBD::debug_bits = 0x0;
43
44 uint64_t
45 PBD::new_debug_bit (const char* name)
46 {
47         uint64_t ret;
48         _debug_bit_map.insert (make_pair (name, _debug_bit));
49         ret = _debug_bit;
50         _debug_bit <<= 1;
51         return ret;
52 }
53
54 void
55 PBD::debug_print (const char* prefix, string str)
56 {
57         cerr << prefix << ": " << str;
58 }
59
60 void
61 PBD::set_debug_bits (uint64_t bits)
62 {
63         debug_bits = bits;
64 }
65
66 int
67 PBD::parse_debug_options (const char* str)
68 {
69         char* p;
70         char* sp;
71         uint64_t bits = 0;
72         char* copy = strdup (str);
73
74         p = strtok_r (copy, ",", &sp);
75
76         while (p) {
77                 if (strcasecmp (p, "list") == 0) {
78                         list_debug_options ();
79                         free (copy);
80                         return 1;
81                 }
82
83                 if (strcasecmp (p, "all") == 0) {
84                         PBD::set_debug_bits (~0ULL);
85                         free (copy);
86                         return 0;
87                 }
88
89                 for (map<const char*,uint64_t>::iterator i = _debug_bit_map.begin(); i != _debug_bit_map.end(); ++i) {
90                         if (strncasecmp (p, i->first, strlen (p)) == 0) {
91                                 bits |= i->second;
92                         }
93                 }
94
95                 p = strtok_r (0, ",", &sp);
96         }
97         
98         free (copy);
99         PBD::set_debug_bits (bits);
100         return 0;
101 }
102
103 void
104 PBD::list_debug_options ()
105 {
106         cout << _("The following debug options are available. Separate multiple options with commas.\nNames are case-insensitive and can be abbreviated.") << endl << endl;
107         cout << '\t' << X_("all") << endl; 
108
109         vector<string> options;
110
111         for (map<const char*,uint64_t>::iterator i = _debug_bit_map.begin(); i != _debug_bit_map.end(); ++i) {
112                 options.push_back (i->first);
113         }
114
115         sort (options.begin(), options.end());
116
117         for (vector<string>::iterator i = options.begin(); i != options.end(); ++i) {
118                 cout << "\t" << (*i) << endl;
119         }
120 }