src/documentprivate.h

   1 /*
   2  *      document-private.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2008-2009 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2008-2009 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
  18  *      along with this program; if not, write to the Free Software
  19  *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  20  *      MA 02110-1301, USA.
  21  *
  22  *  $Id$
  23  */
  24
  25
  26 #ifndef GEANY_DOCUMENT_PRIVATE_H
  27 #define GEANY_DOCUMENT_PRIVATE_H
  28
  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
  57 /* Private GeanyDocument fields */
  58 typedef struct GeanyDocumentPrivate
  59 {
  60         /* GtkLabel shown in the notebook header. */
  61         GtkWidget               *tab_label;
  62         /* GtkTreeView object for this document within the Symbols treeview of the sidebar. */
  63         GtkWidget               *tag_tree;
  64         /* GtkTreeStore object for this document within the Symbols treeview of the sidebar. */
  65         GtkTreeStore    *tag_store;
  66         /* Iter for this document within the Open Files treeview of the sidebar. */
  67         GtkTreeIter              iter;
  68         /* Used by the Undo/Redo management code. */
  69         GTrashStack             *undo_actions;
  70         /* Used by the Undo/Redo management code. */
  71         GTrashStack             *redo_actions;
  72         /* Used so Undo/Redo works for encoding changes. */
  73         FileEncoding     saved_encoding;
  74         gboolean                 colourise_needed;      /* use document.c:queue_colourise() instead */
  75         gint                     line_count;            /* Number of lines in the document. */
  76         gint                     symbol_list_sort_mode;
  77         /* indicates whether a file is on a remote filesystem, works only with GIO/GVfs */
  78         gboolean                 is_remote;
  79         /* File status on disk of the document */
  80         FileDiskStatus   file_disk_status;
  81         /* Reference to a GFileMonitor object, only used when GIO file monitoring is used. */
  82         gpointer                 monitor;
  83         /* Time of the last disk check, only used when legacy file monitoring is used. */
  84         time_t                   last_check;
  85         /* Modification time of the document on disk, only used when legacy file monitoring is used. */
  86         time_t                   mtime;
  87 }
  88 GeanyDocumentPrivate;
  89
  90 #endif