walkero
/
lite-xl
1
0
Fork 0
Code Issues 7 Pull Requests Projects Releases 15 Wiki Activity

Remove DMON_LOG_ERROR to return an error code

This commit is contained in:
Francesco Abbate 2022-01-08 10:55:43 +01:00
parent 7473fbf32c
commit 1520c12580
4 changed files with 64 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
data/core/init.lua
View File

@ -394,7 +394,12 @@ local function scan_project_folder(index)
local fstype = system.get_fs_type(dir.name) local fstype = system.get_fs_type(dir.name)
dir.force_rescan = (fstype == "nfs" or fstype == "fuse") dir.force_rescan = (fstype == "nfs" or fstype == "fuse")
if not dir.force_rescan then if not dir.force_rescan then
dir.watch_id = system.watch_dir(dir.name) local watch_err
dir.watch_id, watch_err = system.watch_dir(dir.name)
if not dir.watch_id then
core.log("Watch directory %s: %s", dir.name, watch_err)
dir.force_rescan = true
end
end end
local t, complete, entries_count = get_directory_files(dir, dir.name, "", {}, nil, 0, timed_max_files_pred) local t, complete, entries_count = get_directory_files(dir, dir.name, "", {}, nil, 0, timed_max_files_pred)
-- If dir.files_limit is set to TRUE it means that: -- If dir.files_limit is set to TRUE it means that:

78
lib/dmon/dmon.h
View File

