]> git.cworth.org Git - apitrace/blob - trace_writer.hpp
Move signatures to trace_model.hpp where they belong.
[apitrace] / trace_writer.hpp
1 /**************************************************************************
2  *
3  * Copyright 2007-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  * Trace writing functions.
28  */
29
30 #ifndef _TRACE_WRITER_HPP_
31 #define _TRACE_WRITER_HPP_
32
33
34 #include <stddef.h>
35
36 #include <vector>
37
38 #include "trace_model.hpp"
39
40
41 namespace Trace {
42
43     class Writer {
44     protected:
45         void *g_gzFile;
46         unsigned call_no;
47
48         std::vector<bool> functions;
49         std::vector<bool> structs;
50         std::vector<bool> enums;
51         std::vector<bool> bitmasks;
52
53     public:
54         Writer();
55         ~Writer();
56
57         void open(void);
58         bool open(const char *filename);
59         void close(void);
60
61         unsigned beginEnter(const FunctionSig *sig);
62         void endEnter(void);
63
64         void beginLeave(unsigned call);
65         void endLeave(void);
66
67         void beginArg(unsigned index);
68         inline void endArg(void) {}
69
70         void beginReturn(void);
71         inline void endReturn(void) {}
72
73         void beginArray(size_t length);
74         inline void endArray(void) {}
75
76         inline void beginElement(void) {}
77         inline void endElement(void) {}
78
79         void beginStruct(const StructSig *sig);
80         inline void endStruct(void) {}
81
82         void writeBool(bool value);
83         void writeSInt(signed long long value);
84         void writeUInt(unsigned long long value);
85         void writeFloat(float value);
86         void writeDouble(double value);
87         void writeString(const char *str);
88         void writeString(const char *str, size_t size);
89         void writeWString(const wchar_t *str);
90         void writeBlob(const void *data, size_t size);
91         void writeEnum(const EnumSig *sig);
92         void writeBitmask(const BitmaskSig *sig, unsigned long long value);
93         void writeNull(void);
94         void writeOpaque(const void *ptr);
95
96     protected:
97         void inline _write(const void *sBuffer, size_t dwBytesToWrite);
98         void inline _writeByte(char c);
99         void inline _writeUInt(unsigned long long value);
100         void inline _writeFloat(float value);
101         void inline _writeDouble(double value);
102         void inline _writeString(const char *str);
103
104     };
105 }
106
107 #endif /* _TRACE_WRITER_HPP_ */