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