src/search.h

   1 /*
   2  *      search.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2006 The Geany contributors
   5  *
   6  *      This program is free software; you can redistribute it and/or modify
   7  *      it under the terms of the GNU General Public License as published by
   8  *      the Free Software Foundation; either version 2 of the License, or
   9  *      (at your option) any later version.
  10  *
  11  *      This program is distributed in the hope that it will be useful,
  12  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *      GNU General Public License for more details.
  15  *
  16  *      You should have received a copy of the GNU General Public License along
  17  *      with this program; if not, write to the Free Software Foundation, Inc.,
  18  *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 /**
  22  * @file search.h
  23  * Search (prefs).
  24  **/
  25
  26
  27 #ifndef GEANY_SEARCH_H
  28 #define GEANY_SEARCH_H 1
  29
  30 #include <glib.h>
  31
  32
  33 G_BEGIN_DECLS
  34
  35 typedef enum GeanyFindFlags
  36 {
  37         GEANY_FIND_MATCHCASE = 1 << 0,
  38         GEANY_FIND_WHOLEWORD = 1 << 1,
  39         GEANY_FIND_WORDSTART = 1 << 2,
  40         GEANY_FIND_REGEXP    = 1 << 3,
  41         GEANY_FIND_MULTILINE = 1 << 4
  42 }
  43 GeanyFindFlags;
  44
  45 /** @gironly
  46  * Find selection options */
  47 typedef enum
  48 {
  49         GEANY_FIND_SEL_CURRENT_WORD,
  50         GEANY_FIND_SEL_X,
  51         GEANY_FIND_SEL_AGAIN
  52 }
  53 GeanyFindSelOptions;
  54
  55 /** Search preferences */
  56 typedef struct GeanySearchPrefs
  57 {
  58         gboolean        always_wrap;                    /* don't ask whether to wrap search */
  59         gboolean        use_current_word;               /**< Use current word for default search text */
  60         gboolean        use_current_file_dir;   /* find in files directory to use on showing dialog */
  61         gboolean        hide_find_dialog;               /* hide the find dialog on next or previous */
  62         gboolean        replace_and_find_by_default;    /* enter in replace window performs Replace & Find instead of Replace */
  63         GeanyFindSelOptions find_selection_type;
  64         gboolean        skip_confirmation_for_replace_in_session;       /* do *not* ask for confirmation
  65                                                                                                                            before using "replace in session */
  66 }
  67 GeanySearchPrefs;
  68
  69 typedef struct GeanyMatchInfo
  70 {
  71         GeanyFindFlags flags;
  72         /* range */
  73         gint start, end;
  74         /* only valid if (flags & GEANY_FIND_REGEX) */
  75         gchar *match_text; /* text actually matched */
  76         struct
  77         {
  78                 gint start, end;
  79         }
  80         matches[10]; /* sub-patterns */
  81 }
  82 GeanyMatchInfo;
  83
  84 void search_show_find_in_files_dialog(const gchar *dir);
  85
  86
  87 #ifdef GEANY_PRIVATE
  88
  89 struct GeanyDocument; /* document.h includes this header */
  90 struct _ScintillaObject;
  91 struct Sci_TextToFind;
  92
  93
  94 /* the flags given in the search dialog for "find next", also used by the search bar */
  95 typedef struct GeanySearchData
  96 {
  97         gchar                   *text;
  98         GeanyFindFlags  flags;
  99         gboolean                backwards;
 100         /* set to TRUE when text was set by a search bar callback to keep track of
 101          * search bar background colour */
 102         gboolean                search_bar;
 103         /* text as it was entered by user */
 104         gchar                   *original_text;
 105 }
 106 GeanySearchData;
 107
 108 extern GeanySearchData search_data;
 109
 110 extern GeanySearchPrefs search_prefs;
 111
 112
 113 void search_init(void);
 114
 115 void search_finalize(void);
 116
 117 void search_show_find_dialog(void);
 118
 119 void search_show_replace_dialog(void);
 120
 121 void search_show_find_in_files_dialog_full(const gchar *text, const gchar *dir);
 122
 123 void geany_match_info_free(GeanyMatchInfo *info);
 124
 125 gint search_find_prev(struct _ScintillaObject *sci, const gchar *str, GeanyFindFlags flags, GeanyMatchInfo **match_);
 126
 127 gint search_find_next(struct _ScintillaObject *sci, const gchar *str, GeanyFindFlags flags, GeanyMatchInfo **match_);
 128
 129 gint search_find_text(struct _ScintillaObject *sci, GeanyFindFlags flags, struct Sci_TextToFind *ttf, GeanyMatchInfo **match_);
 130
 131 void search_find_again(gboolean change_direction);
 132
 133 void search_find_usage(const gchar *search_text, const gchar *original_search_text, GeanyFindFlags flags, gboolean in_session);
 134
 135 void search_find_selection(struct GeanyDocument *doc, gboolean search_backwards);
 136
 137 gint search_mark_all(struct GeanyDocument *doc, const gchar *search_text, GeanyFindFlags flags);
 138
 139 gint search_replace_match(struct _ScintillaObject *sci, const GeanyMatchInfo *match, const gchar *replace_text);
 140
 141 guint search_replace_range(struct _ScintillaObject *sci, struct Sci_TextToFind *ttf,
 142                 GeanyFindFlags flags, const gchar *replace_text);
 143
 144 #endif /* GEANY_PRIVATE */
 145
 146 G_END_DECLS
 147
 148 #endif /* GEANY_SEARCH_H */