autocmd.h

Go to the documentation of this file.

#ifndef NVIM_AUTOCMD_H
#define NVIM_AUTOCMD_H
 
#include "nvim/buffer_defs.h"
#include "nvim/ex_cmds_defs.h"
 
// event_T definition
#ifdef INCLUDE_GENERATED_DECLARATIONS
# include "auevents_enum.generated.h"
#endif
 
// Struct to save values in before executing autocommands for a buffer that is
// not the current buffer.
typedef struct {
  buf_T *save_curbuf;             
  bool use_aucmd_win;             
  handle_T save_curwin_handle;    
  handle_T new_curwin_handle;     
  handle_T save_prevwin_handle;   
  bufref_T new_curbuf;            
  char *globaldir;                
  bool save_VIsual_active;        
} aco_save_T;
 
typedef struct AutoCmd {
  AucmdExecutable exec;
  bool once;                            // "One shot": removed after execution
  bool nested;                          // If autocommands nest here
  bool last;                            // last command in list
  int64_t id;                           // ID used for uniquely tracking an autocmd.
  sctx_T script_ctx;                    // script context where defined
  char *desc;                           // Description for the autocmd.
  struct AutoCmd *next;                 // Next AutoCmd in list
} AutoCmd;
 
typedef struct AutoPat {
  struct AutoPat *next;                 // next AutoPat in AutoPat list; MUST
                                        // be the first entry
  char *pat;                            // pattern as typed (NULL when pattern
                                        // has been removed)
  regprog_T *reg_prog;                  // compiled regprog for pattern
  AutoCmd *cmds;                        // list of commands to do
  int group;                            // group ID
  int patlen;                           // strlen() of pat
  int buflocal_nr;                      // !=0 for buffer-local AutoPat
  char allow_dirs;                      // Pattern may match whole path
  char last;                            // last pattern for apply_autocmds()
} AutoPat;
 
typedef struct AutoPatCmd {
  AutoPat *curpat;          // next AutoPat to examine
  AutoCmd *nextcmd;         // next AutoCmd to execute
  int group;                // group being used
  char *fname;              // fname to match with
  char *sfname;             // sfname to match with
  char *tail;               // tail of fname
  event_T event;            // current event
  int arg_bufnr;            // initially equal to <abuf>, set to zero when buf is deleted
  struct AutoPatCmd *next;  // chain of active apc-s for auto-invalidation
} AutoPatCmd;
 
 
// Set by the apply_autocmds_group function if the given event is equal to
// EVENT_FILETYPE. Used by the readfile function in order to determine if
// EVENT_BUFREADPOST triggered the EVENT_FILETYPE.
//
// Relying on this value requires one to reset it prior calling
// apply_autocmds_group.
EXTERN bool au_did_filetype INIT(= false);
 
 
#ifdef INCLUDE_GENERATED_DECLARATIONS
# include "autocmd.h.generated.h"
#endif
 
#define AUGROUP_DEFAULT    (-1)      // default autocmd group
#define AUGROUP_ERROR      (-2)      // erroneous autocmd group
#define AUGROUP_ALL        (-3)      // all autocmd groups
#define AUGROUP_DELETED    (-4)      // all autocmd groups
// #define AUGROUP_NS       -5      // TODO(tjdevries): Support namespaced based augroups
 
#define BUFLOCAL_PAT_LEN 25
 
#define FOR_ALL_AUEVENTS(event) \
  for (event_T event = (event_T)0; (int)event < (int)NUM_EVENTS; event = (event_T)((int)event + 1))  // NOLINT
 
#endif  // NVIM_AUTOCMD_H