Changeset 11057

Timestamp:

02/12/10 12:45:00 (3 years ago)

Author:

robert

Message:

Introduced OSG_WARN, OSG_NOTICE, OSG_INFO, OSG_DEBUG convinience macros that map to OSG_NOTIFY(osg::WARN) etc.

Introduced the OSG_NOTIFY_DISABLE Cmake variable + include/osg/Config #define to control whether the OpenSceneGraph build
should disable the notification system completely. By setting OSG_NOTIFY_DISABLE to ON in CMake and then rebuilding the
the OSG you can get a slightly smaller (~1%) and more slightly efficient library which can be good for shipping applications,
but with downside of reduced ability to detect runtime problems and their causes.

Location:

OpenSceneGraph/trunk

Files:

• CMakeLists.txt (modified) (1 diff)
• include/osg/Notify (modified) (2 diffs)
• src/osg/Config.in (modified) (1 diff)
• src/osg/Notify.cpp (modified) (7 diffs)

OpenSceneGraph/trunk/CMakeLists.txt

@@ -264 +264 @@
 #luigi#ENDIF(UNIX)
 ########################################################################################################
+
+OPTION(OSG_NOTIFY_DISABLED "Set to ON to build OpenSceneGraph with the noitfy() disabled." OFF)
 
 OPTION(OSG_USE_FLOAT_MATRIX "Set to ON to build OpenSceneGraph with float Matrix instead of double." OFF)

OpenSceneGraph/trunk/include/osg/Notify

@@ -46 +46 @@
 extern OSG_EXPORT NotifySeverity getNotifyLevel();
 
-/** is notification enabled, given the current setNotifyLevel() setting? */
-extern OSG_EXPORT bool isNotifyEnabled(NotifySeverity severity);
-
 /** initialize notify level. */
 extern OSG_EXPORT bool initNotifyLevel();
+
+#ifdef OSG_NOTIFY_DISABLED
+    inline bool isNotifyEnabled(NotifySeverity) { return false; }
+#else
+    /** is notification enabled, given the current setNotifyLevel() setting? */
+    extern OSG_EXPORT bool isNotifyEnabled(NotifySeverity severity);
+#endif
 
 /** notify messaging function for providing fatal through to verbose
@@ -77 +81 @@
 
 #define OSG_NOTIFY(level) if (isNotifyEnabled(level)) osg::notify(level)
-
-#if _DEBUG
-    #define OSG_DEBUG_NOTIFY(level) if (isNotifyEnabled(level)) osg::notify(level)
-#else
-    // when using an optimized build use if (false) to tell the compiler to ignore the rest of the notify.
-    #define OSG_DEBUG_NOTIFY(level) if (false) osg::notify(level)
-#endif
+#define OSG_FATAL OSG_NOTIFY(osg::FALTAL)
+#define OSG_WARN OSG_NOTIFY(osg::WARN)
+#define OSG_NOTICE OSG_NOTIFY(osg::NOTICE)
+#define OSG_INFO OSG_NOTIFY(osg::INFO)
+#define OSG_DEBUG OSG_NOTIFY(osg::DEBUG_INFO)
 
 /** Handler processing output of notification stream. It acts as a sink to 

OpenSceneGraph/trunk/src/osg/Config.in

@@ -24 +24 @@
 #define OSG_CONFIG 1
 
+#cmakedefine OSG_NOTIFY_DISABLED
 #cmakedefine OSG_USE_FLOAT_MATRIX
 #cmakedefine OSG_USE_FLOAT_PLANE

OpenSceneGraph/trunk/src/osg/Notify.cpp

@@ -115 +115 @@
 static osg::ApplicationUsageProxy Notify_e0(osg::ApplicationUsage::ENVIRONMENTAL_VARIABLE, "OSG_NOTIFY_LEVEL <mode>", "FATAL | WARN | NOTICE | DEBUG_INFO | DEBUG_FP | DEBUG | INFO | ALWAYS");
 
+static bool s_NeedNotifyInit = true;
 static osg::NotifySeverity g_NotifyLevel = osg::NOTICE;
 static osg::NullStream *g_NullStream;
@@ -121 +122 @@
 void osg::setNotifyLevel(osg::NotifySeverity severity)
 {
-    osg::initNotifyLevel();
+    if (s_NeedNotifyInit) osg::initNotifyLevel();
     g_NotifyLevel = severity;
 }
@@ -128 +129 @@
 osg::NotifySeverity osg::getNotifyLevel()
 {
-    osg::initNotifyLevel();
+    if (s_NeedNotifyInit) osg::initNotifyLevel();
     return g_NotifyLevel;
 }
@@ -141 +142 @@
 osg::NotifyHandler* osg::getNotifyHandler()
 {
-    osg::initNotifyLevel();
+    if (s_NeedNotifyInit) osg::initNotifyLevel();
     osg::NotifyStreamBuffer *buffer = static_cast<osg::NotifyStreamBuffer *>(g_NotifyStream->rdbuf());
     return buffer ? buffer->getNotifyHandler() : 0;
@@ -148 +149 @@
 bool osg::initNotifyLevel()
 {
-    static bool s_NotifyInit = false;
     static osg::NullStream s_NullStream;
     static osg::NotifyStream s_NotifyStream;
-
-    if (s_NotifyInit) return true;
 
     g_NullStream = &s_NullStream;
@@ -194 +192 @@
         buffer->setNotifyHandler(new StandardNotifyHandler);
 
-    s_NotifyInit = true;
+    s_NeedNotifyInit = false;
 
     return true;
@@ -200 +198 @@
 }
 
+#ifndef OSG_NOTIFY_DISABLED
 bool osg::isNotifyEnabled( osg::NotifySeverity severity )
 {
+    if (s_NeedNotifyInit) osg::initNotifyLevel();
     return severity<=g_NotifyLevel;
 }
+#endif
 
 std::ostream& osg::notify(const osg::NotifySeverity severity)
 {
-    static bool initialized = false;
-    if (!initialized) 
-    {
-        initialized = osg::initNotifyLevel();
-    }
-
-    if (severity<=g_NotifyLevel)
+    if (s_NeedNotifyInit) osg::initNotifyLevel();
+
+    if (osg::isNotifyEnabled(severity))
     {
         g_NotifyStream->setCurrentSeverity(severity);