@ -44,9 +44,6 @@
// DMON_ASSERT: // DMON_ASSERT:
// define this to provide your own assert // define this to provide your own assert
// default is 'assert' // default is 'assert'
// DMON_LOG_ERROR:
// define this to provide your own logging mechanism
// default implementation logs to stdout and breaks the program
// DMON_LOG_DEBUG // DMON_LOG_DEBUG
// define this to provide your own extra debug logging mechanism // define this to provide your own extra debug logging mechanism
// default implementation logs to stdout in DEBUG and does nothing in other builds // default implementation logs to stdout in DEBUG and does nothing in other builds
@ -104,10 +101,21 @@ typedef enum dmon_action_t {
DMON_ACTION_MOVE DMON_ACTION_MOVE
} dmon_action; } dmon_action;
typedef enum dmon_error_enum {
DMON_SUCCESS = 0,
DMON_ERROR_WATCH_DIR,
DMON_ERROR_OPEN_DIR,
DMON_ERROR_MONITOR_FAIL,
DMON_ERROR_UNSUPPORTED_SYMLINK,
DMON_ERROR_END,
} dmon_error;
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
DMON_API_DECL const char *dmon_error_str(dmon_error err);
DMON_API_DECL void dmon_init(void); DMON_API_DECL void dmon_init(void);
DMON_API_DECL void dmon_deinit(void); DMON_API_DECL void dmon_deinit(void);
@ -115,7 +123,7 @@ DMON_API_DECL dmon_watch_id dmon_watch(const char* rootdir,
void (*watch_cb)(dmon_watch_id watch_id, dmon_action action, void (*watch_cb)(dmon_watch_id watch_id, dmon_action action,
const char* rootdir, const char* filepath, const char* rootdir, const char* filepath,
const char* oldfilepath, void* user), const char* oldfilepath, void* user),
uint32_t flags, void* user_data); uint32_t flags, void* user_data, dmon_error *error_code);
DMON_API_DECL void dmon_unwatch(dmon_watch_id id); DMON_API_DECL void dmon_unwatch(dmon_watch_id id);
#ifdef __cplusplus #ifdef __cplusplus
@ -171,6 +179,7 @@ DMON_API_DECL void dmon_unwatch(dmon_watch_id id);
# include <stdlib.h> # include <stdlib.h>
/* Recursive removed for Lite XL when using inotify. */ /* Recursive removed for Lite XL when using inotify. */
# define LITE_XL_DISABLE_INOTIFY_RECURSIVE # define LITE_XL_DISABLE_INOTIFY_RECURSIVE
# define DMON_LOG_DEBUG(s)
#elif DMON_OS_MACOS #elif DMON_OS_MACOS
# include <pthread.h> # include <pthread.h>
# include <CoreServices/CoreServices.h> # include <CoreServices/CoreServices.h>
@ -191,11 +200,6 @@ DMON_API_DECL void dmon_unwatch(dmon_watch_id id);
# define DMON_ASSERT(e) assert(e) # define DMON_ASSERT(e) assert(e)
#endif #endif
#ifndef DMON_LOG_ERROR
# include <stdio.h>
# define DMON_LOG_ERROR(s) do { puts(s); DMON_ASSERT(0); } while(0)
#endif
#ifndef DMON_LOG_DEBUG #ifndef DMON_LOG_DEBUG
# ifndef NDEBUG # ifndef NDEBUG
# include <stdio.h> # include <stdio.h>
@ -225,10 +229,6 @@ DMON_API_DECL void dmon_unwatch(dmon_watch_id id);
#include <string.h> #include <string.h>
#ifndef _DMON_LOG_ERRORF
# define _DMON_LOG_ERRORF(str, ...) do { char msg[512]; snprintf(msg, sizeof(msg), str, __VA_ARGS__); DMON_LOG_ERROR(msg); } while(0);
#endif
#ifndef _DMON_LOG_DEBUGF #ifndef _DMON_LOG_DEBUGF
# define _DMON_LOG_DEBUGF(str, ...) do { char msg[512]; snprintf(msg, sizeof(msg), str, __VA_ARGS__); DMON_LOG_DEBUG(msg); } while(0); # define _DMON_LOG_DEBUGF(str, ...) do { char msg[512]; snprintf(msg, sizeof(msg), str, __VA_ARGS__); DMON_LOG_DEBUG(msg); } while(0);
#endif #endif
@ -358,6 +358,19 @@ static void * stb__sbgrowf(void *arr, int increment, int itemsize)
// watcher callback (same as dmon.h's decleration) // watcher callback (same as dmon.h's decleration)
typedef void (dmon__watch_cb)(dmon_watch_id, dmon_action, const char*, const char*, const char*, void*); typedef void (dmon__watch_cb)(dmon_watch_id, dmon_action, const char*, const char*, const char*, void*);
static const char *dmon__errors[] = {
"Success",
"Error watching directory",
"Error opening directory",
"Error enabling monitoring",
"Error support for symlink disabled",
};
DMON_API_IMPL const char *dmon_error_str(dmon_error err) {
DMON_ASSERT(err >= 0 && err < DMON_ERROR_END);
return dmon__errors[(int) err];
}
#if DMON_OS_WINDOWS #if DMON_OS_WINDOWS
// IOCP (windows) // IOCP (windows)
#ifdef UNICODE #ifdef UNICODE
@ -503,13 +516,13 @@ _DMON_PRIVATE DWORD WINAPI dmon__thread(LPVOID arg)
} }
DWORD wait_result = WaitForMultipleObjects(_dmon.num_watches, wait_handles, FALSE, 10); DWORD wait_result = WaitForMultipleObjects(_dmon.num_watches, wait_handles, FALSE, 10);
DMON_ASSERT(wait_result != WAIT_FAILED); // FIXME: do not check for WAIT_ABANDONED_<n>, check if that can happen.
if (wait_result != WAIT_TIMEOUT) { if (wait_result != WAIT_TIMEOUT && wait_result != WAIT_FAILED) {
dmon__watch_state* watch = &_dmon.watches[wait_result - WAIT_OBJECT_0]; dmon__watch_state* watch = &_dmon.watches[wait_result - WAIT_OBJECT_0];
DMON_ASSERT(HasOverlappedIoCompleted(&watch->overlapped));
DWORD bytes; DWORD bytes;
if (GetOverlappedResult(watch->dir_handle, &watch->overlapped, &bytes, FALSE)) { if (HasOverlappedIoCompleted(&watch->overlapped) &&
GetOverlappedResult(watch->dir_handle, &watch->overlapped, &bytes, FALSE)) {
char filepath[DMON_MAX_PATH]; char filepath[DMON_MAX_PATH];
PFILE_NOTIFY_INFORMATION notify; PFILE_NOTIFY_INFORMATION notify;
size_t offset = 0; size_t offset = 0;
@ -598,7 +611,7 @@ DMON_API_IMPL dmon_watch_id dmon_watch(const char* rootdir,
void (*watch_cb)(dmon_watch_id watch_id, dmon_action action, void (*watch_cb)(dmon_watch_id watch_id, dmon_action action,
const char* dirname, const char* filename, const char* dirname, const char* filename,
const char* oldname, void* user), const char* oldname, void* user),
uint32_t flags, void* user_data) uint32_t flags, void* user_data, dmon_error *error_code)
{ {
DMON_ASSERT(watch_cb); DMON_ASSERT(watch_cb);
DMON_ASSERT(rootdir && rootdir[0]); DMON_ASSERT(rootdir && rootdir[0]);
@ -632,17 +645,17 @@ DMON_API_IMPL dmon_watch_id dmon_watch(const char* rootdir,
FILE_NOTIFY_CHANGE_FILE_NAME | FILE_NOTIFY_CHANGE_DIR_NAME | FILE_NOTIFY_CHANGE_FILE_NAME | FILE_NOTIFY_CHANGE_DIR_NAME |
FILE_NOTIFY_CHANGE_SIZE; FILE_NOTIFY_CHANGE_SIZE;
watch->overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL); watch->overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
DMON_ASSERT(watch->overlapped.hEvent != INVALID_HANDLE_VALUE);
if (!dmon__refresh_watch(watch)) { if (watch->overlapped.hEvent == INVALID_HANDLE_VALUE ||
!dmon__refresh_watch(watch)) {
dmon__unwatch(watch); dmon__unwatch(watch);
DMON_LOG_ERROR("ReadDirectoryChanges failed"); *error_code = DMON_ERROR_WATCH_DIR;
LeaveCriticalSection(&_dmon.mutex); LeaveCriticalSection(&_dmon.mutex);
_InterlockedExchange(&_dmon.modify_watches, 0); _InterlockedExchange(&_dmon.modify_watches, 0);
return dmon__make_id(0); return dmon__make_id(0);
} }
} else { } else {
_DMON_LOG_ERRORF("Could not open: %s", rootdir); *error_code = DMON_ERROR_OPEN_DIR;
LeaveCriticalSection(&_dmon.mutex); LeaveCriticalSection(&_dmon.mutex);
_InterlockedExchange(&_dmon.modify_watches, 0); _InterlockedExchange(&_dmon.modify_watches, 0);
return dmon__make_id(0); return dmon__make_id(0);
@ -714,7 +727,9 @@ static dmon__state _dmon;
/* Implementation of recursive monitoring was removed on Linux for the Lite XL /* Implementation of recursive monitoring was removed on Linux for the Lite XL
* application. It is never used with recent version of Lite XL starting from 2.0.5 * application. It is never used with recent version of Lite XL starting from 2.0.5
* and recursive monitoring with inotify was always problematic and half-broken. */ * and recursive monitoring with inotify was always problematic and half-broken.
* Do not cover the new calling signature with error_code because not used by
* Lite XL. */
#ifndef LITE_XL_DISABLE_INOTIFY_RECURSIVE #ifndef LITE_XL_DISABLE_INOTIFY_RECURSIVE
_DMON_PRIVATE void dmon__watch_recursive(const char* dirname, int fd, uint32_t mask, _DMON_PRIVATE void dmon__watch_recursive(const char* dirname, int fd, uint32_t mask,
bool followlinks, dmon__watch_state* watch) bool followlinks, dmon__watch_state* watch)
@ -1099,7 +1114,7 @@ DMON_API_IMPL dmon_watch_id dmon_watch(const char* rootdir,
void (*watch_cb)(dmon_watch_id watch_id, dmon_action action, void (*watch_cb)(dmon_watch_id watch_id, dmon_action action,
const char* dirname, const char* filename, const char* dirname, const char* filename,
const char* oldname, void* user), const char* oldname, void* user),
uint32_t flags, void* user_data) uint32_t flags, void* user_data, dmon_error *error_code)
{ {
DMON_ASSERT(watch_cb); DMON_ASSERT(watch_cb);
DMON_ASSERT(rootdir && rootdir[0]); DMON_ASSERT(rootdir && rootdir[0]);
@ -1118,7 +1133,7 @@ DMON_API_IMPL dmon_watch_id dmon_watch(const char* rootdir,
struct stat root_st; struct stat root_st;
if (stat(rootdir, &root_st) != 0 || !S_ISDIR(root_st.st_mode) || if (stat(rootdir, &root_st) != 0 || !S_ISDIR(root_st.st_mode) ||
(root_st.st_mode & S_IRUSR) != S_IRUSR) { (root_st.st_mode & S_IRUSR) != S_IRUSR) {
_DMON_LOG_ERRORF("Could not open/read directory: %s", rootdir); *error_code = DMON_ERROR_OPEN_DIR;
pthread_mutex_unlock(&_dmon.mutex); pthread_mutex_unlock(&_dmon.mutex);
return dmon__make_id(0); return dmon__make_id(0);
} }
@ -1133,8 +1148,7 @@ DMON_API_IMPL dmon_watch_id dmon_watch(const char* rootdir,
dmon__strcpy(watch->rootdir, sizeof(watch->rootdir) - 1, linkpath); dmon__strcpy(watch->rootdir, sizeof(watch->rootdir) - 1, linkpath);
} else { } else {
_DMON_LOG_ERRORF("symlinks are unsupported: %s. use DMON_WATCHFLAGS_FOLLOW_SYMLINKS", *error_code = DMON_ERROR_UNSUPPORTED_SYMLINK;
rootdir);
pthread_mutex_unlock(&_dmon.mutex); pthread_mutex_unlock(&_dmon.mutex);
return dmon__make_id(0); return dmon__make_id(0);
} }
@ -1151,7 +1165,7 @@ DMON_API_IMPL dmon_watch_id dmon_watch(const char* rootdir,
watch->fd = inotify_init(); watch->fd = inotify_init();
if (watch->fd < -1) { if (watch->fd < -1) {
DMON_LOG_ERROR("could not create inotify instance"); *error_code = DMON_ERROR_MONITOR_FAIL;
pthread_mutex_unlock(&_dmon.mutex); pthread_mutex_unlock(&_dmon.mutex);
return dmon__make_id(0); return dmon__make_id(0);
} }
@ -1159,7 +1173,7 @@ DMON_API_IMPL dmon_watch_id dmon_watch(const char* rootdir,
uint32_t inotify_mask = IN_MOVED_TO | IN_CREATE | IN_MOVED_FROM | IN_DELETE | IN_MODIFY; uint32_t inotify_mask = IN_MOVED_TO | IN_CREATE | IN_MOVED_FROM | IN_DELETE | IN_MODIFY;
int wd = inotify_add_watch(watch->fd, watch->rootdir, inotify_mask); int wd = inotify_add_watch(watch->fd, watch->rootdir, inotify_mask);
if (wd < 0) { if (wd < 0) {
_DMON_LOG_ERRORF("Error watching directory '%s'. (inotify_add_watch:err=%d)", watch->rootdir, errno); *error_code = DMON_ERROR_WATCH_DIR;
pthread_mutex_unlock(&_dmon.mutex); pthread_mutex_unlock(&_dmon.mutex);
return dmon__make_id(0); return dmon__make_id(0);
} }
@ -1491,7 +1505,7 @@ DMON_API_IMPL dmon_watch_id dmon_watch(const char* rootdir,
void (*watch_cb)(dmon_watch_id watch_id, dmon_action action, void (*watch_cb)(dmon_watch_id watch_id, dmon_action action,
const char* dirname, const char* filename, const char* dirname, const char* filename,
const char* oldname, void* user), const char* oldname, void* user),
uint32_t flags, void* user_data) uint32_t flags, void* user_data, dmon_error *error_code)
{ {
DMON_ASSERT(watch_cb); DMON_ASSERT(watch_cb);
DMON_ASSERT(rootdir && rootdir[0]); DMON_ASSERT(rootdir && rootdir[0]);
@ -1511,7 +1525,7 @@ DMON_API_IMPL dmon_watch_id dmon_watch(const char* rootdir,
struct stat root_st; struct stat root_st;
if (stat(rootdir, &root_st) != 0 || !S_ISDIR(root_st.st_mode) || if (stat(rootdir, &root_st) != 0 || !S_ISDIR(root_st.st_mode) ||
(root_st.st_mode & S_IRUSR) != S_IRUSR) { (root_st.st_mode & S_IRUSR) != S_IRUSR) {
_DMON_LOG_ERRORF("Could not open/read directory: %s", rootdir); *error_code = DMON_ERROR_OPEN_DIR;
pthread_mutex_unlock(&_dmon.mutex); pthread_mutex_unlock(&_dmon.mutex);
__sync_lock_test_and_set(&_dmon.modify_watches, 0); __sync_lock_test_and_set(&_dmon.modify_watches, 0);
return dmon__make_id(0); return dmon__make_id(0);
@ -1526,7 +1540,7 @@ DMON_API_IMPL dmon_watch_id dmon_watch(const char* rootdir,
dmon__strcpy(watch->rootdir, sizeof(watch->rootdir) - 1, linkpath); dmon__strcpy(watch->rootdir, sizeof(watch->rootdir) - 1, linkpath);
} else { } else {
_DMON_LOG_ERRORF("symlinks are unsupported: %s. use DMON_WATCHFLAGS_FOLLOW_SYMLINKS", rootdir); *error_code = DMON_ERROR_UNSUPPORTED_SYMLINK;
pthread_mutex_unlock(&_dmon.mutex); pthread_mutex_unlock(&_dmon.mutex);
__sync_lock_test_and_set(&_dmon.modify_watches, 0); __sync_lock_test_and_set(&_dmon.modify_watches, 0);
return dmon__make_id(0); return dmon__make_id(0);

2
lib/dmon/dmon_extra.h
View File

@ -52,6 +52,8 @@ DMON_API_IMPL bool dmon_watch_add(dmon_watch_id id, const char* watchdir)
// else, we assume that watchdir is correct, so save it as it is // else, we assume that watchdir is correct, so save it as it is
struct stat st; struct stat st;
dmon__watch_subdir subdir; dmon__watch_subdir subdir;
// FIXME: check if it is a symlink and respect DMON_WATCHFLAGS_FOLLOW_SYMLINKS
// to resolve the link.
if (stat(watchdir, &st) == 0 && (st.st_mode & S_IFDIR)) { if (stat(watchdir, &st) == 0 && (st.st_mode & S_IFDIR)) {
dmon__strcpy(subdir.rootdir, sizeof(subdir.rootdir), watchdir); dmon__strcpy(subdir.rootdir, sizeof(subdir.rootdir), watchdir);
if (strstr(subdir.rootdir, watch->rootdir) == subdir.rootdir) { if (strstr(subdir.rootdir, watch->rootdir) == subdir.rootdir) {

13
src/api/system.c
View File

@ -724,12 +724,19 @@ static int f_watch_dir(lua_State *L) {
* using the function system.watch_dir_add/rm. On other systems we watch recursively * using the function system.watch_dir_add/rm. On other systems we watch recursively
* and system.watch_dir_add/rm are dummy functions that always returns true. */ * and system.watch_dir_add/rm are dummy functions that always returns true. */
#if __linux__ #if __linux__
const uint32_t dmon_flags = 0; const uint32_t dmon_flags = DMON_WATCHFLAGS_FOLLOW_SYMLINKS;
#elif __APPLE__
const uint32_t dmon_flags = DMON_WATCHFLAGS_FOLLOW_SYMLINKS | DMON_WATCHFLAGS_RECURSIVE;
#else #else
const uint32_t dmon_flags = DMON_WATCHFLAGS_RECURSIVE; const uint32_t dmon_flags = DMON_WATCHFLAGS_RECURSIVE;
#endif #endif
dmon_watch_id watch_id = dmon_watch(path, dirmonitor_watch_callback, dmon_flags, NULL); dmon_error error;
if (watch_id.id == 0) { luaL_error(L, "directory monitoring watch failed"); } dmon_watch_id watch_id = dmon_watch(path, dirmonitor_watch_callback, dmon_flags, NULL, &error);
if (watch_id.id == 0) {
lua_pushnil(L);
lua_pushstring(L, dmon_error_str(error));
return 2;
}
lua_pushnumber(L, watch_id.id); lua_pushnumber(L, watch_id.id);
return 1; return 1;
} }