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