search.h

Go to the documentation of this file.

#ifndef NVIM_SEARCH_H
#define NVIM_SEARCH_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "nvim/buffer_defs.h"
#include "nvim/eval/funcs.h"
#include "nvim/eval/typval.h"
#include "nvim/normal.h"
#include "nvim/os/time.h"
#include "nvim/vim.h"
 
// Values for the find_pattern_in_path() function args 'type' and 'action':
#define FIND_ANY        1
#define FIND_DEFINE     2
#define CHECK_PATH      3
 
#define ACTION_SHOW     1
#define ACTION_GOTO     2
#define ACTION_SPLIT    3
#define ACTION_SHOW_ALL 4
#define ACTION_EXPAND   5
 
// Values for 'options' argument in do_search() and searchit()
#define SEARCH_REV    0x01  
#define SEARCH_ECHO   0x02  
#define SEARCH_MSG    0x0c  
#define SEARCH_NFMSG  0x08  
#define SEARCH_OPT    0x10  
#define SEARCH_HIS    0x20  
#define SEARCH_END    0x40  
#define SEARCH_NOOF   0x80  
#define SEARCH_START 0x100  
#define SEARCH_MARK  0x200  
#define SEARCH_KEEP  0x400  
#define SEARCH_PEEK  0x800  
#define SEARCH_COL  0x1000  
 
// Values for flags argument for findmatchlimit()
#define FM_BACKWARD     0x01    // search backwards
#define FM_FORWARD      0x02    // search forwards
#define FM_BLOCKSTOP    0x04    // stop at start/end of block
#define FM_SKIPCOMM     0x08    // skip comments
 
// Values for sub_cmd and which_pat argument for search_regcomp()
// Also used for which_pat argument for searchit()
#define RE_SEARCH       0       // save/use pat in/from search_pattern
#define RE_SUBST        1       // save/use pat in/from subst_pattern
#define RE_BOTH         2       // save pat in both patterns
#define RE_LAST         2       // use last used pattern if "pat" is NULL
 
// Values for searchcount()
#define SEARCH_STAT_DEF_TIMEOUT 40L
#define SEARCH_STAT_DEF_MAX_COUNT 99
#define SEARCH_STAT_BUF_LEN 12
 
typedef struct soffset {
  char dir;     
  bool line;    
  bool end;     
  int64_t off;  
} SearchOffset;
 
typedef struct spat {
  char_u *pat;          
  bool magic;           
  bool no_scs;          
  Timestamp timestamp;  
  SearchOffset off;     
  dict_T *additional_data;  
} SearchPattern;
 
typedef struct {
  linenr_T sa_stop_lnum;  
  proftime_T *sa_tm;        
  int sa_timed_out;  
  int sa_wrapped;    
} searchit_arg_T;
 
typedef struct searchstat {
  int cur;      // current position of found words
  int cnt;      // total count of found words
  bool exact_match;    // true if matched exactly on specified position
  int incomplete;     // 0: search was fully completed
  // 1: recomputing was timed out
  // 2: max count exceeded
  int last_maxcount;  // the max count of the last search
} searchstat_T;
 
#ifdef INCLUDE_GENERATED_DECLARATIONS
# include "search.h.generated.h"
#endif
#endif  // NVIM_SEARCH_H