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