node_modules/node-pty/deps/winpty/src/shared/DebugClient.h

   1 // Copyright (c) 2011-2012 Ryan Prichard
   2 //
   3 // Permission is hereby granted, free of charge, to any person obtaining a copy
   4 // of this software and associated documentation files (the "Software"), to
   5 // deal in the Software without restriction, including without limitation the
   6 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   7 // sell copies of the Software, and to permit persons to whom the Software is
   8 // furnished to do so, subject to the following conditions:
   9 //
  10 // The above copyright notice and this permission notice shall be included in
  11 // all copies or substantial portions of the Software.
  12 //
  13 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  18 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  19 // IN THE SOFTWARE.
  20
  21 #ifndef DEBUGCLIENT_H
  22 #define DEBUGCLIENT_H
  23
  24 #include "winpty_snprintf.h"
  25
  26 bool isTracingEnabled();
  27 bool hasDebugFlag(const char *flag);
  28 void trace(const char *format, ...) WINPTY_SNPRINTF_FORMAT(1, 2);
  29
  30 // This macro calls trace without evaluating the arguments.
  31 #define TRACE(format, ...)                          \
  32     do {                                            \
  33         if (isTracingEnabled()) {                   \
  34             trace((format), ## __VA_ARGS__);        \
  35         }                                           \
  36     } while (false)
  37
  38 #endif // DEBUGCLIENT_H