Make #include guard naming consistent

[openocd.git] / src / helper / log.h

diff --git a/src/helper/log.h b/src/helper/log.h
index 6f7c24a80bb40f361381aaa7dfa6b97ae9822d4f..eb222cbb708d025fcdbd57d36687edf05961ec9a 100644 (file)
--- a/src/helper/log.h
+++ b/src/helper/log.h
@@ -19,14 +19,13 @@
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
-#ifndef ERROR_H
-#define ERROR_H
 
-#include "command.h"
+#ifndef OPENOCD_HELPER_LOG_H
+#define OPENOCD_HELPER_LOG_H
+
+#include <helper/command.h>
 
 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
  * used for __attribute__((format( ... ))), with GCC v4.4 or later
@@ -48,8 +47,7 @@
  * LOG_LVL_INFO - state information, etc.
  * LOG_LVL_DEBUG - debug statements, execution trace
  */
-enum log_levels
-{
+enum log_levels {
        LOG_LVL_SILENT = -3,
        LOG_LVL_OUTPUT = -2,
        LOG_LVL_USER = -1,
@@ -60,13 +58,16 @@ enum log_levels
 };
 
 void log_printf(enum log_levels level, const char *file, unsigned line,
-       const char *function, const char *format, ...)
+               const char *function, const char *format, ...)
 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
 void log_printf_lf(enum log_levels level, const char *file, unsigned line,
-       const char *function, const char *format, ...)
+               const char *function, const char *format, ...)
 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
 
-int log_init(struct command_context *cmd_ctx);
+/**
+ * Initialize logging module.  Call during program startup.
+ */
+void log_init(void);
 int set_log_output(struct command_context *cmd_ctx, FILE *output);
 
 int log_register_commands(struct command_context *cmd_ctx);
@@ -77,14 +78,6 @@ void kept_alive(void);
 void alive_sleep(uint64_t ms);
 void busy_sleep(uint64_t ms);
 
-/* log entries can be paused and replayed roughly according to the try/catch/rethrow
- * concepts in C++
- */
-void log_try(void);
-void log_catch(void);
-void log_rethrow(void);
-
-
 typedef void (*log_callback_fn)(void *priv, const char *file, unsigned line,
                const char *function, const char *string);
 
@@ -108,39 +101,42 @@ extern int debug_level;
 #define LOG_LEVEL_IS(FOO)  ((debug_level) >= (FOO))
 
 #define LOG_DEBUG(expr ...) \
-               ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
+       do { \
+               if (debug_level >= LOG_LVL_DEBUG) \
+                       log_printf_lf(LOG_LVL_DEBUG, \
+                               __FILE__, __LINE__, __func__, \
+                               expr); \
+       } while (0)
 
 #define LOG_INFO(expr ...) \
-               log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
-
-#define LOG_INFO_N(expr ...) \
-               log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
+       log_printf_lf(LOG_LVL_INFO, __FILE__, __LINE__, __func__, expr)
 
 #define LOG_WARNING(expr ...) \
-               log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
+       log_printf_lf(LOG_LVL_WARNING, __FILE__, __LINE__, __func__, expr)
 
 #define LOG_ERROR(expr ...) \
-               log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
+       log_printf_lf(LOG_LVL_ERROR, __FILE__, __LINE__, __func__, expr)
 
 #define LOG_USER(expr ...) \
-               log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
+       log_printf_lf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr)
 
 #define LOG_USER_N(expr ...) \
-               log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
+       log_printf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr)
 
 #define LOG_OUTPUT(expr ...) \
-               log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
+       log_printf(LOG_LVL_OUTPUT, __FILE__, __LINE__, __func__, expr)
 
 /* general failures
  * error codes < 100
  */
-#define ERROR_OK                                       (0)
-#define ERROR_INVALID_ARGUMENTS                ERROR_COMMAND_SYNTAX_ERROR
-#define ERROR_NO_CONFIG_FILE           (-2)
-#define ERROR_BUF_TOO_SMALL                    (-3)
+#define ERROR_OK                                               (0)
+#define ERROR_NO_CONFIG_FILE                   (-2)
+#define ERROR_BUF_TOO_SMALL                            (-3)
 /* see "Error:" log entry for meaningful message to the user. The caller should
  * make no assumptions about what went wrong and try to handle the problem.
  */
-#define ERROR_FAIL                                     (-4)
+#define ERROR_FAIL                                             (-4)
+#define ERROR_WAIT                                             (-5)
+
 
-#endif /* LOG_H */
+#endif /* OPENOCD_HELPER_LOG_H */