PSPPIRE: Add feature to search for text in the syntax window.
[pspp] / src / ui / gui / psppire-syntax-window.c
index 2e398ade4ad22097097c321875a5801623ec0ba8..3fecfad26a5ddcdd089fa7e4bf1e8ff847d10199 100644 (file)
@@ -1,5 +1,6 @@
 /* PSPPIRE - a graphical user interface for PSPP.
-   Copyright (C) 2008, 2009, 2010, 2011, 2012, 2014, 2016  Free Software Foundation
+   Copyright (C) 2008, 2009, 2010, 2011, 2012, 2014, 2016,
+   2020  Free Software Foundation
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -160,6 +161,8 @@ psppire_syntax_window_dispose (GObject *obj)
   if (sw->dispose_has_run)
     return;
 
+  g_object_unref (sw->search_text_buffer);
+
   g_free (sw->encoding);
   sw->encoding = NULL;
 
@@ -261,10 +264,90 @@ on_edit_delete (PsppireSyntaxWindow *sw)
   GtkTextIter begin, end;
   GtkTextBuffer *buffer = GTK_TEXT_BUFFER (sw->buffer);
 
-  if ( gtk_text_buffer_get_selection_bounds (buffer, &begin, &end) )
+  if (gtk_text_buffer_get_selection_bounds (buffer, &begin, &end))
     gtk_text_buffer_delete (buffer, &begin, &end);
 }
 
+/* Create and run a dialog to collect the search string.
+   In future this might be expanded to include options, for example
+   backward searching, case sensitivity etc.  */
+static const char *
+get_search_text (PsppireSyntaxWindow *parent)
+{
+  const char *search_text = NULL;
+  GtkDialogFlags flags = GTK_DIALOG_DESTROY_WITH_PARENT | GTK_DIALOG_MODAL;
+  GtkWidget *dialog = gtk_dialog_new_with_buttons (_("Text Search"),
+                                                   GTK_WINDOW (parent),
+                                                   flags,
+                                                   _("_OK"),
+                                                   GTK_RESPONSE_OK,
+                                                   _("_Cancel"),
+                                                   GTK_RESPONSE_CANCEL,
+                                                   NULL);
+
+  GtkWidget *content_area =
+    gtk_dialog_get_content_area (GTK_DIALOG (dialog));
+
+  GtkWidget *box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 5);
+  GtkWidget *label = gtk_label_new (_("Text to search for:"));
+  GtkWidget *entry = gtk_entry_new_with_buffer (parent->search_text_buffer);
+
+  /* Add the label, and show everything we have added.  */
+  gtk_container_add (GTK_CONTAINER (content_area), box);
+  gtk_container_add (GTK_CONTAINER (box), label);
+  gtk_container_add (GTK_CONTAINER (box), entry);
+  gtk_widget_show_all (content_area);
+
+  int result = gtk_dialog_run (GTK_DIALOG (dialog));
+  switch (result)
+    {
+    case GTK_RESPONSE_OK:
+      search_text = gtk_entry_get_text (GTK_ENTRY (entry));
+      break;
+    default:
+      search_text = NULL;
+    };
+
+  gtk_widget_destroy (dialog);
+  return search_text;
+}
+
+
+/* What to do when the Find menuitem is called.  */
+static void
+on_edit_find (PsppireSyntaxWindow *sw)
+{
+  GtkTextBuffer *buffer = GTK_TEXT_BUFFER (sw->buffer);
+  GtkTextIter begin;
+  GtkTextIter loc;
+  const char *target = get_search_text (sw);
+
+  if (target == NULL)
+    return;
+
+  /* This is a wrap-around search.  So start searching one
+     character after the current char.  */
+  GtkTextMark *mark = gtk_text_buffer_get_insert (buffer);
+  gtk_text_buffer_get_iter_at_mark (buffer, &begin, mark);
+  gtk_text_iter_forward_char (&begin);
+  if (gtk_text_iter_forward_search (&begin, target, 0,
+                                    &loc, 0, 0))
+    {
+      gtk_text_buffer_place_cursor (buffer, &loc);
+    }
+  else
+    {
+      /* If not found, then continue the search from the top
+         of the buffer.  */
+      gtk_text_buffer_get_start_iter (buffer, &begin);
+      if (gtk_text_iter_forward_search (&begin, target, 0,
+                                        &loc, 0, 0))
+        {
+          gtk_text_buffer_place_cursor (buffer, &loc);
+        }
+    }
+}
+
 
 /* The syntax editor's clipboard deals only with text */
 enum {
@@ -331,7 +414,7 @@ set_clip (PsppireSyntaxWindow *sw, GtkTextIter *begin, GtkTextIter *end)
   GtkClipboard *clipboard ;
   GtkTextBuffer *buffer = GTK_TEXT_BUFFER (sw->buffer);
 
-  if ( ! gtk_text_buffer_get_selection_bounds (buffer, begin, end) )
+  if (! gtk_text_buffer_get_selection_bounds (buffer, begin, end))
     return FALSE;
 
   g_free (sw->cliptext);
@@ -354,7 +437,7 @@ on_edit_cut (PsppireSyntaxWindow *sw)
 {
   GtkTextIter begin, end;
 
-  if ( set_clip (sw, &begin, &end))
+  if (set_clip (sw, &begin, &end))
     gtk_text_buffer_delete (GTK_TEXT_BUFFER (sw->buffer), &begin, &end);
 }
 
@@ -390,7 +473,7 @@ set_paste_sensitivity (GtkClipboard *clip, GdkEventOwnerChange *event, gpointer
   for (i = 0 ; i < sizeof (targets) / sizeof (targets[0]) ; ++i)
     {
       GdkAtom atom = gdk_atom_intern (targets[i].target, TRUE);
-      if ( gtk_clipboard_wait_is_target_available (clip, atom))
+      if (gtk_clipboard_wait_is_target_available (clip, atom))
        {
          compatible_target = TRUE;
          break;
@@ -421,7 +504,7 @@ on_run_selection (PsppireSyntaxWindow *se)
 {
   GtkTextIter begin, end;
 
-  if ( gtk_text_buffer_get_selection_bounds (GTK_TEXT_BUFFER (se->buffer), &begin, &end) )
+  if (gtk_text_buffer_get_selection_bounds (GTK_TEXT_BUFFER (se->buffer), &begin, &end))
     editor_execute_syntax (se, begin, end);
 }
 
@@ -439,7 +522,7 @@ on_run_to_end (PsppireSyntaxWindow *se)
   gtk_text_buffer_get_iter_at_mark (GTK_TEXT_BUFFER (se->buffer),
                                    &here,
                                    gtk_text_buffer_get_insert (GTK_TEXT_BUFFER (se->buffer))
-                                   );
+                               );
 
   line = gtk_text_iter_get_line (&here) ;
 
@@ -465,7 +548,7 @@ on_run_current_line (PsppireSyntaxWindow *se)
   gtk_text_buffer_get_iter_at_mark (GTK_TEXT_BUFFER (se->buffer),
                                    &here,
                                    gtk_text_buffer_get_insert (GTK_TEXT_BUFFER (se->buffer))
-                                   );
+                               );
 
   line = gtk_text_iter_get_line (&here) ;
 
@@ -485,8 +568,8 @@ on_run_current_line (PsppireSyntaxWindow *se)
 static gchar *
 append_suffix (const gchar *filename)
 {
-  if ( ! g_str_has_suffix (filename, ".sps" ) &&
-       ! g_str_has_suffix (filename, ".SPS" ) )
+  if (! g_str_has_suffix (filename, ".sps") &&
+       ! g_str_has_suffix (filename, ".SPS"))
     {
       return g_strdup_printf ("%s.sps", filename);
     }
@@ -529,7 +612,7 @@ save_editor_to_file (PsppireSyntaxWindow *se,
   ss_dealloc (&text_locale);
   g_free (suffixedname);
 
-  if ( result )
+  if (result)
     {
       char *fn = g_filename_display_name (filename);
       gchar *msg = g_strdup_printf (_("Saved file `%s'"), fn);
@@ -583,12 +666,12 @@ syntax_pick_filename (PsppireWindow *window)
 
   response = gtk_dialog_run (GTK_DIALOG (dialog));
 
-  if ( response == GTK_RESPONSE_ACCEPT )
+  if (response == GTK_RESPONSE_ACCEPT)
     {
       gchar *encoding;
       char *filename;
 
-      filename = gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog) );
+      filename = gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog));
       psppire_window_set_filename (window, filename);
       free (filename);
 
@@ -612,7 +695,7 @@ syntax_save (PsppireWindow *se)
   const gchar *filename = psppire_window_get_filename (se);
   GError *err = NULL;
   save_editor_to_file (PSPPIRE_SYNTAX_WINDOW (se), filename, &err);
-  if ( err )
+  if (err)
     {
       msg (ME, "%s", err->message);
       g_error_free (err);
@@ -630,7 +713,7 @@ load_and_show_syntax_window (GtkWidget *se, const gchar *filename,
   ok = psppire_window_load (PSPPIRE_WINDOW (se), filename, encoding, NULL);
   gtk_source_buffer_end_not_undoable_action (PSPPIRE_SYNTAX_WINDOW (se)->buffer);
 
-  if (ok )
+  if (ok)
     gtk_widget_show (se);
   else
     gtk_widget_destroy (se);
@@ -649,7 +732,7 @@ open_syntax_window (const char *file_name, const gchar *encoding)
 {
   GtkWidget *se = psppire_syntax_window_new (NULL);
 
-  if ( file_name)
+  if (file_name)
     load_and_show_syntax_window (se, file_name, encoding);
 
   return GTK_WINDOW (se);
@@ -729,6 +812,7 @@ psppire_syntax_window_init (PsppireSyntaxWindow *window)
   window->cliptext = NULL;
   window->dispose_has_run = FALSE;
 
+  window->search_text_buffer = gtk_entry_buffer_new (NULL, -1);
 
   window->edit_delete = g_simple_action_new ("delete", NULL);
   g_action_map_add_action (G_ACTION_MAP (window), G_ACTION (window->edit_delete));
@@ -742,6 +826,8 @@ psppire_syntax_window_init (PsppireSyntaxWindow *window)
   window->edit_paste = g_simple_action_new ("paste", NULL);
   g_action_map_add_action (G_ACTION_MAP (window), G_ACTION (window->edit_paste));
 
+  window->edit_find = g_simple_action_new ("find", NULL);
+  g_action_map_add_action (G_ACTION_MAP (window), G_ACTION (window->edit_find));
 
   window->buffer = GTK_SOURCE_BUFFER (gtk_text_view_get_buffer (GTK_TEXT_VIEW (text_view)));
 
@@ -867,6 +953,11 @@ psppire_syntax_window_init (PsppireSyntaxWindow *window)
                    G_CALLBACK (on_edit_paste),
                    window);
 
+  g_signal_connect_swapped (window->edit_find,
+                   "activate",
+                   G_CALLBACK (on_edit_find),
+                   window);
+
   {
     GSimpleAction *run_all = g_simple_action_new ("run-all", NULL);
 
@@ -978,7 +1069,7 @@ syntax_load (PsppireWindow *window, const gchar *filename,
   GtkTextBuffer *buffer = GTK_TEXT_BUFFER (sw->buffer);
 
   /* FIXME: What if it's a very big file ? */
-  if ( ! g_file_get_contents (filename, &text_locale, &len_locale, &err) )
+  if (! g_file_get_contents (filename, &text_locale, &len_locale, &err))
     {
       error_dialog (GTK_WINDOW (window), filename, err);
       g_clear_error (&err);
@@ -1009,7 +1100,7 @@ syntax_load (PsppireWindow *window, const gchar *filename,
                                      NULL).string;
   free (text_locale);
 
-  if ( text_utf8 == NULL )
+  if (text_utf8 == NULL)
     {
       error_dialog (GTK_WINDOW (window), filename, err);
       g_clear_error (&err);