1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* This file is part of GtkSourceView
*
* Copyright 2005, 2007 Paolo Maggi
* Copyright 2007 Steve Frécinaux
* Copyright 2008 Jesse van den Kieboom
* Copyright 2014 Sébastien Wilmet
*
* GtkSourceView is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* GtkSourceView is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#if !defined (GTK_SOURCE_H_INSIDE) && !defined (GTK_SOURCE_COMPILATION)
#error "Only <gtksourceview/gtksource.h> can be included directly."
#endif
#include <gtk/gtk.h>
#include "gtksourcetypes.h"
#include "gtksourcefile.h"
G_BEGIN_DECLS
#define GTK_SOURCE_TYPE_FILE_SAVER (gtk_source_file_saver_get_type())
#define GTK_SOURCE_FILE_SAVER_ERROR (gtk_source_file_saver_error_quark())
/**
* GtkSourceFileSaverError:
* @GTK_SOURCE_FILE_SAVER_ERROR_INVALID_CHARS: The buffer contains invalid
* characters.
* @GTK_SOURCE_FILE_SAVER_ERROR_EXTERNALLY_MODIFIED: The file is externally
* modified.
*
* An error code used with the %GTK_SOURCE_FILE_SAVER_ERROR domain.
*/
typedef enum _GtkSourceFileSaverError
{
GTK_SOURCE_FILE_SAVER_ERROR_INVALID_CHARS,
GTK_SOURCE_FILE_SAVER_ERROR_EXTERNALLY_MODIFIED
} GtkSourceFileSaverError;
/**
* GtkSourceFileSaverFlags:
* @GTK_SOURCE_FILE_SAVER_FLAGS_NONE: No flags.
* @GTK_SOURCE_FILE_SAVER_FLAGS_IGNORE_INVALID_CHARS: Ignore invalid characters.
* @GTK_SOURCE_FILE_SAVER_FLAGS_IGNORE_MODIFICATION_TIME: Save file despite external modifications.
* @GTK_SOURCE_FILE_SAVER_FLAGS_CREATE_BACKUP: Create a backup before saving the file.
*
* Flags to define the behavior of a [flags@FileSaverFlags].
*/
typedef enum _GtkSourceFileSaverFlags
{
GTK_SOURCE_FILE_SAVER_FLAGS_NONE = 0,
GTK_SOURCE_FILE_SAVER_FLAGS_IGNORE_INVALID_CHARS = 1 << 0,
GTK_SOURCE_FILE_SAVER_FLAGS_IGNORE_MODIFICATION_TIME = 1 << 1,
GTK_SOURCE_FILE_SAVER_FLAGS_CREATE_BACKUP = 1 << 2
} GtkSourceFileSaverFlags;
GTK_SOURCE_AVAILABLE_IN_ALL
G_DECLARE_FINAL_TYPE (GtkSourceFileSaver, gtk_source_file_saver, GTK_SOURCE, FILE_SAVER, GObject)
GTK_SOURCE_AVAILABLE_IN_ALL
GQuark gtk_source_file_saver_error_quark (void);
GTK_SOURCE_AVAILABLE_IN_ALL
GtkSourceFileSaver *gtk_source_file_saver_new (GtkSourceBuffer *buffer,
GtkSourceFile *file);
GTK_SOURCE_AVAILABLE_IN_ALL
GtkSourceFileSaver *gtk_source_file_saver_new_with_target (GtkSourceBuffer *buffer,
GtkSourceFile *file,
GFile *target_location);
GTK_SOURCE_AVAILABLE_IN_ALL
GtkSourceBuffer *gtk_source_file_saver_get_buffer (GtkSourceFileSaver *saver);
GTK_SOURCE_AVAILABLE_IN_ALL
GtkSourceFile *gtk_source_file_saver_get_file (GtkSourceFileSaver *saver);
GTK_SOURCE_AVAILABLE_IN_ALL
GFile *gtk_source_file_saver_get_location (GtkSourceFileSaver *saver);
GTK_SOURCE_AVAILABLE_IN_ALL
void gtk_source_file_saver_set_encoding (GtkSourceFileSaver *saver,
const GtkSourceEncoding *encoding);
GTK_SOURCE_AVAILABLE_IN_ALL
const GtkSourceEncoding *gtk_source_file_saver_get_encoding (GtkSourceFileSaver *saver);
GTK_SOURCE_AVAILABLE_IN_ALL
void gtk_source_file_saver_set_newline_type (GtkSourceFileSaver *saver,
GtkSourceNewlineType newline_type);
GTK_SOURCE_AVAILABLE_IN_ALL
GtkSourceNewlineType gtk_source_file_saver_get_newline_type (GtkSourceFileSaver *saver);
GTK_SOURCE_AVAILABLE_IN_ALL
void gtk_source_file_saver_set_compression_type (GtkSourceFileSaver *saver,
GtkSourceCompressionType compression_type);
GTK_SOURCE_AVAILABLE_IN_ALL
GtkSourceCompressionType gtk_source_file_saver_get_compression_type (GtkSourceFileSaver *saver);
GTK_SOURCE_AVAILABLE_IN_ALL
void gtk_source_file_saver_set_flags (GtkSourceFileSaver *saver,
GtkSourceFileSaverFlags flags);
GTK_SOURCE_AVAILABLE_IN_ALL
GtkSourceFileSaverFlags gtk_source_file_saver_get_flags (GtkSourceFileSaver *saver);
GTK_SOURCE_AVAILABLE_IN_ALL
void gtk_source_file_saver_save_async (GtkSourceFileSaver *saver,
gint io_priority,
GCancellable *cancellable,
GFileProgressCallback progress_callback,
gpointer progress_callback_data,
GDestroyNotify progress_callback_notify,
GAsyncReadyCallback callback,
gpointer user_data);
GTK_SOURCE_AVAILABLE_IN_ALL
gboolean gtk_source_file_saver_save_finish (GtkSourceFileSaver *saver,
GAsyncResult *result,
GError **error);
G_END_DECLS
|
