git.cworth.org Git - apitrace/blob - 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 #include <stddef.h>
  34
  35 #include <vector>
  36
  37 namespace Trace {
  38
  39     typedef unsigned Id;
  40
  41     struct FunctionSig {
  42         Id id;
  43         const char *name;
  44         unsigned num_args;
  45         const char **arg_names;
  46     };
  47
  48     struct StructSig {
  49         Id id;
  50         const char *name;
  51         unsigned num_members;
  52         const char **member_names;
  53     };
  54
  55     struct EnumSig {
  56         Id id;
  57         const char *name;
  58         signed long long value;
  59     };
  60
  61     struct BitmaskVal {
  62         const char *name;
  63         unsigned long long value;
  64     };
  65
  66     struct BitmaskSig {
  67         Id id;
  68         unsigned count;
  69         const BitmaskVal *values;
  70     };
  71
  72     class Writer {
  73     protected:
  74         void *g_gzFile;
  75         unsigned call_no;
  76
  77         std::vector<bool> functions;
  78         std::vector<bool> structs;
  79         std::vector<bool> enums;
  80         std::vector<bool> bitmasks;
  81
  82     public:
  83         Writer();
  84         ~Writer();
  85
  86         void open(void);
  87         bool open(const char *filename);
  88         void close(void);
  89
  90         unsigned beginEnter(const FunctionSig &function);
  91         void endEnter(void);
  92
  93         void beginLeave(unsigned call);
  94         void endLeave(void);
  95
  96         void beginArg(unsigned index);
  97         inline void endArg(void) {}
  98
  99         void beginReturn(void);
 100         inline void endReturn(void) {}
 101
 102         void beginArray(size_t length);
 103         inline void endArray(void) {}
 104
 105         inline void beginElement(void) {}
 106         inline void endElement(void) {}
 107
 108         void beginStruct(const StructSig *sig);
 109         inline void endStruct(void) {}
 110
 111         void writeBool(bool value);
 112         void writeSInt(signed long long value);
 113         void writeUInt(unsigned long long value);
 114         void writeFloat(float value);
 115         void writeDouble(double value);
 116         void writeString(const char *str);
 117         void writeString(const char *str, size_t size);
 118         void writeWString(const wchar_t *str);
 119         void writeBlob(const void *data, size_t size);
 120         void writeEnum(const EnumSig *sig);
 121         void writeBitmask(const BitmaskSig &bitmask, unsigned long long value);
 122         void writeNull(void);
 123         void writeOpaque(const void *ptr);
 124
 125     protected:
 126         void inline _write(const void *sBuffer, size_t dwBytesToWrite);
 127         void inline _writeByte(char c);
 128         void inline _writeUInt(unsigned long long value);
 129         void inline _writeFloat(float value);
 130         void inline _writeDouble(double value);
 131         void inline _writeString(const char *str);
 132
 133     };
 134 }
 135
 136 #endif /* _TRACE_WRITER_HPP_ */