Automated merge with http://hg.secondlife.com/viewer-release

1 files changed, 44 insertions, 36 deletions

diff --git a/indra/llcommon/llerrorcontrol.h b/indra/llcommon/llerrorcontrol.h
index ed9de002f5..d53a819d88 100644
--- a/indra/llcommon/llerrorcontrol.h
+++ b/indra/llcommon/llerrorcontrol.h
@@ -1,4 +1,4 @@
-/** 
+/**
  * @file llerrorcontrol.h
  * @date   December 2006
  * @brief error message system control
@@ -6,21 +6,21 @@
  * $LicenseInfo:firstyear=2007&license=viewerlgpl$
  * Second Life Viewer Source Code
  * Copyright (C) 2010, Linden Research, Inc.
- * 
+ *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation;
  * version 2.1 of the License only.
- * 
+ *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
- * 
+ *
  * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
  * $/LicenseInfo$
  */
@@ -38,7 +38,7 @@ class LLSD;
 	This is the part of the LLError namespace that manages the messages
 	produced by the logging.  The logging support is defined in llerror.h.
 	Most files do not need to include this.
-	
+
 	These implementations are in llerror.cpp.
 */
 
@@ -72,7 +72,7 @@ namespace LLError
 		Settings that control what is logged.
 		Setting a level means log messages at that level or above.
 	*/
-	
+
 	LL_COMMON_API void setPrintLocation(bool);
 	LL_COMMON_API void setDefaultLevel(LLError::ELevel);
 	LL_COMMON_API ELevel getDefaultLevel();
@@ -80,7 +80,8 @@ namespace LLError
 	LL_COMMON_API void setClassLevel(const std::string& class_name, LLError::ELevel);
 	LL_COMMON_API void setFileLevel(const std::string& file_name, LLError::ELevel);
 	LL_COMMON_API void setTagLevel(const std::string& file_name, LLError::ELevel);
-	
+
+	LL_COMMON_API LLError::ELevel decodeLevel(std::string name);
 	LL_COMMON_API void configure(const LLSD&);
 		// the LLSD can configure all of the settings
 		// usually read automatically from the live errorlog.xml file
@@ -100,31 +101,31 @@ namespace LLError
 		// (by, for example, setting a class level to LEVEL_NONE), will keep
 		// the that message from causing the fatal funciton to be invoked.
 
-    LL_COMMON_API FatalFunction getFatalFunction();
-        // Retrieve the previously-set FatalFunction
-
-    /// temporarily override the FatalFunction for the duration of a
-    /// particular scope, e.g. for unit tests
-    class LL_COMMON_API OverrideFatalFunction
-    {
-    public:
-        OverrideFatalFunction(const FatalFunction& func):
-            mPrev(getFatalFunction())
-        {
-            setFatalFunction(func);
-        }
-        ~OverrideFatalFunction()
-        {
-            setFatalFunction(mPrev);
-        }
-
-    private:
-        FatalFunction mPrev;
-    };
+	LL_COMMON_API FatalFunction getFatalFunction();
+		// Retrieve the previously-set FatalFunction
+
+	/// temporarily override the FatalFunction for the duration of a
+	/// particular scope, e.g. for unit tests
+	class LL_COMMON_API OverrideFatalFunction
+	{
+	public:
+		OverrideFatalFunction(const FatalFunction& func):
+			mPrev(getFatalFunction())
+		{
+			setFatalFunction(func);
+		}
+		~OverrideFatalFunction()
+		{
+			setFatalFunction(mPrev);
+		}
+
+	private:
+		FatalFunction mPrev;
+	};
 
 	typedef std::string (*TimeFunction)();
 	LL_COMMON_API std::string utcTime();
-	
+
 	LL_COMMON_API void setTimeFunction(TimeFunction);
 		// The function is use to return the current time, formatted for
 		// display by those error recorders that want the time included.
@@ -136,19 +137,27 @@ namespace LLError
 		// An object that handles the actual output or error messages.
 	public:
 		virtual ~Recorder();
-		
+
 		virtual void recordMessage(LLError::ELevel, const std::string& message) = 0;
 			// use the level for better display, not for filtering
-			
+
 		virtual bool wantsTime(); // default returns false
 			// override and return true if the recorder wants the time string
 			// included in the text of the message
 	};
-	
+
+	/**
+	 * @NOTE: addRecorder() conveys ownership to the underlying Settings
+	 * object -- when destroyed, it will @em delete the passed Recorder*!
+	 */
 	LL_COMMON_API void addRecorder(Recorder*);
+	/**
+	 * @NOTE: removeRecorder() reclaims ownership of the Recorder*: its
+	 * lifespan becomes the caller's problem.
+	 */
 	LL_COMMON_API void removeRecorder(Recorder*);
 		// each error message is passed to each recorder via recordMessage()
-	
+
 	LL_COMMON_API void logToFile(const std::string& filename);
 	LL_COMMON_API void logToFixedBuffer(LLLineBuffer*);
 		// Utilities to add recorders for logging to a file or a fixed buffer
@@ -166,10 +175,9 @@ namespace LLError
 	class Settings;
 	LL_COMMON_API Settings* saveAndResetSettings();
 	LL_COMMON_API void restoreSettings(Settings *);
-		
+
 	LL_COMMON_API std::string abbreviateFile(const std::string& filePath);
 	LL_COMMON_API int shouldLogCallCount();
-	
 };
 
 #endif // LL_LLERRORCONTROL_H