Back to index

lightning-sunbird  0.9+nobinonly
BrowserDiagnostics.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Adam Lock <adamlock@eircom.net>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 #ifndef BROWSER_DIAGNOSTICS_H
00039 #define BROWSER_DIAGNOSTICS_H
00040 
00041 #ifdef _DEBUG
00042 #  include <assert.h>
00043 #  define NG_TRACE NgTrace
00044 #  define NG_TRACE_METHOD(fn) \
00045     { \
00046         NG_TRACE(_T("0x%04x %s()\n"), (int) GetCurrentThreadId(), _T(#fn)); \
00047     }
00048 #  define NG_TRACE_METHOD_ARGS(fn, pattern, args) \
00049     { \
00050         NG_TRACE(_T("0x%04x %s(") _T(pattern) _T(")\n"), (int) GetCurrentThreadId(), _T(#fn), args); \
00051     }
00052 #  define NG_ASSERT(expr) assert(expr)
00053 #  define NG_ASSERT_POINTER(p, type) \
00054     NG_ASSERT(((p) != NULL) && NgIsValidAddress((p), sizeof(type), FALSE))
00055 #  define NG_ASSERT_NULL_OR_POINTER(p, type) \
00056     NG_ASSERT(((p) == NULL) || NgIsValidAddress((p), sizeof(type), FALSE))
00057 #else
00058 #  define NG_TRACE 1 ? (void)0 : NgTrace
00059 #  define NG_TRACE_METHOD(fn)
00060 #  define NG_TRACE_METHOD_ARGS(fn, pattern, args)
00061 #  define NG_ASSERT(X)
00062 #  define NG_ASSERT_POINTER(p, type)
00063 #  define NG_ASSERT_NULL_OR_POINTER(p, type)
00064 #endif
00065 
00066 #define NG_TRACE_ALWAYS AtlTrace
00067 
00068 inline void _cdecl NgTrace(LPCSTR lpszFormat, ...)
00069 {
00070     va_list args;
00071     va_start(args, lpszFormat);
00072 
00073     int nBuf;
00074     char szBuffer[512];
00075 
00076     nBuf = _vsnprintf(szBuffer, sizeof(szBuffer), lpszFormat, args);
00077     NG_ASSERT(nBuf < sizeof(szBuffer)); //Output truncated as it was > sizeof(szBuffer)
00078 
00079     OutputDebugStringA(szBuffer);
00080     va_end(args);
00081 }
00082 
00083 inline BOOL NgIsValidAddress(const void* lp, UINT nBytes, BOOL bReadWrite = TRUE)
00084 {
00085     return (lp != NULL && !IsBadReadPtr(lp, nBytes) &&
00086         (!bReadWrite || !IsBadWritePtr((LPVOID)lp, nBytes)));
00087 }
00088 
00089 #endif