git.cworth.org Git - apitrace/blob - trace_write.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 #ifndef _TRACE_WRITE_HPP_
  27 #define _TRACE_WRITE_HPP_
  28
  29 namespace Trace {
  30
  31     typedef unsigned Id;
  32
  33     struct FunctionSig {
  34         Id id;
  35         const char *name;
  36         unsigned num_args;
  37         const char **args;
  38     };
  39
  40     struct BitmaskVal {
  41         const char *name;
  42         unsigned long long value;
  43     };
  44
  45     struct BitmaskSig {
  46         Id id;
  47         unsigned count;
  48         const BitmaskVal *values;
  49     };
  50
  51     void Open(void);
  52     void Close(void);
  53
  54     unsigned BeginEnter(const FunctionSig &function);
  55     void EndEnter(void);
  56
  57     void BeginLeave(unsigned call);
  58     void EndLeave(void);
  59
  60     void BeginArg(unsigned index);
  61     inline void EndArg(void) {}
  62
  63     void BeginReturn(void);
  64     inline void EndReturn(void) {}
  65
  66     void BeginArray(size_t length);
  67     inline void EndArray(void) {}
  68
  69     inline void BeginElement(void) {}
  70     inline void EndElement(void) {}
  71
  72     void BeginStruct(size_t length);
  73     inline void EndStruct(void) {}
  74
  75     void BeginMember(const char *name);
  76     inline void EndMember(void) {}
  77
  78     void LiteralBool(bool value);
  79     void LiteralSInt(signed long long value);
  80     void LiteralUInt(unsigned long long value);
  81     void LiteralFloat(float value);
  82     void LiteralFloat(double value);
  83     void LiteralString(const char *str);
  84     void LiteralString(const char *str, size_t size);
  85     void LiteralWString(const wchar_t *str);
  86     void LiteralBlob(const void *data, size_t size);
  87     void LiteralNamedConstant(const char *name, long long value);
  88     void LiteralBitmask(const BitmaskSig &bitmask, unsigned long long value);
  89     void LiteralNull(void);
  90     void LiteralOpaque(const void *ptr);
  91
  92     void Abort(void);
  93 }
  94
  95 #endif /* _TRACE_WRITE_HPP_ */