src/documentprivate.h

   1 /*
   2  *      document-private.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2008 The Geany contributors
   5  *
   6  *      This program is free software; you can redistribute it and/or modify
   7  *      it under the terms of the GNU General Public License as published by
   8  *      the Free Software Foundation; either version 2 of the License, or
   9  *      (at your option) any later version.
  10  *
  11  *      This program is distributed in the hope that it will be useful,
  12  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *      GNU General Public License for more details.
  15  *
  16  *      You should have received a copy of the GNU General Public License along
  17  *      with this program; if not, write to the Free Software Foundation, Inc.,
  18  *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21
  22 #ifndef GEANY_DOCUMENT_PRIVATE_H
  23 #define GEANY_DOCUMENT_PRIVATE_H 1
  24
  25 #include <gtk/gtk.h>
  26
  27 G_BEGIN_DECLS
  28
  29 /* available UNDO actions, UNDO_SCINTILLA is a pseudo action to trigger Scintilla's
  30  * undo management */
  31 enum
  32 {
  33         UNDO_SCINTILLA = 0,
  34         UNDO_ENCODING,
  35         UNDO_BOM,
  36         UNDO_RELOAD,
  37         UNDO_EOL,
  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         MSG_TYPE_POST_RELOAD,
  69
  70         NUM_MSG_TYPES
  71 };
  72
  73 /* Private GeanyDocument fields */
  74 typedef struct GeanyDocumentPrivate
  75 {
  76         /* GtkLabel shown in the notebook header. */
  77         GtkWidget               *tab_label;
  78         /* GtkTreeView object for this document within the Symbols treeview of the sidebar. */
  79         GtkWidget               *tag_tree;
  80         /* GtkTreeStore object for this document within the Symbols treeview of the sidebar. */
  81         GtkTreeStore    *tag_store;
  82         /* Indicates whether tag tree has to be updated */
  83         gboolean                tag_tree_dirty;
  84         /* Iter for this document within the Open Files treeview of the sidebar. */
  85         GtkTreeIter              iter;
  86         /* Used by the Undo/Redo management code. */
  87         GTrashStack             *undo_actions;
  88         /* Used by the Undo/Redo management code. */
  89         GTrashStack             *redo_actions;
  90         /* Used so Undo/Redo works for encoding changes. */
  91         FileEncoding     saved_encoding;
  92         gboolean                 colourise_needed;      /* use document.c:queue_colourise() instead */
  93         guint                    keyword_hash;  /* hash of keyword string used for typename colourisation */
  94         gint                     line_count;            /* Number of lines in the document. */
  95         gint                     symbol_list_sort_mode;
  96         /* indicates whether a file is on a remote filesystem, works only with GIO/GVfs */
  97         gboolean                 is_remote;
  98         /* File status on disk of the document */
  99         FileDiskStatus   file_disk_status;
 100         /* Reference to a GFileMonitor object, only used when GIO file monitoring is used. */
 101         gpointer                 monitor;
 102         /* Time of the last disk check, only used when legacy file monitoring is used. */
 103         time_t                   last_check;
 104         /* Modification time of the document on disk, only used when legacy file monitoring is used. */
 105         time_t                   mtime;
 106         /* ID of the idle callback updating the tag list */
 107         guint                    tag_list_update_source;
 108         /* Whether it's temporarily protected (read-only and saving needs confirmation). Does
 109          * not imply doc->readonly as writable files can be protected */
 110         gint                     protected;
 111         /* Save pointer to info bars allowing to cancel them programatically (to avoid multiple ones) */
 112         GtkWidget               *info_bars[NUM_MSG_TYPES];
 113         /* Keyed Data List to attach arbitrary data to the document */
 114         GData                   *data;
 115         /* Text used for filtering symbol tree. */
 116         gchar                   *tag_filter;
 117         /* Group symbols in symbol tree by their type. */
 118         gboolean                symbols_group_by_type;
 119 }
 120 GeanyDocumentPrivate;
 121
 122 G_END_DECLS
 123
 124 #endif /* GEANY_DOCUMENT_PRIVATE_H */