lib/search.h

   1 #ifndef MC__SEARCH_H
   2 #define MC__SEARCH_H
   3
   4 #include <config.h>
   5
   6 #include "lib/global.h"         /* <glib.h> */
   7
   8 #include <sys/types.h>
   9
  10 #ifdef SEARCH_TYPE_PCRE
  11 #include <pcre.h>
  12 #endif
  13
  14 /*** typedefs(not structures) and defined constants **********************************************/
  15
  16 typedef enum mc_search_cbret_t mc_search_cbret_t;
  17
  18 typedef mc_search_cbret_t (*mc_search_fn) (const void *user_data, gsize char_offset,
  19                                            int *current_char);
  20 typedef mc_search_cbret_t (*mc_update_fn) (const void *user_data, gsize char_offset);
  21
  22 #define MC_SEARCH__NUM_REPLACE_ARGS 64
  23
  24 #ifdef SEARCH_TYPE_GLIB
  25 #define mc_search_matchinfo_t GMatchInfo
  26 #else
  27 #define mc_search_matchinfo_t pcre_extra
  28 #endif
  29
  30 /*** enums ***************************************************************************************/
  31
  32 typedef enum
  33 {
  34     MC_SEARCH_E_OK,
  35     MC_SEARCH_E_INPUT,
  36     MC_SEARCH_E_REGEX_COMPILE,
  37     MC_SEARCH_E_REGEX,
  38     MC_SEARCH_E_REGEX_REPLACE,
  39     MC_SEARCH_E_NOTFOUND
  40 } mc_search_error_t;
  41
  42 typedef enum
  43 {
  44     MC_SEARCH_T_NORMAL,
  45     MC_SEARCH_T_REGEX,
  46     MC_SEARCH_T_HEX,
  47     MC_SEARCH_T_GLOB
  48 } mc_search_type_t;
  49
  50 enum mc_search_cbret_t
  51 {
  52     MC_SEARCH_CB_OK = 0,
  53     MC_SEARCH_CB_INVALID = -1,
  54     MC_SEARCH_CB_ABORT = -2,
  55     MC_SEARCH_CB_SKIP = -3
  56 };
  57
  58 /*** structures declarations (and typedefs of structures)*****************************************/
  59
  60 typedef struct mc_search_struct
  61 {
  62     /* public input data */
  63
  64 #ifdef HAVE_CHARSET
  65     /* search in all charsets */
  66     gboolean is_all_charsets;
  67 #endif
  68
  69     /* case sensitive search */
  70     gboolean is_case_sensitive;
  71
  72     /* search only once.  Is this for replace? */
  73     gboolean is_once_only;
  74
  75     /* search only whole words (from begin to end). Used only with NORMAL search type */
  76     gboolean whole_words;
  77
  78     /* search entire string (from begin to end). Used only with GLOB search type */
  79     gboolean is_entire_line;
  80
  81     /* function, used for getting data. NULL if not used */
  82     mc_search_fn search_fn;
  83
  84     /* function, used for updatin current search status. NULL if not used */
  85     mc_update_fn update_fn;
  86
  87     /* type of search */
  88     mc_search_type_t search_type;
  89
  90     /* public output data */
  91
  92     /* some data for normal */
  93     off_t normal_offset;
  94
  95     off_t start_buffer;
  96     /* some data for regexp */
  97     int num_results;
  98     gboolean is_utf8;
  99     mc_search_matchinfo_t *regex_match_info;
 100     GString *regex_buffer;
 101 #ifdef SEARCH_TYPE_PCRE
 102     int iovector[MC_SEARCH__NUM_REPLACE_ARGS * 2];
 103 #endif                          /* SEARCH_TYPE_PCRE */
 104
 105     /* private data */
 106
 107     /* prepared conditions */
 108     GPtrArray *conditions;
 109
 110     /* original search string */
 111     gchar *original;
 112     gsize original_len;
 113 #ifdef HAVE_CHARSET
 114     gchar *original_charset;
 115 #endif
 116
 117     /* error code after search */
 118     mc_search_error_t error;
 119     gchar *error_str;
 120 } mc_search_t;
 121
 122 typedef struct mc_search_type_str_struct
 123 {
 124     const char *str;
 125     mc_search_type_t type;
 126 } mc_search_type_str_t;
 127
 128 /*** global variables defined in .c file *********************************************************/
 129
 130 /*** declarations of public functions ************************************************************/
 131
 132 mc_search_t *mc_search_new (const gchar * original, gsize original_len,
 133                             const gchar * original_charset);
 134
 135 void mc_search_free (mc_search_t * lc_mc_search);
 136
 137 gboolean mc_search_prepare (mc_search_t * mc_search);
 138
 139 gboolean mc_search_run (mc_search_t * mc_search, const void *user_data, gsize start_search,
 140                         gsize end_search, gsize * found_len);
 141
 142 gboolean mc_search_is_type_avail (mc_search_type_t);
 143
 144 const mc_search_type_str_t *mc_search_types_list_get (size_t * num);
 145
 146 GString *mc_search_prepare_replace_str (mc_search_t * mc_search, GString * replace_str);
 147 char *mc_search_prepare_replace_str2 (mc_search_t * lc_mc_search, const char *replace_str);
 148
 149 gboolean mc_search_is_fixed_search_str (mc_search_t *);
 150
 151 gchar **mc_search_get_types_strings_array (size_t * num);
 152
 153 gboolean mc_search (const gchar * pattern, const gchar * pattern_charset, const gchar * str,
 154                     mc_search_type_t type);
 155
 156 int mc_search_getstart_result_by_num (mc_search_t *, int);
 157 int mc_search_getend_result_by_num (mc_search_t *, int);
 158
 159 #endif