src/msgwindow.h

   1 /*
   2  *      msgwindow.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2005-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
   6  *
   7  *      This program is free software; you can redistribute it and/or modify
   8  *      it under the terms of the GNU General Public License as published by
   9  *      the Free Software Foundation; either version 2 of the License, or
  10  *      (at your option) any later version.
  11  *
  12  *      This program is distributed in the hope that it will be useful,
  13  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *      GNU General Public License for more details.
  16  *
  17  *      You should have received a copy of the GNU General Public License along
  18  *      with this program; if not, write to the Free Software Foundation, Inc.,
  19  *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #ifndef GEANY_MSGWINDOW_H
  23 #define GEANY_MSGWINDOW_H 1
  24
  25 G_BEGIN_DECLS
  26
  27 /**
  28  * Various colors for use in the compiler and messages treeviews when adding messages.
  29  **/
  30 enum MsgColors
  31 {
  32         COLOR_RED,              /**< Color red */
  33         COLOR_DARK_RED, /**< Color dark red */
  34         COLOR_BLACK,    /**< Color black */
  35         COLOR_BLUE              /**< Color blue */
  36 };
  37
  38 /** Indices of the notebooks in the messages window. */
  39 typedef enum
  40 {
  41         /* force it to start at 0 to keep in sync with the notebook page numbers */
  42         MSG_STATUS = 0, /**< Index of the status message tab */
  43         MSG_COMPILER,   /**< Index of the compiler tab */
  44         MSG_MESSAGE,    /**< Index of the messages tab */
  45         MSG_SCRATCH,    /**< Index of the scratch tab */
  46         MSG_VTE                 /**< Index of the VTE tab */
  47 } MessageWindowTabNum;
  48
  49
  50
  51 typedef struct
  52 {
  53         GtkListStore    *store_status;
  54         GtkListStore    *store_msg;
  55         GtkListStore    *store_compiler;
  56         GtkWidget               *tree_compiler;
  57         GtkWidget               *tree_status;
  58         GtkWidget               *tree_msg;
  59         GtkWidget               *scribble;
  60         GtkWidget               *popup_status_menu;
  61         GtkWidget               *popup_msg_menu;
  62         GtkWidget               *popup_compiler_menu;
  63         GtkWidget               *notebook;
  64         gchar                   *messages_dir;
  65 } MessageWindow;
  66
  67 extern MessageWindow msgwindow;
  68
  69
  70 void msgwin_init(void);
  71
  72 void msgwin_finalize(void);
  73
  74 void msgwin_show_hide(gboolean show);
  75
  76 void msgwin_switch_tab(gint tabnum, gboolean show);
  77
  78 void msgwin_clear_tab(gint tabnum);
  79
  80 void msgwin_msg_add(gint msg_color, gint line, GeanyDocument *doc, const gchar *format, ...)
  81                         G_GNUC_PRINTF (4, 5);
  82
  83 void msgwin_msg_add_string(gint msg_color, gint line, GeanyDocument *doc, const gchar *string);
  84
  85 void msgwin_compiler_add(gint msg_color, const gchar *format, ...) G_GNUC_PRINTF (2, 3);
  86
  87 void msgwin_compiler_add_string(gint msg_color, const gchar *msg);
  88
  89 void msgwin_status_add(const gchar *format, ...) G_GNUC_PRINTF (1, 2);
  90
  91 void msgwin_show_hide_tabs(void);
  92
  93 void msgwin_set_messages_dir(const gchar *messages_dir);
  94
  95
  96 void msgwin_menu_add_common_items(GtkMenu *menu);
  97
  98 gboolean msgwin_goto_compiler_file_line(gboolean focus_editor);
  99
 100 void msgwin_parse_compiler_error_line(const gchar *string, const gchar *dir,
 101                                                                           gchar **filename, gint *line);
 102
 103 gboolean msgwin_goto_messages_file_line(gboolean focus_editor);
 104
 105 G_END_DECLS
 106
 107 #endif