]> git.cworth.org Git - apitrace/blob - common/trace_dump.hpp
Move trace dumping to a separate module. Add option to not dump arg names.
[apitrace] / common / trace_dump.hpp
1 /**************************************************************************
2  *
3  * Copyright 2010 VMware, Inc.
4  * All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  *
24  **************************************************************************/
25
26 /*
27  * Human-readible dumping.
28  */
29
30 #ifndef _TRACE_DUMP_HPP_
31 #define _TRACE_DUMP_HPP_
32
33
34 #include <iostream>
35
36 #include "trace_model.hpp"
37
38
39 namespace trace {
40
41
42 typedef unsigned DumpFlags;
43
44 enum {
45     DUMP_FLAG_NO_COLOR                 = (1 << 0),
46     DUMP_FLAG_NO_ARG_NAMES             = (1 << 1),
47 };
48
49
50 void dump(Value *value, std::ostream &os, DumpFlags flags = 0);
51
52
53 inline std::ostream & operator <<(std::ostream &os, Value *value) {
54     if (value) {
55         dump(value, os);
56     }
57     return os;
58 }
59
60
61 void dump(Call &call, std::ostream &os, DumpFlags flags = 0);
62
63
64 inline std::ostream & operator <<(std::ostream &os, Call &call) {
65     dump(call, os);
66     return os;
67 }
68
69
70 } /* namespace trace */
71
72 #endif /* _TRACE_DUMP_HPP_ */