# debug.cpp

Go to the documentation of this file.

    00001 /* $Id: debug.cpp 19080 2010-02-10 16:12:54Z smatz $ */
    00002
    00003 /*
    00004  * This file is part of OpenTTD.
    00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
    00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
    00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
    00008  */
    00009
    00012 #include "stdafx.h"
    00013 #include <stdarg.h>
    00014 #include "console_func.h"
    00015 #include "debug.h"
    00016 #include "string_func.h"
    00017 #include "fileio_func.h"
    00018 #include "settings_type.h"
    00019
    00020 #include <time.h>
    00021
    00022 #if defined(ENABLE_NETWORK)
    00023 #include "network/core/os_abstraction.h"
    00024 SOCKET _debug_socket = INVALID_SOCKET;
    00025 #endif /* ENABLE_NETWORK */
    00026
    00027 int _debug_ai_level;
    00028 int _debug_driver_level;
    00029 int _debug_grf_level;
    00030 int _debug_map_level;
    00031 int _debug_misc_level;
    00032 int _debug_net_level;
    00033 int _debug_sprite_level;
    00034 int _debug_oldloader_level;
    00035 int _debug_npf_level;
    00036 int _debug_yapf_level;
    00037 int _debug_freetype_level;
    00038 int _debug_sl_level;
    00039 int _debug_gamelog_level;
    00040 int _debug_desync_level;
    00041 int _debug_console_level;
    00042
    00043
    00044 struct DebugLevel {
    00045   const char *name;
    00046   int *level;
    00047 };
    00048
    00049 #define DEBUG_LEVEL(x) { #x, &_debug_##x##_level }
    00050   static const DebugLevel debug_level[] = {
    00051   DEBUG_LEVEL(ai),
    00052   DEBUG_LEVEL(driver),
    00053   DEBUG_LEVEL(grf),
    00054   DEBUG_LEVEL(map),
    00055   DEBUG_LEVEL(misc),
    00056   DEBUG_LEVEL(net),
    00057   DEBUG_LEVEL(sprite),
    00058   DEBUG_LEVEL(oldloader),
    00059   DEBUG_LEVEL(npf),
    00060   DEBUG_LEVEL(yapf),
    00061   DEBUG_LEVEL(freetype),
    00062   DEBUG_LEVEL(sl),
    00063   DEBUG_LEVEL(gamelog),
    00064   DEBUG_LEVEL(desync),
    00065   DEBUG_LEVEL(console),
    00066   };
    00067 #undef DEBUG_LEVEL
    00068
    00069 #if !defined(NO_DEBUG_MESSAGES)
    00070
    00071 static void debug_print(const char *dbg, const char *buf)
    00072 {
    00073 #if defined(ENABLE_NETWORK)
    00074   if (_debug_socket != INVALID_SOCKET) {
    00075     char buf2[1024 + 32];
    00076
    00077     snprintf(buf2, lengthof(buf2), "%sdbg: [%s] %s\n", GetLogPrefix(), dbg, buf);
    00078     send(_debug_socket, buf2, (int)strlen(buf2), 0);
    00079     return;
    00080   }
    00081 #endif /* ENABLE_NETWORK */
    00082   if (strcmp(dbg, "desync") != 0) {
    00083 #if defined(WINCE)
    00084     /* We need to do OTTD2FS twice, but as it uses a static buffer, we need to store one temporary */
    00085     TCHAR tbuf[512];
    00086     _sntprintf(tbuf, sizeof(tbuf), _T("%s"), OTTD2FS(dbg));
    00087     NKDbgPrintfW(_T("dbg: [%s] %s\n"), tbuf, OTTD2FS(buf));
    00088 #else
    00089     fprintf(stderr, "%sdbg: [%s] %s\n", GetLogPrefix(), dbg, buf);
    00090 #endif
    00091     IConsoleDebug(dbg, buf);
    00092   } else {
    00093     static FILE *f = FioFOpenFile("commands-out.log", "wb", AUTOSAVE_DIR);
    00094     if (f == NULL) return;
    00095
    00096     fprintf(f, "%s%s", GetLogPrefix(), buf);
    00097     fflush(f);
    00098   }
    00099 }
    00100
    00101 void CDECL debug(const char *dbg, const char *format, ...)
    00102 {
    00103   char buf[1024];
    00104
    00105   va_list va;
    00106   va_start(va, format);
    00107   vsnprintf(buf, lengthof(buf), format, va);
    00108   va_end(va);
    00109
    00110   debug_print(dbg, buf);
    00111 }
    00112 #endif /* NO_DEBUG_MESSAGES */
    00113
    00114 void SetDebugString(const char *s)
    00115 {
    00116   int v;
    00117   char *end;
    00118   const char *t;
    00119
    00120   /* global debugging level? */
    00121   if (*s >= '0' && *s <= '9') {
    00122     const DebugLevel *i;
    00123
    00124     v = strtoul(s, &end, 0);
    00125     s = end;
    00126
    00127     for (i = debug_level; i != endof(debug_level); ++i) *i->level = v;
    00128   }
    00129
    00130   /* individual levels */
    00131   for (;;) {
    00132     const DebugLevel *i;
    00133     int *p;
    00134
    00135     /* skip delimiters */
    00136     while (*s == ' ' || *s == ',' || *s == '\t') s++;
    00137     if (*s == '\0') break;
    00138
    00139     t = s;
    00140     while (*s >= 'a' && *s <= 'z') s++;
    00141
    00142     /* check debugging levels */
    00143     p = NULL;
    00144     for (i = debug_level; i != endof(debug_level); ++i)
    00145       if (s == t + strlen(i->name) && strncmp(t, i->name, s - t) == 0) {
    00146         p = i->level;
    00147         break;
    00148       }
    00149
    00150     if (*s == '=') s++;
    00151     v = strtoul(s, &end, 0);
    00152     s = end;
    00153     if (p != NULL) {
    00154       *p = v;
    00155     } else {
    00156       ShowInfoF("Unknown debug level '%.*s'", (int)(s - t), t);
    00157       return;
    00158     }
    00159   }
    00160 }
    00161
    00166 const char *GetDebugString()
    00167 {
    00168   const DebugLevel *i;
    00169   static char dbgstr[150];
    00170   char dbgval[20];
    00171
    00172   memset(dbgstr, 0, sizeof(dbgstr));
    00173   i = debug_level;
    00174   snprintf(dbgstr, sizeof(dbgstr), "%s=%d", i->name, *i->level);
    00175
    00176   for (i++; i != endof(debug_level); i++) {
    00177     snprintf(dbgval, sizeof(dbgval), ", %s=%d", i->name, *i->level);
    00178     strecat(dbgstr, dbgval, lastof(dbgstr));
    00179   }
    00180
    00181   return dbgstr;
    00182 }
    00183
    00189 const char *GetLogPrefix()
    00190 {
    00191   static char _log_prefix[24];
    00192   if (_settings_client.gui.show_date_in_logs) {
    00193     time_t cur_time = time(NULL);
    00194     strftime(_log_prefix, sizeof(_log_prefix), "[%Y-%m-%d %H:%M:%S] ", localtime(&cur_time));
    00195   } else {
    00196     *_log_prefix = '\0';
    00197   }
    00198   return _log_prefix;
    00199 }
    00200