cevent.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2026 Enrico M. Crisostomo
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef FSW__CEVENT_H
#  define FSW__CEVENT_H
 
#  include <time.h>
#  include <limits.h>
#  include <stdbool.h>
#  include "libfswatch_types.h"
 
#  ifdef __cplusplus
extern "C"
{
#  endif

  enum fsw_event_flag
  {
    NoOp = 0,                     
    PlatformSpecific = (1 << 0),  
    Created = (1 << 1),           
    Updated = (1 << 2),           
    Removed = (1 << 3),           
    Renamed = (1 << 4),           
    OwnerModified = (1 << 5),     
    AttributeModified = (1 << 6), 
    MovedFrom = (1 << 7),         
    MovedTo = (1 << 8),           
    IsFile = (1 << 9),            
    IsDir = (1 << 10),            
    IsSymLink = (1 << 11),        
    Link = (1 << 12),             
    Overflow = (1 << 13),         
    CloseWrite = (1 << 14)        
  };
 
  extern const enum fsw_event_flag FSW_ALL_EVENT_FLAGS[16];

  FSW_STATUS fsw_get_event_flag_by_name(const char *name, enum fsw_event_flag *flag);

  char *fsw_get_event_flag_name(const enum fsw_event_flag flag);

  typedef struct fsw_cevent
  {
    char * path;
    time_t evt_time;
    enum fsw_event_flag * flags;
    unsigned int flags_num;
  } fsw_cevent;

  enum fsw_process_id_kind
  {
    FSW_PROCESS_ID_NONE = 0, 
    FSW_PROCESS_ID_PID,      
    FSW_PROCESS_ID_TID       
  };

  typedef struct fsw_cevent_v2
  {
    char * path;
    time_t evt_time;
    enum fsw_event_flag * flags;
    unsigned int flags_num;
    unsigned long correlation_id;
    enum fsw_process_id_kind process_id_kind;
    long long process_id;
    int process_pidfd;
    bool has_process_pidfd;
  } fsw_cevent_v2;

  typedef void (*FSW_CEVENT_CALLBACK)(fsw_cevent const *const events,
                                      const unsigned int event_num,
                                      void *data);

  typedef void (*FSW_CEVENT_CALLBACK_V2)(fsw_cevent_v2 const *const events,
                                         const unsigned int event_num,
                                         void *data);
 
#  ifdef __cplusplus
}
#  endif
 
#endif  /* FSW__CEVENT_H */