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_RELOAD,
  38         UNDO_ACTIONS_MAX
  39 };
  40
  41 typedef struct UndoReloadData
  42 {
  43         guint actions_count; /* How many following undo/redo actions need to be applied. */
  44         gint eol_mode;       /* End-Of-Line mode before/after reloading. */
  45 }
  46 UndoReloadData;
  47
  48 typedef enum
  49 {
  50         FILE_OK,
  51         FILE_CHANGED, /* also valid for deleted files */
  52         FILE_IGNORE
  53 }
  54 FileDiskStatus;
  55
  56
  57 typedef struct FileEncoding
  58 {
  59         gchar                   *encoding;
  60         gboolean                 has_bom;
  61 }
  62 FileEncoding;
  63
  64 enum
  65 {
  66         MSG_TYPE_RELOAD,
  67         MSG_TYPE_RESAVE,
  68
  69         NUM_MSG_TYPES
  70 };
  71
  72 /* Private GeanyDocument fields */
  73 typedef struct GeanyDocumentPrivate
  74 {
  75         /* GtkLabel shown in the notebook header. */
  76         GtkWidget               *tab_label;
  77         /* GtkTreeView object for this document within the Symbols treeview of the sidebar. */
  78         GtkWidget               *tag_tree;
  79         /* GtkTreeStore object for this document within the Symbols treeview of the sidebar. */
  80         GtkTreeStore    *tag_store;
  81         /* Indicates whether tag tree has to be updated */
  82         gboolean                tag_tree_dirty;
  83         /* Iter for this document within the Open Files treeview of the sidebar. */
  84         GtkTreeIter              iter;
  85         /* Used by the Undo/Redo management code. */
  86         GTrashStack             *undo_actions;
  87         /* Used by the Undo/Redo management code. */
  88         GTrashStack             *redo_actions;
  89         /* Used so Undo/Redo works for encoding changes. */
  90         FileEncoding     saved_encoding;
  91         gboolean                 colourise_needed;      /* use document.c:queue_colourise() instead */
  92         gint                     line_count;            /* Number of lines in the document. */
  93         gint                     symbol_list_sort_mode;
  94         /* indicates whether a file is on a remote filesystem, works only with GIO/GVfs */
  95         gboolean                 is_remote;
  96         /* File status on disk of the document */
  97         FileDiskStatus   file_disk_status;
  98         /* Reference to a GFileMonitor object, only used when GIO file monitoring is used. */
  99         gpointer                 monitor;
 100         /* Time of the last disk check, only used when legacy file monitoring is used. */
 101         time_t                   last_check;
 102         /* Modification time of the document on disk, only used when legacy file monitoring is used. */
 103         time_t                   mtime;
 104         /* ID of the idle callback updating the tag list */
 105         guint                    tag_list_update_source;
 106         /* Whether it's temporarily protected (read-only and saving needs confirmation). Does
 107          * not imply doc->readonly as writable files can be protected */
 108         gint                     protected;
 109         /* Save pointer to info bars allowing to cancel them programatically (to avoid multiple ones) */
 110         GtkWidget               *info_bars[NUM_MSG_TYPES];
 111 }
 112 GeanyDocumentPrivate;
 113
 114 G_END_DECLS
 115
 116 #endif /* GEANY_DOCUMENT_PRIVATE_H */