src/search.h

   1 /*
   2  *      search.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2006-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2006-2012 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 along
  18  *      with this program; if not, write to the Free Software Foundation, Inc.,
  19  *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 /**
  23  * @file search.h
  24  * Search (prefs).
  25  **/
  26
  27
  28 #ifndef GEANY_SEARCH_H
  29 #define GEANY_SEARCH_H 1
  30
  31 #include <glib.h>
  32
  33
  34 G_BEGIN_DECLS
  35
  36 typedef enum GeanyFindFlags
  37 {
  38         GEANY_FIND_MATCHCASE = 1 << 0,
  39         GEANY_FIND_WHOLEWORD = 1 << 1,
  40         GEANY_FIND_WORDSTART = 1 << 2,
  41         GEANY_FIND_REGEXP    = 1 << 3,
  42         GEANY_FIND_MULTILINE = 1 << 4
  43 }
  44 GeanyFindFlags;
  45
  46 enum GeanyFindSelOptions
  47 {
  48         GEANY_FIND_SEL_CURRENT_WORD,
  49         GEANY_FIND_SEL_X,
  50         GEANY_FIND_SEL_AGAIN
  51 };
  52
  53 /** Search preferences */
  54 typedef struct GeanySearchPrefs
  55 {
  56         gboolean        always_wrap;                    /* don't ask whether to wrap search */
  57         gboolean        use_current_word;               /**< Use current word for default search text */
  58         gboolean        use_current_file_dir;   /* find in files directory to use on showing dialog */
  59         gboolean        hide_find_dialog;               /* hide the find dialog on next or previous */
  60         gboolean        replace_and_find_by_default;    /* enter in replace window performs Replace & Find instead of Replace */
  61         enum GeanyFindSelOptions find_selection_type;
  62 }
  63 GeanySearchPrefs;
  64
  65 typedef struct GeanyMatchInfo
  66 {
  67         GeanyFindFlags flags;
  68         /* range */
  69         gint start, end;
  70         /* only valid if (flags & GEANY_FIND_REGEX) */
  71         gchar *match_text; /* text actually matched */
  72         struct
  73         {
  74                 gint start, end;
  75         }
  76         matches[10]; /* sub-patterns */
  77 }
  78 GeanyMatchInfo;
  79
  80 void search_show_find_in_files_dialog(const gchar *dir);
  81
  82
  83 #ifdef GEANY_PRIVATE
  84
  85 struct GeanyDocument; /* document.h includes this header */
  86 struct _ScintillaObject;
  87 struct Sci_TextToFind;
  88
  89
  90 /* the flags given in the search dialog for "find next", also used by the search bar */
  91 typedef struct GeanySearchData
  92 {
  93         gchar                   *text;
  94         GeanyFindFlags  flags;
  95         gboolean                backwards;
  96         /* set to TRUE when text was set by a search bar callback to keep track of
  97          * search bar background colour */
  98         gboolean                search_bar;
  99         /* text as it was entered by user */
 100         gchar                   *original_text;
 101 }
 102 GeanySearchData;
 103
 104 extern GeanySearchData search_data;
 105
 106 extern GeanySearchPrefs search_prefs;
 107
 108
 109 void search_init(void);
 110
 111 void search_finalize(void);
 112
 113 void search_show_find_dialog(void);
 114
 115 void search_show_replace_dialog(void);
 116
 117 void search_show_find_in_files_dialog_full(const gchar *text, const gchar *dir);
 118
 119 void geany_match_info_free(GeanyMatchInfo *info);
 120
 121 gint search_find_prev(struct _ScintillaObject *sci, const gchar *str, GeanyFindFlags flags, GeanyMatchInfo **match_);
 122
 123 gint search_find_next(struct _ScintillaObject *sci, const gchar *str, GeanyFindFlags flags, GeanyMatchInfo **match_);
 124
 125 gint search_find_text(struct _ScintillaObject *sci, GeanyFindFlags flags, struct Sci_TextToFind *ttf, GeanyMatchInfo **match_);
 126
 127 void search_find_again(gboolean change_direction);
 128
 129 void search_find_usage(const gchar *search_text, const gchar *original_search_text, GeanyFindFlags flags, gboolean in_session);
 130
 131 void search_find_selection(struct GeanyDocument *doc, gboolean search_backwards);
 132
 133 gint search_mark_all(struct GeanyDocument *doc, const gchar *search_text, GeanyFindFlags flags);
 134
 135 gint search_replace_match(struct _ScintillaObject *sci, const GeanyMatchInfo *match, const gchar *replace_text);
 136
 137 guint search_replace_range(struct _ScintillaObject *sci, struct Sci_TextToFind *ttf,
 138                 GeanyFindFlags flags, const gchar *replace_text);
 139
 140 #endif /* GEANY_PRIVATE */
 141
 142 G_END_DECLS
 143
 144 #endif /* GEANY_SEARCH_H */