[gtksourceview/wip/loader-saver] Rename ensure-trailing-newline to better names

[Sébastien Wilmet <swilmet src gnome org>]

commit 0bd5df1b3d98275128b4f751acee953c6da448e1
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Thu Apr 3 17:37:21 2014 +0200

    Rename ensure-trailing-newline to better names

 gtksourceview/gtksourcebuffer.c             |    5 +--
 gtksourceview/gtksourcebufferinputstream.c  |   30 ++++++++++++------------
 gtksourceview/gtksourcebufferinputstream.h  |    2 +-
 gtksourceview/gtksourcebufferoutputstream.c |   33 +++++++++++---------------
 gtksourceview/gtksourcebufferoutputstream.h |    2 +-
 5 files changed, 33 insertions(+), 39 deletions(-)
---
diff --git a/gtksourceview/gtksourcebuffer.c b/gtksourceview/gtksourcebuffer.c
index 66ce0d4..a7985e8 100644
--- a/gtksourceview/gtksourcebuffer.c
+++ b/gtksourceview/gtksourcebuffer.c
@@ -2787,9 +2787,8 @@ gtk_source_buffer_get_compression_type (GtkSourceBuffer *buffer)
  *
  * Sets whether the @buffer has an implicit trailing newline.
  *
- * If an explicit trailing newline is present in a #GtkTextBuffer, there will be
- * one more visible line in a #GtkTextView. This is generally not what the user
- * expects.
+ * If an explicit trailing newline is present in a #GtkTextBuffer, #GtkTextView
+ * shows it as an empty line. This is generally not what the user expects.
  *
  * If @implicit_trailing_newline is %TRUE (the default value):
  *  - when a #GtkSourceFileLoader loads the content of a file into the @buffer,
diff --git a/gtksourceview/gtksourcebufferinputstream.c b/gtksourceview/gtksourcebufferinputstream.c
index 1a118a0..8a7fcbf 100644
--- a/gtksourceview/gtksourcebufferinputstream.c
+++ b/gtksourceview/gtksourcebufferinputstream.c
@@ -43,7 +43,7 @@ struct _GtkSourceBufferInputStreamPrivate
 
        guint newline_added : 1;
        guint is_initialized : 1;
-       guint ensure_trailing_newline : 1;
+       guint add_trailing_newline : 1;
 };
 
 enum
@@ -51,7 +51,7 @@ enum
        PROP_0,
        PROP_BUFFER,
        PROP_NEWLINE_TYPE,
