Changeset 11694 for trunk/psLib/src/sys/psLogMsg.h

Timestamp:

Feb 7, 2007, 3:59:28 PM (19 years ago)

Author:

jhoblitt

Message:

./sys header file cleanup:

formatting/whitespace fixes
add a few additional gcc attributes
mark p_psFileLine as deprecated

File:

• trunk/psLib/src/sys/psLogMsg.h (modified) (9 diffs)

trunk/psLib/src/sys/psLogMsg.h

@@ -9 +9 @@
  *  @author Robert Lupton, Princeton University
  *  @author GLG, MHPCC
+ *  @author Joshua Hoblitt, University of Hawaii
  *
- *  @version $Revision: 1.38 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2007-01-23 22:47:23 $
+ *  @version $Revision: 1.39 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2007-02-08 01:59:28 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -25 +26 @@
 #include "psType.h"
 
+
+///< Status codes for log messages
+enum {
+    PS_LOG_ABORT = 0,                  ///< log message is a critical error, perform an abort after printing
+    PS_LOG_ERROR,                      ///< log message is an error, but don't abort
+    PS_LOG_WARN,                       ///< log message is a warning
+    PS_LOG_INFO,                       ///< log message is informational only
+    PS_LOG_DETAIL,                     ///< log message provides details of minor interest
+    PS_LOG_MINUTIA,                    ///< log message provides very detailed information
+};
+
+
+///< Destinations for log messages
+enum {
+    PS_LOG_TO_NONE = 0,                ///< turn off logging
+    PS_LOG_TO_STDERR = 1,              ///< log to system's stderr
+    PS_LOG_TO_STDOUT = 2               ///< log to system's stdout
+};
+
 /** This procedure sets the destination for future log messages.
  *
@@ -36 +56 @@
 );
 
+
 /** This procedure returns the current log destination file descriptor.  If the
- *  destination has not been defined by the use, the descriptor for stdout is returned.
+ * destination has not been defined by the use, the descriptor for stdout is
+ * returned.
  *
  *  @return int:        The current file descriptor.
  */
 int psLogGetDestination();
+
 
 /** This procedure sets the message level for future log messages.  Subsequent
@@ -54 +77 @@
     int level                          ///< Specifies the system log level
 );
+
 
 /** This procedures returns the current log message level.
@@ -74 +98 @@
 );
 
+
 /** This procedures uses a string to set the destination for which to send
  *  the corresponding log messages.
@@ -83 +108 @@
 );
 
+
 /** This procedure logs a message to the destination set by a prior
  *  call to psLogSetDestination(), if myLevel is less than the level
@@ -89 +115 @@
  *
  */
-#ifdef __GNUC__
 void psLogMsg(
     const char *name,                  ///< name of the log source
@@ -95 +120 @@
     const char *format,                ///< printf-style format command
     ...
+#ifdef __GNUC__
 ) __attribute__((format(printf, 3, 4)));
-#else // __GNUC__
-void psLogMsg(
-    const char *name,                  ///< name of the log source
-    int level,                         ///< severity level of this log message
-    const char *format,                ///< printf-style format command
-    ...
+#else // ifdef __GNUC__
 );
-#endif // __GNUC__
+#endif // ifdef __GNUC__
 
-#ifndef SWIG
+
 /** This procedure is functionally equivalent to psLogMsg(), except that
  *  it takes a va_list as the message parameter, not a printf-style string.
  *
  */
+#ifndef SWIG
 void psLogMsgV(
     const char *name,                  ///< name of the log source
@@ -118 +140 @@
 #endif // #ifndef SWIG
 
-///< Status codes for log messages
-enum {
-    PS_LOG_ABORT = 0,                  ///< log message is a critical error, perform an abort after printing
-    PS_LOG_ERROR,                      ///< log message is an error, but don't abort
-    PS_LOG_WARN,                       ///< log message is a warning
-    PS_LOG_INFO,                       ///< log message is informational only
-    PS_LOG_DETAIL,                     ///< log message provides details of minor interest
-    PS_LOG_MINUTIA,                    ///< log message provides very detailed information
-};
-
-///< Destinations for log messages
-enum {
-    PS_LOG_TO_NONE = 0,                ///< turn off logging
-    PS_LOG_TO_STDERR = 1,              ///< log to system's stderr
-    PS_LOG_TO_STDOUT = 2               ///< log to system's stdout
-};
 
 /// @}