X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseLog.h;h=cec83bc459d3842d6c4acde2fda692943aa412ab;hb=77c8179523073aa4881bd317fb7b31f260682eb3;hp=6426fa4c409d48b9c50f410224fc3075e20535c4;hpb=e905f81375fca80387e991b33a8347b6feb9d25a;p=platform%2Fframework%2Fnative%2Fappfw.git

diff --git a/inc/FBaseLog.h b/inc/FBaseLog.h
index 6426fa4..cec83bc 100644
--- a/inc/FBaseLog.h
+++ b/inc/FBaseLog.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -755,121 +754,582 @@ extern "C" {
  *
  * @{
  */
+
 #if (defined(_APP_LOG) || defined(_OSP_DEBUG_) || defined(_DEBUG)) && defined(_SECURE_LOG)
 
 #define AppSecureLog(...)			AppLogInternal(__PRETTY_FUNCTION__, __LINE__, "[SECURE_LOG] "__VA_ARGS__)
+#define AppSecureLogDebug(...)			AppLogDebugInternal(__PRETTY_FUNCTION__, __LINE__, "[SECURE_LOG] "__VA_ARGS__)
 #define AppSecureLogException(...)		AppLogExceptionInternal(__PRETTY_FUNCTION__, __LINE__, "[SECURE_LOG] "__VA_ARGS__)
 
 #define AppSecureLogTag(tag, ...)		AppLogTagInternal(tag, __PRETTY_FUNCTION__, __LINE__, "[SECURE_LOG] "__VA_ARGS__)
+#define AppSecureLogDebugTag(tag, ...)		AppLogDebugTagInternal(tag, __PRETTY_FUNCTION__, __LINE__, "[SECURE_LOG] "__VA_ARGS__)
 #define AppSecureLogExceptionTag(tag, ...)	AppLogExceptionTagInternal(tag, __PRETTY_FUNCTION__, __LINE__, "[SECURE_LOG] "__VA_ARGS__)
 
 #else
 /**
-* This macro is to protect informative log messages which needs to keep security.
-* It allows display of informative log messages if compiled with "_SECURE_LOG" definition.
-* Otherwise, it will be removed in the compile time.
-*
-* @since 2.1
-*
-* @param[in]	...			The message to display
-*
-* The following example demonstrates how to use the AppSecureLog macro.
-*
-* @code
-*        bool
-*        MyEngine::Init(int value)
-*        {
-*           AppSecureLog("User ID : 'JoneDoe'");
-*
-*           return true;
-*        }
-* @endcode
-* @hideinitializer
-*/
+ * This macro is to protect informative log messages which needs to keep security.
+ * It allows display of informative log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, it will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	...			The message to display
+ *
+ * The following example demonstrates how to use the AppSecureLog macro.
+ *
+ * @code
+ *        bool
+ *        MyEngine::Init(int value)
+ *        {
+ *           AppSecureLog("User ID : 'JoneDoe'");
+ *
+ *           return true;
+ *        }
+ * @endcode
+ * @hideinitializer
+ */
 #define AppSecureLog(...)
 
 /**
-* This macro is to protect exception log messages which needs to keep security.
-* It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
-* Otherwise, it will be removed in the compile time.
-*
-* @since 2.1
-*
-* @param[in]	...			The message to display
-*
-* The following example demonstrates how to use the AppSecureLogException macro.
-*
-* @code
-*        bool
-*        MyEngine::Init(int value)
-*        {
-*           //...
-*           if (something_wrong)
-*           {
-*              AppSecureLogException("User ID : 'JoneDoe' mismatch.");
-*
-*              return false;
-*           }
-*   //...
-*
-*           return true;
-*        }
-* @endcode
-* @hideinitializer
-*/
+ * This macro is to protect debug log messages which needs to keep security.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, it will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	...			The message to display
+ *
+ * The following example demonstrates how to use the AppSecureLogDebug macro.
+ *
+ * @code
+ *        bool
+ *        MyEngine::Init(int value)
+ *        {
+ *           //...
+ *           if (something_wrong)
+ *           {
+ *              AppSecureLogDebug("User ID : 'JoneDoe' mismatch.");
+ *
+ *              return false;
+ *           }
+ *   //...
+ *
+ *           return true;
+ *        }
+ * @endcode
+ * @hideinitializer
+ */
+#define AppSecureLogDebug(...)
+
+/**
+ * This macro is to protect exception log messages which needs to keep security.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, it will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	...			The message to display 
+ *
+ * The following example demonstrates how to use the AppSecureLogException macro.
+ *
+ * @code
+ *        bool
+ *        MyEngine::Init(int value)
+ *        {
+ *           //...
+ *           if (something_wrong)
+ *           {
+ *              AppSecureLogException("User ID : 'JoneDoe' mismatch.");
+ *
+ *              return false;
+ *           }
+ *   //...
+ *
+ *           return true;
+ *        }
+ * @endcode
+ * @hideinitializer
+ */
 #define AppSecureLogException(...)
 
 /**
-* This macro is to protect informative log messages which needs to keep security, with a tag.
-* It allows display of informative log messages if compiled with "_SECURE_LOG" definition.
-* Otherwise, it will be removed in the compile time.
-*
-* @since 2.1
-*
-* @param[in]	tag			The user defined tag
-* @param[in]	...			The message to display
-*
-* The following example demonstrates how to use the AppSecureLogTag macro.
-*
-* @code
-*        bool
-*        MyEngine::Init(int value)
-*        {
-*           AppSecureLogTag("MyTag", "User ID : 'JoneDoe'");
-*
-*           return true;
-*        }
-* @endcode
-* @hideinitializer
-*/
+ * This macro is to protect informative log messages which needs to keep security, with a tag.
+ * It allows display of informative log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, it will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	tag			The user defined tag
+ * @param[in]	...			The message to display
+ *
+ * The following example demonstrates how to use the AppSecureLogTag macro.
+ *
+ * @code
+ *        bool
+ *        MyEngine::Init(int value)
+ *        {
+ *           AppSecureLogTag("MyTag", "User ID : 'JoneDoe'");
+ *
+ *           return true;
+ *        }
+ * @endcode
+ * @hideinitializer
+ */
 #define AppSecureLogTag(tag, ...)
 
 /**
-* This macro is to protect exception log messages which needs to keep security, with a tag.
-* It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
-* Otherwise, it will be removed in the compile time.
-*
-* @since 2.1
-*
-* @param[in]	tag			The user defined tag
-* @param[in]	...			The message to display
-*
-* The following example demonstrates how to use the AppSecureLogExceptionTag macro.
-*
-* @code
-*        bool
-*        MyEngine::Init(int value)
-*        {
-*           AppSecureLogExceptionTag("MyTag", "User ID : 'JoneDoe' mismatch.");
-*
-*           return true;
-*        }
-* @endcode
-* @hideinitializer
-*/
+ * This macro is to protect debug log messages which needs to keep security, with a tag.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, it will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	tag			The user defined tag
+ * @param[in]	...			The message to display
+ *
+ * The following example demonstrates how to use the AppSecureLogDebugTag macro.
+ *
+ * @code
+ *        bool
+ *        MyEngine::Init(int value)
+ *        {
+ *           AppSecureLogDebugTag("MyTag", "User ID : 'JoneDoe' mismatch.");
+ *
+ *           return true;
+ *        }
+ * @endcode
+ * @hideinitializer
+ */
+#define AppSecureLogDebugTag(tag, ...)
+
+/**
+ * This macro is to protect exception log messages which needs to keep security, with a tag.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, it will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	tag			The user defined tag
+ * @param[in]	...			The message to display
+ *
+ * The following example demonstrates how to use the AppSecureLogExceptionTag macro.
+ *
+ * @code
+ *        bool
+ *        MyEngine::Init(int value)
+ *        {
+ *           AppSecureLogExceptionTag("MyTag", "User ID : 'JoneDoe' mismatch.");
+ *
+ *           return true;
+ *        }
+ * @endcode
+ * @hideinitializer
+ */
 #define AppSecureLogExceptionTag(tag, ...)
 
 #endif
+
+/**
+ * If the condition is @c false, it prints a message, evaluates a cleanup expression,
+ * and goes to <tt>CATCH</tt>.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	expr			Expressions that are evaluated before going to CATCH label
+ * @param[in]	...			The message to display
+ *
+ * The following example demonstrates how to use the SecureTry macro.
+ *
+ * @code
+ *	result
+ *	MyClass::DoSomething(const String* passwd)
+ *	{
+ *	   result r = E_SUCCESS;
+ *
+ *	   // Do something...
+ *
+ *	   // If password is wrong, print "[E_INVALID_ARG] The password '1234' is wrong." to the console
+ *	   // execute the expression "r = E_INVALID_ARG", and move to CATCH
+ *	   SecureTryCatch(*passwd != refPasswd, r = E_INVALID_ARG, "[E_INVALID_ARG] The password '%ls' is wrong.", passwd->GetPointer());
+ *
+ *	   SetLastResult(E_SUCCESS);
+ *
+ *	   return E_SUCCESS;// execute the expression "r = E_INVALID_ARG", and move to CATCH
+ *
+ *	   CATCH:
+ *	      SetLastResult(r);
+ *            // Do something
+ *
+ *	      return r;
+ *	}
+ * @endcode
+ * @hideinitializer
+ */
+#define SecureTryCatch(condition, expr, ...) \
+	if (!(condition)) { \
+		AppSecureLogException(__VA_ARGS__); \
+		expr; \
+		goto CATCH;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, it prints a message, sets the last result, evaluates a cleanup expression
+ * and goes to <tt>CATCH</tt>.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	expr			Expressions that are evaluated before going to CATCH label
+ * @param[in]	r			The last result to set
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryCatchResult(condition, expr, r, ...) \
+	if (!(condition)) { \
+		SetLastResult(r); \
+		AppSecureLogException(__VA_ARGS__); \
+		expr; \
+		goto CATCH;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, it prints a message, sets the last result, evaluates a cleanup expression
+ * and goes to label.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]    condition		The condition that is expected to be true
+ * @param[in]    expr			Expressions that are evaluated before going to catchLabel
+ * @param[in]    catchLabel		The label for goto operation
+ * @param[in]    r			The last result to set
+ * @param[in]    ...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryCatchLabelResult(condition, expr, catchLabel, r, ...) \
+	if (!(condition)) { \
+		SetLastResult(r); \
+		AppSecureLogException(__VA_ARGS__); \
+		expr; \
+		goto catchLabel;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, the message is printed and a value is returned.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	returnValue		The value to return when the condition is @c false
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryReturn(condition, returnValue, ...)	\
+	if (!(condition)) { \
+		AppSecureLogException(__VA_ARGS__); \
+		return returnValue;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, the message is printed, sets the last result and a value is returned.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality  will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	returnValue		The value to return when the condition is @c false
+ * @param[in]	r			The last result to set
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryReturnResult(condition, returnValue, r, ...)	\
+	if (!(condition)) { \
+		SetLastResult(r); \
+		AppSecureLogException(__VA_ARGS__); \
+		return returnValue;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, the message is printed, sets the last result and no value is returned.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	r			The last result to set
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryReturnVoidResult(condition, r, ...)	\
+	if (!(condition)) { \
+		SetLastResult(r); \
+		AppSecureLogException(__VA_ARGS__); \
+		return;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, the message is printed and no value is returned.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryReturnVoid(condition, ...) \
+	if (!(condition)) { \
+		AppSecureLogException(__VA_ARGS__); \
+		return;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, the message is printed.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryLog(condition, ...)	\
+	if (!(condition)) { \
+		AppSecureLog(__VA_ARGS__); \
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, the informative log message is printed and a value is returned.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]    condition		The condition that is expected to be true
+ * @param[in]    returnValue		The value to return when the condition is @c false
+ * @param[in]    ...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryLogReturn(condition, returnValue, ...) \
+	if (!(condition)) { \
+		AppSecureLog(__VA_ARGS__); \
+		return returnValue;	\
+	} \
+	else {;}
+
+// SecureTryTag Macros
+
+/**
+ * If the condition is @c false, it prints a message with a tag, evaluates a cleanup expression
+ * and goes to <tt>CATCH</tt>.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	tag			Used to identify the source of a log message
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	expr			Expressions that are evaluated before going to CATCH label
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryCatchTag(tag, condition, expr, ...) \
+	if (!(condition)) { \
+		AppSecureLogExceptionTag(tag, __VA_ARGS__); \
+		expr; \
+		goto CATCH;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, it prints a message with a tag, sets the last result, evaluates a cleanup expression,
+ * and goes to <tt>CATCH</tt>.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	tag			Used to identify the source of a log message
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	expr			Expressions that are evaluated before going to CATCH label
+ * @param[in]	r			The last result to set
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryCatchResultTag(tag, condition, expr, r, ...) \
+	if (!(condition)) { \
+		SetLastResult(r); \
+		AppSecureLogExceptionTag(tag, __VA_ARGS__); \
+		expr; \
+		goto CATCH;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, it prints a message with a tag, sets the last result, evaluates a cleanup expression
+ * and goes to label.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]    tag			Used to identify the source of a log message
+ * @param[in]    condition		The condition that is expected to be true
+ * @param[in]    expr			Expressions that are evaluated before going to catchLabel
+ * @param[in]    catchLabel		The label for goto operation
+ * @param[in]    r			The last result to set
+ * @param[in]    ...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryCatchLabelResultTag(tag, condition, expr, catchLabel, r, ...) \
+	if (!(condition)) { \
+		SetLastResult(r); \
+		AppSecureLogExceptionTag(tag, __VA_ARGS__); \
+		expr; \
+		goto catchLabel;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, the message is printed with a tag and a value is returned.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	tag			Used to identify the source of a log message
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	returnValue		The value to return when the condition is @c false
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryReturnTag(tag, condition, returnValue, ...)	\
+	if (!(condition)) { \
+		AppSecureLogExceptionTag(tag, __VA_ARGS__); \
+		return returnValue;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, the message is printed with a tag, sets the last result and a value is returned.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	tag			Used to identify the source of a log message
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	returnValue		The value to return when the condition is @c false
+ * @param[in]	r			The last result to set
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryReturnResultTag(tag, condition, returnValue, r, ...)	\
+	if (!(condition)) { \
+		SetLastResult(r); \
+		AppSecureLogExceptionTag(tag, __VA_ARGS__); \
+		return returnValue;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, the message is printed with a tag, sets the last result and no value is returned.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	tag			Used to identify the source of a log message
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	r			The last result to set
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryReturnVoidResultTag(tag, condition, r, ...)	\
+	if (!(condition)) { \
+		SetLastResult(r); \
+		AppSecureLogExceptionTag(tag, __VA_ARGS__); \
+		return;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, the message is printed with a tag and no value is returned.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	tag			Used to identify the source of a log message
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryReturnVoidTag(tag, condition, ...) \
+	if (!(condition)) { \
+		AppSecureLogExceptionTag(tag, __VA_ARGS__); \
+		return;	\
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, the message is printed with a tag.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]	tag			Used to identify the source of a log message
+ * @param[in]	condition		The condition that is expected to be true
+ * @param[in]	...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryLogTag(tag, condition, ...)	\
+	if (!(condition)) { \
+		AppSecureLogTag(tag, __VA_ARGS__); \
+	} \
+	else {;}
+
+/**
+ * If the condition is @c false, the informative log message is printed with a tag and a value is returned.
+ * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, log printing functionality will be removed in the compile time.
+ *
+ * @since 2.1
+ *
+ * @param[in]    tag			Used to identify the source of a log message
+ * @param[in]    condition		The condition that is expected to be true
+ * @param[in]    returnValue		The value to return when the condition is @c false
+ * @param[in]    ...			The message to display
+ * @hideinitializer
+ */
+#define SecureTryLogReturnTag(tag, condition, returnValue, ...) \
+	if (!(condition)) { \
+		AppSecureLogTag(tag, __VA_ARGS__); \
+		return returnValue;	\
+	} \
+	else {;}
+
 /** @} */
 
 _OSP_EXPORT_ void AppLogInternal(const char* pFunction, int lineNumber, const char* pFormat, ...);
@@ -882,7 +1342,6 @@ _OSP_EXPORT_ void AppLogTagInternal(const char* pTag, const char* pFunction, int
 _OSP_EXPORT_ void AppLogDebugTagInternal(const char* pTag, const char* pFunction, int lineNumber, const char* pFormat, ...);
 _OSP_EXPORT_ void AppLogExceptionTagInternal(const char* pTag, const char* pFunction, int lineNumber, const char* pFormat, ...);
 
-
 #ifdef __cplusplus
 }
 #endif