plugins/sourceview/anjuta-document-loader.h

   1 /*
   2  * anjuta-document-loader.h
   3  * This file is part of anjuta
   4  *
   5  * Copyright (C) 2005 - Paolo Maggi
   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,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 /*
  24  * Modified by the anjuta Team, 2005. See the AUTHORS file for a
  25  * list of people on the anjuta Team.
  26  * See the ChangeLog files for a list of changes.
  27  *
  28  * $Id$
  29  */
  30
  31 #ifndef __ANJUTA_DOCUMENT_LOADER_H__
  32 #define __ANJUTA_DOCUMENT_LOADER_H__
  33
  34 #include "anjuta-document.h"
  35 #include <libgnomevfs/gnome-vfs-file-size.h>
  36
  37 G_BEGIN_DECLS
  38
  39 /*
  40  * Type checking and casting macros
  41  */
  42 #define ANJUTA_TYPE_DOCUMENT_LOADER              (anjuta_document_loader_get_type())
  43 #define ANJUTA_DOCUMENT_LOADER(obj)              (G_TYPE_CHECK_INSTANCE_CAST((obj), ANJUTA_TYPE_DOCUMENT_LOADER, AnjutaDocumentLoader))
  44 #define ANJUTA_DOCUMENT_LOADER_CONST(obj)        (G_TYPE_CHECK_INSTANCE_CAST((obj), ANJUTA_TYPE_DOCUMENT_LOADER, AnjutaDocumentLoader const))
  45 #define ANJUTA_DOCUMENT_LOADER_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), ANJUTA_TYPE_DOCUMENT_LOADER, AnjutaDocumentLoaderClass))
  46 #define ANJUTA_IS_DOCUMENT_LOADER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE((obj), ANJUTA_TYPE_DOCUMENT_LOADER))
  47 #define ANJUTA_IS_DOCUMENT_LOADER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), ANJUTA_TYPE_DOCUMENT_LOADER))
  48 #define ANJUTA_DOCUMENT_LOADER_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS((obj), ANJUTA_TYPE_DOCUMENT_LOADER, AnjutaDocumentLoaderClass))
  49
  50 /* Private structure type */
  51 typedef struct _AnjutaDocumentLoaderPrivate AnjutaDocumentLoaderPrivate;
  52
  53 /*
  54  * Main object structure
  55  */
  56 typedef struct _AnjutaDocumentLoader AnjutaDocumentLoader;
  57
  58 struct _AnjutaDocumentLoader
  59 {
  60         GObject object;
  61
  62         /*< private > */
  63         AnjutaDocumentLoaderPrivate *priv;
  64 };
  65
  66 /*
  67  * Class definition
  68  */
  69 typedef struct _AnjutaDocumentLoaderClass AnjutaDocumentLoaderClass;
  70
  71 struct _AnjutaDocumentLoaderClass
  72 {
  73         GObjectClass parent_class;
  74
  75         void (* loading) (AnjutaDocumentLoader *loader,
  76                           gboolean             completed,
  77                           const GError        *error);
  78 };
  79
  80 /*
  81  * Public methods
  82  */
  83 GType                    anjuta_document_loader_get_type                (void) G_GNUC_CONST;
  84
  85 AnjutaDocumentLoader    *anjuta_document_loader_new             (AnjutaDocument       *doc);
  86
  87 /* If enconding == NULL, the encoding will be autodetected */
  88 void                     anjuta_document_loader_load            (AnjutaDocumentLoader *loader,
  89                                                                  const gchar         *uri,
  90                                                                  const AnjutaEncoding *encoding);
  91 #if 0
  92 gboolean                 anjuta_document_loader_load_from_stdin (AnjutaDocumentLoader *loader);
  93 #endif
  94 gboolean                 anjuta_document_loader_cancel          (AnjutaDocumentLoader *loader);
  95
  96
  97 /* Returns STDIN_URI if loading from stdin */
  98 #define STDIN_URI "stdin:"
  99 const gchar             *anjuta_document_loader_get_uri         (AnjutaDocumentLoader *loader);
 100
 101 const gchar             *anjuta_document_loader_get_mime_type   (AnjutaDocumentLoader *loader);
 102
 103 time_t                   anjuta_document_loader_get_mtime       (AnjutaDocumentLoader *loader);
 104
 105 /* In the case the loader does not know if the file is readonly, for example for most
 106 remote files, the function returns FALSE */
 107 gboolean                 anjuta_document_loader_get_readonly    (AnjutaDocumentLoader *loader);
 108
 109 const AnjutaEncoding    *anjuta_document_loader_get_encoding    (AnjutaDocumentLoader *loader);
 110
 111 /* Returns 0 if file size is unknown */
 112 GnomeVFSFileSize         anjuta_document_loader_get_file_size   (AnjutaDocumentLoader *loader);
 113
 114 GnomeVFSFileSize         anjuta_document_loader_get_bytes_read  (AnjutaDocumentLoader *loader);
 115
 116
 117 G_END_DECLS
 118
 119 #endif  /* __ANJUTA_DOCUMENT_LOADER_H__  */