Back to index

lightning-sunbird  0.9+nobinonly
xpclog.h
Go to the documentation of this file.
00001 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is Mozilla Communicator client code, released
00017  * March 31, 1998.
00018  *
00019  * The Initial Developer of the Original Code is
00020  * Netscape Communications Corporation.
00021  * Portions created by the Initial Developer are Copyright (C) 1998
00022  * the Initial Developer. All Rights Reserved.
00023  *
00024  * Contributor(s):
00025  *   John Bandhauer <jband@netscape.com> (original author)
00026  *
00027  * Alternatively, the contents of this file may be used under the terms of
00028  * either of the GNU General Public License Version 2 or later (the "GPL"),
00029  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00030  * in which case the provisions of the GPL or the LGPL are applicable instead
00031  * of those above. If you wish to allow use of your version of this file only
00032  * under the terms of either the GPL or the LGPL, and not to allow others to
00033  * use your version of this file under the terms of the MPL, indicate your
00034  * decision by deleting the provisions above and replace them with the notice
00035  * and other provisions required by the GPL or the LGPL. If you do not delete
00036  * the provisions above, a recipient may use your version of this file under
00037  * the terms of any one of the MPL, the GPL or the LGPL.
00038  *
00039  * ***** END LICENSE BLOCK ***** */
00040 
00041 /* Debug Logging support. */
00042 
00043 #ifndef xpclog_h___
00044 #define xpclog_h___
00045 
00046 #include "nsIXPConnect.h"
00047 #include "prtypes.h"
00048 #include "prlog.h"
00049 
00050 /*
00051  * This uses prlog.h See prlog.h for environment settings for output.
00052  * The module name used here is 'xpclog'. These environment settings
00053  * should work...
00054  *
00055  * SET NSPR_LOG_MODULES=xpclog:5
00056  * SET NSPR_LOG_FILE=logfile.txt
00057  *
00058  * usage:
00059  *   XPC_LOG_ERROR(("my comment number %d", 5))   // note the double parens
00060  *
00061  */
00062 
00063 #ifdef DEBUG
00064 #define XPC_LOG_INTERNAL(number,_args)  \
00065     do{if(XPC_Log_Check(number)){XPC_Log_print _args;}}while(0)
00066 
00067 #define XPC_LOG_ALWAYS(_args)   XPC_LOG_INTERNAL(1,_args)
00068 #define XPC_LOG_ERROR(_args)    XPC_LOG_INTERNAL(2,_args)
00069 #define XPC_LOG_WARNING(_args)  XPC_LOG_INTERNAL(3,_args)
00070 #define XPC_LOG_DEBUG(_args)    XPC_LOG_INTERNAL(4,_args)
00071 #define XPC_LOG_FLUSH()         PR_LogFlush()
00072 #define XPC_LOG_INDENT()        XPC_Log_Indent()
00073 #define XPC_LOG_OUTDENT()       XPC_Log_Outdent()
00074 #define XPC_LOG_CLEAR_INDENT()  XPC_Log_Clear_Indent()
00075 #define XPC_LOG_FINISH()        XPC_Log_Finish()
00076 
00077 JS_BEGIN_EXTERN_C
00078 
00079 void   XPC_Log_print(const char *fmt, ...);
00080 PRBool XPC_Log_Check(int i);
00081 void   XPC_Log_Indent();
00082 void   XPC_Log_Outdent();
00083 void   XPC_Log_Clear_Indent();
00084 void   XPC_Log_Finish();
00085 
00086 JS_END_EXTERN_C
00087 
00088 #else
00089 
00090 #define XPC_LOG_ALWAYS(_args)  ((void)0)
00091 #define XPC_LOG_ERROR(_args)   ((void)0)
00092 #define XPC_LOG_WARNING(_args) ((void)0)
00093 #define XPC_LOG_DEBUG(_args)   ((void)0)
00094 #define XPC_LOG_FLUSH()        ((void)0)
00095 #define XPC_LOG_INDENT()       ((void)0)
00096 #define XPC_LOG_OUTDENT()      ((void)0)
00097 #define XPC_LOG_CLEAR_INDENT() ((void)0)
00098 #define XPC_LOG_FINISH()       ((void)0)
00099 #endif
00100 
00101 #endif /* xpclog_h___ */