зеркало из https://github.com/mozilla/pjs.git
185 строки
6.2 KiB
C
185 строки
6.2 KiB
C
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
*
|
|
* The contents of this file are subject to the Netscape Public License
|
|
* Version 1.0 (the "NPL"); you may not use this file except in
|
|
* compliance with the NPL. You may obtain a copy of the NPL at
|
|
* http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
|
* for the specific language governing rights and limitations under the
|
|
* NPL.
|
|
*
|
|
* The Initial Developer of this code under the NPL is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
|
* Reserved.
|
|
*/
|
|
|
|
|
|
#ifndef _XP_Assert_
|
|
#define _XP_Assert_
|
|
|
|
#include "xp_trace.h"
|
|
/*include <stdlib.h>*/
|
|
|
|
/*-----------------------------------------------------------------------------
|
|
abort
|
|
|
|
For debug builds...
|
|
XP_ABORT(X), unlike abort(), takes a text string argument. It will print
|
|
it out and then call abort (to drop you into your debugger).
|
|
|
|
For release builds...
|
|
XP_ABORT will call abort(). Whether you #define NDEBUG or not is up
|
|
to you.
|
|
-----------------------------------------------------------------------------*/
|
|
#define XP_ABORT(MESSAGE) (XP_TRACE(MESSAGE),abort())
|
|
|
|
/*-----------------------------------------------------------------------------
|
|
XP_ASSERT is just like "assert" but calls XP_ABORT if it fails the test.
|
|
I need this (on a Mac) because "assert" and "abort" are braindead,
|
|
whereas my XP_Abort function will invoke the debugger. It could
|
|
possibly have been easier to just #define assert to be something decent.
|
|
-----------------------------------------------------------------------------*/
|
|
|
|
#if defined (XP_UNIX)
|
|
#if !defined(NO_UNIX_SKIP_ASSERTS)
|
|
/* Turning UNIX_SKIP_ASSERTS on by default. */
|
|
/* (Solaris 2.x) on Sol2.5, assert() does not work. Too bad... */
|
|
/* Therefore, we print the line where assert happened instead. */
|
|
/* Print out a \007 to sound the bell. -mcafee */
|
|
#define XP_AssertAtLine() fprintf(stderr, "assert: line %d, file %s%c\n", __LINE__, __FILE__, 7)
|
|
#ifdef DEBUG
|
|
#define XP_ASSERT(X) ( (((X))!=0)? (void)0: (void)XP_AssertAtLine() )
|
|
#else
|
|
#define XP_ASSERT(X) (void)0
|
|
#endif
|
|
#else
|
|
#include <assert.h>
|
|
#define XP_ASSERT(X) assert(X) /* are we having fun yet? */
|
|
#endif
|
|
|
|
#elif defined (XP_WIN)
|
|
#ifdef DEBUG
|
|
|
|
/* LTNOTE: I got tired of seeing all asserts at FEGUI.CPP. This should
|
|
* Fix the problem. I intentionally left out Win16 because strings are stuffed
|
|
* into the datasegment we probably couldn't build.
|
|
*/
|
|
#ifdef WIN32
|
|
XP_BEGIN_PROTOS
|
|
extern void XP_AssertAtLine( char *pFileName, int iLine );
|
|
XP_END_PROTOS
|
|
#define XP_ASSERT(X) ( ((X)!=0)? (void)0: XP_AssertAtLine(__FILE__,__LINE__))
|
|
|
|
#else /* win16 */
|
|
#define XP_ASSERT(X) ( ((X)!=0)? (void)0: XP_Assert((X) != 0) )
|
|
XP_BEGIN_PROTOS
|
|
void XP_Assert(int);
|
|
XP_END_PROTOS
|
|
#endif
|
|
|
|
#else
|
|
#define XP_ASSERT(X) ((void) 0)
|
|
#endif
|
|
|
|
#elif defined (XP_OS2)
|
|
#ifdef DEBUG
|
|
#include <assert.h>
|
|
#define XP_ASSERT(X) assert(X) /* IBM-DAK same as UNIX */
|
|
#else
|
|
#define XP_ASSERT(X)
|
|
#endif
|
|
|
|
#elif defined(XP_MAC)
|
|
|
|
#ifdef DEBUG
|
|
#ifdef __cplusplus
|
|
#ifdef __MWERKS__
|
|
/*
|
|
** See the comment above: XP_ASSERT is supposed to abort!
|
|
** The MacFE_Signal is actually not in the spirit of the creator of XP_Assert.
|
|
** Also, the previous version was annoying (always seen in uapp.cp)
|
|
** The Metrowerks Assert_ macro is much more helpful...
|
|
*/
|
|
#include <UException.h>
|
|
#define XP_ASSERT(X) Assert_(X)
|
|
#else
|
|
extern "C" void debugstr(const char* s);
|
|
#endif
|
|
#else
|
|
extern void debugstr(const char* s);
|
|
#endif
|
|
#ifndef XP_ASSERT
|
|
/* The following is wrong... because it will cause
|
|
the use of an XP_ASSERT within an if ... else ...
|
|
construct to match incorrectly with the "last prior if" :-/
|
|
XXX
|
|
*/
|
|
#define XP_ASSERT(X) if (!(X)) debugstr(#X)
|
|
#endif
|
|
#else
|
|
#define XP_ASSERT(X)
|
|
#endif
|
|
|
|
#endif /* XP_MAC */
|
|
|
|
/*-----------------------------------------------------------------------------
|
|
assert variants
|
|
|
|
XP_WARN_ASSERT if defined to nothing for release builds. This means
|
|
that instead of
|
|
#ifdef DEBUG
|
|
assert (X);
|
|
#endif
|
|
you can just do
|
|
XP_WARN_ASSERT(X);
|
|
|
|
Of course when asserts fail that means something is going wrong and you
|
|
*should* have normal code to deal with that.
|
|
I frequently found myself writing code like this:
|
|
#ifdef DEBUG
|
|
assert (aPtr);
|
|
#endif
|
|
if (!aPtr)
|
|
return error_something_has_gone_wrong;
|
|
so I just combined them into a macro that can be used like this:
|
|
if (XP_FAIL_ASSERT(aPtr))
|
|
return; // or whatever else you do when things go wrong
|
|
What this means is it will return if X *fails* the test. Essentially
|
|
the XP_FAIL_ASSERT bit replaces the "!" in the if test.
|
|
|
|
XP_OK_ASSERT is the opposite. If if you want to do something only if
|
|
something is OK, then use it. For example:
|
|
if (XP_OK_ASSERT(aPtr))
|
|
aPtr->aField = 25;
|
|
Use this if you are 99% sure that aPtr will be valid. If it ever is not,
|
|
you'll drop into the debugger. For release builds, it turns into an
|
|
if statement, so it's completely safe to execute.
|
|
|
|
You can also do XP_VERIFY, which essentially will throw an assert if a
|
|
condition fails in debug mode, but just do whatever at runtime. For
|
|
example:
|
|
|
|
XP_VERIFY(PR_LoadLibrary("foo") == 0);
|
|
|
|
This will trigger an XP_ASSERT if the condition fails during debug, bug
|
|
just run the PR_LoadLibrary in release. Kind of the same as XP_WARN_ASSERT,
|
|
but the "verbiage" is a bit clearer (to me, anyway).
|
|
-----------------------------------------------------------------------------*/
|
|
#ifdef DEBUG
|
|
# define XP_WARN_ASSERT(X) ( ((X)!=0)? (void)0: XP_ABORT((#X)) )
|
|
# define XP_OK_ASSERT(X) (((X)!=0)? 1: (XP_ABORT((#X)),0))
|
|
# define XP_FAIL_ASSERT(X) (((X)!=0)? 0: (XP_ABORT((#X)),1))
|
|
# define XP_VERIFY(X) ( (X)? (void)0: XP_ASSERT(0) )
|
|
#else
|
|
# define XP_WARN_ASSERT(X) (void)((X)!=0)
|
|
# define XP_OK_ASSERT(X) (((X)!=0)? 1: 0)
|
|
# define XP_FAIL_ASSERT(X) (((X)!=0)? 0: 1)
|
|
# define XP_VERIFY(X) ( (void)(X) )
|
|
#endif
|
|
|
|
#endif /* _XP_Assert_ */
|
|
|