-       PROP_ENSURE_TRAILING_NEWLINE
+       PROP_ADD_TRAILING_NEWLINE
 };
 
 G_DEFINE_TYPE_WITH_PRIVATE (GtkSourceBufferInputStream, _gtk_source_buffer_input_stream, 
G_TYPE_INPUT_STREAM);
@@ -274,7 +274,7 @@ _gtk_source_buffer_input_stream_read (GInputStream  *input_stream,
 
        if (gtk_text_iter_is_end (&iter) &&
            !gtk_text_iter_is_start (&iter) &&
-           stream->priv->ensure_trailing_newline)
+           stream->priv->add_trailing_newline)
        {
                gssize newline_size;
 
@@ -333,8 +333,8 @@ _gtk_source_buffer_input_stream_set_property (GObject      *object,
                        stream->priv->newline_type = g_value_get_enum (value);
                        break;
 
-               case PROP_ENSURE_TRAILING_NEWLINE:
-                       stream->priv->ensure_trailing_newline = g_value_get_boolean (value);
+               case PROP_ADD_TRAILING_NEWLINE:
+                       stream->priv->add_trailing_newline = g_value_get_boolean (value);
                        break;
 
                default:
@@ -361,8 +361,8 @@ _gtk_source_buffer_input_stream_get_property (GObject    *object,
                        g_value_set_enum (value, stream->priv->newline_type);
                        break;
 
-               case PROP_ENSURE_TRAILING_NEWLINE:
-                       g_value_set_boolean (value, stream->priv->ensure_trailing_newline);
+               case PROP_ADD_TRAILING_NEWLINE:
+                       g_value_set_boolean (value, stream->priv->add_trailing_newline);
                        break;
 
                default:
@@ -422,15 +422,15 @@ _gtk_source_buffer_input_stream_class_init (GtkSourceBufferInputStreamClass *kla
                                                            G_PARAM_CONSTRUCT_ONLY));
 
        /**
-        * GtkSourceBufferInputStream:ensure-trailing-newline:
+        * GtkSourceBufferInputStream:add-trailing-newline:
         *
-        * The :ensure-trailing-newline property specifies whether or not to
-        * ensure (enforce) the buffer ends with a trailing newline.
+        * The :add-trailing-newline property specifies whether or not to
+        * add a trailing newline when reading the buffer.
         */
        g_object_class_install_property (gobject_class,
-                                        PROP_ENSURE_TRAILING_NEWLINE,
-                                        g_param_spec_boolean ("ensure-trailing-newline",
-                                                              "Ensure trailing newline",
+                                        PROP_ADD_TRAILING_NEWLINE,
+                                        g_param_spec_boolean ("add-trailing-newline",
+                                                              "Add trailing newline",
                                                               "",
                                                               TRUE,
                                                               G_PARAM_READWRITE |
@@ -455,14 +455,14 @@ _gtk_source_buffer_input_stream_init (GtkSourceBufferInputStream *stream)
 GInputStream *
 _gtk_source_buffer_input_stream_new (GtkTextBuffer        *buffer,
                                     GtkSourceNewlineType  type,
-                                    gboolean              ensure_trailing_newline)
+                                    gboolean              add_trailing_newline)
 {
        g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
 
        return g_object_new (GTK_SOURCE_TYPE_BUFFER_INPUT_STREAM,
                             "buffer", buffer,
                             "newline-type", type,
-                            "ensure-trailing-newline", ensure_trailing_newline,
+                            "add-trailing-newline", add_trailing_newline,
                             NULL);
 }
 
diff --git a/gtksourceview/gtksourcebufferinputstream.h b/gtksourceview/gtksourcebufferinputstream.h
index 5c0940a..b80c7c4 100644
--- a/gtksourceview/gtksourcebufferinputstream.h
+++ b/gtksourceview/gtksourcebufferinputstream.h
@@ -58,7 +58,7 @@ GType          _gtk_source_buffer_input_stream_get_type               (void) G_GNUC_CONST;
 G_GNUC_INTERNAL
 GInputStream   *_gtk_source_buffer_input_stream_new                    (GtkTextBuffer              *buffer,
                                                                         GtkSourceNewlineType        type,
-                                                                        gboolean                    
ensure_trailing_newline);
+                                                                        gboolean                    
add_trailing_newline);
 
 G_GNUC_INTERNAL
 gsize           _gtk_source_buffer_input_stream_get_total_size         (GtkSourceBufferInputStream *stream);
diff --git a/gtksourceview/gtksourcebufferoutputstream.c b/gtksourceview/gtksourcebufferoutputstream.c
index b14d844..d7cedff 100644
--- a/gtksourceview/gtksourcebufferoutputstream.c
+++ b/gtksourceview/gtksourcebufferoutputstream.c
@@ -81,14 +81,14 @@ struct _GtkSourceBufferOutputStreamPrivate
        guint is_initialized : 1;
        guint is_closed : 1;
 
-       guint ensure_trailing_newline : 1;
+       guint remove_trailing_newline : 1;
 };
 
 enum
 {
        PROP_0,
        PROP_BUFFER,
-       PROP_ENSURE_TRAILING_NEWLINE
+       PROP_REMOVE_TRAILING_NEWLINE
 };
 
 G_DEFINE_TYPE_WITH_PRIVATE (GtkSourceBufferOutputStream, gtk_source_buffer_output_stream, 
G_TYPE_OUTPUT_STREAM)
@@ -122,8 +122,8 @@ gtk_source_buffer_output_stream_set_property (GObject      *object,
                        stream->priv->source_buffer = g_value_dup_object (value);
                        break;
 
-               case PROP_ENSURE_TRAILING_NEWLINE:
-                       stream->priv->ensure_trailing_newline = g_value_get_boolean (value);
+               case PROP_REMOVE_TRAILING_NEWLINE:
+                       stream->priv->remove_trailing_newline = g_value_get_boolean (value);
                        break;
 
                default:
@@ -146,8 +146,8 @@ gtk_source_buffer_output_stream_get_property (GObject    *object,
                        g_value_set_object (value, stream->priv->source_buffer);
                        break;
 
-               case PROP_ENSURE_TRAILING_NEWLINE:
-                       g_value_set_boolean (value, stream->priv->ensure_trailing_newline);
+               case PROP_REMOVE_TRAILING_NEWLINE:
+                       g_value_set_boolean (value, stream->priv->remove_trailing_newline);
                        break;
 
                default:
@@ -227,9 +227,9 @@ gtk_source_buffer_output_stream_class_init (GtkSourceBufferOutputStreamClass *kl
                                                              G_PARAM_STATIC_STRINGS));
 
        g_object_class_install_property (object_class,
-                                        PROP_ENSURE_TRAILING_NEWLINE,
-                                        g_param_spec_boolean ("ensure-trailing-newline",
-                                                              "Ensure trailing newline",
+                                        PROP_REMOVE_TRAILING_NEWLINE,
+                                        g_param_spec_boolean ("remove-trailing-newline",
+                                                              "Remove trailing newline",
                                                               "",
                                                               TRUE,
                                                               G_PARAM_READWRITE |
@@ -473,13 +473,13 @@ get_newline_type (GtkTextIter *end)
 GOutputStream *
 gtk_source_buffer_output_stream_new (GtkSourceBuffer *buffer,
                                     GSList          *candidate_encodings,
-                                    gboolean         ensure_trailing_newline)
+                                    gboolean         remove_trailing_newline)
 {
        GtkSourceBufferOutputStream *stream;
 
        stream = g_object_new (GTK_SOURCE_TYPE_BUFFER_OUTPUT_STREAM,
                               "buffer", buffer,
-                              "ensure-trailing-newline", ensure_trailing_newline,
+                              "remove-trailing-newline", remove_trailing_newline,
                               NULL);
 
        stream->priv->encodings = g_slist_copy (candidate_encodings);
@@ -665,12 +665,8 @@ validate_and_insert (GtkSourceBufferOutputStream *stream,
        }
 }
 
-/* If the last char is a newline, remove it from the buffer (otherwise
- * GtkTextView shows it as an empty line).
- * See https://bugzilla.gnome.org/show_bug.cgi?id=324942
- */
 static void
-remove_ending_newline (GtkSourceBufferOutputStream *stream)
+remove_trailing_newline (GtkSourceBufferOutputStream *stream)
 {
        GtkTextIter end;
        GtkTextIter start;
@@ -688,7 +684,6 @@ remove_ending_newline (GtkSourceBufferOutputStream *stream)
                        gtk_text_iter_forward_to_line_end (&start);
                }
 
-               /* Delete the empty line which is from 'start' to 'end' */
                gtk_text_buffer_delete (GTK_TEXT_BUFFER (stream->priv->source_buffer),
                                        &start,
                                        &end);
@@ -698,9 +693,9 @@ remove_ending_newline (GtkSourceBufferOutputStream *stream)
 static void
 end_append_text_to_document (GtkSourceBufferOutputStream *stream)
 {
-       if (stream->priv->ensure_trailing_newline)
+       if (stream->priv->remove_trailing_newline)
        {
-               remove_ending_newline (stream);
+               remove_trailing_newline (stream);
        }
 
        gtk_text_buffer_set_modified (GTK_TEXT_BUFFER (stream->priv->source_buffer),
diff --git a/gtksourceview/gtksourcebufferoutputstream.h b/gtksourceview/gtksourcebufferoutputstream.h
index 863b8bd..62b2f5c 100644
--- a/gtksourceview/gtksourcebufferoutputstream.h
+++ b/gtksourceview/gtksourcebufferoutputstream.h
@@ -58,7 +58,7 @@ GType                  gtk_source_buffer_output_stream_get_type       (void) G_GNUC_CONST;
 G_GNUC_INTERNAL
 GOutputStream          *gtk_source_buffer_output_stream_new            (GtkSourceBuffer             *buffer,
                                                                         GSList                      
*candidate_encodings,
-                                                                        gboolean                     
ensure_trailing_newline);
+                                                                        gboolean                     
remove_trailing_newline);
 
 G_GNUC_INTERNAL
 GtkSourceNewlineType    gtk_source_buffer_output_stream_detect_newline_type