debug.cpp

Go to the documentation of this file.

/* $Id: debug.cpp 14772 2008-12-29 21:50:25Z rubidium $ */

#include "stdafx.h"
#include <stdio.h>
#include <stdarg.h>
#include "openttd.h"
#include "console_func.h"
#include "debug.h"
#include "string_func.h"
#include "network/core/core.h"
#include "fileio_func.h"

#if defined(ENABLE_NETWORK)
SOCKET _debug_socket = INVALID_SOCKET;
#endif /* ENABLE_NETWORK */

int _debug_ai_level;
int _debug_driver_level;
int _debug_grf_level;
int _debug_map_level;
int _debug_misc_level;
int _debug_ms_level;
int _debug_net_level;
int _debug_sprite_level;
int _debug_oldloader_level;
int _debug_ntp_level;
int _debug_npf_level;
int _debug_yapf_level;
int _debug_freetype_level;
int _debug_sl_level;
int _debug_station_level;
int _debug_gamelog_level;
int _debug_desync_level;


struct DebugLevel {
  const char *name;
  int *level;
};

#define DEBUG_LEVEL(x) { #x, &_debug_##x##_level }
  static const DebugLevel debug_level[] = {
  DEBUG_LEVEL(ai),
  DEBUG_LEVEL(driver),
  DEBUG_LEVEL(grf),
  DEBUG_LEVEL(map),
  DEBUG_LEVEL(misc),
  DEBUG_LEVEL(ms),
  DEBUG_LEVEL(net),
  DEBUG_LEVEL(sprite),
  DEBUG_LEVEL(oldloader),
  DEBUG_LEVEL(ntp),
  DEBUG_LEVEL(npf),
  DEBUG_LEVEL(yapf),
  DEBUG_LEVEL(freetype),
  DEBUG_LEVEL(sl),
  DEBUG_LEVEL(station),
  DEBUG_LEVEL(gamelog),
  DEBUG_LEVEL(desync),
  };
#undef DEBUG_LEVEL

#if !defined(NO_DEBUG_MESSAGES)

static void debug_print(const char *dbg, const char *buf)
{
#if defined(ENABLE_NETWORK)
  if (_debug_socket != INVALID_SOCKET) {
    char buf2[1024 + 32];

    snprintf(buf2, lengthof(buf2), "dbg: [%s] %s\n", dbg, buf);
    send(_debug_socket, buf2, (int)strlen(buf2), 0);
  } else
#endif /* ENABLE_NETWORK */
  if (strcmp(dbg, "desync") != 0) {
#if defined(WINCE)
    /* We need to do OTTD2FS twice, but as it uses a static buffer, we need to store one temporary */
    TCHAR tbuf[512];
    _sntprintf(tbuf, sizeof(tbuf), _T("%s"), OTTD2FS(dbg));
    NKDbgPrintfW(_T("dbg: [%s] %s\n"), tbuf, OTTD2FS(buf));
#else
    fprintf(stderr, "dbg: [%s] %s\n", dbg, buf);
#endif
    IConsoleDebug(dbg, buf);
  } else {
    static FILE *f = FioFOpenFile("commands-out.log", "wb", AUTOSAVE_DIR);
    if (f == NULL) return;

    fprintf(f, "%s", buf);
    fflush(f);
  }
}

void CDECL debug(const char *dbg, ...)
{
  va_list va;
  va_start(va, dbg);
  const char *s;
  char buf[1024];

  s = va_arg(va, const char*);
  vsnprintf(buf, lengthof(buf), s, va);
  va_end(va);

  debug_print(dbg, buf);
}
#endif /* NO_DEBUG_MESSAGES */

void SetDebugString(const char *s)
{
  int v;
  char *end;
  const char *t;

  /* global debugging level? */
  if (*s >= '0' && *s <= '9') {
    const DebugLevel *i;

    v = strtoul(s, &end, 0);
    s = end;

    for (i = debug_level; i != endof(debug_level); ++i) *i->level = v;
  }

  /* individual levels */
  for (;;) {
    const DebugLevel *i;
    int *p;

    /* skip delimiters */
    while (*s == ' ' || *s == ',' || *s == '\t') s++;
    if (*s == '\0') break;

    t = s;
    while (*s >= 'a' && *s <= 'z') s++;

    /* check debugging levels */
    p = NULL;
    for (i = debug_level; i != endof(debug_level); ++i)
      if (s == t + strlen(i->name) && strncmp(t, i->name, s - t) == 0) {
        p = i->level;
        break;
      }

    if (*s == '=') s++;
    v = strtoul(s, &end, 0);
    s = end;
    if (p != NULL) {
      *p = v;
    } else {
      ShowInfoF("Unknown debug level '%.*s'", s - t, t);
      return;
    }
  }
}

const char *GetDebugString()
{
  const DebugLevel *i;
  static char dbgstr[150];
  char dbgval[20];

  memset(dbgstr, 0, sizeof(dbgstr));
  i = debug_level;
  snprintf(dbgstr, sizeof(dbgstr), "%s=%d", i->name, *i->level);

  for (i++; i != endof(debug_level); i++) {
    snprintf(dbgval, sizeof(dbgval), ", %s=%d", i->name, *i->level);
    strecat(dbgstr, dbgval, lastof(dbgstr));
  }

  return dbgstr;
}