src/documentprivate.h

   1 /*
   2  *      document-private.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2008-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2008-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
  23 #ifndef GEANY_DOCUMENT_PRIVATE_H
  24 #define GEANY_DOCUMENT_PRIVATE_H 1
  25
  26 #include "gtkcompat.h"
  27
  28 G_BEGIN_DECLS
  29
  30 /* available UNDO actions, UNDO_SCINTILLA is a pseudo action to trigger Scintilla's
  31  * undo management */
  32 enum
  33 {
  34         UNDO_SCINTILLA = 0,
  35         UNDO_ENCODING,
  36         UNDO_BOM,
  37         UNDO_ACTIONS_MAX
  38 };
  39
  40 typedef enum
  41 {
  42         FILE_OK,
  43         FILE_CHANGED, /* also valid for deleted files */
  44         FILE_IGNORE
  45 }
  46 FileDiskStatus;
  47
  48
  49 typedef struct FileEncoding
  50 {
  51         gchar                   *encoding;
  52         gboolean                 has_bom;
  53 }
  54 FileEncoding;
  55
  56 enum
  57 {
  58         MSG_TYPE_RELOAD,
  59         MSG_TYPE_RESAVE,
  60
  61         NUM_MSG_TYPES
  62 };
  63
  64 /* Private GeanyDocument fields */
  65 typedef struct GeanyDocumentPrivate
  66 {
  67         /* GtkLabel shown in the notebook header. */
  68         GtkWidget               *tab_label;
  69         /* GtkTreeView object for this document within the Symbols treeview of the sidebar. */
  70         GtkWidget               *tag_tree;
  71         /* GtkTreeStore object for this document within the Symbols treeview of the sidebar. */
  72         GtkTreeStore    *tag_store;
  73         /* Iter for this document within the Open Files treeview of the sidebar. */
  74         GtkTreeIter              iter;
  75         /* Used by the Undo/Redo management code. */
  76         GTrashStack             *undo_actions;
  77         /* Used by the Undo/Redo management code. */
  78         GTrashStack             *redo_actions;
  79         /* Used so Undo/Redo works for encoding changes. */
  80         FileEncoding     saved_encoding;
  81         gboolean                 colourise_needed;      /* use document.c:queue_colourise() instead */
  82         gint                     line_count;            /* Number of lines in the document. */
  83         gint                     symbol_list_sort_mode;
  84         /* indicates whether a file is on a remote filesystem, works only with GIO/GVfs */
  85         gboolean                 is_remote;
  86         /* File status on disk of the document */
  87         FileDiskStatus   file_disk_status;
  88         /* Reference to a GFileMonitor object, only used when GIO file monitoring is used. */
  89         gpointer                 monitor;
  90         /* Time of the last disk check, only used when legacy file monitoring is used. */
  91         time_t                   last_check;
  92         /* Modification time of the document on disk, only used when legacy file monitoring is used. */
  93         time_t                   mtime;
  94         /* ID of the idle callback updating the tag list */
  95         guint                    tag_list_update_source;
  96         /* Whether it's temporarily protected (read-only and saving needs confirmation). Does
  97          * not imply doc->readonly as writable files can be protected */
  98         gint                     protected;
  99         /* Save pointer to info bars allowing to cancel them programatically (to avoid multiple ones) */
 100         GtkWidget               *info_bars[NUM_MSG_TYPES];
 101 }
 102 GeanyDocumentPrivate;
 103
 104 G_END_DECLS
 105
 106 #endif /* GEANY_DOCUMENT_PRIVATE_H */