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 /** @gironly
  47  * Find selection options */
  48 typedef enum
  49 {
  50         GEANY_FIND_SEL_CURRENT_WORD,
  51         GEANY_FIND_SEL_X,
  52         GEANY_FIND_SEL_AGAIN
  53 }
  54 GeanyFindSelOptions;
  55
  56 /** Search preferences */
  57 typedef struct GeanySearchPrefs
  58 {
  59         gboolean        always_wrap;                    /* don't ask whether to wrap search */
  60         gboolean        use_current_word;               /**< Use current word for default search text */
  61         gboolean        use_current_file_dir;   /* find in files directory to use on showing dialog */
  62         gboolean        hide_find_dialog;               /* hide the find dialog on next or previous */
  63         gboolean        replace_and_find_by_default;    /* enter in replace window performs Replace & Find instead of Replace */
  64         GeanyFindSelOptions find_selection_type;
  65 }
  66 GeanySearchPrefs;
  67
  68 typedef struct GeanyMatchInfo
  69 {
  70         GeanyFindFlags flags;
  71         /* range */
  72         gint start, end;
  73         /* only valid if (flags & GEANY_FIND_REGEX) */
  74         gchar *match_text; /* text actually matched */
  75         struct
  76         {
  77                 gint start, end;
  78         }
  79         matches[10]; /* sub-patterns */
  80 }
  81 GeanyMatchInfo;
  82
  83 void search_show_find_in_files_dialog(const gchar *dir);
  84
  85
  86 #ifdef GEANY_PRIVATE
  87
  88 struct GeanyDocument; /* document.h includes this header */
  89 struct _ScintillaObject;
  90 struct Sci_TextToFind;
  91
  92
  93 /* the flags given in the search dialog for "find next", also used by the search bar */
  94 typedef struct GeanySearchData
  95 {
  96         gchar                   *text;
  97         GeanyFindFlags  flags;
  98         gboolean                backwards;
  99         /* set to TRUE when text was set by a search bar callback to keep track of
 100          * search bar background colour */
 101         gboolean                search_bar;
 102         /* text as it was entered by user */
 103         gchar                   *original_text;
 104 }
 105 GeanySearchData;
 106
 107 extern GeanySearchData search_data;
 108
 109 extern GeanySearchPrefs search_prefs;
 110
 111
 112 void search_init(void);
 113
 114 void search_finalize(void);
 115
 116 void search_show_find_dialog(void);
 117
 118 void search_show_replace_dialog(void);
 119
 120 void search_show_find_in_files_dialog_full(const gchar *text, const gchar *dir);
 121
 122 void geany_match_info_free(GeanyMatchInfo *info);
 123
 124 gint search_find_prev(struct _ScintillaObject *sci, const gchar *str, GeanyFindFlags flags, GeanyMatchInfo **match_);
 125
 126 gint search_find_next(struct _ScintillaObject *sci, const gchar *str, GeanyFindFlags flags, GeanyMatchInfo **match_);
 127
 128 gint search_find_text(struct _ScintillaObject *sci, GeanyFindFlags flags, struct Sci_TextToFind *ttf, GeanyMatchInfo **match_);
 129
 130 void search_find_again(gboolean change_direction);
 131
 132 void search_find_usage(const gchar *search_text, const gchar *original_search_text, GeanyFindFlags flags, gboolean in_session);
 133
 134 void search_find_selection(struct GeanyDocument *doc, gboolean search_backwards);
 135
 136 gint search_mark_all(struct GeanyDocument *doc, const gchar *search_text, GeanyFindFlags flags);
 137
 138 gint search_replace_match(struct _ScintillaObject *sci, const GeanyMatchInfo *match, const gchar *replace_text);
 139
 140 guint search_replace_range(struct _ScintillaObject *sci, struct Sci_TextToFind *ttf,
 141                 GeanyFindFlags flags, const gchar *replace_text);
 142
 143 #endif /* GEANY_PRIVATE */
 144
 145 G_END_DECLS
 146
 147 #endif /* GEANY_SEARCH_H */