diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bfb4876..918017d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,40 +1,38 @@ -name: ci +name: CI on: - - pull_request - - push + push: + pull_request: jobs: Test: - if: "!contains(github.event.head_commit.message, '[skip ci]')" + name: "Test" runs-on: ${{ matrix.os }} strategy: fail-fast: false matrix: os: - ubuntu-latest - # - macos-latest + - macos-latest - windows-latest node_version: - - 10 - - 12 # - 14 + # - 18 + - 20 steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 + with: + submodules: true - - name: Install Node - uses: actions/setup-node@v1 + - name: Install Node ${{ matrix.node }} + uses: actions/setup-node@v4 with: node-version: ${{ matrix.node_version }} - name: Install dependencies run: npm install - - name: Run tests - run: npm run test + - name: Run context safety test + run: npm run test-context-safety - Skip: - if: contains(github.event.head_commit.message, '[skip ci]') - runs-on: ubuntu-latest - steps: - - name: Skip CI đŸš« - run: echo skip ci + - name: Run tests + run: npm test diff --git a/.gitignore b/.gitignore index 79c895b..6b3934f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,11 @@ +.DS_Store *.swp build/ node_modules/ -lib/ .node-version +.tool-versions npm-debug.log api.json package-lock.json +.cache/ +compile_commands.json diff --git a/.npmignore b/.npmignore index 2503ddf..24a4f71 100644 --- a/.npmignore +++ b/.npmignore @@ -1,8 +1,6 @@ build/ spec/ -script/ -*.coffee +scripts/ .npmignore -.travis.yml .node-version npm-debug.log diff --git a/Gruntfile.coffee b/Gruntfile.coffee deleted file mode 100644 index ed9c3a1..0000000 --- a/Gruntfile.coffee +++ /dev/null @@ -1,77 +0,0 @@ -module.exports = (grunt) -> - grunt.initConfig - pkg: grunt.file.readJSON('package.json') - - coffee: - glob_to_multiple: - expand: true - cwd: 'src' - src: ['*.coffee'] - dest: 'lib' - ext: '.js' - - coffeelint: - options: - no_empty_param_list: - level: 'error' - max_line_length: - level: 'ignore' - - src: ['src/**/*.coffee'] - test: ['spec/**/*.coffee'] - gruntfile: ['Gruntfile.coffee'] - - cpplint: - files: ['src/**/*.cc'] - reporter: 'spec' - verbosity: 1 - filters: - build: - include: false - legal: - copyright: false - readability: - braces: false - runtime: - references: false - sizeof: false - whitespace: - line_length: false - - shell: - rebuild: - command: 'npm build .' - options: - stdout: true - stderr: true - failOnError: true - - test: - command: 'node node_modules/jasmine-tagged/bin/jasmine-tagged --captureExceptions --coffee spec/' - options: - stdout: true - stderr: true - failOnError: true - - 'update-atomdoc': - command: 'npm update grunt-atomdoc' - options: - stdout: true - stderr: true - failOnError: true - - grunt.loadNpmTasks('grunt-contrib-coffee') - grunt.loadNpmTasks('grunt-shell') - grunt.loadNpmTasks('grunt-coffeelint') - grunt.loadNpmTasks('node-cpplint') - grunt.loadNpmTasks('grunt-atomdoc') - - grunt.registerTask('lint', ['coffeelint', 'cpplint']) - grunt.registerTask('default', ['coffee', 'lint', 'shell:rebuild']) - grunt.registerTask('test', ['default', 'shell:test']) - grunt.registerTask('prepublish', ['coffee', 'lint', 'shell:update-atomdoc', 'atomdoc']) - grunt.registerTask 'clean', -> - rm = require('rimraf').sync - rm 'build' - rm 'lib' - rm 'api.json' diff --git a/README.md b/README.md index 7efdbd0..457fe2e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ -# Path Watcher Node module -![ci](https://github.com/atom/node-pathwatcher/workflows/ci/badge.svg) -[![Depenency Status](https://david-dm.org/atom/node-pathwatcher/status.svg)](https://david-dm.org/atom/node-pathwatcher) +# node-pathwatcher + +Watch files and directories for changes. + + +> [!IMPORTANT] +> This library is used in [Pulsar][] in several places for compatibility reasons. The [nsfw](https://www.npmjs.com/package/nsfw) library is more robust and more widely used; it is available in Pulsar via `atom.watchPath` and is usually a better choice. +> +> If you’re here because you want a general-purpose file-watching library for Node, use `nsfw` instead. +> +> The purpose of this library’s continued inclusion in Pulsar is to provide the [File][] and [Directory][] classes that have long been available as exports via `require('atom')`. ## Installing @@ -10,30 +18,64 @@ npm install pathwatcher ## Building - * Clone the repository - * Run `npm install` to install the dependencies - * Run `npm test` to run the specs +* Clone the repository +* `git submodule init && git submodule update` +* Run `npm install` to install the dependencies +* Run `npm test` to run the specs + +## Caveats + +This module is context-aware and context-safe; it can be used from multiple worker threads in the same process. If you keep a file-watcher active, though, it’ll keep the environment from closing; you must stop all watchers if you want your script or thread to finish. + +If you’re using it in an Electron renderer process, you must take extra care in page reloading scenarios. Be sure to use `closeAllWatchers` well before the page environment is terminated — e.g., by attaching a `beforeunload` listener. ## Using -```coffeescript -PathWatcher = require 'pathwatcher' +```js +const PathWatcher = require('pathwatcher'); ``` -### PathWatcher.watch(filename, [listener]) +### `watch(filename, listener)` + +Watch for changes on `filename`, where `filename` is either a file or a directory. `filename` must be an absolute path and must exist at the time `watch` is called. + +The listener callback gets two arguments: `(event, path)`. `event` can be `rename`, `delete` or `change`, and `path` is the path of the file which triggered the event. -Watch for changes on `filename`, where `filename` is either a file or a -directory. The returned object is a `PathWatcher`. +The watcher is not recursive; changes to the contents of subdirectories will not be detected. -The listener callback gets two arguments `(event, path)`. `event` can be `rename`, -`delete` or `change`, and `path` is the path of the file which triggered the -event. +Returns an instance of `PathWatcher`. This instance is useful primarily for the `close` method that stops the watch operation. -For directories, the `change` event is emitted when a file or directory under -the watched directory got created or deleted. And the `PathWatcher.watch` is -not recursive, so changes of subdirectories under the watched directory would -not be detected. +#### Caveats -### PathWatcher.close() +* Watching a specific file or directory will not notify you when that file or directory is created, since the file must already exist before you start watching the path. +* When watching a file, `event` can be any of `rename`, `delete`, or `change`, where `change` means that the file’s contents changed somehow. +* When watching a directory, `event` can only be `change`, and in this context `change` signifies that one or more of the directory’s children changed (by being renamed, deleted, added, or modified). +* A watched directory will not report when it is renamed or deleted. If you want to detect when a given directory is deleted, watch its parent directory and test for the child directory’s existence when you receive a `change` event. + +### `PathWatcher::close()` Stop watching for changes on the given `PathWatcher`. + +### `closeAllWatchers()` + +Stop watching on all subscribed paths. All existing `PathWatcher` instances will stop receiving events. Call this if you’re going to end the process; it ensures that your script will exit cleanly. + +### `getWatchedPaths()` + +Returns an array of strings representing the actual paths that are being watched on disk. + +`pathwatcher` watches directories in all instances, since it’s easy to do so in a cross-platform manner. + +### `File` and `Directory` + +These are convenience wrappers around some filesystem operations. They also wrap `PathWatcher.watch` via their `onDidChange` (and similar) methods. + +Documentation can be found on the Pulsar documentation site: + +* [File][] +* [Directory][] + + +[File]: https://docs.pulsar-edit.dev/api/pulsar/latest/File/ +[Directory]: https://docs.pulsar-edit.dev/api/pulsar/latest/Directory/ +[Pulsar]: https://pulsar-edit.dev diff --git a/appveyor.yml b/appveyor.yml deleted file mode 100644 index 63206ce..0000000 --- a/appveyor.yml +++ /dev/null @@ -1,6 +0,0 @@ -# dummy appveyor -build: off - -branches: - only: - - non-existing diff --git a/binding.gyp b/binding.gyp index 9bf2936..1fe7ebd 100644 --- a/binding.gyp +++ b/binding.gyp @@ -1,27 +1,133 @@ { "targets": [ { - "target_name": "pathwatcher", + "target_name": "efsw", + "type": "static_library", "sources": [ - "src/main.cc", - "src/common.cc", - "src/common.h", - "src/handle_map.cc", - "src/handle_map.h", - "src/unsafe_persistent.h", + "./vendor/efsw/src/efsw/Debug.cpp", + "./vendor/efsw/src/efsw/DirWatcherGeneric.cpp", + "./vendor/efsw/src/efsw/DirectorySnapshot.cpp", + "./vendor/efsw/src/efsw/DirectorySnapshotDiff.cpp", + "./vendor/efsw/src/efsw/FileInfo.cpp", + "./vendor/efsw/src/efsw/FileSystem.cpp", + "./vendor/efsw/src/efsw/FileWatcher.cpp", + "./vendor/efsw/src/efsw/FileWatcherCWrapper.cpp", + "./vendor/efsw/src/efsw/FileWatcherFSEvents.cpp", + "./vendor/efsw/src/efsw/FileWatcherGeneric.cpp", + "./vendor/efsw/src/efsw/FileWatcherImpl.cpp", + "./vendor/efsw/src/efsw/FileWatcherInotify.cpp", + "./vendor/efsw/src/efsw/FileWatcherKqueue.cpp", + "./vendor/efsw/src/efsw/FileWatcherWin32.cpp", + "./vendor/efsw/src/efsw/Log.cpp", + "./vendor/efsw/src/efsw/Mutex.cpp", + "./vendor/efsw/src/efsw/String.cpp", + "./vendor/efsw/src/efsw/System.cpp", + "./vendor/efsw/src/efsw/Thread.cpp", + "./vendor/efsw/src/efsw/Watcher.cpp", + "./vendor/efsw/src/efsw/WatcherFSEvents.cpp", + "./vendor/efsw/src/efsw/WatcherGeneric.cpp", + "./vendor/efsw/src/efsw/WatcherInotify.cpp", + "./vendor/efsw/src/efsw/WatcherKqueue.cpp", + "./vendor/efsw/src/efsw/WatcherWin32.cpp" ], "include_dirs": [ - "src", - ' +#include + +#ifdef DEBUG +#include +#endif + +#ifdef __APPLE__ +#include +#endif + +#ifdef _WIN32 +// Stub out this function on Windows. For now we don't have a need to compare +// watcher start times to file creation/modification times, so this isn't +// necessary. (Likewise, we're careful to conceal `PredatesWatchStart` calls +// behind `#ifdef`s, so we don’t need to define it at all.) +static int Now() { return 0; } +#else + +// Returns the current Unix timestamp. +static timeval Now() { + struct timeval tv; + gettimeofday(&tv, nullptr); + return tv; +} + +// Given a Unix timestamp and a file `timespec`, decides whether the file’s +// timestamp predates the Unix timestamp. Used to compare creation/modification +// times to arbitrary points in time. +static bool PredatesWatchStart(struct timespec fileSpec, timeval startTime) { + bool fileEventOlder = fileSpec.tv_sec < startTime.tv_sec || ( + (fileSpec.tv_sec == startTime.tv_sec) && + ((fileSpec.tv_nsec / 1000) < startTime.tv_usec) + ); + return fileEventOlder; +} +#endif + +static Napi::BigInt WatcherHandleToBigInt(Napi::Env env, efsw::WatchID handle) { + int64_t handleAsInt64 = static_cast(handle); + return Napi::BigInt::New(env, handleAsInt64); +} + +static efsw::WatchID BigIntToWatcherHandle(Napi::BigInt value) { + // JavaScript `BigInt`s can be arbitrarily large, so they may not fit inside + // a `long` or `int64_t`. But if this value needs truncation, something shady + // is going on, since that value certainly didn't come from us. We conform to + // the API here, but we don't need to check whether the value was truncated. + bool lossless = false; + efsw::WatchID handle = value.Int64Value(&lossless); + return handle; +} + +static std::string EventType(efsw::Action action, bool isChild) { + switch (action) { + case efsw::Actions::Add: + return isChild ? "child-create" : "create"; + case efsw::Actions::Delete: + return isChild ? "child-delete" : "delete"; + case efsw::Actions::Modified: + return isChild ? "child-change" : "change"; + case efsw::Actions::Moved: + return isChild ? "child-rename" : "rename"; + default: + return "unknown"; + } +} + +// This is a bit hacky, but it allows us to stop invoking callbacks more +// quickly when the environment is terminating. +static bool EnvIsStopping(Napi::Env env) { + PathWatcher* pw = env.GetInstanceData(); + return pw->isStopping; +} + +// Ensure a given path has a trailing separator for comparison purposes. +static std::string NormalizePath(std::string path) { + if (path.back() == PATH_SEPARATOR) return path; + return path + PATH_SEPARATOR; +} + +static void StripTrailingSlashFromPath(std::string& path) { + if (path.empty() || (path.back() != '/')) return; + path.pop_back(); +} + +static bool PathsAreEqual(std::string pathA, std::string pathB) { + return NormalizePath(pathA) == NormalizePath(pathB); +} + +// This is the main-thread function that receives all `ThreadSafeFunction` +// calls. It converts the `PathWatcherEvent` struct into JS values before +// invoking our callback. +static void ProcessEvent( + Napi::Env env, + Napi::Function callback, + PathWatcherEvent* event +) { + // Translate the event type to the expected event name in the JS code. + // + // NOTE: This library previously envisioned that some platforms would allow + // watching of files directly and some would require watching of a file's + // parent folder. EFSW uses the parent-folder approach on all platforms, so + // in practice we're not using half of the event names we used to use. That's + // why the second argument below is `true`. + // + // There might be some edge cases that we need to handle here; for instance, + // if we're watching a directory and that directory itself is deleted, then + // that should be `delete` rather than `child-delete`. Right now we deal with + // that in JavaScript, but we could handle it here instead. + if (EnvIsStopping(env)) return; + + std::string newPath; + std::string oldPath; + + if (!event->new_path.empty()) { + newPath.assign(event->new_path.begin(), event->new_path.end()); + } + + if (!event->old_path.empty()) { + oldPath.assign(event->old_path.begin(), event->old_path.end()); + } + + // Since we watch directories, most sorts of events will only happen to files + // within the directories
 + bool isChildEvent = true; + if (PathsAreEqual(newPath, event->watcher_path)) { + // 
but the `delete` event can happen to the directory itself, in which + // case we should report it as `delete` rather than `child-delete`. + isChildEvent = false; + } + + std::string eventName = EventType(event->type, isChildEvent); + + try { + callback.Call({ + Napi::String::New(env, eventName), + WatcherHandleToBigInt(env, event->handle), + Napi::String::New(env, newPath), + Napi::String::New(env, oldPath) + }); + } catch (const Napi::Error& e) { + // TODO: Unsure why this would happen. + Napi::TypeError::New(env, "Unknown error handling filesystem event").ThrowAsJavaScriptException(); + } +} + +PathWatcherListener::PathWatcherListener( + Napi::Env env, + Napi::ThreadSafeFunction tsfn +): tsfn(tsfn) {} + +void PathWatcherListener::Stop() { + if (isShuttingDown) return; + // Prevent responders from acting while we shut down. + std::lock_guard lock(shutdownMutex); + if (isShuttingDown) return; + isShuttingDown = true; +} + +void PathWatcherListener::Stop(FileWatcher* fileWatcher) { + for (auto& it : paths) { + fileWatcher->removeWatch(it.first); + } + paths.clear(); + Stop(); +} + +// Correlate a watch ID to a path/timestamp pair. +void PathWatcherListener::AddPath(PathTimestampPair pair, efsw::WatchID handle) { + std::lock_guard lock(pathsMutex); + paths[handle] = pair; + pathsToHandles[pair.path] = handle; +} + +// Remove metadata for a given watch ID. +void PathWatcherListener::RemovePath(efsw::WatchID handle) { + std::string path; + if (isShuttingDown) return; + { + std::lock_guard lock(pathsMutex); + auto it = paths.find(handle); +#ifdef DEBUG + std::cout << "Unwatching handle: [" << handle << "] path: [" << it->second.path << "]" << std::endl; +#endif + + if (it == paths.end()) return; + path = it->second.path; + paths.erase(it); + } + + { + std::lock_guard lock(pathsToHandlesMutex); + auto itp = pathsToHandles.find(path); + if (itp == pathsToHandles.end()) return; + pathsToHandles.erase(itp); + } +} + +bool PathWatcherListener::HasPath(std::string path) { + std::lock_guard lock(pathsToHandlesMutex); + auto it = pathsToHandles.find(path); + return it != pathsToHandles.end(); +} + +efsw::WatchID PathWatcherListener::GetHandleForPath(std::string path) { + std::lock_guard lock(pathsToHandlesMutex); + auto it = pathsToHandles.find(path); + return it->second; +} + +bool PathWatcherListener::IsEmpty() { + std::lock_guard lock(pathsMutex); + return paths.empty(); +} + +void PathWatcherListener::handleFileAction( + efsw::WatchID watchId, + const std::string& dir, + const std::string& filename, + efsw::Action action, + std::string oldFilename +) { +#ifdef DEBUG + std::cout << "PathWatcherListener::handleFileAction dir: " << dir << " filename: " << filename << " action: " << EventType(action, true) << std::endl; +#endif + // Don't try to proceed if we've already started the shutdown process
 + if (isShuttingDown) return; + + // 
but if we haven't, make sure that shutdown doesn’t happen until we’re + // done. + std::lock_guard lock(shutdownMutex); + if (isShuttingDown) return; + + // Extract the expected watcher path and (on macOS) the start time of the + // watcher. + PathTimestampPair pair; + std::string realPath; +#ifdef __APPLE__ + timeval startTime; +#endif + { + std::lock_guard lock(pathsMutex); + auto it = paths.find(watchId); + if (it == paths.end()) { + // Couldn't find watcher. Assume it's been removed. + return; + } + pair = it->second; + realPath = pair.path; +#ifdef __APPLE__ + startTime = pair.timestamp; +#endif + } + + std::string newPathStr = dir + filename; + std::vector newPath(newPathStr.begin(), newPathStr.end()); + +#ifdef __APPLE__ + // macOS seems to think that lots of file creations happen that aren't + // actually creations; for instance, multiple successive writes to the same + // file will sometimes nonsensically produce a `child-create` event preceding + // each `child-change` event. + // + // Luckily, we can easily check whether or not a file has actually been + // created on macOS: we can compare creation time to modification time. This + // weeds out most of the false positives. + { + struct stat file; + if (stat(newPathStr.c_str(), &file) != 0 && action != efsw::Action::Delete) { + // If this was a delete action, the file is _expected_ not to exist + // anymore. Otherwise it's a strange outcome and it means we should + // ignore this event. + return; + } + + if (action == efsw::Action::Add) { + // One easy way to check if a file was truly just created: does its + // creation time match its modification time? If not, the file has been + // written to since its creation. + if (file.st_birthtimespec.tv_sec != file.st_mtimespec.tv_sec) { + return; + } + + // Next, weed out unnecessary `create` and `change` events that represent + // file actions that happened before we started watching. + if (PredatesWatchStart(file.st_birthtimespec, startTime)) { +#ifdef DEBUG + std::cout << "File was created before we started this path watcher! (skipping)" << std::endl; +#endif + return; + } + } else if (action == efsw::Action::Modified) { + if (PredatesWatchStart(file.st_mtimespec, startTime)) { +#ifdef DEBUG + std::cout << "File was modified before we started this path watcher! (skipping)" << std::endl; +#endif + return; + } + } + } +#endif + + std::vector oldPath; + if (!oldFilename.empty()) { + std::string oldPathStr = dir + oldFilename; + oldPath.assign(oldPathStr.begin(), oldPathStr.end()); + } + + if (!tsfn) return; + napi_status status = tsfn.Acquire(); + if (status != napi_ok) { + // We couldn't acquire the `tsfn`; it might be in the process of being + // aborted because our environment is terminating. + return; + } + + PathWatcherEvent* event = new PathWatcherEvent(action, watchId, newPath, oldPath, realPath); + + // TODO: Instead of calling `BlockingCall` once per event, throttle them by + // some small amount of time (like 50-100ms). That will allow us to deliver + // them in batches more efficiently — and for the wrapper JavaScript code to + // do some elimination of redundant events. + status = tsfn.BlockingCall(event, ProcessEvent); + + tsfn.Release(); + if (status != napi_ok) { + // TODO: Not sure how this could fail, or how we should present it to the + // user if it does fail. This action runs on a separate thread and it's not + // immediately clear how we'd surface an exception from here. + delete event; + } +} + +static int next_env_id = 1; + +PathWatcher::PathWatcher(Napi::Env env, Napi::Object exports) { + envId = next_env_id++; + +#ifdef DEBUG + std::cout << "Initializing PathWatcher" << std::endl; +#endif + + DefineAddon(exports, { + InstanceMethod("watch", &PathWatcher::Watch), + InstanceMethod("unwatch", &PathWatcher::Unwatch), + InstanceMethod("setCallback", &PathWatcher::SetCallback) + }); + + env.SetInstanceData(this); +} + +PathWatcher::~PathWatcher() { + isFinalizing = true; + StopAllListeners(); +} + +// Watch a given path. Returns a handle. +Napi::Value PathWatcher::Watch(const Napi::CallbackInfo& info) { + auto env = info.Env(); + // Record the current timestamp as early as possible. We'll use this as a way + // of ignoring file-watcher events that happened before we started watching. + auto now = Now(); + + // First argument must be a string. + if (!info[0].IsString()) { + Napi::TypeError::New(env, "String required").ThrowAsJavaScriptException(); + return env.Null(); + } + + // Second argument is optional and tells us whether to use a recursive + // watcher. Defaults to `false`. + bool useRecursiveWatcher = false; + if (info[1].IsBoolean()) { + auto recursiveOption = info[1].As(); + useRecursiveWatcher = recursiveOption; + } + + // The wrapper JS will resolve this to the file's real path. We expect to be + // dealing with real locations on disk, since that's what EFSW will report to + // us anyway. + Napi::String path = info[0].ToString(); + std::string cppPath(path); + + StripTrailingSlashFromPath(cppPath); + +#ifdef DEBUG + std::cout << "PathWatcher::Watch path: [" << cppPath << "]" << std::endl; +#endif + + // It's invalid to call `watch` before having set a callback via + // `setCallback`. + if (callback.IsEmpty()) { + Napi::TypeError::New(env, "No callback set").ThrowAsJavaScriptException(); + return env.Null(); + } + + if (!isWatching) { +#ifdef DEBUG + std::cout << " Creating ThreadSafeFunction and FileWatcher" << std::endl; +#endif + tsfn = Napi::ThreadSafeFunction::New( + env, + callback.Value(), + "pathwatcher-efsw-listener", + 0, + 1, + [this](Napi::Env env) { + // This is unexpected. We should try to do some cleanup before the + // environment terminates. + StopAllListeners(); + } + ); + + listener = new PathWatcherListener(env, tsfn); + +#ifdef __APPLE__ + fileWatcher = new FSEventsFileWatcher(); +#else + fileWatcher = new efsw::FileWatcher(); + fileWatcher->followSymlinks(true); + fileWatcher->watch(); +#endif + + isWatching = true; + } + + + // EFSW represents watchers as unsigned `int`s; we can easily convert these + // to JavaScript. + WatcherHandle handle = fileWatcher->addWatch(cppPath, listener, useRecursiveWatcher); + +#ifdef DEBUG + std::cout << " handle: [" << handle << "]" << std::endl; +#endif + + if (handle >= 0) { + // For each new watched path, remember both the normalized path and the + // time we started watching it. + PathTimestampPair pair = { cppPath, now }; + listener->AddPath(pair, handle); + } else { + auto error = Napi::Error::New(env, "Failed to add watch; unknown error"); + error.Set("code", Napi::Number::New(env, handle)); + error.ThrowAsJavaScriptException(); + return env.Null(); + } + + // The `watch` function returns a number much like `setTimeout` or + // `setInterval` would; this is the handle that the wrapper JavaScript can + // use to unwatch the path later. + // + // But EFSW defines a WatchID as a `long`, which means it's 64-bits and + // therefore possibly larger than the JS `Number` type can handle. We'll use + // `BigInt`s instead because we live in the future. + return WatcherHandleToBigInt(env, handle); +} + +// Unwatch the given handle. +Napi::Value PathWatcher::Unwatch(const Napi::CallbackInfo& info) { + auto env = info.Env(); + + if (!isWatching) { + // We're not listening right now, so this is redundant at best and invalid + // at worst. Return early so we don't try to use resources that have + // already been finalized. + return env.Undefined(); + } + + if (!info[0].IsBigInt()) { + Napi::TypeError::New(env, "Argument must be a BigInt").ThrowAsJavaScriptException(); + return env.Null(); + } + + if (!listener) return env.Undefined(); + + efsw::WatchID handle = BigIntToWatcherHandle(info[0].As()); + + // EFSW doesn’t mind if we give it a handle that it doesn’t recognize; it’ll + // just silently do nothing. + // + // This is useful because removing watcher can innocuously error anyway on + // certain platforms. For instance, Linux will automatically stop watching a + // directory when it gets deleted, and will then complain when you try to + // stop the watcher that was already stopped. This shows up in debug logging + // but is otherwise safe to ignore. + fileWatcher->removeWatch(handle); + listener->RemovePath(handle); + + if (listener->IsEmpty()) { + Cleanup(env); + isWatching = false; + } + + return env.Undefined(); +} + +void PathWatcher::StopAllListeners() { + // This function is called internally in situations where we detect that the + // environment is terminating. At that point, it's not safe to try to release + // any `ThreadSafeFunction`s; but we can do the rest of the cleanup work + // here. + if (!isWatching) return; + if (!listener) return; + listener->Stop(fileWatcher); + + delete fileWatcher; + isWatching = false; +} + +// Set the JavaScript callback that will be invoked whenever a file changes. +// +// The user-facing API allows for an arbitrary number of different callbacks; +// this is an internal API for the wrapping JavaScript to use. That internal +// callback can multiplex to however many other callbacks need to be invoked. +void PathWatcher::SetCallback(const Napi::CallbackInfo& info) { + auto env = info.Env(); + if (!info[0].IsFunction()) { + Napi::TypeError::New(env, "Function required").ThrowAsJavaScriptException(); + } + + Napi::Function fn = info[0].As(); + callback.Reset(); + callback = Napi::Persistent(fn); +} + +void PathWatcher::Cleanup(Napi::Env env) { + StopAllListeners(); + + if (!isFinalizing) { + // `ThreadSafeFunction` wraps an internal `napi_threadsafe_function` that, + // in some occasional scenarios, might already be `null` by the time we get + // this far. It's not entirely understood why. But if that's true, we can + // skip this part instead of trying to abort a function that doesn't exist + // and causing a segfault. + napi_threadsafe_function _tsfn = tsfn; + if (_tsfn == nullptr) { + return; + } + // The `ThreadSafeFunction` is the thing that will keep the environment + // from terminating if we keep it open. When there are no active watchers, + // we should release `tsfn`; when we add a new watcher thereafter, we can + // create a new `tsfn`. + tsfn.Abort(); + } +} + +NODE_API_ADDON(PathWatcher) diff --git a/lib/core.h b/lib/core.h new file mode 100644 index 0000000..e373787 --- /dev/null +++ b/lib/core.h @@ -0,0 +1,153 @@ +#pragma once + +#include +#include +#include +#include +#include +#include "../vendor/efsw/include/efsw/efsw.hpp" + +#ifdef __APPLE__ +#include "./platform/FSEventsFileWatcher.hpp" +#endif + +#ifndef _WIN32 +#include +#endif + +#ifdef _WIN32 +#define PATH_SEPARATOR '\\' +#else +#define PATH_SEPARATOR '/' +#endif + +#ifdef __APPLE__ +typedef FSEventsFileWatcher FileWatcher; +#else +typedef efsw::FileWatcher FileWatcher; +#endif + +typedef efsw::WatchID WatcherHandle; + +#ifdef _WIN32 +struct PathTimestampPair { + std::string path; + int timestamp; +}; +#else +struct PathTimestampPair { + std::string path; + timeval timestamp; +}; +#endif + +struct PathWatcherEvent { + efsw::Action type; + efsw::WatchID handle; + std::vector new_path; + std::vector old_path; + + std::string watcher_path; + + // Default constructor + PathWatcherEvent() = default; + + // Constructor + PathWatcherEvent( + efsw::Action t, + efsw::WatchID h, + const std::vector& np, + const std::vector& op = std::vector(), + const std::string& wp = "" + ) : type(t), handle(h), new_path(np), old_path(op), watcher_path(wp) {} + + // Copy constructor + PathWatcherEvent(const PathWatcherEvent& other) + : type(other.type), handle(other.handle), new_path(other.new_path), old_path(other.old_path), watcher_path(other.watcher_path) {} + + // Copy assignment operator + PathWatcherEvent& operator=(const PathWatcherEvent& other) { + if (this != &other) { + type = other.type; + handle = other.handle; + new_path = other.new_path; + old_path = other.old_path; + watcher_path = other.watcher_path; + } + return *this; + } + + // Move constructor + PathWatcherEvent(PathWatcherEvent&& other) noexcept + : type(other.type), handle(other.handle), + new_path(std::move(other.new_path)), old_path(std::move(other.old_path)), watcher_path(std::move(other.watcher_path)) {} + + // Move assignment operator + PathWatcherEvent& operator=(PathWatcherEvent&& other) noexcept { + if (this != &other) { + type = other.type; + handle = other.handle; + new_path = std::move(other.new_path); + old_path = std::move(other.old_path); + watcher_path = std::move(other.watcher_path); + } + return *this; + } +}; + +class PathWatcherListener: public efsw::FileWatchListener { +public: + PathWatcherListener( + Napi::Env env, + Napi::ThreadSafeFunction tsfn + ); + + void handleFileAction( + efsw::WatchID watchId, + const std::string& dir, + const std::string& filename, + efsw::Action action, + std::string oldFilename + ) override; + + void AddPath(PathTimestampPair pair, efsw::WatchID handle); + void RemovePath(efsw::WatchID handle); + bool HasPath(std::string path); + efsw::WatchID GetHandleForPath(std::string path); + bool IsEmpty(); + void Stop(); + void Stop(FileWatcher* fileWatcher); + +private: + std::atomic isShuttingDown{false}; + std::mutex shutdownMutex; + std::mutex pathsMutex; + std::mutex pathsToHandlesMutex; + Napi::ThreadSafeFunction tsfn; + std::unordered_map paths; + std::unordered_map pathsToHandles; +}; + +class PathWatcher : public Napi::Addon { +public: + PathWatcher(Napi::Env env, Napi::Object exports); + ~PathWatcher(); + + bool isStopping = false; + +private: + Napi::Value Watch(const Napi::CallbackInfo& info); + Napi::Value Unwatch(const Napi::CallbackInfo& info); + void SetCallback(const Napi::CallbackInfo& info); + void Cleanup(Napi::Env env); + void StopAllListeners(); + + int envId; + bool isFinalizing = false; + bool isWatching = false; + Napi::FunctionReference callback; + Napi::ThreadSafeFunction tsfn; + PathWatcherListener* listener; + + FileWatcher* fileWatcher = nullptr; +}; diff --git a/lib/efsw_core.h b/lib/efsw_core.h new file mode 100644 index 0000000..c342c66 --- /dev/null +++ b/lib/efsw_core.h @@ -0,0 +1,42 @@ +/** + * node-efsw - Node.js binding for EFSW + * + * Copyright (c) 2017 XadillaX + * + * MIT License + */ +#ifndef __EFSW_CORE_H__ +#define __EFSW_CORE_H__ +#include +#include +#include "../vendor/efsw/include/efsw/efsw.hpp" +#include "efsw_core_listener.h" + +namespace efsw_core { + +class EFSWCore : public Nan::ObjectWrap { +public: + static NAN_MODULE_INIT(Init); + +private: + explicit EFSWCore(const char* path, Nan::Callback* listener); + ~EFSWCore(); + + efsw::WatchId Start(); + void Stop(); + + static NAN_METHOD(New); + static NAN_METHOD(Start); + static NAN_METHOD(Stop); + +private: + std::string path; + Nan::Callback* listener; + efsw::FileWatcher* watcher; + efsw::WatchId watch_id; + EFSWCoreListener core_listener; +}; + +} + +#endif diff --git a/lib/efsw_core_listener.h b/lib/efsw_core_listener.h new file mode 100644 index 0000000..7ff76f7 --- /dev/null +++ b/lib/efsw_core_listener.h @@ -0,0 +1,41 @@ +/** + * node-efsw - Node.js binding for EFSW + * + * Copyright (c) 2017 XadillaX + * + * MIT License + */ +#ifndef __EFSW_CORE_LISTENER_H__ +#define __EFSW_CORE_LISTENER_H__ +#include +#include +#include "./deps/efsw/include/efsw/efsw.hpp" + +namespace efsw_core { + +#define Watch watch +#define AddWatch addWatch +#define RemoveWatch removeWatch +#define HandleFileAction handleFileAction +#define GetLastErrorLog getLastErrorLog +#define WatchId WatchID + +// class EFSWCoreListener : public efsw::FileWatchListener { +// public: +// EFSWCoreListener(Nan::Callback* listener); +// ~EFSWCoreListener(); +// +// void HandleFileAction( +// efsw::WatchId, +// const std::string& dir, +// const std::string& filename, +// efsw::Action action, +// std::string old_filename = ""); +// +// private: +// Nan::Callback* listener; +// }; +// +// } + +#endif diff --git a/lib/platform/FSEventsFileWatcher.cpp b/lib/platform/FSEventsFileWatcher.cpp new file mode 100644 index 0000000..22e2c0d --- /dev/null +++ b/lib/platform/FSEventsFileWatcher.cpp @@ -0,0 +1,640 @@ +#include "../core.h" +#include +#include "FSEventsFileWatcher.hpp" + +#ifdef DEBUG +#include +#endif + +// This is an API-compatible replacement for `efsw::FileWatcher` on macOS. It +// uses its own implementation of `FSEvents` so it can minimize the number of +// streams created in comparison to `efsw`’s approach of using one stream per +// watched path. + +// NOTE: Lots of these utility functions are duplications and alternate +// versions of functions that are already present in `efsw`. We could use the +// `efsw` versions instead, but it feels like a good idea to minimize the +// amount of cross-pollination here. + +int shorthandFSEventsModified = kFSEventStreamEventFlagItemFinderInfoMod | + kFSEventStreamEventFlagItemModified | + kFSEventStreamEventFlagItemInodeMetaMod; + +// Ensure a given path has a trailing separator for comparison purposes. +static std::string NormalizePath(std::string path) { + if (path.back() == PATH_SEPARATOR) return path; + return path + PATH_SEPARATOR; +} + +static bool PathsAreEqual(std::string pathA, std::string pathB) { + return NormalizePath(pathA) == NormalizePath(pathB); +} + +std::string PrecomposeFileName(const std::string& name) { + CFStringRef cfStringRef = CFStringCreateWithCString( + kCFAllocatorDefault, + name.c_str(), + kCFStringEncodingUTF8 + ); + + CFMutableStringRef cfMutable = CFStringCreateMutableCopy(NULL, 0, cfStringRef); + + CFStringNormalize(cfMutable, kCFStringNormalizationFormC); + + const char* c_str = CFStringGetCStringPtr(cfMutable, kCFStringEncodingUTF8); + + if (c_str != NULL) { + std::string result(c_str); + CFRelease(cfStringRef); + CFRelease(cfMutable); + return result; + } + + CFIndex length = CFStringGetLength(cfMutable); + CFIndex maxSize = CFStringGetMaximumSizeForEncoding(length, kCFStringEncodingUTF8); + if (maxSize == kCFNotFound) { + CFRelease(cfStringRef); + CFRelease(cfMutable); + return std::string(); + } + + std::string result(maxSize + 1, '\0'); + if (CFStringGetCString( + cfMutable, + &result[0], + result.size(), + kCFStringEncodingUTF8 + )) { + result.resize(std::strlen(result.c_str())); + CFRelease(cfStringRef); + CFRelease(cfMutable); + } else { + result.clear(); + } + return result; +} + +// Returns whether `path` currently exists on disk. Does not distiguish between +// files and directories. +bool PathExists(const std::string& path) { + struct stat buffer; + return (stat(path.c_str(), &buffer) == 0); +} + +// Given two paths, determine whether the first descends from (or is equal to) +// the second. +bool PathStartsWith(const std::string& str, const std::string& prefix) { + if (PathsAreEqual(str, prefix)) return true; + if (prefix.length() > str.length()) { + return false; + } + // We ensure `prefix` ends with a path separator so we don't mistakenly think + // that `/foo/barbaz` descends from `/foo/bar`. + auto normalizedPrefix = NormalizePath(prefix); + return str.compare(0, normalizedPrefix.length(), normalizedPrefix) == 0; +} + +// Strips a trailing slash from the path (in place). +void DirRemoveSlashAtEnd (std::string& dir) { + if (dir.size() >= 1 && dir[dir.size() - 1] == PATH_SEPARATOR) { + dir.erase( dir.size() - 1 ); + } +} + +// Given `/foo/bar/baz.txt`, returns `/foo/bar` (or `/foo/bar/`). +// +// Given `/foo/bar/baz`, also returns `/foo/bar` (or `/foo/bar/`). In other +// words: it works like Node’s `path.dirname` and strips the last segment of a +// path. +std::string PathWithoutFileName(std::string filepath, bool keepTrailingSeparator) { + DirRemoveSlashAtEnd(filepath); + + size_t pos = filepath.find_last_of(PATH_SEPARATOR); + if (pos != std::string::npos) { + return filepath.substr(0, keepTrailingSeparator ? pos + 1 : pos); + } + return filepath; +} + +std::string PathWithoutFileName(std::string filepath) { + // Default behavior of `PathWithoutFileName` is to keep the trailing + // separator. + return PathWithoutFileName(filepath, true); +} + +// Given `/foo/bar/baz.txt`, returns `baz.txt`. +// +// Given `/foo/bar/baz`, returns `baz`. +// +// Equivalent to Node’s `path.basename`. +std::string FileNameFromPath(std::string filepath) { + DirRemoveSlashAtEnd(filepath); + + size_t pos = filepath.find_last_of(PATH_SEPARATOR); + + if (pos != std::string::npos) { + return filepath.substr(pos + 1); + } + return filepath; +} + +// Borrowed from `efsw`. Don’t ask me to explain it. +static std::string convertCFStringToStdString( CFStringRef cfString ) { + // Try to get the C string pointer directly. + const char* cStr = CFStringGetCStringPtr(cfString, kCFStringEncodingUTF8); + + if (cStr) { + // If the pointer is valid, directly return a `std::string` from it. + return std::string(cStr); + } else { + // If not, manually convert it. + CFIndex length = CFStringGetLength(cfString); + CFIndex maxSize = CFStringGetMaximumSizeForEncoding( + length, + kCFStringEncodingUTF8 + ) + 1; // +1 for null terminator + + char* buffer = new char[maxSize]; + + if (CFStringGetCString( + cfString, + buffer, + maxSize, + kCFStringEncodingUTF8 + )) { + std::string result(buffer); + delete[] buffer; + return result; + } else { + delete[] buffer; + return ""; + } + } +} + +// Empty constructor. + +FSEventsFileWatcher::~FSEventsFileWatcher() { + pendingDestruction = true; + // Defer cleanup until we can finish processing file events. + std::unique_lock lock(processingMutex); + while (isProcessing) { + processingComplete.wait(lock); + } + + isValid = false; + if (currentEventStream) { + FSEventStreamStop(currentEventStream); + FSEventStreamInvalidate(currentEventStream); + FSEventStreamRelease(currentEventStream); + } +} + +efsw::WatchID FSEventsFileWatcher::addWatch( + const std::string& directory, + efsw::FileWatchListener* listener, + // The `_useRecursion` flag is ignored; it's present for API compatibility. + bool _useRecursion +) { + efsw::WatchID handle = nextHandleID++; + { + std::lock_guard lock(mapMutex); + handlesToPaths[handle] = directory; + pathsToHandles[directory] = handle; + handlesToListeners[handle] = listener; + } + + bool didStart = startNewStream(); + + if (!didStart) { + removeHandle(handle); + // TODO: Debug information? + return -handle; + } + + return handle; +} + +void FSEventsFileWatcher::removeWatch( + efsw::WatchID handle +) { + auto remainingCount = removeHandle(handle); + + if (remainingCount == 0) { + if (currentEventStream) { + FSEventStreamStop(currentEventStream); + FSEventStreamInvalidate(currentEventStream); + FSEventStreamRelease(currentEventStream); + } + currentEventStream = nullptr; + return; + } + + // We don't capture the return value here because it doesn’t affect our + // response. If a new stream fails to start for whatever reason, the old + // stream will still work. And because we've removed the handle from the + // relevant maps, we will silently ignore any filesystem events that happen + // at the given path. + startNewStream(); +} + +void FSEventsFileWatcher::FSEventCallback( + ConstFSEventStreamRef streamRef, + void* userData, + size_t numEvents, + void* eventPaths, + const FSEventStreamEventFlags eventFlags[], + const FSEventStreamEventId eventIds[] +) { + FSEventsFileWatcher* instance = static_cast(userData); + if (!instance->isValid) return; + + std::vector events; + events.reserve(numEvents); + + for (size_t i = 0; i < numEvents; i++) { + CFDictionaryRef pathInfoDict = static_cast( + CFArrayGetValueAtIndex((CFArrayRef) eventPaths, i) + ); + CFStringRef path = static_cast( + CFDictionaryGetValue(pathInfoDict, kFSEventStreamEventExtendedDataPathKey) + ); + CFNumberRef cfInode = static_cast( + CFDictionaryGetValue(pathInfoDict, kFSEventStreamEventExtendedFileIDKey) + ); + + if (cfInode) { + unsigned long inode = 0; + CFNumberGetValue(cfInode, kCFNumberLongType, &inode); + events.push_back( + FSEvent( + convertCFStringToStdString(path), + (long) eventFlags[i], + (uint64_t) eventIds[i], + inode + ) + ); + } + } + + if (!instance->isValid) return; + instance->handleActions(events); + instance->process(); +} + +void FSEventsFileWatcher::sendFileAction( + efsw::WatchID watchid, + const std::string& dir, + const std::string& filename, + efsw::Action action, + std::string oldFilename +) { + efsw::FileWatchListener* listener; + auto it = handlesToListeners.find(watchid); + if (it == handlesToListeners.end()) return; + listener = it->second; + + listener->handleFileAction( + watchid, + PrecomposeFileName(dir), + PrecomposeFileName(filename), + action, + PrecomposeFileName(oldFilename) + ); +} + +struct FileEventMatch { + efsw::WatchID handle; + std::string path; +}; + +void FSEventsFileWatcher::handleActions(std::vector& events) { + size_t esize = events.size(); + + for (size_t i = 0; i < esize; i++) { + FSEvent& event = events[i]; + std::vector matches; + + if (event.flags & ( + kFSEventStreamEventFlagUserDropped | + kFSEventStreamEventFlagKernelDropped | + kFSEventStreamEventFlagEventIdsWrapped | + kFSEventStreamEventFlagHistoryDone | + kFSEventStreamEventFlagMount | + kFSEventStreamEventFlagUnmount | + kFSEventStreamEventFlagRootChanged + )) continue; + + efsw::WatchID handle; + std::string path; + + { + // How do we match up this path change to the watcher that cares about + // it? + // + // Since we do only non-recursive watching, each filesystem event can + // belong to one watcher at most. This vastly simplifies our + // implementation compared to `efsw`’s — since it has to care about the + // possibility of recursive watchers, one file change can correspond to + // arbitrarily many watchers. + // + // For that reason, we can do a simple map lookup. First we try the + // path’s parent directory; if that’s not successful, we try the full + // path. One of these is (for practical purposes) guaranteed to find a + // watcher. + // + // NOTE: `efsw` currently does not detect a directory’s deletion when + // that directory is the one being watched. For consistency, we'll try to + // make this custom `FileWatcher` instance behave the same way. + // + // This works in our favor because it means that there can be only one + // watcher responding to this filesystem event. The only way to find + // lifecycle events on directories themselves — deletions, renames, + // creations — is to listen on the directory’s parent, which neatly + // mirrors the situation with files. + // + std::lock_guard lock(mapMutex); + auto itpth = pathsToHandles.find(PathWithoutFileName(event.path, false)); + if (itpth != pathsToHandles.end()) { + // We have an entry for this paths’s owner directory. We prefer this + // whether the entry itself is a file or a directory (to replicate + // `efsw`’s bug). + path = itpth->first; + handle = itpth->second; + } else { + // Couldn't match this up to a watcher. A bit unusual, but not + // catastrophic. + continue; + } + } + + std::string dirPath(PathWithoutFileName(event.path)); + std::string filePath(FileNameFromPath(event.path)); + + if (event.flags & ( + kFSEventStreamEventFlagItemCreated | + kFSEventStreamEventFlagItemRemoved | + kFSEventStreamEventFlagItemRenamed + )) { + if (!PathsAreEqual(dirPath, path)) { + dirsChanged.insert(dirPath); + } + } + + // `efsw`‘s comment here suggests that you can’t reliably infer order from + // these events — so if the same file is marked as added and changed and + // deleted in consecutive events, you don't know if it was deleted/ + // added/modified, modified/deleted/added, etc. + // + // This is the equivalent logic from `WatcherFSEvents.cpp` because I don’t + // trust myself to touch it at all. The goal is largely to infer an + // ordering to the extent possible based on whether the path exists at the + // moment. + if (event.flags & kFSEventStreamEventFlagItemRenamed) { + // Does the next event also refer to this same file, and is that event + // also a rename? + if ( + (i + 1 < esize) && + (events[i + 1].flags & kFSEventStreamEventFlagItemRenamed) && + (events[i + 1].inode == event.inode) + ) { + // If so, compare this event and the next one to figure out which one + // refers to a current file on disk. + FSEvent& nEvent = events[i + 1]; + std::string newDir(PathWithoutFileName(nEvent.path)); + std::string newFilepath(FileNameFromPath(nEvent.path)); + + if (event.path != nEvent.path) { + if (dirPath == newDir) { + // This is a move within the same directory. + if ( + !PathExists(event.path) || + 0 == strcasecmp(event.path.c_str(), nEvent.path.c_str()) + ) { + // Move from one path to the other. + sendFileAction(handle, dirPath, newFilepath, efsw::Actions::Moved, filePath); + } else { + // Move in the opposite direction. + sendFileAction(handle, dirPath, filePath, efsw::Actions::Moved, newFilepath); + } + } else { + // This is a move from one directory to another, so we'll treat + // it as one deletion and one creation. + sendFileAction(handle, dirPath, filePath, efsw::Actions::Delete); + sendFileAction(handle, newDir, newFilepath, efsw::Actions::Add); + + if (nEvent.flags & shorthandFSEventsModified) { + sendFileAction(handle, dirPath, filePath, efsw::Actions::Modified); + } + } + } else { + // The file paths are the same, so we'll let another function + // untangle it. + handleAddModDel(handle, nEvent.flags, nEvent.path, dirPath, filePath); + } + + if (nEvent.flags & ( + kFSEventStreamEventFlagItemCreated | + kFSEventStreamEventFlagItemRemoved | + kFSEventStreamEventFlagItemRenamed + )) { + if (!PathsAreEqual(newDir, path)) { + dirsChanged.insert(newDir); + } + } + + // Skip the renamed file. + i++; + } else if (PathExists(event.path)) { + // Treat remaining renames as creations when we know the path still + // exists
 + sendFileAction(handle, dirPath, filePath, efsw::Actions::Add); + + if (event.flags & shorthandFSEventsModified) { + sendFileAction(handle, dirPath, filePath, efsw::Actions::Modified); + } + } else { + // 
and as deletions when we know the path doesn’t still exist. + sendFileAction(handle, dirPath, filePath, efsw::Actions::Delete); + } + } else { + // Ordinary business — new files, changed, files, deleted files. + handleAddModDel(handle, event.flags, event.path, dirPath, filePath); + } + } +} + +void FSEventsFileWatcher::handleAddModDel( + efsw::WatchID handle, + const uint32_t& flags, + const std::string& path, + std::string& dirPath, + std::string& filePath +) { + if (flags & kFSEventStreamEventFlagItemCreated) { + // This claims to be a file creation; make sure it exists on disk before + // triggering an event. + if (PathExists(path)) { + sendFileAction(handle, dirPath, filePath, efsw::Actions::Add); + } + } + + if (flags & shorthandFSEventsModified) { + sendFileAction(handle, dirPath, filePath, efsw::Actions::Modified); + } + + if (flags & kFSEventStreamEventFlagItemRemoved) { + // This claims to be a file deletion; make sure it doesn't exist on disk + // before triggering an event. + if (!PathExists(path)) { + sendFileAction(handle, dirPath, filePath, efsw::Actions::Delete); + } + } +} + +// Private: clean up a handle from both unordered maps. +size_t FSEventsFileWatcher::removeHandle(efsw::WatchID handle) { + // If we're destroyed (or about to destroy ourselves), don't try to do + // anything to these maps; the mutex lock will fail. + if (!isValid || pendingDestruction) return 0; + std::lock_guard lock(mapMutex); + std::string path; + auto itp = handlesToPaths.find(handle); + if (itp != handlesToPaths.end()) { + path = itp->second; + handlesToPaths.erase(itp); + } + auto itpth = pathsToHandles.find(path); + if (itpth != pathsToHandles.end()) { + pathsToHandles.erase(itpth); + } + auto itl = handlesToListeners.find(handle); + if (itl != handlesToListeners.end()) { + handlesToListeners.erase(itl); + } + return handlesToPaths.size(); +} + +void FSEventsFileWatcher::process() { + // We are very careful in this function to ensure that `FSEventsFileWatcher` + // doesn’t finalize while this is happening. + if (!isValid || pendingDestruction) return; + { + std::unique_lock lock(processingMutex); + if (isProcessing) return; + isProcessing = true; + } + + ProcessingGuard guard(*this); + + std::set dirsCopy; + { + dirsCopy = dirsChanged; + dirsChanged.clear(); + } + + // Process the copied directories. + for (const auto& dir : dirsCopy) { + if (pendingDestruction) return; + + efsw::WatchID handle; + std::string path; + + { + std::lock_guard lock(mapMutex); + auto itpth = pathsToHandles.find(PathWithoutFileName(dir, false)); + if (itpth == pathsToHandles.end()) continue; + path = itpth->first; + handle = itpth->second; + } + + // TODO: It is questionable whether these file events are useful or + // actionable, since the listener will fail to respond to them if they come + // from an unexpected path on disk. + sendFileAction( + handle, + PathWithoutFileName(dir), + FileNameFromPath(dir), + efsw::Actions::Modified + ); + + if (pendingDestruction) return; + } +} + +// Start a new FSEvent stream and promote it to the “active” stream after it +// starts. +bool FSEventsFileWatcher::startNewStream() { + // Build a list of all current watched paths. We'll eventually pass this to + // `FSEventStreamCreate`. + std::vector cfStrings; + { + std::lock_guard lock(mapMutex); + for (const auto& pair : handlesToPaths) { + CFStringRef cfStr = CFStringCreateWithCString( + kCFAllocatorDefault, + pair.second.c_str(), + kCFStringEncodingUTF8 + ); + if (cfStr) { + cfStrings.push_back(cfStr); + } + } + } + + CFArrayRef paths = CFArrayCreate( + NULL, + reinterpret_cast(cfStrings.data()), + cfStrings.size(), + NULL + ); + + uint32_t streamFlags = kFSEventStreamCreateFlagNone; + + streamFlags = kFSEventStreamCreateFlagFileEvents | + kFSEventStreamCreateFlagNoDefer | + kFSEventStreamCreateFlagUseExtendedData | + kFSEventStreamCreateFlagUseCFTypes; + + FSEventStreamContext ctx; + ctx.version = 0; + ctx.info = this; + ctx.retain = NULL; + ctx.release = NULL; + ctx.copyDescription = NULL; + + dispatch_queue_t queue = dispatch_queue_create(NULL, NULL); + + nextEventStream = FSEventStreamCreate( + kCFAllocatorDefault, + &FSEventsFileWatcher::FSEventCallback, + &ctx, + paths, + kFSEventStreamEventIdSinceNow, + 0., + streamFlags + ); + + FSEventStreamSetDispatchQueue(nextEventStream, queue); + bool didStart = FSEventStreamStart(nextEventStream); + + // Release all the strings we just created. + for (CFStringRef str : cfStrings) { + CFRelease(str); + } + CFRelease(paths); + + // If it started successfully, we can swap it into place as the new main + // stream. + if (didStart) { + if (currentEventStream) { + FSEventStreamStop(currentEventStream); + FSEventStreamInvalidate(currentEventStream); + FSEventStreamRelease(currentEventStream); + } + currentEventStream = nextEventStream; + nextEventStream = nullptr; + } + + return didStart; +} diff --git a/lib/platform/FSEventsFileWatcher.hpp b/lib/platform/FSEventsFileWatcher.hpp new file mode 100644 index 0000000..cdbdc2c --- /dev/null +++ b/lib/platform/FSEventsFileWatcher.hpp @@ -0,0 +1,105 @@ +#pragma once + +#include +#include +#include +#include +#include +#include +#include +#include "../../vendor/efsw/include/efsw/efsw.hpp" + +class FSEvent { +public: + FSEvent( + std::string path, + long flags, + uint64_t id, + uint64_t inode = 0 + ): path(path), flags(flags), id(id), inode(inode) {} + + std::string path; + long flags; + uint64_t id; + uint64_t inode; +}; + +class FSEventsFileWatcher { +public: + FSEventsFileWatcher() {}; + ~FSEventsFileWatcher(); + efsw::WatchID addWatch( + const std::string& directory, + efsw::FileWatchListener* watcher, + bool _useRecursion = false + ); + void removeWatch( + efsw::WatchID watchID + ); + + void handleActions(std::vector& events); + void sendFileAction( + efsw::WatchID watchid, + const std::string& dir, + const std::string& filename, + efsw::Action action, + std::string oldFilename = "" + ); + + static void FSEventCallback( + ConstFSEventStreamRef streamRef, + void* userData, + size_t numEvents, + void* eventPaths, + const FSEventStreamEventFlags eventFlags[], + const FSEventStreamEventId eventIds[] + ); + + void handleAddModDel( + efsw::WatchID handle, + const uint32_t& flags, + const std::string& path, + std::string& dirPath, + std::string& filePath + ); + + void process(); + + bool isValid = true; + +private: + // RAII guard to ensure we un-mark our “processing” flag if we're destroyed + // during processing. + class ProcessingGuard { + FSEventsFileWatcher& watcher; + public: + ProcessingGuard(FSEventsFileWatcher& w) : watcher(w) {} + ~ProcessingGuard() { + std::unique_lock lock(watcher.processingMutex); + watcher.isProcessing = false; + watcher.processingComplete.notify_all(); + } + }; + + size_t removeHandle(efsw::WatchID handle); + bool startNewStream(); + + long nextHandleID; + std::atomic isProcessing{false}; + std::atomic pendingDestruction{false}; + std::mutex processingMutex; + std::mutex mapMutex; + std::condition_variable processingComplete; + + // The running event stream that subscribes to all the paths we care about. + FSEventStreamRef currentEventStream = nullptr; + // An event stream that we create when our list of paths changes; it will + // become the `currentEventStream` after it starts. + FSEventStreamRef nextEventStream = nullptr; + + std::set dirsChanged; + + std::unordered_map handlesToPaths; + std::unordered_map pathsToHandles; + std::unordered_map handlesToListeners; +}; diff --git a/package.json b/package.json index 650864a..af7e9c9 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "main": "./lib/main", + "main": "./src/main", "name": "pathwatcher", "description": "Watch files and directories for changes", "version": "8.1.2", @@ -9,6 +9,9 @@ "url": "http://github.com/atom/node-pathwatcher/raw/master/LICENSE.md" } ], + "engines": { + "node": ">=14" + }, "repository": { "type": "git", "url": "https://github.com/atom/node-pathwatcher.git" @@ -18,20 +21,15 @@ }, "homepage": "http://atom.github.io/node-pathwatcher", "scripts": { - "prepublish": "grunt prepublish", - "test": "grunt test" + "test": "node spec/run.js", + "test-context-safety": "node spec/context-safety.js", + "clean": "node scripts/clean.js" }, "devDependencies": { - "grunt": "~0.4.1", - "grunt-contrib-coffee": "~0.9.0", - "grunt-cli": "~0.1.7", - "grunt-shell": "~0.2.2", - "jasmine-tagged": "^1.1", + "jasmine": "^5.3.1", + "node-addon-api": "^8.1.0", "rimraf": "~2.2.0", - "node-cpplint": "~0.1.5", - "grunt-coffeelint": "git+https://github.com/atom/grunt-coffeelint.git", - "temp": "~0.9.0", - "grunt-atomdoc": "^1.0" + "temp": "~0.9.0" }, "dependencies": { "async": "~0.2.10", @@ -40,7 +38,6 @@ "fs-plus": "^3.0.0", "grim": "^2.0.1", "iconv-lite": "~0.4.4", - "nan": "^2.10.0", "underscore-plus": "~1.x" } } diff --git a/scripts/clean.js b/scripts/clean.js new file mode 100644 index 0000000..f7344c2 --- /dev/null +++ b/scripts/clean.js @@ -0,0 +1,17 @@ +const fs = require('fs/promises'); +const path = require('path'); + +const ROOT = path.resolve(__dirname, '..'); + +async function rimraf (filePath) { + if (!path.isAbsolute(filePath)) { + filePath = path.resolve(ROOT, filePath); + } + await fs.rm(filePath, { recursive: true, force: true }); +} + + +(async () => { + await rimraf('build'); + await rimraf('api.json'); +})(); diff --git a/spec/context-safety.js b/spec/context-safety.js new file mode 100644 index 0000000..be5d2aa --- /dev/null +++ b/spec/context-safety.js @@ -0,0 +1,55 @@ + +// This script tests the library for context safety by creating several +// instances on separate threads. +// +// This test is successful when the script exits gracefully. It fails when the +// script segfaults or runs indefinitely. +const spawnThread = require('./worker'); + +const NUM_WORKERS = 1; +const MAX_DURATION_MS = 15 * 1000; + +// Pick one of the workers to return earlier than the others. If this causes +// the others to fail or misbehave, it suggests that cleanup logic for an +// environment is not truly context-safe. +let earlyReturn = null; +if (NUM_WORKERS > 1) { + earlyReturn = Math.floor(Math.random() * NUM_WORKERS); +} + +function bail () { + console.error(`Script ran for more than ${MAX_DURATION_MS / 1000} seconds; there's an open handle somewhere!`); + process.exit(2); +} + +// Wait to see if the script is still running MAX_DURATION_MS milliseconds from +// now
 +let failsafe = setTimeout(bail, MAX_DURATION_MS); +// 
but `unref` ourselves so that we're not the reason why the script keeps +// running! +failsafe.unref(); + +let promises = []; +let errors = []; +for (let i = 0; i < NUM_WORKERS; i++) { + let promise = spawnThread(i, earlyReturn); + + // We want to prevent unhandled promise rejections. The errors from any + // rejected promises will be collected and handled once all workers are done. + promise.catch((err) => errors.push(err)); + promises.push(promise); +} + +(async () => { + await Promise.allSettled(promises); + if (errors.length > 0) { + console.error('Errors:'); + for (let error of errors) { + console.error(` ${error}`); + } + // Don't call `process.exit`; we want to be able to detect whether there + // are open handles. If there aren't, the process will exit on its own; + // if there are, then the failsafe will detect it and tell us about it. + process.exitCode = 1; + } +})(); diff --git a/spec/directory-spec.coffee b/spec/directory-spec.coffee deleted file mode 100644 index 9931b13..0000000 --- a/spec/directory-spec.coffee +++ /dev/null @@ -1,387 +0,0 @@ -path = require 'path' -fs = require 'fs-plus' -temp = require 'temp' -Directory = require '../lib/directory' -PathWatcher = require '../lib/main' - -describe "Directory", -> - directory = null - - beforeEach -> - directory = new Directory(path.join(__dirname, 'fixtures')) - - afterEach -> - PathWatcher.closeAllWatchers() - - it "normalizes the specified path", -> - expect(new Directory(directory.path + path.sep + 'abc' + path.sep + '..').getBaseName()).toBe 'fixtures' - expect(new Directory(directory.path + path.sep + 'abc' + path.sep + '..').path.toLowerCase()).toBe directory.path.toLowerCase() - - expect(new Directory(directory.path + path.sep).getBaseName()).toBe 'fixtures' - expect(new Directory(directory.path + path.sep).path.toLowerCase()).toBe directory.path.toLowerCase() - - expect(new Directory(directory.path + path.sep + path.sep).getBaseName()).toBe 'fixtures' - expect(new Directory(directory.path + path.sep + path.sep).path.toLowerCase()).toBe directory.path.toLowerCase() - - expect(new Directory(path.sep).getBaseName()).toBe '' - expect(new Directory(path.sep).path).toBe path.sep - - it 'returns false from isFile()', -> - expect(directory.isFile()).toBe false - - it 'returns true from isDirectory()', -> - expect(directory.isDirectory()).toBe true - - describe '::isSymbolicLink()', -> - it 'returns false for regular directories', -> - expect(directory.isSymbolicLink()).toBe false - - it 'returns true for symlinked directories', -> - symbolicDirectory = new Directory(path.join(__dirname, 'fixtures'), true) - expect(symbolicDirectory.isSymbolicLink()).toBe true - - describe '::exists()', -> - [callback, tempDir] = [] - - beforeEach -> - tempDir = temp.mkdirSync('node-pathwatcher-directory') - callback = jasmine.createSpy('promiseCallback') - - it 'returns a Promise that resolves to true for an existing directory', -> - directory = new Directory(tempDir) - - waitsForPromise -> - directory.exists().then(callback) - - runs -> - expect(callback.argsForCall[0][0]).toBe true - - it 'returns a Promise that resolves to false for a non-existent directory', -> - directory = new Directory(path.join(tempDir, 'foo')) - - waitsForPromise -> - directory.exists().then(callback) - - runs -> - expect(callback.argsForCall[0][0]).toBe false - - describe '::existsSync()', -> - [tempDir] = [] - - beforeEach -> - tempDir = temp.mkdirSync('node-pathwatcher-directory') - - it 'returns true for an existing directory', -> - directory = new Directory(tempDir) - expect(directory.existsSync()).toBe true - - it 'returns false for a non-existent directory', -> - directory = new Directory(path.join(tempDir, 'foo')) - expect(directory.existsSync()).toBe false - - describe '::create()', -> - [callback, tempDir] = [] - - beforeEach -> - tempDir = temp.mkdirSync('node-pathwatcher-directory') - callback = jasmine.createSpy('promiseCallback') - - it 'creates directory if directory does not exist', -> - directoryName = path.join(tempDir, 'subdir') - expect(fs.existsSync(directoryName)).toBe false - nonExistentDirectory = new Directory(directoryName) - - waitsForPromise -> - nonExistentDirectory.create(0o0600).then(callback) - - runs -> - expect(callback.argsForCall[0][0]).toBe true - expect(fs.existsSync(directoryName)).toBe true - expect(fs.isDirectorySync(directoryName)).toBe true - - return if process.platform is 'win32' # No mode on Windows - - rawMode = fs.statSync(directoryName).mode - mode = rawMode & 0o07777 - expect(mode.toString(8)).toBe (0o0600).toString(8) - - it 'leaves existing directory alone if it exists', -> - directoryName = path.join(tempDir, 'subdir') - fs.mkdirSync(directoryName) - existingDirectory = new Directory(directoryName) - - waitsForPromise -> - existingDirectory.create().then(callback) - - runs -> - expect(callback.argsForCall[0][0]).toBe false - expect(fs.existsSync(directoryName)).toBe true - expect(fs.isDirectorySync(directoryName)).toBe true - - it 'creates parent directories if they do not exist', -> - directoryName = path.join(tempDir, 'foo', 'bar', 'baz') - expect(fs.existsSync(directoryName)).toBe false - nonExistentDirectory = new Directory(directoryName) - - waitsForPromise -> - nonExistentDirectory.create().then(callback) - - runs -> - expect(callback.argsForCall[0][0]).toBe true - - expect(fs.existsSync(directoryName)).toBe true - expect(fs.isDirectorySync(directoryName)).toBe true - - parentName = path.join(tempDir, 'foo', 'bar') - expect(fs.existsSync(parentName)).toBe true - expect(fs.isDirectorySync(parentName)).toBe true - - it "throws an error when called on a root directory that does not exist", -> - spyOn(Directory::, 'isRoot').andReturn(true) - directory = new Directory(path.join(tempDir, 'subdir')) - - waitsForPromise shouldReject: true, -> - directory.create() - - runs -> - expect(fs.existsSync(path.join(tempDir, 'subdir'))).toBe false - - describe "when the contents of the directory change on disk", -> - temporaryFilePath = null - - beforeEach -> - temporaryFilePath = path.join(__dirname, 'fixtures', 'temporary') - fs.removeSync(temporaryFilePath) - - afterEach -> - fs.removeSync(temporaryFilePath) - - it "notifies ::onDidChange observers", -> - changeHandler = null - - runs -> - directory.onDidChange changeHandler = jasmine.createSpy('changeHandler') - fs.writeFileSync(temporaryFilePath, '') - - waitsFor "first change", -> changeHandler.callCount > 0 - - runs -> - changeHandler.reset() - fs.removeSync(temporaryFilePath) - - waitsFor "second change", -> changeHandler.callCount > 0 - - describe "when the directory unsubscribes from events", -> - temporaryFilePath = null - - beforeEach -> - temporaryFilePath = path.join(directory.path, 'temporary') - fs.removeSync(temporaryFilePath) if fs.existsSync(temporaryFilePath) - - afterEach -> - fs.removeSync(temporaryFilePath) if fs.existsSync(temporaryFilePath) - - it "no longer triggers events", -> - [subscription, changeHandler] = [] - - runs -> - subscription = directory.onDidChange changeHandler = jasmine.createSpy('changeHandler') - fs.writeFileSync(temporaryFilePath, '') - - waitsFor "change event", -> changeHandler.callCount > 0 - - runs -> - changeHandler.reset() - subscription.dispose() - waits 20 - - runs -> fs.removeSync(temporaryFilePath) - waits 20 - runs -> expect(changeHandler.callCount).toBe 0 - - describe "on #darwin or #linux", -> - it "includes symlink information about entries", -> - entries = directory.getEntriesSync() - for entry in entries - name = entry.getBaseName() - if name is 'symlink-to-dir' or name is 'symlink-to-file' - expect(entry.symlink).toBeTruthy() - else - expect(entry.symlink).toBeFalsy() - - callback = jasmine.createSpy('getEntries') - directory.getEntries(callback) - - waitsFor -> callback.callCount is 1 - - runs -> - entries = callback.mostRecentCall.args[1] - for entry in entries - name = entry.getBaseName() - if name is 'symlink-to-dir' or name is 'symlink-to-file' - expect(entry.isSymbolicLink()).toBe true - else - expect(entry.isSymbolicLink()).toBe false - - describe ".relativize(path)", -> - describe "on #darwin or #linux", -> - it "returns a relative path based on the directory's path", -> - absolutePath = directory.getPath() - expect(directory.relativize(absolutePath)).toBe '' - expect(directory.relativize(path.join(absolutePath, "b"))).toBe "b" - expect(directory.relativize(path.join(absolutePath, "b/file.coffee"))).toBe "b/file.coffee" - expect(directory.relativize(path.join(absolutePath, "file.coffee"))).toBe "file.coffee" - - it "returns a relative path based on the directory's symlinked source path", -> - symlinkPath = path.join(__dirname, 'fixtures', 'symlink-to-dir') - symlinkDirectory = new Directory(symlinkPath) - realFilePath = require.resolve('./fixtures/dir/a') - expect(symlinkDirectory.relativize(symlinkPath)).toBe '' - expect(symlinkDirectory.relativize(realFilePath)).toBe 'a' - - it "returns the full path if the directory's path is not a prefix of the path", -> - expect(directory.relativize('/not/relative')).toBe '/not/relative' - - it "handled case insensitive filesystems", -> - spyOn(fs, 'isCaseInsensitive').andReturn true - directoryPath = temp.mkdirSync('Mixed-case-directory-') - directory = new Directory(directoryPath) - - expect(directory.relativize(directoryPath.toUpperCase())).toBe "" - expect(directory.relativize(path.join(directoryPath.toUpperCase(), "b"))).toBe "b" - expect(directory.relativize(path.join(directoryPath.toUpperCase(), "B"))).toBe "B" - expect(directory.relativize(path.join(directoryPath.toUpperCase(), "b/file.coffee"))).toBe "b/file.coffee" - expect(directory.relativize(path.join(directoryPath.toUpperCase(), "file.coffee"))).toBe "file.coffee" - - expect(directory.relativize(directoryPath.toLowerCase())).toBe "" - expect(directory.relativize(path.join(directoryPath.toLowerCase(), "b"))).toBe "b" - expect(directory.relativize(path.join(directoryPath.toLowerCase(), "B"))).toBe "B" - expect(directory.relativize(path.join(directoryPath.toLowerCase(), "b/file.coffee"))).toBe "b/file.coffee" - expect(directory.relativize(path.join(directoryPath.toLowerCase(), "file.coffee"))).toBe "file.coffee" - - expect(directory.relativize(directoryPath)).toBe "" - expect(directory.relativize(path.join(directoryPath, "b"))).toBe "b" - expect(directory.relativize(path.join(directoryPath, "B"))).toBe "B" - expect(directory.relativize(path.join(directoryPath, "b/file.coffee"))).toBe "b/file.coffee" - expect(directory.relativize(path.join(directoryPath, "file.coffee"))).toBe "file.coffee" - - describe "on #win32", -> - it "returns a relative path based on the directory's path", -> - absolutePath = directory.getPath() - expect(directory.relativize(absolutePath)).toBe '' - expect(directory.relativize(path.join(absolutePath, "b"))).toBe "b" - expect(directory.relativize(path.join(absolutePath, "b/file.coffee"))).toBe "b\\file.coffee" - expect(directory.relativize(path.join(absolutePath, "file.coffee"))).toBe "file.coffee" - - it "returns the full path if the directory's path is not a prefix of the path", -> - expect(directory.relativize('/not/relative')).toBe "\\not\\relative" - - describe ".resolve(uri)", -> - describe "when passed an absolute or relative path", -> - it "returns an absolute path based on the directory's path", -> - absolutePath = require.resolve('./fixtures/dir/a') - expect(directory.resolve('dir/a')).toBe absolutePath - expect(directory.resolve(absolutePath + '/../a')).toBe absolutePath - expect(directory.resolve('dir/a/../a')).toBe absolutePath - expect(directory.resolve()).toBeUndefined() - - describe "when passed a uri with a scheme", -> - it "does not modify uris that begin with a scheme", -> - expect(directory.resolve('http://zombo.com')).toBe 'http://zombo.com' - - describe ".contains(path)", -> - it "returns true if the path is a child of the directory's path", -> - absolutePath = directory.getPath() - expect(directory.contains(path.join(absolutePath))).toBe false - expect(directory.contains(path.join(absolutePath, "b"))).toBe true - expect(directory.contains(path.join(absolutePath, "b", "file.coffee"))).toBe true - expect(directory.contains(path.join(absolutePath, "file.coffee"))).toBe true - - it "returns false if the directory's path is not a prefix of the path", -> - expect(directory.contains('/not/relative')).toBe false - - it "handles case insensitive filesystems", -> - spyOn(fs, 'isCaseInsensitive').andReturn true - directoryPath = temp.mkdirSync('Mixed-case-directory-') - directory = new Directory(directoryPath) - - expect(directory.contains(directoryPath.toUpperCase())).toBe false - expect(directory.contains(path.join(directoryPath.toUpperCase(), "b"))).toBe true - expect(directory.contains(path.join(directoryPath.toUpperCase(), "B"))).toBe true - expect(directory.contains(path.join(directoryPath.toUpperCase(), "b", "file.coffee"))).toBe true - expect(directory.contains(path.join(directoryPath.toUpperCase(), "file.coffee"))).toBe true - - expect(directory.contains(directoryPath.toLowerCase())).toBe false - expect(directory.contains(path.join(directoryPath.toLowerCase(), "b"))).toBe true - expect(directory.contains(path.join(directoryPath.toLowerCase(), "B"))).toBe true - expect(directory.contains(path.join(directoryPath.toLowerCase(), "b", "file.coffee"))).toBe true - expect(directory.contains(path.join(directoryPath.toLowerCase(), "file.coffee"))).toBe true - - expect(directory.contains(directoryPath)).toBe false - expect(directory.contains(path.join(directoryPath, "b"))).toBe true - expect(directory.contains(path.join(directoryPath, "B"))).toBe true - expect(directory.contains(path.join(directoryPath, "b", "file.coffee"))).toBe true - expect(directory.contains(path.join(directoryPath, "file.coffee"))).toBe true - - describe "on #darwin or #linux", -> - it "returns true if the path is a child of the directory's symlinked source path", -> - symlinkPath = path.join(__dirname, 'fixtures', 'symlink-to-dir') - symlinkDirectory = new Directory(symlinkPath) - realFilePath = require.resolve('./fixtures/dir/a') - expect(symlinkDirectory.contains(realFilePath)).toBe true - - describe "traversal", -> - beforeEach -> - directory = new Directory(path.join __dirname, 'fixtures', 'dir') - - fixturePath = (parts...) -> - path.join __dirname, 'fixtures', parts... - - describe "getFile(filename)", -> - it "returns a File within this directory", -> - f = directory.getFile("a") - expect(f.isFile()).toBe(true) - expect(f.getRealPathSync()).toBe(fixturePath 'dir', 'a') - - it "can descend more than one directory at a time", -> - f = directory.getFile("subdir", "b") - expect(f.isFile()).toBe(true) - expect(f.getRealPathSync()).toBe(fixturePath 'dir', 'subdir', 'b') - - it "doesn't have to actually exist", -> - f = directory.getFile("the-silver-bullet") - expect(f.isFile()).toBe(true) - expect(f.existsSync()).toBe(false) - - describe "getSubdir(dirname)", -> - it "returns a subdirectory within this directory", -> - d = directory.getSubdirectory("subdir") - expect(d.isDirectory()).toBe(true) - expect(d.getRealPathSync()).toBe(fixturePath 'dir', 'subdir') - - it "can descend more than one directory at a time", -> - d = directory.getSubdirectory("subdir", "subsubdir") - expect(d.isDirectory()).toBe(true) - expect(d.getRealPathSync()).toBe(fixturePath 'dir', 'subdir', 'subsubdir') - - it "doesn't have to exist", -> - d = directory.getSubdirectory("why-would-you-call-a-directory-this-come-on-now") - expect(d.isDirectory()).toBe(true) - - describe "getParent()", -> - it "returns the parent Directory", -> - d = directory.getParent() - expect(d.isDirectory()).toBe(true) - expect(d.getRealPathSync()).toBe(fixturePath()) - - describe "isRoot()", -> - it "returns false if the Directory isn't the root", -> - expect(directory.isRoot()).toBe(false) - - it "returns true if the Directory is the root", -> - [current, previous] = [directory, null] - while current.getPath() isnt previous?.getPath() - previous = current - current = current.getParent() - - expect(current.isRoot()).toBe(true) diff --git a/spec/directory-spec.js b/spec/directory-spec.js new file mode 100644 index 0000000..f961804 --- /dev/null +++ b/spec/directory-spec.js @@ -0,0 +1,474 @@ +const path = require('path'); +const fs = require('fs-plus'); +const temp = require('temp'); +const Directory = require('../src/directory'); +const PathWatcher = require('../src/main'); + +describe('Directory', () => { + let directory; + let isCaseInsensitiveSpy; + let didSpy = false; + + beforeEach(() => { + // TODO: There's got to be a better way to do this. + if (!didSpy) { + isCaseInsensitiveSpy = spyOn(fs, 'isCaseInsensitive'); + didSpy = true; + } + directory = new Directory(path.join(__dirname, 'fixtures')); + }); + + afterEach(async () => { + PathWatcher.closeAllWatchers(); + isCaseInsensitiveSpy.and.callThrough(); + await wait(100); + }); + + it('normalizes the specified path', () => { + let filePath = path.join(directory.path, 'abc', '..'); + let otherDirectory = new Directory(filePath); + expect(otherDirectory.getBaseName()).toBe('fixtures'); + expect(otherDirectory.path.toLowerCase()).toBe(directory.path.toLowerCase()); + + otherDirectory = new Directory(`${directory.path}${path.sep}`); + expect(otherDirectory.getBaseName()).toBe('fixtures'); + expect(otherDirectory.path.toLowerCase()).toBe(directory.path.toLowerCase()); + + otherDirectory = new Directory(path.sep); + expect(otherDirectory.getBaseName()).toBe(''); + expect(otherDirectory.path).toBe(path.sep); + }); + + it('returns false from ::isFile', () => { + expect(directory.isFile()).toBe(false); + }); + + it('returns true from ::isDirectory', () => { + expect(directory.isDirectory()).toBe(true); + }); + + describe('::isSymbolicLink', () => { + it('returns false for regular directories', () => { + expect(directory.isSymbolicLink()).toBe(false); + }); + + it('returns true for symlinked directories', () => { + let symbolicDirectory = new Directory(path.join(__dirname, 'fixtures'), true); + expect(symbolicDirectory.isSymbolicLink()).toBe(true); + }); + }); + + describe('::exists', () => { + let tempDir; + + beforeEach(() => { + tempDir = temp.mkdirSync('node-pathwatcher-directory'); + }); + + it('resolves to true for a directory that exists', async () => { + directory = new Directory(tempDir); + expect( + await directory.exists() + ).toBe(true); + }); + + it('resolves to false for a directory that doesn’t exist', async () => { + directory = new Directory(path.join(tempDir, 'foo')); + expect( + await directory.exists() + ).toBe(false); + }); + }); + + describe('::existsSync', () => { + let tempDir; + + beforeEach(() => { + tempDir = temp.mkdirSync('node-pathwatcher-directory'); + }); + + it('returns true for a directory that exists', () => { + directory = new Directory(tempDir); + expect( + directory.existsSync() + ).toBe(true); + }); + + it('returns false for a directory that doesn’t exist', () => { + directory = new Directory(path.join(tempDir, 'foo')); + expect( + directory.existsSync() + ).toBe(false); + }); + }); + + describe('::create', () => { + let tempDir; + + beforeEach(() => { + tempDir = temp.mkdirSync('node-pathwatcher-directory'); + }); + + it('creates the directory if the directory doesn’t exist', async () => { + let directoryName = path.join(tempDir, 'subdir'); + expect(fs.existsSync(directoryName)).toBe(false); + let nonExistentDirectory = new Directory(directoryName); + + let didCreate = await nonExistentDirectory.create(0o0600); + + expect(didCreate).toBe(true); + expect(fs.existsSync(directoryName)).toBe(true); + expect(fs.isDirectorySync(directoryName)).toBe(true); + + if (process.platform === 'win32') return; + + let rawMode = fs.statSync(directoryName).mode; + mode = rawMode & 0o07777; + expect(mode.toString(8)).toBe((0o0600).toString(8)); + }); + + it('leaves an existing directory alone', async () => { + let directoryName = path.join(tempDir, 'subdir'); + fs.mkdirSync(directoryName); + let existingDirectory = new Directory(directoryName); + + let didCreate = await existingDirectory.create(); + + expect(didCreate).toBe(false); + expect(fs.existsSync(directoryName)).toBe(true); + expect(fs.isDirectorySync(directoryName)).toBe(true); + }); + + it('creates parent directories if they don’t exist', async () => { + let directoryName = path.join(tempDir, 'foo', 'bar', 'baz'); + expect(fs.existsSync(directoryName)).toBe(false); + let nonExistentDirectory = new Directory(directoryName); + + let didCreate = await nonExistentDirectory.create(0o0600); + + expect(didCreate).toBe(true); + expect(fs.existsSync(directoryName)).toBe(true); + expect(fs.isDirectorySync(directoryName)).toBe(true); + + let parentName = path.join(tempDir, 'foo', 'bar'); + expect(fs.existsSync(parentName)).toBe(true); + expect(fs.isDirectorySync(parentName)).toBe(true); + }); + + it('throws an error when called on a root directory that does not exist', async () => { + spyOn(Directory.prototype, 'isRoot').and.returnValue(true); + let directory = new Directory(path.join(tempDir, 'subdir')); + + expect(directory.isRoot()).toBe(true); + + try { + await directory.create(); + expect(false).toBe(true); + } catch (err) { + expect(true).toBe(true); + } + + expect(fs.existsSync(path.join(tempDir, 'subdir'))).toBe(false); + }); + }); + + describe('when the contents of the directory change on disk', () => { + let temporaryFilePath; + + beforeEach(() => { + temporaryFilePath = path.join(__dirname, 'fixtures', 'temporary'); + fs.removeSync(temporaryFilePath); + }); + + afterEach(() => { + fs.removeSync(temporaryFilePath); + }); + + it('notifies ::onDidChange observers', async () => { + let handler = jasmine.createSpy('changeHandler'); + directory.onDidChange(handler); + fs.writeFileSync(temporaryFilePath, ''); + + await condition(() => handler.calls.count() > 0); + + handler.calls.reset(); + fs.removeSync(temporaryFilePath); + + await condition(() => handler.calls.count() > 0); + }); + }); + + describe('when the directory unsubscribes from events', () => { + let temporaryFilePath; + + beforeEach(() => { + temporaryFilePath = path.join(__dirname, 'fixtures', 'temporary'); + if (fs.existsSync(temporaryFilePath)) { + fs.removeSync(temporaryFilePath); + } + }); + + afterEach(() => { + if (fs.existsSync(temporaryFilePath)) { + fs.removeSync(temporaryFilePath); + } + }); + + it('no longer triggers events', async () => { + let changeHandler = jasmine.createSpy('changeHandler'); + let subscription = directory.onDidChange(changeHandler); + + await wait(1000); + + fs.writeFileSync(temporaryFilePath, ''); + + await condition(() => changeHandler.calls.count() > 0); + + changeHandler.calls.reset(); + subscription.dispose(); + + await wait(20); + fs.removeSync(temporaryFilePath); + await wait(20); + expect(changeHandler.calls.count()).toBe(0); + }); + }); + + if (process.platform !== 'win32') { + describe('on #darwin or #linux', () => { + it('includes symlink information about entries', async () => { + let entries = directory.getEntriesSync(); + for (let entry of entries) { + let name = entry.getBaseName(); + if (name === 'symlink-to-dir' || name === 'symlink-to-file') { + expect(entry.symlink).toBeTruthy(); + } else { + expect(entry.symlink).toBeFalsy(); + } + } + + let callback = jasmine.createSpy('getEntries'); + directory.getEntries(callback); + + await condition(() => callback.calls.count() === 1); + + entries = callback.calls.mostRecent().args[1]; + for (let entry of entries) { + let name = entry.getBaseName(); + if (name === 'symlink-to-dir' || name === 'symlink-to-file') { + expect(entry.symlink).toBeTruthy(); + } else { + expect(entry.symlink).toBeFalsy(); + } + } + }); + }); + } + + describe('::relativize', () => { + if (process.platform !== 'win32') { + describe('on #darwin or #linux', () => { + it('returns a relative path based on the directory’s path', () => { + let absolutePath = directory.getPath(); + expect(directory.relativize(absolutePath)).toBe(''); + expect(directory.relativize(path.join(absolutePath, 'b'))).toBe('b') + expect(directory.relativize(path.join(absolutePath, 'b/file.coffee'))).toBe('b/file.coffee'); + expect(directory.relativize(path.join(absolutePath, "file.coffee"))).toBe('file.coffee'); + }); + + it('returns a relative path based on the directory’s symlinked source path', () => { + let symlinkPath = path.join(__dirname, 'fixtures', 'symlink-to-dir'); + let symlinkDirectory = new Directory(symlinkPath); + let realFilePath = require.resolve('./fixtures/dir/a'); + expect(symlinkDirectory.relativize(symlinkPath)).toBe(''); + expect(symlinkDirectory.relativize(realFilePath)).toBe('a'); + }); + + it('returns the full path if the directory’s path is not a prefix of the path', () => { + expect(directory.relativize('/not/relative')).toBe('/not/relative'); + }); + + it('handles case-insensitive filesystems', () => { + isCaseInsensitiveSpy.and.returnValue(true); + let directoryPath = temp.mkdirSync('Mixed-case-directory-') + let directory = new Directory(directoryPath) + + expect(directory.relativize(directoryPath.toUpperCase())).toBe(""); + expect(directory.relativize(path.join(directoryPath.toUpperCase(), "b"))).toBe("b"); + expect(directory.relativize(path.join(directoryPath.toUpperCase(), "B"))).toBe("B"); + expect(directory.relativize(path.join(directoryPath.toUpperCase(), "b/file.coffee"))).toBe("b/file.coffee"); + expect(directory.relativize(path.join(directoryPath.toUpperCase(), "file.coffee"))).toBe("file.coffee"); + + expect(directory.relativize(directoryPath.toLowerCase())).toBe(""); + expect(directory.relativize(path.join(directoryPath.toLowerCase(), "b"))).toBe("b"); + expect(directory.relativize(path.join(directoryPath.toLowerCase(), "B"))).toBe("B"); + expect(directory.relativize(path.join(directoryPath.toLowerCase(), "b/file.coffee"))).toBe("b/file.coffee"); + expect(directory.relativize(path.join(directoryPath.toLowerCase(), "file.coffee"))).toBe("file.coffee"); + + expect(directory.relativize(directoryPath)).toBe(""); + expect(directory.relativize(path.join(directoryPath, "b"))).toBe("b"); + expect(directory.relativize(path.join(directoryPath, "B"))).toBe("B"); + expect(directory.relativize(path.join(directoryPath, "b/file.coffee"))).toBe("b/file.coffee"); + expect(directory.relativize(path.join(directoryPath, "file.coffee"))).toBe("file.coffee"); + }); + }); + } // end #darwin/#linux + + if (process.platform === 'win32') { + describe('on #win32', () => { + it('returns a relative path based on the directory’s path', () => { + let absolutePath = directory.getPath(); + expect(directory.relativize(absolutePath)).toBe(''); + expect(directory.relativize(path.join(absolutePath, 'b'))).toBe('b') + expect(directory.relativize(path.join(absolutePath, 'b/file.coffee'))).toBe('b\\file.coffee'); + expect(directory.relativize(path.join(absolutePath, "file.coffee"))).toBe('file.coffee'); + }); + + it('returns the full path if the directory’s path is not a prefix of the path', () => { + expect(directory.relativize('/not/relative')).toBe("\\not\\relative"); + }); + }); + } + }); + + describe('::resolve', () => { + describe('when passed an absolute or relative path', () => { + it('returns an absolute path based on the directory’s path', () => { + let absolutePath = require.resolve('./fixtures/dir/a'); + expect(directory.resolve('dir/a')).toBe(absolutePath); + expect(directory.resolve(absolutePath + '/../a')).toBe(absolutePath) + expect(directory.resolve('dir/a/../a')).toBe(absolutePath) + expect(directory.resolve()).toBeUndefined() + }); + }); + + describe('when passed a URI with a scheme', () => { + it('does not modify URIs that begin with a scheme', () => { + expect(directory.resolve('http://zombo.com')).toBe('http://zombo.com'); + }); + }); + }); + + describe('::contains', () => { + it('returns true if the path is a child of the directory’s path', () => { + let absolutePath = directory.getPath(); + + expect(directory.contains(path.join(absolutePath))).toBe(false); + expect(directory.contains(path.join(absolutePath, "b"))).toBe(true); + expect(directory.contains(path.join(absolutePath, "b", "file.coffee"))).toBe(true); + expect(directory.contains(path.join(absolutePath, "file.coffee"))).toBe(true); + }); + + it('returns false if the directory’s path is not a prefix of the path', () => { + expect(directory.contains('/not/relative')).toBe(false); + }); + + it('handles case-insensitive filesystems', () => { + isCaseInsensitiveSpy.and.returnValue(true); + let directoryPath = temp.mkdirSync('Mixed-case-directory-') + let directory = new Directory(directoryPath) + + expect(directory.contains(directoryPath.toUpperCase())).toBe(false); + expect(directory.contains(path.join(directoryPath.toUpperCase(), "b"))).toBe(true); + expect(directory.contains(path.join(directoryPath.toUpperCase(), "B"))).toBe(true); + expect(directory.contains(path.join(directoryPath.toUpperCase(), "b", "file.coffee"))).toBe(true); + expect(directory.contains(path.join(directoryPath.toUpperCase(), "file.coffee"))).toBe(true); + + expect(directory.contains(directoryPath.toLowerCase())).toBe(false); + expect(directory.contains(path.join(directoryPath.toLowerCase(), "b"))).toBe(true); + expect(directory.contains(path.join(directoryPath.toLowerCase(), "B"))).toBe(true); + expect(directory.contains(path.join(directoryPath.toLowerCase(), "b", "file.coffee"))).toBe(true); + expect(directory.contains(path.join(directoryPath.toLowerCase(), "file.coffee"))).toBe(true); + + expect(directory.contains(directoryPath)).toBe(false); + expect(directory.contains(path.join(directoryPath, "b"))).toBe(true); + expect(directory.contains(path.join(directoryPath, "B"))).toBe(true); + expect(directory.contains(path.join(directoryPath, "b", "file.coffee"))).toBe(true); + expect(directory.contains(path.join(directoryPath, "file.coffee"))).toBe(true); + }); + + if (process.platform !== 'win32') { + describe('on #darwin or #linux', () => { + it('returns true if the path is a child of the directory’s symlinked source path', () => { + let symlinkPath = path.join(__dirname, 'fixtures', 'symlink-to-dir'); + let symlinkDirectory = new Directory(symlinkPath); + let realFilePath = require.resolve('./fixtures/dir/a'); + expect(symlinkDirectory.contains(realFilePath)).toBe(true); + }); + }); + } + + describe('traversal', () => { + beforeEach(() => { + directory = new Directory(path.join(__dirname, 'fixtures', 'dir')); + }); + + function fixturePath (...parts) { + return path.join(__dirname, 'fixtures', ...parts); + } + + describe('::getFile', () => { + it('returns a File within this directory', () => { + let f = directory.getFile('a'); + expect(f.isFile()).toBe(true); + expect(f.getRealPathSync()).toBe(fixturePath('dir', 'a')); + }); + + it('can descend more than one directory at a time', () => { + let f = directory.getFile('subdir', 'b'); + expect(f.isFile()).toBe(true); + expect(f.getRealPathSync()).toBe(fixturePath('dir', 'subdir', 'b')); + }); + + it('doesn’t have to exist', () => { + let f = directory.getFile('the-silver-bullet'); + expect(f.isFile()).toBe(true); + expect(f.existsSync()).toBe(false); + }); + }); + + describe('::getSubdirectory', () => { + it('returns a subdirectory within this directory', () => { + let d = directory.getSubdirectory('subdir'); + expect(d.isDirectory()).toBe(true); + expect(d.getRealPathSync()).toBe(fixturePath('dir', 'subdir')); + }); + + it('can descend more than one directory at a time', () => { + let d = directory.getSubdirectory('subdir', 'subsubdir'); + expect(d.isDirectory()).toBe(true); + expect(d.getRealPathSync()).toBe(fixturePath('dir', 'subdir', 'subsubdir')); + }); + + it('doesn’t have to exist', () => { + let d = directory.getSubdirectory("why-would-you-call-a-directory-this-come-on-now"); + expect(d.isDirectory()).toBe(true); + }); + }); + + describe('::getParent', () => { + it('returns the parent Directory', () => { + let d = directory.getParent(); + expect(d.isDirectory()).toBe(true); + expect(d.getRealPathSync()).toBe(fixturePath()); + }); + }); + + describe('::isRoot', () => { + it('returns false if the Directory isn’t the root', () => { + expect(directory.isRoot()).toBe(false); + }); + + it('returns true if the Directory is the root', () => { + let current = directory; + let previous = null; + while (current.getPath() !== previous?.getPath()) { + previous = current; + current = current.getParent(); + } + expect(current.isRoot()).toBe(true); + }); + }); + }); + }); +}); diff --git a/spec/file-spec.coffee b/spec/file-spec.coffee deleted file mode 100644 index bad6b09..0000000 --- a/spec/file-spec.coffee +++ /dev/null @@ -1,515 +0,0 @@ -path = require 'path' -fs = require 'fs-plus' -temp = require 'temp' -File = require '../lib/file' -PathWatcher = require '../lib/main' - -describe 'File', -> - [filePath, file] = [] - - beforeEach -> - filePath = path.join(__dirname, 'fixtures', 'file-test.txt') # Don't put in /tmp because /tmp symlinks to /private/tmp and screws up the rename test - fs.removeSync(filePath) - fs.writeFileSync(filePath, "this is old!") - file = new File(filePath) - - afterEach -> - file.unsubscribeFromNativeChangeEvents() - fs.removeSync(filePath) - PathWatcher.closeAllWatchers() - - it "normalizes the specified path", -> - expect(new File(__dirname + path.sep + 'fixtures' + path.sep + 'abc' + path.sep + '..' + path.sep + 'file-test.txt').getBaseName()).toBe 'file-test.txt' - expect(new File(__dirname + path.sep + 'fixtures' + path.sep + 'abc' + path.sep + '..' + path.sep + 'file-test.txt').path.toLowerCase()).toBe file.path.toLowerCase() - - it 'returns true from isFile()', -> - expect(file.isFile()).toBe true - - it 'returns false from isDirectory()', -> - expect(file.isDirectory()).toBe false - - describe '::isSymbolicLink', -> - it 'returns false for regular files', -> - expect(file.isSymbolicLink()).toBe false - - it 'returns true for symlinked files', -> - symbolicFile = new File(filePath, true) - expect(symbolicFile.isSymbolicLink()).toBe true - - describe "::getDigestSync", -> - it "computes and returns the SHA-1 digest and caches it", -> - filePath = path.join(temp.mkdirSync('node-pathwatcher-directory'), 'file.txt') - fs.writeFileSync(filePath, '') - - file = new File(filePath) - spyOn(file, 'readSync').andCallThrough() - - expect(file.getDigestSync()).toBe 'da39a3ee5e6b4b0d3255bfef95601890afd80709' - expect(file.readSync.callCount).toBe 1 - expect(file.getDigestSync()).toBe 'da39a3ee5e6b4b0d3255bfef95601890afd80709' - expect(file.readSync.callCount).toBe 1 - - file.writeSync('x') - - expect(file.getDigestSync()).toBe '11f6ad8ec52a2984abaafd7c3b516503785c2072' - expect(file.readSync.callCount).toBe 1 - expect(file.getDigestSync()).toBe '11f6ad8ec52a2984abaafd7c3b516503785c2072' - expect(file.readSync.callCount).toBe 1 - - describe '::create()', -> - [callback, nonExistentFile, tempDir] = [] - - beforeEach -> - tempDir = temp.mkdirSync('node-pathwatcher-directory') - callback = jasmine.createSpy('promiseCallback') - - afterEach -> - nonExistentFile.unsubscribeFromNativeChangeEvents() - fs.removeSync(nonExistentFile.getPath()) - - it 'creates file in directory if file does not exist', -> - fileName = path.join(tempDir, 'file.txt') - expect(fs.existsSync(fileName)).toBe false - nonExistentFile = new File(fileName) - - waitsForPromise -> - nonExistentFile.create().then(callback) - - runs -> - expect(callback.argsForCall[0][0]).toBe true - expect(fs.existsSync(fileName)).toBe true - expect(fs.isFileSync(fileName)).toBe true - expect(fs.readFileSync(fileName).toString()).toBe '' - - it 'leaves existing file alone if it exists', -> - fileName = path.join(tempDir, 'file.txt') - fs.writeFileSync(fileName, 'foo') - existingFile = new File(fileName) - - waitsForPromise -> - existingFile.create().then(callback) - - runs -> - expect(callback.argsForCall[0][0]).toBe false - expect(fs.existsSync(fileName)).toBe true - expect(fs.isFileSync(fileName)).toBe true - expect(fs.readFileSync(fileName).toString()).toBe 'foo' - - it 'creates parent directories and file if they do not exist', -> - fileName = path.join(tempDir, 'foo', 'bar', 'file.txt') - expect(fs.existsSync(fileName)).toBe false - nonExistentFile = new File(fileName) - - waitsForPromise -> - nonExistentFile.create().then(callback) - - runs -> - expect(callback.argsForCall[0][0]).toBe true - expect(fs.existsSync(fileName)).toBe true - expect(fs.isFileSync(fileName)).toBe true - - parentName = path.join(tempDir, 'foo' ,'bar') - expect(fs.existsSync(parentName)).toBe true - expect(fs.isDirectorySync(parentName)).toBe true - - describe "when the file has not been read", -> - describe "when the contents of the file change", -> - it "notifies ::onDidChange observers", -> - file.onDidChange changeHandler = jasmine.createSpy('changeHandler') - fs.writeFileSync(file.getPath(), "this is new!") - - waitsFor "change event", -> - changeHandler.callCount > 0 - - describe "when the contents of the file are deleted", -> - it "notifies ::onDidChange observers", -> - file.onDidChange changeHandler = jasmine.createSpy('changeHandler') - fs.writeFileSync(file.getPath(), "") - - waitsFor "change event", -> - changeHandler.callCount > 0 - - describe "when the file has already been read #darwin", -> - beforeEach -> - file.readSync() - - describe "when the contents of the file change", -> - it "notifies ::onDidChange observers", -> - lastText = null - - file.onDidChange -> - file.read().then (text) -> - lastText = text - - runs -> fs.writeFileSync(file.getPath(), 'this is new!') - waitsFor 'read after first change event', -> lastText is 'this is new!' - runs -> expect(file.readSync()).toBe('this is new!') - - runs -> fs.writeFileSync(file.getPath(), 'this is newer!') - waitsFor 'read after second change event', -> lastText is 'this is newer!' - runs -> expect(file.readSync()).toBe('this is newer!') - - describe "when the file is deleted", -> - it "notifies ::onDidDelete observers", -> - deleteHandler = jasmine.createSpy('deleteHandler') - file.onDidDelete(deleteHandler) - fs.removeSync(file.getPath()) - - waitsFor "remove event", -> - deleteHandler.callCount > 0 - - describe "when a file is moved (via the filesystem)", -> - newPath = null - - beforeEach -> - newPath = path.join(path.dirname(filePath), "file-was-moved-test.txt") - - afterEach -> - if fs.existsSync(newPath) - fs.removeSync(newPath) - deleteHandler = jasmine.createSpy('deleteHandler') - file.onDidDelete(deleteHandler) - waitsFor "remove event", 30000, -> deleteHandler.callCount > 0 - - it "it updates its path", -> - moveHandler = jasmine.createSpy('moveHandler') - file.onDidRename moveHandler - - fs.moveSync(filePath, newPath) - - waitsFor "move event", 30000, -> - moveHandler.callCount > 0 - - runs -> - expect(file.getPath()).toBe newPath - - it "maintains ::onDidChange observers that were subscribed on the previous path", -> - moveHandler = null - moveHandler = jasmine.createSpy('moveHandler') - file.onDidRename moveHandler - changeHandler = null - changeHandler = jasmine.createSpy('changeHandler') - file.onDidChange changeHandler - - fs.moveSync(filePath, newPath) - - waitsFor "move event", -> - moveHandler.callCount > 0 - - runs -> - expect(changeHandler).not.toHaveBeenCalled() - fs.writeFileSync(file.getPath(), "this is new!") - - waitsFor "change event", -> - changeHandler.callCount > 0 - - describe "when a file is deleted and the recreated within a small amount of time (git sometimes does this)", -> - it "triggers a contents change event if the contents change", -> - changeHandler = jasmine.createSpy("file changed") - deleteHandler = jasmine.createSpy("file deleted") - file.onDidChange changeHandler - file.onDidDelete deleteHandler - - expect(changeHandler).not.toHaveBeenCalled() - - fs.removeSync(filePath) - - expect(changeHandler).not.toHaveBeenCalled() - waits 20 - runs -> - fs.writeFileSync(filePath, "HE HAS RISEN!") - expect(changeHandler).not.toHaveBeenCalled() - - waitsFor "resurrection change event", -> - changeHandler.callCount == 1 - - runs -> - expect(deleteHandler).not.toHaveBeenCalled() - fs.writeFileSync(filePath, "Hallelujah!") - changeHandler.reset() - - waitsFor "post-resurrection change event", -> - changeHandler.callCount > 0 - - describe "when a file is moved to the trash", -> - osxTrashDir = process.env.HOME + "/.Trash" - osxTrashPath = path.join(osxTrashDir, "file-was-moved-to-trash.txt") - it "triggers a delete event", -> - deleteHandler = null - deleteHandler = jasmine.createSpy("deleteHandler") - file.onDidDelete(deleteHandler) - - fs.moveSync(filePath, osxTrashPath) - - waitsFor "remove event", -> - deleteHandler.callCount > 0 - - # Clean up - if fs.existsSync(osxTrashPath) - fs.removeSync(osxTrashPath) - - describe "when a file cannot be opened after the watch has been applied", -> - errorSpy = null - beforeEach -> - errorSpy = jasmine.createSpy() - errorSpy.andCallFake ({error, handle})-> - handle() - file.onWillThrowWatchError errorSpy - - describe "when the error happens in the promise callback chain", -> - beforeEach -> - spyOn(file, 'setDigest').andCallFake -> - error = new Error('ENOENT open "FUUU"') - error.code = 'ENOENT' - throw error - - it "emits an event with the error", -> - changeHandler = jasmine.createSpy('changeHandler') - file.onDidChange changeHandler - fs.writeFileSync(file.getPath(), "this is new!!") - - waitsFor "change event", -> - errorSpy.callCount > 0 - - runs -> - args = errorSpy.mostRecentCall.args[0] - expect(args.error.code).toBe 'ENOENT' - expect(args.error.eventType).toBe 'change' - expect(args.handle).toBeTruthy() - - describe "when the error happens in the read method", -> - beforeEach -> - spyOn(file, 'read').andCallFake -> - error = new Error('ENOENT open "FUUU"') - error.code = 'ENOENT' - throw error - - it "emits an event with the error", -> - changeHandler = jasmine.createSpy('changeHandler') - file.onDidChange changeHandler - fs.writeFileSync(file.getPath(), "this is new!!") - - waitsFor "change event", -> - errorSpy.callCount > 0 - - runs -> - args = errorSpy.mostRecentCall.args[0] - expect(args.error.code).toBe 'ENOENT' - expect(args.error.eventType).toBe 'change' - expect(args.handle).toBeTruthy() - - describe "getRealPathSync()", -> - tempDir = null - - beforeEach -> - tempDir = temp.mkdirSync('node-pathwatcher-directory') - fs.writeFileSync(path.join(tempDir, 'file'), '') - fs.writeFileSync(path.join(tempDir, 'file2'), '') - - it "returns the resolved path to the file", -> - tempFile = new File(path.join(tempDir, 'file')) - expect(tempFile.getRealPathSync()).toBe fs.realpathSync(path.join(tempDir, 'file')) - tempFile.setPath(path.join(tempDir, 'file2')) - expect(tempFile.getRealPathSync()).toBe fs.realpathSync(path.join(tempDir, 'file2')) - - describe "on #darwin and #linux", -> - it "returns the target path for symlinks", -> - fs.symlinkSync(path.join(tempDir, 'file2'), path.join(tempDir, 'file3')) - tempFile = new File(path.join(tempDir, 'file3')) - expect(tempFile.getRealPathSync()).toBe fs.realpathSync(path.join(tempDir, 'file2')) - - describe "exists()", -> - tempDir = null - - beforeEach -> - tempDir = temp.mkdirSync('node-pathwatcher-directory') - fs.writeFileSync(path.join(tempDir, 'file'), '') - - it "does actually exist", -> - existingFile = new File(path.join(tempDir, 'file')) - existsHandler = jasmine.createSpy('exists handler') - existingFile.exists().then(existsHandler) - waitsFor 'exists handler', -> - existsHandler.callCount > 0 - runs -> - expect(existsHandler.argsForCall[0][0]).toBe(true) - - it "doesn't exist", -> - nonExistingFile = new File(path.join(tempDir, 'not_file')) - existsHandler = jasmine.createSpy('exists handler') - nonExistingFile.exists().then(existsHandler) - waitsFor 'exists handler', -> - existsHandler.callCount > 0 - runs -> - expect(existsHandler.argsForCall[0][0]).toBe(false) - - describe "getRealPath()", -> - tempDir = null - - beforeEach -> - tempDir = temp.mkdirSync('node-pathwatcher-directory') - fs.writeFileSync(path.join(tempDir, 'file'), '') - fs.writeFileSync(path.join(tempDir, 'file2'), '') - - it "returns the resolved path to the file", -> - tempFile = new File(path.join(tempDir, 'file')) - realpathHandler = jasmine.createSpy('realpath handler') - tempFile.getRealPath().then(realpathHandler) - waitsFor 'realpath handler', -> - realpathHandler.callCount > 0 - runs -> - expect(realpathHandler.argsForCall[0][0]).toBe fs.realpathSync(path.join(tempDir, 'file')) - - it "returns the resolved path to the file after setPath", -> - tempFile = new File(path.join(tempDir, 'file')) - tempFile.setPath(path.join(tempDir, 'file2')) - realpathHandler = jasmine.createSpy('realpath handler') - tempFile.getRealPath().then(realpathHandler) - waitsFor 'realpath handler', -> - realpathHandler.callCount > 0 - runs -> - expect(realpathHandler.argsForCall[0][0]).toBe fs.realpathSync(path.join(tempDir, 'file2')) - - describe "on #darwin and #linux", -> - it "returns the target path for symlinks", -> - fs.symlinkSync(path.join(tempDir, 'file2'), path.join(tempDir, 'file3')) - tempFile = new File(path.join(tempDir, 'file3')) - realpathHandler = jasmine.createSpy('realpath handler') - tempFile.getRealPath().then(realpathHandler) - waitsFor 'realpath handler', -> - realpathHandler.callCount > 0 - runs -> - expect(realpathHandler.argsForCall[0][0]).toBe fs.realpathSync(path.join(tempDir, 'file2')) - - describe "getParent()", -> - it "gets the parent Directory", -> - d = file.getParent() - expected = path.join __dirname, 'fixtures' - expect(d.getRealPathSync()).toBe(expected) - - describe 'encoding', -> - it "should be 'utf8' by default", -> - expect(file.getEncoding()).toBe('utf8') - - it "should be settable", -> - file.setEncoding('cp1252') - expect(file.getEncoding()).toBe('cp1252') - - it "throws an exception when assigning an invalid encoding", -> - expect(-> - file.setEncoding('utf-8-bom') - ).toThrow() - - describe 'createReadStream()', -> - it 'returns a stream to read the file', -> - stream = file.createReadStream() - ended = false - content = [] - - stream.on 'data', (chunk) -> content.push(chunk) - stream.on 'end', -> ended = true - - waitsFor 'stream ended', -> ended - - runs -> - expect(content.join('')).toEqual('this is old!') - - it 'honors the specified encoding', -> - unicodeText = 'ё' - unicodeBytes = Buffer.from('\x51\x04') # 'ё' - - fs.writeFileSync(file.getPath(), unicodeBytes) - - file.setEncoding('utf16le') - - stream = file.createReadStream() - ended = false - content = [] - - stream.on 'data', (chunk) -> content.push(chunk) - stream.on 'end', -> ended = true - - waitsFor 'stream ended', -> ended - - runs -> - expect(content.join('')).toEqual(unicodeText) - - describe 'createWriteStream()', -> - it 'returns a stream to read the file', -> - unicodeText = 'ё' - unicodeBytes = Buffer.from('\x51\x04') # 'ё' - - file.setEncoding('utf16le') - stream = file.createWriteStream() - ended = false - - stream.on 'finish', -> ended = true - - stream.end(unicodeText) - - waitsFor 'stream finished', -> ended - - runs -> - expect(fs.statSync(file.getPath()).size).toBe(2) - content = fs.readFileSync(file.getPath()).toString('ascii') - expect(content).toBe(unicodeBytes.toString('ascii')) - - describe 'encoding support', -> - [unicodeText, unicodeBytes] = [] - - beforeEach -> - unicodeText = 'ё' - unicodeBytes = Buffer.from('\x51\x04') # 'ё' - - it 'should read a file in UTF-16', -> - fs.writeFileSync(file.getPath(), unicodeBytes) - file.setEncoding('utf16le') - - readHandler = jasmine.createSpy('read handler') - file.read().then(readHandler) - - waitsFor 'read handler', -> - readHandler.callCount > 0 - - runs -> - expect(readHandler.argsForCall[0][0]).toBe(unicodeText) - - it 'should readSync a file in UTF-16', -> - fs.writeFileSync(file.getPath(), unicodeBytes) - file.setEncoding('utf16le') - expect(file.readSync()).toBe(unicodeText) - - it 'should write a file in UTF-16', -> - file.setEncoding('utf16le') - writeHandler = jasmine.createSpy('write handler') - file.write(unicodeText).then(writeHandler) - waitsFor 'write handler', -> - writeHandler.callCount > 0 - runs -> - expect(fs.statSync(file.getPath()).size).toBe(2) - content = fs.readFileSync(file.getPath()).toString('ascii') - expect(content).toBe(unicodeBytes.toString('ascii')) - - it 'should write a file in UTF-16 synchronously', -> - file.setEncoding('utf16le') - file.writeSync(unicodeText) - expect(fs.statSync(file.getPath()).size).toBe(2) - content = fs.readFileSync(file.getPath()).toString('ascii') - expect(content).toBe(unicodeBytes.toString('ascii')) - - describe 'reading a non-existing file', -> - it 'should return null', -> - file = new File('not_existing.txt') - readHandler = jasmine.createSpy('read handler') - file.read().then(readHandler) - waitsFor 'read handler', -> - readHandler.callCount > 0 - runs -> - expect(readHandler.argsForCall[0][0]).toBe(null) - - describe 'writeSync()', -> - it 'emits did-change event', -> - file.onDidChange writeHandler = jasmine.createSpy('write handler') - file.writeSync('ok') - waitsFor 'write handler', -> - writeHandler.callCount > 0 diff --git a/spec/file-spec.js b/spec/file-spec.js new file mode 100644 index 0000000..8437630 --- /dev/null +++ b/spec/file-spec.js @@ -0,0 +1,570 @@ +const path = require('path'); +const fs = require('fs-plus'); +const temp = require('temp'); +const File = require('../src/file'); +const PathWatcher = require('../src/main'); + +describe('File', () => { + let filePath; + let file; + + beforeEach(() => { + // Don't put in /tmp because /tmp symlinks to /private/tmp and screws up + // the rename test + filePath = path.join(__dirname, 'fixtures', 'file-test.txt'); + fs.removeSync(filePath); + fs.writeFileSync(filePath, 'this is old!'); + file = new File(filePath); + }); + + afterEach(async () => { + file.unsubscribeFromNativeChangeEvents(); + fs.removeSync(filePath); + PathWatcher.closeAllWatchers(); + // Without a brief pause between tests, events from previous tests can echo + // into the current ones. + await wait(50); + }); + + it('normalizes the specified path', () => { + let fileName = path.join(__dirname, 'fixtures', 'abc', '..', 'file-test.txt'); + let f = new File(fileName); + + expect(f.getBaseName()).toBe('file-test.txt'); + expect(f.path.toLowerCase()).toBe(file.path.toLowerCase()); + }); + + it('returns true from isFile()', () => { + expect(file.isFile()).toBe(true); + }); + + it('returns false from isDirectory()', () => { + expect(file.isDirectory()).toBe(false); + }); + + describe('::isSymbolicLink', () => { + it('returns false for regular files', () => { + expect(file.isSymbolicLink()).toBe(false); + }); + + it('returns true for symlinked files', () => { + let symbolicFile = new File(filePath, true); + expect(symbolicFile.isSymbolicLink()).toBe(true); + }); + }); + + describe('::getDigestSync', () => { + it('computes and returns the SHA-1 digest and caches it', () => { + filePath = path.join(temp.mkdirSync('node-pathwatcher-directory'), 'file.txt'); + fs.writeFileSync(filePath, ''); + file = new File(filePath); + spyOn(file, 'readSync').and.callThrough(); + + expect( + file.getDigestSync() + ).toBe('da39a3ee5e6b4b0d3255bfef95601890afd80709'); + expect(file.readSync.calls.count()).toBe(1); + expect( + file.getDigestSync() + ).toBe('da39a3ee5e6b4b0d3255bfef95601890afd80709'); + expect(file.readSync.calls.count()).toBe(1); + + file.writeSync('x'); + + expect( + file.getDigestSync() + ).toBe('11f6ad8ec52a2984abaafd7c3b516503785c2072'); + expect(file.readSync.calls.count()).toBe(1); + expect( + file.getDigestSync() + ).toBe('11f6ad8ec52a2984abaafd7c3b516503785c2072'); + expect(file.readSync.calls.count()).toBe(1); + }); + }); + + describe('::create()', () => { + let nonExistentFile; + let tempDir; + + beforeEach(() => { + tempDir = temp.mkdirSync('node-pathwatcher-directory'); + }); + + afterEach(() => { + nonExistentFile?.unsubscribeFromNativeChangeEvents(); + if (nonExistentFile?.getPath()) { + fs.removeSync(nonExistentFile?.getPath()); + } + }); + + it('creates file in directory if file does not exist', async () => { + fileName = path.join(tempDir, 'file.txt'); + expect(fs.existsSync(fileName)).toBe(false); + nonExistentFile = new File(fileName); + + let didCreate = await nonExistentFile.create(); + expect(didCreate).toBe(true); + expect(fs.existsSync(fileName)).toBe(true); + expect(fs.isFileSync(fileName)).toBe(true); + expect(fs.readFileSync(fileName).toString()).toBe(''); + }); + + it('leaves existing file alone if it exists', async () => { + fileName = path.join(tempDir, 'file.txt'); + fs.writeFileSync(fileName, 'foo'); + let existingFile = new File(fileName); + + let didCreate = await existingFile.create(); + expect(didCreate).toBe(false); + expect(fs.existsSync(fileName)).toBe(true); + expect(fs.isFileSync(fileName)).toBe(true); + expect(fs.readFileSync(fileName).toString()).toBe('foo'); + }); + + it('creates parent directories and files if they do not exist', async () => { + fileName = path.join(tempDir, 'foo', 'bar', 'file.txt'); + expect(fs.existsSync(fileName)).toBe(false); + nonExistentFile = new File(fileName); + + let didCreate = await nonExistentFile.create(); + expect(didCreate).toBe(true); + expect(fs.existsSync(fileName)).toBe(true); + expect(fs.isFileSync(fileName)).toBe(true); + + let parentName = path.join(tempDir, 'foo', 'bar'); + expect(fs.existsSync(parentName)).toBe(true); + expect(fs.isDirectorySync(parentName)).toBe(true); + }); + }); + + describe('when the file has not been read', () => { + describe('when the contents of the file change', () => { + it('notifies ::onDidChange observers', async () => { + let spy = jasmine.createSpy('changeHandler'); + let [promise, changeHandler] = makePromiseCallback(spy) + file.onDidChange(changeHandler); + fs.writeFileSync(file.getPath(), 'this is new!'); + await promise; + expect(spy.calls.count()).toBe(1); + }); + }); + + describe('when the contents of the file are deleted', () => { + it('notifies ::onDidChange observers', async () => { + let spy = jasmine.createSpy('changeHandler'); + let [promise, changeHandler] = makePromiseCallback(spy) + file.onDidChange(changeHandler); + fs.writeFileSync(file.getPath(), ''); + await promise; + expect(spy.calls.count()).toBe(1); + }); + }); + }); + + // Since all `NativeWatcher` instance watch directories, two different + // `PathWatcher` instances for two different files in the same directory will + // end up sharing a `NativeWatcher`. This test ensures that `PathWatcher`s + // know how to tell their own events apart from those of others. + describe('when a native watcher is shared by several PathWatchers', () => { + let siblingPath = path.join(__dirname, 'fixtures', 'file-test-a.txt'); + let siblingFile = new File(siblingPath); + beforeEach(() => { + if (!fs.existsSync(siblingPath)) { + fs.writeFileSync(siblingPath, 'initial'); + } + }); + + afterEach(() => { + if (fs.existsSync(siblingPath)) { + fs.rmSync(siblingPath); + } + }) + + it('does not cross-fire events', async () => { + let changeHandler1 = jasmine.createSpy('originalChangeHandler'); + file.onDidChange(changeHandler1); + await wait(100); + + let changeHandler2 = jasmine.createSpy('siblingChangeHandler'); + siblingFile.onDidChange(changeHandler2); + + await wait(100); + fs.writeFileSync(siblingPath, 'changed!'); + + await condition(() => changeHandler2.calls.count() > 0); + expect(changeHandler1).not.toHaveBeenCalled(); + }); + }); + + if (process.platform === 'darwin') { + describe('when the file has already been read', () => { + beforeEach(() => file.readSync()); + + describe('when the contents of the file change', () => { + it('notifies ::onDidChange observers', async () => { + let lastText = null; + + file.onDidChange(async () => { + lastText = await file.read(); + }); + + fs.writeFileSync(file.getPath(), 'this is new!'); + await condition(() => lastText === 'this is new!'); + expect(file.readSync()).toBe('this is new!'); + + fs.writeFileSync(file.getPath(), 'this is newer!'); + await condition(() => lastText === 'this is newer!'); + expect(file.readSync()).toBe('this is newer!'); + }); + }) + }); + + describe('when the file is deleted', () => { + it('notifies ::onDidDelete observers', async () => { + let deleteHandler = jasmine.createSpy('deleteHandler'); + file.onDidDelete(deleteHandler); + fs.removeSync(file.getPath()); + + await condition(() => deleteHandler.calls.count() > 0); + }); + }); + + describe('when a file is moved (via the filesystem)', () => { + let newPath = null; + + beforeEach(async () => { + newPath = path.join(path.dirname(filePath), 'file-was-moved-test.txt'); + }); + + afterEach(async () => { + if (!fs.existsSync(newPath)) return; + if (file.getPath() !== newPath) { + fs.removeSync(newPath); + return; + } + let deleteHandler = jasmine.createSpy('deleteHandler'); + file.onDidDelete(deleteHandler); + fs.removeSync(newPath); + await condition(() => deleteHandler.calls.count() > 0, 30000); + }); + + it('updates its path', async () => { + let moveHandler = jasmine.createSpy('moveHandler'); + file.onDidRename(moveHandler); + + await wait(1000); + fs.moveSync(filePath, newPath); + await condition(() => moveHandler.calls.count() > 0); + + expect(file.getPath()).toBe(newPath); + }); + + it('maintains ::onDidChange observers that were subscribed on the previous path', async () => { + let moveHandler = jasmine.createSpy('moveHandler'); + + file.onDidRename(moveHandler); + + + let changeHandler = jasmine.createSpy('changeHandler'); + file.onDidChange(changeHandler); + + fs.moveSync(filePath, newPath); + + await condition(() => moveHandler.calls.count() > 0); + expect(changeHandler).not.toHaveBeenCalled(); + + fs.writeFileSync(file.getPath(), 'this is new!'); + changeHandler.calls.reset(); + + await condition(() => changeHandler.calls.count() > 0); + }); + }); + + describe('when a file is deleted and then recreated within a small amount of time (git sometimes does this)', () => { + it('triggers a contents-changed event if the contents change', async () => { + let changeHandler = jasmine.createSpy('file changed'); + let deleteHandler = jasmine.createSpy('file deleted'); + file.onDidChange(changeHandler); + file.onDidDelete(deleteHandler); + + expect(changeHandler).not.toHaveBeenCalled(); + fs.removeSync(filePath); + expect(changeHandler).not.toHaveBeenCalled(); + + await wait(20); + + expect(changeHandler).not.toHaveBeenCalled(); + + fs.writeFileSync(filePath, 'HE HAS RISEN!'); + + await condition(() => changeHandler.calls.count() > 0); + + expect(deleteHandler).not.toHaveBeenCalled(); + fs.writeFileSync(filePath, 'Hallelujah!'); + changeHandler.calls.reset(); + + await condition(() => changeHandler.calls.count() > 0); + }); + }); + + describe('when a file is moved to the trash', () => { + const MACOS_TRASH_DIR = path.join(process.env.HOME, '.Trash'); + let expectedTrashPath = path.join( + MACOS_TRASH_DIR, + `file-was-moved-to-trash-${Math.round(Math.random() * 1000)}.txt` + ); + + it('triggers a delete event', async () => { + let deleteHandler = jasmine.createSpy('deleteHandler'); + file.onDidDelete(deleteHandler); + + fs.moveSync(filePath, expectedTrashPath); + + await condition(() => deleteHandler.calls.count() > 0); + + if (fs.existsSync(expectedTrashPath)) { + fs.removeSync(expectedTrashPath); + } + }); + }); + + // NOTE: We used to have tests for the ` onWillThrowWatchError` callback, + // but that callback was made a no-op many years ago. This seems to have + // been done for performance reasons, since there is no practical way to + // detect errors of the sort that were thrown via `onWillThrowWatchError` + // without re-reading the entire file whenever a change is detected. + + + } // end darwin-only tests + + describe('::getRealPathSync', () => { + let tempDir; + + beforeEach(() => { + tempDir = temp.mkdirSync('node-pathwatcher-directory'); + fs.writeFileSync(path.join(tempDir, 'file'), ''); + fs.writeFileSync(path.join(tempDir, 'file2'), ''); + }); + + it('returns the resolved path to the file', () => { + let tempFile = new File(path.join(tempDir, 'file')); + expect( + tempFile.getRealPathSync() + ).toBe( + fs.realpathSync(path.join(tempDir, 'file')) + ); + + tempFile.setPath(path.join(tempDir, 'file2')); + expect( + tempFile.getRealPathSync() + ).toBe( + fs.realpathSync(path.join(tempDir, 'file2')) + ); + }); + }); + + describe('::exists', () => { + let tempDir; + + beforeEach(() => { + tempDir = temp.mkdirSync('node-pathwatcher-directory'); + fs.writeFileSync(path.join(tempDir, 'file'), ''); + }); + + it('does actually exist', async () => { + let existingFile = new File(path.join(tempDir, 'file')); + let exists = await existingFile.exists(); + expect(exists).toBe(true); + }); + + it('doesn’t exist', async () => { + let nonExistentFile = new File(path.join(tempDir, 'not_file')); + let exists = await nonExistentFile.exists(); + expect(exists).toBe(false); + }); + }); + + describe('::getRealPath', () => { + let tempDir; + + beforeEach(() => { + tempDir = temp.mkdirSync('node-pathwatcher-directory'); + fs.writeFileSync(path.join(tempDir, 'file'), ''); + fs.writeFileSync(path.join(tempDir, 'file2'), ''); + }); + + it('returns the resolved path to the file', async () => { + let tempFile = new File(path.join(tempDir, 'file')); + expect( + await tempFile.getRealPath() + ).toBe( + fs.realpathSync(path.join(tempDir, 'file')) + ); + }); + + it('returns the resolved path to the file after a call to setPath', async () => { + let tempFile = new File(path.join(tempDir, 'file')); + tempFile.setPath(path.join(tempDir, 'file2')); + expect( + await tempFile.getRealPath() + ).toBe( + fs.realpathSync(path.join(tempDir, 'file2')) + ); + }); + + if (process.platform !== 'win32') { + describe('on #darwin and #linux', () => { + it('returns the target path for symlinks', async () => { + fs.symlinkSync( + path.join(tempDir, 'file2'), + path.join(tempDir, 'file3') + ); + let tempFile = new File(path.join(tempDir, 'file3')); + expect( + await tempFile.getRealPath() + ).toBe( + fs.realpathSync(path.join(tempDir, 'file2')) + ); + }); + }); + } + }); + + describe('::getParent', () => { + it('gets the parent directory', () => { + expect( + file.getParent().getRealPathSync() + ).toBe( + path.join(__dirname, 'fixtures') + ); + }); + }); + + describe('encoding', () => { + it('should be utf8 by default', () => { + expect(file.getEncoding()).toBe('utf8'); + }); + + it('should be settable', () => { + file.setEncoding('cp1252'); + expect(file.getEncoding()).toBe('cp1252'); + }); + + it('throws an exception when assigning an invalid encoding', () => { + expect(() => { + file.setEncoding('utf-8-bom'); + }).toThrow(); + }); + }) + + describe('::createReadStream', () => { + it('returns a stream to read the file', async () => { + let stream = file.createReadStream(); + let ended = false; + let content = []; + + stream.on('data', (chunk) => content.push(chunk)); + stream.on('end', () => ended = true); + + await condition(() => ended); + + expect(content.join('')).toEqual('this is old!'); + }); + + it('honors the specified encoding', async () => { + let unicodeText = 'ё'; + let unicodeBytes = Buffer.from('\x51\x04') // 'ё' + + fs.writeFileSync(file.getPath(), unicodeBytes); + + file.setEncoding('utf16le'); + + let stream = file.createReadStream(); + let ended = false; + let content = []; + + stream.on('data', (chunk) => content.push(chunk)); + stream.on('end', () => ended = true); + + await condition(() => ended); + expect(content.join('')).toEqual(unicodeText); + }); + }); + + describe('::createWriteStream', () => { + it('returns a stream to read the file', async () => { + let unicodeText = 'ё'; + let unicodeBytes = Buffer.from('\x51\x04') // 'ё' + + file.setEncoding('utf16le'); + + let stream = file.createWriteStream(); + let ended = false; + stream.on('finish', () => ended = true); + + stream.end(unicodeText); + await condition(() => ended); + expect(fs.statSync(file.getPath()).size).toBe(2); + let content = fs.readFileSync(file.getPath()).toString('ascii'); + expect(content).toBe(unicodeBytes.toString('ascii')); + }); + }); + + describe('encoding support', () => { + let unicodeText; + let unicodeBytes; + + beforeEach(() => { + unicodeText = 'ё'; + unicodeBytes = Buffer.from('\x51\x04') // 'ё' + }); + + it('should read a file in UTF-16', async () => { + fs.writeFileSync(file.getPath(), unicodeBytes); + file.setEncoding('utf16le'); + + let contents = await file.read(); + expect(contents).toBe(unicodeText); + }); + + it('should readSync a file in UTF-16', () => { + fs.writeFileSync(file.getPath(), unicodeBytes); + file.setEncoding('utf16le'); + expect(file.readSync()).toBe(unicodeText); + }); + + it('should write a file in UTF-16', async () => { + file.setEncoding('utf16le'); + await file.write(unicodeText); + expect(fs.statSync(file.getPath()).size).toBe(2); + let content = fs.readFileSync(file.getPath()).toString('ascii'); + expect(content).toBe(unicodeBytes.toString('ascii')); + }); + + it('should writeSync a file in UTF-16', () => { + file.setEncoding('utf16le'); + file.writeSync(unicodeText); + expect(fs.statSync(file.getPath()).size).toBe(2); + let content = fs.readFileSync(file.getPath()).toString('ascii'); + expect(content).toBe(unicodeBytes.toString('ascii')); + }); + }); + + describe('reading a nonexistent file', () => { + it('should return null', async () => { + file = new File('not_existing.txt'); + expect( + await file.read() + ).toBe(null); + }); + }); + + describe('::writeSync', () => { + it('emits did-change event', async () => { + let handler = jasmine.createSpy('write handler'); + file.onDidChange(handler); + file.writeSync('ok'); + await condition(() => handler.calls.count() > 0); + }); + }); +}); diff --git a/spec/helpers/all.js b/spec/helpers/all.js new file mode 100644 index 0000000..f312e3b --- /dev/null +++ b/spec/helpers/all.js @@ -0,0 +1,37 @@ +// jasmine.getEnv().setIncludedTags([process.platform]); + +global.makePromiseCallback = function makePromiseCallback(fn = () => {}) { + let outerResolve; + let promise = new Promise((resolve) => { + outerResolve = resolve; + }); + + let callback = (...args) => { + fn(...args); + outerResolve(); + }; + + return [promise, callback]; +} + +function timeoutPromise (ms) { + return new Promise((_, reject) => setTimeout(reject, ms)); +} + +global.condition = function condition(fn, timeoutMs = 5000) { + let promise = new Promise((resolve) => { + let poll = () => { + let outcome = fn(); + if (outcome) resolve(); + setTimeout(poll, 50); + }; + poll(); + }); + + return Promise.race([promise, timeoutPromise(timeoutMs)]); +}; + + +global.wait = function wait(ms) { + return new Promise(resolve => setTimeout(resolve, ms)); +}; diff --git a/spec/pathwatcher-spec.coffee b/spec/pathwatcher-spec.coffee deleted file mode 100644 index f57c758..0000000 --- a/spec/pathwatcher-spec.coffee +++ /dev/null @@ -1,167 +0,0 @@ -pathWatcher = require '../lib/main' -fs = require 'fs' -path = require 'path' -temp = require 'temp' - -temp.track() - -describe 'PathWatcher', -> - tempDir = temp.mkdirSync('node-pathwatcher-directory') - tempFile = path.join(tempDir, 'file') - - beforeEach -> - fs.writeFileSync(tempFile, '') - - afterEach -> - pathWatcher.closeAllWatchers() - - describe '.getWatchedPaths()', -> - it 'returns an array of all watched paths', -> - expect(pathWatcher.getWatchedPaths()).toEqual [] - watcher1 = pathWatcher.watch tempFile, -> - expect(pathWatcher.getWatchedPaths()).toEqual [watcher1.handleWatcher.path] - watcher2 = pathWatcher.watch tempFile, -> - expect(pathWatcher.getWatchedPaths()).toEqual [watcher1.handleWatcher.path] - watcher1.close() - expect(pathWatcher.getWatchedPaths()).toEqual [watcher1.handleWatcher.path] - watcher2.close() - expect(pathWatcher.getWatchedPaths()).toEqual [] - - describe '.closeAllWatchers()', -> - it 'closes all watched paths', -> - expect(pathWatcher.getWatchedPaths()).toEqual [] - watcher = pathWatcher.watch tempFile, -> - expect(pathWatcher.getWatchedPaths()).toEqual [watcher.handleWatcher.path] - pathWatcher.closeAllWatchers() - expect(pathWatcher.getWatchedPaths()).toEqual [] - - describe 'when a watched path is changed', -> - it 'fires the callback with the event type and empty path', -> - eventType = null - eventPath = null - watcher = pathWatcher.watch tempFile, (type, path) -> - eventType = type - eventPath = path - - fs.writeFileSync(tempFile, 'changed') - waitsFor -> eventType? - runs -> - expect(eventType).toBe 'change' - expect(eventPath).toBe '' - - describe 'when a watched path is renamed #darwin #win32', -> - it 'fires the callback with the event type and new path and watches the new path', -> - eventType = null - eventPath = null - watcher = pathWatcher.watch tempFile, (type, path) -> - eventType = type - eventPath = path - - tempRenamed = path.join(tempDir, 'renamed') - fs.renameSync(tempFile, tempRenamed) - waitsFor -> eventType? - runs -> - expect(eventType).toBe 'rename' - expect(fs.realpathSync(eventPath)).toBe fs.realpathSync(tempRenamed) - expect(pathWatcher.getWatchedPaths()).toEqual [watcher.handleWatcher.path] - - describe 'when a watched path is deleted #win32 #darwin', -> - it 'fires the callback with the event type and null path', -> - deleted = false - watcher = pathWatcher.watch tempFile, (type, path) -> - deleted = true if type is 'delete' and path is null - - fs.unlinkSync(tempFile) - waitsFor -> deleted - - describe 'when a file under watched directory is deleted', -> - it 'fires the callback with the change event and empty path', (done) -> - fileUnderDir = path.join(tempDir, 'file') - fs.writeFileSync(fileUnderDir, '') - watcher = pathWatcher.watch tempDir, (type, path) -> - expect(type).toBe 'change' - expect(path).toBe '' - done() - fs.unlinkSync(fileUnderDir) - - describe 'when a new file is created under watched directory', -> - it 'fires the callback with the change event and empty path', -> - newFile = path.join(tempDir, 'file') - watcher = pathWatcher.watch tempDir, (type, path) -> - fs.unlinkSync(newFile) - - expect(type).toBe 'change' - expect(path).toBe '' - done() - fs.writeFileSync(newFile, '') - - describe 'when a file under watched directory is moved', -> - it 'fires the callback with the change event and empty path', (done) -> - newName = path.join(tempDir, 'file2') - watcher = pathWatcher.watch tempDir, (type, path) -> - expect(type).toBe 'change' - expect(path).toBe '' - done() - fs.renameSync(tempFile, newName) - - describe 'when en exception is thrown in the closed watcher\'s callback', -> - it 'does not crash', (done) -> - watcher = pathWatcher.watch tempFile, (type, path) -> - watcher.close() - try - throw new Error('test') - catch e - done() - fs.writeFileSync(tempFile, 'changed') - - describe 'when watching a file that does not exist', -> - it 'throws an error with a code #darwin #linux', -> - doesNotExist = path.join(tempDir, 'does-not-exist') - watcher = null - try - watcher = pathWatcher.watch doesNotExist, -> null - catch error - expect(error.message).toBe 'Unable to watch path' - expect(error.code).toBe 'ENOENT' - expect(watcher).toBe null # ensure it threw - - describe 'when watching multiple files under the same directory', -> - it 'fires the callbacks when both of the files are modifiled', -> - called = 0 - tempFile2 = path.join(tempDir, 'file2') - fs.writeFileSync(tempFile2, '') - pathWatcher.watch tempFile, (type, path) -> - called |= 1 - pathWatcher.watch tempFile2, (type, path) -> - called |= 2 - fs.writeFileSync(tempFile, 'changed') - fs.writeFileSync(tempFile2, 'changed') - waitsFor -> called == 3 - - it 'shares the same handle watcher between the two files on #win32', -> - tempFile2 = path.join(tempDir, 'file2') - fs.writeFileSync(tempFile2, '') - watcher1 = pathWatcher.watch tempFile, (type, path) -> - watcher2 = pathWatcher.watch tempFile2, (type, path) -> - expect(watcher1.handleWatcher).toBe(watcher2.handleWatcher) - - describe 'when a file is unwatched', -> - it 'it does not lock the filesystem tree', -> - nested1 = path.join(tempDir, 'nested1') - nested2 = path.join(nested1, 'nested2') - nested3 = path.join(nested2, 'nested3') - fs.mkdirSync(nested1) - fs.mkdirSync(nested2) - fs.writeFileSync(nested3) - - subscription1 = pathWatcher.watch nested1, -> - subscription2 = pathWatcher.watch nested2, -> - subscription3 = pathWatcher.watch nested3, -> - - subscription1.close() - subscription2.close() - subscription3.close() - - fs.unlinkSync(nested3) - fs.rmdirSync(nested2) - fs.rmdirSync(nested1) diff --git a/spec/pathwatcher-spec.js b/spec/pathwatcher-spec.js new file mode 100644 index 0000000..edc61a4 --- /dev/null +++ b/spec/pathwatcher-spec.js @@ -0,0 +1,305 @@ +const PathWatcher = require('../src/main'); +const fs = require('fs-plus'); +const path = require('path'); +const temp = require('temp'); + +temp.track(); + +function EMPTY() {} + +describe('PathWatcher', () => { + let tempDir = temp.mkdirSync('node-pathwatcher-directory'); + let tempFile = path.join(tempDir, 'file'); + + beforeEach(() => fs.writeFileSync(tempFile, '')); + afterEach(async () => { + PathWatcher.closeAllWatchers(); + // Allow time in between each spec so that file-watchers have a chance to + // clean up. + await wait(100); + }); + + describe('getWatchedPaths', () => { + it('returns an array of all watched paths', () => { + let realTempFilePath = fs.realpathSync(tempFile); + let expectedWatchPath = path.dirname(realTempFilePath); + + expect(PathWatcher.getWatchedPaths()).toEqual([]); + + // Watchers watch the parent directory. + let watcher1 = PathWatcher.watch(tempFile, EMPTY); + expect(PathWatcher.getWatchedPaths()).toEqual([expectedWatchPath]); + + // Second watcher is a sibling of the first and should be able to reuse + // the existing watcher. + let watcher2 = PathWatcher.watch(tempFile, EMPTY); + expect(PathWatcher.getWatchedPaths()).toEqual([expectedWatchPath]); + watcher1.close(); + + // Native watcher won't close yet because it knows it had two listeners. + expect(PathWatcher.getWatchedPaths()).toEqual([expectedWatchPath]); + watcher2.close(); + + expect(PathWatcher.getWatchedPaths()).toEqual([]); + }); + }); + + describe('closeAllWatchers', () => { + it('closes all watched paths', () => { + let realTempFilePath = fs.realpathSync(tempFile); + let expectedWatchPath = path.dirname(realTempFilePath); + expect(PathWatcher.getWatchedPaths()).toEqual([]); + PathWatcher.watch(tempFile, EMPTY); + expect(PathWatcher.getWatchedPaths()).toEqual([expectedWatchPath]); + PathWatcher.closeAllWatchers(); + expect(PathWatcher.getWatchedPaths()).toEqual([]); + }); + }); + + // The purpose of this `describe` block is to ensure that our custom FSEvent + // implementation on macOS agrees with the built-in `efsw` implementations on + // Windows and Linux. + // + // Notably: in order to behave predictably, the FSEvent watcher should not + // trigger a watcher on `/foo/bar/baz` when `/foo/bar/baz` itself is deleted, + // since that’s how the other watcher implementations behave. + describe('when a watched directory is deleted', () => { + let subDir; + beforeEach(() => { + subDir = path.join(tempDir, 'subdir'); + if (!fs.existsSync(subDir)) { + fs.mkdirSync(subDir); + } + }); + + afterEach(() => { + if (subDir && fs.existsSync(subDir)) { + fs.rmSync(subDir, { recursive: true }); + } + }); + + it('does not trigger the callback', async () => { + // This test proves that `efsw` does not detect when a directory is + // deleted if you are watching that exact path. Our custom macOS + // implementation should behave the same way for predictability. + let innerSpy = jasmine.createSpy('innerSpy'); + PathWatcher.watch(subDir, innerSpy); + await wait(20); + fs.rmSync(subDir, { recursive: true }); + await wait(200); + expect(innerSpy).not.toHaveBeenCalled(); + }); + + it('triggers a callback on the directory’s parent if the parent is being watched', async () => { + // We can detect the directory’s deletion if we watch its parent + // directory. + // + // This test proves that, but it also proves that a watcher on the + // deleted directory is still not invoked in this scenario. This was a + // specific scenario I tried to handle and this test proves that said + // workaround is not present. + let outerSpy = jasmine.createSpy('outerSpy'); + let innerSpy = jasmine.createSpy('innerSpy'); + PathWatcher.watch(tempDir, outerSpy); + PathWatcher.watch(subDir, innerSpy); + await wait(20); + fs.rmSync(subDir, { recursive: true }); + await condition(() => outerSpy.calls.count() > 0); + await wait(200); + expect(innerSpy).not.toHaveBeenCalled(); + }); + }); + + describe('when a watched path is changed', () => { + it('fires the callback with the event type and empty path', async () => { + let eventType; + let eventPath; + + PathWatcher.watch(tempFile, (type, path) => { + eventType = type; + eventPath = path; + }); + + fs.writeFileSync(tempFile, 'changed'); + + await condition(() => !!eventType); + + expect(eventType).toBe('change'); + expect(eventPath).toBe(''); + }); + }); + + + if (process.platform !== 'linux') { + describe('when a watched path is renamed #darwin #win32', () => { + it('fires the callback with the event type and new path and watches the new path', async () => { + let eventType; + let eventPath; + + let watcher = PathWatcher.watch(tempFile, (type, path) => { + eventType = type; + eventPath = path; + }); + + let tempRenamed = path.join(tempDir, 'renamed'); + fs.renameSync(tempFile, tempRenamed); + + await condition(() => !!eventType); + + expect(eventType).toBe('rename'); + expect(fs.realpathSync(eventPath)).toBe(fs.realpathSync(tempRenamed)); + expect(PathWatcher.getWatchedPaths()).toEqual([watcher.native.path]); + }); + }); + + describe('when a watched path is deleted #darwin #win32', () => { + it('fires the callback with the event type and null path', async () => { + let deleted = false; + + PathWatcher.watch(tempFile, (type, path) => { + if (type === 'delete' && path === null) { + deleted = true; + } + }); + + fs.unlinkSync(tempFile); + await condition(() => deleted); + }); + }); + } + + describe('when a file under a watched directory is deleted', () => { + it('fires the callback with the change event and empty path', async () => { + let fileUnderDir = path.join(tempDir, 'file'); + fs.writeFileSync(fileUnderDir, ''); + let done = false; + + PathWatcher.watch(tempDir, (type, path) => { + expect(type).toBe('change'); + expect(path).toBe(''); + done = true; + }); + + fs.writeFileSync(fileUnderDir, 'what'); + await wait(200); + fs.unlinkSync(fileUnderDir); + await condition(() => done); + }); + }); + + describe('when a new file is created under a watched directory', () => { + it('fires the callback with the change event and empty path', async () => { + let newFile = path.join(tempDir, 'file'); + if (fs.existsSync(newFile)) { + fs.unlinkSync(newFile); + } + let done = false; + PathWatcher.watch(tempDir, (type, path) => { + if (fs.existsSync(newFile)) { + fs.unlinkSync(newFile); + } + expect(type).toBe('change'); + expect(path).toBe(''); + done = true; + }); + + fs.writeFileSync(newFile, 'x'); + await condition(() => done); + }); + }); + + describe('when a file under a watched directory is moved', () => { + it('fires the callback with the change event and empty path', async () => { + + let newName = path.join(tempDir, 'file2'); + let done = false; + PathWatcher.watch(tempDir, (type, path) => { + expect(type).toBe('change'); + expect(path).toBe(''); + done = true; + }); + + fs.renameSync(tempFile, newName); + await condition(() => done); + }); + }); + + describe('when an exception is thrown in the closed watcher’s callback', () => { + it('does not crash', async () => { + let done = false; + let watcher = PathWatcher.watch(tempFile, (_type, _path) => { + watcher.close(); + try { + throw new Error('test'); + } catch (e) { + done = true; + } + }); + + fs.writeFileSync(tempFile, 'changed'); + await condition(() => done); + }); + }); + + if (process.platform !== 'win32') { + describe('when watching a file that does not exist', () => { + it('throws an error with a code #darwin #linux', () => { + let doesNotExist = path.join(tempDir, 'does-not-exist'); + let watcher; + try { + watcher = PathWatcher.watch(doesNotExist, EMPTY); + } catch (error) { + expect(error.message).toBe('Unable to watch path'); + expect(error.code).toBe('ENOENT'); + } + expect(watcher).toBe(undefined); // (ensure it threw) + }); + }); + } + + describe('when watching multiple files under the same directory', () => { + it('fires the callbacks when both of the files are modified', async () => { + let called = 0; + let tempFile2 = path.join(tempDir, 'file2'); + fs.writeFileSync(tempFile2, ''); + PathWatcher.watch(tempFile, () => called |= 1); + PathWatcher.watch(tempFile2, () => called |= 2); + fs.writeFileSync(tempFile, 'changed'); + fs.writeFileSync(tempFile2, 'changed'); + await condition(() => called === 3); + }); + + if (process.platform === 'win32') { + it('shares the same handle watcher between the two files on #win32', () => { + let tempFile2 = path.join(tempDir, 'file2'); + fs.writeFileSync(tempFile2, ''); + let watcher1 = PathWatcher.watch(tempFile, EMPTY); + let watcher2 = PathWatcher.watch(tempFile2, EMPTY); + expect(watcher1.native).toBe(watcher2.native); + }); + } + }); + + describe('when a file is unwatched', () => { + it('does not lock the file system tree', () => { + let nested1 = path.join(tempDir, 'nested1'); + let nested2 = path.join(nested1, 'nested2'); + let nested3 = path.join(nested2, 'nested3'); + fs.mkdirSync(nested1); + fs.mkdirSync(nested2); + fs.writeFileSync(nested3, ''); + + let subscription1 = PathWatcher.watch(nested1, EMPTY); + let subscription2 = PathWatcher.watch(nested2, EMPTY); + let subscription3 = PathWatcher.watch(nested3, EMPTY); + + subscription1.close(); + subscription2.close(); + subscription3.close(); + + fs.unlinkSync(nested3); + fs.rmdirSync(nested2); + fs.rmdirSync(nested1); + }); + }); +}); diff --git a/spec/run.js b/spec/run.js new file mode 100644 index 0000000..afb10ab --- /dev/null +++ b/spec/run.js @@ -0,0 +1,39 @@ +// This script exists so that we can add some extra logic that runs once the +// suite has finished. This is necessary so that we can detect when the task +// fails to finish (perhaps because of an open handle somewhere) and prevent +// it from running in CI for hours while doing nothing. +const Path = require('path'); +const Jasmine = require('jasmine'); +const jasmine = new Jasmine(); + +// Load the config from the typical place
 +const CONFIG = require(Path.resolve(__dirname, 'support', 'jasmine.json')); + +// 
but still allow the user to override the standard suite of specs. +if (process.argv[2]) { + CONFIG.spec_files = [process.argv[2]]; +} +jasmine.loadConfig(CONFIG); + +// This value refers to the amount of time we allow the script to run _after_ +// the tests are done. +const MAX_DURATION_MS = 10 * 1000; + +function bail () { + console.error(`Script ran for more than ${MAX_DURATION_MS / 1000} seconds after the end of the suite; there's an open handle somewhere!`); + process.exit(2); +} + +// Theory: the indefinite waiting that happens in CI sometimes might be the +// result of an open handle somewhere. If so, then the test task will keep +// running even though we haven't told Jasmine not to exit on completion. This +// approach might detect such scenarios and turn them into CI failures. +(async () => { + await jasmine.execute(); + // Wait to see if the script is still running MAX_DURATION milliseconds from + // now
 + let failsafe = setTimeout(bail, MAX_DURATION_MS); + // 
but `unref` ourselves so that we're not the reason why the script keeps + // running! + failsafe.unref(); +})(); diff --git a/spec/spec-helper.coffee b/spec/spec-helper.coffee deleted file mode 100644 index fccfadc..0000000 --- a/spec/spec-helper.coffee +++ /dev/null @@ -1,28 +0,0 @@ -jasmine.getEnv().setIncludedTags([process.platform]) - -global.waitsForPromise = (args...) -> - if args.length > 1 - {shouldReject} = args[0] - else - shouldReject = false - fn = args[args.length - 1] - - promiseFinished = false - - process.nextTick -> - promise = fn() - if shouldReject - promise.catch -> - promiseFinished = true - promise.then -> - jasmine.getEnv().currentSpec.fail("Expected promise to be rejected, but it was resolved") - promiseFinished = true - else - promise.then -> promiseFinished = true - promise.catch (error) -> - jasmine.getEnv().currentSpec.fail("Expected promise to be resolved, but it was rejected with #{jasmine.pp(error)}") - promiseFinished = true - - global.waitsFor "promise to complete", -> promiseFinished - -require('grim').includeDeprecatedAPIs = false diff --git a/spec/support/jasmine.json b/spec/support/jasmine.json new file mode 100644 index 0000000..a37a37e --- /dev/null +++ b/spec/support/jasmine.json @@ -0,0 +1,18 @@ +{ + "spec_dir": ".", + + "spec_files": [ + "spec/*-spec.js" + ], + + "helpers": [ + "spec/helpers/all.js" + ], + + "env": { + "failSpecWithNoExpectations": false, + "stopSpecOnExpectationFailure": false, + "stopOnSpecFailure": false, + "random": true + } +} diff --git a/spec/worker.js b/spec/worker.js new file mode 100644 index 0000000..ad5bc40 --- /dev/null +++ b/spec/worker.js @@ -0,0 +1,117 @@ +const { + Worker, isMainThread, parentPort, workerData +} = require('node:worker_threads'); +const { + performance +} = require('node:perf_hooks'); + +const temp = require('temp'); +const fs = require('fs'); +const path = require('path'); +const util = require('util'); + +const wait = util.promisify(setTimeout); + +const EXPECTED_CALL_COUNT = 3; + +if (isMainThread) { + module.exports = function spawnThread(index, indexOfEarlyReturn) { + let id = index + 1; + return new Promise(async (resolve, reject) => { + console.log('Spawning worker:', id); + const worker = new Worker(__filename, { + workerData: { id, earlyReturn: indexOfEarlyReturn === null ? false : id === (indexOfEarlyReturn + 1) }, + }); + worker.on('message', async (msg) => { + console.log('[parent] Worker', id, 'reported call count:', msg); + await wait(1000); + let expected = id === indexOfEarlyReturn + 1 ? (EXPECTED_CALL_COUNT - 1) : EXPECTED_CALL_COUNT; + let passes = msg >= expected; + if (passes) { + console.log(`Worker ${id} passed!`); + resolve(); + } else { + reject(`Not enough calls on worker ${id}! Expected: ${expected} Actual: ${msg}`); + } + }); + worker.on('error', (err) => { + console.error(`ERROR IN WORKER: ${id}`); + console.error(err); + reject(err); + }); + worker.on('exit', (code) => { + if (code !== 0) { + console.log(`Worker ${id} stopped with exit code ${code}`); + reject(); + } else { + console.log(`Worker ${id} exited gracefully`); + // resolve(); + } + }); + }); + }; +} else { + let tempDir = temp.mkdirSync('node-pathwatcher-directory'); + const tempFile = path.join(tempDir, 'file'); + + const { watch, closeAllWatchers } = require('../src/main'); + + console.log('NEW WORKER:', workerData); + + class Scheduler { + constructor(id, pathToWatch) { + this.id = id; + this.path = pathToWatch; + this.callCount = 0; + } + + async start () { + console.log('Scheduler', this.id, 'starting at', performance.now(), 'watching path:', this.path); + this.watcher = watch(this.path, (event) => { + this.callCount++; + console.warn('\x1b[33m%s\x1b[0m', 'PathWatcher event for worker', this.id, event) + console.log('callCount is now:', this.callCount); + }); + console.log('Scheduler', this.id, 'ready at:', performance.now()); + } + + stop () { + this.watcher?.close(); + } + } + + (async () => { + console.log('Worker', workerData.id, 'creating file:', tempFile); + fs.writeFileSync(tempFile, ''); + await wait(500); + const scheduler = new Scheduler(workerData.id, tempFile); + scheduler.start(); + await wait(2000); + + console.log('Worker', scheduler.id, 'changing file:', tempFile); + // Should generate one or two events: + fs.writeFileSync(tempFile, 'changed'); + await wait(1000); + console.log('Worker', scheduler.id, 'changing file again:', tempFile); + // Should generate another event: + fs.writeFileSync(tempFile, 'changed again'); + await wait(500); + if (workerData.earlyReturn) { + console.log('Worker', scheduler.id, 'returning early!'); + } else { + await wait(500); + // Should generate a final event (total count 3 or 4): + console.log('Worker', scheduler.id, 'deleting file:', tempFile); + fs.rmSync(tempFile); + await wait(1000); + + await wait(Math.random() * 2000); + } + + parentPort.postMessage(scheduler.callCount); + + closeAllWatchers(); + console.log('Worker', scheduler.id, 'closing'); + // process.exit(0); + })(); +} diff --git a/src/common.cc b/src/common.cc deleted file mode 100644 index b37c70c..0000000 --- a/src/common.cc +++ /dev/null @@ -1,169 +0,0 @@ -#include "common.h" - -static uv_async_t g_async; -static int g_watch_count; -static uv_sem_t g_semaphore; -static uv_thread_t g_thread; - -static EVENT_TYPE g_type; -static WatcherHandle g_handle; -static std::vector g_new_path; -static std::vector g_old_path; -static Nan::Persistent g_callback; - -static void CommonThread(void* handle) { - WaitForMainThread(); - PlatformThread(); -} - -#if NODE_VERSION_AT_LEAST(0, 11, 13) -static void MakeCallbackInMainThread(uv_async_t* handle) { -#else -static void MakeCallbackInMainThread(uv_async_t* handle, int status) { -#endif - Nan::HandleScope scope; - - if (!g_callback.IsEmpty()) { - Local type; - switch (g_type) { - case EVENT_CHANGE: - type = Nan::New("change").ToLocalChecked(); - break; - case EVENT_DELETE: - type = Nan::New("delete").ToLocalChecked(); - break; - case EVENT_RENAME: - type = Nan::New("rename").ToLocalChecked(); - break; - case EVENT_CHILD_CREATE: - type = Nan::New("child-create").ToLocalChecked(); - break; - case EVENT_CHILD_CHANGE: - type = Nan::New("child-change").ToLocalChecked(); - break; - case EVENT_CHILD_DELETE: - type = Nan::New("child-delete").ToLocalChecked(); - break; - case EVENT_CHILD_RENAME: - type = Nan::New("child-rename").ToLocalChecked(); - break; - default: - type = Nan::New("unknown").ToLocalChecked(); - return; - } - - Local argv[] = { - type, - WatcherHandleToV8Value(g_handle), - Nan::New(g_new_path.data(), g_new_path.size()).ToLocalChecked(), - Nan::New(g_old_path.data(), g_old_path.size()).ToLocalChecked(), - }; - Local context = Nan::GetCurrentContext(); - Nan::New(g_callback)->Call(context, context->Global(), 4, argv).ToLocalChecked(); - } - - WakeupNewThread(); -} - -static void SetRef(bool value) { - uv_handle_t* h = reinterpret_cast(&g_async); - if (value) { - uv_ref(h); - } else { - uv_unref(h); - } -} - -void CommonInit() { - uv_sem_init(&g_semaphore, 0); - uv_async_init(uv_default_loop(), &g_async, MakeCallbackInMainThread); - // As long as any uv_ref'd uv_async_t handle remains active, the node - // process will never exit, so we must call uv_unref here (#47). - SetRef(false); - g_watch_count = 0; - uv_thread_create(&g_thread, &CommonThread, NULL); -} - -void WaitForMainThread() { - uv_sem_wait(&g_semaphore); -} - -void WakeupNewThread() { - uv_sem_post(&g_semaphore); -} - -void PostEventAndWait(EVENT_TYPE type, - WatcherHandle handle, - const std::vector& new_path, - const std::vector& old_path) { - // FIXME should not pass args by settings globals. - g_type = type; - g_handle = handle; - g_new_path = new_path; - g_old_path = old_path; - - uv_async_send(&g_async); - WaitForMainThread(); -} - -NAN_METHOD(SetCallback) { - Nan::HandleScope scope; - - if (!info[0]->IsFunction()) - return Nan::ThrowTypeError("Function required"); - - g_callback.Reset(Local::Cast(info[0])); - return; -} - -NAN_METHOD(Watch) { - Nan::HandleScope scope; - - if (!info[0]->IsString()) - return Nan::ThrowTypeError("String required"); - - Local context = Nan::GetCurrentContext(); - Local path = info[0]->ToString(context).ToLocalChecked(); - WatcherHandle handle = PlatformWatch(*String::Utf8Value(v8::Isolate::GetCurrent(), path)); - if (!PlatformIsHandleValid(handle)) { - int error_number = PlatformInvalidHandleToErrorNumber(handle); - v8::Local err = - v8::Exception::Error(Nan::New("Unable to watch path").ToLocalChecked()); - v8::Local err_obj = err.As(); - if (error_number != 0) { - err_obj->Set(context, - Nan::New("errno").ToLocalChecked(), - Nan::New(error_number)).FromJust(); -#if NODE_VERSION_AT_LEAST(0, 11, 5) - // Node 0.11.5 is the first version to contain libuv v0.11.6, which - // contains https://github.com/libuv/libuv/commit/3ee4d3f183 which changes - // uv_err_name from taking a struct uv_err_t (whose uv_err_code `code` is - // a difficult-to-produce uv-specific errno) to just take an int which is - // a negative errno. - err_obj->Set(context, - Nan::New("code").ToLocalChecked(), - Nan::New(uv_err_name(-error_number)).ToLocalChecked()).FromJust(); -#endif - } - return Nan::ThrowError(err); - } - - if (g_watch_count++ == 0) - SetRef(true); - - info.GetReturnValue().Set(WatcherHandleToV8Value(handle)); -} - -NAN_METHOD(Unwatch) { - Nan::HandleScope scope; - - if (!IsV8ValueWatcherHandle(info[0])) - return Nan::ThrowTypeError("Local type required"); - - PlatformUnwatch(V8ValueToWatcherHandle(info[0])); - - if (--g_watch_count == 0) - SetRef(false); - - return; -} diff --git a/src/common.h b/src/common.h deleted file mode 100644 index 8f0d85f..0000000 --- a/src/common.h +++ /dev/null @@ -1,56 +0,0 @@ -#ifndef SRC_COMMON_H_ -#define SRC_COMMON_H_ - -#include - -#include "nan.h" -using namespace v8; - -#ifdef _WIN32 -// Platform-dependent definetion of handle. -typedef HANDLE WatcherHandle; - -// Conversion between V8 value and WatcherHandle. -Local WatcherHandleToV8Value(WatcherHandle handle); -WatcherHandle V8ValueToWatcherHandle(Local value); -bool IsV8ValueWatcherHandle(Local value); -#else -// Correspoding definetions on OS X and Linux. -typedef int32_t WatcherHandle; -#define WatcherHandleToV8Value(h) Nan::New(h) -#define V8ValueToWatcherHandle(v) v->Int32Value(Nan::GetCurrentContext()).FromJust() -#define IsV8ValueWatcherHandle(v) v->IsInt32() -#endif - -void PlatformInit(); -void PlatformThread(); -WatcherHandle PlatformWatch(const char* path); -void PlatformUnwatch(WatcherHandle handle); -bool PlatformIsHandleValid(WatcherHandle handle); -int PlatformInvalidHandleToErrorNumber(WatcherHandle handle); - -enum EVENT_TYPE { - EVENT_NONE, - EVENT_CHANGE, - EVENT_RENAME, - EVENT_DELETE, - EVENT_CHILD_CHANGE, - EVENT_CHILD_RENAME, - EVENT_CHILD_DELETE, - EVENT_CHILD_CREATE, -}; - -void WaitForMainThread(); -void WakeupNewThread(); -void PostEventAndWait(EVENT_TYPE type, - WatcherHandle handle, - const std::vector& new_path, - const std::vector& old_path = std::vector()); - -void CommonInit(); - -NAN_METHOD(SetCallback); -NAN_METHOD(Watch); -NAN_METHOD(Unwatch); - -#endif // SRC_COMMON_H_ diff --git a/src/directory.coffee b/src/directory.coffee deleted file mode 100644 index 513835e..0000000 --- a/src/directory.coffee +++ /dev/null @@ -1,334 +0,0 @@ -path = require 'path' - -async = require 'async' -{Emitter, Disposable} = require 'event-kit' -fs = require 'fs-plus' -Grim = require 'grim' - -File = require './file' -PathWatcher = require './main' - -# Extended: Represents a directory on disk that can be watched for changes. -module.exports = -class Directory - realPath: null - subscriptionCount: 0 - - ### - Section: Construction - ### - - # Public: Configures a new Directory instance, no files are accessed. - # - # * `directoryPath` A {String} containing the absolute path to the directory - # * `symlink` (optional) A {Boolean} indicating if the path is a symlink. - # (default: false) - constructor: (directoryPath, @symlink=false, includeDeprecatedAPIs=Grim.includeDeprecatedAPIs) -> - @emitter = new Emitter - - if includeDeprecatedAPIs - @on 'contents-changed-subscription-will-be-added', @willAddSubscription - @on 'contents-changed-subscription-removed', @didRemoveSubscription - - if directoryPath - directoryPath = path.normalize(directoryPath) - # Remove a trailing slash - if directoryPath.length > 1 and directoryPath[directoryPath.length - 1] is path.sep - directoryPath = directoryPath.substring(0, directoryPath.length - 1) - @path = directoryPath - - @lowerCasePath = @path.toLowerCase() if fs.isCaseInsensitive() - @reportOnDeprecations = true if Grim.includeDeprecatedAPIs - - # Public: Creates the directory on disk that corresponds to `::getPath()` if - # no such directory already exists. - # - # * `mode` (optional) {Number} that defaults to `0777`. - # - # Returns a {Promise} that resolves once the directory is created on disk. It - # resolves to a boolean value that is true if the directory was created or - # false if it already existed. - create: (mode = 0o0777) -> - @exists().then (isExistingDirectory) => - return false if isExistingDirectory - - throw Error("Root directory does not exist: #{@getPath()}") if @isRoot() - - @getParent().create().then => - new Promise (resolve, reject) => - fs.mkdir @getPath(), mode, (error) -> - if error - reject error - else - resolve true - ### - Section: Event Subscription - ### - - # Public: Invoke the given callback when the directory's contents change. - # - # * `callback` {Function} to be called when the directory's contents change. - # - # Returns a {Disposable} on which `.dispose()` can be called to unsubscribe. - onDidChange: (callback) -> - @willAddSubscription() - @trackUnsubscription(@emitter.on('did-change', callback)) - - willAddSubscription: => - @subscribeToNativeChangeEvents() if @subscriptionCount is 0 - @subscriptionCount++ - - didRemoveSubscription: => - @subscriptionCount-- - @unsubscribeFromNativeChangeEvents() if @subscriptionCount is 0 - - trackUnsubscription: (subscription) -> - new Disposable => - subscription.dispose() - @didRemoveSubscription() - - ### - Section: Directory Metadata - ### - - # Public: Returns a {Boolean}, always false. - isFile: -> false - - # Public: Returns a {Boolean}, always true. - isDirectory: -> true - - # Public: Returns a {Boolean} indicating whether or not this is a symbolic link - isSymbolicLink: -> - @symlink - - # Public: Returns a promise that resolves to a {Boolean}, true if the - # directory exists, false otherwise. - exists: -> - new Promise (resolve) => fs.exists(@getPath(), resolve) - - # Public: Returns a {Boolean}, true if the directory exists, false otherwise. - existsSync: -> - fs.existsSync(@getPath()) - - # Public: Return a {Boolean}, true if this {Directory} is the root directory - # of the filesystem, or false if it isn't. - isRoot: -> - @getParent().getRealPathSync() is @getRealPathSync() - - ### - Section: Managing Paths - ### - - # Public: Returns the directory's {String} path. - # - # This may include unfollowed symlinks or relative directory entries. Or it - # may be fully resolved, it depends on what you give it. - getPath: -> @path - - # Public: Returns this directory's completely resolved {String} path. - # - # All relative directory entries are removed and symlinks are resolved to - # their final destination. - getRealPathSync: -> - unless @realPath? - try - @realPath = fs.realpathSync(@path) - @lowerCaseRealPath = @realPath.toLowerCase() if fs.isCaseInsensitive() - catch e - @realPath = @path - @lowerCaseRealPath = @lowerCasePath if fs.isCaseInsensitive() - @realPath - - # Public: Returns the {String} basename of the directory. - getBaseName: -> - path.basename(@path) - - # Public: Returns the relative {String} path to the given path from this - # directory. - relativize: (fullPath) -> - return fullPath unless fullPath - - # Normalize forward slashes to back slashes on windows - fullPath = fullPath.replace(/\//g, '\\') if process.platform is 'win32' - - if fs.isCaseInsensitive() - pathToCheck = fullPath.toLowerCase() - directoryPath = @lowerCasePath - else - pathToCheck = fullPath - directoryPath = @path - - if pathToCheck is directoryPath - return '' - else if @isPathPrefixOf(directoryPath, pathToCheck) - return fullPath.substring(directoryPath.length + 1) - - # Check real path - @getRealPathSync() - if fs.isCaseInsensitive() - directoryPath = @lowerCaseRealPath - else - directoryPath = @realPath - - if pathToCheck is directoryPath - '' - else if @isPathPrefixOf(directoryPath, pathToCheck) - fullPath.substring(directoryPath.length + 1) - else - fullPath - - # Given a relative path, this resolves it to an absolute path relative to this - # directory. If the path is already absolute or prefixed with a URI scheme, it - # is returned unchanged. - # - # * `uri` A {String} containing the path to resolve. - # - # Returns a {String} containing an absolute path or `undefined` if the given - # URI is falsy. - resolve: (relativePath) -> - return unless relativePath - - if relativePath?.match(/[A-Za-z0-9+-.]+:\/\//) # leave path alone if it has a scheme - relativePath - else if fs.isAbsolute(relativePath) - path.normalize(fs.resolveHome(relativePath)) - else - path.normalize(fs.resolveHome(path.join(@getPath(), relativePath))) - - ### - Section: Traversing - ### - - # Public: Traverse to the parent directory. - # - # Returns a {Directory}. - getParent: -> - new Directory(path.join @path, '..') - - # Public: Traverse within this Directory to a child File. This method doesn't - # actually check to see if the File exists, it just creates the File object. - # - # * `filename` The {String} name of a File within this Directory. - # - # Returns a {File}. - getFile: (filename...) -> - new File(path.join @getPath(), filename...) - - # Public: Traverse within this a Directory to a child Directory. This method - # doesn't actually check to see if the Directory exists, it just creates the - # Directory object. - # - # * `dirname` The {String} name of the child Directory. - # - # Returns a {Directory}. - getSubdirectory: (dirname...) -> - new Directory(path.join @path, dirname...) - - # Public: Reads file entries in this directory from disk synchronously. - # - # Returns an {Array} of {File} and {Directory} objects. - getEntriesSync: -> - directories = [] - files = [] - for entryPath in fs.listSync(@path) - try - stat = fs.lstatSync(entryPath) - symlink = stat.isSymbolicLink() - stat = fs.statSync(entryPath) if symlink - - if stat?.isDirectory() - directories.push(new Directory(entryPath, symlink)) - else if stat?.isFile() - files.push(new File(entryPath, symlink)) - - directories.concat(files) - - # Public: Reads file entries in this directory from disk asynchronously. - # - # * `callback` A {Function} to call with the following arguments: - # * `error` An {Error}, may be null. - # * `entries` An {Array} of {File} and {Directory} objects. - getEntries: (callback) -> - fs.list @path, (error, entries) -> - return callback(error) if error? - - directories = [] - files = [] - addEntry = (entryPath, stat, symlink, callback) -> - if stat?.isDirectory() - directories.push(new Directory(entryPath, symlink)) - else if stat?.isFile() - files.push(new File(entryPath, symlink)) - callback() - - statEntry = (entryPath, callback) -> - fs.lstat entryPath, (error, stat) -> - if stat?.isSymbolicLink() - fs.stat entryPath, (error, stat) -> - addEntry(entryPath, stat, true, callback) - else - addEntry(entryPath, stat, false, callback) - - async.eachLimit entries, 1, statEntry, -> - callback(null, directories.concat(files)) - - # Public: Determines if the given path (real or symbolic) is inside this - # directory. This method does not actually check if the path exists, it just - # checks if the path is under this directory. - # - # * `pathToCheck` The {String} path to check. - # - # Returns a {Boolean} whether the given path is inside this directory. - contains: (pathToCheck) -> - return false unless pathToCheck - - # Normalize forward slashes to back slashes on windows - pathToCheck = pathToCheck.replace(/\//g, '\\') if process.platform is 'win32' - - if fs.isCaseInsensitive() - directoryPath = @lowerCasePath - pathToCheck = pathToCheck.toLowerCase() - else - directoryPath = @path - - return true if @isPathPrefixOf(directoryPath, pathToCheck) - - # Check real path - @getRealPathSync() - if fs.isCaseInsensitive() - directoryPath = @lowerCaseRealPath - else - directoryPath = @realPath - - @isPathPrefixOf(directoryPath, pathToCheck) - - ### - Section: Private - ### - - subscribeToNativeChangeEvents: -> - @watchSubscription ?= PathWatcher.watch @path, (eventType) => - if eventType is 'change' - @emit 'contents-changed' if Grim.includeDeprecatedAPIs - @emitter.emit 'did-change' - - unsubscribeFromNativeChangeEvents: -> - if @watchSubscription? - @watchSubscription.close() - @watchSubscription = null - - # Does given full path start with the given prefix? - isPathPrefixOf: (prefix, fullPath) -> - fullPath.indexOf(prefix) is 0 and fullPath[prefix.length] is path.sep - -if Grim.includeDeprecatedAPIs - EmitterMixin = require('emissary').Emitter - EmitterMixin.includeInto(Directory) - - Directory::on = (eventName) -> - if eventName is 'contents-changed' - Grim.deprecate("Use Directory::onDidChange instead") - else if @reportOnDeprecations - Grim.deprecate("Subscribing via ::on is deprecated. Use documented event subscription methods instead.") - - EmitterMixin::on.apply(this, arguments) diff --git a/src/directory.js b/src/directory.js new file mode 100644 index 0000000..be00e50 --- /dev/null +++ b/src/directory.js @@ -0,0 +1,461 @@ +const Path = require('path'); +const FS = require('fs-plus'); +const Grim = require('grim'); +const async = require('async'); +const { Emitter, Disposable } = require('event-kit'); + +const File = require('./file'); +// Lazy-load the main `PathWatcher` import to prevent circular references. +let PathWatcher; + +// Extended: Represents a directory on disk that can be traversed or watched +// for changes. +class Directory { + realPath = null; + subscriptionCount = 0; + + /* + Section: Construction + */ + + // Public: Configures a new {Directory} instance. + // + // No files are accessed. The directory does not yet need to exist. + // + // * `directoryPath` A {String} containing the absolute path to the + // directory. + // * `symlink` (optional) A {Boolean} indicating if the path is a symlink + // (default: `false`). + constructor(directoryPath, symlink = false, includeDeprecatedAPIs = Grim.includeDeprecatedAPIs) { + this.emitter = new Emitter(); + this.symlink = symlink; + + if (includeDeprecatedAPIs) { + this.on('contents-changed-subscription-will-be-added', this.willAddSubscription.bind(this)); + this.on('contents-changed-subscription-removed', this.didRemoveSubscription.bind(this)); + } + + if (directoryPath) { + directoryPath = Path.normalize(directoryPath); + if (directoryPath.length > 1 && directoryPath.endsWith(Path.sep)) { + directoryPath = directoryPath.substring(0, directoryPath.length - 1); + } + } + this.path = directoryPath; + if (FS.isCaseInsensitive()) { + this.lowerCasePath = this.path.toLowerCase(); + } + if (Grim.includeDeprecatedAPIs) { + this.reportOnDeprecations = true; + } + } + + // Public: Creates the directory on disk that corresponds to {::getPath} if + // no such directory already exists. + // + // * `mode` (optional) {Number} that defaults to `0777` and represents the + // default permissions of the directory on supported platforms. + // + // Returns a {Promise} that resolves to a {Boolean}: `true` if the directory + // was created and `false` if it already existed. + async create (mode = 0o0777) { + let isExistingDirectory = await this.exists(); + if (isExistingDirectory) return false; + if (this.isRoot()) { + throw new Error(`Root directory does not exist: ${this.getPath()}`); + } + await this.getParent().create(); + return new Promise((resolve, reject) => { + FS.mkdir(this.getPath(), mode, (error) => { + if (error) { + reject(error); + } else { + resolve(true); + } + }); + }); + } + + /* + Section: Event Subscription + */ + + // Public: Invoke the given callback when the directory’s contents change. + // + // A directory’s contents are considered to have changed when one of its + // children is added, deleted, or renamed. This callback will not fire when + // one of its children has its contents changed. + // + // * `callback` {Function} to be called when the directory’s contents change. + // Takes no arguments. + // + // Returns a {Disposable} on which {Disposable::dispose} can be called to + // unsubscribe. + onDidChange (callback) { + this.willAddSubscription(); + return this.trackUnsubscription( + this.emitter.on('did-change', callback) + ); + } + + willAddSubscription () { + if (this.subscriptionCount === 0) { + this.subscribeToNativeChangeEvents(); + } + this.subscriptionCount++; + } + + didRemoveSubscription () { + this.subscriptionCount--; + if (this.subscriptionCount === 0) { + this.unsubscribeFromNativeChangeEvents(); + } + } + + trackUnsubscription (subscription) { + return new Disposable(() => { + subscription.dispose(); + this.didRemoveSubscription(); + }); + } + + // Public: Returns a {Boolean}; always `false`. + isFile () { + return false; + } + + // Public: Returns a {Boolean}; always `true`. + isDirectory() { + return true; + } + + // Public: Returns a {Boolean} indicating whetehr or not this is a symbolic + // link. + isSymbolicLink () { + return this.symlink; + } + + // Public: Returns a {Promise} that resolves to a {Boolean}: `true` if the + // directory exists, `false` otherwise. + exists () { + return new Promise((resolve) => { + FS.exists(this.getPath(), resolve) + }); + } + + // Public: Returns a {Boolean}: `true` if the directory exists, `false` + // otherwise. + existsSync () { + return FS.existsSync(this.getPath()); + } + + // Public: Returns a {Boolean}: `true` if this {Directory} is the root + // directory of the filesystem, or `false` if it isn’t. + isRoot () { + let realPath = this.getRealPathSync(); + return realPath === this.getParent().getRealPathSync(); + } + + /* + Section: Managing Paths + */ + + // Public: Returns the directory’s {String} path. + // + // This may include unfollowed symlinks or relative directory entries; or it + // may be fully resolved. It depends on what you give it. Anything that + // Node’s builtin `fs` and `path` libraries can resolve will also be + // understood by {Directory}. + getPath () { + return this.path; + } + + // Public: Returns the directory’s resolved {String} path, resolving symlinks + // if necessary. + // + // This will always be an absolute path; all relative paths are resolved and + // all symlinks are followed. + getRealPathSync () { + if (!this.realPath) { + try { + this.realPath = FS.realpathSync(this.path); + if (FS.isCaseInsensitive()) { + this.lowerCaseRealPath = this.realPath.toLowerCase(); + } + } catch (err) { + this.realPath = this.path; + if (FS.isCaseInsensitive()) { + this.lowerCaseRealPath = this.lowerCasePath; + } + } + } + return this.realPath; + } + + // Public: Returns the {String} basename of the directory. + getBaseName () { + return Path.basename(this.path); + } + + // Public: Returns the relative {String} path to the given path from this + // directory. If the given path is not a descendant of this directory, will + // return its full absolute path. + // + // * `fullPath` A path to compare against the real, absolute path of this + // {Directory}. + relativize (fullPath) { + if (!fullPath) return fullPath; + + if (process.platform === 'win32') { + fullPath = fullPath.replace(/\//g, '\\'); + } + + let pathToCheck; + let directoryPath; + if (FS.isCaseInsensitive()) { + pathToCheck = fullPath.toLowerCase(); + directoryPath = this.lowerCasePath; + } else { + pathToCheck = fullPath; + directoryPath = this.path; + } + + if (pathToCheck === directoryPath) { + return ''; + } else if (this.isPathPrefixOf(directoryPath, pathToCheck)) { + return fullPath.substring(directoryPath.length + 1); + } + + // Check the real path. + this.getRealPathSync(); + if (FS.isCaseInsensitive()) { + directoryPath = this.lowerCaseRealPath; + } else { + directoryPath = this.realPath; + } + + if (pathToCheck === directoryPath) { + return ''; + } else if (this.isPathPrefixOf(directoryPath, pathToCheck)) { + return fullPath.substring(directoryPath.length + 1); + } else { + return fullPath; + } + } + + // Public: Resolves the given relative path to an absolute path relative to + // this directory. If the path is already absolute or prefixed with a URI + // scheme, it is returned unchanged. + // + // * `uri` A {String} containing the path to resolve. + // + // Returns a {String} containing an absolute path, or `undefined` if the + // given URI is falsy (like an empty string). + resolve (relativePath) { + if (!relativePath) return; + + if (relativePath?.match(/[A-Za-z0-9+-.]+:\/\//)) { + // Leave the path alone if it has a scheme. + return relativePath; + } else if (FS.isAbsolute(relativePath)) { + return Path.normalize(FS.resolveHome(relativePath)); + } else { + return Path.normalize( + FS.resolveHome(Path.join(this.getPath(), relativePath)) + ); + } + } + + /* + Section: Traversing + */ + + // Public: Traverse to the parent directory. + // + // Returns a {Directory}. + getParent () { + return new Directory(Path.join(this.path, '..')); + } + + // Public: Traverse within this {Directory} to a child {File}. This method + // doesn't actually check to see if the {File} exists; it just creates the + // {File} object. + // + // You can also access descendant files by passing multiple arguments. In + // this usage, the final segment should be the name of a file; the others + // should be directories. + // + // * `filename` The {String} name of a File within this Directory. + // + // Returns a {File}. + getFile (...fileName) { + return new File(Path.join(this.getPath(), ...fileName)); + } + + // Public: Traverse within this {Directory} to a child {Directory}. This + // method doesn't actually check to see if the directory exists; it just + // creates the {Directory} object. + // + // You can also access descendant directories by passing multiple arguments. + // In this usage, all segments should be directory names. + // + // * `dirname` The {String} name of the child {Directory}. + // + // Returns a {Directory}. + getSubdirectory (...dirName) { + return new Directory(Path.join(this.getPath(), ...dirName)); + } + + // Public: Reads file entries in this directory from disk asynchronously and + // applies a function to each. + // + // * `callback` A {Function} to call with the following arguments: + // * `error` An {Error}, may be null. + // * `entries` An {Array} of {File} and {Directory} objects. + getEntries (callback) { + FS.list(this.path, (error, entries) => { + if (error) return callback(error); + + let directories = []; + let files = []; + + let addEntry = (entryPath, stat, symlink, innerCallback) => { + if (stat?.isDirectory()) { + directories.push(new Directory(entryPath, symlink)); + } else if (stat?.isFile()) { + files.push(new File(entryPath, symlink)) + } + return innerCallback(); + }; + + let statEntry = (entryPath, innerCallback) => { + FS.lstat(entryPath, (_error, stat) => { + if (stat?.isSymbolicLink()) { + FS.stat(entryPath, (_error, stat) => { + addEntry(entryPath, stat, true, innerCallback) + }); + } else { + addEntry(entryPath, stat, false, innerCallback); + } + }); + }; + + return async.eachLimit( + entries, + 1, + statEntry, + function() { + return callback(null, directories.concat(files)); + } + ); + }); + } + + // Public: Reads file entries in this directory from disk synchronously. + // + // Returns an {Array} of {File} and {Directory} objects. + getEntriesSync () { + let directories = []; + let files = []; + for (let entryPath of FS.listSync(this.path)) { + let stat; + let symlink = false; + try { + stat = FS.lstatSync(entryPath); + symlink = stat.isSymbolicLink(); + if (symlink) { + stat = FS.statSync(entryPath); + } + } catch (_err) {} + if (stat?.isDirectory()) { + directories.push(new Directory(entryPath, symlink)); + } else if (stat?.isFile()) { + files.push(new File(entryPath, symlink)); + } + } + return directories.concat(files); + } + + + // Public: Determines if the given path (real or symbolic) is inside this + // directory. This method does not actually check if the path exists; it just + // checks if the path is under this directory. + // + // * `pathToCheck` The {String} path to check. + // + // Returns a {Boolean} whether the given path is inside this directory. + contains (pathToCheck) { + if (!pathToCheck) return false; + + // Normalize forward slashes to backslashes on Windows. + if (process.platform === 'win32') { + pathToCheck = pathToCheck.replace(/\//g, '\\'); + } + + let directoryPath; + if (FS.isCaseInsensitive()) { + directoryPath = this.lowerCasePath; + pathToCheck = pathToCheck.toLowerCase(); + } else { + directoryPath = this.path; + } + + if (this.isPathPrefixOf(directoryPath, pathToCheck)) { + return true; + } + + // Check the real path. + this.getRealPathSync(); + if (FS.isCaseInsensitive()) { + directoryPath = this.lowerCaseRealPath; + } else { + directoryPath = this.realPath; + } + + return this.isPathPrefixOf(directoryPath, pathToCheck); + } + + /* + Section: Private + */ + + subscribeToNativeChangeEvents () { + PathWatcher ??= require('./main'); + this.watchSubscription ??= PathWatcher.watch( + this.path, + (_eventType) => { + if (Grim.includeDeprecatedAPIs) { + this.emit('contents-changed'); + } + this.emitter.emit('did-change'); + } + ); + } + + unsubscribeFromNativeChangeEvents () { + this.watchSubscription?.close(); + this.watchSubscription &&= null; + } + + // Does the given full path start with the given prefix? + isPathPrefixOf (prefix, fullPath) { + return fullPath.startsWith(prefix) && fullPath[prefix.length] === Path.sep; + } +} + +let EmitterMixin; +if (Grim.includeDeprecatedAPIs) { + EmitterMixin = require('emissary').Emitter; + EmitterMixin.includeInto(Directory); + + Directory.prototype.on = function on(eventName, ...args) { + if (eventName === 'contents-changed') { + Grim.deprecate("Use Directory::onDidChange instead"); + } else if (this.reportOnDeprecations) { + Grim.deprecate("Subscribing via ::on is deprecated. Use documented event subscription methods instead."); + } + EmitterMixin.prototype.on.call(this, eventName, ...args); + }; +} + +module.exports = Directory; diff --git a/src/file.coffee b/src/file.coffee deleted file mode 100644 index b9bf58f..0000000 --- a/src/file.coffee +++ /dev/null @@ -1,406 +0,0 @@ -crypto = require 'crypto' -path = require 'path' - -_ = require 'underscore-plus' -{Emitter, Disposable} = require 'event-kit' -fs = require 'fs-plus' -Grim = require 'grim' - -iconv = null # Defer until used - -Directory = null -PathWatcher = require './main' - -# Extended: Represents an individual file that can be watched, read from, and -# written to. -module.exports = -class File - encoding: 'utf8' - realPath: null - subscriptionCount: 0 - - ### - Section: Construction - ### - - # Public: Configures a new File instance, no files are accessed. - # - # * `filePath` A {String} containing the absolute path to the file - # * `symlink` (optional) A {Boolean} indicating if the path is a symlink (default: false). - constructor: (filePath, @symlink=false, includeDeprecatedAPIs=Grim.includeDeprecatedAPIs) -> - filePath = path.normalize(filePath) if filePath - @path = filePath - @emitter = new Emitter - - if includeDeprecatedAPIs - @on 'contents-changed-subscription-will-be-added', @willAddSubscription - @on 'moved-subscription-will-be-added', @willAddSubscription - @on 'removed-subscription-will-be-added', @willAddSubscription - @on 'contents-changed-subscription-removed', @didRemoveSubscription - @on 'moved-subscription-removed', @didRemoveSubscription - @on 'removed-subscription-removed', @didRemoveSubscription - - @cachedContents = null - @reportOnDeprecations = true - - # Public: Creates the file on disk that corresponds to `::getPath()` if no - # such file already exists. - # - # Returns a {Promise} that resolves once the file is created on disk. It - # resolves to a boolean value that is true if the file was created or false if - # it already existed. - create: -> - @exists().then (isExistingFile) => - unless isExistingFile - parent = @getParent() - parent.create().then => - @write('').then -> true - else - false - - ### - Section: Event Subscription - ### - - # Public: Invoke the given callback when the file's contents change. - # - # * `callback` {Function} to be called when the file's contents change. - # - # Returns a {Disposable} on which `.dispose()` can be called to unsubscribe. - onDidChange: (callback) -> - @willAddSubscription() - @trackUnsubscription(@emitter.on('did-change', callback)) - - # Public: Invoke the given callback when the file's path changes. - # - # * `callback` {Function} to be called when the file's path changes. - # - # Returns a {Disposable} on which `.dispose()` can be called to unsubscribe. - onDidRename: (callback) -> - @willAddSubscription() - @trackUnsubscription(@emitter.on('did-rename', callback)) - - # Public: Invoke the given callback when the file is deleted. - # - # * `callback` {Function} to be called when the file is deleted. - # - # Returns a {Disposable} on which `.dispose()` can be called to unsubscribe. - onDidDelete: (callback) -> - @willAddSubscription() - @trackUnsubscription(@emitter.on('did-delete', callback)) - - # Public: Invoke the given callback when there is an error with the watch. - # When your callback has been invoked, the file will have unsubscribed from - # the file watches. - # - # * `callback` {Function} callback - # * `errorObject` {Object} - # * `error` {Object} the error object - # * `handle` {Function} call this to indicate you have handled the error. - # The error will not be thrown if this function is called. - onWillThrowWatchError: (callback) -> - @emitter.on('will-throw-watch-error', callback) - - willAddSubscription: => - @subscriptionCount++ - try - @subscribeToNativeChangeEvents() - - didRemoveSubscription: => - @subscriptionCount-- - @unsubscribeFromNativeChangeEvents() if @subscriptionCount is 0 - - trackUnsubscription: (subscription) -> - new Disposable => - subscription.dispose() - @didRemoveSubscription() - - ### - Section: File Metadata - ### - - # Public: Returns a {Boolean}, always true. - isFile: -> true - - # Public: Returns a {Boolean}, always false. - isDirectory: -> false - - # Public: Returns a {Boolean} indicating whether or not this is a symbolic link - isSymbolicLink: -> - @symlink - - # Public: Returns a promise that resolves to a {Boolean}, true if the file - # exists, false otherwise. - exists: -> - new Promise (resolve) => - fs.exists @getPath(), resolve - - # Public: Returns a {Boolean}, true if the file exists, false otherwise. - existsSync: -> - fs.existsSync(@getPath()) - - # Public: Get the SHA-1 digest of this file - # - # Returns a promise that resolves to a {String}. - getDigest: -> - if @digest? - Promise.resolve(@digest) - else - @read().then => @digest # read assigns digest as a side-effect - - # Public: Get the SHA-1 digest of this file - # - # Returns a {String}. - getDigestSync: -> - @readSync() unless @digest - @digest - - setDigest: (contents) -> - @digest = crypto.createHash('sha1').update(contents ? '').digest('hex') - - # Public: Sets the file's character set encoding name. - # - # * `encoding` The {String} encoding to use (default: 'utf8') - setEncoding: (encoding='utf8') -> - # Throws if encoding doesn't exist. Better to throw an exception early - # instead of waiting until the file is saved. - - if encoding isnt 'utf8' - iconv ?= require 'iconv-lite' - iconv.getCodec(encoding) - - @encoding = encoding - - # Public: Returns the {String} encoding name for this file (default: 'utf8'). - getEncoding: -> @encoding - - ### - Section: Managing Paths - ### - - # Public: Returns the {String} path for the file. - getPath: -> @path - - # Sets the path for the file. - setPath: (@path) -> - @realPath = null - - # Public: Returns this file's completely resolved {String} path. - getRealPathSync: -> - unless @realPath? - try - @realPath = fs.realpathSync(@path) - catch error - @realPath = @path - @realPath - - # Public: Returns a promise that resolves to the file's completely resolved {String} path. - getRealPath: -> - if @realPath? - Promise.resolve(@realPath) - else - new Promise (resolve, reject) => - fs.realpath @path, (err, result) => - if err? - reject(err) - else - resolve(@realPath = result) - - # Public: Return the {String} filename without any directory information. - getBaseName: -> - path.basename(@path) - - ### - Section: Traversing - ### - - # Public: Return the {Directory} that contains this file. - getParent: -> - Directory ?= require './directory' - new Directory(path.dirname @path) - - ### - Section: Reading and Writing - ### - - readSync: (flushCache) -> - if not @existsSync() - @cachedContents = null - else if not @cachedContents? or flushCache - encoding = @getEncoding() - if encoding is 'utf8' - @cachedContents = fs.readFileSync(@getPath(), encoding) - else - iconv ?= require 'iconv-lite' - @cachedContents = iconv.decode(fs.readFileSync(@getPath()), encoding) - - @setDigest(@cachedContents) - @cachedContents - - writeFileSync: (filePath, contents) -> - encoding = @getEncoding() - if encoding is 'utf8' - fs.writeFileSync(filePath, contents, {encoding}) - else - iconv ?= require 'iconv-lite' - fs.writeFileSync(filePath, iconv.encode(contents, encoding)) - - # Public: Reads the contents of the file. - # - # * `flushCache` A {Boolean} indicating whether to require a direct read or if - # a cached copy is acceptable. - # - # Returns a promise that resolves to either a {String}, or null if the file does not exist. - read: (flushCache) -> - if @cachedContents? and not flushCache - promise = Promise.resolve(@cachedContents) - else - promise = new Promise (resolve, reject) => - content = [] - readStream = @createReadStream() - - readStream.on 'data', (chunk) -> - content.push(chunk) - - readStream.on 'end', -> - resolve(content.join('')) - - readStream.on 'error', (error) -> - if error.code == 'ENOENT' - resolve(null) - else - reject(error) - - promise.then (contents) => - @setDigest(contents) - @cachedContents = contents - - # Public: Returns a stream to read the content of the file. - # - # Returns a {ReadStream} object. - createReadStream: -> - encoding = @getEncoding() - if encoding is 'utf8' - fs.createReadStream(@getPath(), {encoding}) - else - iconv ?= require 'iconv-lite' - fs.createReadStream(@getPath()).pipe(iconv.decodeStream(encoding)) - - # Public: Overwrites the file with the given text. - # - # * `text` The {String} text to write to the underlying file. - # - # Returns a {Promise} that resolves when the file has been written. - write: (text) -> - @exists().then (previouslyExisted) => - @writeFile(@getPath(), text).then => - @cachedContents = text - @setDigest(text) - @subscribeToNativeChangeEvents() if not previouslyExisted and @hasSubscriptions() - undefined - - # Public: Returns a stream to write content to the file. - # - # Returns a {WriteStream} object. - createWriteStream: -> - encoding = @getEncoding() - if encoding is 'utf8' - fs.createWriteStream(@getPath(), {encoding}) - else - iconv ?= require 'iconv-lite' - stream = iconv.encodeStream(encoding) - stream.pipe(fs.createWriteStream(@getPath())) - stream - - # Public: Overwrites the file with the given text. - # - # * `text` The {String} text to write to the underlying file. - # - # Returns undefined. - writeSync: (text) -> - previouslyExisted = @existsSync() - @writeFileSync(@getPath(), text) - @cachedContents = text - @setDigest(text) - @emit 'contents-changed' if Grim.includeDeprecatedAPIs - @emitter.emit 'did-change' - @subscribeToNativeChangeEvents() if not previouslyExisted and @hasSubscriptions() - undefined - - writeFile: (filePath, contents) -> - encoding = @getEncoding() - if encoding is 'utf8' - new Promise (resolve, reject) -> - fs.writeFile filePath, contents, {encoding}, (err, result) -> - if err? - reject(err) - else - resolve(result) - else - iconv ?= require 'iconv-lite' - new Promise (resolve, reject) -> - fs.writeFile filePath, iconv.encode(contents, encoding), (err, result) -> - if err? - reject(err) - else - resolve(result) - - ### - Section: Private - ### - - handleNativeChangeEvent: (eventType, eventPath) -> - switch eventType - when 'delete' - @unsubscribeFromNativeChangeEvents() - @detectResurrectionAfterDelay() - when 'rename' - @setPath(eventPath) - @emit 'moved' if Grim.includeDeprecatedAPIs - @emitter.emit 'did-rename' - when 'change', 'resurrect' - @cachedContents = null - @emitter.emit 'did-change' - - detectResurrectionAfterDelay: -> - _.delay (=> @detectResurrection()), 50 - - detectResurrection: -> - @exists().then (exists) => - if exists - @subscribeToNativeChangeEvents() - @handleNativeChangeEvent('resurrect') - else - @cachedContents = null - @emit 'removed' if Grim.includeDeprecatedAPIs - @emitter.emit 'did-delete' - - subscribeToNativeChangeEvents: -> - @watchSubscription ?= PathWatcher.watch @path, (args...) => - @handleNativeChangeEvent(args...) - - unsubscribeFromNativeChangeEvents: -> - if @watchSubscription? - @watchSubscription.close() - @watchSubscription = null - -if Grim.includeDeprecatedAPIs - EmitterMixin = require('emissary').Emitter - EmitterMixin.includeInto(File) - - File::on = (eventName) -> - switch eventName - when 'contents-changed' - Grim.deprecate("Use File::onDidChange instead") - when 'moved' - Grim.deprecate("Use File::onDidRename instead") - when 'removed' - Grim.deprecate("Use File::onDidDelete instead") - else - if @reportOnDeprecations - Grim.deprecate("Subscribing via ::on is deprecated. Use documented event subscription methods instead.") - - EmitterMixin::on.apply(this, arguments) -else - File::hasSubscriptions = -> - @subscriptionCount > 0 diff --git a/src/file.js b/src/file.js new file mode 100644 index 0000000..fdf40c2 --- /dev/null +++ b/src/file.js @@ -0,0 +1,560 @@ +const crypto = require('crypto'); +const Path = require('path'); +const { Emitter, Disposable } = require('event-kit'); +const _ = require('underscore-plus'); +const FS = require('fs-plus'); +const Grim = require('grim'); + +let iconv; +let Directory; + +async function wait (ms) { + return new Promise(r => setTimeout(r, ms)); +} + +// Lazy-load the main `PathWatcher` import to prevent circular references. +let PathWatcher; + +// Extended: Represents an individual file that can be watched, read from, and +// written to. +class File { + encoding = 'utf8'; + realPath = null; + subscriptionCount = 0; + + /* + Section: Construction + */ + + // Public: Configures a new {File} instance. + // + // No files are accessed. The file does not yet need to exist. + // + // * `filePath` A {String} containing the absolute path to the file. + // * `symlink` (optional) A {Boolean} indicating if the path is a symlink + // (default: false). + constructor( + filePath, + symlink = false, + includeDeprecatedAPIs = Grim.includeDeprecatedAPIs + ) { + this.didRemoveSubscription = this.didRemoveSubscription.bind(this); + this.willAddSubscription = this.willAddSubscription.bind(this); + this.symlink = symlink; + + filePath &&= Path.normalize(filePath); + this.path = filePath; + this.emitter = new Emitter(); + + if (includeDeprecatedAPIs) { + this.on('contents-changed-subscription-will-be-added', this.willAddSubscription); + this.on('moved-subscription-will-be-added', this.willAddSubscription); + this.on('removed-subscription-will-be-added', this.willAddSubscription); + this.on('contents-changed-subscription-removed', this.didRemoveSubscription); + this.on('moved-subscription-removed', this.didRemoveSubscription); + this.on('removed-subscription-removed', this.didRemoveSubscription); + } + + this.cachedContents = null; + this.reportOnDeprecations = true; + } + + // Public: Creates the file on disk that corresponds to {::getPath} if no + // such file already exists. + // + // Returns a {Promise} that resolves once the file is created on disk. It + // resolves to a boolean value that is `true` if the file was created or + // `false` if it already existed. + // + async create () { + let isExistingFile = await this.exists(); + let parent; + if (!isExistingFile) { + parent = this.getParent(); + await parent.create(); + await this.write(''); + return true; + } else { + return false; + } + } + + /* + Section: Event Subscription + */ + + // Public: Invoke the given callback when the file’s contents change. + // + // * `callback` {Function} to be called when the file’s contents change. + // Takes no arguments. + // + // Returns a {Disposable} on which {Disposable::dispose} can be called to + // unsubscribe. + onDidChange (callback) { + this.willAddSubscription(); + // Add a small buffer here. If a file has changed, we want to wait briefly + // to see if it's prelude to a delete event (as EFSW sometimes does). The + // good news is that we don't have to wait very long at all. + let wrappedCallback = async (...args) => { + await wait(0); + if (!(await this.exists())) return; + callback(...args); + }; + return this.trackUnsubscription(this.emitter.on('did-change', wrappedCallback)); + } + + // Public: Invoke the given callback when the file’s path changes. + // + // * `callback` {Function} to be called when the file’s path changes. + // Takes no arguments. + // + // Returns a {Disposable} on which {Disposable::dispose} can be called to + // unsubscribe. + onDidRename (callback) { + this.willAddSubscription(); + return this.trackUnsubscription(this.emitter.on('did-rename', callback)); + } + + // Public: Invoke the given callback when the file is deleted. + // + // * `callback` {Function} to be called when the file is deleted. + // Takes no arguments. + // + // Returns a {Disposable} on which {Disposable::dispose} can be called to + // unsubscribe. + onDidDelete (callback) { + this.willAddSubscription(); + return this.trackUnsubscription(this.emitter.on('did-delete', callback)); + } + + onWillThrowWatchError (_callback) { + // Deprecated callback; must return a `Disposable` for compatibility. + return new Disposable(() => {}); + } + + willAddSubscription () { + this.subscriptionCount++; + try { + return this.subscribeToNativeChangeEvents(); + } catch (_err) {} + } + + didRemoveSubscription () { + this.subscriptionCount--; + if (this.subscriptionCount === 0) { + return this.unsubscribeFromNativeChangeEvents(); + } + } + + trackUnsubscription (subscription) { + return new Disposable(() => { + subscription.dispose(); + this.didRemoveSubscription(); + }); + } + + /* + Section: File Metadata + */ + + // Public: Returns a {Boolean}; always `true`. + isFile () { + return true; + } + + // Public: Returns a {Boolean}; always `false`. + isDirectory () { + return false; + } + + // Public: Returns a {Boolean} indicating whether or not this is a symbolic + // link. + isSymbolicLink () { + return this.symlink; + } + + // Public: Returns a {Promise} that resolves to a {Boolean}: `true` if the + // file exists; `false` otherwise. + async exists () { + return new Promise((resolve) => FS.exists(this.getPath(), resolve)); + } + + // Public: Returns a {Boolean}: `true` if the file exists; `false` otherwise. + existsSync () { + return FS.existsSync(this.getPath()); + } + + // Public: Get the SHA-1 digest of this file. + // + // Returns a {Promise} that resolves to a {String}. + async getDigest () { + if (this.digest != null) { + return this.digest; + } + await this.read(); + return this.digest; + } + + // Public: Get the SHA-1 digest of this file. + // + // Returns a {String}. + getDigestSync () { + if (this.digest == null) { + this.readSync(); + } + return this.digest; + } + + + setDigest (contents) { + this.digest = crypto + .createHash('sha1') + .update(contents ?? '') + .digest('hex'); + return this.digest; + } + + // Public: Sets the file's character set encoding name. + // + // Supports `utf8` natively and whichever other encodings are supported by + // the `iconv-lite` package. + setEncoding (encoding = 'utf8') { + if (encoding !== 'utf8') { + iconv ??= require('iconv-lite'); + iconv.getCodec(encoding); + } + this.encoding = encoding; + return encoding; + } + + // Public: Returns the {String} encoding name for this file; default is + // `utf8`. + getEncoding () { + return this.encoding; + } + + /* + Section: Managing Paths + */ + + // Public: Returns the {String} path for this file. + getPath () { + return this.path; + } + + // Public: Sets the path for the file. + // + // This should not normally need to be called; use it only when you know a + // file’s path has changed and you don’t want to rely on the internal + // renaming detection. + // + // * `path` {String} The new path to set; should be absolute. + setPath (path) { + this.path = path; + this.realPath = null; + } + + // Public: Returns a {Promise} that resolves to this file’s completely + // resolved {String} path, following symlinks if necessary. + async getRealPath () { + if (this.realPath != null) { + return this.realPath; + } + return new Promise((resolve, reject) => { + FS.realpath(this.path, (err, result) => { + if (err != null) return reject(err); + this.realPath = result; + return resolve(this.realPath); + }); + }); + } + + // Public: Returns this file’s completely resolved {String} path, following + // symlinks if necessary. + getRealPathSync () { + if (this.realPath == null) { + try { + this.realPath = FS.realpathSync(this.path); + } catch (_error) { + this.realPath = this.path; + } + } + return this.realPath; + } + + // Public: Returns the {String} filename of this file without its directory + // context. + getBaseName () { + return Path.basename(this.path); + } + + /* + Section: Traversing + */ + + // Public: Returns the {Directory} that contains this file. + getParent () { + Directory ??= require('./directory'); + return new Directory(Path.dirname(this.path)); + } + + + /* + Section: Reading and Writing + */ + + // Public: Reads the contents of the file. + // + // * `flushCache` A {Boolean} indicating whether to require a direct read or + // if a cached copy is acceptable. + // + // Returns a {Promise} that resolves to a {String} (if the file exists) or + // `null` (if it does not). + async read (flushCache) { + let contents; + if (!flushCache && this.cachedContents != null) { + contents = this.cachedContents; + } else { + contents = await new Promise((resolve, reject) => { + let content = []; + let readStream = this.createReadStream(); + readStream.on('data', (chunk) => content.push(chunk)); + readStream.on('end', () => resolve(content.join(''))); + readStream.on('error', (error) => { + if (error.code === 'ENOENT') { + return resolve(null); + } else { + return reject(error); + } + }) + }); + } + this.setDigest(contents); + this.cachedContents = contents; + return contents; + } + + // Public: Reads the contents of the file synchronously. + // + // * `flushCache` A {Boolean} indicating whether to require a direct read or + // if a cached copy is acceptable. + // + // Returns a {String} (if the file exists) or `null` (if it does not). + readSync (flushCache) { + if (!this.existsSync()) { + this.cachedContents = null; + } else if ((this.cachedContents == null) || flushCache) { + let encoding = this.getEncoding(); + if (encoding === 'utf8') { + this.cachedContents = FS.readFileSync(this.getPath(), encoding); + } else { + iconv ??= require('iconv-lite'); + this.cachedContents = iconv.decode( + FS.readFileSync(this.getPath()), + encoding + ); + } + } + this.setDigest(this.cachedContents); + return this.cachedContents; + } + + // Public: Returns a stream to read the content of the file. + // + // Returns a {ReadStream} object. + createReadStream () { + let encoding = this.getEncoding(); + if (encoding === 'utf8') { + return FS.createReadStream(this.getPath(), { encoding }); + } else { + iconv ??= require('iconv-lite'); + return FS.createReadStream(this.getPath()) + .pipe(iconv.decodeStream(encoding)); + } + } + + // Public: Overwrites the file with the given text. + // + // * `text` The {String} text to write to the underlying file. + // + // Returns a {Promise} that resolves when the file has been written. + async write (text) { + let previouslyExisted = await this.exists(); + await this.writeFile(this.getPath(), text); + this.cachedContents = text; + this.setDigest(text); + if (!previouslyExisted && this.hasSubscriptions()) { + this.subscribeToNativeChangeEvents(); + } + } + + // Public: Overwrites the file with the given text. + // + // * `text` The {String} text to write to the underlying file. + writeSync (text) { + let previouslyExisted = this.existsSync(); + this.writeFileSync(this.getPath(), text); + this.cachedContents = text; + this.setDigest(text); + if (Grim.includeDeprecatedAPIs) { + this.emit('contents-changed'); + } + this.emitter.emit('did-change'); + if (!previouslyExisted && this.hasSubscriptions()) { + this.subscribeToNativeChangeEvents(); + } + } + + // Public: Returns a stream to write content to the file. + // + // Returns a {WriteStream} object. + createWriteStream () { + let encoding = this.getEncoding(); + if (encoding === 'utf8') { + return FS.createWriteStream(this.getPath(), { encoding }); + } else { + iconv ??= require('iconv-lite'); + let stream = iconv.encodeStream(encoding); + stream.pipe(FS.createWriteStream(this.getPath())); + return stream; + } + } + + // Internal helper method for writing to a file. + async writeFile (filePath, contents) { + let encoding = this.getEncoding(); + if (encoding === 'utf8') { + return new Promise((resolve, reject) => { + FS.writeFile( + filePath, + contents, + { encoding }, + (err, result) => { + if (err != null) { + reject(err); + } else { + resolve(result); + } + } + ) + }); + } else { + iconv ??= require('iconv-lite'); + return new Promise((resolve, reject) => { + FS.writeFile( + filePath, + iconv.encode(contents, encoding), + (err, result) => { + if (err != null) { + reject(err); + } else { + resolve(result); + } + } + ) + }); + } + } + + // Internal helper method for writing to a file. + writeFileSync (filePath, contents) { + let encoding = this.getEncoding(); + if (encoding === 'utf8') { + return FS.writeFileSync(filePath, contents, { encoding }); + } else { + iconv ??= require('iconv-lite'); + return FS.writeFileSync(filePath, iconv.encode(contents, encoding)); + } + } + + /* + Section: Private + */ + + async handleNativeChangeEvent (eventType, eventPath) { + switch (eventType) { + case 'delete': + this.unsubscribeFromNativeChangeEvents(); + // We could just `await wait(50)` here, but this method exists so that + // we can monkeypatch it in the Pulsar specs and prevent it from going + // async. + this.detectResurrectionAfterDelay(); + return; + case 'rename': + this.setPath(eventPath); + if (Grim.includeDeprecatedAPIs) { + this.emit('moved'); + } + this.emitter.emit('did-rename'); + return; + case 'change': + case 'resurrect': + this.cachedContents = null; + this.emitter.emit('did-change'); + } + } + + detectResurrectionAfterDelay () { + return _.delay(() => this.detectResurrection(), 50); + } + + async detectResurrection () { + let exists = await this.exists(); + if (exists) { + this.subscribeToNativeChangeEvents(); + this.handleNativeChangeEvent('resurrect'); + } else { + this.cachedContents = null; + if (Grim.includeDeprecatedAPIs) { + this.emit('removed'); + } + this.emitter.emit('did-delete'); + } + } + + subscribeToNativeChangeEvents () { + PathWatcher ??= require('./main'); + this.watchSubscription ??= PathWatcher.watch( + this.path, + (...args) => { + return this.handleNativeChangeEvent(...args); + } + ); + return this.watchSubscription; + } + + unsubscribeFromNativeChangeEvents () { + this.watchSubscription?.close(); + this.watchSubscription &&= null; + } +} + +if (Grim.includeDeprecatedAPIs) { + EmitterMixin = require('emissary').Emitter; + EmitterMixin.includeInto(File); + File.prototype.on = function(eventName) { + switch (eventName) { + case 'contents-changed': + Grim.deprecate("Use File::onDidChange instead"); + break; + case 'moved': + Grim.deprecate("Use File::onDidRename instead"); + break; + case 'removed': + Grim.deprecate("Use File::onDidDelete instead"); + break; + default: + if (this.reportOnDeprecations) { + Grim.deprecate("Subscribing via ::on is deprecated. Use documented event subscription methods instead."); + } + } + return EmitterMixin.prototype.on.apply(this, arguments); + }; +} else { + File.prototype.hasSubscriptions = function() { + return this.subscriptionCount > 0; + }; +} + + +module.exports = File; diff --git a/src/handle_map.cc b/src/handle_map.cc deleted file mode 100644 index c55a85f..0000000 --- a/src/handle_map.cc +++ /dev/null @@ -1,143 +0,0 @@ -#include "handle_map.h" - -#include - -HandleMap::HandleMap() { -} - -HandleMap::~HandleMap() { - Clear(); -} - -bool HandleMap::Has(WatcherHandle key) const { - return map_.find(key) != map_.end(); -} - -bool HandleMap::Erase(WatcherHandle key) { - Map::iterator iter = map_.find(key); - if (iter == map_.end()) - return false; - - NanDisposeUnsafePersistent(iter->second); - map_.erase(iter); - return true; -} - -void HandleMap::Clear() { - for (Map::iterator iter = map_.begin(); iter != map_.end(); ++iter) - NanDisposeUnsafePersistent(iter->second); - map_.clear(); -} - -// static -NAN_METHOD(HandleMap::New) { - Nan::HandleScope scope; - HandleMap* obj = new HandleMap(); - obj->Wrap(info.This()); - return; -} - -// static -NAN_METHOD(HandleMap::Add) { - Nan::HandleScope scope; - - if (!IsV8ValueWatcherHandle(info[0])) - return Nan::ThrowTypeError("Bad argument"); - - HandleMap* obj = Nan::ObjectWrap::Unwrap(info.This()); - WatcherHandle key = V8ValueToWatcherHandle(info[0]); - if (obj->Has(key)) - return Nan::ThrowError("Duplicate key"); - - NanAssignUnsafePersistent(obj->map_[key], info[1]); - return; -} - -// static -NAN_METHOD(HandleMap::Get) { - Nan::HandleScope scope; - - if (!IsV8ValueWatcherHandle(info[0])) - return Nan::ThrowTypeError("Bad argument"); - - HandleMap* obj = Nan::ObjectWrap::Unwrap(info.This()); - WatcherHandle key = V8ValueToWatcherHandle(info[0]); - if (!obj->Has(key)) - return Nan::ThrowError("Invalid key"); - - info.GetReturnValue().Set(NanUnsafePersistentToLocal(obj->map_[key])); -} - -// static -NAN_METHOD(HandleMap::Has) { - Nan::HandleScope scope; - - if (!IsV8ValueWatcherHandle(info[0])) - return Nan::ThrowTypeError("Bad argument"); - - HandleMap* obj = Nan::ObjectWrap::Unwrap(info.This()); - info.GetReturnValue().Set(Nan::New(obj->Has(V8ValueToWatcherHandle(info[0])))); -} - -// static -NAN_METHOD(HandleMap::Values) { - Nan::HandleScope scope; - - HandleMap* obj = Nan::ObjectWrap::Unwrap(info.This()); - - int i = 0; - v8::Local context = Nan::GetCurrentContext(); - v8::Local keys = Nan::New(obj->map_.size()); - for (Map::const_iterator iter = obj->map_.begin(); - iter != obj->map_.end(); - ++iter, ++i) { - keys->Set(context, i, NanUnsafePersistentToLocal(iter->second)).FromJust(); - } - - info.GetReturnValue().Set(keys); -} - -// static -NAN_METHOD(HandleMap::Remove) { - Nan::HandleScope scope; - - if (!IsV8ValueWatcherHandle(info[0])) - return Nan::ThrowTypeError("Bad argument"); - - HandleMap* obj = Nan::ObjectWrap::Unwrap(info.This()); - if (!obj->Erase(V8ValueToWatcherHandle(info[0]))) - return Nan::ThrowError("Invalid key"); - - return; -} - -// static -NAN_METHOD(HandleMap::Clear) { - Nan::HandleScope scope; - - HandleMap* obj = Nan::ObjectWrap::Unwrap(info.This()); - obj->Clear(); - - return; -} - -// static -void HandleMap::Initialize(Local target) { - Nan::HandleScope scope; - - Local t = Nan::New(HandleMap::New); - t->InstanceTemplate()->SetInternalFieldCount(1); - t->SetClassName(Nan::New("HandleMap").ToLocalChecked()); - - Nan::SetPrototypeMethod(t, "add", Add); - Nan::SetPrototypeMethod(t, "get", Get); - Nan::SetPrototypeMethod(t, "has", Has); - Nan::SetPrototypeMethod(t, "values", Values); - Nan::SetPrototypeMethod(t, "remove", Remove); - Nan::SetPrototypeMethod(t, "clear", Clear); - - Local context = Nan::GetCurrentContext(); - target->Set(context, - Nan::New("HandleMap").ToLocalChecked(), - t->GetFunction(context).ToLocalChecked()).FromJust(); -} diff --git a/src/handle_map.h b/src/handle_map.h deleted file mode 100644 index a9638b0..0000000 --- a/src/handle_map.h +++ /dev/null @@ -1,36 +0,0 @@ -#ifndef SRC_HANDLE_MAP_H_ -#define SRC_HANDLE_MAP_H_ - -#include - -#include "common.h" -#include "unsafe_persistent.h" - -class HandleMap : public Nan::ObjectWrap { - public: - static void Initialize(Local target); - - private: - typedef std::map > Map; - - HandleMap(); - virtual ~HandleMap(); - - bool Has(WatcherHandle key) const; - bool Erase(WatcherHandle key); - void Clear(); - - static void DisposeHandle(NanUnsafePersistent& value); - - static NAN_METHOD(New); - static NAN_METHOD(Add); - static NAN_METHOD(Get); - static NAN_METHOD(Has); - static NAN_METHOD(Values); - static NAN_METHOD(Remove); - static NAN_METHOD(Clear); - - Map map_; -}; - -#endif // SRC_HANDLE_MAP_H_ diff --git a/src/main.cc b/src/main.cc deleted file mode 100644 index 898f45f..0000000 --- a/src/main.cc +++ /dev/null @@ -1,19 +0,0 @@ -#include "common.h" -#include "handle_map.h" - -namespace { - -void Init(Local exports) { - CommonInit(); - PlatformInit(); - - Nan::SetMethod(exports, "setCallback", SetCallback); - Nan::SetMethod(exports, "watch", Watch); - Nan::SetMethod(exports, "unwatch", Unwatch); - - HandleMap::Initialize(exports); -} - -} // namespace - -NODE_MODULE(pathwatcher, Init) diff --git a/src/main.coffee b/src/main.coffee deleted file mode 100644 index 81b6fb4..0000000 --- a/src/main.coffee +++ /dev/null @@ -1,137 +0,0 @@ -binding = require '../build/Release/pathwatcher.node' -{HandleMap} = binding -{Emitter} = require 'event-kit' -fs = require 'fs' -path = require 'path' - -handleWatchers = null - -class HandleWatcher - constructor: (@path) -> - @emitter = new Emitter() - @start() - - onEvent: (event, filePath, oldFilePath) -> - filePath = path.normalize(filePath) if filePath - oldFilePath = path.normalize(oldFilePath) if oldFilePath - - switch event - when 'rename' - # Detect atomic write. - @close() - detectRename = => - fs.stat @path, (err) => - if err # original file is gone it's a rename. - @path = filePath - # On OS X files moved to ~/.Trash should be handled as deleted. - if process.platform is 'darwin' and (/\/\.Trash\//).test(filePath) - @emitter.emit('did-change', {event: 'delete', newFilePath: null}) - @close() - else - @start() - @emitter.emit('did-change', {event: 'rename', newFilePath: filePath}) - else # atomic write. - @start() - @emitter.emit('did-change', {event: 'change', newFilePath: null}) - setTimeout(detectRename, 100) - when 'delete' - @emitter.emit('did-change', {event: 'delete', newFilePath: null}) - @close() - when 'unknown' - throw new Error("Received unknown event for path: #{@path}") - else - @emitter.emit('did-change', {event, newFilePath: filePath, oldFilePath: oldFilePath}) - - onDidChange: (callback) -> - @emitter.on('did-change', callback) - - start: -> - @handle = binding.watch(@path) - if handleWatchers.has(@handle) - troubleWatcher = handleWatchers.get(@handle) - troubleWatcher.close() - console.error("The handle(#{@handle}) returned by watching #{@path} is the same with an already watched path(#{troubleWatcher.path})") - handleWatchers.add(@handle, this) - - closeIfNoListener: -> - @close() if @emitter.getTotalListenerCount() is 0 - - close: -> - if handleWatchers.has(@handle) - binding.unwatch(@handle) - handleWatchers.remove(@handle) - -class PathWatcher - isWatchingParent: false - path: null - handleWatcher: null - - constructor: (filePath, callback) -> - @path = filePath - @emitter = new Emitter() - - # On Windows watching a file is emulated by watching its parent folder. - if process.platform is 'win32' - stats = fs.statSync(filePath) - @isWatchingParent = not stats.isDirectory() - - filePath = path.dirname(filePath) if @isWatchingParent - for watcher in handleWatchers.values() - if watcher.path is filePath - @handleWatcher = watcher - break - - @handleWatcher ?= new HandleWatcher(filePath) - - @onChange = ({event, newFilePath, oldFilePath}) => - switch event - when 'rename', 'change', 'delete' - @path = newFilePath if event is 'rename' - callback.call(this, event, newFilePath) if typeof callback is 'function' - @emitter.emit('did-change', {event, newFilePath}) - when 'child-rename' - if @isWatchingParent - @onChange({event: 'rename', newFilePath}) if @path is oldFilePath - else - @onChange({event: 'change', newFilePath: ''}) - when 'child-delete' - if @isWatchingParent - @onChange({event: 'delete', newFilePath: null}) if @path is newFilePath - else - @onChange({event: 'change', newFilePath: ''}) - when 'child-change' - @onChange({event: 'change', newFilePath: ''}) if @isWatchingParent and @path is newFilePath - when 'child-create' - @onChange({event: 'change', newFilePath: ''}) unless @isWatchingParent - - @disposable = @handleWatcher.onDidChange(@onChange) - - onDidChange: (callback) -> - @emitter.on('did-change', callback) - - close: -> - @emitter.dispose() - @disposable.dispose() - @handleWatcher.closeIfNoListener() - -exports.watch = (pathToWatch, callback) -> - unless handleWatchers? - handleWatchers = new HandleMap - binding.setCallback (event, handle, filePath, oldFilePath) -> - handleWatchers.get(handle).onEvent(event, filePath, oldFilePath) if handleWatchers.has(handle) - - new PathWatcher(path.resolve(pathToWatch), callback) - -exports.closeAllWatchers = -> - if handleWatchers? - watcher.close() for watcher in handleWatchers.values() - handleWatchers.clear() - -exports.getWatchedPaths = -> - paths = [] - if handleWatchers? - paths.push(watcher.path) for watcher in handleWatchers.values() - paths - -exports.File = require './file' -exports.Directory = require './directory' diff --git a/src/main.js b/src/main.js new file mode 100644 index 0000000..840fc86 --- /dev/null +++ b/src/main.js @@ -0,0 +1,644 @@ +let binding; +try { + binding = require('../build/Debug/pathwatcher.node'); +} catch (err) { + binding = require('../build/Release/pathwatcher.node'); +} + +const fs = require('fs'); +const path = require('path'); +const { Emitter, Disposable, CompositeDisposable } = require('event-kit'); + +let initialized = false; + +// Ensures a path that refers to a directory ends with a path separator. +function sep (dirPath) { + if (dirPath.endsWith(path.sep)) return dirPath; + return `${dirPath}${path.sep}`; +} + +function isDirectory (somePath) { + let stats = fs.statSync(somePath); + return stats.isDirectory(); +} + +class WatcherError extends Error { + constructor(message, code) { + super(message); + this.name = 'WatcherError'; + this.code = code; + } +} + +function getRealFilePath (filePath) { + try { + return fs.realpathSync(filePath) ?? filePath; + } catch (_err) { + return filePath; + } +} + +function isDirectory (filePath) { + let stats = fs.statSync(filePath); + return stats.isDirectory(); +} + +let NativeWatcherId = 1; + +// A “native” watcher instance that is responsible for managing watchers on +// various directories. +// +// Each `NativeWatcher` can supply file-watcher events for one or more +// `PathWatcher` instances; those `PathWatcher`s may care about all events in +// the watched directory, only events that affect a particular child of the +// directory, or even events that affect a descendant folder or file. +// +// We employ some common-sense measures to consolidate watchers when they want +// to watch similar paths. A `NativeWatcher` will start when a `PathWatcher` +// first subscribes to it; it will stop when no more `PathWatcher`s are +// subscribed. +class NativeWatcher { + // Holds _active_ `NativeWatcher` instances. A `NativeWatcher` is active if + // at least one consumer has subscribed to it via `onDidChange`; it becomes + // inactive whenever its last consumer unsubscribes. + static INSTANCES = new Map(); + + // Given a path, returns whatever existing active `NativeWatcher` is already + // watching that path, or creates one if it doesn’t yet exist. + // + // It is important that we don’t ask the bindings to create a new watcher for + // a native path that already exists, so this helps us prevent that from + // happening. + static findOrCreate (normalizedPath, options) { + for (let instance of this.INSTANCES.values()) { + if (instance.normalizedPath === normalizedPath) { + return instance; + } + } + return new NativeWatcher(normalizedPath, options); + } + + // Returns the number of active `NativeWatcher` instances. Depending on + // platform, a higher number may or may not be more demanding of the + // operating system. + static get instanceCount() { + return this.INSTANCES.size; + } + + constructor(normalizedPath, { recursive = false } = {}) { + this.id = NativeWatcherId++; + this.normalizedPath = normalizedPath; + this.emitter = new Emitter(); + this.subs = new CompositeDisposable(); + this.recursive = recursive; + this.running = false; + } + + get path () { + return this.normalizedPath; + } + + get listenerCount () { + return this.emitter.listenerCountForEventName('did-change'); + } + + start () { + if (this.running) return; + if (!fs.existsSync(this.normalizedPath)) { + // We can't start a watcher on a path that doesn't exist. + return; + } + this.handle = binding.watch(this.normalizedPath, this.recursive); + NativeWatcher.INSTANCES.set(this.handle, this); + this.running = true; + this.emitter.emit('did-start'); + } + + onDidStart (callback) { + return this.emitter.on('did-start', callback); + } + + onDidChange (callback) { + this.start(); + + let sub = this.emitter.on('did-change', callback); + return new Disposable(() => { + sub.dispose(); + if (this.emitter.listenerCountForEventName('did-change') === 0) { + this.stop(); + } + }); + } + + onShouldDetach (callback) { + return this.emitter.on('should-detach', callback); + } + + onWillStop (callback) { + return this.emitter.on('will-stop', callback); + } + + onDidStop () { + return this.emitter.on('did-stop', callback); + } + + onDidError (callback) { + return this.emitter.on('did-error', callback); + } + + stop (shutdown = false) { + if (this.running) { + this.emitter.emit('will-stop', shutdown); + binding.unwatch(this.handle); + this.running = false; + this.emitter.emit('did-stop', shutdown); + } + + NativeWatcher.INSTANCES.delete(this.handle); + } + + dispose () { + this.emitter.dispose(); + } + + onEvent (event) { + this.emitter.emit('did-change', event); + } + + onError (err) { + this.emitter.emit('did-error', err); + } +} + +let PathWatcherId = 10; + +// A class responsible for watching a particular directory or file on the +// filesystem. +// +// A `PathWatcher` is backed by a `NativeWatcher` that is guaranteed to notify +// it about the events it cares about, and often other events it _doesn’t_ care +// about; it’s the `PathWatcher`’s job to filter this stream and ignore the +// irrelevant events. +// +// For instance, a `NativeWatcher` can only watch a directory, but a +// `PathWatcher` can watch a specific file in the directory. In that case, it’s +// up to the `PathWatcher` to ignore any events that do not pertain to that +// file. +// +// A `PathWatcher` might be asked to switch from one `NativeWatcher` to another +// after creation. As more `PathWatcher`s are created, and more +// `NativeWatchers` are created to support them, opportunities for +// consolidation and reuse might present themselves. For instance, sibling +// watchers with two different `NativeWatcher`s might trigger the creation of a +// new `NativeWatcher` pointing to their shared parent directory. +// +// In these scenarios, the new `NativeWatcher` is created before the old one is +// destroyed; the goal is that the switch from one `NativeWatcher` to another +// is atomic and results in no missed filesystem events. The old watcher will +// be disposed of once no `PathWatcher`s are listening to it anymore. +class PathWatcher { + constructor (watchedPath) { + this.id = PathWatcherId++; + this.watchedPath = watchedPath; + + this.normalizePath = null; + this.native = null; + this.changeCallbacks = new Map(); + + this.emitter = new Emitter(); + this.subs = new CompositeDisposable(); + + // NOTE: Right now we have the constraint that we can't watch a path that + // doesn't yet exist. This is a long-standing behavior of `pathwatcher` and + // would have to be changed carefully if it were changed at all. + if (!fs.existsSync(watchedPath)) { + throw new WatcherError('Unable to watch path', 'ENOENT'); + } + + // Because `pathwatcher` is historically a very synchronous API, you'll see + // lots of synchronous `fs` calls in this code. This is done for + // backward-compatibility. It's a medium-term goal for us to reduce our + // dependence on this library and move its consumers to a file-watcher + // contract with an asynchronous API. + this.normalizedPath = getRealFilePath(watchedPath); + // try { + // this.normalizedPath = fs.realpathSync(watchedPath) ?? watchedPath; + // } catch (err) { + // this.normalizedPath = watchedPath; + // } + + // We must watch a directory. If this is a file, we must watch its parent. + // If this is a directory, we can watch it directly. This flag helps us + // keep track of it. + this.isWatchingParent = !isDirectory(this.normalizedPath); + + // `originalNormalizedPath` will always contain the resolved (real path on + // disk) file path that we care about. + this.originalNormalizedPath = this.normalizedPath; + if (this.isWatchingParent) { + // `normalizedPath` will always contain the path to the directory we mean + // to watch. + this.normalizedPath = path.dirname(this.normalizedPath); + } + + this.attachedPromise = new Promise(resolve => { + this.resolveAttachedPromise = resolve; + }); + + this.startPromise = new Promise((resolve, reject) => { + this.resolveStartPromise = resolve; + this.rejectStartPromise = reject; + }); + + this.active = true; + } + + getNormalizedPath() { + return this.normalizedPath; + } + + getNormalizedPathPromise () { + return Promise.resolve(this.normalizedPath); + } + + onDidChange (callback) { + // We don't try to create a native watcher until something subscribes to + // our `did-change` events. + if (this.native) { + let sub = this.native.onDidChange(event => { + this.onNativeEvent(event, callback); + }); + this.changeCallbacks.set(callback, sub); + this.native.start(); + } else { + // We don't have a native watcher yet, so we’ll ask the registry to + // assign one to us. This could be a brand-new instance or one that was + // already watching one of our ancestor folders. + this.native = NativeWatcher.findOrCreate(this.normalizedPath); + this.onDidChange(callback); + } + + return new Disposable(() => { + let sub = this.changeCallbacks.get(callback); + this.changeCallbacks.delete(callback); + sub.dispose(); + }); + } + + onDidError (callback) { + return this.emitter.on('did-error', callback); + } + + // Attach a `NativeWatcher` to this `PathWatcher`. + attachToNative (native) { + this.subs.dispose(); + this.subs = new CompositeDisposable(); + this.native = native; + if (native.running) { + this.resolveStartPromise(); + } else { + this.subs.add( + native.onDidStart(() => this.resolveStartPromise()) + ); + } + + // Transfer any native event subscriptions to the new NativeWatcher. + for (let [callback, formerSub] of this.changeCallbacks) { + let newSub = native.onDidChange(event => { + return this.onNativeEvent(event, callback); + }); + this.changeCallbacks.set(callback, newSub); + formerSub.dispose(); + } + + this.subs.add( + native.onDidError(err => this.emitter.emit('did-error', err)) + ); + + this.subs.add( + native.onShouldDetach(({ replacement, watchedPath }) => { + // When we close all native watchers, we set this flag; we don't want + // it to trigger a flurry of new watcher creation. + if (isClosingAllWatchers) return; + + // The `NativeWatcher` is telling us that it may shut down; it’s + // offering a replacement `NativeWatcher`. We are in charge of whether + // we jump ship, though: + // + // * Are we even watching a path anymore? Maybe this was triggered + // because we called our own `close` method. + // * Is it trying to get us to “switch” to the `NativeWatcher` we’re + // already using? + // * Sanity check: is this even a `NativeWatcher` we can use? + // + // Keep in mind that a `NativeWatcher` isn’t doomed to be stopped + // unless it has signaled a `will-stop` event. If that hasn’t happened, + // then `should-detach` is merely offering a suggestion. + if ( + this.active && + this.native === native && + replacement !== native && + this.normalizedPath?.startsWith(watchedPath) + ) { + this.attachToNative(replacement, replacement.normalizedPath); + } + }) + ); + + this.subs.add( + native.onWillStop(() => { + if (this.native !== native) return; + this.subs.dispose(); + this.native = null; + }) + ); + + this.resolveAttachedPromise(); + } + + rename (newName) { + this.close(); + try { + this.normalizedPath = fs.realpathSync(newName); + } catch (err) { + this.normalizedPath = newName; + } + + let stats = fs.statSync(this.normalizedPath); + this.isWatchingParent = !stats.isDirectory(); + + this.originalNormalizedPath = this.normalizedPath; + if (!stats.isDirectory()) { + this.normalizedPath = path.dirname(this.normalizedPath); + } + + this.native = NativeWatcher.findOrCreate(this.normalizedPath); + this.active = true; + } + + onNativeEvent (event, callback) { + // console.debug( + // 'PathWatcher::onNativeEvent', + // event, + // 'for watcher of path:', + // this.originalNormalizedPath + // ); + + let isWatchedPath = (eventPath) => { + if (eventPath === this.normalizedPath) return true; + return eventPath?.startsWith(sep(this.normalizedPath)); + } + + // Does `event.path` match the exact path our `PathWatcher` cares about? + let eventPathIsEqual = this.originalNormalizedPath === event.path; + // Does `event.oldPath` match the exact path our `PathWatcher` cares about? + let eventOldPathIsEqual = this.originalNormalizedPath === event.oldPath; + + // Is `event.path` somewhere within the folder that this `PathWatcher` is + // monitoring? + let newWatched = isWatchedPath(event.path); + // Is `event.oldPath` somewhere within the folder that this `PathWatcher` + // is monitoring? + let oldWatched = isWatchedPath(event.oldPath); + + let newEvent = { ...event }; + + if (!newWatched && !oldWatched) { + return; + } + + + switch (newEvent.action) { + case 'rename': + // This event needs no alteration
 as long as it relates to the file + // we care about. + if (!eventPathIsEqual && !eventOldPathIsEqual) return; + break; + case 'change': + case 'delete': + case 'create': + // These events need no alteration
 as long as they relate to the file + // we care about. + if (!eventPathIsEqual) return; + break; + case 'child-create': + if (!this.isWatchingParent) { + if (eventPathIsEqual) { + // We're watching a directory and this is a create event for the + // directory itself. This should be fixed in the bindings, but for + // now we can switch the event type in the JS. + newEvent.action = 'create'; + } else { + newEvent.action = 'change'; + newEvent.path = ''; + } + break; + } else if (eventPathIsEqual) { + newEvent.action = 'create'; + } + break; + case 'child-delete': + if (!this.isWatchingParent) { + newEvent.action = 'change'; + newEvent.path = ''; + } else if (eventPathIsEqual) { + newEvent.action = 'delete'; + } + break; + case 'child-rename': + // TODO: Laziness in the native addon means that even events that + // happen to the directory itself are reported as `child-rename` + // instead of `rename`. We can fix this in the JS for now, but it + // should eventually be fixed in the C++. + + // First, weed out the cases that can't possibly affect us. + let pathIsInvolved = eventPathIsEqual || eventOldPathIsEqual; + + // The only cases for which we should return early are the ones where + // (a) we're watching a file, and (b) this event doesn't involve it + // in any way. + if (this.isWatchingParent && !pathIsInvolved) { + return; + } + + if (!this.isWatchingParent && !pathIsInvolved) { + // We're watching a directory and these events involve something + // inside of the directory. + if ( + path.dirname(event.path) === this.normalizedPath || + path.dirname(event.oldPath) === this.normalizedPath + ) { + // This is a direct child of the directory, so we'll fire an + // event. + newEvent.action = 'change'; + newEvent.path = ''; + } else { + // Changes in ancestors or descendants do not concern us, so + // we'll return early. + // + // TODO: Changes in ancestors might, actually; they might need to + // be treated as folder deletions/creations. + return; + } + } else { + // We're left with cases where + // + // * We're watching a directory and that directory is named by the + // event, or + // * We're watching a file (via a directory watch) and that file is + // named by the event. + // + // Those cases are handled identically. + + if (newWatched && this.originalNormalizedPath !== event.path) { + // The file/directory we care about has moved to a new destination + // and that destination is visible to this watcher. That means we + // can simply update the path we care about and keep path-watching. + this.moveToPath(event.path); + } + + if (oldWatched && newWatched) { + // We can keep tabs on both file paths from here, so this will + // be treated as a rename. + newEvent.action = 'rename'; + } else if (oldWatched && !newWatched) { + // We're moving the file to a place we're not observing, so + // we'll treat it as a deletion. + newEvent.action = 'delete'; + } else if (!oldWatched && newWatched) { + // The file came from someplace we're not watching, so it might + // as well be a file creation. + newEvent.action = 'create'; + } + } + break; + case 'child-change': + if (!this.isWatchingParent) { + // We are watching a directory. + if (eventPathIsEqual) { + // This makes no sense; we won't fire a `child-change` on a + // directory. Ignore it. + return; + } else { + newEvent.action = 'change'; + newEvent.path = ''; + } + } else { + if (eventPathIsEqual) { + newEvent.action = 'change'; + newEvent.path = ''; + } else { + return; + } + } + break; + } // end switch + + if (eventPathIsEqual && newEvent.action === 'create') { + // This file or directory already existed; we checked. Any `create` + // event for it is spurious. + return; + } + + if (eventPathIsEqual && newEvent.action === 'delete') { + // Specs require that a `delete` action carry a path of `null`. + // + // NOTE: We might want to revisit this and change what the specs test! + newEvent.path = null; + // newEvent.path = newEvent.action === 'delete' ? null : newEvent.path; + } + // console.debug( + // 'FINAL EVENT ACTION:', + // newEvent.action, + // 'PATH', + // newEvent.path + // ); + callback(newEvent.action, newEvent.path); + } + + moveToPath (newPath) { + this.isWatchingParent = !isDirectory(newPath); + if (this.isWatchingParent) { + // Watching a directory just because we care about a specific file inside + // it. + this.originalNormalizedPath = newPath; + this.normalizedPath = path.dirname(newPath); + } else { + // Actually watching a directory. + this.originalNormalizedPath = newPath; + this.normalizedPath = newPath; + } + } + + dispose () { + this.disposing = true; + for (let sub of this.changeCallbacks.values()) { + sub.dispose(); + } + + this.emitter.dispose(); + this.subs.dispose(); + } + + close () { + this.active = false; + this.dispose(); + } +} + +class WatcherEvent { + constructor(event, filePath, oldFilePath) { + this.action = event; + this.path = filePath; + this.oldPath = oldFilePath; + } +} + +function DEFAULT_CALLBACK(action, handle, filePath, oldFilePath) { + if (!NativeWatcher.INSTANCES.has(handle)) { + // Might be a stray callback from a `NativeWatcher` that has already + // stopped. + return; + } + + let watcher = NativeWatcher.INSTANCES.get(handle); + let event = new WatcherEvent(action, filePath, oldFilePath); + watcher.onEvent(event); +} + +function watch (pathToWatch, callback) { + if (!initialized) { + binding.setCallback(DEFAULT_CALLBACK); + initialized = true; + } + let watcher = new PathWatcher(path.resolve(pathToWatch)); + watcher.onDidChange(callback); + return watcher; +} + +let isClosingAllWatchers = false; +function closeAllWatchers () { + isClosingAllWatchers = true; + for (let watcher of NativeWatcher.INSTANCES.values()) { + watcher.stop(true); + } + NativeWatcher.INSTANCES.clear(); + isClosingAllWatchers = false; +} + +function getWatchedPaths () { + let watchers = Array.from(NativeWatcher.INSTANCES.values()); + let result = watchers.map(w => w.normalizedPath); + return result +} + +const File = require('./file'); +const Directory = require('./directory'); + +module.exports = { + watch, + closeAllWatchers, + getWatchedPaths, + File, + Directory +}; diff --git a/src/pathwatcher_linux.cc b/src/pathwatcher_linux.cc deleted file mode 100644 index 13e6a0b..0000000 --- a/src/pathwatcher_linux.cc +++ /dev/null @@ -1,88 +0,0 @@ -#include -#include - -#include -#include -#include -#include - -#include - -#include "common.h" - -static int g_inotify; -static int g_init_errno; - -void PlatformInit() { - g_inotify = inotify_init(); - if (g_inotify == -1) { - g_init_errno = errno; - return; - } - - WakeupNewThread(); -} - -void PlatformThread() { - // Needs to be large enough for sizeof(inotify_event) + strlen(filename). - char buf[4096]; - - while (true) { - int size; - do { - size = read(g_inotify, buf, sizeof(buf)); - } while (size == -1 && errno == EINTR); - - if (size == -1) { - break; - } else if (size == 0) { - break; - } - - inotify_event* e; - for (char* p = buf; p < buf + size; p += sizeof(*e) + e->len) { - e = reinterpret_cast(p); - - int fd = e->wd; - EVENT_TYPE type; - std::vector path; - - // Note that inotify won't tell us where the file or directory has been - // moved to, so we just treat IN_MOVE_SELF as file being deleted. - if (e->mask & (IN_ATTRIB | IN_CREATE | IN_DELETE | IN_MODIFY | IN_MOVE)) { - type = EVENT_CHANGE; - } else if (e->mask & (IN_DELETE_SELF | IN_MOVE_SELF)) { - type = EVENT_DELETE; - } else { - continue; - } - - PostEventAndWait(type, fd, path); - } - } -} - -WatcherHandle PlatformWatch(const char* path) { - if (g_inotify == -1) { - return -g_init_errno; - } - - int fd = inotify_add_watch(g_inotify, path, IN_ATTRIB | IN_CREATE | - IN_DELETE | IN_MODIFY | IN_MOVE | IN_MOVE_SELF | IN_DELETE_SELF); - if (fd == -1) { - return -errno; - } - return fd; -} - -void PlatformUnwatch(WatcherHandle fd) { - inotify_rm_watch(g_inotify, fd); -} - -bool PlatformIsHandleValid(WatcherHandle handle) { - return handle >= 0; -} - -int PlatformInvalidHandleToErrorNumber(WatcherHandle handle) { - return -handle; -} diff --git a/src/pathwatcher_unix.cc b/src/pathwatcher_unix.cc deleted file mode 100644 index d88865e..0000000 --- a/src/pathwatcher_unix.cc +++ /dev/null @@ -1,109 +0,0 @@ -#include -#include -#include -#include -#include -#include - -#include - -#include "common.h" - -// test for descriptor event notification, if not available set to O_RDONLY -#ifndef O_EVTONLY -#define O_EVTONLY O_RDONLY -#endif - -// test for flag to return full path of the fd -// if not then set value as defined by mac -// see: http://fxr.watson.org/fxr/source/bsd/sys/fcntl.h?v=xnu-792.6.70 -#ifndef F_GETPATH -#define F_GETPATH 50 -#endif - -static int g_kqueue; -static int g_init_errno; - -void PlatformInit() { - g_kqueue = kqueue(); - if (g_kqueue == -1) { - g_init_errno = errno; - return; - } - - WakeupNewThread(); -} - -void PlatformThread() { - struct kevent event; - - while (true) { - int r; - do { - r = kevent(g_kqueue, NULL, 0, &event, 1, NULL); - } while ((r == -1 && errno == EINTR) || r == 0); - - EVENT_TYPE type; - int fd = static_cast(event.ident); - std::vector path; - - if (event.fflags & NOTE_WRITE) { - type = EVENT_CHANGE; - } else if (event.fflags & NOTE_DELETE) { - type = EVENT_DELETE; - } else if (event.fflags & NOTE_RENAME) { - type = EVENT_RENAME; - char buffer[MAXPATHLEN] = { 0 }; - fcntl(fd, F_GETPATH, buffer); - close(fd); - - int length = strlen(buffer); - path.resize(length); - std::copy(buffer, buffer + length, path.data()); - } else if (event.fflags & NOTE_ATTRIB && lseek(fd, 0, SEEK_END) == 0) { - // The file became empty, this does not fire as a NOTE_WRITE event for - // some reason. - type = EVENT_CHANGE; - } else { - continue; - } - - PostEventAndWait(type, fd, path); - } -} - -WatcherHandle PlatformWatch(const char* path) { - if (g_kqueue == -1) { - return -g_init_errno; - } - - int fd = open(path, O_EVTONLY, 0); - if (fd < 0) { - return -errno; - } - - struct timespec timeout = { 0, 0 }; - struct kevent event; - int filter = EVFILT_VNODE; - int flags = EV_ADD | EV_ENABLE | EV_CLEAR; - int fflags = NOTE_WRITE | NOTE_DELETE | NOTE_RENAME | NOTE_ATTRIB; - EV_SET(&event, fd, filter, flags, fflags, 0, reinterpret_cast(const_cast(path))); - int r = kevent(g_kqueue, &event, 1, NULL, 0, &timeout); - if (r == -1) { - return -errno; - } - - return fd; -} - -void PlatformUnwatch(WatcherHandle fd) { - close(fd); -} - -bool PlatformIsHandleValid(WatcherHandle handle) { - return handle >= 0; -} - -int PlatformInvalidHandleToErrorNumber(WatcherHandle handle) { - return -handle; -} diff --git a/src/pathwatcher_win.cc b/src/pathwatcher_win.cc deleted file mode 100644 index 1a99bd4..0000000 --- a/src/pathwatcher_win.cc +++ /dev/null @@ -1,313 +0,0 @@ -#include -#include -#include - -#include "common.h" - -// Size of the buffer to store result of ReadDirectoryChangesW. -static const unsigned int kDirectoryWatcherBufferSize = 4096; - -// Object template to create representation of WatcherHandle. -static Nan::Persistent g_object_template; - -// Mutex for the HandleWrapper map. -static uv_mutex_t g_handle_wrap_map_mutex; - -// The events to be waited on. -static std::vector g_events; - -// The dummy event to wakeup the thread. -static HANDLE g_wake_up_event; - -// The dummy event to ensure we are not waiting on a file handle when destroying it. -static HANDLE g_file_handles_free_event; - -struct ScopedLocker { - explicit ScopedLocker(uv_mutex_t& mutex) : mutex_(&mutex) { uv_mutex_lock(mutex_); } - ~ScopedLocker() { Unlock(); } - - void Unlock() { uv_mutex_unlock(mutex_); } - - uv_mutex_t* mutex_; -}; - -struct HandleWrapper { - HandleWrapper(WatcherHandle handle, const char* path_str) - : dir_handle(handle), - path(strlen(path_str)), - canceled(false) { - memset(&overlapped, 0, sizeof(overlapped)); - overlapped.hEvent = CreateEvent(NULL, FALSE, FALSE, NULL); - g_events.push_back(overlapped.hEvent); - - std::copy(path_str, path_str + path.size(), path.data()); - map_[overlapped.hEvent] = this; - } - - ~HandleWrapper() { - if (!canceled) { - Cancel(); - } - - CloseHandle(dir_handle); - CloseHandle(overlapped.hEvent); - } - - void Cancel() { - canceled = true; - CancelIoEx(dir_handle, &overlapped); - g_events.erase(std::remove(g_events.begin(), g_events.end(), overlapped.hEvent), g_events.end()); - map_.erase(overlapped.hEvent); - } - - WatcherHandle dir_handle; - std::vector path; - bool canceled; - OVERLAPPED overlapped; - char buffer[kDirectoryWatcherBufferSize]; - - static HandleWrapper* Get(HANDLE key) { return map_[key]; } - - static std::map map_; -}; - -std::map HandleWrapper::map_; - -struct WatcherEvent { - EVENT_TYPE type; - WatcherHandle handle; - std::vector new_path; - std::vector old_path; -}; - -static bool QueueReaddirchanges(HandleWrapper* handle) { - return ReadDirectoryChangesW(handle->dir_handle, - handle->buffer, - kDirectoryWatcherBufferSize, - FALSE, - FILE_NOTIFY_CHANGE_FILE_NAME | - FILE_NOTIFY_CHANGE_DIR_NAME | - FILE_NOTIFY_CHANGE_ATTRIBUTES | - FILE_NOTIFY_CHANGE_SIZE | - FILE_NOTIFY_CHANGE_LAST_WRITE | - FILE_NOTIFY_CHANGE_LAST_ACCESS | - FILE_NOTIFY_CHANGE_CREATION | - FILE_NOTIFY_CHANGE_SECURITY, - NULL, - &handle->overlapped, - NULL) == TRUE; -} - -Local WatcherHandleToV8Value(WatcherHandle handle) { - Local context = Nan::GetCurrentContext(); - Local value = Nan::New(g_object_template)->NewInstance(context).ToLocalChecked(); - Nan::SetInternalFieldPointer(value->ToObject(context).ToLocalChecked(), 0, handle); - return value; -} - -WatcherHandle V8ValueToWatcherHandle(Local value) { - return reinterpret_cast(Nan::GetInternalFieldPointer( - value->ToObject(Nan::GetCurrentContext()).ToLocalChecked(), 0)); -} - -bool IsV8ValueWatcherHandle(Local value) { - return value->IsObject() && - value->ToObject(Nan::GetCurrentContext()).ToLocalChecked()->InternalFieldCount() == 1; -} - -void PlatformInit() { - uv_mutex_init(&g_handle_wrap_map_mutex); - - g_file_handles_free_event = CreateEvent(NULL, TRUE, TRUE, NULL); - g_wake_up_event = CreateEvent(NULL, FALSE, FALSE, NULL); - g_events.push_back(g_wake_up_event); - - g_object_template.Reset(Nan::New()); - Nan::New(g_object_template)->SetInternalFieldCount(1); - - WakeupNewThread(); -} - -void PlatformThread() { - while (true) { - // Do not use g_events directly, since reallocation could happen when there - // are new watchers adding to g_events when WaitForMultipleObjects is still - // polling. - ScopedLocker locker(g_handle_wrap_map_mutex); - std::vector copied_events(g_events); - locker.Unlock(); - - ResetEvent(g_file_handles_free_event); - DWORD r = WaitForMultipleObjects(copied_events.size(), - copied_events.data(), - FALSE, - INFINITE); - SetEvent(g_file_handles_free_event); - int i = r - WAIT_OBJECT_0; - if (i >= 0 && i < copied_events.size()) { - // It's a wake up event, there is no fs events. - if (copied_events[i] == g_wake_up_event) - continue; - - ScopedLocker locker(g_handle_wrap_map_mutex); - - HandleWrapper* handle = HandleWrapper::Get(copied_events[i]); - if (!handle || handle->canceled) - continue; - - DWORD bytes_transferred; - if (!GetOverlappedResult(handle->dir_handle, &handle->overlapped, &bytes_transferred, FALSE)) - continue; - if (bytes_transferred == 0) - continue; - - std::vector old_path; - std::vector events; - - DWORD offset = 0; - while (true) { - FILE_NOTIFY_INFORMATION* file_info = - reinterpret_cast(handle->buffer + offset); - - // Emit events for children. - EVENT_TYPE event = EVENT_NONE; - switch (file_info->Action) { - case FILE_ACTION_ADDED: - event = EVENT_CHILD_CREATE; - break; - case FILE_ACTION_REMOVED: - event = EVENT_CHILD_DELETE; - break; - case FILE_ACTION_RENAMED_OLD_NAME: - event = EVENT_CHILD_RENAME; - break; - case FILE_ACTION_RENAMED_NEW_NAME: - event = EVENT_CHILD_RENAME; - break; - case FILE_ACTION_MODIFIED: - event = EVENT_CHILD_CHANGE; - break; - } - - if (event != EVENT_NONE) { - // The FileNameLength is in "bytes", but the WideCharToMultiByte - // requires the length to be in "characters"! - int file_name_length_in_characters = - file_info->FileNameLength / sizeof(wchar_t); - - char filename[MAX_PATH] = { 0 }; - int size = WideCharToMultiByte(CP_UTF8, - 0, - file_info->FileName, - file_name_length_in_characters, - filename, - MAX_PATH, - NULL, - NULL); - - // Convert file name to file path, same with: - // path = handle->path + '\\' + filename - std::vector path(handle->path.size() + 1 + size); - std::vector::iterator iter = path.begin(); - iter = std::copy(handle->path.begin(), handle->path.end(), iter); - *(iter++) = '\\'; - std::copy(filename, filename + size, iter); - - if (file_info->Action == FILE_ACTION_RENAMED_OLD_NAME) { - // Do not send rename event until the NEW_NAME event, but still keep - // a record of old name. - old_path.swap(path); - } else if (file_info->Action == FILE_ACTION_RENAMED_NEW_NAME) { - WatcherEvent e = { event, handle->overlapped.hEvent }; - e.new_path.swap(path); - e.old_path.swap(old_path); - events.push_back(e); - } else { - WatcherEvent e = { event, handle->overlapped.hEvent }; - e.new_path.swap(path); - events.push_back(e); - } - } - - if (file_info->NextEntryOffset == 0) break; - offset += file_info->NextEntryOffset; - } - - // Restart the monitor, it was reset after each call. - QueueReaddirchanges(handle); - - locker.Unlock(); - - for (size_t i = 0; i < events.size(); ++i) - PostEventAndWait(events[i].type, - events[i].handle, - events[i].new_path, - events[i].old_path); - } - } -} - -WatcherHandle PlatformWatch(const char* path) { - wchar_t wpath[MAX_PATH] = { 0 }; - MultiByteToWideChar(CP_UTF8, 0, path, -1, wpath, MAX_PATH); - - // Requires a directory, file watching is emulated in js. - DWORD attr = GetFileAttributesW(wpath); - if (attr == INVALID_FILE_ATTRIBUTES || !(attr & FILE_ATTRIBUTE_DIRECTORY)) { - return INVALID_HANDLE_VALUE; - } - - WatcherHandle dir_handle = CreateFileW(wpath, - FILE_LIST_DIRECTORY, - FILE_SHARE_READ | FILE_SHARE_DELETE | - FILE_SHARE_WRITE, - NULL, - OPEN_EXISTING, - FILE_FLAG_BACKUP_SEMANTICS | - FILE_FLAG_OVERLAPPED, - NULL); - if (!PlatformIsHandleValid(dir_handle)) { - return INVALID_HANDLE_VALUE; - } - - std::unique_ptr handle; - { - ScopedLocker locker(g_handle_wrap_map_mutex); - handle.reset(new HandleWrapper(dir_handle, path)); - } - - if (!QueueReaddirchanges(handle.get())) { - return INVALID_HANDLE_VALUE; - } - - // Wake up the thread to add the new event. - SetEvent(g_wake_up_event); - - // The pointer is leaked if no error happened. - return handle.release()->overlapped.hEvent; -} - -void PlatformUnwatch(WatcherHandle key) { - if (PlatformIsHandleValid(key)) { - HandleWrapper* handle; - { - ScopedLocker locker(g_handle_wrap_map_mutex); - handle = HandleWrapper::Get(key); - handle->Cancel(); - } - - do { - SetEvent(g_wake_up_event); - } while (WaitForSingleObject(g_file_handles_free_event, 50) == WAIT_TIMEOUT); - delete handle; - } -} - -bool PlatformIsHandleValid(WatcherHandle handle) { - return handle != INVALID_HANDLE_VALUE; -} - -// We have no errno on Windows. -int PlatformInvalidHandleToErrorNumber(WatcherHandle handle) { - return 0; -} diff --git a/src/unsafe_persistent.h b/src/unsafe_persistent.h deleted file mode 100644 index 6b2fb8a..0000000 --- a/src/unsafe_persistent.h +++ /dev/null @@ -1,52 +0,0 @@ -#ifndef UNSAFE_PERSISTENT_H_ -#define UNSAFE_PERSISTENT_H_ - -#include "nan.h" - -#if NODE_VERSION_AT_LEAST(0, 11, 0) -template -struct NanUnsafePersistentTraits { - typedef v8::Persistent > HandleType; - static const bool kResetInDestructor = false; - template - static V8_INLINE void Copy(const Persistent& source, - HandleType* dest) { - // do nothing, just allow copy - } -}; -template -class NanUnsafePersistent : public NanUnsafePersistentTraits::HandleType { - public: - V8_INLINE NanUnsafePersistent() {} - - template - V8_INLINE NanUnsafePersistent(v8::Isolate* isolate, S that) - : NanUnsafePersistentTraits::HandleType(isolate, that) { - } -}; -template -NAN_INLINE void NanAssignUnsafePersistent( - NanUnsafePersistent& handle - , v8::Local obj) { - handle.Reset(); - handle = NanUnsafePersistent(v8::Isolate::GetCurrent(), obj); -} -template -NAN_INLINE v8::Local NanUnsafePersistentToLocal(const NanUnsafePersistent &arg1) { - return v8::Local::New(v8::Isolate::GetCurrent(), arg1); -} -#define NanDisposeUnsafePersistent(handle) handle.Reset() -#else -#define NanUnsafePersistent v8::Persistent -#define NanUnsafePersistentToLocal Nan::New -#define NanDisposeUnsafePersistent(handle) handle.Dispose() -template -NAN_INLINE void NanAssignUnsafePersistent( - v8::Persistent& handle - , v8::Local obj) { - handle.Dispose(); - handle = v8::Persistent::New(obj); -} -#endif - -#endif // UNSAFE_PERSISTENT_H_ diff --git a/vendor/efsw/.DS_Store b/vendor/efsw/.DS_Store new file mode 100644 index 0000000..5008ddf Binary files /dev/null and b/vendor/efsw/.DS_Store differ diff --git a/vendor/efsw/.clang-format b/vendor/efsw/.clang-format new file mode 100644 index 0000000..7a55b3d --- /dev/null +++ b/vendor/efsw/.clang-format @@ -0,0 +1,18 @@ +ï»ż--- +AlignEscapedNewlines: Left +AllowAllConstructorInitializersOnNextLine: 'true' +AllowAllParametersOfDeclarationOnNextLine: 'true' +AllowShortFunctionsOnASingleLine: Inline +BreakConstructorInitializers: AfterColon +ColumnLimit: '100' +CompactNamespaces: 'true' +ConstructorInitializerAllOnOneLineOrOnePerLine: 'true' +ContinuationIndentWidth: '4' +IndentCaseLabels: 'true' +IndentWidth: '4' +PointerAlignment: Left +SpacesInParentheses: 'true' +TabWidth: '4' +UseTab: Always + +... diff --git a/vendor/efsw/.ecode/project_build.json b/vendor/efsw/.ecode/project_build.json new file mode 100644 index 0000000..625df0e --- /dev/null +++ b/vendor/efsw/.ecode/project_build.json @@ -0,0 +1,170 @@ +{ + "linux-debug": { + "build": [ + { + "args": " --thread-sanitizer --verbose gmake2", + "command": "premake5", + "working_dir": "" + }, + { + "args": "-j${nproc} -C make/linux", + "command": "make", + "working_dir": "" + } + ], + "build_types": [], + "clean": [ + { + "args": "", + "command": "", + "working_dir": "" + } + ], + "config": { + "clear_sys_env": false + }, + "os": [ + "linux" + ], + "output_parser": { + "config": { + "preset": "generic", + "relative_file_paths": true + } + } + }, + "linux-release": { + "build": [ + { + "args": "gmake2", + "command": "premake5", + "working_dir": "" + }, + { + "args": "-j${nproc} -C make/linux -e config=release_x86_64", + "command": "make", + "working_dir": "" + } + ], + "build_types": [], + "clean": [ + { + "args": "", + "command": "", + "working_dir": "" + } + ], + "config": { + "clear_sys_env": false + }, + "os": [ + "linux" + ], + "output_parser": { + "config": { + "preset": "generic", + "relative_file_paths": true + } + } + }, + "linux-relwithdbginfo": { + "build": [ + { + "args": "gmake2", + "command": "premake5", + "working_dir": "" + }, + { + "args": "-j${nproc} -C make/linux -e config=relwithdbginfo_x86_64", + "command": "make", + "working_dir": "" + } + ], + "build_types": [], + "clean": [ + { + "args": "", + "command": "", + "working_dir": "" + } + ], + "config": { + "clear_sys_env": false + }, + "os": [ + "linux" + ], + "output_parser": { + "config": { + "preset": "generic", + "relative_file_paths": true + } + } + }, + "mingw-debug": { + "build": [ + { + "args": "--os=windows gmake2", + "command": "premake5", + "working_dir": "" + }, + { + "args": "-j${nproc} -C make/windows", + "command": "mingw64-make", + "working_dir": "" + } + ], + "build_types": [], + "clean": [ + { + "args": "", + "command": "", + "working_dir": "" + } + ], + "config": { + "clear_sys_env": false + }, + "os": [ + "linux" + ], + "output_parser": { + "config": { + "relative_file_paths": true + } + } + }, + "mingw-release": { + "build": [ + { + "args": "--os=windows gmake2", + "command": "premake5", + "working_dir": "" + }, + { + "args": "-j${nproc} -C make/windows -e config=release_x86_64", + "command": "mingw64-make", + "working_dir": "" + } + ], + "build_types": [], + "clean": [ + { + "args": "", + "command": "", + "working_dir": "" + } + ], + "config": { + "clear_sys_env": false + }, + "os": [ + "linux" + ], + "output_parser": { + "config": { + "relative_file_paths": true + } + } + } +} \ No newline at end of file diff --git a/vendor/efsw/.github/workflows/main.yml b/vendor/efsw/.github/workflows/main.yml new file mode 100644 index 0000000..1e3c8f1 --- /dev/null +++ b/vendor/efsw/.github/workflows/main.yml @@ -0,0 +1,52 @@ +name: build + +on: [push, pull_request] + +jobs: + Linux: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Install dependencies + run: | + sudo apt-get update + sudo apt-get install -y wget + wget https://github.com/premake/premake-core/releases/download/v5.0.0-alpha14/premake-5.0.0-alpha14-linux.tar.gz + tar xvzf premake-5.0.0-alpha14-linux.tar.gz + - name: Build + run: | + ./premake5 --verbose gmake2 + cd make/linux + make all + MacOS: + runs-on: macos-latest + steps: + - uses: actions/checkout@v2 + - name: Install dependencies + run: | + brew install wget + wget https://github.com/premake/premake-core/releases/download/v5.0.0-alpha14/premake-5.0.0-alpha14-macosx.tar.gz + tar -xzf premake-5.0.0-alpha14-macosx.tar.gz + - name: Build + run: | + ./premake5 --verbose gmake2 + make -C make/macosx/ -j`nproc` all + Windows: + runs-on: windows-2019 + env: + MSBUILD_PATH: C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\MSBuild\Current\Bin\ + steps: + - uses: actions/checkout@v2 + - name: Install dependencies + shell: powershell + run: | + Invoke-WebRequest -Uri "https://github.com/premake/premake-core/releases/download/v5.0.0-alpha14/premake-5.0.0-alpha14-windows.zip" -OutFile "premake-5.0.0-alpha14-windows.zip" + Expand-Archive -DestinationPath . -Path premake-5.0.0-alpha14-windows.zip + - name: Create project + shell: powershell + run: | + ./premake5.exe --verbose vs2019 + - name: Build + shell: cmd + run: | + "%MSBUILD_PATH%\MSBuild.exe" .\make\windows\efsw.sln -m diff --git a/vendor/efsw/.gitignore b/vendor/efsw/.gitignore new file mode 100644 index 0000000..abba35d --- /dev/null +++ b/vendor/efsw/.gitignore @@ -0,0 +1,21 @@ +bin/ +build/ +obj/ +make/ +lib/ +CMakeFiles/ +/cmake +/CMakeCache.txt +/cmake_install.cmake +/Makefile +*.DS_Store +.qtc_clangd +.cmake +.vscode/ +*.so +*.a +*.dylib +*.lib +/.cache +/efsw-test +/efsw-test-stdc diff --git a/vendor/efsw/CMakeLists.txt b/vendor/efsw/CMakeLists.txt new file mode 100644 index 0000000..89c61b1 --- /dev/null +++ b/vendor/efsw/CMakeLists.txt @@ -0,0 +1,198 @@ +cmake_minimum_required(VERSION 3.15 FATAL_ERROR) + +project(efsw) + +set(CMAKE_POSITION_INDEPENDENT_CODE ON) +set(CMAKE_CXX_STANDARD 11) + +set(ESFW_MAIN_PROJECT OFF) + +if((CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) AND(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)) + set(ESFW_MAIN_PROJECT ON) +endif() + +include(GNUInstallDirs) + +find_package(Threads REQUIRED) + +option(VERBOSE "Build efsw with verbose mode.") +option(BUILD_SHARED_LIBS "Build efsw as a shared library" ON) +option(BUILD_STATIC_LIBS "Build efsw as a static library" ON) +option(BUILD_TEST_APP "Build the test app" ${ESFW_MAIN_PROJECT}) +option(EFSW_INSTALL "Add efsw install targets" ${ESFW_MAIN_PROJECT}) + +add_library(efsw) + +if(BUILD_STATIC_LIBS) + add_library(efsw-static STATIC) + + target_include_directories(efsw-static + PRIVATE src/ + PUBLIC + $ + $ + $ + ) +endif() + +set(EFSW_CPP_SOURCE + src/efsw/Debug.cpp + src/efsw/DirectorySnapshot.cpp + src/efsw/DirectorySnapshotDiff.cpp + src/efsw/DirWatcherGeneric.cpp + src/efsw/FileInfo.cpp + src/efsw/FileSystem.cpp + src/efsw/FileWatcher.cpp + src/efsw/FileWatcherCWrapper.cpp + src/efsw/FileWatcherGeneric.cpp + src/efsw/FileWatcherImpl.cpp + src/efsw/Log.cpp + src/efsw/Mutex.cpp + src/efsw/String.cpp + src/efsw/System.cpp + src/efsw/Thread.cpp + src/efsw/Watcher.cpp + src/efsw/WatcherGeneric.cpp +) + +target_include_directories(efsw + PRIVATE src/ + PUBLIC + $ + $ + $ +) + +if(VERBOSE) + target_compile_definitions(efsw PRIVATE EFSW_VERBOSE) +endif() + +target_compile_features(efsw PRIVATE cxx_std_11) + +if(BUILD_SHARED_LIBS) + target_compile_definitions(efsw PRIVATE EFSW_DYNAMIC EFSW_EXPORTS) +endif() + +# platforms +if(WIN32) + list(APPEND EFSW_CPP_SOURCE + src/efsw/platform/win/FileSystemImpl.cpp + src/efsw/platform/win/MutexImpl.cpp + src/efsw/platform/win/SystemImpl.cpp + src/efsw/platform/win/ThreadImpl.cpp + ) +else() + list(APPEND EFSW_CPP_SOURCE + src/efsw/platform/posix/FileSystemImpl.cpp + src/efsw/platform/posix/MutexImpl.cpp + src/efsw/platform/posix/SystemImpl.cpp + src/efsw/platform/posix/ThreadImpl.cpp + ) +endif() + +# watcher implementations +if(APPLE) + list(APPEND EFSW_CPP_SOURCE + src/efsw/FileWatcherFSEvents.cpp + src/efsw/FileWatcherKqueue.cpp + src/efsw/WatcherFSEvents.cpp + src/efsw/WatcherKqueue.cpp + ) +elseif(WIN32) + list(APPEND EFSW_CPP_SOURCE + src/efsw/FileWatcherWin32.cpp + src/efsw/WatcherWin32.cpp + ) +elseif(${CMAKE_SYSTEM_NAME} MATCHES "Linux") + list(APPEND EFSW_CPP_SOURCE + src/efsw/FileWatcherInotify.cpp + src/efsw/WatcherInotify.cpp + ) + + find_path(EFSW_INOTIFY_H NAMES sys/inotify.h NO_CACHE) + if(EFSW_INOTIFY_H STREQUAL "EFSW_INOTIFY_H-NOTFOUND") + target_compile_definitions(efsw PRIVATE EFSW_INOTIFY_NOSYS) + endif() +elseif(${CMAKE_SYSTEM_NAME} MATCHES "FreeBSD") + list(APPEND EFSW_CPP_SOURCE + src/efsw/FileWatcherKqueue.cpp + src/efsw/WatcherKqueue.cpp + ) +endif() + +if (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC" OR + (CMAKE_CXX_COMPILER_ID STREQUAL "Clang" AND CMAKE_CXX_SIMULATE_ID STREQUAL "MSVC")) + target_compile_definitions(efsw PRIVATE _SCL_SECURE_NO_WARNINGS) +else() + target_compile_options(efsw PRIVATE -Wall -Wno-long-long -fPIC) +endif() + +target_compile_definitions(efsw PRIVATE $,DEBUG,NDEBUG>) + +if(APPLE) + set(MAC_LIBS "-framework CoreFoundation" "-framework CoreServices") + target_link_libraries(efsw PRIVATE ${MAC_LIBS}) + if(BUILD_STATIC_LIBS) + target_link_libraries(efsw-static PRIVATE ${MAC_LIBS}) + endif() +elseif(NOT(${CMAKE_SYSTEM_NAME} MATCHES "Haiku") AND NOT WIN32) + target_link_libraries(efsw PRIVATE Threads::Threads) +endif() + +target_sources(efsw PRIVATE ${EFSW_CPP_SOURCE}) + +if(BUILD_STATIC_LIBS) + target_sources(efsw-static PRIVATE ${EFSW_CPP_SOURCE}) +endif() + +include(CMakePackageConfigHelpers) + +set(packageDestDir "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}") + +configure_package_config_file( + ${CMAKE_CURRENT_SOURCE_DIR}/efswConfig.cmake.in + ${CMAKE_CURRENT_BINARY_DIR}/cmake/efswConfig.cmake + INSTALL_DESTINATION "${packageDestDir}" + NO_SET_AND_CHECK_MACRO + NO_CHECK_REQUIRED_COMPONENTS_MACRO +) + +export(TARGETS efsw NAMESPACE efsw:: FILE ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}Targets.cmake) +if(BUILD_STATIC_LIBS) + export(TARGETS efsw-static NAMESPACE efsw:: APPEND FILE ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}Targets.cmake) +endif() + +if(EFSW_INSTALL) + install(TARGETS efsw EXPORT efswExport + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} + ) + + install( + FILES + include/efsw/efsw.h include/efsw/efsw.hpp + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/efsw + ) + + if(BUILD_STATIC_LIBS) + install(TARGETS efsw-static EXPORT efswExport + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} + ) + endif() + + install(EXPORT efswExport NAMESPACE efsw:: DESTINATION "${packageDestDir}" FILE ${PROJECT_NAME}Targets.cmake) + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/cmake/efswConfig.cmake DESTINATION "${packageDestDir}") +endif() + +if(BUILD_TEST_APP) + # C++ test application + add_executable(efsw-test src/test/efsw-test.cpp) + target_link_libraries(efsw-test efsw-static) + + # C test application + add_executable(efsw-test-stdc src/test/efsw-test.c) + target_link_libraries(efsw-test-stdc efsw-static) +endif() diff --git a/vendor/efsw/LICENSE b/vendor/efsw/LICENSE new file mode 100644 index 0000000..37f354a --- /dev/null +++ b/vendor/efsw/LICENSE @@ -0,0 +1,22 @@ +Copyright (c) 2020 MartĂ­n Lucas Golini + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +This software is a fork of the "simplefilewatcher" by James Wynn (james@jameswynn.com) +http://code.google.com/p/simplefilewatcher/ also MIT licensed. diff --git a/vendor/efsw/README.md b/vendor/efsw/README.md new file mode 100644 index 0000000..1c71940 --- /dev/null +++ b/vendor/efsw/README.md @@ -0,0 +1,149 @@ +Entropia File System Watcher ![efsw](https://web.ensoft.dev/efsw/efsw-logo.svg) +============================ + +[![build status](https://img.shields.io/github/actions/workflow/status/SpartanJ/efsw/main.yml?branch=master)](https://github.com/SpartanJ/efsw/actions?query=workflow%3Abuild) + +**efsw** is a C++ cross-platform file system watcher and notifier. + +**efsw** monitors the file system asynchronously for changes to files and directories by watching a list of specified paths, and raises events when a directory or file change. + +**efsw** supports recursive directories watch, tracking the entire sub directory tree. + +**efsw** currently supports the following platforms: + +* Linux via [inotify](http://en.wikipedia.org/wiki/Inotify) + +* Windows via [I/O Completion Ports](http://en.wikipedia.org/wiki/IOCP) + +* Mac OS X via [FSEvents](http://en.wikipedia.org/wiki/FSEvents) or [kqueue](http://en.wikipedia.org/wiki/Kqueue) + +* FreeBSD/BSD via [kqueue](http://en.wikipedia.org/wiki/Kqueue) + +* OS-independent generic watcher +(polling the disk for directory snapshots and comparing them periodically) + +If any of the backend fails to start for any reason, it will fallback to the OS-independent implementation. +This should never happen, except for the Kqueue implementation; see `Platform limitations and clarifications`. + +**Code License** +-------------- +[MIT License](http://www.opensource.org/licenses/mit-license.php) + +**Some example code:** +-------------------- + +```c++ +// Inherits from the abstract listener class, and implements the the file action handler +class UpdateListener : public efsw::FileWatchListener { + public: + void handleFileAction( efsw::WatchID watchid, const std::string& dir, + const std::string& filename, efsw::Action action, + std::string oldFilename ) override { + switch ( action ) { + case efsw::Actions::Add: + std::cout << "DIR (" << dir << ") FILE (" << filename << ") has event Added" + << std::endl; + break; + case efsw::Actions::Delete: + std::cout << "DIR (" << dir << ") FILE (" << filename << ") has event Delete" + << std::endl; + break; + case efsw::Actions::Modified: + std::cout << "DIR (" << dir << ") FILE (" << filename << ") has event Modified" + << std::endl; + break; + case efsw::Actions::Moved: + std::cout << "DIR (" << dir << ") FILE (" << filename << ") has event Moved from (" + << oldFilename << ")" << std::endl; + break; + default: + std::cout << "Should never happen!" << std::endl; + } + } +}; + +// Create the file system watcher instance +// efsw::FileWatcher allow a first boolean parameter that indicates if it should start with the +// generic file watcher instead of the platform specific backend +efsw::FileWatcher* fileWatcher = new efsw::FileWatcher(); + +// Create the instance of your efsw::FileWatcherListener implementation +UpdateListener* listener = new UpdateListener(); + +// Add a folder to watch, and get the efsw::WatchID +// It will watch the /tmp folder recursively ( the third parameter indicates that is recursive ) +// Reporting the files and directories changes to the instance of the listener +efsw::WatchID watchID = fileWatcher->addWatch( "/tmp", listener, true ); + +// Adds another directory to watch. This time as non-recursive. +efsw::WatchID watchID2 = fileWatcher->addWatch( "/usr", listener, false ); + +// For Windows, adds another watch, specifying to use a bigger buffer, to not miss events +// (do not use for network locations, see efsw.hpp for details). +efsw::WatchID watchID3 = fileWatcher->addWatch( "c:\\temp", listener, true, { (BufferSize, 128*1024) } ); + +// Start watching asynchronously the directories +fileWatcher->watch(); + +// Remove the second watcher added +// You can also call removeWatch by passing the watch path ( it must end with an slash or backslash +// in windows, since that's how internally it's saved ) +fileWatcher->removeWatch( watchID2 ); +``` + +**Dependencies** +-------------- +None :) + +**Compiling** +------------ +To generate project files you will need to [download and install](https://premake.github.io/download) [Premake](https://premake.github.io/docs/What-Is-Premake) + +Then you can generate the project for your platform by just going to the project directory where the premake4.lua file is located and executing: + +`premake5 gmake2` to generate project Makefiles, then `cd make/*YOURPLATFORM*/`, and finally `make` or `make config=release_x86_64` ( it will generate the static lib, the shared lib and the test application ). + +or + +`premake5 vs2022` to generate Visual Studio 2022 project. + +or + +`premake5 xcode4` to generate Xcode 4 project. + +There is also a cmake file that I don't officially support but it works just fine, provided by [Mohammed Nafees](https://github.com/mnafees) and improved by [Eugene Shalygin](https://github.com/zeule). + +**Platform limitations and clarifications** +------------------------------------------- + +Directory paths are expected to be encoded as UTF-8 strings in all platforms. + +handleFileAction returns UTF-8 strings in all platforms. + +Windows and FSEvents Mac OS X implementation can't follow symlinks ( it will ignore followSymlinks() and allowOutOfScopeLinks() ). + +Kqueue implementation is limited by the maximum number of file descriptors allowed per process by the OS. In the case of reaching the file descriptors limit ( in BSD around 18000 and in OS X around 10240 ), it will fallback to the generic file watcher. + +OS X will use only Kqueue if the OS X version is below 10.5. This implementation needs to be compiled separately from the OS X >= 10.5 implementation, since there's no way to compile FSEvents backend in OS X below 10.5. + +FSEvents for OS X Lion and beyond in some cases will generate more actions than in reality ocurred, since fine-grained implementation of FSEvents doesn't give the order of the actions retrieved. In some cases I need to guess/approximate the order of them. + +Generic watcher relies on the inode information to detect file and directories renames/move. Since Windows has no concept of inodes as Unix platforms do, there is no current reliable way of determining file/directory movement on Windows without help from the Windows API ( this is replaced with Add/Delete events ). + +Linux versions below 2.6.13 are not supported, since inotify wasn't implemented yet. I'm not interested in supporting older kernels, since I don't see the point. If someone needs this, open an issue in the issue tracker and I may consider implementing a dnotify backend. + +OS-independent watcher, Kqueue and FSEvents for OS X below 10.5 keep cache of the directories structures, to be able to detect changes in the directories. This means that there's a memory overhead for these backends. + +**Useful information** +-------------------- +The project also comes with a C API wrapper, contributed by [Sepul Sepehr Taghdisian](https://github.com/septag). + +There's a string manipulation class not exposed in the efsw header ( efsw::String ) that can be used to make string encoding conversion. + + +**Clarifications** +---------------- + +This software started as a fork of the [simplefilewatcher](http://code.google.com/p/simplefilewatcher/) by James Wynn (james[at]jameswynn.com), [MIT licensed](http://www.opensource.org/licenses/mit-license.html). + +The icon used for the project is part of the [HaikuÂź's Icons](http://www.haiku-inc.org/haiku-icons.html), [MIT licensed](http://www.opensource.org/licenses/mit-license.html). diff --git a/vendor/efsw/compile_flags.txt b/vendor/efsw/compile_flags.txt new file mode 100644 index 0000000..d87aa27 --- /dev/null +++ b/vendor/efsw/compile_flags.txt @@ -0,0 +1,16 @@ +-Wno-documentation-unknown-command +-Wno-unknown-warning-option +-Wno-unknown-pragmas +-std=c++11 +-fsyntax-only +-Isrc +-Iinclude +-fmessage-length=0 +-fdiagnostics-show-note-include-stack +-fretain-comments-from-system-headers +-fmacro-backtrace-limit=0 +-ferror-limit=1000 +-Wall +-Wextra +-x +c++-header diff --git a/vendor/efsw/efswConfig.cmake.in b/vendor/efsw/efswConfig.cmake.in new file mode 100644 index 0000000..5340f33 --- /dev/null +++ b/vendor/efsw/efswConfig.cmake.in @@ -0,0 +1,10 @@ +# - Config file for the @CMAKE_PROJECT_NAME@ package + +@PACKAGE_INIT@ + +@DEPENDENCIES_SECTION@ +include(CMakeFindDependencyMacro) + +find_dependency(Threads) + +include("${CMAKE_CURRENT_LIST_DIR}/@PROJECT_NAME@Targets.cmake") diff --git a/vendor/efsw/include/efsw/efsw.h b/vendor/efsw/include/efsw/efsw.h new file mode 100644 index 0000000..ecb9ec4 --- /dev/null +++ b/vendor/efsw/include/efsw/efsw.h @@ -0,0 +1,180 @@ +/** + @author Sepul Sepehr Taghdisian + + Copyright (c) 2013 Martin Lucas Golini + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + THE SOFTWARE. + + This software is a fork of the "simplefilewatcher" by James Wynn (james@jameswynn.com) + http://code.google.com/p/simplefilewatcher/ also MIT licensed. +*/ +/** This is the C API wrapper of EFSW */ +#ifndef ESFW_H +#define ESFW_H + +#ifdef __cplusplus +extern "C" { +#endif + +#if defined(_WIN32) + #ifdef EFSW_DYNAMIC + // Windows platforms + #ifdef EFSW_EXPORTS + // From DLL side, we must export + #define EFSW_API __declspec(dllexport) + #else + // From client application side, we must import + #define EFSW_API __declspec(dllimport) + #endif + #else + // No specific directive needed for static build + #ifndef EFSW_API + #define EFSW_API + #endif + #endif +#else + #if ( __GNUC__ >= 4 ) && defined( EFSW_EXPORTS ) + #define EFSW_API __attribute__ ((visibility("default"))) + #endif + + // Other platforms don't need to define anything + #ifndef EFSW_API + #define EFSW_API + #endif +#endif + +/// Type for a watch id +typedef long efsw_watchid; + +/// Type for watcher +typedef void* efsw_watcher; + +enum efsw_action +{ + EFSW_ADD = 1, /// Sent when a file is created or renamed + EFSW_DELETE = 2, /// Sent when a file is deleted or renamed + EFSW_MODIFIED = 3, /// Sent when a file is modified + EFSW_MOVED = 4 /// Sent when a file is moved +}; + +enum efsw_error +{ + EFSW_NOTFOUND = -1, + EFSW_REPEATED = -2, + EFSW_OUTOFSCOPE = -3, + EFSW_NOTREADABLE = -4, + EFSW_REMOTE = -5, + EFSW_WATCHER_FAILED = -6, + EFSW_UNSPECIFIED = -7 +}; + +enum efsw_option +{ + /// For Windows, the default buffer size of 63*1024 bytes sometimes is not enough and + /// file system events may be dropped. For that, using a different (bigger) buffer size + /// can be defined here, but note that this does not work for network drives, + /// because a buffer larger than 64K will fail the folder being watched, see + /// http://msdn.microsoft.com/en-us/library/windows/desktop/aa365465(v=vs.85).aspx) + EFSW_OPT_WIN_BUFFER_SIZE = 1, + /// For Windows, per default all events are captured but we might only be interested + /// in a subset; the value of the option should be set to a bitwise or'ed set of + /// FILE_NOTIFY_CHANGE_* flags. + EFSW_OPT_WIN_NOTIFY_FILTER = 2 +}; + +/// Basic interface for listening for file events. +typedef void (*efsw_pfn_fileaction_callback) ( + efsw_watcher watcher, + efsw_watchid watchid, + const char* dir, + const char* filename, + enum efsw_action action, + const char* old_filename, + void* param +); + +typedef struct { + enum efsw_option option; + int value; +} efsw_watcher_option; + +/** + * Creates a new file-watcher + * @param generic_mode Force the use of the Generic file watcher + */ +efsw_watcher EFSW_API efsw_create(int generic_mode); + +/// Release the file-watcher and unwatch any directories +void EFSW_API efsw_release(efsw_watcher watcher); + +/// Retrieve last error occured by file-watcher +EFSW_API const char* efsw_getlasterror(); + +/// Reset file-watcher last error +EFSW_API void efsw_clearlasterror(); + +/// Add a directory watch +/// On error returns WatchID with Error type. +efsw_watchid EFSW_API efsw_addwatch(efsw_watcher watcher, const char* directory, + efsw_pfn_fileaction_callback callback_fn, int recursive, void* param); + +/// Add a directory watch, specifying options +/// @param options Pointer to an array of watcher options +/// @param nr_options Number of options referenced by \p options +efsw_watchid EFSW_API efsw_addwatch_withoptions(efsw_watcher watcher, const char* directory, + efsw_pfn_fileaction_callback callback_fn, int recursive, efsw_watcher_option *options, + int options_number, void* param); + +/// Remove a directory watch. This is a brute force search O(nlogn). +void EFSW_API efsw_removewatch(efsw_watcher watcher, const char* directory); + +/// Remove a directory watch. This is a map lookup O(logn). +void EFSW_API efsw_removewatch_byid(efsw_watcher watcher, efsw_watchid watchid); + +/// Starts watching ( in other thread ) +void EFSW_API efsw_watch(efsw_watcher watcher); + +/** + * Allow recursive watchers to follow symbolic links to other directories + * followSymlinks is disabled by default + */ +void EFSW_API efsw_follow_symlinks(efsw_watcher watcher, int enable); + +/** @return If can follow symbolic links to directorioes */ +int EFSW_API efsw_follow_symlinks_isenabled(efsw_watcher watcher); + +/** + * When enable this it will allow symlinks to watch recursively out of the pointed directory. + * follorSymlinks must be enabled to this work. + * For example, added symlink to /home/folder, and the symlink points to /, this by default is not allowed, + * it's only allowed to symlink anything from /home/ and deeper. This is to avoid great levels of recursion. + * Enabling this could lead in infinite recursion, and crash the watcher ( it will try not to avoid this ). + * Buy enabling out of scope links, it will allow this behavior. + * allowOutOfScopeLinks are disabled by default. + */ +void EFSW_API efsw_allow_outofscopelinks(efsw_watcher watcher, int allow); + +/// @return Returns if out of scope links are allowed +int EFSW_API efsw_outofscopelinks_isallowed(efsw_watcher watcher); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/vendor/efsw/include/efsw/efsw.hpp b/vendor/efsw/include/efsw/efsw.hpp new file mode 100644 index 0000000..b6519b6 --- /dev/null +++ b/vendor/efsw/include/efsw/efsw.hpp @@ -0,0 +1,242 @@ +/** + @author MartĂ­n Lucas Golini + + Copyright (c) 2013 MartĂ­n Lucas Golini + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + THE SOFTWARE. + + This software is a fork of the "simplefilewatcher" by James Wynn (james@jameswynn.com) + http://code.google.com/p/simplefilewatcher/ also MIT licensed. +*/ + +#ifndef ESFW_HPP +#define ESFW_HPP + +#include +#include +#include + +#if defined( _WIN32 ) +#ifdef EFSW_DYNAMIC +// Windows platforms +#ifdef EFSW_EXPORTS +// From DLL side, we must export +#define EFSW_API __declspec( dllexport ) +#else +// From client application side, we must import +#define EFSW_API __declspec( dllimport ) +#endif +#else +// No specific directive needed for static build +#ifndef EFSW_API +#define EFSW_API +#endif +#endif +#else +#if ( __GNUC__ >= 4 ) && defined( EFSW_EXPORTS ) +#ifndef EFSW_API +#define EFSW_API __attribute__( ( visibility( "default" ) ) ) +#endif +#endif + +// Other platforms don't need to define anything +#ifndef EFSW_API +#define EFSW_API +#endif +#endif + +namespace efsw { + +/// Type for a watch id +typedef long WatchID; + +// forward declarations +class FileWatcherImpl; +class FileWatchListener; +class WatcherOption; + +/// Actions to listen for. Rename will send two events, one for +/// the deletion of the old file, and one for the creation of the +/// new file. +namespace Actions { +enum Action { + /// Sent when a file is created or renamed + Add = 1, + /// Sent when a file is deleted or renamed + Delete = 2, + /// Sent when a file is modified + Modified = 3, + /// Sent when a file is moved + Moved = 4 +}; +} +typedef Actions::Action Action; + +/// Errors log namespace +namespace Errors { + +enum Error { + NoError = 0, + FileNotFound = -1, + FileRepeated = -2, + FileOutOfScope = -3, + FileNotReadable = -4, + /// Directory in remote file system + /// ( create a generic FileWatcher instance to watch this directory ). + FileRemote = -5, + /// File system watcher failed to watch for changes. + WatcherFailed = -6, + Unspecified = -7 +}; + +class EFSW_API Log { + public: + /// @return The last error logged + static std::string getLastErrorLog(); + + /// @return The code of the last error logged + static Error getLastErrorCode(); + + /// Reset last error + static void clearLastError(); + + /// Creates an error of the type specified + static Error createLastError( Error err, std::string log ); +}; + +} // namespace Errors +typedef Errors::Error Error; + +/// Optional file watcher settings. +namespace Options { +enum Option { + /// For Windows, the default buffer size of 63*1024 bytes sometimes is not enough and + /// file system events may be dropped. For that, using a different (bigger) buffer size + /// can be defined here, but note that this does not work for network drives, + /// because a buffer larger than 64K will fail the folder being watched, see + /// http://msdn.microsoft.com/en-us/library/windows/desktop/aa365465(v=vs.85).aspx) + WinBufferSize = 1, + /// For Windows, per default all events are captured but we might only be interested + /// in a subset; the value of the option should be set to a bitwise or'ed set of + /// FILE_NOTIFY_CHANGE_* flags. + WinNotifyFilter = 2 +}; +} +typedef Options::Option Option; + +/// Listens to files and directories and dispatches events +/// to notify the listener of files and directories changes. +/// @class FileWatcher +class EFSW_API FileWatcher { + public: + /// Default constructor, will use the default platform file watcher + FileWatcher(); + + /// Constructor that lets you force the use of the Generic File Watcher + explicit FileWatcher( bool useGenericFileWatcher ); + + virtual ~FileWatcher(); + + /// Add a directory watch. Same as the other addWatch, but doesn't have recursive option. + /// For backwards compatibility. + /// On error returns WatchID with Error type. + WatchID addWatch( const std::string& directory, FileWatchListener* watcher ); + + /// Add a directory watch + /// On error returns WatchID with Error type. + WatchID addWatch( const std::string& directory, FileWatchListener* watcher, bool recursive ); + + /// Add a directory watch, allowing customization with options + /// @param directory The folder to be watched + /// @param watcher The listener to receive events + /// @param recursive Set this to true to include subdirectories + /// @param options Allows customization of a watcher + /// @return Returns the watch id for the directory or, on error, a WatchID with Error type. + WatchID addWatch( const std::string& directory, FileWatchListener* watcher, bool recursive, + const std::vector &options ); + + /// Remove a directory watch. This is a brute force search O(nlogn). + void removeWatch( const std::string& directory ); + + /// Remove a directory watch. This is a map lookup O(logn). + void removeWatch( WatchID watchid ); + + /// Starts watching ( in other thread ) + void watch(); + + /// @return Returns a list of the directories that are being watched + std::vector directories(); + + /** Allow recursive watchers to follow symbolic links to other directories + * followSymlinks is disabled by default + */ + void followSymlinks( bool follow ); + + /** @return If can follow symbolic links to directorioes */ + const bool& followSymlinks() const; + + /** When enable this it will allow symlinks to watch recursively out of the pointed directory. + * follorSymlinks must be enabled to this work. + * For example, added symlink to /home/folder, and the symlink points to /, this by default is + * not allowed, it's only allowed to symlink anything from /home/ and deeper. This is to avoid + * great levels of recursion. Enabling this could lead in infinite recursion, and crash the + * watcher ( it will try not to avoid this ). Buy enabling out of scope links, it will allow + * this behavior. allowOutOfScopeLinks are disabled by default. + */ + void allowOutOfScopeLinks( bool allow ); + + /// @return Returns if out of scope links are allowed + const bool& allowOutOfScopeLinks() const; + + private: + /// The implementation + FileWatcherImpl* mImpl; + bool mFollowSymlinks; + bool mOutOfScopeLinks; +}; + +/// Basic interface for listening for file events. +/// @class FileWatchListener +class FileWatchListener { + public: + virtual ~FileWatchListener() {} + + /// Handles the action file action + /// @param watchid The watch id for the directory + /// @param dir The directory + /// @param filename The filename that was accessed (not full path) + /// @param action Action that was performed + /// @param oldFilename The name of the file or directory moved + virtual void handleFileAction( WatchID watchid, const std::string& dir, + const std::string& filename, Action action, + std::string oldFilename = "" ) = 0; +}; + +/// Optional, typically platform specific parameter for customization of a watcher. +/// @class WatcherOption +class WatcherOption { + public: + WatcherOption(Option option, int value) : mOption(option), mValue(value) {}; + Option mOption; + int mValue; +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/premake4.lua b/vendor/efsw/premake4.lua new file mode 100644 index 0000000..2918390 --- /dev/null +++ b/vendor/efsw/premake4.lua @@ -0,0 +1,235 @@ +newoption { trigger = "verbose", description = "Build efsw with verbose mode." } +newoption { trigger = "strip-symbols", description = "Strip debugging symbols in other file ( only for relwithdbginfo configuration )." } +newoption { trigger = "thread-sanitizer", description ="Compile with ThreadSanitizer." } + +efsw_major_version = "1" +efsw_minor_version = "0" +efsw_patch_version = "2" +efsw_version = efsw_major_version .. "." .. efsw_minor_version .. "." .. efsw_patch_version + +function get_include_paths() + local function _insert_include_paths( file ) + local function _trim(s) + return (s:gsub("^%s*(.-)%s*$", "%1")) + end + + local paths = { } + local lines = file:read('*all') + + for line in string.gmatch(lines, '([^\n]+)') + do + table.insert( paths, _trim( line ) ) + end + + file:close() + + return paths + end + + local file = io.popen( "echo | gcc -Wp,-v -x c++ - -fsyntax-only 2>&1 | grep -v '#' | grep '/'", 'r' ) + local include_paths = _insert_include_paths( file ) + + if next(include_paths) == nil then + file = io.popen( "echo | clang++ -Wp,-v -x c++ - -fsyntax-only 2>&1 | grep -v '#' | grep '/' | grep -v 'nonexistent'", 'r' ) + + include_paths = _insert_include_paths( file ) + + if next(include_paths) == nil then + table.insert( include_paths, "/usr/include" ) + table.insert( include_paths, "/usr/local/include" ) + end + end + + return include_paths +end + +function inotify_header_exists() + local efsw_include_paths = get_include_paths() + + for _,v in pairs( efsw_include_paths ) + do + local cur_path = v .. "/sys/inotify.h" + + if os.isfile( cur_path ) then + return true + end + end + + return false +end + +function string.starts(String,Start) + if ( _ACTION ) then + return string.sub(String,1,string.len(Start))==Start + end + + return false +end + +function is_vs() + return ( string.starts(_ACTION,"vs") ) +end + +function conf_warnings() + if not is_vs() then + buildoptions{ "-Wall -Wno-long-long" } + + if not os.is("windows") then + buildoptions{ "-fPIC" } + end + else + defines { "_SCL_SECURE_NO_WARNINGS" } + end + + if _OPTIONS["thread-sanitizer"] then + buildoptions { "-fsanitize=thread" } + linkoptions { "-fsanitize=thread" } + if not os.is("macosx") then + links { "tsan" } + end + end +end + +function conf_links() + if not os.is("windows") and not os.is("haiku") then + links { "pthread" } + end + + if os.is("macosx") then + links { "CoreFoundation.framework", "CoreServices.framework" } + end +end + +function conf_excludes() + if os.is("windows") then + excludes { "src/efsw/WatcherKqueue.cpp", "src/efsw/WatcherFSEvents.cpp", "src/efsw/WatcherInotify.cpp", "src/efsw/FileWatcherKqueue.cpp", "src/efsw/FileWatcherInotify.cpp", "src/efsw/FileWatcherFSEvents.cpp" } + elseif os.is("linux") then + excludes { "src/efsw/WatcherKqueue.cpp", "src/efsw/WatcherFSEvents.cpp", "src/efsw/WatcherWin32.cpp", "src/efsw/FileWatcherKqueue.cpp", "src/efsw/FileWatcherWin32.cpp", "src/efsw/FileWatcherFSEvents.cpp" } + elseif os.is("macosx") then + excludes { "src/efsw/WatcherInotify.cpp", "src/efsw/WatcherWin32.cpp", "src/efsw/FileWatcherInotify.cpp", "src/efsw/FileWatcherWin32.cpp" } + elseif os.is("freebsd") then + excludes { "src/efsw/WatcherInotify.cpp", "src/efsw/WatcherWin32.cpp", "src/efsw/WatcherFSEvents.cpp", "src/efsw/FileWatcherInotify.cpp", "src/efsw/FileWatcherWin32.cpp", "src/efsw/FileWatcherFSEvents.cpp" } + end + + if os.is("linux") and not inotify_header_exists() then + defines { "EFSW_INOTIFY_NOSYS" } + end +end + +solution "efsw" + location("./make/" .. os.get() .. "/") + targetdir("./bin") + configurations { "debug", "release", "relwithdbginfo" } + + if os.is("windows") then + osfiles = "src/efsw/platform/win/*.cpp" + else + osfiles = "src/efsw/platform/posix/*.cpp" + end + + -- Activates verbose mode + if _OPTIONS["verbose"] then + defines { "EFSW_VERBOSE" } + end + + if not is_vs() then + buildoptions { "-std=c++11" } + end + + if os.is("macosx") then + -- Premake 4.4 needed for this + if not string.match(_PREMAKE_VERSION, "^4.[123]") then + local ver = os.getversion(); + + if not ( ver.majorversion >= 10 and ver.minorversion >= 5 ) then + defines { "EFSW_FSEVENTS_NOT_SUPPORTED" } + end + end + end + + objdir("obj/" .. os.get() .. "/") + + project "efsw-static-lib" + kind "StaticLib" + language "C++" + targetdir("./lib") + includedirs { "include", "src" } + files { "src/efsw/*.cpp", osfiles } + conf_excludes() + + configuration "debug" + defines { "DEBUG" } + flags { "Symbols" } + targetname "efsw-static-debug" + conf_warnings() + + configuration "release" + defines { "NDEBUG" } + flags { "Optimize" } + targetname "efsw-static-release" + conf_warnings() + + configuration "relwithdbginfo" + defines { "NDEBUG" } + flags { "Optimize", "Symbols" } + targetname "efsw-static-reldbginfo" + conf_warnings() + + project "efsw-test" + kind "ConsoleApp" + language "C++" + links { "efsw-static-lib" } + files { "src/test/*.cpp" } + includedirs { "include", "src" } + conf_links() + + configuration "debug" + defines { "DEBUG" } + flags { "Symbols" } + targetname "efsw-test-debug" + conf_warnings() + + configuration "release" + defines { "NDEBUG" } + flags { "Optimize" } + targetname "efsw-test-release" + conf_warnings() + + configuration "relwithdbginfo" + defines { "NDEBUG" } + flags { "Optimize", "Symbols" } + targetname "efsw-test-reldbginfo" + conf_warnings() + + project "efsw-shared-lib" + kind "SharedLib" + language "C++" + targetdir("./lib") + includedirs { "include", "src" } + files { "src/efsw/*.cpp", osfiles } + defines { "EFSW_DYNAMIC", "EFSW_EXPORTS" } + conf_excludes() + conf_links() + + configuration "debug" + defines { "DEBUG" } + flags { "Symbols" } + targetname "efsw-debug" + conf_warnings() + + configuration "release" + defines { "NDEBUG" } + flags { "Optimize" } + targetname "efsw" + conf_warnings() + + configuration "relwithdbginfo" + defines { "NDEBUG" } + flags { "Optimize", "Symbols" } + targetname "efsw" + conf_warnings() + + if os.is("linux") or os.is("bsd") or os.is("haiku") then + targetextension ( ".so." .. efsw_version ) + postbuildcommands { "sh ../../project/build.reldbginfo.sh " .. efsw_major_version .. " " .. efsw_minor_version .. " " .. efsw_patch_version .. " " .. iif( _OPTIONS["strip-symbols"], "strip-symbols", "" ) } + end diff --git a/vendor/efsw/premake5.lua b/vendor/efsw/premake5.lua new file mode 100644 index 0000000..9f993b1 --- /dev/null +++ b/vendor/efsw/premake5.lua @@ -0,0 +1,238 @@ +newoption { trigger = "verbose", description = "Build efsw with verbose mode." } +newoption { trigger = "strip-symbols", description = "Strip debugging symbols in other file ( only for relwithdbginfo configuration )." } +newoption { trigger = "thread-sanitizer", description ="Compile with ThreadSanitizer" } + +efsw_major_version = "1" +efsw_minor_version = "0" +efsw_patch_version = "2" +efsw_version = efsw_major_version .. "." .. efsw_minor_version .. "." .. efsw_patch_version + +function get_include_paths() + local function _insert_include_paths( file ) + local function _trim(s) + return (s:gsub("^%s*(.-)%s*$", "%1")) + end + + local paths = { } + local lines = file:read('*all') + + for line in string.gmatch(lines, '([^\n]+)') + do + table.insert( paths, _trim( line ) ) + end + + file:close() + + return paths + end + + local file = io.popen( "echo | gcc -Wp,-v -x c++ - -fsyntax-only 2>&1 | grep -v '#' | grep '/'", 'r' ) + local include_paths = _insert_include_paths( file ) + + if next(include_paths) == nil then + file = io.popen( "echo | clang++ -Wp,-v -x c++ - -fsyntax-only 2>&1 | grep -v '#' | grep '/' | grep -v 'nonexistent'", 'r' ) + + include_paths = _insert_include_paths( file ) + + if next(include_paths) == nil then + table.insert( include_paths, "/usr/include" ) + table.insert( include_paths, "/usr/local/include" ) + end + end + + return include_paths +end + +function inotify_header_exists() + local efsw_include_paths = get_include_paths() + + for _,v in pairs( efsw_include_paths ) + do + local cur_path = v .. "/sys/inotify.h" + + if os.isfile( cur_path ) then + return true + end + end + + return false +end + +function string.starts(String,Start) + if ( _ACTION ) then + return string.sub(String,1,string.len(Start))==Start + end + + return false +end + +function is_vs() + return ( string.starts(_ACTION,"vs") ) +end + +function conf_warnings() + if not is_vs() then + buildoptions{ "-Wall -Wno-long-long" } + + if not os.istarget("windows") then + buildoptions{ "-fPIC" } + end + else + defines { "_SCL_SECURE_NO_WARNINGS" } + end + + if _OPTIONS["thread-sanitizer"] then + buildoptions { "-fsanitize=thread" } + linkoptions { "-fsanitize=thread" } + if not os.istarget("macosx") then + links { "tsan" } + end + end +end + +function conf_links() + if not os.istarget("windows") and not os.istarget("haiku") then + links { "pthread" } + end + + if os.istarget("macosx") then + links { "CoreFoundation.framework", "CoreServices.framework" } + end +end + +function conf_excludes() + if os.istarget("windows") then + excludes { "src/efsw/WatcherKqueue.cpp", "src/efsw/WatcherFSEvents.cpp", "src/efsw/WatcherInotify.cpp", "src/efsw/FileWatcherKqueue.cpp", "src/efsw/FileWatcherInotify.cpp", "src/efsw/FileWatcherFSEvents.cpp" } + elseif os.istarget("linux") then + excludes { "src/efsw/WatcherKqueue.cpp", "src/efsw/WatcherFSEvents.cpp", "src/efsw/WatcherWin32.cpp", "src/efsw/FileWatcherKqueue.cpp", "src/efsw/FileWatcherWin32.cpp", "src/efsw/FileWatcherFSEvents.cpp" } + elseif os.istarget("macosx") then + excludes { "src/efsw/WatcherInotify.cpp", "src/efsw/WatcherWin32.cpp", "src/efsw/FileWatcherInotify.cpp", "src/efsw/FileWatcherWin32.cpp" } + elseif os.istarget("bsd") then + excludes { "src/efsw/WatcherInotify.cpp", "src/efsw/WatcherWin32.cpp", "src/efsw/WatcherFSEvents.cpp", "src/efsw/FileWatcherInotify.cpp", "src/efsw/FileWatcherWin32.cpp", "src/efsw/FileWatcherFSEvents.cpp" } + end + + if os.istarget("linux") and not inotify_header_exists() then + defines { "EFSW_INOTIFY_NOSYS" } + end +end + +workspace "efsw" + location("./make/" .. os.target() .. "/") + targetdir("./bin") + configurations { "debug", "release", "relwithdbginfo" } + platforms { "x86_64", "x86", "ARM", "ARM64" } + + if os.istarget("windows") then + osfiles = "src/efsw/platform/win/*.cpp" + else + osfiles = "src/efsw/platform/posix/*.cpp" + end + + -- Activates verbose mode + if _OPTIONS["verbose"] then + defines { "EFSW_VERBOSE" } + end + + cppdialect "C++11" + + objdir("obj/" .. os.target() .. "/") + + filter "platforms:x86" + architecture "x86" + + filter "platforms:x86_64" + architecture "x86_64" + + filter "platforms:arm" + architecture "ARM" + + filter "platforms:arm64" + architecture "ARM64" + + project "efsw-static-lib" + kind "StaticLib" + language "C++" + targetdir("./lib") + includedirs { "include", "src" } + files { "src/efsw/*.cpp", osfiles } + conf_excludes() + + filter "configurations:debug" + defines { "DEBUG" } + symbols "On" + targetname "efsw-static-debug" + conf_warnings() + + filter "configurations:release" + defines { "NDEBUG" } + optimize "On" + targetname "efsw-static-release" + conf_warnings() + + filter "configurations:relwithdbginfo" + defines { "NDEBUG" } + symbols "On" + optimize "On" + targetname "efsw-static-reldbginfo" + conf_warnings() + + project "efsw-test" + kind "ConsoleApp" + language "C++" + links { "efsw-static-lib" } + files { "src/test/*.cpp" } + includedirs { "include", "src" } + conf_links() + + filter "configurations:debug" + defines { "DEBUG" } + symbols "On" + targetname "efsw-test-debug" + conf_warnings() + + filter "configurations:release" + defines { "NDEBUG" } + optimize "On" + targetname "efsw-test-release" + conf_warnings() + + filter "configurations:relwithdbginfo" + defines { "NDEBUG" } + symbols "On" + optimize "On" + targetname "efsw-test-reldbginfo" + conf_warnings() + + project "efsw-shared-lib" + kind "SharedLib" + language "C++" + targetdir("./lib") + includedirs { "include", "src" } + files { "src/efsw/*.cpp", osfiles } + defines { "EFSW_DYNAMIC", "EFSW_EXPORTS" } + conf_excludes() + conf_links() + + filter "configurations:debug" + defines { "DEBUG" } + symbols "On" + targetname "efsw-debug" + conf_warnings() + + filter "configurations:release" + defines { "NDEBUG" } + optimize "On" + targetname "efsw" + conf_warnings() + + filter "configurations:relwithdbginfo" + defines { "NDEBUG" } + symbols "On" + optimize "On" + targetname "efsw" + conf_warnings() + + if os.istarget("linux") or os.istarget("bsd") or os.istarget("haiku") then + targetextension ( ".so." .. efsw_version ) + postbuildcommands { "sh ../../project/build.reldbginfo.sh " .. efsw_major_version .. " " .. efsw_minor_version .. " " .. efsw_patch_version .. " " .. iif( _OPTIONS["strip-symbols"], "strip-symbols", "" ) } + end diff --git a/vendor/efsw/project/build.reldbginfo.sh b/vendor/efsw/project/build.reldbginfo.sh new file mode 100644 index 0000000..5ec272b --- /dev/null +++ b/vendor/efsw/project/build.reldbginfo.sh @@ -0,0 +1,9 @@ +#!/bin/sh +cd ../../lib +ln -fs libefsw.so.$1.$2.$3 libefsw.so.$1 +ln -fs libefsw.so.$1 libefsw.so + +if [ "$4" == "strip-symbols" ]; then + objcopy --only-keep-debug libefsw.so.$1.$2.$3 libefsw.debug + objcopy --strip-debug libefsw.so.$1.$2.$3 +fi diff --git a/vendor/efsw/project/qtcreator-linux/efsw.cflags b/vendor/efsw/project/qtcreator-linux/efsw.cflags new file mode 100644 index 0000000..5905d6d --- /dev/null +++ b/vendor/efsw/project/qtcreator-linux/efsw.cflags @@ -0,0 +1 @@ +-std=c11 diff --git a/vendor/efsw/project/qtcreator-linux/efsw.config b/vendor/efsw/project/qtcreator-linux/efsw.config new file mode 100644 index 0000000..8cec188 --- /dev/null +++ b/vendor/efsw/project/qtcreator-linux/efsw.config @@ -0,0 +1 @@ +// ADD PREDEFINED MACROS HERE! diff --git a/vendor/efsw/project/qtcreator-linux/efsw.creator b/vendor/efsw/project/qtcreator-linux/efsw.creator new file mode 100644 index 0000000..e94cbbd --- /dev/null +++ b/vendor/efsw/project/qtcreator-linux/efsw.creator @@ -0,0 +1 @@ +[General] diff --git a/vendor/efsw/project/qtcreator-linux/efsw.creator.user b/vendor/efsw/project/qtcreator-linux/efsw.creator.user new file mode 100644 index 0000000..0bcd422 --- /dev/null +++ b/vendor/efsw/project/qtcreator-linux/efsw.creator.user @@ -0,0 +1,344 @@ + + + + + + EnvironmentId + {d43f4693-30c1-436c-b1d1-498aab2c2f8c} + + + ProjectExplorer.Project.ActiveTarget + 0 + + + ProjectExplorer.Project.EditorSettings + + true + false + true + + Cpp + + CppGlobal + + + + QmlJS + + QmlJSGlobal + + + + Nim + + NimGlobal + + + 3 + UTF-8 + false + 4 + false + 80 + true + true + 1 + false + true + false + 0 + true + true + 0 + 8 + true + false + 1 + true + true + true + *.md, *.MD, Makefile + false + true + true + + + + ProjectExplorer.Project.PluginSettings + + + true + false + true + true + true + true + + + 0 + true + + true + Builtin.BuildSystem + + false + false + + 0 + + + + true + + false + + + + true + + true + + + + + ProjectExplorer.Project.Target.0 + + Desktop + Desktop + Desktop + {6d057187-158a-4883-8d5b-d470a6b6b025} + 1 + 0 + 0 + + ../../make/linux + + + true + gmake2 + premake5 + %{buildDir}../../../ + ProjectExplorer.ProcessStep + + + -j24 -e config=release_x86_64 + make + true + GenericProjectManager.GenericMakeStep + + 2 + Build + Build + ProjectExplorer.BuildSteps.Build + + + + + clean + + -e config=release_x86_64 + true + GenericProjectManager.GenericMakeStep + + 1 + Clean + Clean + ProjectExplorer.BuildSteps.Clean + + 2 + false + + false + + release + GenericProjectManager.GenericBuildConfiguration + + + ../../make/linux + + + true + --thread-sanitizer --verbose gmake2 + premake5 + %{buildDir}../../../ + ProjectExplorer.ProcessStep + + + -j24 + make + true + GenericProjectManager.GenericMakeStep + + 2 + Build + Build + ProjectExplorer.BuildSteps.Build + + + + + clean + + -e config=debug_x86_64 + true + GenericProjectManager.GenericMakeStep + + 1 + Clean + Clean + ProjectExplorer.BuildSteps.Clean + + 2 + false + + false + + debug + GenericProjectManager.GenericBuildConfiguration + + + ../../make/linux + + + true + gmake2 + premake5 + %{buildDir}../../../ + ProjectExplorer.ProcessStep + + + -e config=relwithdbginfo_x86_64 + make + true + GenericProjectManager.GenericMakeStep + + 2 + Build + Build + ProjectExplorer.BuildSteps.Build + + + + + clean + + -e config=relwithdbginfo_x86_64 + true + GenericProjectManager.GenericMakeStep + + 1 + Clean + Clean + ProjectExplorer.BuildSteps.Clean + + 2 + false + + false + + relwithdbginfo + GenericProjectManager.GenericBuildConfiguration + + 3 + + + 0 + Deploy + Deploy + ProjectExplorer.BuildSteps.Deploy + + 1 + + false + ProjectExplorer.DefaultDeployConfiguration + + 1 + + dwarf + + cpu-cycles + + -F + true + 0 + true + true + + 2 + + %{buildDir}/../../bin/efsw-test-debug + debug + ProjectExplorer.CustomExecutableRunConfiguration + + /home/programming/thebricks/fe/ + true + false + false + true + true + %{buildDir}../../../ + + + dwarf + + cpu-cycles + + -F + true + 0 + true + true + + 2 + + %{buildDir}../../../bin/efsw-test-release + release + ProjectExplorer.CustomExecutableRunConfiguration + + true + false + false + true + true + %{buildDir}../../../ + + + dwarf + + cpu-cycles + + -F + true + 0 + true + true + + 2 + + %{buildDir}../../../bin/efsw-test-dbginfo + reldbginfo + ProjectExplorer.CustomExecutableRunConfiguration + + true + false + false + true + true + %{buildDir}../../../ + + 3 + + + + ProjectExplorer.Project.TargetCount + 1 + + + ProjectExplorer.Project.Updater.FileVersion + 22 + + + Version + 22 + + diff --git a/vendor/efsw/project/qtcreator-linux/efsw.cxxflags b/vendor/efsw/project/qtcreator-linux/efsw.cxxflags new file mode 100644 index 0000000..c24e3b5 --- /dev/null +++ b/vendor/efsw/project/qtcreator-linux/efsw.cxxflags @@ -0,0 +1 @@ +-std=c++11 diff --git a/vendor/efsw/project/qtcreator-linux/efsw.files b/vendor/efsw/project/qtcreator-linux/efsw.files new file mode 100644 index 0000000..2eb9989 --- /dev/null +++ b/vendor/efsw/project/qtcreator-linux/efsw.files @@ -0,0 +1,118 @@ +../../CMakeLists.txt +../../include/efsw/efsw.hpp +../../premake5.lua +../../src/efsw/Atomic.hpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/Thread.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/System.cpp +../../src/efsw/platform/platformimpl.hpp +../../src/efsw/platform/posix/ThreadImpl.hpp +../../src/efsw/platform/posix/MutexImpl.hpp +../../src/efsw/platform/posix/SystemImpl.hpp +../../src/efsw/platform/posix/ThreadImpl.cpp +../../src/efsw/platform/posix/MutexImpl.cpp +../../src/efsw/platform/posix/SystemImpl.cpp +../../src/efsw/platform/win/ThreadImpl.hpp +../../src/efsw/platform/win/MutexImpl.hpp +../../src/efsw/platform/win/SystemImpl.hpp +../../src/efsw/platform/win/ThreadImpl.cpp +../../src/efsw/platform/win/MutexImpl.cpp +../../src/efsw/platform/win/SystemImpl.cpp +../../src/efsw/base.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/platform/posix/FileSystemImpl.hpp +../../src/efsw/platform/posix/FileSystemImpl.cpp +../../src/efsw/platform/win/FileSystemImpl.hpp +../../src/efsw/platform/win/FileSystemImpl.cpp +../../src/efsw/FileInfo.cpp +../../src/efsw/base.hpp +../../src/efsw/Thread.hpp +../../src/efsw/System.hpp +../../src/efsw/Mutex.hpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileSystem.hpp +../../src/efsw/FileInfo.hpp +../../src/efsw/Thread.cpp +../../src/efsw/System.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/FileInfo.cpp +../../src/efsw/sophist.h +../../src/efsw/base.hpp +../../src/efsw/Utf.hpp +../../src/efsw/Thread.hpp +../../src/efsw/System.hpp +../../src/efsw/String.hpp +../../src/efsw/Mutex.hpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileSystem.hpp +../../src/efsw/FileInfo.hpp +../../src/efsw/Utf.inl +../../src/efsw/Thread.cpp +../../src/efsw/System.cpp +../../src/efsw/String.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/FileInfo.cpp +../../src/test/efsw-test.cpp +../../premake4.lua +../../src/efsw/WatcherKqueue.hpp +../../src/efsw/WatcherKqueue.cpp +../../src/efsw/Debug.hpp +../../src/efsw/Debug.cpp +../../src/efsw/WatcherGeneric.hpp +../../src/efsw/WatcherGeneric.cpp +../../src/efsw/DirWatcherGeneric.hpp +../../src/efsw/DirWatcherGeneric.cpp +../../src/efsw/Log.cpp +../../src/efsw/WatcherInotify.hpp +../../src/efsw/WatcherInotify.cpp +../../src/efsw/FileWatcherImpl.cpp +../../src/efsw/DirectorySnapshot.hpp +../../src/efsw/DirectorySnapshot.cpp +../../src/efsw/DirectorySnapshotDiff.hpp +../../src/efsw/DirectorySnapshotDiff.cpp +../../src/efsw/WatcherFSEvents.hpp +../../src/efsw/FileWatcherFSEvents.hpp +../../src/efsw/WatcherFSEvents.cpp +../../src/efsw/FileWatcherFSEvents.cpp +../../src/efsw/Watcher.hpp +../../src/efsw/Watcher.cpp +../../src/efsw/WatcherWin32.hpp +../../src/efsw/WatcherWin32.cpp +../../README.md +../../include/efsw/efsw.h +../../src/efsw/FileWatcherCWrapper.cpp +../../src/efsw/inotify-nosys.h diff --git a/vendor/efsw/project/qtcreator-linux/efsw.includes b/vendor/efsw/project/qtcreator-linux/efsw.includes new file mode 100644 index 0000000..1ab792a --- /dev/null +++ b/vendor/efsw/project/qtcreator-linux/efsw.includes @@ -0,0 +1,2 @@ +../../include +../../src diff --git a/vendor/efsw/project/qtcreator-osx/efsw.cflags b/vendor/efsw/project/qtcreator-osx/efsw.cflags new file mode 100644 index 0000000..68d5165 --- /dev/null +++ b/vendor/efsw/project/qtcreator-osx/efsw.cflags @@ -0,0 +1 @@ +-std=c17 \ No newline at end of file diff --git a/vendor/efsw/project/qtcreator-osx/efsw.config b/vendor/efsw/project/qtcreator-osx/efsw.config new file mode 100644 index 0000000..685bb2d --- /dev/null +++ b/vendor/efsw/project/qtcreator-osx/efsw.config @@ -0,0 +1,3 @@ +// ADD PREDEFINED MACROS HERE! +#define EFSW_FSEVENTS_SUPPORTED +#define EFSW_USE_CXX11 diff --git a/vendor/efsw/project/qtcreator-osx/efsw.creator b/vendor/efsw/project/qtcreator-osx/efsw.creator new file mode 100644 index 0000000..e94cbbd --- /dev/null +++ b/vendor/efsw/project/qtcreator-osx/efsw.creator @@ -0,0 +1 @@ +[General] diff --git a/vendor/efsw/project/qtcreator-osx/efsw.creator.user b/vendor/efsw/project/qtcreator-osx/efsw.creator.user new file mode 100644 index 0000000..c1e8795 --- /dev/null +++ b/vendor/efsw/project/qtcreator-osx/efsw.creator.user @@ -0,0 +1,253 @@ + + + + + + EnvironmentId + {49267ae2-f136-4b84-8041-cf11a20f6a32} + + + ProjectExplorer.Project.ActiveTarget + 0 + + + ProjectExplorer.Project.EditorSettings + + true + false + true + + Cpp + + CppGlobal + + + + QmlJS + + QmlJSGlobal + + + 2 + UTF-8 + false + 4 + true + 80 + true + true + 1 + 0 + false + true + false + 0 + true + true + 0 + 8 + true + false + 1 + true + true + true + *.md, *.MD, Makefile + false + true + true + + + + ProjectExplorer.Project.PluginSettings + + + true + false + true + true + true + true + + + 0 + true + + true + + true + true + Builtin.DefaultTidyAndClazy + 4 + false + + + + true + + + + + ProjectExplorer.Project.Target.0 + + Desktop + Desktop (arm-darwin-generic-mach_o-64bit) + Desktop (arm-darwin-generic-mach_o-64bit) + {6d6b6d62-1e99-4e76-b5e2-cf731a0dbd92} + 0 + 0 + 0 + + ../../make/macosx/ + + + true + --file=../../premake4.lua --thread-sanitizer --verbose gmake + /usr/local/bin/premake4 + %{buildDir} + ProjectExplorer.ProcessStep + + + -j4 + true + GenericProjectManager.GenericMakeStep + + 2 + Build + Build + ProjectExplorer.BuildSteps.Build + + + + + clean + + true + GenericProjectManager.GenericMakeStep + + 1 + Clean + Clean + ProjectExplorer.BuildSteps.Clean + + 2 + false + + false + + debug + GenericProjectManager.GenericBuildConfiguration + + + ../../make/macosx/ + + + true + --file=../../premake4.lua gmake + /usr/local/bin/premake4 + %{buildDir} + ProjectExplorer.ProcessStep + + + -j4 config=release + true + GenericProjectManager.GenericMakeStep + + 2 + Build + Build + ProjectExplorer.BuildSteps.Build + + + + + clean + + config=release + true + GenericProjectManager.GenericMakeStep + + 1 + Clean + Clean + ProjectExplorer.BuildSteps.Clean + + 2 + false + + false + + release + GenericProjectManager.GenericBuildConfiguration + + 2 + + + 0 + Deploy + Deploy + ProjectExplorer.BuildSteps.Deploy + + 1 + + false + ProjectExplorer.DefaultDeployConfiguration + + 1 + + true + 0 + true + true + + 2 + + false + /Users/prognoz/programming/efsw/bin/efsw-test-debug + debug + ProjectExplorer.CustomExecutableRunConfiguration + + true + 0 + false + 1 + false + false + %{buildDir}/../../bin + + + true + 0 + true + true + + 2 + + false + efsw-test + release + ProjectExplorer.CustomExecutableRunConfiguration + + false + 1 + false + true + false + %{buildDir}/../../bin/ + + 2 + + + + ProjectExplorer.Project.TargetCount + 1 + + + ProjectExplorer.Project.Updater.FileVersion + 22 + + + Version + 22 + + diff --git a/vendor/efsw/project/qtcreator-osx/efsw.cxxflags b/vendor/efsw/project/qtcreator-osx/efsw.cxxflags new file mode 100644 index 0000000..6435dfc --- /dev/null +++ b/vendor/efsw/project/qtcreator-osx/efsw.cxxflags @@ -0,0 +1 @@ +-std=c++17 \ No newline at end of file diff --git a/vendor/efsw/project/qtcreator-osx/efsw.files b/vendor/efsw/project/qtcreator-osx/efsw.files new file mode 100644 index 0000000..0ab369f --- /dev/null +++ b/vendor/efsw/project/qtcreator-osx/efsw.files @@ -0,0 +1,185 @@ +../../include/efsw/efsw.hpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/Thread.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/System.cpp +../../src/efsw/platform/platformimpl.hpp +../../src/efsw/platform/posix/ThreadImpl.hpp +../../src/efsw/platform/posix/MutexImpl.hpp +../../src/efsw/platform/posix/SystemImpl.hpp +../../src/efsw/platform/posix/ThreadImpl.cpp +../../src/efsw/platform/posix/MutexImpl.cpp +../../src/efsw/platform/posix/SystemImpl.cpp +../../src/efsw/platform/win/ThreadImpl.hpp +../../src/efsw/platform/win/MutexImpl.hpp +../../src/efsw/platform/win/SystemImpl.hpp +../../src/efsw/platform/win/ThreadImpl.cpp +../../src/efsw/platform/win/MutexImpl.cpp +../../src/efsw/platform/win/SystemImpl.cpp +../../src/efsw/base.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/platform/posix/FileSystemImpl.hpp +../../src/efsw/platform/posix/FileSystemImpl.cpp +../../src/efsw/platform/win/FileSystemImpl.hpp +../../src/efsw/platform/win/FileSystemImpl.cpp +../../src/efsw/FileInfo.cpp +../../src/efsw/base.hpp +../../src/efsw/Thread.hpp +../../src/efsw/System.hpp +../../src/efsw/Mutex.hpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileSystem.hpp +../../src/efsw/FileInfo.hpp +../../src/efsw/Thread.cpp +../../src/efsw/System.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/FileInfo.cpp +../../src/efsw/sophist.h +../../src/efsw/base.hpp +../../src/efsw/Utf.hpp +../../src/efsw/Thread.hpp +../../src/efsw/System.hpp +../../src/efsw/String.hpp +../../src/efsw/Mutex.hpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileSystem.hpp +../../src/efsw/FileInfo.hpp +../../src/efsw/Utf.inl +../../src/efsw/Thread.cpp +../../src/efsw/System.cpp +../../src/efsw/String.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/FileInfo.cpp +../../src/test/efsw-test.cpp +../../premake4.lua +../../src/efsw/WatcherKqueue.hpp +../../src/efsw/WatcherKqueue.cpp +../../src/efsw/WatcherKqueue.hpp +../../src/efsw/WatcherInotify.hpp +../../src/efsw/WatcherGeneric.hpp +../../src/efsw/Utf.hpp +../../src/efsw/Thread.hpp +../../src/efsw/System.hpp +../../src/efsw/String.hpp +../../src/efsw/sophist.h +../../src/efsw/Mutex.hpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileSystem.hpp +../../src/efsw/FileInfo.hpp +../../src/efsw/DirWatcherGeneric.hpp +../../src/efsw/Debug.hpp +../../src/efsw/base.hpp +../../src/efsw/WatcherKqueue.cpp +../../src/efsw/WatcherInotify.cpp +../../src/efsw/WatcherGeneric.cpp +../../src/efsw/Utf.inl +../../src/efsw/Thread.cpp +../../src/efsw/System.cpp +../../src/efsw/String.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/Log.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/FileInfo.cpp +../../src/efsw/DirWatcherGeneric.cpp +../../src/efsw/Debug.cpp +../../src/efsw/FileWatcherImpl.cpp +../../src/efsw/DirectorySnapshotDiff.hpp +../../src/efsw/DirectorySnapshot.hpp +../../src/efsw/DirectorySnapshotDiff.cpp +../../src/efsw/DirectorySnapshot.cpp +../../src/efsw/WatcherFSEvents.hpp +../../src/efsw/FileWatcherFSEvents.hpp +../../src/efsw/WatcherFSEvents.cpp +../../src/efsw/FileWatcherFSEvents.cpp +../../src/efsw/WatcherWin32.hpp +../../src/efsw/WatcherKqueue.hpp +../../src/efsw/WatcherInotify.hpp +../../src/efsw/WatcherGeneric.hpp +../../src/efsw/WatcherFSEvents.hpp +../../src/efsw/Watcher.hpp +../../src/efsw/Utf.hpp +../../src/efsw/Thread.hpp +../../src/efsw/System.hpp +../../src/efsw/String.hpp +../../src/efsw/sophist.h +../../src/efsw/Mutex.hpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileWatcherFSEvents.hpp +../../src/efsw/FileSystem.hpp +../../src/efsw/FileInfo.hpp +../../src/efsw/DirWatcherGeneric.hpp +../../src/efsw/DirectorySnapshotDiff.hpp +../../src/efsw/DirectorySnapshot.hpp +../../src/efsw/Debug.hpp +../../src/efsw/base.hpp +../../src/efsw/WatcherWin32.cpp +../../src/efsw/WatcherKqueue.cpp +../../src/efsw/WatcherInotify.cpp +../../src/efsw/WatcherGeneric.cpp +../../src/efsw/WatcherFSEvents.cpp +../../src/efsw/Watcher.cpp +../../src/efsw/Utf.inl +../../src/efsw/Thread.cpp +../../src/efsw/System.cpp +../../src/efsw/String.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/Log.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherImpl.cpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileWatcherFSEvents.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/FileInfo.cpp +../../src/efsw/DirWatcherGeneric.cpp +../../src/efsw/DirectorySnapshotDiff.cpp +../../src/efsw/DirectorySnapshot.cpp +../../src/efsw/Debug.cpp diff --git a/vendor/efsw/project/qtcreator-osx/efsw.includes b/vendor/efsw/project/qtcreator-osx/efsw.includes new file mode 100644 index 0000000..1f6e72e --- /dev/null +++ b/vendor/efsw/project/qtcreator-osx/efsw.includes @@ -0,0 +1,7 @@ +../../src +../../include +/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/../include/c++/v1 +/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/clang/12.0.0/include +/Library/Developer/CommandLineTools/SDKs/MacOSX10.15.sdk/usr/include +/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include +/Library/Developer/CommandLineTools/SDKs/MacOSX10.15.sdk/System/Library/Frameworks diff --git a/vendor/efsw/project/qtcreator-win/efsw.cflags b/vendor/efsw/project/qtcreator-win/efsw.cflags new file mode 100644 index 0000000..68d5165 --- /dev/null +++ b/vendor/efsw/project/qtcreator-win/efsw.cflags @@ -0,0 +1 @@ +-std=c17 \ No newline at end of file diff --git a/vendor/efsw/project/qtcreator-win/efsw.config b/vendor/efsw/project/qtcreator-win/efsw.config new file mode 100644 index 0000000..8cec188 --- /dev/null +++ b/vendor/efsw/project/qtcreator-win/efsw.config @@ -0,0 +1 @@ +// ADD PREDEFINED MACROS HERE! diff --git a/vendor/efsw/project/qtcreator-win/efsw.creator b/vendor/efsw/project/qtcreator-win/efsw.creator new file mode 100644 index 0000000..e94cbbd --- /dev/null +++ b/vendor/efsw/project/qtcreator-win/efsw.creator @@ -0,0 +1 @@ +[General] diff --git a/vendor/efsw/project/qtcreator-win/efsw.creator.user b/vendor/efsw/project/qtcreator-win/efsw.creator.user new file mode 100644 index 0000000..deadd7e --- /dev/null +++ b/vendor/efsw/project/qtcreator-win/efsw.creator.user @@ -0,0 +1,211 @@ + + + + + + EnvironmentId + {55fc4913-4acc-49e6-b0d5-ebf25d4d498e} + + + ProjectExplorer.Project.ActiveTarget + 0 + + + ProjectExplorer.Project.EditorSettings + + true + false + true + + Cpp + + CppGlobal + + + + QmlJS + + QmlJSGlobal + + + 2 + UTF-8 + false + 4 + false + 80 + true + true + 1 + true + false + 0 + true + true + 0 + 8 + true + 1 + true + true + true + false + + + + ProjectExplorer.Project.PluginSettings + + + + ProjectExplorer.Project.Target.0 + + Desktop + Desktop + {eb5b6178-a7a7-439e-ab01-e63b057196a1} + 0 + 0 + 0 + + C:\programming\efsw\make\windows + + + + all + + false + + + false + true + Make + + GenericProjectManager.GenericMakeStep + + 1 + Build + + ProjectExplorer.BuildSteps.Build + + + + + clean + + true + + + false + true + Make + + GenericProjectManager.GenericMakeStep + + 1 + Clean + + ProjectExplorer.BuildSteps.Clean + + 2 + false + + Default + Default + GenericProjectManager.GenericBuildConfiguration + + 1 + + + 0 + Deploy + + ProjectExplorer.BuildSteps.Deploy + + 1 + Deploy locally + + ProjectExplorer.DefaultDeployConfiguration + + 1 + + + dwarf + + cpu-cycles + + + 250 + -F + true + 4096 + false + false + 1000 + + true + + false + false + false + false + true + 0.01 + 10 + true + kcachegrind + 1 + 25 + + 1 + true + false + true + valgrind + + 0 + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + + 2 + + %{buildDir}\..\..\bin\efsw-test-debug.exe + Run C:\programming\efsw\bin\efsw-test-debug.exe + + ProjectExplorer.CustomExecutableRunConfiguration + + 3768 + false + true + false + false + true + %{buildDir} + + + 1 + + + + ProjectExplorer.Project.TargetCount + 1 + + + ProjectExplorer.Project.Updater.FileVersion + 22 + + + Version + 22 + + diff --git a/vendor/efsw/project/qtcreator-win/efsw.cxxflags b/vendor/efsw/project/qtcreator-win/efsw.cxxflags new file mode 100644 index 0000000..6435dfc --- /dev/null +++ b/vendor/efsw/project/qtcreator-win/efsw.cxxflags @@ -0,0 +1 @@ +-std=c++17 \ No newline at end of file diff --git a/vendor/efsw/project/qtcreator-win/efsw.files b/vendor/efsw/project/qtcreator-win/efsw.files new file mode 100644 index 0000000..8efe50d --- /dev/null +++ b/vendor/efsw/project/qtcreator-win/efsw.files @@ -0,0 +1,215 @@ +../../include/efsw/efsw.hpp +../../premake5.lua +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/Thread.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/System.cpp +../../src/efsw/platform/platformimpl.hpp +../../src/efsw/platform/posix/ThreadImpl.hpp +../../src/efsw/platform/posix/MutexImpl.hpp +../../src/efsw/platform/posix/SystemImpl.hpp +../../src/efsw/platform/posix/ThreadImpl.cpp +../../src/efsw/platform/posix/MutexImpl.cpp +../../src/efsw/platform/posix/SystemImpl.cpp +../../src/efsw/platform/win/ThreadImpl.hpp +../../src/efsw/platform/win/MutexImpl.hpp +../../src/efsw/platform/win/SystemImpl.hpp +../../src/efsw/platform/win/ThreadImpl.cpp +../../src/efsw/platform/win/MutexImpl.cpp +../../src/efsw/platform/win/SystemImpl.cpp +../../src/efsw/base.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/platform/posix/FileSystemImpl.hpp +../../src/efsw/platform/posix/FileSystemImpl.cpp +../../src/efsw/platform/win/FileSystemImpl.hpp +../../src/efsw/platform/win/FileSystemImpl.cpp +../../src/efsw/FileInfo.cpp +../../src/efsw/base.hpp +../../src/efsw/Thread.hpp +../../src/efsw/System.hpp +../../src/efsw/Mutex.hpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileSystem.hpp +../../src/efsw/FileInfo.hpp +../../src/efsw/Thread.cpp +../../src/efsw/System.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/FileInfo.cpp +../../src/efsw/sophist.h +../../src/efsw/base.hpp +../../src/efsw/Utf.hpp +../../src/efsw/Thread.hpp +../../src/efsw/System.hpp +../../src/efsw/String.hpp +../../src/efsw/Mutex.hpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileSystem.hpp +../../src/efsw/FileInfo.hpp +../../src/efsw/Utf.inl +../../src/efsw/Thread.cpp +../../src/efsw/System.cpp +../../src/efsw/String.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/FileInfo.cpp +../../src/test/efsw-test.cpp +../../src/efsw/WatcherKqueue.hpp +../../src/efsw/WatcherInotify.hpp +../../src/efsw/WatcherGeneric.hpp +../../src/efsw/Utf.hpp +../../src/efsw/Thread.hpp +../../src/efsw/System.hpp +../../src/efsw/String.hpp +../../src/efsw/Mutex.hpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileSystem.hpp +../../src/efsw/FileInfo.hpp +../../src/efsw/DirWatcherGeneric.hpp +../../src/efsw/Debug.hpp +../../src/efsw/base.hpp +../../src/efsw/sophist.h +../../src/efsw/Utf.inl +../../src/efsw/WatcherKqueue.cpp +../../src/efsw/WatcherInotify.cpp +../../src/efsw/WatcherGeneric.cpp +../../src/efsw/Thread.cpp +../../src/efsw/System.cpp +../../src/efsw/String.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/Log.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/FileInfo.cpp +../../src/efsw/DirWatcherGeneric.cpp +../../src/efsw/Debug.cpp +../../premake4.lua +../../src/efsw/WatcherKqueue.hpp +../../src/efsw/WatcherInotify.hpp +../../src/efsw/WatcherGeneric.hpp +../../src/efsw/Utf.hpp +../../src/efsw/Thread.hpp +../../src/efsw/System.hpp +../../src/efsw/String.hpp +../../src/efsw/sophist.h +../../src/efsw/Mutex.hpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileSystem.hpp +../../src/efsw/FileInfo.hpp +../../src/efsw/DirWatcherGeneric.hpp +../../src/efsw/Debug.hpp +../../src/efsw/base.hpp +../../src/efsw/Utf.inl +../../src/efsw/WatcherKqueue.cpp +../../src/efsw/WatcherInotify.cpp +../../src/efsw/WatcherGeneric.cpp +../../src/efsw/Thread.cpp +../../src/efsw/System.cpp +../../src/efsw/String.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/Log.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherImpl.cpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/FileInfo.cpp +../../src/efsw/DirWatcherGeneric.cpp +../../src/efsw/Debug.cpp +../../src/efsw/WatcherWin32.hpp +../../src/efsw/WatcherKqueue.hpp +../../src/efsw/WatcherInotify.hpp +../../src/efsw/WatcherGeneric.hpp +../../src/efsw/WatcherFSEvents.hpp +../../src/efsw/Watcher.hpp +../../src/efsw/Utf.hpp +../../src/efsw/Thread.hpp +../../src/efsw/System.hpp +../../src/efsw/String.hpp +../../src/efsw/sophist.h +../../src/efsw/Mutex.hpp +../../src/efsw/FileWatcherWin32.hpp +../../src/efsw/FileWatcherKqueue.hpp +../../src/efsw/FileWatcherInotify.hpp +../../src/efsw/FileWatcherImpl.hpp +../../src/efsw/FileWatcherGeneric.hpp +../../src/efsw/FileWatcherFSEvents.hpp +../../src/efsw/FileSystem.hpp +../../src/efsw/FileInfo.hpp +../../src/efsw/DirWatcherGeneric.hpp +../../src/efsw/DirectorySnapshotDiff.hpp +../../src/efsw/DirectorySnapshot.hpp +../../src/efsw/Debug.hpp +../../src/efsw/base.hpp +../../src/efsw/Utf.inl +../../src/efsw/WatcherWin32.cpp +../../src/efsw/WatcherKqueue.cpp +../../src/efsw/WatcherInotify.cpp +../../src/efsw/WatcherGeneric.cpp +../../src/efsw/WatcherFSEvents.cpp +../../src/efsw/Watcher.cpp +../../src/efsw/Thread.cpp +../../src/efsw/System.cpp +../../src/efsw/String.cpp +../../src/efsw/Mutex.cpp +../../src/efsw/Log.cpp +../../src/efsw/FileWatcherWin32.cpp +../../src/efsw/FileWatcherKqueue.cpp +../../src/efsw/FileWatcherInotify.cpp +../../src/efsw/FileWatcherImpl.cpp +../../src/efsw/FileWatcherGeneric.cpp +../../src/efsw/FileWatcherFSEvents.cpp +../../src/efsw/FileWatcher.cpp +../../src/efsw/FileSystem.cpp +../../src/efsw/FileInfo.cpp +../../src/efsw/DirWatcherGeneric.cpp +../../src/efsw/DirectorySnapshotDiff.cpp +../../src/efsw/DirectorySnapshot.cpp +../../src/efsw/Debug.cpp +../../include/efsw/efsw.h +../../src/efsw/FileWatcherCWrapper.cpp diff --git a/vendor/efsw/project/qtcreator-win/efsw.includes b/vendor/efsw/project/qtcreator-win/efsw.includes new file mode 100644 index 0000000..0eeab56 --- /dev/null +++ b/vendor/efsw/project/qtcreator-win/efsw.includes @@ -0,0 +1,2 @@ +../../src +../../include diff --git a/vendor/efsw/src/efsw/Atomic.hpp b/vendor/efsw/src/efsw/Atomic.hpp new file mode 100644 index 0000000..9015c60 --- /dev/null +++ b/vendor/efsw/src/efsw/Atomic.hpp @@ -0,0 +1,33 @@ +#ifndef EFSW_ATOMIC_BOOL_HPP +#define EFSW_ATOMIC_BOOL_HPP + +#include + +#include + +namespace efsw { + +template class Atomic { + public: + explicit Atomic( T set = false ) : set_( set ) {} + + Atomic& operator=( T set ) { + set_.store( set, std::memory_order_release ); + return *this; + } + + explicit operator T() const { + return set_.load( std::memory_order_acquire ); + } + + T load() const { + return set_.load( std::memory_order_acquire ); + } + + private: + std::atomic set_; +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/Debug.cpp b/vendor/efsw/src/efsw/Debug.cpp new file mode 100644 index 0000000..18cfd31 --- /dev/null +++ b/vendor/efsw/src/efsw/Debug.cpp @@ -0,0 +1,81 @@ +#include +#include + +#ifdef EFSW_COMPILER_MSVC +#define WIN32_LEAN_AND_MEAN +#include +#include +#endif + +#include +#include +#include + +namespace efsw { + +#ifdef DEBUG + +void efREPORT_ASSERT( const char* File, int Line, const char* Exp ) { +#ifdef EFSW_COMPILER_MSVC + _CrtDbgReport( _CRT_ASSERT, File, Line, "", Exp ); + + DebugBreak(); +#else + std::cout << "ASSERT: " << Exp << " file: " << File << " line: " << Line << std::endl; + +#if defined( EFSW_COMPILER_GCC ) && defined( EFSW_32BIT ) && !defined( EFSW_ARM ) + asm( "int3" ); +#else + assert( false ); +#endif +#endif +} + +void efPRINT( const char* format, ... ) { + char buf[2048]; + va_list args; + + va_start( args, format ); + +#ifdef EFSW_COMPILER_MSVC + _vsnprintf_s( buf, sizeof( buf ), sizeof( buf ) / sizeof( buf[0] ), format, args ); +#else + vsnprintf( buf, sizeof( buf ) / sizeof( buf[0] ), format, args ); +#endif + + va_end( args ); + +#ifdef EFSW_COMPILER_MSVC + OutputDebugStringA( buf ); +#else + std::cout << buf; +#endif +} + +void efPRINTC( unsigned int cond, const char* format, ... ) { + if ( 0 == cond ) + return; + + char buf[2048]; + va_list args; + + va_start( args, format ); + +#ifdef EFSW_COMPILER_MSVC + _vsnprintf_s( buf, efARRAY_SIZE( buf ), efARRAY_SIZE( buf ), format, args ); +#else + vsnprintf( buf, sizeof( buf ) / sizeof( buf[0] ), format, args ); +#endif + + va_end( args ); + +#ifdef EFSW_COMPILER_MSVC + OutputDebugStringA( buf ); +#else + std::cout << buf; +#endif +} + +#endif + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/Debug.hpp b/vendor/efsw/src/efsw/Debug.hpp new file mode 100644 index 0000000..fefaec4 --- /dev/null +++ b/vendor/efsw/src/efsw/Debug.hpp @@ -0,0 +1,62 @@ +#ifndef EFSW_DEBUG_HPP +#define EFSW_DEBUG_HPP + +#include + +namespace efsw { + +#ifdef DEBUG + +void efREPORT_ASSERT( const char* File, const int Line, const char* Exp ); + +#define efASSERT( expr ) \ + if ( !( expr ) ) { \ + efREPORT_ASSERT( __FILE__, __LINE__, #expr ); \ + } +#define efASSERTM( expr, msg ) \ + if ( !( expr ) ) { \ + efREPORT_ASSERT( __FILE__, __LINE__, #msg ); \ + } + +void efPRINT( const char* format, ... ); +void efPRINTC( unsigned int cond, const char* format, ... ); + +#else + +#define efASSERT( expr ) +#define efASSERTM( expr, msg ) + +#ifndef EFSW_COMPILER_MSVC +#define efPRINT( format, args... ) \ + {} +#define efPRINTC( cond, format, args... ) \ + {} +#else +#define efPRINT +#define efPRINTC +#endif + +#endif + +#ifdef EFSW_VERBOSE +#define efDEBUG efPRINT +#define efDEBUGC efPRINTC +#else + +#ifndef EFSW_COMPILER_MSVC +#define efDEBUG( format, args... ) \ + {} +#define efDEBUGC( cond, format, args... ) \ + {} +#else +#define efDEBUG( ... ) \ + {} +#define efDEBUGC( ... ) \ + {} +#endif + +#endif + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/DirWatcherGeneric.cpp b/vendor/efsw/src/efsw/DirWatcherGeneric.cpp new file mode 100644 index 0000000..8b6bc8a --- /dev/null +++ b/vendor/efsw/src/efsw/DirWatcherGeneric.cpp @@ -0,0 +1,388 @@ +#include +#include +#include +#include + +namespace efsw { + +DirWatcherGeneric::DirWatcherGeneric( DirWatcherGeneric* parent, WatcherGeneric* ws, + const std::string& directory, bool recursive, + bool reportNewFiles ) : + Parent( parent ), Watch( ws ), Recursive( recursive ), Deleted( false ) { + resetDirectory( directory ); + + if ( !reportNewFiles ) { + DirSnap.scan(); + } else { + DirectorySnapshotDiff Diff = DirSnap.scan(); + + if ( Diff.changed() ) { + FileInfoList::iterator it; + + DiffIterator( FilesCreated ) { + handleAction( ( *it ).Filepath, Actions::Add ); + } + } + } +} + +DirWatcherGeneric::~DirWatcherGeneric() { + /// If the directory was deleted mark the files as deleted + if ( Deleted ) { + DirectorySnapshotDiff Diff = DirSnap.scan(); + + if ( !DirSnap.exists() ) { + FileInfoList::iterator it; + + DiffIterator( FilesDeleted ) { + handleAction( ( *it ).Filepath, Actions::Delete ); + } + + DiffIterator( DirsDeleted ) { + handleAction( ( *it ).Filepath, Actions::Delete ); + } + } + } + + DirWatchMap::iterator it = Directories.begin(); + + for ( ; it != Directories.end(); ++it ) { + if ( Deleted ) { + /// If the directory was deleted, mark the flag for file deletion + it->second->Deleted = true; + } + + efSAFE_DELETE( it->second ); + } +} + +void DirWatcherGeneric::resetDirectory( std::string directory ) { + std::string dir( directory ); + + /// Is this a recursive watch? + if ( Watch->Directory != directory ) { + if ( !( directory.size() && + ( directory.at( 0 ) == FileSystem::getOSSlash() || + directory.at( directory.size() - 1 ) == FileSystem::getOSSlash() ) ) ) { + /// Get the real directory + if ( NULL != Parent ) { + std::string parentPath( Parent->DirSnap.DirectoryInfo.Filepath ); + FileSystem::dirAddSlashAtEnd( parentPath ); + FileSystem::dirAddSlashAtEnd( directory ); + + dir = parentPath + directory; + } else { + efDEBUG( "resetDirectory(): Parent is NULL. Fatal error." ); + } + } + } + + DirSnap.setDirectoryInfo( dir ); +} + +void DirWatcherGeneric::handleAction( const std::string& filename, unsigned long action, + std::string oldFilename ) { + Watch->Listener->handleFileAction( Watch->ID, DirSnap.DirectoryInfo.Filepath, + FileSystem::fileNameFromPath( filename ), (Action)action, + oldFilename ); +} + +void DirWatcherGeneric::addChilds( bool reportNewFiles ) { + if ( Recursive ) { + /// Create the subdirectories watchers + std::string dir; + + for ( FileInfoMap::iterator it = DirSnap.Files.begin(); it != DirSnap.Files.end(); it++ ) { + if ( it->second.isDirectory() && it->second.isReadable() && + !FileSystem::isRemoteFS( it->second.Filepath ) ) { + /// Check if the directory is a symbolic link + std::string curPath; + std::string link( FileSystem::getLinkRealPath( it->second.Filepath, curPath ) ); + + dir = it->first; + + if ( "" != link ) { + /// Avoid adding symlinks directories if it's now enabled + if ( !Watch->WatcherImpl->mFileWatcher->followSymlinks() ) { + continue; + } + + /// If it's a symlink check if the realpath exists as a watcher, or + /// if the path is outside the current dir + if ( Watch->WatcherImpl->pathInWatches( link ) || + Watch->pathInWatches( link ) || + !Watch->WatcherImpl->linkAllowed( curPath, link ) ) { + continue; + } else { + dir = link; + } + } else { + if ( Watch->pathInWatches( dir ) || Watch->WatcherImpl->pathInWatches( dir ) ) { + continue; + } + } + + if ( reportNewFiles ) { + handleAction( dir, Actions::Add ); + } + + Directories[dir] = + new DirWatcherGeneric( this, Watch, dir, Recursive, reportNewFiles ); + + Directories[dir]->addChilds( reportNewFiles ); + } + } + } +} + +void DirWatcherGeneric::watch( bool reportOwnChange ) { + DirectorySnapshotDiff Diff = DirSnap.scan(); + + if ( reportOwnChange && Diff.DirChanged && NULL != Parent ) { + Watch->Listener->handleFileAction( + Watch->ID, FileSystem::pathRemoveFileName( DirSnap.DirectoryInfo.Filepath ), + FileSystem::fileNameFromPath( DirSnap.DirectoryInfo.Filepath ), Actions::Modified ); + } + + if ( Diff.changed() ) { + FileInfoList::iterator it; + MovedList::iterator mit; + + /// Files + DiffIterator( FilesCreated ) { + handleAction( ( *it ).Filepath, Actions::Add ); + } + + DiffIterator( FilesModified ) { + handleAction( ( *it ).Filepath, Actions::Modified ); + } + + DiffIterator( FilesDeleted ) { + handleAction( ( *it ).Filepath, Actions::Delete ); + } + + DiffMovedIterator( FilesMoved ) { + handleAction( ( *mit ).second.Filepath, Actions::Moved, ( *mit ).first ); + } + + /// Directories + DiffIterator( DirsCreated ) { + createDirectory( ( *it ).Filepath ); + } + + DiffIterator( DirsModified ) { + handleAction( ( *it ).Filepath, Actions::Modified ); + } + + DiffIterator( DirsDeleted ) { + handleAction( ( *it ).Filepath, Actions::Delete ); + removeDirectory( ( *it ).Filepath ); + } + + DiffMovedIterator( DirsMoved ) { + handleAction( ( *mit ).second.Filepath, Actions::Moved, ( *mit ).first ); + moveDirectory( ( *mit ).first, ( *mit ).second.Filepath ); + } + } + + /// Process the subdirectories looking for changes + for ( DirWatchMap::iterator dit = Directories.begin(); dit != Directories.end(); ++dit ) { + /// Just watch + dit->second->watch(); + } +} + +void DirWatcherGeneric::watchDir( std::string& dir ) { + DirWatcherGeneric* watcher = Watch->WatcherImpl->mFileWatcher->allowOutOfScopeLinks() + ? findDirWatcher( dir ) + : findDirWatcherFast( dir ); + + if ( NULL != watcher ) { + watcher->watch( true ); + } +} + +DirWatcherGeneric* DirWatcherGeneric::findDirWatcherFast( std::string dir ) { + // remove the common base ( dir should always start with the same base as the watcher ) + efASSERT( !dir.empty() ); + efASSERT( dir.size() >= DirSnap.DirectoryInfo.Filepath.size() ); + efASSERT( DirSnap.DirectoryInfo.Filepath == + dir.substr( 0, DirSnap.DirectoryInfo.Filepath.size() ) ); + + if ( dir.size() >= DirSnap.DirectoryInfo.Filepath.size() ) { + dir = dir.substr( DirSnap.DirectoryInfo.Filepath.size() - 1 ); + } + + if ( dir.size() == 1 ) { + efASSERT( dir[0] == FileSystem::getOSSlash() ); + return this; + } + + size_t level = 0; + std::vector dirv = String::split( dir, FileSystem::getOSSlash(), false ); + + DirWatcherGeneric* watcher = this; + + while ( level < dirv.size() ) { + // search the dir level in the current watcher + DirWatchMap::iterator it = watcher->Directories.find( dirv[level] ); + + // found? continue with the next level + if ( it != watcher->Directories.end() ) { + watcher = it->second; + + level++; + } else { + // couldn't found the folder level? + // directory not watched + return NULL; + } + } + + return watcher; +} + +DirWatcherGeneric* DirWatcherGeneric::findDirWatcher( std::string dir ) { + if ( DirSnap.DirectoryInfo.Filepath == dir ) { + return this; + } else { + DirWatcherGeneric* watcher = NULL; + + for ( DirWatchMap::iterator it = Directories.begin(); it != Directories.end(); ++it ) { + watcher = it->second->findDirWatcher( dir ); + + if ( NULL != watcher ) { + return watcher; + } + } + } + + return NULL; +} + +DirWatcherGeneric* DirWatcherGeneric::createDirectory( std::string newdir ) { + FileSystem::dirRemoveSlashAtEnd( newdir ); + newdir = FileSystem::fileNameFromPath( newdir ); + + DirWatcherGeneric* dw = NULL; + + /// Check if the directory is a symbolic link + std::string parentPath( DirSnap.DirectoryInfo.Filepath ); + FileSystem::dirAddSlashAtEnd( parentPath ); + std::string dir( parentPath + newdir ); + + FileSystem::dirAddSlashAtEnd( dir ); + + FileInfo fi( dir ); + + if ( !fi.isDirectory() || !fi.isReadable() || FileSystem::isRemoteFS( dir ) ) { + return NULL; + } + + std::string curPath; + std::string link( FileSystem::getLinkRealPath( dir, curPath ) ); + bool skip = false; + + if ( "" != link ) { + /// Avoid adding symlinks directories if it's now enabled + if ( !Watch->WatcherImpl->mFileWatcher->followSymlinks() ) { + skip = true; + } + + /// If it's a symlink check if the realpath exists as a watcher, or + /// if the path is outside the current dir + if ( Watch->WatcherImpl->pathInWatches( link ) || Watch->pathInWatches( link ) || + !Watch->WatcherImpl->linkAllowed( curPath, link ) ) { + skip = true; + } else { + dir = link; + } + } else { + if ( Watch->pathInWatches( dir ) || Watch->WatcherImpl->pathInWatches( dir ) ) { + skip = true; + } + } + + if ( !skip ) { + handleAction( newdir, Actions::Add ); + + /// Creates the new directory watcher of the subfolder and check for new files + dw = new DirWatcherGeneric( this, Watch, dir, Recursive ); + + dw->addChilds(); + + dw->watch(); + + /// Add it to the list of directories + Directories[newdir] = dw; + } + + return dw; +} + +void DirWatcherGeneric::removeDirectory( std::string dir ) { + FileSystem::dirRemoveSlashAtEnd( dir ); + dir = FileSystem::fileNameFromPath( dir ); + + DirWatcherGeneric* dw = NULL; + DirWatchMap::iterator dit; + + /// Folder deleted + + /// Search the folder, it should exists + dit = Directories.find( dir ); + + if ( dit != Directories.end() ) { + dw = dit->second; + + /// Flag it as deleted so it fire the event for every file inside deleted + dw->Deleted = true; + + /// Delete the DirWatcherGeneric + efSAFE_DELETE( dw ); + + /// Remove the directory from the map + Directories.erase( dit->first ); + } +} + +void DirWatcherGeneric::moveDirectory( std::string oldDir, std::string newDir ) { + FileSystem::dirRemoveSlashAtEnd( oldDir ); + oldDir = FileSystem::fileNameFromPath( oldDir ); + + FileSystem::dirRemoveSlashAtEnd( newDir ); + newDir = FileSystem::fileNameFromPath( newDir ); + + DirWatcherGeneric* dw = NULL; + DirWatchMap::iterator dit; + + /// Directory existed? + dit = Directories.find( oldDir ); + + if ( dit != Directories.end() ) { + dw = dit->second; + + /// Remove the directory from the map + Directories.erase( dit->first ); + + Directories[newDir] = dw; + + dw->resetDirectory( newDir ); + } +} + +bool DirWatcherGeneric::pathInWatches( std::string path ) { + if ( DirSnap.DirectoryInfo.Filepath == path ) { + return true; + } + + for ( DirWatchMap::iterator it = Directories.begin(); it != Directories.end(); ++it ) { + if ( it->second->pathInWatches( path ) ) { + return true; + } + } + + return false; +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/DirWatcherGeneric.hpp b/vendor/efsw/src/efsw/DirWatcherGeneric.hpp new file mode 100644 index 0000000..ca52de7 --- /dev/null +++ b/vendor/efsw/src/efsw/DirWatcherGeneric.hpp @@ -0,0 +1,57 @@ +#ifndef EFSW_DIRWATCHERGENERIC_HPP +#define EFSW_DIRWATCHERGENERIC_HPP + +#include +#include +#include +#include + +namespace efsw { + +class DirWatcherGeneric { + public: + typedef std::map DirWatchMap; + + DirWatcherGeneric* Parent; + WatcherGeneric* Watch; + DirectorySnapshot DirSnap; + DirWatchMap Directories; + bool Recursive; + + DirWatcherGeneric( DirWatcherGeneric* parent, WatcherGeneric* ws, const std::string& directory, + bool recursive, bool reportNewFiles = false ); + + ~DirWatcherGeneric(); + + void watch( bool reportOwnChange = false ); + + void watchDir( std::string& dir ); + + static bool isDir( const std::string& directory ); + + bool pathInWatches( std::string path ); + + void addChilds( bool reportNewFiles = true ); + + DirWatcherGeneric* findDirWatcher( std::string dir ); + + DirWatcherGeneric* findDirWatcherFast( std::string dir ); + + protected: + bool Deleted; + + DirWatcherGeneric* createDirectory( std::string newdir ); + + void removeDirectory( std::string dir ); + + void moveDirectory( std::string oldDir, std::string newDir ); + + void resetDirectory( std::string directory ); + + void handleAction( const std::string& filename, unsigned long action, + std::string oldFilename = "" ); +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/DirectorySnapshot.cpp b/vendor/efsw/src/efsw/DirectorySnapshot.cpp new file mode 100644 index 0000000..f78475f --- /dev/null +++ b/vendor/efsw/src/efsw/DirectorySnapshot.cpp @@ -0,0 +1,212 @@ +#include +#include + +namespace efsw { + +DirectorySnapshot::DirectorySnapshot() {} + +DirectorySnapshot::DirectorySnapshot( std::string directory ) { + init( directory ); +} + +DirectorySnapshot::~DirectorySnapshot() {} + +void DirectorySnapshot::init( std::string directory ) { + setDirectoryInfo( directory ); + initFiles(); +} + +bool DirectorySnapshot::exists() { + return DirectoryInfo.exists(); +} + +void DirectorySnapshot::deleteAll( DirectorySnapshotDiff& Diff ) { + FileInfo fi; + + for ( FileInfoMap::iterator it = Files.begin(); it != Files.end(); it++ ) { + fi = it->second; + + if ( fi.isDirectory() ) { + Diff.DirsDeleted.push_back( fi ); + } else { + Diff.FilesDeleted.push_back( fi ); + } + } + + Files.clear(); +} + +void DirectorySnapshot::setDirectoryInfo( std::string directory ) { + DirectoryInfo = FileInfo( directory ); +} + +void DirectorySnapshot::initFiles() { + Files = FileSystem::filesInfoFromPath( DirectoryInfo.Filepath ); + + FileInfoMap::iterator it = Files.begin(); + std::vector eraseFiles; + + /// Remove all non regular files and non directories + for ( ; it != Files.end(); it++ ) { + if ( !it->second.isRegularFile() && !it->second.isDirectory() ) { + eraseFiles.push_back( it->first ); + } + } + + for ( std::vector::iterator eit = eraseFiles.begin(); eit != eraseFiles.end(); + eit++ ) { + Files.erase( *eit ); + } +} + +DirectorySnapshotDiff DirectorySnapshot::scan() { + DirectorySnapshotDiff Diff; + + Diff.clear(); + + FileInfo curFI( DirectoryInfo.Filepath ); + + Diff.DirChanged = DirectoryInfo != curFI; + + if ( Diff.DirChanged ) { + DirectoryInfo = curFI; + } + + /// If the directory was erased, create the events for files and directories deletion + if ( !curFI.exists() ) { + deleteAll( Diff ); + + return Diff; + } + + FileInfoMap files = FileSystem::filesInfoFromPath( DirectoryInfo.Filepath ); + + if ( files.empty() && Files.empty() ) { + return Diff; + } + + FileInfo fi; + FileInfoMap FilesCpy; + FileInfoMap::iterator it; + FileInfoMap::iterator fiIt; + + if ( Diff.DirChanged ) { + FilesCpy = Files; + } + + for ( it = files.begin(); it != files.end(); it++ ) { + fi = it->second; + + /// File existed before? + fiIt = Files.find( it->first ); + + if ( fiIt != Files.end() ) { + /// Erase from the file list copy + FilesCpy.erase( it->first ); + + /// File changed? + if ( ( *fiIt ).second != fi ) { + /// Update the new file info + Files[it->first] = fi; + + /// handle modified event + if ( fi.isDirectory() ) { + Diff.DirsModified.push_back( fi ); + } else { + Diff.FilesModified.push_back( fi ); + } + } + } + /// Only add regular files or directories + else if ( fi.isRegularFile() || fi.isDirectory() ) { + /// New file found + Files[it->first] = fi; + + FileInfoMap::iterator fit; + std::string oldFile = ""; + + /// Check if the same inode already existed + if ( ( fit = nodeInFiles( fi ) ) != Files.end() ) { + oldFile = fit->first; + + /// Avoid firing a Delete event + FilesCpy.erase( fit->first ); + + /// Delete the old file name + Files.erase( fit->first ); + + if ( fi.isDirectory() ) { + Diff.DirsMoved.push_back( std::make_pair( oldFile, fi ) ); + } else { + Diff.FilesMoved.push_back( std::make_pair( oldFile, fi ) ); + } + } else { + if ( fi.isDirectory() ) { + Diff.DirsCreated.push_back( fi ); + } else { + Diff.FilesCreated.push_back( fi ); + } + } + } + } + + if ( !Diff.DirChanged ) { + return Diff; + } + + /// The files or directories that remains were deleted + for ( it = FilesCpy.begin(); it != FilesCpy.end(); it++ ) { + fi = it->second; + + if ( fi.isDirectory() ) { + Diff.DirsDeleted.push_back( fi ); + } else { + Diff.FilesDeleted.push_back( fi ); + } + + /// Remove the file or directory from the list of files + Files.erase( it->first ); + } + + return Diff; +} + +FileInfoMap::iterator DirectorySnapshot::nodeInFiles( FileInfo& fi ) { + FileInfoMap::iterator it; + + if ( FileInfo::inodeSupported() ) { + for ( it = Files.begin(); it != Files.end(); it++ ) { + if ( it->second.sameInode( fi ) && it->second.Filepath != fi.Filepath ) { + return it; + } + } + } + + return Files.end(); +} + +void DirectorySnapshot::addFile( std::string path ) { + std::string name( FileSystem::fileNameFromPath( path ) ); + Files[name] = FileInfo( path ); +} + +void DirectorySnapshot::removeFile( std::string path ) { + std::string name( FileSystem::fileNameFromPath( path ) ); + + FileInfoMap::iterator it = Files.find( name ); + + if ( Files.end() != it ) { + Files.erase( it ); + } +} + +void DirectorySnapshot::moveFile( std::string oldPath, std::string newPath ) { + removeFile( oldPath ); + addFile( newPath ); +} + +void DirectorySnapshot::updateFile( std::string path ) { + addFile( path ); +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/DirectorySnapshot.hpp b/vendor/efsw/src/efsw/DirectorySnapshot.hpp new file mode 100644 index 0000000..0e60542 --- /dev/null +++ b/vendor/efsw/src/efsw/DirectorySnapshot.hpp @@ -0,0 +1,45 @@ +#ifndef EFSW_DIRECTORYSNAPSHOT_HPP +#define EFSW_DIRECTORYSNAPSHOT_HPP + +#include + +namespace efsw { + +class DirectorySnapshot { + public: + FileInfo DirectoryInfo; + FileInfoMap Files; + + void setDirectoryInfo( std::string directory ); + + DirectorySnapshot(); + + DirectorySnapshot( std::string directory ); + + ~DirectorySnapshot(); + + void init( std::string directory ); + + bool exists(); + + DirectorySnapshotDiff scan(); + + FileInfoMap::iterator nodeInFiles( FileInfo& fi ); + + void addFile( std::string path ); + + void removeFile( std::string path ); + + void moveFile( std::string oldPath, std::string newPath ); + + void updateFile( std::string path ); + + protected: + void initFiles(); + + void deleteAll( DirectorySnapshotDiff& Diff ); +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/DirectorySnapshotDiff.cpp b/vendor/efsw/src/efsw/DirectorySnapshotDiff.cpp new file mode 100644 index 0000000..37ee507 --- /dev/null +++ b/vendor/efsw/src/efsw/DirectorySnapshotDiff.cpp @@ -0,0 +1,22 @@ +#include + +namespace efsw { + +void DirectorySnapshotDiff::clear() { + FilesCreated.clear(); + FilesModified.clear(); + FilesMoved.clear(); + FilesDeleted.clear(); + DirsCreated.clear(); + DirsModified.clear(); + DirsMoved.clear(); + DirsDeleted.clear(); +} + +bool DirectorySnapshotDiff::changed() { + return !FilesCreated.empty() || !FilesModified.empty() || !FilesMoved.empty() || + !FilesDeleted.empty() || !DirsCreated.empty() || !DirsModified.empty() || + !DirsMoved.empty() || !DirsDeleted.empty(); +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/DirectorySnapshotDiff.hpp b/vendor/efsw/src/efsw/DirectorySnapshotDiff.hpp new file mode 100644 index 0000000..26a29ec --- /dev/null +++ b/vendor/efsw/src/efsw/DirectorySnapshotDiff.hpp @@ -0,0 +1,35 @@ +#ifndef EFSW_DIRECTORYSNAPSHOTDIFF_HPP +#define EFSW_DIRECTORYSNAPSHOTDIFF_HPP + +#include + +namespace efsw { + +class DirectorySnapshotDiff { + public: + FileInfoList FilesDeleted; + FileInfoList FilesCreated; + FileInfoList FilesModified; + MovedList FilesMoved; + FileInfoList DirsDeleted; + FileInfoList DirsCreated; + FileInfoList DirsModified; + MovedList DirsMoved; + bool DirChanged; + + void clear(); + + bool changed(); +}; + +#define DiffIterator( FileInfoListName ) \ + it = Diff.FileInfoListName.begin(); \ + for ( ; it != Diff.FileInfoListName.end(); it++ ) + +#define DiffMovedIterator( MovedListName ) \ + mit = Diff.MovedListName.begin(); \ + for ( ; mit != Diff.MovedListName.end(); mit++ ) + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/FileInfo.cpp b/vendor/efsw/src/efsw/FileInfo.cpp new file mode 100644 index 0000000..707f617 --- /dev/null +++ b/vendor/efsw/src/efsw/FileInfo.cpp @@ -0,0 +1,240 @@ +#include +#include +#include + +#ifndef _DARWIN_FEATURE_64_BIT_INODE +#define _DARWIN_FEATURE_64_BIT_INODE +#endif + +#ifndef _FILE_OFFSET_BITS +#define _FILE_OFFSET_BITS 64 +#endif + +#include + +#include +#include + +#ifdef EFSW_COMPILER_MSVC +#ifndef S_ISDIR +#define S_ISDIR( f ) ( (f)&_S_IFDIR ) +#endif + +#ifndef S_ISREG +#define S_ISREG( f ) ( (f)&_S_IFREG ) +#endif + +#ifndef S_ISRDBL +#define S_ISRDBL( f ) ( (f)&_S_IREAD ) +#endif +#else +#include + +#ifndef S_ISRDBL +#define S_ISRDBL( f ) ( (f)&S_IRUSR ) +#endif +#endif + +namespace efsw { + +bool FileInfo::exists( const std::string& filePath ) { + FileInfo fi( filePath ); + return fi.exists(); +} + +bool FileInfo::isLink( const std::string& filePath ) { + FileInfo fi( filePath, true ); + return fi.isLink(); +} + +bool FileInfo::inodeSupported() { +#if EFSW_PLATFORM != EFSW_PLATFORM_WIN32 + return true; +#else + return false; +#endif +} + +FileInfo::FileInfo() : + ModificationTime( 0 ), OwnerId( 0 ), GroupId( 0 ), Permissions( 0 ), Inode( 0 ) {} + +FileInfo::FileInfo( const std::string& filepath ) : + Filepath( filepath ), + ModificationTime( 0 ), + OwnerId( 0 ), + GroupId( 0 ), + Permissions( 0 ), + Inode( 0 ) { + getInfo(); +} + +FileInfo::FileInfo( const std::string& filepath, bool linkInfo ) : + Filepath( filepath ), + ModificationTime( 0 ), + OwnerId( 0 ), + GroupId( 0 ), + Permissions( 0 ), + Inode( 0 ) { + if ( linkInfo ) { + getRealInfo(); + } else { + getInfo(); + } +} + +void FileInfo::getInfo() { +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + if ( Filepath.size() == 3 && Filepath[1] == ':' && Filepath[2] == FileSystem::getOSSlash() ) { + Filepath += FileSystem::getOSSlash(); + } +#endif + + /// Why i'm doing this? stat in mingw32 doesn't work for directories if the dir path ends with a + /// path slash + bool slashAtEnd = FileSystem::slashAtEnd( Filepath ); + + if ( slashAtEnd ) { + FileSystem::dirRemoveSlashAtEnd( Filepath ); + } + +#if EFSW_PLATFORM != EFSW_PLATFORM_WIN32 + struct stat st; + int res = stat( Filepath.c_str(), &st ); +#else + struct _stat st; + int res = _wstat( String::fromUtf8( Filepath ).toWideString().c_str(), &st ); +#endif + + if ( 0 == res ) { + ModificationTime = st.st_mtime; + Size = st.st_size; + OwnerId = st.st_uid; + GroupId = st.st_gid; + Permissions = st.st_mode; + Inode = st.st_ino; + } + + if ( slashAtEnd ) { + FileSystem::dirAddSlashAtEnd( Filepath ); + } +} + +void FileInfo::getRealInfo() { + bool slashAtEnd = FileSystem::slashAtEnd( Filepath ); + + if ( slashAtEnd ) { + FileSystem::dirRemoveSlashAtEnd( Filepath ); + } + +#if EFSW_PLATFORM != EFSW_PLATFORM_WIN32 + struct stat st; + int res = lstat( Filepath.c_str(), &st ); +#else + struct _stat st; + int res = _wstat( String::fromUtf8( Filepath ).toWideString().c_str(), &st ); +#endif + + if ( 0 == res ) { + ModificationTime = st.st_mtime; + Size = st.st_size; + OwnerId = st.st_uid; + GroupId = st.st_gid; + Permissions = st.st_mode; + Inode = st.st_ino; + } + + if ( slashAtEnd ) { + FileSystem::dirAddSlashAtEnd( Filepath ); + } +} + +bool FileInfo::operator==( const FileInfo& Other ) const { + return ( ModificationTime == Other.ModificationTime && Size == Other.Size && + OwnerId == Other.OwnerId && GroupId == Other.GroupId && + Permissions == Other.Permissions && Inode == Other.Inode ); +} + +bool FileInfo::isDirectory() const { + return 0 != S_ISDIR( Permissions ); +} + +bool FileInfo::isRegularFile() const { + return 0 != S_ISREG( Permissions ); +} + +bool FileInfo::isReadable() const { +#if EFSW_PLATFORM != EFSW_PLATFORM_WIN32 + static bool isRoot = getuid() == 0; + return isRoot || 0 != S_ISRDBL( Permissions ); +#else + return 0 != S_ISRDBL( Permissions ); +#endif +} + +bool FileInfo::isLink() const { +#if EFSW_PLATFORM != EFSW_PLATFORM_WIN32 + return S_ISLNK( Permissions ); +#else + return false; +#endif +} + +std::string FileInfo::linksTo() { +#if EFSW_PLATFORM != EFSW_PLATFORM_WIN32 + if ( isLink() ) { + char* ch = realpath( Filepath.c_str(), NULL ); + + if ( NULL != ch ) { + std::string tstr( ch ); + + free( ch ); + + return tstr; + } + } +#endif + return std::string( "" ); +} + +bool FileInfo::exists() { + bool slashAtEnd = FileSystem::slashAtEnd( Filepath ); + + if ( slashAtEnd ) { + FileSystem::dirRemoveSlashAtEnd( Filepath ); + } + +#if EFSW_PLATFORM != EFSW_PLATFORM_WIN32 + struct stat st; + int res = stat( Filepath.c_str(), &st ); +#else + struct _stat st; + int res = _wstat( String::fromUtf8( Filepath ).toWideString().c_str(), &st ); +#endif + + if ( slashAtEnd ) { + FileSystem::dirAddSlashAtEnd( Filepath ); + } + + return 0 == res; +} + +FileInfo& FileInfo::operator=( const FileInfo& Other ) { + this->Filepath = Other.Filepath; + this->Size = Other.Size; + this->ModificationTime = Other.ModificationTime; + this->GroupId = Other.GroupId; + this->OwnerId = Other.OwnerId; + this->Permissions = Other.Permissions; + this->Inode = Other.Inode; + return *this; +} + +bool FileInfo::sameInode( const FileInfo& Other ) const { + return inodeSupported() && Inode == Other.Inode; +} + +bool FileInfo::operator!=( const FileInfo& Other ) const { + return !( *this == Other ); +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/FileInfo.hpp b/vendor/efsw/src/efsw/FileInfo.hpp new file mode 100644 index 0000000..1aca2a8 --- /dev/null +++ b/vendor/efsw/src/efsw/FileInfo.hpp @@ -0,0 +1,64 @@ +#ifndef EFSW_FILEINFO_HPP +#define EFSW_FILEINFO_HPP + +#include +#include +#include +#include + +namespace efsw { + +class FileInfo { + public: + static bool exists( const std::string& filePath ); + + static bool isLink( const std::string& filePath ); + + static bool inodeSupported(); + + FileInfo(); + + FileInfo( const std::string& filepath ); + + FileInfo( const std::string& filepath, bool linkInfo ); + + bool operator==( const FileInfo& Other ) const; + + bool operator!=( const FileInfo& Other ) const; + + FileInfo& operator=( const FileInfo& Other ); + + bool isDirectory() const; + + bool isRegularFile() const; + + bool isReadable() const; + + bool sameInode( const FileInfo& Other ) const; + + bool isLink() const; + + std::string linksTo(); + + bool exists(); + + void getInfo(); + + void getRealInfo(); + + std::string Filepath; + Uint64 ModificationTime; + Uint64 Size; + Uint32 OwnerId; + Uint32 GroupId; + Uint32 Permissions; + Uint64 Inode; +}; + +typedef std::map FileInfoMap; +typedef std::vector FileInfoList; +typedef std::vector> MovedList; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/FileSystem.cpp b/vendor/efsw/src/efsw/FileSystem.cpp new file mode 100644 index 0000000..b6d2d63 --- /dev/null +++ b/vendor/efsw/src/efsw/FileSystem.cpp @@ -0,0 +1,136 @@ +#include +#include +#include + +#if EFSW_OS == EFSW_OS_MACOSX +#include +#endif + +namespace efsw { + +bool FileSystem::isDirectory( const std::string& path ) { + return Platform::FileSystem::isDirectory( path ); +} + +FileInfoMap FileSystem::filesInfoFromPath( std::string path ) { + dirAddSlashAtEnd( path ); + + return Platform::FileSystem::filesInfoFromPath( path ); +} + +char FileSystem::getOSSlash() { + return Platform::FileSystem::getOSSlash(); +} + +bool FileSystem::slashAtEnd( std::string& dir ) { + return ( dir.size() && dir[dir.size() - 1] == getOSSlash() ); +} + +void FileSystem::dirAddSlashAtEnd( std::string& dir ) { + if ( dir.size() >= 1 && dir[dir.size() - 1] != getOSSlash() ) { + dir.push_back( getOSSlash() ); + } +} + +void FileSystem::dirRemoveSlashAtEnd( std::string& dir ) { + if ( dir.size() >= 1 && dir[dir.size() - 1] == getOSSlash() ) { + dir.erase( dir.size() - 1 ); + } +} + +std::string FileSystem::fileNameFromPath( std::string filepath ) { + dirRemoveSlashAtEnd( filepath ); + + size_t pos = filepath.find_last_of( getOSSlash() ); + + if ( pos != std::string::npos ) { + return filepath.substr( pos + 1 ); + } + + return filepath; +} + +std::string FileSystem::pathRemoveFileName( std::string filepath ) { + dirRemoveSlashAtEnd( filepath ); + + size_t pos = filepath.find_last_of( getOSSlash() ); + + if ( pos != std::string::npos ) { + return filepath.substr( 0, pos + 1 ); + } + + return filepath; +} + +std::string FileSystem::getLinkRealPath( std::string dir, std::string& curPath ) { + FileSystem::dirRemoveSlashAtEnd( dir ); + FileInfo fi( dir, true ); + + /// Check with lstat and see if it's a link + if ( fi.isLink() ) { + /// get the real path of the link + std::string link( fi.linksTo() ); + + /// get the current path of the directory without the link dir path + curPath = FileSystem::pathRemoveFileName( dir ); + + /// ensure that ends with the os directory slash + FileSystem::dirAddSlashAtEnd( link ); + + return link; + } + + /// if it's not a link return nothing + return ""; +} + +std::string FileSystem::precomposeFileName( const std::string& name ) { +#if EFSW_OS == EFSW_OS_MACOSX + CFStringRef cfStringRef = + CFStringCreateWithCString( kCFAllocatorDefault, name.c_str(), kCFStringEncodingUTF8 ); + CFMutableStringRef cfMutable = CFStringCreateMutableCopy( NULL, 0, cfStringRef ); + + CFStringNormalize( cfMutable, kCFStringNormalizationFormC ); + + const char* c_str = CFStringGetCStringPtr( cfMutable, kCFStringEncodingUTF8 ); + if ( c_str != NULL ) { + std::string result( c_str ); + CFRelease( cfStringRef ); + CFRelease( cfMutable ); + return result; + } + CFIndex length = CFStringGetLength( cfMutable ); + CFIndex maxSize = CFStringGetMaximumSizeForEncoding( length, kCFStringEncodingUTF8 ); + if ( maxSize == kCFNotFound ) { + CFRelease( cfStringRef ); + CFRelease( cfMutable ); + return std::string(); + } + + std::string result( maxSize + 1, '\0' ); + if ( CFStringGetCString( cfMutable, &result[0], result.size(), kCFStringEncodingUTF8 ) ) { + result.resize( std::strlen( result.c_str() ) ); + CFRelease( cfStringRef ); + CFRelease( cfMutable ); + } else { + result.clear(); + } + return result; +#else + return name; +#endif +} + +bool FileSystem::isRemoteFS( const std::string& directory ) { + return Platform::FileSystem::isRemoteFS( directory ); +} + +bool FileSystem::changeWorkingDirectory( const std::string& directory ) { + return Platform::FileSystem::changeWorkingDirectory( directory ); +} + +std::string FileSystem::getCurrentWorkingDirectory() { + return Platform::FileSystem::getCurrentWorkingDirectory(); +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/FileSystem.hpp b/vendor/efsw/src/efsw/FileSystem.hpp new file mode 100644 index 0000000..d8e11a0 --- /dev/null +++ b/vendor/efsw/src/efsw/FileSystem.hpp @@ -0,0 +1,40 @@ +#ifndef EFSW_FILESYSTEM_HPP +#define EFSW_FILESYSTEM_HPP + +#include +#include + +namespace efsw { + +class FileSystem { + public: + static bool isDirectory( const std::string& path ); + + static FileInfoMap filesInfoFromPath( std::string path ); + + static char getOSSlash(); + + static bool slashAtEnd( std::string& dir ); + + static void dirAddSlashAtEnd( std::string& dir ); + + static void dirRemoveSlashAtEnd( std::string& dir ); + + static std::string fileNameFromPath( std::string filepath ); + + static std::string pathRemoveFileName( std::string filepath ); + + static std::string getLinkRealPath( std::string dir, std::string& curPath ); + + static std::string precomposeFileName( const std::string& name ); + + static bool isRemoteFS( const std::string& directory ); + + static bool changeWorkingDirectory( const std::string& path ); + + static std::string getCurrentWorkingDirectory(); +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/FileWatcher.cpp b/vendor/efsw/src/efsw/FileWatcher.cpp new file mode 100644 index 0000000..f45b243 --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcher.cpp @@ -0,0 +1,120 @@ +#include +#include +#include +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 +#include +#define FILEWATCHER_IMPL FileWatcherWin32 +#define BACKEND_NAME "Win32" +#elif EFSW_PLATFORM == EFSW_PLATFORM_INOTIFY +#include +#define FILEWATCHER_IMPL FileWatcherInotify +#define BACKEND_NAME "Inotify" +#elif EFSW_PLATFORM == EFSW_PLATFORM_KQUEUE +#include +#define FILEWATCHER_IMPL FileWatcherKqueue +#define BACKEND_NAME "Kqueue" +#elif EFSW_PLATFORM == EFSW_PLATFORM_FSEVENTS +#include +#define FILEWATCHER_IMPL FileWatcherFSEvents +#define BACKEND_NAME "FSEvents" +#else +#define FILEWATCHER_IMPL FileWatcherGeneric +#define BACKEND_NAME "Generic" +#endif + +#include + +namespace efsw { + +FileWatcher::FileWatcher() : mFollowSymlinks( false ), mOutOfScopeLinks( false ) { + efDEBUG( "Using backend: %s\n", BACKEND_NAME ); + + mImpl = new FILEWATCHER_IMPL( this ); + + if ( !mImpl->initOK() ) { + efSAFE_DELETE( mImpl ); + + efDEBUG( "Falled back to backend: %s\n", BACKEND_NAME ); + + mImpl = new FileWatcherGeneric( this ); + } +} + +FileWatcher::FileWatcher( bool useGenericFileWatcher ) : + mFollowSymlinks( false ), mOutOfScopeLinks( false ) { + if ( useGenericFileWatcher ) { + efDEBUG( "Using backend: Generic\n" ); + + mImpl = new FileWatcherGeneric( this ); + } else { + efDEBUG( "Using backend: %s\n", BACKEND_NAME ); + + mImpl = new FILEWATCHER_IMPL( this ); + + if ( !mImpl->initOK() ) { + efSAFE_DELETE( mImpl ); + + efDEBUG( "Falled back to backend: %s\n", BACKEND_NAME ); + + mImpl = new FileWatcherGeneric( this ); + } + } +} + +FileWatcher::~FileWatcher() { + efSAFE_DELETE( mImpl ); +} + +WatchID FileWatcher::addWatch( const std::string& directory, FileWatchListener* watcher ) { + return addWatch( directory, watcher, false, {} ); +} + +WatchID FileWatcher::addWatch( const std::string& directory, FileWatchListener* watcher, + bool recursive ) { + return addWatch( directory, watcher, recursive, {} ); +} + +WatchID FileWatcher::addWatch( const std::string& directory, FileWatchListener* watcher, + bool recursive, const std::vector& options ) { + if ( mImpl->mIsGeneric || !FileSystem::isRemoteFS( directory ) ) { + return mImpl->addWatch( directory, watcher, recursive, options ); + } else { + return Errors::Log::createLastError( Errors::FileRemote, directory ); + } +} + +void FileWatcher::removeWatch( const std::string& directory ) { + mImpl->removeWatch( directory ); +} + +void FileWatcher::removeWatch( WatchID watchid ) { + mImpl->removeWatch( watchid ); +} + +void FileWatcher::watch() { + mImpl->watch(); +} + +std::vector FileWatcher::directories() { + return mImpl->directories(); +} + +void FileWatcher::followSymlinks( bool follow ) { + mFollowSymlinks = follow; +} + +const bool& FileWatcher::followSymlinks() const { + return mFollowSymlinks; +} + +void FileWatcher::allowOutOfScopeLinks( bool allow ) { + mOutOfScopeLinks = allow; +} + +const bool& FileWatcher::allowOutOfScopeLinks() const { + return mOutOfScopeLinks; +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/FileWatcherCWrapper.cpp b/vendor/efsw/src/efsw/FileWatcherCWrapper.cpp new file mode 100644 index 0000000..860d7d5 --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherCWrapper.cpp @@ -0,0 +1,131 @@ +#include +#include +#include + +#define TOBOOL( i ) ( ( i ) == 0 ? false : true ) + +/*************************************************************************************************/ +class Watcher_CAPI : public efsw::FileWatchListener { + public: + efsw_watcher mWatcher; + efsw_pfn_fileaction_callback mFn; + void* mParam; + + public: + Watcher_CAPI( efsw_watcher watcher, efsw_pfn_fileaction_callback fn, void* param ) : + mWatcher( watcher ), mFn( fn ), mParam( param ) {} + + void handleFileAction( efsw::WatchID watchid, const std::string& dir, + const std::string& filename, efsw::Action action, + std::string oldFilename = "" ) { + mFn( mWatcher, watchid, dir.c_str(), filename.c_str(), (enum efsw_action)action, + oldFilename.c_str(), mParam ); + } +}; + +/************************************************************************************************* + * globals + */ +static std::vector g_callbacks; + +Watcher_CAPI* find_callback( efsw_watcher watcher, efsw_pfn_fileaction_callback fn ) { + for ( std::vector::iterator i = g_callbacks.begin(); i != g_callbacks.end(); + ++i ) { + Watcher_CAPI* callback = *i; + + if ( callback->mFn == fn && callback->mWatcher == watcher ) + return *i; + } + + return NULL; +} + +Watcher_CAPI* remove_callback( efsw_watcher watcher ) { + std::vector::iterator i = g_callbacks.begin(); + + while ( i != g_callbacks.end() ) { + Watcher_CAPI* callback = *i; + + if ( callback->mWatcher == watcher ) + i = g_callbacks.erase( i ); + else + ++i; + } + + return NULL; +} + +/*************************************************************************************************/ +efsw_watcher efsw_create( int generic_mode ) { + return ( efsw_watcher ) new efsw::FileWatcher( TOBOOL( generic_mode ) ); +} + +void efsw_release( efsw_watcher watcher ) { + remove_callback( watcher ); + delete (efsw::FileWatcher*)watcher; +} + +const char* efsw_getlasterror() { + static std::string log_str; + log_str = efsw::Errors::Log::getLastErrorLog(); + return log_str.c_str(); +} + +EFSW_API void efsw_clearlasterror() { + efsw::Errors::Log::clearLastError(); +} + +efsw_watchid efsw_addwatch( efsw_watcher watcher, const char* directory, + efsw_pfn_fileaction_callback callback_fn, int recursive, void* param ) { + return efsw_addwatch_withoptions( watcher, directory, callback_fn, recursive, 0, 0, param ); +} + +efsw_watchid efsw_addwatch_withoptions(efsw_watcher watcher, const char* directory, + efsw_pfn_fileaction_callback callback_fn, int recursive, + efsw_watcher_option *options, int options_number, + void* param) { + Watcher_CAPI* callback = find_callback( watcher, callback_fn ); + + if ( callback == NULL ) { + callback = new Watcher_CAPI( watcher, callback_fn, param ); + g_callbacks.push_back( callback ); + } + + std::vector watcher_options{}; + for ( int i = 0; i < options_number; i++ ) { + efsw_watcher_option* option = &options[i]; + watcher_options.emplace_back( efsw::WatcherOption{ + static_cast(option->option), option->value } ); + } + + return ( (efsw::FileWatcher*)watcher ) + ->addWatch( std::string( directory ), callback, TOBOOL( recursive ), watcher_options ); +} + +void efsw_removewatch( efsw_watcher watcher, const char* directory ) { + ( (efsw::FileWatcher*)watcher )->removeWatch( std::string( directory ) ); +} + +void efsw_removewatch_byid( efsw_watcher watcher, efsw_watchid watchid ) { + ( (efsw::FileWatcher*)watcher )->removeWatch( watchid ); +} + +void efsw_watch( efsw_watcher watcher ) { + ( (efsw::FileWatcher*)watcher )->watch(); +} + +void efsw_follow_symlinks( efsw_watcher watcher, int enable ) { + ( (efsw::FileWatcher*)watcher )->followSymlinks( TOBOOL( enable ) ); +} + +int efsw_follow_symlinks_isenabled( efsw_watcher watcher ) { + return (int)( (efsw::FileWatcher*)watcher )->followSymlinks(); +} + +void efsw_allow_outofscopelinks( efsw_watcher watcher, int allow ) { + ( (efsw::FileWatcher*)watcher )->allowOutOfScopeLinks( TOBOOL( allow ) ); +} + +int efsw_outofscopelinks_isallowed( efsw_watcher watcher ) { + return (int)( (efsw::FileWatcher*)watcher )->allowOutOfScopeLinks(); +} diff --git a/vendor/efsw/src/efsw/FileWatcherFSEvents.cpp b/vendor/efsw/src/efsw/FileWatcherFSEvents.cpp new file mode 100644 index 0000000..6ea960d --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherFSEvents.cpp @@ -0,0 +1,245 @@ +#include +#include +#include +#include +#include +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_FSEVENTS + +#include + +namespace efsw { + +int getOSXReleaseNumber() { + static int osxR = -1; + + if ( -1 == osxR ) { + struct utsname os; + + if ( -1 != uname( &os ) ) { + std::string release( os.release ); + + size_t pos = release.find_first_of( '.' ); + + if ( pos != std::string::npos ) { + release = release.substr( 0, pos ); + } + + int rel = 0; + + if ( String::fromString( rel, release ) ) { + osxR = rel; + } + } + } + + return osxR; +} + +bool FileWatcherFSEvents::isGranular() { + return getOSXReleaseNumber() >= 11; +} + +static std::string convertCFStringToStdString( CFStringRef cfString ) { + // Try to get the C string pointer directly + const char* cStr = CFStringGetCStringPtr( cfString, kCFStringEncodingUTF8 ); + + if ( cStr ) { + // If the pointer is valid, directly return a std::string from it + return std::string( cStr ); + } else { + // If not, manually convert it + CFIndex length = CFStringGetLength( cfString ); + CFIndex maxSize = CFStringGetMaximumSizeForEncoding( length, kCFStringEncodingUTF8 ) + + 1; // +1 for null terminator + + char* buffer = new char[maxSize]; + + if ( CFStringGetCString( cfString, buffer, maxSize, kCFStringEncodingUTF8 ) ) { + std::string result( buffer ); + delete[] buffer; + return result; + } else { + delete[] buffer; + return ""; + } + } +} + +void FileWatcherFSEvents::FSEventCallback( ConstFSEventStreamRef streamRef, void* userData, + size_t numEvents, void* eventPaths, + const FSEventStreamEventFlags eventFlags[], + const FSEventStreamEventId eventIds[] ) { + WatcherFSEvents* watcher = static_cast( userData ); + + std::vector events; + events.reserve( numEvents ); + + for ( size_t i = 0; i < numEvents; i++ ) { + if ( isGranular() ) { + CFDictionaryRef pathInfoDict = + static_cast( CFArrayGetValueAtIndex( (CFArrayRef)eventPaths, i ) ); + CFStringRef path = static_cast( + CFDictionaryGetValue( pathInfoDict, kFSEventStreamEventExtendedDataPathKey ) ); + CFNumberRef cfInode = static_cast( + CFDictionaryGetValue( pathInfoDict, kFSEventStreamEventExtendedFileIDKey ) ); + + if ( cfInode ) { + unsigned long inode = 0; + CFNumberGetValue( cfInode, kCFNumberLongType, &inode ); + events.push_back( FSEvent( convertCFStringToStdString( path ), (long)eventFlags[i], + (Uint64)eventIds[i], inode ) ); + } + } else { + events.push_back( FSEvent( std::string( ( (char**)eventPaths )[i] ), + (long)eventFlags[i], (Uint64)eventIds[i] ) ); + } + } + + watcher->handleActions( events ); + + watcher->process(); + + efDEBUG( "\n" ); +} + +FileWatcherFSEvents::FileWatcherFSEvents( FileWatcher* parent ) : + FileWatcherImpl( parent ), mLastWatchID( 0 ) { + mInitOK = true; + + watch(); +} + +FileWatcherFSEvents::~FileWatcherFSEvents() { + mInitOK = false; + + mWatchCond.notify_all(); + + WatchMap::iterator iter = mWatches.begin(); + + for ( ; iter != mWatches.end(); ++iter ) { + WatcherFSEvents* watch = iter->second; + + efSAFE_DELETE( watch ); + } +} + +WatchID FileWatcherFSEvents::addWatch( const std::string& directory, FileWatchListener* watcher, + bool recursive, const std::vector &options ) { + std::string dir( directory ); + + FileInfo fi( dir ); + + if ( !fi.isDirectory() ) { + return Errors::Log::createLastError( Errors::FileNotFound, dir ); + } else if ( !fi.isReadable() ) { + return Errors::Log::createLastError( Errors::FileNotReadable, dir ); + } + + FileSystem::dirAddSlashAtEnd( dir ); + + if ( pathInWatches( dir ) ) { + return Errors::Log::createLastError( Errors::FileRepeated, directory ); + } + + /// Check if the directory is a symbolic link + std::string curPath; + std::string link( FileSystem::getLinkRealPath( dir, curPath ) ); + + if ( "" != link ) { + /// If it's a symlink check if the realpath exists as a watcher, or + /// if the path is outside the current dir + if ( pathInWatches( link ) ) { + return Errors::Log::createLastError( Errors::FileRepeated, directory ); + } else if ( !linkAllowed( curPath, link ) ) { + return Errors::Log::createLastError( Errors::FileOutOfScope, dir ); + } else { + dir = link; + } + } + + mLastWatchID++; + + WatcherFSEvents* pWatch = new WatcherFSEvents(); + pWatch->Listener = watcher; + pWatch->ID = mLastWatchID; + pWatch->Directory = dir; + pWatch->Recursive = recursive; + pWatch->FWatcher = this; + + pWatch->init(); + + { + Lock lock( mWatchesLock ); + mWatches.insert( std::make_pair( mLastWatchID, pWatch ) ); + } + + mWatchCond.notify_all(); + return pWatch->ID; +} + +void FileWatcherFSEvents::removeWatch( const std::string& directory ) { + Lock lock( mWatchesLock ); + + WatchMap::iterator iter = mWatches.begin(); + + for ( ; iter != mWatches.end(); ++iter ) { + if ( directory == iter->second->Directory ) { + removeWatch( iter->second->ID ); + return; + } + } +} + +void FileWatcherFSEvents::removeWatch( WatchID watchid ) { + Lock lock( mWatchesLock ); + + WatchMap::iterator iter = mWatches.find( watchid ); + + if ( iter == mWatches.end() ) + return; + + WatcherFSEvents* watch = iter->second; + + mWatches.erase( iter ); + + efDEBUG( "Removed watch %s\n", watch->Directory.c_str() ); + + efSAFE_DELETE( watch ); +} + +void FileWatcherFSEvents::watch() {} + +void FileWatcherFSEvents::handleAction( Watcher* watch, const std::string& filename, + unsigned long action, std::string oldFilename ) { + /// Not used +} + +std::vector FileWatcherFSEvents::directories() { + std::vector dirs; + + Lock lock( mWatchesLock ); + + dirs.reserve( mWatches.size() ); + + for ( WatchMap::iterator it = mWatches.begin(); it != mWatches.end(); ++it ) { + dirs.push_back( std::string( it->second->Directory ) ); + } + + return dirs; +} + +bool FileWatcherFSEvents::pathInWatches( const std::string& path ) { + for ( WatchMap::iterator it = mWatches.begin(); it != mWatches.end(); ++it ) { + if ( it->second->Directory == path ) { + return true; + } + } + + return false; +} + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/FileWatcherFSEvents.hpp b/vendor/efsw/src/efsw/FileWatcherFSEvents.hpp new file mode 100644 index 0000000..2a192a5 --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherFSEvents.hpp @@ -0,0 +1,103 @@ +#ifndef EFSW_FILEWATCHERFSEVENTS_HPP +#define EFSW_FILEWATCHERFSEVENTS_HPP + +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_FSEVENTS + +#include +#include +#include +#include +#include +#include +#include +#include + +namespace efsw { + +/* OSX < 10.7 has no file events */ +/* So i declare the events constants */ +enum FSEventEvents { + efswFSEventStreamCreateFlagUseCFTypes = 0x00000001, + efswFSEventStreamCreateFlagNoDefer = 0x00000002, + efswFSEventStreamCreateFlagFileEvents = 0x00000010, + efswFSEventStreamCreateFlagUseExtendedData = 0x00000040, + efswFSEventStreamEventFlagItemCreated = 0x00000100, + efswFSEventStreamEventFlagItemRemoved = 0x00000200, + efswFSEventStreamEventFlagItemInodeMetaMod = 0x00000400, + efswFSEventStreamEventFlagItemRenamed = 0x00000800, + efswFSEventStreamEventFlagItemModified = 0x00001000, + efswFSEventStreamEventFlagItemFinderInfoMod = 0x00002000, + efswFSEventStreamEventFlagItemChangeOwner = 0x00004000, + efswFSEventStreamEventFlagItemXattrMod = 0x00008000, + efswFSEventStreamEventFlagItemIsFile = 0x00010000, + efswFSEventStreamEventFlagItemIsDir = 0x00020000, + efswFSEventStreamEventFlagItemIsSymlink = 0x00040000, + efswFSEventsModified = efswFSEventStreamEventFlagItemFinderInfoMod | + efswFSEventStreamEventFlagItemModified | + efswFSEventStreamEventFlagItemInodeMetaMod +}; + +/// Implementation for Win32 based on ReadDirectoryChangesW. +/// @class FileWatcherFSEvents +class FileWatcherFSEvents : public FileWatcherImpl { + friend class WatcherFSEvents; + + public: + /// @return If FSEvents supports file-level notifications ( true if OS X >= 10.7 ) + static bool isGranular(); + + /// type for a map from WatchID to WatcherWin32 pointer + typedef std::map WatchMap; + + FileWatcherFSEvents( FileWatcher* parent ); + + virtual ~FileWatcherFSEvents(); + + /// Add a directory watch + /// On error returns WatchID with Error type. + WatchID addWatch( const std::string& directory, FileWatchListener* watcher, bool recursive, + const std::vector &options ) override; + + /// Remove a directory watch. This is a brute force lazy search O(nlogn). + void removeWatch( const std::string& directory ) override; + + /// Remove a directory watch. This is a map lookup O(logn). + void removeWatch( WatchID watchid ) override; + + /// Updates the watcher. Must be called often. + void watch() override; + + /// Handles the action + void handleAction( Watcher* watch, const std::string& filename, unsigned long action, + std::string oldFilename = "" ) override; + + /// @return Returns a list of the directories that are being watched + std::vector directories() override; + + protected: + static void FSEventCallback( ConstFSEventStreamRef streamRef, void* userData, size_t numEvents, + void* eventPaths, const FSEventStreamEventFlags eventFlags[], + const FSEventStreamEventId eventIds[] ); + + /// Vector of WatcherWin32 pointers + WatchMap mWatches; + + /// The last watchid + WatchID mLastWatchID; + + Mutex mWatchesLock; + + bool pathInWatches( const std::string& path ) override; + + std::mutex mWatchesMutex; + std::condition_variable mWatchCond; + +}; + +} // namespace efsw + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/FileWatcherGeneric.cpp b/vendor/efsw/src/efsw/FileWatcherGeneric.cpp new file mode 100644 index 0000000..3f3c52e --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherGeneric.cpp @@ -0,0 +1,158 @@ +#include +#include +#include +#include + +namespace efsw { + +FileWatcherGeneric::FileWatcherGeneric( FileWatcher* parent ) : + FileWatcherImpl( parent ), mThread( NULL ), mLastWatchID( 0 ) { + mInitOK = true; + mIsGeneric = true; +} + +FileWatcherGeneric::~FileWatcherGeneric() { + mInitOK = false; + + efSAFE_DELETE( mThread ); + + /// Delete the watches + WatchList::iterator it = mWatches.begin(); + + for ( ; it != mWatches.end(); ++it ) { + efSAFE_DELETE( ( *it ) ); + } +} + +WatchID FileWatcherGeneric::addWatch( const std::string& directory, FileWatchListener* watcher, + bool recursive, const std::vector& options ) { + std::string dir( directory ); + + FileSystem::dirAddSlashAtEnd( dir ); + + FileInfo fi( dir ); + + if ( !fi.isDirectory() ) { + return Errors::Log::createLastError( Errors::FileNotFound, dir ); + } else if ( !fi.isReadable() ) { + return Errors::Log::createLastError( Errors::FileNotReadable, dir ); + } else if ( pathInWatches( dir ) ) { + return Errors::Log::createLastError( Errors::FileRepeated, dir ); + } + + std::string curPath; + std::string link( FileSystem::getLinkRealPath( dir, curPath ) ); + + if ( "" != link ) { + if ( pathInWatches( link ) ) { + return Errors::Log::createLastError( Errors::FileRepeated, dir ); + } else if ( !linkAllowed( curPath, link ) ) { + return Errors::Log::createLastError( Errors::FileOutOfScope, dir ); + } else { + dir = link; + } + } + + mLastWatchID++; + + WatcherGeneric* pWatch = new WatcherGeneric( mLastWatchID, dir, watcher, this, recursive ); + + Lock lock( mWatchesLock ); + mWatches.push_back( pWatch ); + + return pWatch->ID; +} + +void FileWatcherGeneric::removeWatch( const std::string& directory ) { + WatchList::iterator it = mWatches.begin(); + + for ( ; it != mWatches.end(); ++it ) { + if ( ( *it )->Directory == directory ) { + WatcherGeneric* watch = ( *it ); + + Lock lock( mWatchesLock ); + + mWatches.erase( it ); + + efSAFE_DELETE( watch ); + + return; + } + } +} + +void FileWatcherGeneric::removeWatch( WatchID watchid ) { + WatchList::iterator it = mWatches.begin(); + + for ( ; it != mWatches.end(); ++it ) { + if ( ( *it )->ID == watchid ) { + WatcherGeneric* watch = ( *it ); + + Lock lock( mWatchesLock ); + + mWatches.erase( it ); + + efSAFE_DELETE( watch ); + + return; + } + } +} + +void FileWatcherGeneric::watch() { + if ( NULL == mThread ) { + mThread = new Thread( &FileWatcherGeneric::run, this ); + mThread->launch(); + } +} + +void FileWatcherGeneric::run() { + do { + { + Lock lock( mWatchesLock ); + + WatchList::iterator it = mWatches.begin(); + + for ( ; it != mWatches.end(); ++it ) { + ( *it )->watch(); + } + } + + if ( mInitOK ) + System::sleep( 1000 ); + } while ( mInitOK ); +} + +void FileWatcherGeneric::handleAction( Watcher*, const std::string&, unsigned long, std::string ) { + /// Not used +} + +std::vector FileWatcherGeneric::directories() { + std::vector dirs; + + Lock lock( mWatchesLock ); + + dirs.reserve( mWatches.size() ); + + WatchList::iterator it = mWatches.begin(); + + for ( ; it != mWatches.end(); ++it ) { + dirs.push_back( ( *it )->Directory ); + } + + return dirs; +} + +bool FileWatcherGeneric::pathInWatches( const std::string& path ) { + WatchList::iterator it = mWatches.begin(); + + for ( ; it != mWatches.end(); ++it ) { + if ( ( *it )->Directory == path || ( *it )->pathInWatches( path ) ) { + return true; + } + } + + return false; +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/FileWatcherGeneric.hpp b/vendor/efsw/src/efsw/FileWatcherGeneric.hpp new file mode 100644 index 0000000..47f7e04 --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherGeneric.hpp @@ -0,0 +1,61 @@ +#ifndef EFSW_FILEWATCHERGENERIC_HPP +#define EFSW_FILEWATCHERGENERIC_HPP + +#include +#include +#include +#include + +namespace efsw { + +/// Implementation for Generic File Watcher. +/// @class FileWatcherGeneric +class FileWatcherGeneric : public FileWatcherImpl { + public: + typedef std::vector WatchList; + + FileWatcherGeneric( FileWatcher* parent ); + + virtual ~FileWatcherGeneric(); + + /// Add a directory watch + /// On error returns WatchID with Error type. + WatchID addWatch( const std::string& directory, FileWatchListener* watcher, bool recursive, + const std::vector &options ) override; + + /// Remove a directory watch. This is a brute force lazy search O(nlogn). + void removeWatch( const std::string& directory ) override; + + /// Remove a directory watch. This is a map lookup O(logn). + void removeWatch( WatchID watchid ) override; + + /// Updates the watcher. Must be called often. + void watch() override; + + /// Handles the action + void handleAction( Watcher* watch, const std::string& filename, unsigned long action, + std::string oldFilename = "" ) override; + + /// @return Returns a list of the directories that are being watched + std::vector directories() override; + + protected: + Thread* mThread; + + /// The last watchid + WatchID mLastWatchID; + + /// Map of WatchID to WatchStruct pointers + WatchList mWatches; + + Mutex mWatchesLock; + + bool pathInWatches( const std::string& path ) override; + + private: + void run(); +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/FileWatcherImpl.cpp b/vendor/efsw/src/efsw/FileWatcherImpl.cpp new file mode 100644 index 0000000..bf69a45 --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherImpl.cpp @@ -0,0 +1,34 @@ +#include +#include +#include + +namespace efsw { + +FileWatcherImpl::FileWatcherImpl( FileWatcher* parent ) : + mFileWatcher( parent ), mInitOK( false ), mIsGeneric( false ) { + System::maxFD(); +} + +FileWatcherImpl::~FileWatcherImpl() {} + +bool FileWatcherImpl::initOK() { + return static_cast( mInitOK ); +} + +bool FileWatcherImpl::linkAllowed( const std::string& curPath, const std::string& link ) { + return ( mFileWatcher->followSymlinks() && mFileWatcher->allowOutOfScopeLinks() ) || + -1 != String::strStartsWith( curPath, link ); +} + +int FileWatcherImpl::getOptionValue( const std::vector& options, Option option, + int defaultValue ) { + for ( size_t i = 0; i < options.size(); i++ ) { + if ( options[i].mOption == option ) { + return options[i].mValue; + } + } + + return defaultValue; +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/FileWatcherImpl.hpp b/vendor/efsw/src/efsw/FileWatcherImpl.hpp new file mode 100644 index 0000000..a6ec472 --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherImpl.hpp @@ -0,0 +1,64 @@ +#ifndef EFSW_FILEWATCHERIMPL_HPP +#define EFSW_FILEWATCHERIMPL_HPP + +#include +#include +#include +#include +#include +#include + +namespace efsw { + +class FileWatcherImpl { + public: + FileWatcherImpl( FileWatcher* parent ); + + virtual ~FileWatcherImpl(); + + /// Add a directory watch + /// On error returns WatchID with Error type. + virtual WatchID addWatch( const std::string& directory, FileWatchListener* watcher, + bool recursive, const std::vector& options = {} ) = 0; + + /// Remove a directory watch. This is a brute force lazy search O(nlogn). + virtual void removeWatch( const std::string& directory ) = 0; + + /// Remove a directory watch. This is a map lookup O(logn). + virtual void removeWatch( WatchID watchid ) = 0; + + /// Updates the watcher. Must be called often. + virtual void watch() = 0; + + /// Handles the action + virtual void handleAction( Watcher* watch, const std::string& filename, unsigned long action, + std::string oldFilename = "" ) = 0; + + /// @return Returns a list of the directories that are being watched + virtual std::vector directories() = 0; + + /// @return true if the backend init successfully + virtual bool initOK(); + + /// @return If the link is allowed according to the current path and the state of out scope + /// links + virtual bool linkAllowed( const std::string& curPath, const std::string& link ); + + /// Search if a directory already exists in the watches + virtual bool pathInWatches( const std::string& path ) = 0; + + protected: + friend class FileWatcher; + friend class DirWatcherGeneric; + + FileWatcher* mFileWatcher; + Atomic mInitOK; + bool mIsGeneric; + + int getOptionValue( const std::vector& options, Option option, + int defaultValue ); +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/FileWatcherInotify.cpp b/vendor/efsw/src/efsw/FileWatcherInotify.cpp new file mode 100644 index 0000000..29be12b --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherInotify.cpp @@ -0,0 +1,562 @@ +#include +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_INOTIFY + +#include +#include +#include +#include +#include +#include + +#ifdef EFSW_INOTIFY_NOSYS +#include +#else +#include +#endif + +#include +#include +#include +#include +#include + +#define BUFF_SIZE ( ( sizeof( struct inotify_event ) + FILENAME_MAX ) * 1024 ) + +namespace efsw { + +FileWatcherInotify::FileWatcherInotify( FileWatcher* parent ) : + FileWatcherImpl( parent ), mFD( -1 ), mThread( NULL ), mIsTakingAction( false ) { + mFD = inotify_init(); + + if ( mFD < 0 ) { + efDEBUG( "Error: %s\n", strerror( errno ) ); + } else { + mInitOK = true; + } +} + +FileWatcherInotify::~FileWatcherInotify() { + mInitOK = false; + // There is deadlock when release FileWatcherInotify instance since its handAction + // function is still running and hangs in requiring lock without init lock captured. + while ( mIsTakingAction ) { + // It'd use condition-wait instead of sleep. Actually efsw has no such + // implementation so we just skip and sleep while for that to avoid deadlock. + usleep( 1000 ); + }; + Lock initLock( mInitLock ); + + efSAFE_DELETE( mThread ); + + Lock l( mWatchesLock ); + Lock l2( mRealWatchesLock ); + + WatchMap::iterator iter = mWatches.begin(); + WatchMap::iterator end = mWatches.end(); + + for ( ; iter != end; ++iter ) { + efSAFE_DELETE( iter->second ); + } + + mWatches.clear(); + + if ( mFD != -1 ) { + close( mFD ); + mFD = -1; + } +} + +WatchID FileWatcherInotify::addWatch( const std::string& directory, FileWatchListener* watcher, + bool recursive, const std::vector& ) { + if ( !mInitOK ) + return Errors::Log::createLastError( Errors::Unspecified, directory ); + Lock initLock( mInitLock ); + return addWatch( directory, watcher, recursive, NULL ); +} + +WatchID FileWatcherInotify::addWatch( const std::string& directory, FileWatchListener* watcher, + bool recursive, WatcherInotify* parent ) { + std::string dir( directory ); + + FileSystem::dirAddSlashAtEnd( dir ); + + FileInfo fi( dir ); + + if ( !fi.isDirectory() ) { + return Errors::Log::createLastError( Errors::FileNotFound, dir ); + } else if ( !fi.isReadable() ) { + return Errors::Log::createLastError( Errors::FileNotReadable, dir ); + } else if ( pathInWatches( dir ) ) { + return Errors::Log::createLastError( Errors::FileRepeated, directory ); + } else if ( NULL != parent && FileSystem::isRemoteFS( dir ) ) { + return Errors::Log::createLastError( Errors::FileRemote, dir ); + } + + /// Check if the directory is a symbolic link + std::string curPath; + std::string link( FileSystem::getLinkRealPath( dir, curPath ) ); + + if ( "" != link ) { + /// Avoid adding symlinks directories if it's now enabled + if ( NULL != parent && !mFileWatcher->followSymlinks() ) { + return Errors::Log::createLastError( Errors::FileOutOfScope, dir ); + } + + /// If it's a symlink check if the realpath exists as a watcher, or + /// if the path is outside the current dir + if ( pathInWatches( link ) ) { + return Errors::Log::createLastError( Errors::FileRepeated, directory ); + } else if ( !linkAllowed( curPath, link ) ) { + return Errors::Log::createLastError( Errors::FileOutOfScope, dir ); + } else { + dir = link; + } + } + + int wd = inotify_add_watch( mFD, dir.c_str(), + IN_CLOSE_WRITE | IN_MOVED_TO | IN_CREATE | IN_MOVED_FROM | + IN_DELETE | IN_MODIFY ); + + if ( wd < 0 ) { + if ( errno == ENOENT ) { + return Errors::Log::createLastError( Errors::FileNotFound, dir ); + } else { + return Errors::Log::createLastError( Errors::Unspecified, + std::string( strerror( errno ) ) ); + } + } + + efDEBUG( "Added watch %s with id: %d\n", dir.c_str(), wd ); + + WatcherInotify* pWatch = new WatcherInotify(); + pWatch->Listener = watcher; + pWatch->ID = parent ? parent->ID : wd; + pWatch->InotifyID = wd; + pWatch->Directory = dir; + pWatch->Recursive = recursive; + pWatch->Parent = parent; + + { + Lock lock( mWatchesLock ); + mWatches.insert( std::make_pair( wd, pWatch ) ); + mWatchesRef[pWatch->Directory] = wd; + } + + if ( NULL == pWatch->Parent ) { + Lock l( mRealWatchesLock ); + mRealWatches[pWatch->InotifyID] = pWatch; + } + + if ( pWatch->Recursive ) { + std::map files = FileSystem::filesInfoFromPath( pWatch->Directory ); + std::map::iterator it = files.begin(); + + for ( ; it != files.end(); ++it ) { + if ( !mInitOK ) + break; + + const FileInfo& cfi = it->second; + + if ( cfi.isDirectory() && cfi.isReadable() ) { + addWatch( cfi.Filepath, watcher, recursive, pWatch ); + } + } + } + + return wd; +} + +void FileWatcherInotify::removeWatchLocked( WatchID watchid ) { + WatchMap::iterator iter = mWatches.find( watchid ); + if ( iter == mWatches.end() ) + return; + + WatcherInotify* watch = iter->second; + + for ( std::vector>::iterator itm = + mMovedOutsideWatches.begin(); + mMovedOutsideWatches.end() != itm; ++itm ) { + if ( itm->first == watch ) { + mMovedOutsideWatches.erase( itm ); + break; + } + } + + if ( watch->Recursive && NULL == watch->Parent ) { + WatchMap::iterator it = mWatches.begin(); + std::vector eraseWatches; + + for ( ; it != mWatches.end(); ++it ) + if ( it->second != watch && it->second->inParentTree( watch ) ) + eraseWatches.push_back( it->second->InotifyID ); + + for ( std::vector::iterator eit = eraseWatches.begin(); eit != eraseWatches.end(); + ++eit ) { + removeWatch( *eit ); + } + } + + mWatchesRef.erase( watch->Directory ); + mWatches.erase( iter ); + + if ( NULL == watch->Parent ) { + WatchMap::iterator eraseit = mRealWatches.find( watch->InotifyID ); + + if ( eraseit != mRealWatches.end() ) { + mRealWatches.erase( eraseit ); + } + } + + int err = inotify_rm_watch( mFD, watchid ); + + if ( err < 0 ) { + efDEBUG( "Error removing watch %d: %s\n", watchid, strerror( errno ) ); + } else { + efDEBUG( "Removed watch %s with id: %d\n", watch->Directory.c_str(), watchid ); + } + + efSAFE_DELETE( watch ); +} + +void FileWatcherInotify::removeWatch( const std::string& directory ) { + if ( !mInitOK ) + return; + Lock initLock( mInitLock ); + Lock lock( mWatchesLock ); + Lock l( mRealWatchesLock ); + + std::unordered_map::iterator ref = mWatchesRef.find( directory ); + if ( ref == mWatchesRef.end() ) + return; + + removeWatchLocked( ref->second ); +} + +void FileWatcherInotify::removeWatch( WatchID watchid ) { + if ( !mInitOK ) + return; + Lock initLock( mInitLock ); + Lock lock( mWatchesLock ); + removeWatchLocked( watchid ); +} + +void FileWatcherInotify::watch() { + if ( NULL == mThread ) { + mThread = new Thread( &FileWatcherInotify::run, this ); + mThread->launch(); + } +} + +Watcher* FileWatcherInotify::watcherContainsDirectory( std::string dir ) { + FileSystem::dirRemoveSlashAtEnd( dir ); + std::string watcherPath = FileSystem::pathRemoveFileName( dir ); + FileSystem::dirAddSlashAtEnd( watcherPath ); + Lock lock( mWatchesLock ); + + for ( WatchMap::iterator it = mWatches.begin(); it != mWatches.end(); ++it ) { + Watcher* watcher = it->second; + if ( watcher->Directory == watcherPath ) + return watcher; + } + + return NULL; +} + +void FileWatcherInotify::run() { + char* buff = new char[BUFF_SIZE]; + memset( buff, 0, BUFF_SIZE ); + WatchMap::iterator wit; + + WatcherInotify* currentMoveFrom = NULL; + u_int32_t currentMoveCookie = -1; + bool lastWasMovedFrom = false; + std::string prevOldFileName; + + do { + fd_set rfds; + FD_ZERO( &rfds ); + FD_SET( mFD, &rfds ); + timeval timeout; + timeout.tv_sec = 0; + timeout.tv_usec = 100000; + + if ( select( FD_SETSIZE, &rfds, NULL, NULL, &timeout ) > 0 ) { + ssize_t len; + + len = read( mFD, buff, BUFF_SIZE ); + + if ( len != -1 ) { + ssize_t i = 0; + + while ( i < len ) { + struct inotify_event* pevent = (struct inotify_event*)&buff[i]; + + { + { + Lock lock( mWatchesLock ); + + wit = mWatches.find( pevent->wd ); + } + + if ( wit != mWatches.end() ) { + handleAction( wit->second, (char*)pevent->name, pevent->mask ); + + if ( ( pevent->mask & IN_MOVED_TO ) && wit->second == currentMoveFrom && + pevent->cookie == currentMoveCookie ) { + /// make pair success + currentMoveFrom = NULL; + currentMoveCookie = -1; + } else if ( pevent->mask & IN_MOVED_FROM ) { + // Previous event was moved from and current event is moved from + // Treat it as a DELETE or moved ouside watches + if ( lastWasMovedFrom && currentMoveFrom ) { + mMovedOutsideWatches.push_back( + std::make_pair( currentMoveFrom, prevOldFileName ) ); + } + + currentMoveFrom = wit->second; + currentMoveCookie = pevent->cookie; + } else { + /// Keep track of the IN_MOVED_FROM events to know + /// if the IN_MOVED_TO event is also fired + if ( currentMoveFrom ) { + mMovedOutsideWatches.push_back( + std::make_pair( currentMoveFrom, prevOldFileName ) ); + } + + currentMoveFrom = NULL; + currentMoveCookie = -1; + } + } + + lastWasMovedFrom = ( pevent->mask & IN_MOVED_FROM ) != 0; + if ( pevent->mask & IN_MOVED_FROM ) + prevOldFileName = std::string( (char*)pevent->name ); + } + + i += sizeof( struct inotify_event ) + pevent->len; + } + } + } else { + // Here means no event received + // If last event is IN_MOVED_FROM, we assume no IN_MOVED_TO + if ( currentMoveFrom ) { + mMovedOutsideWatches.push_back( + std::make_pair( currentMoveFrom, currentMoveFrom->OldFileName ) ); + } + + currentMoveFrom = NULL; + currentMoveCookie = -1; + } + + if ( !mMovedOutsideWatches.empty() ) { + // We need to make a copy since the element mMovedOutsideWatches could be modified + // during the iteration. + std::vector> movedOutsideWatches( + mMovedOutsideWatches ); + + /// In case that the IN_MOVED_TO is never fired means that the file was moved to other + /// folder + for ( std::vector>::iterator it = + movedOutsideWatches.begin(); + it != movedOutsideWatches.end(); ++it ) { + + // Skip if the watch has already being removed + if ( mMovedOutsideWatches.size() != movedOutsideWatches.size() ) { + bool found = false; + for ( std::vector>::iterator itm = + mMovedOutsideWatches.begin(); + mMovedOutsideWatches.end() != itm; ++itm ) { + if ( itm->first == it->first ) { + found = true; + break; + } + } + if ( !found ) + continue; + } + + Watcher* watch = ( *it ).first; + const std::string& oldFileName = ( *it ).second; + + /// Check if the file move was a folder already being watched + std::vector eraseWatches; + + { + Lock lock( mWatchesLock ); + + for ( ; wit != mWatches.end(); ++wit ) { + Watcher* oldWatch = wit->second; + + if ( oldWatch != watch && + -1 != String::strStartsWith( watch->Directory + oldFileName + "/", + oldWatch->Directory ) ) { + eraseWatches.push_back( oldWatch ); + } + } + } + + /// Remove invalid watches + std::stable_sort( eraseWatches.begin(), eraseWatches.end(), + []( const Watcher* left, const Watcher* right ) { + return left->Directory < right->Directory; + } ); + + if ( eraseWatches.empty() ) { + handleAction( watch, oldFileName, IN_DELETE ); + } else { + for ( std::vector::reverse_iterator eit = eraseWatches.rbegin(); + eit != eraseWatches.rend(); ++eit ) { + Watcher* rmWatch = *eit; + + /// Create Delete event for removed watches that have been moved too + if ( Watcher* cntWatch = watcherContainsDirectory( rmWatch->Directory ) ) { + handleAction( cntWatch, + FileSystem::fileNameFromPath( rmWatch->Directory ), + IN_DELETE ); + } + } + } + } + + mMovedOutsideWatches.clear(); + } + } while ( mInitOK ); + + delete[] buff; +} + +void FileWatcherInotify::checkForNewWatcher( Watcher* watch, std::string fpath ) { + FileSystem::dirAddSlashAtEnd( fpath ); + + /// If the watcher is recursive, checks if the new file is a folder, and creates a watcher + if ( watch->Recursive && FileSystem::isDirectory( fpath ) ) { + bool found = false; + + { + Lock lock( mWatchesLock ); + + /// First check if exists + for ( WatchMap::iterator it = mWatches.begin(); it != mWatches.end(); ++it ) { + if ( it->second->Directory == fpath ) { + found = true; + break; + } + } + } + + if ( !found ) { + addWatch( fpath, watch->Listener, watch->Recursive, + static_cast( watch ) ); + } + } +} + +void FileWatcherInotify::handleAction( Watcher* watch, const std::string& filename, + unsigned long action, std::string ) { + if ( !watch || !watch->Listener || !mInitOK ) { + return; + } + mIsTakingAction = true; + Lock initLock( mInitLock ); + + std::string fpath( watch->Directory + filename ); + + if ( ( IN_CLOSE_WRITE & action ) || ( IN_MODIFY & action ) ) { + watch->Listener->handleFileAction( watch->ID, watch->Directory, filename, + Actions::Modified ); + } else if ( IN_MOVED_TO & action ) { + /// If OldFileName doesn't exist means that the file has been moved from other folder, so we + /// just send the Add event + if ( watch->OldFileName.empty() ) { + watch->Listener->handleFileAction( watch->ID, watch->Directory, filename, + Actions::Add ); + + watch->Listener->handleFileAction( watch->ID, watch->Directory, filename, + Actions::Modified ); + + checkForNewWatcher( watch, fpath ); + } else { + watch->Listener->handleFileAction( watch->ID, watch->Directory, filename, + Actions::Moved, watch->OldFileName ); + } + + if ( watch->Recursive && FileSystem::isDirectory( fpath ) ) { + /// Update the new directory path + std::string opath( watch->Directory + watch->OldFileName ); + FileSystem::dirAddSlashAtEnd( opath ); + FileSystem::dirAddSlashAtEnd( fpath ); + + Lock lock( mWatchesLock ); + + for ( WatchMap::iterator it = mWatches.begin(); it != mWatches.end(); ++it ) { + if ( it->second->Directory == opath ) { + it->second->Directory = fpath; + it->second->DirInfo = FileInfo( fpath ); + } else if ( -1 != String::strStartsWith( opath, it->second->Directory ) ) { + it->second->Directory = fpath + it->second->Directory.substr( opath.size() ); + it->second->DirInfo.Filepath = it->second->Directory; + } + } + } + + watch->OldFileName = ""; + } else if ( IN_CREATE & action ) { + watch->Listener->handleFileAction( watch->ID, watch->Directory, filename, Actions::Add ); + + checkForNewWatcher( watch, fpath ); + } else if ( IN_MOVED_FROM & action ) { + watch->OldFileName = filename; + } else if ( IN_DELETE & action ) { + watch->Listener->handleFileAction( watch->ID, watch->Directory, filename, Actions::Delete ); + + FileSystem::dirAddSlashAtEnd( fpath ); + + /// If the file erased is a directory and recursive is enabled, removes the directory erased + if ( watch->Recursive ) { + Lock l( mWatchesLock ); + + for ( WatchMap::iterator it = mWatches.begin(); it != mWatches.end(); ++it ) { + if ( it->second->Directory == fpath ) { + removeWatchLocked( it->second->InotifyID ); + break; + } + } + } + } + mIsTakingAction = false; +} + +std::vector FileWatcherInotify::directories() { + std::vector dirs; + + Lock l( mRealWatchesLock ); + + dirs.reserve( mRealWatches.size() ); + + WatchMap::iterator it = mRealWatches.begin(); + + for ( ; it != mRealWatches.end(); ++it ) + dirs.push_back( it->second->Directory ); + + return dirs; +} + +bool FileWatcherInotify::pathInWatches( const std::string& path ) { + Lock l( mRealWatchesLock ); + + /// Search in the real watches, since it must allow adding a watch already watched as a subdir + WatchMap::iterator it = mRealWatches.begin(); + + for ( ; it != mRealWatches.end(); ++it ) + if ( it->second->Directory == path ) + return true; + + return false; +} + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/FileWatcherInotify.hpp b/vendor/efsw/src/efsw/FileWatcherInotify.hpp new file mode 100644 index 0000000..84174a0 --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherInotify.hpp @@ -0,0 +1,86 @@ +#ifndef EFSW_FILEWATCHERLINUX_HPP +#define EFSW_FILEWATCHERLINUX_HPP + +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_INOTIFY + +#include +#include +#include +#include + +namespace efsw { + +/// Implementation for Linux based on inotify. +/// @class FileWatcherInotify +class FileWatcherInotify : public FileWatcherImpl { + public: + /// type for a map from WatchID to WatchStruct pointer + typedef std::map WatchMap; + + FileWatcherInotify( FileWatcher* parent ); + + virtual ~FileWatcherInotify(); + + /// Add a directory watch + /// On error returns WatchID with Error type. + WatchID addWatch( const std::string& directory, FileWatchListener* watcher, bool recursive, + const std::vector& options ) override; + + /// Remove a directory watch. This is a brute force lazy search O(nlogn). + void removeWatch( const std::string& directory ) override; + + /// Remove a directory watch. This is a map lookup O(logn). + void removeWatch( WatchID watchid ) override; + + /// Updates the watcher. Must be called often. + void watch() override; + + /// Handles the action + void handleAction( Watcher* watch, const std::string& filename, unsigned long action, + std::string oldFilename = "" ) override; + + /// @return Returns a list of the directories that are being watched + std::vector directories() override; + + protected: + /// Map of WatchID to WatchStruct pointers + WatchMap mWatches; + + /// User added watches + WatchMap mRealWatches; + + std::unordered_map mWatchesRef; + + /// inotify file descriptor + int mFD; + + Thread* mThread; + + Mutex mWatchesLock; + Mutex mRealWatchesLock; + Mutex mInitLock; + bool mIsTakingAction; + std::vector> mMovedOutsideWatches; + + WatchID addWatch( const std::string& directory, FileWatchListener* watcher, bool recursive, + WatcherInotify* parent = NULL ); + + bool pathInWatches( const std::string& path ) override; + + private: + void run(); + + void removeWatchLocked( WatchID watchid ); + + void checkForNewWatcher( Watcher* watch, std::string fpath ); + + Watcher* watcherContainsDirectory( std::string dir ); +}; + +} // namespace efsw + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/FileWatcherKqueue.cpp b/vendor/efsw/src/efsw/FileWatcherKqueue.cpp new file mode 100644 index 0000000..32ef3dc --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherKqueue.cpp @@ -0,0 +1,229 @@ +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_KQUEUE || EFSW_PLATFORM == EFSW_PLATFORM_FSEVENTS + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +namespace efsw { + +FileWatcherKqueue::FileWatcherKqueue( FileWatcher* parent ) : + FileWatcherImpl( parent ), + mLastWatchID( 0 ), + mThread( NULL ), + mFileDescriptorCount( 1 ), + mAddingWatcher( false ) { + mTimeOut.tv_sec = 0; + mTimeOut.tv_nsec = 0; + mInitOK = true; +} + +FileWatcherKqueue::~FileWatcherKqueue() { + WatchMap::iterator iter = mWatches.begin(); + + for ( ; iter != mWatches.end(); ++iter ) { + efSAFE_DELETE( iter->second ); + } + + mWatches.clear(); + + mInitOK = false; + + efSAFE_DELETE( mThread ); +} + +WatchID FileWatcherKqueue::addWatch( const std::string& directory, FileWatchListener* watcher, + bool recursive, const std::vector& options ) { + static bool s_ug = false; + + std::string dir( directory ); + + FileSystem::dirAddSlashAtEnd( dir ); + + FileInfo fi( dir ); + + if ( !fi.isDirectory() ) { + return Errors::Log::createLastError( Errors::FileNotFound, dir ); + } else if ( !fi.isReadable() ) { + return Errors::Log::createLastError( Errors::FileNotReadable, dir ); + } else if ( pathInWatches( dir ) ) { + return Errors::Log::createLastError( Errors::FileRepeated, directory ); + } + + std::string curPath; + std::string link( FileSystem::getLinkRealPath( dir, curPath ) ); + + if ( "" != link ) { + if ( pathInWatches( link ) ) { + return Errors::Log::createLastError( Errors::FileRepeated, directory ); + } else if ( !linkAllowed( curPath, link ) ) { + return Errors::Log::createLastError( Errors::FileOutOfScope, dir ); + } else { + dir = link; + } + } + + /// Check first if are enough file descriptors available to create another kqueue watcher, + /// otherwise it creates a generic watcher + if ( availablesFD() ) { + mAddingWatcher = true; + + WatcherKqueue* watch = new WatcherKqueue( ++mLastWatchID, dir, watcher, recursive, this ); + + { + Lock lock( mWatchesLock ); + mWatches.insert( std::make_pair( mLastWatchID, watch ) ); + } + + watch->addAll(); + + // if failed to open the directory... erase the watcher + if ( !watch->initOK() ) { + int le = watch->lastErrno(); + + mWatches.erase( watch->ID ); + + efSAFE_DELETE( watch ); + + mLastWatchID--; + + // Probably the folder has too many files, create a generic watcher + if ( EACCES != le ) { + WatcherGeneric* genericWatch = + new WatcherGeneric( ++mLastWatchID, dir, watcher, this, recursive ); + + Lock lock( mWatchesLock ); + mWatches.insert( std::make_pair( mLastWatchID, genericWatch ) ); + } else { + return Errors::Log::createLastError( Errors::Unspecified, link ); + } + } + + mAddingWatcher = false; + } else { + if ( !s_ug ) { + efDEBUG( "Started using generic watcher, file descriptor limit reached: %ld\n", + mFileDescriptorCount ); + s_ug = true; + } + + WatcherGeneric* watch = new WatcherGeneric( ++mLastWatchID, dir, watcher, this, recursive ); + + Lock lock( mWatchesLock ); + mWatches.insert( std::make_pair( mLastWatchID, watch ) ); + } + + return mLastWatchID; +} + +void FileWatcherKqueue::removeWatch( const std::string& directory ) { + Lock lock( mWatchesLock ); + + WatchMap::iterator iter = mWatches.begin(); + + for ( ; iter != mWatches.end(); ++iter ) { + if ( directory == iter->second->Directory ) { + removeWatch( iter->first ); + return; + } + } +} + +void FileWatcherKqueue::removeWatch( WatchID watchid ) { + Lock lock( mWatchesLock ); + + WatchMap::iterator iter = mWatches.find( watchid ); + + if ( iter == mWatches.end() ) + return; + + Watcher* watch = iter->second; + + mWatches.erase( iter ); + + efSAFE_DELETE( watch ); +} + +bool FileWatcherKqueue::isAddingWatcher() const { + return mAddingWatcher; +} + +void FileWatcherKqueue::watch() { + if ( NULL == mThread ) { + mThread = new Thread( &FileWatcherKqueue::run, this ); + mThread->launch(); + } +} + +void FileWatcherKqueue::run() { + do { + { + Lock lock( mWatchesLock ); + + for ( WatchMap::iterator it = mWatches.begin(); it != mWatches.end(); ++it ) { + it->second->watch(); + } + } + + System::sleep( 500 ); + } while ( mInitOK ); +} + +void FileWatcherKqueue::handleAction( Watcher* watch, const std::string& filename, + unsigned long action, std::string oldFilename ) {} + +std::vector FileWatcherKqueue::directories() { + std::vector dirs; + + Lock lock( mWatchesLock ); + + dirs.reserve( mWatches.size() ); + + WatchMap::iterator it = mWatches.begin(); + + for ( ; it != mWatches.end(); ++it ) { + dirs.push_back( it->second->Directory ); + } + + return dirs; +} + +bool FileWatcherKqueue::pathInWatches( const std::string& path ) { + WatchMap::iterator it = mWatches.begin(); + + for ( ; it != mWatches.end(); ++it ) { + if ( it->second->Directory == path ) { + return true; + } + } + + return false; +} + +void FileWatcherKqueue::addFD() { + mFileDescriptorCount++; +} + +void FileWatcherKqueue::removeFD() { + mFileDescriptorCount--; +} + +bool FileWatcherKqueue::availablesFD() { + return mFileDescriptorCount <= (Int64)System::getMaxFD() - 500; +} + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/FileWatcherKqueue.hpp b/vendor/efsw/src/efsw/FileWatcherKqueue.hpp new file mode 100644 index 0000000..ff5327b --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherKqueue.hpp @@ -0,0 +1,81 @@ +#ifndef EFSW_FILEWATCHEROSX_HPP +#define EFSW_FILEWATCHEROSX_HPP + +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_KQUEUE || EFSW_PLATFORM == EFSW_PLATFORM_FSEVENTS + +#include + +namespace efsw { + +/// Implementation for OSX based on kqueue. +/// @class FileWatcherKqueue +class FileWatcherKqueue : public FileWatcherImpl { + friend class WatcherKqueue; + + public: + FileWatcherKqueue( FileWatcher* parent ); + + virtual ~FileWatcherKqueue(); + + /// Add a directory watch + /// On error returns WatchID with Error type. + WatchID addWatch( const std::string& directory, FileWatchListener* watcher, bool recursive, + const std::vector &options ) override; + + /// Remove a directory watch. This is a brute force lazy search O(nlogn). + void removeWatch( const std::string& directory ) override; + + /// Remove a directory watch. This is a map lookup O(logn). + void removeWatch( WatchID watchid ) override; + + /// Updates the watcher. Must be called often. + void watch() override; + + /// Handles the action + void handleAction( Watcher* watch, const std::string& filename, unsigned long action, + std::string oldFilename = "" ) override; + + /// @return Returns a list of the directories that are being watched + std::vector directories() override; + + protected: + /// Map of WatchID to WatchStruct pointers + WatchMap mWatches; + + /// time out data + struct timespec mTimeOut; + + /// WatchID allocator + int mLastWatchID; + + Thread* mThread; + + Mutex mWatchesLock; + + std::vector mRemoveList; + + long mFileDescriptorCount; + + bool mAddingWatcher; + + bool isAddingWatcher() const; + + bool pathInWatches( const std::string& path ) override; + + void addFD(); + + void removeFD(); + + bool availablesFD(); + + private: + void run(); +}; + +} // namespace efsw + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/FileWatcherWin32.cpp b/vendor/efsw/src/efsw/FileWatcherWin32.cpp new file mode 100644 index 0000000..19b71d7 --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherWin32.cpp @@ -0,0 +1,267 @@ +#include +#include +#include +#include +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + +namespace efsw { + +FileWatcherWin32::FileWatcherWin32( FileWatcher* parent ) : + FileWatcherImpl( parent ), mLastWatchID( 0 ), mThread( NULL ) { + mIOCP = CreateIoCompletionPort( INVALID_HANDLE_VALUE, NULL, 0, 1 ); + if ( mIOCP && mIOCP != INVALID_HANDLE_VALUE ) + mInitOK = true; +} + +FileWatcherWin32::~FileWatcherWin32() { + mInitOK = false; + + if ( mIOCP && mIOCP != INVALID_HANDLE_VALUE ) { + PostQueuedCompletionStatus( mIOCP, 0, reinterpret_cast( this ), NULL ); + } + + efSAFE_DELETE( mThread ); + + removeAllWatches(); + + if ( mIOCP ) + CloseHandle( mIOCP ); +} + +WatchID FileWatcherWin32::addWatch( const std::string& directory, FileWatchListener* watcher, + bool recursive, const std::vector &options ) { + std::string dir( directory ); + + FileInfo fi( dir ); + + if ( !fi.isDirectory() ) { + return Errors::Log::createLastError( Errors::FileNotFound, dir ); + } else if ( !fi.isReadable() ) { + return Errors::Log::createLastError( Errors::FileNotReadable, dir ); + } + + FileSystem::dirAddSlashAtEnd( dir ); + + Lock lock( mWatchesLock ); + + if ( pathInWatches( dir ) ) { + return Errors::Log::createLastError( Errors::FileRepeated, dir ); + } + + WatchID watchid = ++mLastWatchID; + + DWORD bufferSize = static_cast( getOptionValue(options, Option::WinBufferSize, 63 * 1024) ); + DWORD notifyFilter = static_cast( getOptionValue(options, Option::WinNotifyFilter, + FILE_NOTIFY_CHANGE_CREATION | FILE_NOTIFY_CHANGE_LAST_WRITE | + FILE_NOTIFY_CHANGE_FILE_NAME | FILE_NOTIFY_CHANGE_DIR_NAME | + FILE_NOTIFY_CHANGE_SIZE) ); + + WatcherStructWin32* watch = CreateWatch( String::fromUtf8( dir ).toWideString().c_str(), + recursive, bufferSize, notifyFilter, mIOCP ); + + if ( NULL == watch ) { + return Errors::Log::createLastError( Errors::FileNotFound, dir ); + } + + // Add the handle to the handles vector + watch->Watch->ID = watchid; + watch->Watch->Watch = this; + watch->Watch->Listener = watcher; + watch->Watch->DirName = new char[dir.length() + 1]; + strcpy( watch->Watch->DirName, dir.c_str() ); + + mWatches.insert( watch ); + + return watchid; +} + +void FileWatcherWin32::removeWatch( const std::string& directory ) { + Lock lock( mWatchesLock ); + + Watches::iterator iter = mWatches.begin(); + + for ( ; iter != mWatches.end(); ++iter ) { + if ( directory == ( *iter )->Watch->DirName ) { + removeWatch( *iter ); + break; + } + } +} + +void FileWatcherWin32::removeWatch( WatchID watchid ) { + Lock lock( mWatchesLock ); + + Watches::iterator iter = mWatches.begin(); + + for ( ; iter != mWatches.end(); ++iter ) { + // Find the watch ID + if ( ( *iter )->Watch->ID == watchid ) { + removeWatch( *iter ); + return; + } + } +} + +void FileWatcherWin32::removeWatch( WatcherStructWin32* watch ) { + Lock lock( mWatchesLock ); + + DestroyWatch( watch ); + mWatches.erase( watch ); +} + +void FileWatcherWin32::watch() { + if ( NULL == mThread ) { + mThread = new Thread( &FileWatcherWin32::run, this ); + mThread->launch(); + } +} + +void FileWatcherWin32::removeAllWatches() { + Lock lock( mWatchesLock ); + + Watches::iterator iter = mWatches.begin(); + + for ( ; iter != mWatches.end(); ++iter ) { + DestroyWatch( ( *iter ) ); + } + + mWatches.clear(); +} + +void FileWatcherWin32::run() { + do { + if ( mInitOK && !mWatches.empty() ) { + DWORD numOfBytes = 0; + OVERLAPPED* ov = NULL; + ULONG_PTR compKey = 0; + BOOL res = FALSE; + + while ( ( res = GetQueuedCompletionStatus( mIOCP, &numOfBytes, &compKey, &ov, + INFINITE ) ) != FALSE ) { + if ( compKey != 0 && compKey == reinterpret_cast( this ) ) { + break; + } else { + Lock lock( mWatchesLock ); + if (mWatches.find( (WatcherStructWin32*)ov ) != mWatches.end()) + WatchCallback( numOfBytes, ov ); + } + } + } else { + System::sleep( 10 ); + } + } while ( mInitOK ); + + removeAllWatches(); +} + +void FileWatcherWin32::handleAction( Watcher* watch, const std::string& filename, + unsigned long action, std::string /*oldFilename*/ ) { + Action fwAction; + + switch ( action ) { + case FILE_ACTION_RENAMED_OLD_NAME: + watch->OldFileName = filename; + return; + case FILE_ACTION_ADDED: + fwAction = Actions::Add; + break; + case FILE_ACTION_RENAMED_NEW_NAME: { + fwAction = Actions::Moved; + + std::string fpath( watch->Directory + filename ); + + // Update the directory path + if ( watch->Recursive && FileSystem::isDirectory( fpath ) ) { + // Update the new directory path + std::string opath( watch->Directory + watch->OldFileName ); + FileSystem::dirAddSlashAtEnd( opath ); + FileSystem::dirAddSlashAtEnd( fpath ); + + for ( Watches::iterator it = mWatches.begin(); it != mWatches.end(); ++it ) { + if ( ( *it )->Watch->Directory == opath ) { + ( *it )->Watch->Directory = fpath; + + break; + } + } + } + + std::string folderPath( static_cast( watch )->DirName ); + std::string realFilename = filename; + std::size_t sepPos = filename.find_last_of( "/\\" ); + std::string oldFolderPath = + static_cast( watch )->DirName + + watch->OldFileName.substr( 0, watch->OldFileName.find_last_of( "/\\" ) ); + + if ( sepPos != std::string::npos ) { + folderPath += + filename.substr( 0, sepPos + 1 < filename.size() ? sepPos + 1 : sepPos ); + realFilename = filename.substr( sepPos + 1 ); + } + + if ( folderPath == oldFolderPath ) { + watch->Listener->handleFileAction( + watch->ID, folderPath, realFilename, fwAction, + FileSystem::fileNameFromPath( watch->OldFileName ) ); + } else { + watch->Listener->handleFileAction( watch->ID, + static_cast( watch )->DirName, + filename, fwAction, watch->OldFileName ); + } + return; + } + case FILE_ACTION_REMOVED: + fwAction = Actions::Delete; + break; + case FILE_ACTION_MODIFIED: + fwAction = Actions::Modified; + break; + default: + return; + }; + + std::string folderPath( static_cast( watch )->DirName ); + std::string realFilename = filename; + std::size_t sepPos = filename.find_last_of( "/\\" ); + + if ( sepPos != std::string::npos ) { + folderPath += filename.substr( 0, sepPos + 1 < filename.size() ? sepPos + 1 : sepPos ); + realFilename = filename.substr( sepPos + 1 ); + } + + FileSystem::dirAddSlashAtEnd( folderPath ); + + watch->Listener->handleFileAction( watch->ID, folderPath, realFilename, fwAction ); +} + +std::vector FileWatcherWin32::directories() { + std::vector dirs; + + Lock lock( mWatchesLock ); + + dirs.reserve( mWatches.size() ); + + for ( Watches::iterator it = mWatches.begin(); it != mWatches.end(); ++it ) { + dirs.push_back( std::string( ( *it )->Watch->DirName ) ); + } + + return dirs; +} + +bool FileWatcherWin32::pathInWatches( const std::string& path ) { + Lock lock( mWatchesLock ); + + for ( Watches::iterator it = mWatches.begin(); it != mWatches.end(); ++it ) { + if ( ( *it )->Watch->DirName == path ) { + return true; + } + } + + return false; +} + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/FileWatcherWin32.hpp b/vendor/efsw/src/efsw/FileWatcherWin32.hpp new file mode 100644 index 0000000..3016aac --- /dev/null +++ b/vendor/efsw/src/efsw/FileWatcherWin32.hpp @@ -0,0 +1,71 @@ +#ifndef EFSW_FILEWATCHERWIN32_HPP +#define EFSW_FILEWATCHERWIN32_HPP + +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + +#include +#include +#include +#include + +namespace efsw { + +/// Implementation for Win32 based on ReadDirectoryChangesW. +/// @class FileWatcherWin32 +class FileWatcherWin32 : public FileWatcherImpl { + public: + /// type for a map from WatchID to WatcherWin32 pointer + typedef std::unordered_set Watches; + + FileWatcherWin32( FileWatcher* parent ); + + virtual ~FileWatcherWin32(); + + /// Add a directory watch + /// On error returns WatchID with Error type. + WatchID addWatch( const std::string& directory, FileWatchListener* watcher, bool recursive, + const std::vector &options ) override; + + /// Remove a directory watch. This is a brute force lazy search O(nlogn). + void removeWatch( const std::string& directory ) override; + + /// Remove a directory watch. This is a map lookup O(logn). + void removeWatch( WatchID watchid ) override; + + /// Updates the watcher. Must be called often. + void watch() override; + + /// Handles the action + void handleAction( Watcher* watch, const std::string& filename, unsigned long action, + std::string oldFilename = "" ) override; + + /// @return Returns a list of the directories that are being watched + std::vector directories() override; + + protected: + HANDLE mIOCP; + Watches mWatches; + + /// The last watchid + WatchID mLastWatchID; + Thread* mThread; + Mutex mWatchesLock; + + bool pathInWatches( const std::string& path ) override; + + /// Remove all directory watches. + void removeAllWatches(); + + void removeWatch( WatcherStructWin32* watch ); + + private: + void run(); +}; + +} // namespace efsw + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/Lock.hpp b/vendor/efsw/src/efsw/Lock.hpp new file mode 100644 index 0000000..e8c522a --- /dev/null +++ b/vendor/efsw/src/efsw/Lock.hpp @@ -0,0 +1,21 @@ +#ifndef EFSW_LOCK_HPP +#define EFSW_LOCK_HPP + +#include + +namespace efsw { + +/** Simple mutex class */ +class Lock { + public: + explicit Lock( Mutex& mutex ) : mMutex( mutex ) { mMutex.lock(); } + + ~Lock() { mMutex.unlock(); } + + private: + Mutex& mMutex; +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/Log.cpp b/vendor/efsw/src/efsw/Log.cpp new file mode 100644 index 0000000..6f32df7 --- /dev/null +++ b/vendor/efsw/src/efsw/Log.cpp @@ -0,0 +1,49 @@ +#include +#include + +namespace efsw { namespace Errors { + +static std::string LastError = ""; +static Error LastErrorCode = NoError; + +std::string Log::getLastErrorLog() { + return LastError; +} + +Error Log::getLastErrorCode() { + return LastErrorCode; +} + +void Log::clearLastError() { + LastErrorCode = NoError; + LastError = ""; +} + +Error Log::createLastError( Error err, std::string log ) { + switch ( err ) { + case FileNotFound: + LastError = "File not found ( " + log + " )"; + break; + case FileRepeated: + LastError = "File repeated in watches ( " + log + " )"; + break; + case FileOutOfScope: + LastError = "Symlink file out of scope ( " + log + " )"; + break; + case FileRemote: + LastError = + "File is located in a remote file system, use a generic watcher. ( " + log + " )"; + break; + case WatcherFailed: + LastError = "File system watcher failed ( " + log + " )"; + break; + case Unspecified: + default: + LastError = log; + } + + efDEBUG( "%s\n", LastError.c_str() ); + return err; +} + +}} // namespace efsw::Errors diff --git a/vendor/efsw/src/efsw/Mutex.cpp b/vendor/efsw/src/efsw/Mutex.cpp new file mode 100644 index 0000000..c961db1 --- /dev/null +++ b/vendor/efsw/src/efsw/Mutex.cpp @@ -0,0 +1,20 @@ +#include +#include + +namespace efsw { + +Mutex::Mutex() : mMutexImpl( new Platform::MutexImpl() ) {} + +Mutex::~Mutex() { + efSAFE_DELETE( mMutexImpl ); +} + +void Mutex::lock() { + mMutexImpl->lock(); +} + +void Mutex::unlock() { + mMutexImpl->unlock(); +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/Mutex.hpp b/vendor/efsw/src/efsw/Mutex.hpp new file mode 100644 index 0000000..d98ad17 --- /dev/null +++ b/vendor/efsw/src/efsw/Mutex.hpp @@ -0,0 +1,31 @@ +#ifndef EFSW_MUTEX_HPP +#define EFSW_MUTEX_HPP + +#include + +namespace efsw { + +namespace Platform { +class MutexImpl; +} + +/** Simple mutex class */ +class Mutex { + public: + Mutex(); + + ~Mutex(); + + /** Lock the mutex */ + void lock(); + + /** Unlock the mutex */ + void unlock(); + + private: + Platform::MutexImpl* mMutexImpl; +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/String.cpp b/vendor/efsw/src/efsw/String.cpp new file mode 100644 index 0000000..8c9a3cc --- /dev/null +++ b/vendor/efsw/src/efsw/String.cpp @@ -0,0 +1,669 @@ +#include +#include +#include + +namespace efsw { + +const std::size_t String::InvalidPos = StringType::npos; + +std::vector String::split( const std::string& str, const char& splitchar, + const bool& pushEmptyString ) { + std::vector tmp; + std::string tmpstr; + + for ( size_t i = 0; i < str.size(); i++ ) { + if ( str[i] == splitchar ) { + if ( pushEmptyString || tmpstr.size() ) { + tmp.push_back( tmpstr ); + tmpstr = ""; + } + } else { + tmpstr += str[i]; + } + } + + if ( tmpstr.size() ) { + tmp.push_back( tmpstr ); + } + + return tmp; +} + +std::vector String::split( const String& str, const Uint32& splitchar, + const bool& pushEmptyString ) { + std::vector tmp; + String tmpstr; + + for ( size_t i = 0; i < str.size(); i++ ) { + if ( str[i] == splitchar ) { + if ( pushEmptyString || tmpstr.size() ) { + tmp.push_back( tmpstr ); + tmpstr = ""; + } + } else { + tmpstr += str[i]; + } + } + + if ( tmpstr.size() ) { + tmp.push_back( tmpstr ); + } + + return tmp; +} + +int String::strStartsWith( const std::string& start, const std::string& str ) { + int pos = -1; + size_t size = start.size(); + + if ( str.size() >= size ) { + for ( std::size_t i = 0; i < size; i++ ) { + if ( start[i] == str[i] ) { + pos = (int)i; + } else { + pos = -1; + break; + } + } + } + + return pos; +} + +int String::strStartsWith( const String& start, const String& str ) { + int pos = -1; + size_t size = start.size(); + + if ( str.size() >= size ) { + for ( std::size_t i = 0; i < size; i++ ) { + if ( start[i] == str[i] ) { + pos = (int)i; + } else { + pos = -1; + break; + } + } + } + + return pos; +} + +String::String() {} + +String::String( char ansiChar, const std::locale& locale ) { + mString += Utf32::DecodeAnsi( ansiChar, locale ); +} + +#ifndef EFSW_NO_WIDECHAR +String::String( wchar_t wideChar ) { + mString += Utf32::DecodeWide( wideChar ); +} +#endif + +String::String( StringBaseType utf32Char ) { + mString += utf32Char; +} + +String::String( const char* uf8String ) { + if ( uf8String ) { + std::size_t length = strlen( uf8String ); + + if ( length > 0 ) { + mString.reserve( length + 1 ); + + Utf8::ToUtf32( uf8String, uf8String + length, std::back_inserter( mString ) ); + } + } +} + +String::String( const std::string& utf8String ) { + mString.reserve( utf8String.length() + 1 ); + + Utf8::ToUtf32( utf8String.begin(), utf8String.end(), std::back_inserter( mString ) ); +} + +String::String( const char* ansiString, const std::locale& locale ) { + if ( ansiString ) { + std::size_t length = strlen( ansiString ); + if ( length > 0 ) { + mString.reserve( length + 1 ); + Utf32::FromAnsi( ansiString, ansiString + length, std::back_inserter( mString ), + locale ); + } + } +} + +String::String( const std::string& ansiString, const std::locale& locale ) { + mString.reserve( ansiString.length() + 1 ); + Utf32::FromAnsi( ansiString.begin(), ansiString.end(), std::back_inserter( mString ), locale ); +} + +#ifndef EFSW_NO_WIDECHAR +String::String( const wchar_t* wideString ) { + if ( wideString ) { + std::size_t length = std::wcslen( wideString ); + if ( length > 0 ) { + mString.reserve( length + 1 ); + Utf32::FromWide( wideString, wideString + length, std::back_inserter( mString ) ); + } + } +} + +String::String( const std::wstring& wideString ) { + mString.reserve( wideString.length() + 1 ); + Utf32::FromWide( wideString.begin(), wideString.end(), std::back_inserter( mString ) ); +} +#endif + +String::String( const StringBaseType* utf32String ) { + if ( utf32String ) + mString = utf32String; +} + +String::String( const StringType& utf32String ) : mString( utf32String ) {} + +String::String( const String& str ) : mString( str.mString ) {} + +String String::fromUtf8( const std::string& utf8String ) { + String::StringType utf32; + + utf32.reserve( utf8String.length() + 1 ); + + Utf8::ToUtf32( utf8String.begin(), utf8String.end(), std::back_inserter( utf32 ) ); + + return String( utf32 ); +} + +String::operator std::string() const { + return toAnsiString(); +} + +std::string String::toAnsiString( const std::locale& locale ) const { + // Prepare the output string + std::string output; + output.reserve( mString.length() + 1 ); + + // Convert + Utf32::ToAnsi( mString.begin(), mString.end(), std::back_inserter( output ), 0, locale ); + + return output; +} + +#ifndef EFSW_NO_WIDECHAR +std::wstring String::toWideString() const { + // Prepare the output string + std::wstring output; + output.reserve( mString.length() + 1 ); + + // Convert + Utf32::ToWide( mString.begin(), mString.end(), std::back_inserter( output ), 0 ); + + return output; +} +#endif + +std::string String::toUtf8() const { + // Prepare the output string + std::string output; + output.reserve( mString.length() + 1 ); + + // Convert + Utf32::toUtf8( mString.begin(), mString.end(), std::back_inserter( output ) ); + + return output; +} + +String& String::operator=( const String& right ) { + mString = right.mString; + return *this; +} + +String& String::operator=( const StringBaseType& right ) { + mString = right; + return *this; +} + +String& String::operator+=( const String& right ) { + mString += right.mString; + return *this; +} + +String& String::operator+=( const StringBaseType& right ) { + mString += right; + return *this; +} + +String::StringBaseType String::operator[]( std::size_t index ) const { + return mString[index]; +} + +String::StringBaseType& String::operator[]( std::size_t index ) { + return mString[index]; +} + +String::StringBaseType String::at( std::size_t index ) const { + return mString.at( index ); +} + +void String::push_back( StringBaseType c ) { + mString.push_back( c ); +} + +void String::swap( String& str ) { + mString.swap( str.mString ); +} + +void String::clear() { + mString.clear(); +} + +std::size_t String::size() const { + return mString.size(); +} + +std::size_t String::length() const { + return mString.length(); +} + +bool String::empty() const { + return mString.empty(); +} + +void String::erase( std::size_t position, std::size_t count ) { + mString.erase( position, count ); +} + +String& String::insert( std::size_t position, const String& str ) { + mString.insert( position, str.mString ); + return *this; +} + +String& String::insert( std::size_t pos1, const String& str, std::size_t pos2, std::size_t n ) { + mString.insert( pos1, str.mString, pos2, n ); + return *this; +} + +String& String::insert( size_t pos1, const char* s, size_t n ) { + String tmp( s ); + + mString.insert( pos1, tmp.data(), n ); + + return *this; +} + +String& String::insert( size_t pos1, size_t n, char c ) { + mString.insert( pos1, n, c ); + return *this; +} + +String& String::insert( size_t pos1, const char* s ) { + String tmp( s ); + + mString.insert( pos1, tmp.data() ); + + return *this; +} + +String::Iterator String::insert( Iterator p, char c ) { + return mString.insert( p, c ); +} + +void String::insert( Iterator p, size_t n, char c ) { + mString.insert( p, n, c ); +} + +const String::StringBaseType* String::c_str() const { + return mString.c_str(); +} + +const String::StringBaseType* String::data() const { + return mString.data(); +} + +String::Iterator String::begin() { + return mString.begin(); +} + +String::ConstIterator String::begin() const { + return mString.begin(); +} + +String::Iterator String::end() { + return mString.end(); +} + +String::ConstIterator String::end() const { + return mString.end(); +} + +String::ReverseIterator String::rbegin() { + return mString.rbegin(); +} + +String::ConstReverseIterator String::rbegin() const { + return mString.rbegin(); +} + +String::ReverseIterator String::rend() { + return mString.rend(); +} + +String::ConstReverseIterator String::rend() const { + return mString.rend(); +} + +void String::resize( std::size_t n, StringBaseType c ) { + mString.resize( n, c ); +} + +void String::resize( std::size_t n ) { + mString.resize( n ); +} + +std::size_t String::max_size() const { + return mString.max_size(); +} + +void String::reserve( size_t res_arg ) { + mString.reserve( res_arg ); +} + +std::size_t String::capacity() const { + return mString.capacity(); +} + +String& String::assign( const String& str ) { + mString.assign( str.mString ); + return *this; +} + +String& String::assign( const String& str, size_t pos, size_t n ) { + mString.assign( str.mString, pos, n ); + return *this; +} + +String& String::assign( const char* s, size_t n ) { + String tmp( s ); + + mString.assign( tmp.mString ); + + return *this; +} + +String& String::assign( const char* s ) { + String tmp( s ); + + mString.assign( tmp.mString ); + + return *this; +} + +String& String::assign( size_t n, char c ) { + mString.assign( n, c ); + + return *this; +} + +String& String::append( const String& str ) { + mString.append( str.mString ); + + return *this; +} + +String& String::append( const String& str, size_t pos, size_t n ) { + mString.append( str.mString, pos, n ); + + return *this; +} + +String& String::append( const char* s, size_t n ) { + String tmp( s ); + + mString.append( tmp.mString ); + + return *this; +} + +String& String::append( const char* s ) { + String tmp( s ); + + mString.append( tmp.mString ); + + return *this; +} + +String& String::append( size_t n, char c ) { + mString.append( n, c ); + + return *this; +} + +String& String::append( std::size_t n, StringBaseType c ) { + mString.append( n, c ); + + return *this; +} + +String& String::replace( size_t pos1, size_t n1, const String& str ) { + mString.replace( pos1, n1, str.mString ); + + return *this; +} + +String& String::replace( Iterator i1, Iterator i2, const String& str ) { + mString.replace( i1, i2, str.mString ); + + return *this; +} + +String& String::replace( size_t pos1, size_t n1, const String& str, size_t pos2, size_t n2 ) { + mString.replace( pos1, n1, str.mString, pos2, n2 ); + + return *this; +} + +String& String::replace( size_t pos1, size_t n1, const char* s, size_t n2 ) { + String tmp( s ); + + mString.replace( pos1, n1, tmp.data(), n2 ); + + return *this; +} + +String& String::replace( Iterator i1, Iterator i2, const char* s, size_t n2 ) { + String tmp( s ); + + mString.replace( i1, i2, tmp.data(), n2 ); + + return *this; +} + +String& String::replace( size_t pos1, size_t n1, const char* s ) { + String tmp( s ); + + mString.replace( pos1, n1, tmp.mString ); + + return *this; +} + +String& String::replace( Iterator i1, Iterator i2, const char* s ) { + String tmp( s ); + + mString.replace( i1, i2, tmp.mString ); + + return *this; +} + +String& String::replace( size_t pos1, size_t n1, size_t n2, char c ) { + mString.replace( pos1, n1, n2, (StringBaseType)c ); + + return *this; +} + +String& String::replace( Iterator i1, Iterator i2, size_t n2, char c ) { + mString.replace( i1, i2, n2, (StringBaseType)c ); + + return *this; +} + +std::size_t String::find( const String& str, std::size_t start ) const { + return mString.find( str.mString, start ); +} + +std::size_t String::find( const char* s, std::size_t pos, std::size_t n ) const { + return find( String( s ), pos ); +} + +std::size_t String::find( const char* s, std::size_t pos ) const { + return find( String( s ), pos ); +} + +size_t String::find( char c, std::size_t pos ) const { + return mString.find( (StringBaseType)c, pos ); +} + +std::size_t String::rfind( const String& str, std::size_t pos ) const { + return mString.rfind( str.mString, pos ); +} + +std::size_t String::rfind( const char* s, std::size_t pos, std::size_t n ) const { + return rfind( String( s ), pos ); +} + +std::size_t String::rfind( const char* s, std::size_t pos ) const { + return rfind( String( s ), pos ); +} + +std::size_t String::rfind( char c, std::size_t pos ) const { + return mString.rfind( c, pos ); +} + +std::size_t String::copy( StringBaseType* s, std::size_t n, std::size_t pos ) const { + return mString.copy( s, n, pos ); +} + +String String::substr( std::size_t pos, std::size_t n ) const { + return String( mString.substr( pos, n ) ); +} + +int String::compare( const String& str ) const { + return mString.compare( str.mString ); +} + +int String::compare( const char* s ) const { + return compare( String( s ) ); +} + +int String::compare( std::size_t pos1, std::size_t n1, const String& str ) const { + return mString.compare( pos1, n1, str.mString ); +} + +int String::compare( std::size_t pos1, std::size_t n1, const char* s ) const { + return compare( pos1, n1, String( s ) ); +} + +int String::compare( std::size_t pos1, std::size_t n1, const String& str, std::size_t pos2, + std::size_t n2 ) const { + return mString.compare( pos1, n1, str.mString, pos2, n2 ); +} + +int String::compare( std::size_t pos1, std::size_t n1, const char* s, std::size_t n2 ) const { + return compare( pos1, n1, String( s ), 0, n2 ); +} + +std::size_t String::find_first_of( const String& str, std::size_t pos ) const { + return mString.find_first_of( str.mString, pos ); +} + +std::size_t String::find_first_of( const char* s, std::size_t pos, std::size_t n ) const { + return find_first_of( String( s ), pos ); +} + +std::size_t String::find_first_of( const char* s, std::size_t pos ) const { + return find_first_of( String( s ), pos ); +} + +std::size_t String::find_first_of( StringBaseType c, std::size_t pos ) const { + return mString.find_first_of( c, pos ); +} + +std::size_t String::find_last_of( const String& str, std::size_t pos ) const { + return mString.find_last_of( str.mString, pos ); +} + +std::size_t String::find_last_of( const char* s, std::size_t pos, std::size_t n ) const { + return find_last_of( String( s ), pos ); +} + +std::size_t String::find_last_of( const char* s, std::size_t pos ) const { + return find_last_of( String( s ), pos ); +} + +std::size_t String::find_last_of( StringBaseType c, std::size_t pos ) const { + return mString.find_last_of( c, pos ); +} + +std::size_t String::find_first_not_of( const String& str, std::size_t pos ) const { + return mString.find_first_not_of( str.mString, pos ); +} + +std::size_t String::find_first_not_of( const char* s, std::size_t pos, std::size_t n ) const { + return find_first_not_of( String( s ), pos ); +} + +std::size_t String::find_first_not_of( const char* s, std::size_t pos ) const { + return find_first_not_of( String( s ), pos ); +} + +std::size_t String::find_first_not_of( StringBaseType c, std::size_t pos ) const { + return mString.find_first_not_of( c, pos ); +} + +std::size_t String::find_last_not_of( const String& str, std::size_t pos ) const { + return mString.find_last_not_of( str.mString, pos ); +} + +std::size_t String::find_last_not_of( const char* s, std::size_t pos, std::size_t n ) const { + return find_last_not_of( String( s ), pos ); +} + +std::size_t String::find_last_not_of( const char* s, std::size_t pos ) const { + return find_last_not_of( String( s ), pos ); +} + +std::size_t String::find_last_not_of( StringBaseType c, std::size_t pos ) const { + return mString.find_last_not_of( c, pos ); +} + +bool operator==( const String& left, const String& right ) { + return left.mString == right.mString; +} + +bool operator!=( const String& left, const String& right ) { + return !( left == right ); +} + +bool operator<( const String& left, const String& right ) { + return left.mString < right.mString; +} + +bool operator>( const String& left, const String& right ) { + return right < left; +} + +bool operator<=( const String& left, const String& right ) { + return !( right < left ); +} + +bool operator>=( const String& left, const String& right ) { + return !( left < right ); +} + +String operator+( const String& left, const String& right ) { + String string = left; + string += right; + + return string; +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/String.hpp b/vendor/efsw/src/efsw/String.hpp new file mode 100644 index 0000000..b42b945 --- /dev/null +++ b/vendor/efsw/src/efsw/String.hpp @@ -0,0 +1,630 @@ +/** NOTE: + * This code is based on the Utf implementation from SFML2. License zlib/png ( + *http://www.sfml-dev.org/license.php ) The class was modified to fit efsw own needs. This is not + *the original implementation from SFML2. Functions and methods are the same that in std::string to + *facilitate portability. + **/ + +#ifndef EFSW_STRING_HPP +#define EFSW_STRING_HPP + +#include +#include +#include +#include +#include +#include +#include +#include + +namespace efsw { + +/** @brief Utility string class that automatically handles conversions between types and encodings + * **/ +class String { + public: + typedef char32_t StringBaseType; + typedef std::basic_string StringType; + typedef StringType::iterator Iterator; //! Iterator type + typedef StringType::const_iterator ConstIterator; //! Constant iterator type + typedef StringType::reverse_iterator ReverseIterator; //! Reverse Iterator type + typedef StringType::const_reverse_iterator ConstReverseIterator; //! Constant iterator type + + static const std::size_t InvalidPos; ///< Represents an invalid position in the string + + template static std::string toStr( const T& i ) { + std::ostringstream ss; + ss << i; + return ss.str(); + } + + /** Converts from a string to type */ + template + static bool fromString( T& t, const std::string& s, + std::ios_base& ( *f )( std::ios_base& ) = std::dec ) { + std::istringstream iss( s ); + return !( iss >> f >> t ).fail(); + } + + /** Converts from a String to type */ + template + static bool fromString( T& t, const String& s, + std::ios_base& ( *f )( std::ios_base& ) = std::dec ) { + std::istringstream iss( s.toUtf8() ); + return !( iss >> f >> t ).fail(); + } + + /** Split a string and hold it on a vector */ + static std::vector split( const std::string& str, const char& splitchar, + const bool& pushEmptyString = false ); + + /** Split a string and hold it on a vector */ + static std::vector split( const String& str, const Uint32& splitchar, + const bool& pushEmptyString = false ); + + /** Determine if a string starts with the string passed + ** @param start The substring expected to start + ** @param str The string to compare + ** @return -1 if the substring is no in str, otherwise the size of the substring + */ + static int strStartsWith( const std::string& start, const std::string& str ); + + static int strStartsWith( const String& start, const String& str ); + + /** @brief Construct from an UTF-8 string to UTF-32 according + ** @param uf8String UTF-8 string to convert + **/ + static String fromUtf8( const std::string& utf8String ); + + /** @brief Default constructor + ** This constructor creates an empty string. + **/ + String(); + + /** @brief Construct from a single ANSI character and a locale + ** The source character is converted to UTF-32 according + ** to the given locale. If you want to use the current global + ** locale, rather use the other constructor. + ** @param ansiChar ANSI character to convert + ** @param locale Locale to use for conversion + **/ + String( char ansiChar, const std::locale& locale = std::locale() ); + +#ifndef EFSW_NO_WIDECHAR + /** @brief Construct from single wide character + ** @param wideChar Wide character to convert + **/ + String( wchar_t wideChar ); +#endif + + /** @brief Construct from single UTF-32 character + ** @param utf32Char UTF-32 character to convert + **/ + String( StringBaseType utf32Char ); + + /** @brief Construct from an from a null-terminated C-style UTF-8 string to UTF-32 + ** @param uf8String UTF-8 string to convert + **/ + String( const char* uf8String ); + + /** @brief Construct from an UTF-8 string to UTF-32 according + ** @param uf8String UTF-8 string to convert + **/ + String( const std::string& utf8String ); + + /** @brief Construct from a null-terminated C-style ANSI string and a locale + ** The source string is converted to UTF-32 according + ** to the given locale. If you want to use the current global + ** locale, rather use the other constructor. + ** @param ansiString ANSI string to convert + ** @param locale Locale to use for conversion + **/ + String( const char* ansiString, const std::locale& locale ); + + /** @brief Construct from an ANSI string and a locale + ** The source string is converted to UTF-32 according + ** to the given locale. If you want to use the current global + ** locale, rather use the other constructor. + ** @param ansiString ANSI string to convert + ** @param locale Locale to use for conversion + **/ + String( const std::string& ansiString, const std::locale& locale ); + +#ifndef EFSW_NO_WIDECHAR + /** @brief Construct from null-terminated C-style wide string + ** @param wideString Wide string to convert + **/ + String( const wchar_t* wideString ); + + /** @brief Construct from a wide string + ** @param wideString Wide string to convert + **/ + String( const std::wstring& wideString ); +#endif + + /** @brief Construct from a null-terminated C-style UTF-32 string + ** @param utf32String UTF-32 string to assign + **/ + String( const StringBaseType* utf32String ); + + /** @brief Construct from an UTF-32 string + ** @param utf32String UTF-32 string to assign + **/ + String( const StringType& utf32String ); + + /** @brief Copy constructor + ** @param str Instance to copy + **/ + String( const String& str ); + + /** @brief Implicit cast operator to std::string (ANSI string) + ** The current global locale is used for conversion. If you + ** want to explicitely specify a locale, see toAnsiString. + ** Characters that do not fit in the target encoding are + ** discarded from the returned string. + ** This operator is defined for convenience, and is equivalent + ** to calling toAnsiString(). + ** @return Converted ANSI string + ** @see toAnsiString, operator String + **/ + operator std::string() const; + + /** @brief Convert the unicode string to an ANSI string + ** The UTF-32 string is converted to an ANSI string in + ** the encoding defined by \a locale. If you want to use + ** the current global locale, see the other overload + ** of toAnsiString. + ** Characters that do not fit in the target encoding are + ** discarded from the returned string. + ** @param locale Locale to use for conversion + ** @return Converted ANSI string + ** @see toWideString, operator std::string + **/ + std::string toAnsiString( const std::locale& locale = std::locale() ) const; + +#ifndef EFSW_NO_WIDECHAR + /** @brief Convert the unicode string to a wide string + ** Characters that do not fit in the target encoding are + ** discarded from the returned string. + ** @return Converted wide string + ** @see toAnsiString, operator String + **/ + std::wstring toWideString() const; +#endif + + std::string toUtf8() const; + + /** @brief Overload of assignment operator + ** @param right Instance to assign + ** @return Reference to self + **/ + String& operator=( const String& right ); + + String& operator=( const StringBaseType& right ); + + /** @brief Overload of += operator to append an UTF-32 string + ** @param right String to append + ** @return Reference to self + **/ + String& operator+=( const String& right ); + + String& operator+=( const StringBaseType& right ); + + /** @brief Overload of [] operator to access a character by its position + ** This function provides read-only access to characters. + ** Note: this function doesn't throw if \a index is out of range. + ** @param index Index of the character to get + ** @return Character at position \a index + **/ + StringBaseType operator[]( std::size_t index ) const; + + /** @brief Overload of [] operator to access a character by its position + ** This function provides read and write access to characters. + ** Note: this function doesn't throw if \a index is out of range. + ** @param index Index of the character to get + ** @return Reference to the character at position \a index + **/ + + StringBaseType& operator[]( std::size_t index ); + + /** @brief Get character in string + ** Performs a range check, throwing an exception of type out_of_range in case that pos is not an + *actual position in the string. + ** @return The character at position pos in the string. + */ + StringBaseType at( std::size_t index ) const; + + /** @brief clear the string + ** This function removes all the characters from the string. + ** @see empty, erase + **/ + void clear(); + + /** @brief Get the size of the string + ** @return Number of characters in the string + ** @see empty + **/ + std::size_t size() const; + + /** @see size() */ + std::size_t length() const; + + /** @brief Check whether the string is empty or not + ** @return True if the string is empty (i.e. contains no character) + ** @see clear, size + **/ + bool empty() const; + + /** @brief Erase one or more characters from the string + ** This function removes a sequence of \a count characters + ** starting from \a position. + ** @param position Position of the first character to erase + ** @param count Number of characters to erase + **/ + void erase( std::size_t position, std::size_t count = 1 ); + + /** @brief Insert one or more characters into the string + ** This function inserts the characters of \a str + ** into the string, starting from \a position. + ** @param position Position of insertion + ** @param str Characters to insert + **/ + String& insert( std::size_t position, const String& str ); + + String& insert( std::size_t pos1, const String& str, std::size_t pos2, std::size_t n ); + + String& insert( std::size_t pos1, const char* s, std::size_t n ); + + String& insert( std::size_t pos1, const char* s ); + + String& insert( std::size_t pos1, size_t n, char c ); + + Iterator insert( Iterator p, char c ); + + void insert( Iterator p, std::size_t n, char c ); + + template + void insert( Iterator p, InputIterator first, InputIterator last ) { + mString.insert( p, first, last ); + } + + /** @brief Find a sequence of one or more characters in the string + ** This function searches for the characters of \a str + ** into the string, starting from \a start. + ** @param str Characters to find + ** @param start Where to begin searching + ** @return Position of \a str in the string, or String::InvalidPos if not found + **/ + std::size_t find( const String& str, std::size_t start = 0 ) const; + + std::size_t find( const char* s, std::size_t pos, std::size_t n ) const; + + std::size_t find( const char* s, std::size_t pos = 0 ) const; + + std::size_t find( char c, std::size_t pos = 0 ) const; + + /** @brief Get a pointer to the C-style array of characters + ** This functions provides a read-only access to a + ** null-terminated C-style representation of the string. + ** The returned pointer is temporary and is meant only for + ** immediate use, thus it is not recommended to store it. + ** @return Read-only pointer to the array of characters + **/ + const StringBaseType* c_str() const; + + /** @brief Get string data + ** Notice that no terminating null character is appended (see member c_str for such a + *functionality). + ** The returned array points to an internal location which should not be modified directly in + *the program. + ** Its contents are guaranteed to remain unchanged only until the next call to a non-constant + *member function of the string object. + ** @return Pointer to an internal array containing the same content as the string. + **/ + const StringBaseType* data() const; + + /** @brief Return an iterator to the beginning of the string + ** @return Read-write iterator to the beginning of the string characters + ** @see end + **/ + Iterator begin(); + + /** @brief Return an iterator to the beginning of the string + ** @return Read-only iterator to the beginning of the string characters + ** @see end + **/ + ConstIterator begin() const; + + /** @brief Return an iterator to the beginning of the string + ** The end iterator refers to 1 position past the last character; + ** thus it represents an invalid character and should never be + ** accessed. + ** @return Read-write iterator to the end of the string characters + ** @see begin + **/ + Iterator end(); + + /** @brief Return an iterator to the beginning of the string + ** The end iterator refers to 1 position past the last character; + ** thus it represents an invalid character and should never be + ** accessed. + ** @return Read-only iterator to the end of the string characters + ** @see begin + **/ + ConstIterator end() const; + + /** @brief Return an reverse iterator to the beginning of the string + ** @return Read-write reverse iterator to the beginning of the string characters + ** @see end + **/ + ReverseIterator rbegin(); + + /** @brief Return an reverse iterator to the beginning of the string + ** @return Read-only reverse iterator to the beginning of the string characters + ** @see end + **/ + ConstReverseIterator rbegin() const; + + /** @brief Return an reverse iterator to the beginning of the string + ** The end reverse iterator refers to 1 position past the last character; + ** thus it represents an invalid character and should never be + ** accessed. + ** @return Read-write reverse iterator to the end of the string characters + ** @see begin + **/ + ReverseIterator rend(); + + /** @brief Return an reverse iterator to the beginning of the string + ** The end reverse iterator refers to 1 position past the last character; + ** thus it represents an invalid character and should never be + ** accessed. + ** @return Read-only reverse iterator to the end of the string characters + ** @see begin + **/ + ConstReverseIterator rend() const; + + /** @brief Resize String */ + void resize( std::size_t n, StringBaseType c ); + + /** @brief Resize String */ + void resize( std::size_t n ); + + /** @return Maximum size of string */ + std::size_t max_size() const; + + /** @brief Request a change in capacity */ + void reserve( size_t res_arg = 0 ); + + /** @return Size of allocated storage */ + std::size_t capacity() const; + + /** @brief Append character to string */ + void push_back( StringBaseType c ); + + /** @brief Swap contents with another string */ + void swap( String& str ); + + String& assign( const String& str ); + + String& assign( const String& str, std::size_t pos, std::size_t n ); + + String& assign( const char* s, std::size_t n ); + + String& assign( const char* s ); + + String& assign( std::size_t n, char c ); + + template String& assign( InputIterator first, InputIterator last ) { + mString.assign( first, last ); + return *this; + } + + String& append( const String& str ); + + String& append( const String& str, std::size_t pos, std::size_t n ); + + String& append( const char* s, std::size_t n ); + + String& append( const char* s ); + + String& append( std::size_t n, char c ); + + String& append( std::size_t n, StringBaseType c ); + + template String& append( InputIterator first, InputIterator last ) { + mString.append( first, last ); + return *this; + } + + String& replace( std::size_t pos1, std::size_t n1, const String& str ); + + String& replace( Iterator i1, Iterator i2, const String& str ); + + String& replace( std::size_t pos1, std::size_t n1, const String& str, std::size_t pos2, + std::size_t n2 ); + + String& replace( std::size_t pos1, std::size_t n1, const char* s, std::size_t n2 ); + + String& replace( Iterator i1, Iterator i2, const char* s, std::size_t n2 ); + + String& replace( std::size_t pos1, std::size_t n1, const char* s ); + + String& replace( Iterator i1, Iterator i2, const char* s ); + + String& replace( std::size_t pos1, std::size_t n1, std::size_t n2, char c ); + + String& replace( Iterator i1, Iterator i2, std::size_t n2, char c ); + + template + String& replace( Iterator i1, Iterator i2, InputIterator j1, InputIterator j2 ) { + mString.replace( i1, i2, j1, j2 ); + return *this; + } + + std::size_t rfind( const String& str, std::size_t pos = StringType::npos ) const; + + std::size_t rfind( const char* s, std::size_t pos, std::size_t n ) const; + + std::size_t rfind( const char* s, std::size_t pos = StringType::npos ) const; + + std::size_t rfind( char c, std::size_t pos = StringType::npos ) const; + + String substr( std::size_t pos = 0, std::size_t n = StringType::npos ) const; + + std::size_t copy( StringBaseType* s, std::size_t n, std::size_t pos = 0 ) const; + + int compare( const String& str ) const; + + int compare( const char* s ) const; + + int compare( std::size_t pos1, std::size_t n1, const String& str ) const; + + int compare( std::size_t pos1, std::size_t n1, const char* s ) const; + + int compare( std::size_t pos1, std::size_t n1, const String& str, std::size_t pos2, + std::size_t n2 ) const; + + int compare( std::size_t pos1, std::size_t n1, const char* s, std::size_t n2 ) const; + + std::size_t find_first_of( const String& str, std::size_t pos = 0 ) const; + + std::size_t find_first_of( const char* s, std::size_t pos, std::size_t n ) const; + + std::size_t find_first_of( const char* s, std::size_t pos = 0 ) const; + + std::size_t find_first_of( StringBaseType c, std::size_t pos = 0 ) const; + + std::size_t find_last_of( const String& str, std::size_t pos = StringType::npos ) const; + + std::size_t find_last_of( const char* s, std::size_t pos, std::size_t n ) const; + + std::size_t find_last_of( const char* s, std::size_t pos = StringType::npos ) const; + + std::size_t find_last_of( StringBaseType c, std::size_t pos = StringType::npos ) const; + + std::size_t find_first_not_of( const String& str, std::size_t pos = 0 ) const; + + std::size_t find_first_not_of( const char* s, std::size_t pos, std::size_t n ) const; + + std::size_t find_first_not_of( const char* s, std::size_t pos = 0 ) const; + + std::size_t find_first_not_of( StringBaseType c, std::size_t pos = 0 ) const; + + std::size_t find_last_not_of( const String& str, std::size_t pos = StringType::npos ) const; + + std::size_t find_last_not_of( const char* s, std::size_t pos, std::size_t n ) const; + + std::size_t find_last_not_of( const char* s, std::size_t pos = StringType::npos ) const; + + std::size_t find_last_not_of( StringBaseType c, std::size_t pos = StringType::npos ) const; + + private: + friend bool operator==( const String& left, const String& right ); + friend bool operator<( const String& left, const String& right ); + + StringType mString; ///< Internal string of UTF-32 characters +}; + +/** @relates String +** @brief Overload of == operator to compare two UTF-32 strings +** @param left Left operand (a string) +** @param right Right operand (a string) +** @return True if both strings are equal +**/ +bool operator==( const String& left, const String& right ); + +/** @relates String +** @brief Overload of != operator to compare two UTF-32 strings +** @param left Left operand (a string) +** @param right Right operand (a string) +** @return True if both strings are different +**/ +bool operator!=( const String& left, const String& right ); + +/** @relates String +** @brief Overload of < operator to compare two UTF-32 strings +** @param left Left operand (a string) +** @param right Right operand (a string) +** @return True if \a left is alphabetically lesser than \a right +**/ +bool operator<( const String& left, const String& right ); + +/** @relates String +** @brief Overload of > operator to compare two UTF-32 strings +** @param left Left operand (a string) +** @param right Right operand (a string) +** @return True if \a left is alphabetically greater than \a right +**/ +bool operator>( const String& left, const String& right ); + +/** @relates String +** @brief Overload of <= operator to compare two UTF-32 strings +** @param left Left operand (a string) +** @param right Right operand (a string) +** @return True if \a left is alphabetically lesser or equal than \a right +**/ +bool operator<=( const String& left, const String& right ); + +/** @relates String +** @brief Overload of >= operator to compare two UTF-32 strings +** @param left Left operand (a string) +** @param right Right operand (a string) +** @return True if \a left is alphabetically greater or equal than \a right +**/ +bool operator>=( const String& left, const String& right ); + +/** @relates String +** @brief Overload of binary + operator to concatenate two strings +** @param left Left operand (a string) +** @param right Right operand (a string) +** @return Concatenated string +**/ +String operator+( const String& left, const String& right ); + +} // namespace efsw + +#endif + +/** @class efsw::String +** @ingroup system +** efsw::String is a utility string class defined mainly for +** convenience. It is a Unicode string (implemented using +** UTF-32), thus it can store any character in the world +** (european, chinese, arabic, hebrew, etc.). +** It automatically handles conversions from/to ANSI and +** wide strings, so that you can work with standard string +** classes and still be compatible with functions taking a +** efsw::String. +** @code +** efsw::String s; +** std::string s1 = s; // automatically converted to ANSI string +** String s2 = s; // automatically converted to wide string +** s = "hello"; // automatically converted from ANSI string +** s = L"hello"; // automatically converted from wide string +** s += 'a'; // automatically converted from ANSI string +** s += L'a'; // automatically converted from wide string +** @endcode +** Conversions involving ANSI strings use the default user locale. However +** it is possible to use a custom locale if necessary: +** @code +** std::locale locale; +** efsw::String s; +** ... +** std::string s1 = s.toAnsiString(locale); +** s = efsw::String("hello", locale); +** @endcode +** +** efsw::String defines the most important functions of the +** standard std::string class: removing, random access, iterating, +** appending, comparing, etc. However it is a simple class +** provided for convenience, and you may have to consider using +** a more optimized class if your program requires complex string +** handling. The automatic conversion functions will then take +** care of converting your string to efsw::String whenever EE +** requires it. +** +** Please note that EE also defines a low-level, generic +** interface for Unicode handling, see the efsw::Utf classes. +** +** All credits to Laurent Gomila, i just modified and expanded a little bit the implementation. +**/ diff --git a/vendor/efsw/src/efsw/System.cpp b/vendor/efsw/src/efsw/System.cpp new file mode 100644 index 0000000..ba68bf4 --- /dev/null +++ b/vendor/efsw/src/efsw/System.cpp @@ -0,0 +1,22 @@ +#include +#include + +namespace efsw { + +void System::sleep( const unsigned long& ms ) { + Platform::System::sleep( ms ); +} + +std::string System::getProcessPath() { + return Platform::System::getProcessPath(); +} + +void System::maxFD() { + Platform::System::maxFD(); +} + +Uint64 System::getMaxFD() { + return Platform::System::getMaxFD(); +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/System.hpp b/vendor/efsw/src/efsw/System.hpp new file mode 100644 index 0000000..498e121 --- /dev/null +++ b/vendor/efsw/src/efsw/System.hpp @@ -0,0 +1,25 @@ +#ifndef EFSW_SYSTEM_HPP +#define EFSW_SYSTEM_HPP + +#include + +namespace efsw { + +class System { + public: + /// Sleep for x milliseconds + static void sleep( const unsigned long& ms ); + + /// @return The process binary path + static std::string getProcessPath(); + + /// Maximize the number of file descriptors allowed per process in the current OS + static void maxFD(); + + /// @return The number of supported file descriptors for the process + static Uint64 getMaxFD(); +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/Thread.cpp b/vendor/efsw/src/efsw/Thread.cpp new file mode 100644 index 0000000..cfa88b4 --- /dev/null +++ b/vendor/efsw/src/efsw/Thread.cpp @@ -0,0 +1,41 @@ +#include +#include + +namespace efsw { + +Thread::Thread() : mThreadImpl( NULL ), mEntryPoint( NULL ) {} + +Thread::~Thread() { + wait(); + + efSAFE_DELETE( mEntryPoint ); +} + +void Thread::launch() { + wait(); + + mThreadImpl = new Platform::ThreadImpl( this ); +} + +void Thread::wait() { + if ( mThreadImpl ) { + mThreadImpl->wait(); + + efSAFE_DELETE( mThreadImpl ); + } +} + +void Thread::terminate() { + if ( mThreadImpl ) { + mThreadImpl->terminate(); + + efSAFE_DELETE( mThreadImpl ); + } +} + +void Thread::run() { + if ( mEntryPoint ) + mEntryPoint->run(); +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/Thread.hpp b/vendor/efsw/src/efsw/Thread.hpp new file mode 100644 index 0000000..b60373c --- /dev/null +++ b/vendor/efsw/src/efsw/Thread.hpp @@ -0,0 +1,100 @@ +#ifndef EFSW_THREAD_HPP +#define EFSW_THREAD_HPP + +#include + +namespace efsw { + +namespace Platform { +class ThreadImpl; +} +namespace Private { +struct ThreadFunc; +} + +/** @brief Thread manager class */ +class Thread { + public: + typedef void ( *FuncType )( void* ); + + template Thread( F function ); + + template Thread( F function, A argument ); + + template Thread( void ( C::*function )(), C* object ); + + virtual ~Thread(); + + /** Launch the thread */ + virtual void launch(); + + /** Wait the thread until end */ + void wait(); + + /** Terminate the thread */ + void terminate(); + + protected: + Thread(); + + private: + friend class Platform::ThreadImpl; + + /** The virtual function to run in the thread */ + virtual void run(); + + Platform::ThreadImpl* mThreadImpl; ///< OS-specific implementation of the thread + Private::ThreadFunc* mEntryPoint; ///< Abstraction of the function to run +}; + +//! NOTE: Taken from SFML2 threads +namespace Private { + +// Base class for abstract thread functions +struct ThreadFunc { + virtual ~ThreadFunc() {} + virtual void run() = 0; +}; + +// Specialization using a functor (including free functions) with no argument +template struct ThreadFunctor : ThreadFunc { + ThreadFunctor( T functor ) : m_functor( functor ) {} + virtual void run() { m_functor(); } + T m_functor; +}; + +// Specialization using a functor (including free functions) with one argument +template struct ThreadFunctorWithArg : ThreadFunc { + ThreadFunctorWithArg( F function, A arg ) : m_function( function ), m_arg( arg ) {} + virtual void run() { m_function( m_arg ); } + F m_function; + A m_arg; +}; + +// Specialization using a member function +template struct ThreadMemberFunc : ThreadFunc { + ThreadMemberFunc( void ( C::*function )(), C* object ) : + m_function( function ), m_object( object ) {} + virtual void run() { ( m_object->*m_function )(); } + void ( C::*m_function )(); + C* m_object; +}; + +} // namespace Private + +template +Thread::Thread( F functor ) : + mThreadImpl( NULL ), mEntryPoint( new Private::ThreadFunctor( functor ) ) {} + +template +Thread::Thread( F function, A argument ) : + mThreadImpl( NULL ), + mEntryPoint( new Private::ThreadFunctorWithArg( function, argument ) ) {} + +template +Thread::Thread( void ( C::*function )(), C* object ) : + mThreadImpl( NULL ), mEntryPoint( new Private::ThreadMemberFunc( function, object ) ) {} + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/Utf.hpp b/vendor/efsw/src/efsw/Utf.hpp new file mode 100644 index 0000000..1b042cd --- /dev/null +++ b/vendor/efsw/src/efsw/Utf.hpp @@ -0,0 +1,721 @@ +/** NOTE: + * This code is based on the Utf implementation from SFML2. License zlib/png ( + *http://www.sfml-dev.org/license.php ) The class was modified to fit efsw own needs. This is not + *the original implementation from SFML2. + * */ + +#ifndef EFSW_UTF_HPP +#define EFSW_UTF_HPP + +//////////////////////////////////////////////////////////// +// Headers +//////////////////////////////////////////////////////////// +#include +#include +#include +#include + +namespace efsw { + +template class Utf; + +//////////////////////////////////////////////////////////// +/// \brief Specialization of the Utf template for UTF-8 +/// +//////////////////////////////////////////////////////////// +template <> class Utf<8> { + public: + //////////////////////////////////////////////////////////// + /// \brief Decode a single UTF-8 character + /// + /// Decoding a character means finding its unique 32-bits + /// code (called the codepoint) in the Unicode standard. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Codepoint of the decoded UTF-8 character + /// \param replacement Replacement character to use in case the UTF-8 sequence is invalid + /// + /// \return Iterator pointing to one past the last read element of the input sequence + /// + //////////////////////////////////////////////////////////// + template + static In Decode( In begin, In end, Uint32& output, Uint32 replacement = 0 ); + + //////////////////////////////////////////////////////////// + /// \brief Encode a single UTF-8 character + /// + /// Encoding a character means converting a unique 32-bits + /// code (called the codepoint) in the target encoding, UTF-8. + /// + /// \param input Codepoint to encode as UTF-8 + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement for characters not convertible to UTF-8 (use 0 to skip them) + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out Encode( Uint32 input, Out output, Uint8 replacement = 0 ); + + //////////////////////////////////////////////////////////// + /// \brief Advance to the next UTF-8 character + /// + /// This function is necessary for multi-elements encodings, as + /// a single character may use more than 1 storage element. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// + /// \return Iterator pointing to one past the last read element of the input sequence + /// + //////////////////////////////////////////////////////////// + template static In Next( In begin, In end ); + + //////////////////////////////////////////////////////////// + /// \brief Count the number of characters of a UTF-8 sequence + /// + /// This function is necessary for multi-elements encodings, as + /// a single character may use more than 1 storage element, thus the + /// total size can be different from (begin - end). + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// + /// \return Iterator pointing to one past the last read element of the input sequence + /// + //////////////////////////////////////////////////////////// + template static std::size_t Count( In begin, In end ); + + //////////////////////////////////////////////////////////// + /// \brief Convert an ANSI characters range to UTF-8 + /// + /// The current global locale will be used by default, unless you + /// pass a custom one in the \a locale parameter. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param locale Locale to use for conversion + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out FromAnsi( In begin, In end, Out output, const std::locale& locale = std::locale() ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a wide characters range to UTF-8 + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out FromWide( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a latin-1 (ISO-5589-1) characters range to UTF-8 + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param locale Locale to use for conversion + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out FromLatin1( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Convert an UTF-8 characters range to ANSI characters + /// + /// The current global locale will be used by default, unless you + /// pass a custom one in the \a locale parameter. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement for characters not convertible to ANSI (use 0 to skip them) + /// \param locale Locale to use for conversion + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out ToAnsi( In begin, In end, Out output, char replacement = 0, + const std::locale& locale = std::locale() ); + +#ifndef EFSW_NO_WIDECHAR + //////////////////////////////////////////////////////////// + /// \brief Convert an UTF-8 characters range to wide characters + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement for characters not convertible to wide (use 0 to skip them) + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out ToWide( In begin, In end, Out output, wchar_t replacement = 0 ); +#endif + + //////////////////////////////////////////////////////////// + /// \brief Convert an UTF-8 characters range to latin-1 (ISO-5589-1) characters + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement for characters not convertible to wide (use 0 to skip them) + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out ToLatin1( In begin, In end, Out output, char replacement = 0 ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a UTF-8 characters range to UTF-8 + /// + /// This functions does nothing more than a direct copy; + /// it is defined only to provide the same interface as other + /// specializations of the efsw::Utf<> template, and allow + /// generic code to be written on top of it. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out toUtf8( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a UTF-8 characters range to UTF-16 + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out ToUtf16( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a UTF-8 characters range to UTF-32 + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out ToUtf32( In begin, In end, Out output ); +}; + +//////////////////////////////////////////////////////////// +/// \brief Specialization of the Utf template for UTF-16 +/// +//////////////////////////////////////////////////////////// +template <> class Utf<16> { + public: + //////////////////////////////////////////////////////////// + /// \brief Decode a single UTF-16 character + /// + /// Decoding a character means finding its unique 32-bits + /// code (called the codepoint) in the Unicode standard. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Codepoint of the decoded UTF-16 character + /// \param replacement Replacement character to use in case the UTF-8 sequence is invalid + /// + /// \return Iterator pointing to one past the last read element of the input sequence + /// + //////////////////////////////////////////////////////////// + template + static In Decode( In begin, In end, Uint32& output, Uint32 replacement = 0 ); + + //////////////////////////////////////////////////////////// + /// \brief Encode a single UTF-16 character + /// + /// Encoding a character means converting a unique 32-bits + /// code (called the codepoint) in the target encoding, UTF-16. + /// + /// \param input Codepoint to encode as UTF-16 + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement for characters not convertible to UTF-16 (use 0 to skip them) + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out Encode( Uint32 input, Out output, Uint16 replacement = 0 ); + + //////////////////////////////////////////////////////////// + /// \brief Advance to the next UTF-16 character + /// + /// This function is necessary for multi-elements encodings, as + /// a single character may use more than 1 storage element. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// + /// \return Iterator pointing to one past the last read element of the input sequence + /// + //////////////////////////////////////////////////////////// + template static In Next( In begin, In end ); + + //////////////////////////////////////////////////////////// + /// \brief Count the number of characters of a UTF-16 sequence + /// + /// This function is necessary for multi-elements encodings, as + /// a single character may use more than 1 storage element, thus the + /// total size can be different from (begin - end). + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// + /// \return Iterator pointing to one past the last read element of the input sequence + /// + //////////////////////////////////////////////////////////// + template static std::size_t Count( In begin, In end ); + + //////////////////////////////////////////////////////////// + /// \brief Convert an ANSI characters range to UTF-16 + /// + /// The current global locale will be used by default, unless you + /// pass a custom one in the \a locale parameter. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param locale Locale to use for conversion + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out FromAnsi( In begin, In end, Out output, const std::locale& locale = std::locale() ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a wide characters range to UTF-16 + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out FromWide( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a latin-1 (ISO-5589-1) characters range to UTF-16 + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param locale Locale to use for conversion + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out FromLatin1( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Convert an UTF-16 characters range to ANSI characters + /// + /// The current global locale will be used by default, unless you + /// pass a custom one in the \a locale parameter. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement for characters not convertible to ANSI (use 0 to skip them) + /// \param locale Locale to use for conversion + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out ToAnsi( In begin, In end, Out output, char replacement = 0, + const std::locale& locale = std::locale() ); + +#ifndef EFSW_NO_WIDECHAR + //////////////////////////////////////////////////////////// + /// \brief Convert an UTF-16 characters range to wide characters + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement for characters not convertible to wide (use 0 to skip them) + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out ToWide( In begin, In end, Out output, wchar_t replacement = 0 ); +#endif + + //////////////////////////////////////////////////////////// + /// \brief Convert an UTF-16 characters range to latin-1 (ISO-5589-1) characters + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement for characters not convertible to wide (use 0 to skip them) + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out ToLatin1( In begin, In end, Out output, char replacement = 0 ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a UTF-16 characters range to UTF-8 + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out toUtf8( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a UTF-16 characters range to UTF-16 + /// + /// This functions does nothing more than a direct copy; + /// it is defined only to provide the same interface as other + /// specializations of the efsw::Utf<> template, and allow + /// generic code to be written on top of it. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out ToUtf16( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a UTF-16 characters range to UTF-32 + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out ToUtf32( In begin, In end, Out output ); +}; + +//////////////////////////////////////////////////////////// +/// \brief Specialization of the Utf template for UTF-32 +/// +//////////////////////////////////////////////////////////// +template <> class Utf<32> { + public: + //////////////////////////////////////////////////////////// + /// \brief Decode a single UTF-32 character + /// + /// Decoding a character means finding its unique 32-bits + /// code (called the codepoint) in the Unicode standard. + /// For UTF-32, the character value is the same as the codepoint. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Codepoint of the decoded UTF-32 character + /// \param replacement Replacement character to use in case the UTF-8 sequence is invalid + /// + /// \return Iterator pointing to one past the last read element of the input sequence + /// + //////////////////////////////////////////////////////////// + template + static In Decode( In begin, In end, Uint32& output, Uint32 replacement = 0 ); + + //////////////////////////////////////////////////////////// + /// \brief Encode a single UTF-32 character + /// + /// Encoding a character means converting a unique 32-bits + /// code (called the codepoint) in the target encoding, UTF-32. + /// For UTF-32, the codepoint is the same as the character value. + /// + /// \param input Codepoint to encode as UTF-32 + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement for characters not convertible to UTF-32 (use 0 to skip them) + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out Encode( Uint32 input, Out output, Uint32 replacement = 0 ); + + //////////////////////////////////////////////////////////// + /// \brief Advance to the next UTF-32 character + /// + /// This function is trivial for UTF-32, which can store + /// every character in a single storage element. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// + /// \return Iterator pointing to one past the last read element of the input sequence + /// + //////////////////////////////////////////////////////////// + template static In Next( In begin, In end ); + + //////////////////////////////////////////////////////////// + /// \brief Count the number of characters of a UTF-32 sequence + /// + /// This function is trivial for UTF-32, which can store + /// every character in a single storage element. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// + /// \return Iterator pointing to one past the last read element of the input sequence + /// + //////////////////////////////////////////////////////////// + template static std::size_t Count( In begin, In end ); + + //////////////////////////////////////////////////////////// + /// \brief Convert an ANSI characters range to UTF-32 + /// + /// The current global locale will be used by default, unless you + /// pass a custom one in the \a locale parameter. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param locale Locale to use for conversion + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out FromAnsi( In begin, In end, Out output, const std::locale& locale = std::locale() ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a wide characters range to UTF-32 + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out FromWide( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a latin-1 (ISO-5589-1) characters range to UTF-32 + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param locale Locale to use for conversion + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out FromLatin1( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Convert an UTF-32 characters range to ANSI characters + /// + /// The current global locale will be used by default, unless you + /// pass a custom one in the \a locale parameter. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement for characters not convertible to ANSI (use 0 to skip them) + /// \param locale Locale to use for conversion + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out ToAnsi( In begin, In end, Out output, char replacement = 0, + const std::locale& locale = std::locale() ); + +#ifndef EFSW_NO_WIDECHAR + //////////////////////////////////////////////////////////// + /// \brief Convert an UTF-32 characters range to wide characters + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement for characters not convertible to wide (use 0 to skip them) + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out ToWide( In begin, In end, Out output, wchar_t replacement = 0 ); +#endif + + //////////////////////////////////////////////////////////// + /// \brief Convert an UTF-16 characters range to latin-1 (ISO-5589-1) characters + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement for characters not convertible to wide (use 0 to skip them) + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out ToLatin1( In begin, In end, Out output, char replacement = 0 ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a UTF-32 characters range to UTF-8 + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out toUtf8( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a UTF-32 characters range to UTF-16 + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out ToUtf16( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Convert a UTF-32 characters range to UTF-32 + /// + /// This functions does nothing more than a direct copy; + /// it is defined only to provide the same interface as other + /// specializations of the efsw::Utf<> template, and allow + /// generic code to be written on top of it. + /// + /// \param begin Iterator pointing to the beginning of the input sequence + /// \param end Iterator pointing to the end of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template static Out ToUtf32( In begin, In end, Out output ); + + //////////////////////////////////////////////////////////// + /// \brief Decode a single ANSI character to UTF-32 + /// + /// This function does not exist in other specializations + /// of efsw::Utf<>, it is defined for convenience (it is used by + /// several other conversion functions). + /// + /// \param input Input ANSI character + /// \param locale Locale to use for conversion + /// + /// \return Converted character + /// + //////////////////////////////////////////////////////////// + template + static Uint32 DecodeAnsi( In input, const std::locale& locale = std::locale() ); + + //////////////////////////////////////////////////////////// + /// \brief Decode a single wide character to UTF-32 + /// + /// This function does not exist in other specializations + /// of efsw::Utf<>, it is defined for convenience (it is used by + /// several other conversion functions). + /// + /// \param input Input wide character + /// + /// \return Converted character + /// + //////////////////////////////////////////////////////////// + template static Uint32 DecodeWide( In input ); + + //////////////////////////////////////////////////////////// + /// \brief Encode a single UTF-32 character to ANSI + /// + /// This function does not exist in other specializations + /// of efsw::Utf<>, it is defined for convenience (it is used by + /// several other conversion functions). + /// + /// \param codepoint Iterator pointing to the beginning of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement if the input character is not convertible to ANSI (use 0 to + /// skip it) \param locale Locale to use for conversion + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out EncodeAnsi( Uint32 codepoint, Out output, char replacement = 0, + const std::locale& locale = std::locale() ); + +#ifndef EFSW_NO_WIDECHAR + //////////////////////////////////////////////////////////// + /// \brief Encode a single UTF-32 character to wide + /// + /// This function does not exist in other specializations + /// of efsw::Utf<>, it is defined for convenience (it is used by + /// several other conversion functions). + /// + /// \param codepoint Iterator pointing to the beginning of the input sequence + /// \param output Iterator pointing to the beginning of the output sequence + /// \param replacement Replacement if the input character is not convertible to wide (use 0 to + /// skip it) + /// + /// \return Iterator to the end of the output sequence which has been written + /// + //////////////////////////////////////////////////////////// + template + static Out EncodeWide( Uint32 codepoint, Out output, wchar_t replacement = 0 ); +#endif +}; + +#include "Utf.inl" + +// Make typedefs to get rid of the template syntax +typedef Utf<8> Utf8; +typedef Utf<16> Utf16; +typedef Utf<32> Utf32; + +} // namespace efsw +#endif + +//////////////////////////////////////////////////////////// +/// \class efsw::Utf +/// \ingroup system +/// +/// Utility class providing generic functions for UTF conversions. +/// +/// efsw::Utf is a low-level, generic interface for counting, iterating, +/// encoding and decoding Unicode characters and strings. It is able +/// to handle ANSI, wide, UTF-8, UTF-16 and UTF-32 encodings. +/// +/// efsw::Utf functions are all static, these classes are not meant to +/// be instanciated. All the functions are template, so that you +/// can use any character / string type for a given encoding. +/// +/// It has 3 specializations: +/// \li efsw::Utf<8> (typedef'd to efsw::Utf8) +/// \li efsw::Utf<16> (typedef'd to efsw::Utf16) +/// \li efsw::Utf<32> (typedef'd to efsw::Utf32) +/// +//////////////////////////////////////////////////////////// diff --git a/vendor/efsw/src/efsw/Utf.inl b/vendor/efsw/src/efsw/Utf.inl new file mode 100644 index 0000000..ef71bc8 --- /dev/null +++ b/vendor/efsw/src/efsw/Utf.inl @@ -0,0 +1,576 @@ +// References : +// http://www.unicode.org/ +// http://www.unicode.org/Public/PROGRAMS/CVTUTF/ConvertUTF.c +// http://www.unicode.org/Public/PROGRAMS/CVTUTF/ConvertUTF.h +// http://people.w3.org/rishida/scripts/uniview/conversion +//////////////////////////////////////////////////////////// + +template In Utf<8>::Decode( In begin, In end, Uint32& output, Uint32 replacement ) { + // Some useful precomputed data + static const int trailing[256] = { + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 2, 2, 2, 2, 2, 2, 2, 2, + 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5 }; + static const Uint32 offsets[6] = { 0x00000000, 0x00003080, 0x000E2080, + 0x03C82080, 0xFA082080, 0x82082080 }; + + // Decode the character + int trailingBytes = trailing[static_cast( *begin )]; + if ( begin + trailingBytes < end ) { + output = 0; + switch ( trailingBytes ) { + case 5: + output += static_cast( *begin++ ); + output <<= 6; + case 4: + output += static_cast( *begin++ ); + output <<= 6; + case 3: + output += static_cast( *begin++ ); + output <<= 6; + case 2: + output += static_cast( *begin++ ); + output <<= 6; + case 1: + output += static_cast( *begin++ ); + output <<= 6; + case 0: + output += static_cast( *begin++ ); + } + output -= offsets[trailingBytes]; + } else { + // Incomplete character + begin = end; + output = replacement; + } + + return begin; +} + +template Out Utf<8>::Encode( Uint32 input, Out output, Uint8 replacement ) { + // Some useful precomputed data + static const Uint8 firstBytes[7] = { 0x00, 0x00, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC }; + + // Encode the character + if ( ( input > 0x0010FFFF ) || ( ( input >= 0xD800 ) && ( input <= 0xDBFF ) ) ) { + // Invalid character + if ( replacement ) + *output++ = replacement; + } else { + // Valid character + + // Get the number of bytes to write + int bytesToWrite = 1; + if ( input < 0x80 ) + bytesToWrite = 1; + else if ( input < 0x800 ) + bytesToWrite = 2; + else if ( input < 0x10000 ) + bytesToWrite = 3; + else if ( input <= 0x0010FFFF ) + bytesToWrite = 4; + + // Extract the bytes to write + Uint8 bytes[4]; + switch ( bytesToWrite ) { + case 4: + bytes[3] = static_cast( ( input | 0x80 ) & 0xBF ); + input >>= 6; + case 3: + bytes[2] = static_cast( ( input | 0x80 ) & 0xBF ); + input >>= 6; + case 2: + bytes[1] = static_cast( ( input | 0x80 ) & 0xBF ); + input >>= 6; + case 1: + bytes[0] = static_cast( input | firstBytes[bytesToWrite] ); + } + + // Add them to the output + const Uint8* currentByte = bytes; + switch ( bytesToWrite ) { + case 4: + *output++ = *currentByte++; + case 3: + *output++ = *currentByte++; + case 2: + *output++ = *currentByte++; + case 1: + *output++ = *currentByte++; + } + } + + return output; +} + +template In Utf<8>::Next( In begin, In end ) { + Uint32 codepoint; + return Decode( begin, end, codepoint ); +} + +template std::size_t Utf<8>::Count( In begin, In end ) { + std::size_t length = 0; + while ( begin < end ) { + begin = Next( begin, end ); + ++length; + } + + return length; +} + +template +Out Utf<8>::FromAnsi( In begin, In end, Out output, const std::locale& locale ) { + while ( begin < end ) { + Uint32 codepoint = Utf<32>::DecodeAnsi( *begin++, locale ); + output = Encode( codepoint, output ); + } + + return output; +} + +template Out Utf<8>::FromWide( In begin, In end, Out output ) { + while ( begin < end ) { + Uint32 codepoint = Utf<32>::DecodeWide( *begin++ ); + output = Encode( codepoint, output ); + } + + return output; +} + +template Out Utf<8>::FromLatin1( In begin, In end, Out output ) { + // Latin-1 is directly compatible with Unicode encodings, + // and can thus be treated as (a sub-range of) UTF-32 + while ( begin < end ) + output = Encode( *begin++, output ); + + return output; +} + +template +Out Utf<8>::ToAnsi( In begin, In end, Out output, char replacement, const std::locale& locale ) { + while ( begin < end ) { + Uint32 codepoint; + begin = Decode( begin, end, codepoint ); + output = Utf<32>::EncodeAnsi( codepoint, output, replacement, locale ); + } + + return output; +} + +#ifndef EFSW_NO_WIDECHAR +template +Out Utf<8>::ToWide( In begin, In end, Out output, wchar_t replacement ) { + while ( begin < end ) { + Uint32 codepoint; + begin = Decode( begin, end, codepoint ); + output = Utf<32>::EncodeWide( codepoint, output, replacement ); + } + + return output; +} +#endif + +template +Out Utf<8>::ToLatin1( In begin, In end, Out output, char replacement ) { + // Latin-1 is directly compatible with Unicode encodings, + // and can thus be treated as (a sub-range of) UTF-32 + while ( begin < end ) { + Uint32 codepoint; + begin = Decode( begin, end, codepoint ); + *output++ = codepoint < 256 ? static_cast( codepoint ) : replacement; + } + + return output; +} + +template Out Utf<8>::toUtf8( In begin, In end, Out output ) { + while ( begin < end ) + *output++ = *begin++; + + return output; +} + +template Out Utf<8>::ToUtf16( In begin, In end, Out output ) { + while ( begin < end ) { + Uint32 codepoint; + begin = Decode( begin, end, codepoint ); + output = Utf<16>::Encode( codepoint, output ); + } + + return output; +} + +template Out Utf<8>::ToUtf32( In begin, In end, Out output ) { + while ( begin < end ) { + Uint32 codepoint; + begin = Decode( begin, end, codepoint ); + *output++ = codepoint; + } + + return output; +} + +template In Utf<16>::Decode( In begin, In end, Uint32& output, Uint32 replacement ) { + Uint16 first = *begin++; + + // If it's a surrogate pair, first convert to a single UTF-32 character + if ( ( first >= 0xD800 ) && ( first <= 0xDBFF ) ) { + if ( begin < end ) { + Uint32 second = *begin++; + if ( ( second >= 0xDC00 ) && ( second <= 0xDFFF ) ) { + // The second element is valid: convert the two elements to a UTF-32 character + output = static_cast( ( ( first - 0xD800 ) << 10 ) + ( second - 0xDC00 ) + + 0x0010000 ); + } else { + // Invalid character + output = replacement; + } + } else { + // Invalid character + begin = end; + output = replacement; + } + } else { + // We can make a direct copy + output = first; + } + + return begin; +} + +template Out Utf<16>::Encode( Uint32 input, Out output, Uint16 replacement ) { + if ( input < 0xFFFF ) { + // The character can be copied directly, we just need to check if it's in the valid range + if ( ( input >= 0xD800 ) && ( input <= 0xDFFF ) ) { + // Invalid character (this range is reserved) + if ( replacement ) + *output++ = replacement; + } else { + // Valid character directly convertible to a single UTF-16 character + *output++ = static_cast( input ); + } + } else if ( input > 0x0010FFFF ) { + // Invalid character (greater than the maximum unicode value) + if ( replacement ) + *output++ = replacement; + } else { + // The input character will be converted to two UTF-16 elements + input -= 0x0010000; + *output++ = static_cast( ( input >> 10 ) + 0xD800 ); + *output++ = static_cast( ( input & 0x3FFUL ) + 0xDC00 ); + } + + return output; +} + +template In Utf<16>::Next( In begin, In end ) { + Uint32 codepoint; + return Decode( begin, end, codepoint ); +} + +template std::size_t Utf<16>::Count( In begin, In end ) { + std::size_t length = 0; + while ( begin < end ) { + begin = Next( begin, end ); + ++length; + } + + return length; +} + +template +Out Utf<16>::FromAnsi( In begin, In end, Out output, const std::locale& locale ) { + while ( begin < end ) { + Uint32 codepoint = Utf<32>::DecodeAnsi( *begin++, locale ); + output = Encode( codepoint, output ); + } + + return output; +} + +template Out Utf<16>::FromWide( In begin, In end, Out output ) { + while ( begin < end ) { + Uint32 codepoint = Utf<32>::DecodeWide( *begin++ ); + output = Encode( codepoint, output ); + } + + return output; +} + +template Out Utf<16>::FromLatin1( In begin, In end, Out output ) { + // Latin-1 is directly compatible with Unicode encodings, + // and can thus be treated as (a sub-range of) UTF-32 + while ( begin < end ) + *output++ = *begin++; + + return output; +} + +template +Out Utf<16>::ToAnsi( In begin, In end, Out output, char replacement, const std::locale& locale ) { + while ( begin < end ) { + Uint32 codepoint; + begin = Decode( begin, end, codepoint ); + output = Utf<32>::EncodeAnsi( codepoint, output, replacement, locale ); + } + + return output; +} + +#ifndef EFSW_NO_WIDECHAR +template +Out Utf<16>::ToWide( In begin, In end, Out output, wchar_t replacement ) { + while ( begin < end ) { + Uint32 codepoint; + begin = Decode( begin, end, codepoint ); + output = Utf<32>::EncodeWide( codepoint, output, replacement ); + } + + return output; +} +#endif + +template +Out Utf<16>::ToLatin1( In begin, In end, Out output, char replacement ) { + // Latin-1 is directly compatible with Unicode encodings, + // and can thus be treated as (a sub-range of) UTF-32 + while ( begin < end ) { + *output++ = *begin < 256 ? static_cast( *begin ) : replacement; + begin++; + } + + return output; +} + +template Out Utf<16>::toUtf8( In begin, In end, Out output ) { + while ( begin < end ) { + Uint32 codepoint; + begin = Decode( begin, end, codepoint ); + output = Utf<8>::Encode( codepoint, output ); + } + + return output; +} + +template Out Utf<16>::ToUtf16( In begin, In end, Out output ) { + while ( begin < end ) + *output++ = *begin++; + + return output; +} + +template Out Utf<16>::ToUtf32( In begin, In end, Out output ) { + while ( begin < end ) { + Uint32 codepoint; + begin = Decode( begin, end, codepoint ); + *output++ = codepoint; + } + + return output; +} + +template In Utf<32>::Decode( In begin, In end, Uint32& output, Uint32 ) { + output = *begin++; + return begin; +} + +template Out Utf<32>::Encode( Uint32 input, Out output, Uint32 replacement ) { + *output++ = input; + return output; +} + +template In Utf<32>::Next( In begin, In end ) { + return ++begin; +} + +template std::size_t Utf<32>::Count( In begin, In end ) { + return begin - end; +} + +template +Out Utf<32>::FromAnsi( In begin, In end, Out output, const std::locale& locale ) { + while ( begin < end ) + *output++ = DecodeAnsi( *begin++, locale ); + + return output; +} + +template Out Utf<32>::FromWide( In begin, In end, Out output ) { + while ( begin < end ) + *output++ = DecodeWide( *begin++ ); + + return output; +} + +template Out Utf<32>::FromLatin1( In begin, In end, Out output ) { + // Latin-1 is directly compatible with Unicode encodings, + // and can thus be treated as (a sub-range of) UTF-32 + while ( begin < end ) + *output++ = *begin++; + + return output; +} + +template +Out Utf<32>::ToAnsi( In begin, In end, Out output, char replacement, const std::locale& locale ) { + while ( begin < end ) + output = EncodeAnsi( *begin++, output, replacement, locale ); + + return output; +} + +#ifndef EFSW_NO_WIDECHAR +template +Out Utf<32>::ToWide( In begin, In end, Out output, wchar_t replacement ) { + while ( begin < end ) + output = EncodeWide( *begin++, output, replacement ); + + return output; +} +#endif + +template +Out Utf<32>::ToLatin1( In begin, In end, Out output, char replacement ) { + // Latin-1 is directly compatible with Unicode encodings, + // and can thus be treated as (a sub-range of) UTF-32 + while ( begin < end ) { + *output++ = *begin < 256 ? static_cast( *begin ) : replacement; + begin++; + } + + return output; +} + +template Out Utf<32>::toUtf8( In begin, In end, Out output ) { + while ( begin < end ) + output = Utf<8>::Encode( *begin++, output ); + + return output; +} + +template Out Utf<32>::ToUtf16( In begin, In end, Out output ) { + while ( begin < end ) + output = Utf<16>::Encode( *begin++, output ); + + return output; +} + +template Out Utf<32>::ToUtf32( In begin, In end, Out output ) { + while ( begin < end ) + *output++ = *begin++; + + return output; +} + +template Uint32 Utf<32>::DecodeAnsi( In input, const std::locale& locale ) { + // On Windows, gcc's standard library (glibc++) has almost + // no support for Unicode stuff. As a consequence, in this + // context we can only use the default locale and ignore + // the one passed as parameter. + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN && /* if Windows ... */ \ + ( defined( __GLIBCPP__ ) || \ + defined( __GLIBCXX__ ) ) && /* ... and standard library is glibc++ ... */ \ + !( defined( __SGI_STL_PORT ) || \ + defined( _STLPORT_VERSION ) ) /* ... and STLPort is not used on top of it */ + + wchar_t character = 0; + mbtowc( &character, &input, 1 ); + return static_cast( character ); + +#else +// Get the facet of the locale which deals with character conversion +#ifndef EFSW_NO_WIDECHAR + const std::ctype& facet = std::use_facet>( locale ); +#else + const std::ctype& facet = std::use_facet>( locale ); +#endif + + // Use the facet to convert each character of the input string + return static_cast( facet.widen( input ) ); + +#endif +} + +template Uint32 Utf<32>::DecodeWide( In input ) { + // The encoding of wide characters is not well defined and is left to the system; + // however we can safely assume that it is UCS-2 on Windows and + // UCS-4 on Unix systems. + // In both cases, a simple copy is enough (UCS-2 is a subset of UCS-4, + // and UCS-4 *is* UTF-32). + + return input; +} + +template +Out Utf<32>::EncodeAnsi( Uint32 codepoint, Out output, char replacement, + const std::locale& locale ) { + // On Windows, gcc's standard library (glibc++) has almost + // no support for Unicode stuff. As a consequence, in this + // context we can only use the default locale and ignore + // the one passed as parameter. + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN && /* if Windows ... */ \ + ( defined( __GLIBCPP__ ) || \ + defined( __GLIBCXX__ ) ) && /* ... and standard library is glibc++ ... */ \ + !( defined( __SGI_STL_PORT ) || \ + defined( _STLPORT_VERSION ) ) /* ... and STLPort is not used on top of it */ + + char character = 0; + if ( wctomb( &character, static_cast( codepoint ) ) >= 0 ) + *output++ = character; + else if ( replacement ) + *output++ = replacement; + + return output; + +#else +// Get the facet of the locale which deals with character conversion +#ifndef EFSW_NO_WIDECHAR + const std::ctype& facet = std::use_facet>( locale ); +#else + const std::ctype& facet = std::use_facet>( locale ); +#endif + + // Use the facet to convert each character of the input string + *output++ = facet.narrow( static_cast( codepoint ), replacement ); + + return output; + +#endif +} + +#ifndef EFSW_NO_WIDECHAR +template +Out Utf<32>::EncodeWide( Uint32 codepoint, Out output, wchar_t replacement ) { + // The encoding of wide characters is not well defined and is left to the system; + // however we can safely assume that it is UCS-2 on Windows and + // UCS-4 on Unix systems. + // For UCS-2 we need to check if the source characters fits in (UCS-2 is a subset of UCS-4). + // For UCS-4 we can do a direct copy (UCS-4 *is* UTF-32). + + switch ( sizeof( wchar_t ) ) { + case 4: { + *output++ = static_cast( codepoint ); + break; + } + + default: { + if ( ( codepoint <= 0xFFFF ) && ( ( codepoint < 0xD800 ) || ( codepoint > 0xDFFF ) ) ) { + *output++ = static_cast( codepoint ); + } else if ( replacement ) { + *output++ = replacement; + } + break; + } + } + + return output; +} +#endif diff --git a/vendor/efsw/src/efsw/Watcher.cpp b/vendor/efsw/src/efsw/Watcher.cpp new file mode 100644 index 0000000..913ae3c --- /dev/null +++ b/vendor/efsw/src/efsw/Watcher.cpp @@ -0,0 +1,10 @@ +#include + +namespace efsw { + +Watcher::Watcher() : ID( 0 ), Directory( "" ), Listener( NULL ), Recursive( false ) {} + +Watcher::Watcher( WatchID id, std::string directory, FileWatchListener* listener, bool recursive ) : + ID( id ), Directory( directory ), Listener( listener ), Recursive( recursive ) {} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/Watcher.hpp b/vendor/efsw/src/efsw/Watcher.hpp new file mode 100644 index 0000000..84f0980 --- /dev/null +++ b/vendor/efsw/src/efsw/Watcher.hpp @@ -0,0 +1,29 @@ +#ifndef EFSW_WATCHERIMPL_HPP +#define EFSW_WATCHERIMPL_HPP + +#include +#include + +namespace efsw { + +/** @brief Base Watcher class */ +class Watcher { + public: + Watcher(); + + Watcher( WatchID id, std::string directory, FileWatchListener* listener, bool recursive ); + + virtual ~Watcher() {} + + virtual void watch() {} + + WatchID ID; + std::string Directory; + FileWatchListener* Listener; + bool Recursive; + std::string OldFileName; +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/WatcherFSEvents.cpp b/vendor/efsw/src/efsw/WatcherFSEvents.cpp new file mode 100644 index 0000000..e9b6b70 --- /dev/null +++ b/vendor/efsw/src/efsw/WatcherFSEvents.cpp @@ -0,0 +1,211 @@ +#include +#include +#include +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_FSEVENTS + +namespace efsw { + +WatcherFSEvents::WatcherFSEvents() : + Watcher(), FWatcher( NULL ), FSStream( NULL ), WatcherGen( NULL ) {} + +WatcherFSEvents::WatcherFSEvents( WatchID id, std::string directory, FileWatchListener* listener, + bool recursive, WatcherFSEvents* parent ) : + Watcher( id, directory, listener, recursive ), + FWatcher( NULL ), + FSStream( NULL ), + WatcherGen( NULL ) {} + +WatcherFSEvents::~WatcherFSEvents() { + if ( NULL != FSStream ) { + FSEventStreamStop( FSStream ); + FSEventStreamInvalidate( FSStream ); + FSEventStreamRelease( FSStream ); + } + + efSAFE_DELETE( WatcherGen ); +} + +void WatcherFSEvents::init() { + CFStringRef CFDirectory = + CFStringCreateWithCString( NULL, Directory.c_str(), kCFStringEncodingUTF8 ); + CFArrayRef CFDirectoryArray = CFArrayCreate( NULL, (const void**)&CFDirectory, 1, NULL ); + + Uint32 streamFlags = kFSEventStreamCreateFlagNone; + + if ( FileWatcherFSEvents::isGranular() ) { + streamFlags = efswFSEventStreamCreateFlagFileEvents | efswFSEventStreamCreateFlagNoDefer | + efswFSEventStreamCreateFlagUseExtendedData | + efswFSEventStreamCreateFlagUseCFTypes; + } else { + WatcherGen = new WatcherGeneric( ID, Directory, Listener, FWatcher.load(), Recursive ); + } + + FSEventStreamContext ctx; + /* Initialize context */ + ctx.version = 0; + ctx.info = this; + ctx.retain = NULL; + ctx.release = NULL; + ctx.copyDescription = NULL; + + dispatch_queue_t queue = dispatch_queue_create(NULL, NULL); + + FSStream = + FSEventStreamCreate( kCFAllocatorDefault, &FileWatcherFSEvents::FSEventCallback, &ctx, + CFDirectoryArray, kFSEventStreamEventIdSinceNow, 0., streamFlags ); + + FSEventStreamSetDispatchQueue(FSStream, queue); + + FSEventStreamStart( FSStream ); + + CFRelease( CFDirectoryArray ); + CFRelease( CFDirectory ); +} + +void WatcherFSEvents::sendFileAction( WatchID watchid, const std::string& dir, + const std::string& filename, Action action, + std::string oldFilename ) { + Listener->handleFileAction( watchid, FileSystem::precomposeFileName( dir ), + FileSystem::precomposeFileName( filename ), action, FileSystem::precomposeFileName( oldFilename ) ); +} + +void WatcherFSEvents::handleAddModDel( const Uint32& flags, const std::string& path, + std::string& dirPath, std::string& filePath ) { + if ( flags & efswFSEventStreamEventFlagItemCreated ) { + if ( FileInfo::exists( path ) ) { + sendFileAction( ID, dirPath, filePath, Actions::Add ); + } + } + + if ( flags & efswFSEventsModified ) { + sendFileAction( ID, dirPath, filePath, Actions::Modified ); + } + + if ( flags & efswFSEventStreamEventFlagItemRemoved ) { + // Since i don't know the order, at least i try to keep the data consistent with the real + // state + if ( !FileInfo::exists( path ) ) { + sendFileAction( ID, dirPath, filePath, Actions::Delete ); + } + } +} + +void WatcherFSEvents::handleActions( std::vector& events ) { + size_t esize = events.size(); + + for ( size_t i = 0; i < esize; i++ ) { + FSEvent& event = events[i]; + + if ( event.Flags & + ( kFSEventStreamEventFlagUserDropped | kFSEventStreamEventFlagKernelDropped | + kFSEventStreamEventFlagEventIdsWrapped | kFSEventStreamEventFlagHistoryDone | + kFSEventStreamEventFlagMount | kFSEventStreamEventFlagUnmount | + kFSEventStreamEventFlagRootChanged ) ) { + continue; + } + + if ( !Recursive ) { + /** In case that is not recursive the watcher, ignore the events from subfolders */ + if ( event.Path.find_last_of( FileSystem::getOSSlash() ) != Directory.size() - 1 ) { + continue; + } + } + + if ( FileWatcherFSEvents::isGranular() ) { + std::string dirPath( FileSystem::pathRemoveFileName( event.Path ) ); + std::string filePath( FileSystem::fileNameFromPath( event.Path ) ); + + if ( event.Flags & + ( efswFSEventStreamEventFlagItemCreated | efswFSEventStreamEventFlagItemRemoved | + efswFSEventStreamEventFlagItemRenamed ) ) { + if ( dirPath != Directory ) { + DirsChanged.insert( dirPath ); + } + } + + // This is a mess. But it's FSEvents faults, because shrinks events from the same file + // in one single event ( so there's no order for them ) For example a file could have + // been added modified and erased, but i can't know if first was erased and then added + // and modified, or added, then modified and then erased. I don't know what they were + // thinking by doing this... + efDEBUG( "Event in: %s - flags: 0x%x\n", event.Path.c_str(), event.Flags ); + + if ( event.Flags & efswFSEventStreamEventFlagItemRenamed ) { + if ( ( i + 1 < esize ) && + ( events[i + 1].Flags & efswFSEventStreamEventFlagItemRenamed ) && + ( events[i + 1].inode == event.inode ) ) { + FSEvent& nEvent = events[i + 1]; + std::string newDir( FileSystem::pathRemoveFileName( nEvent.Path ) ); + std::string newFilepath( FileSystem::fileNameFromPath( nEvent.Path ) ); + + if ( event.Path != nEvent.Path ) { + if ( dirPath == newDir ) { + if ( !FileInfo::exists( event.Path ) || + 0 == strcasecmp( event.Path.c_str(), nEvent.Path.c_str() ) ) { + sendFileAction( ID, dirPath, newFilepath, Actions::Moved, + filePath ); + } else { + sendFileAction( ID, dirPath, filePath, Actions::Moved, + newFilepath ); + } + } else { + sendFileAction( ID, dirPath, filePath, Actions::Delete ); + sendFileAction( ID, newDir, newFilepath, Actions::Add ); + + if ( nEvent.Flags & efswFSEventsModified ) { + sendFileAction( ID, newDir, newFilepath, Actions::Modified ); + } + } + } else { + handleAddModDel( nEvent.Flags, nEvent.Path, dirPath, filePath ); + } + + if ( nEvent.Flags & ( efswFSEventStreamEventFlagItemCreated | + efswFSEventStreamEventFlagItemRemoved | + efswFSEventStreamEventFlagItemRenamed ) ) { + if ( newDir != Directory ) { + DirsChanged.insert( newDir ); + } + } + + // Skip the renamed file + i++; + } else if ( FileInfo::exists( event.Path ) ) { + sendFileAction( ID, dirPath, filePath, Actions::Add ); + + if ( event.Flags & efswFSEventsModified ) { + sendFileAction( ID, dirPath, filePath, Actions::Modified ); + } + } else { + sendFileAction( ID, dirPath, filePath, Actions::Delete ); + } + } else { + handleAddModDel( event.Flags, event.Path, dirPath, filePath ); + } + } else { + efDEBUG( "Directory: %s changed\n", event.Path.c_str() ); + DirsChanged.insert( event.Path ); + } + } +} + +void WatcherFSEvents::process() { + std::set::iterator it = DirsChanged.begin(); + + for ( ; it != DirsChanged.end(); it++ ) { + if ( !FileWatcherFSEvents::isGranular() ) { + WatcherGen->watchDir( ( *it ) ); + } else { + sendFileAction( ID, FileSystem::pathRemoveFileName( ( *it ) ), + FileSystem::fileNameFromPath( ( *it ) ), Actions::Modified ); + } + } + + DirsChanged.clear(); +} + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/WatcherFSEvents.hpp b/vendor/efsw/src/efsw/WatcherFSEvents.hpp new file mode 100644 index 0000000..1c6047c --- /dev/null +++ b/vendor/efsw/src/efsw/WatcherFSEvents.hpp @@ -0,0 +1,64 @@ +#ifndef EFSW_WATCHERINOTIFY_HPP +#define EFSW_WATCHERINOTIFY_HPP + +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_FSEVENTS + +#include +#include +#include +#include +#include +#include + +namespace efsw { + +class FileWatcherFSEvents; + +class FSEvent { + public: + FSEvent( std::string path, long flags, Uint64 id, Uint64 inode = 0 ) : + Path( path ), Flags( flags ), Id( id ), inode( inode ) {} + + std::string Path; + long Flags; + Uint64 Id; + Uint64 inode{ 0 }; +}; + +class WatcherFSEvents : public Watcher { + public: + WatcherFSEvents(); + + WatcherFSEvents( WatchID id, std::string directory, FileWatchListener* listener, bool recursive, + WatcherFSEvents* parent = NULL ); + + ~WatcherFSEvents(); + + void init(); + + void handleActions( std::vector& events ); + + void process(); + + Atomic FWatcher; + FSEventStreamRef FSStream; + + protected: + void handleAddModDel( const Uint32& flags, const std::string& path, std::string& dirPath, + std::string& filePath ); + + WatcherGeneric* WatcherGen; + + std::set DirsChanged; + + void sendFileAction( WatchID watchid, const std::string& dir, const std::string& filename, + Action action, std::string oldFilename = "" ); +}; + +} // namespace efsw + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/WatcherGeneric.cpp b/vendor/efsw/src/efsw/WatcherGeneric.cpp new file mode 100644 index 0000000..a6bb106 --- /dev/null +++ b/vendor/efsw/src/efsw/WatcherGeneric.cpp @@ -0,0 +1,33 @@ +#include +#include +#include + +namespace efsw { + +WatcherGeneric::WatcherGeneric( WatchID id, const std::string& directory, FileWatchListener* fwl, + FileWatcherImpl* fw, bool recursive ) : + Watcher( id, directory, fwl, recursive ), WatcherImpl( fw ), DirWatch( NULL ) { + FileSystem::dirAddSlashAtEnd( Directory ); + + DirWatch = new DirWatcherGeneric( NULL, this, directory, recursive, false ); + + DirWatch->addChilds( false ); +} + +WatcherGeneric::~WatcherGeneric() { + efSAFE_DELETE( DirWatch ); +} + +void WatcherGeneric::watch() { + DirWatch->watch(); +} + +void WatcherGeneric::watchDir( std::string dir ) { + DirWatch->watchDir( dir ); +} + +bool WatcherGeneric::pathInWatches( std::string path ) { + return DirWatch->pathInWatches( path ); +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/WatcherGeneric.hpp b/vendor/efsw/src/efsw/WatcherGeneric.hpp new file mode 100644 index 0000000..d11ec20 --- /dev/null +++ b/vendor/efsw/src/efsw/WatcherGeneric.hpp @@ -0,0 +1,29 @@ +#ifndef EFSW_WATCHERGENERIC_HPP +#define EFSW_WATCHERGENERIC_HPP + +#include + +namespace efsw { + +class DirWatcherGeneric; + +class WatcherGeneric : public Watcher { + public: + FileWatcherImpl* WatcherImpl; + DirWatcherGeneric* DirWatch; + + WatcherGeneric( WatchID id, const std::string& directory, FileWatchListener* fwl, + FileWatcherImpl* fw, bool recursive ); + + ~WatcherGeneric(); + + void watch() override; + + void watchDir( std::string dir ); + + bool pathInWatches( std::string path ); +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/WatcherInotify.cpp b/vendor/efsw/src/efsw/WatcherInotify.cpp new file mode 100644 index 0000000..812ddae --- /dev/null +++ b/vendor/efsw/src/efsw/WatcherInotify.cpp @@ -0,0 +1,21 @@ +#include + +namespace efsw { + +WatcherInotify::WatcherInotify() : Watcher(), Parent( NULL ) {} + +bool WatcherInotify::inParentTree( WatcherInotify* parent ) { + WatcherInotify* tNext = Parent; + + while ( NULL != tNext ) { + if ( tNext == parent ) { + return true; + } + + tNext = tNext->Parent; + } + + return false; +} + +} // namespace efsw diff --git a/vendor/efsw/src/efsw/WatcherInotify.hpp b/vendor/efsw/src/efsw/WatcherInotify.hpp new file mode 100644 index 0000000..d43935c --- /dev/null +++ b/vendor/efsw/src/efsw/WatcherInotify.hpp @@ -0,0 +1,23 @@ +#ifndef EFSW_WATCHERINOTIFY_HPP +#define EFSW_WATCHERINOTIFY_HPP + +#include +#include + +namespace efsw { + +class WatcherInotify : public Watcher { + public: + WatcherInotify(); + + bool inParentTree( WatcherInotify* parent ); + + WatcherInotify* Parent; + WatchID InotifyID; + + FileInfo DirInfo; +}; + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/WatcherKqueue.cpp b/vendor/efsw/src/efsw/WatcherKqueue.cpp new file mode 100644 index 0000000..424b989 --- /dev/null +++ b/vendor/efsw/src/efsw/WatcherKqueue.cpp @@ -0,0 +1,566 @@ +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_KQUEUE || EFSW_PLATFORM == EFSW_PLATFORM_FSEVENTS + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define KEVENT_RESERVE_VALUE ( 10 ) + +#ifndef O_EVTONLY +#define O_EVTONLY ( O_RDONLY | O_NONBLOCK ) +#endif + +namespace efsw { + +int comparator( const void* ke1, const void* ke2 ) { + const KEvent* kev1 = reinterpret_cast( ke1 ); + const KEvent* kev2 = reinterpret_cast( ke2 ); + + if ( NULL != kev2->udata ) { + FileInfo* fi1 = reinterpret_cast( kev1->udata ); + FileInfo* fi2 = reinterpret_cast( kev2->udata ); + + return strcmp( fi1->Filepath.c_str(), fi2->Filepath.c_str() ); + } + + return 1; +} + +WatcherKqueue::WatcherKqueue( WatchID watchid, const std::string& dirname, + FileWatchListener* listener, bool recursive, + FileWatcherKqueue* watcher, WatcherKqueue* parent ) : + Watcher( watchid, dirname, listener, recursive ), + mLastWatchID( 0 ), + mChangeListCount( 0 ), + mKqueue( kqueue() ), + mWatcher( watcher ), + mParent( parent ), + mInitOK( true ), + mErrno( 0 ) { + if ( -1 == mKqueue ) { + efDEBUG( + "kqueue() returned invalid descriptor for directory %s. File descriptors count: %ld\n", + Directory.c_str(), mWatcher->mFileDescriptorCount ); + + mInitOK = false; + mErrno = errno; + } else { + mWatcher->addFD(); + } +} + +WatcherKqueue::~WatcherKqueue() { + // Remove the childs watchers ( sub-folders watches ) + removeAll(); + + for ( size_t i = 0; i < mChangeListCount; i++ ) { + if ( NULL != mChangeList[i].udata ) { + FileInfo* fi = reinterpret_cast( mChangeList[i].udata ); + + efSAFE_DELETE( fi ); + } + } + + close( mKqueue ); + + mWatcher->removeFD(); +} + +void WatcherKqueue::addAll() { + if ( -1 == mKqueue ) { + return; + } + + // scan directory and call addFile(name, false) on each file + FileSystem::dirAddSlashAtEnd( Directory ); + + efDEBUG( "addAll(): Added folder: %s\n", Directory.c_str() ); + + // add base dir + int fd = open( Directory.c_str(), O_EVTONLY ); + + if ( -1 == fd ) { + efDEBUG( "addAll(): Couldn't open folder: %s\n", Directory.c_str() ); + + if ( EACCES != errno ) { + mInitOK = false; + } + + mErrno = errno; + + return; + } + + mDirSnap.setDirectoryInfo( Directory ); + mDirSnap.scan(); + + mChangeList.resize( KEVENT_RESERVE_VALUE ); + + // Creates the kevent for the folder + EV_SET( &mChangeList[0], fd, EVFILT_VNODE, EV_ADD | EV_ENABLE | EV_ONESHOT, + NOTE_DELETE | NOTE_EXTEND | NOTE_WRITE | NOTE_ATTRIB | NOTE_RENAME, 0, 0 ); + + mWatcher->addFD(); + + // Get the files and directories from the directory + FileInfoMap files = FileSystem::filesInfoFromPath( Directory ); + + for ( FileInfoMap::iterator it = files.begin(); it != files.end(); it++ ) { + FileInfo& fi = it->second; + + if ( fi.isRegularFile() ) { + // Add the regular files kevent + addFile( fi.Filepath, false ); + } else if ( Recursive && fi.isDirectory() && fi.isReadable() ) { + // Create another watcher for the subfolders ( if recursive ) + WatchID id = addWatch( fi.Filepath, Listener, Recursive, this ); + + // If the watcher is not adding the watcher means that the directory was created + if ( id > 0 && !mWatcher->isAddingWatcher() ) { + handleFolderAction( fi.Filepath, Actions::Add ); + } + } + } +} + +void WatcherKqueue::removeAll() { + efDEBUG( "removeAll(): Removing all child watchers\n" ); + + std::vector erase; + + for ( WatchMap::iterator it = mWatches.begin(); it != mWatches.end(); it++ ) { + efDEBUG( "removeAll(): Removed child watcher %s\n", it->second->Directory.c_str() ); + + erase.push_back( it->second->ID ); + } + + for ( std::vector::iterator eit = erase.begin(); eit != erase.end(); eit++ ) { + removeWatch( *eit ); + } +} + +void WatcherKqueue::addFile( const std::string& name, bool emitEvents ) { + efDEBUG( "addFile(): Added: %s\n", name.c_str() ); + + // Open the file to get the file descriptor + int fd = open( name.c_str(), O_EVTONLY ); + + if ( fd == -1 ) { + efDEBUG( "addFile(): Could open file descriptor for %s. File descriptor count: %ld\n", + name.c_str(), mWatcher->mFileDescriptorCount ); + + Errors::Log::createLastError( Errors::FileNotReadable, name ); + + if ( EACCES != errno ) { + mInitOK = false; + } + + mErrno = errno; + + return; + } + + mWatcher->addFD(); + + // increase the file kevent file count + mChangeListCount++; + + if ( mChangeListCount + KEVENT_RESERVE_VALUE > mChangeList.size() && + mChangeListCount % KEVENT_RESERVE_VALUE == 0 ) { + size_t reserve_size = mChangeList.size() + KEVENT_RESERVE_VALUE; + mChangeList.resize( reserve_size ); + efDEBUG( "addFile(): Reserverd more KEvents space for %s, space reserved %ld, list actual " + "size %ld.\n", + Directory.c_str(), reserve_size, mChangeListCount ); + } + + // create entry + FileInfo* entry = new FileInfo( name ); + + // set the event data at the end of the list + EV_SET( &mChangeList[mChangeListCount], fd, EVFILT_VNODE, EV_ADD | EV_ENABLE | EV_ONESHOT, + NOTE_DELETE | NOTE_EXTEND | NOTE_WRITE | NOTE_ATTRIB | NOTE_RENAME, 0, (void*)entry ); + + // qsort sort the list by name + qsort( &mChangeList[1], mChangeListCount, sizeof( KEvent ), comparator ); + + // handle action + if ( emitEvents ) { + handleAction( name, Actions::Add ); + } +} + +void WatcherKqueue::removeFile( const std::string& name, bool emitEvents ) { + efDEBUG( "removeFile(): Trying to remove file: %s\n", name.c_str() ); + + // bsearch + KEvent target; + + // Create a temporary file info to search the kevent ( searching the directory ) + FileInfo tempEntry( name ); + + target.udata = &tempEntry; + + // Search the kevent + KEvent* ke = (KEvent*)bsearch( &target, &mChangeList[0], mChangeListCount + 1, sizeof( KEvent ), + comparator ); + + // Trying to remove a non-existing file? + if ( !ke ) { + Errors::Log::createLastError( Errors::FileNotFound, name ); + efDEBUG( "File not removed\n" ); + return; + } + + efDEBUG( "File removed\n" ); + + // handle action + if ( emitEvents ) { + handleAction( name, Actions::Delete ); + } + + // Delete the user data ( FileInfo ) from the kevent closed + FileInfo* del = reinterpret_cast( ke->udata ); + + efSAFE_DELETE( del ); + + // close the file descriptor from the kevent + close( ke->ident ); + + mWatcher->removeFD(); + + memset( ke, 0, sizeof( KEvent ) ); + + // move end to current + memcpy( ke, &mChangeList[mChangeListCount], sizeof( KEvent ) ); + memset( &mChangeList[mChangeListCount], 0, sizeof( KEvent ) ); + --mChangeListCount; +} + +void WatcherKqueue::rescan() { + efDEBUG( "rescan(): Rescanning: %s\n", Directory.c_str() ); + + DirectorySnapshotDiff Diff = mDirSnap.scan(); + + if ( Diff.DirChanged ) { + sendDirChanged(); + } + + if ( Diff.changed() ) { + FileInfoList::iterator it; + MovedList::iterator mit; + + /// Files + DiffIterator( FilesCreated ) { + addFile( ( *it ).Filepath ); + } + + DiffIterator( FilesModified ) { + handleAction( ( *it ).Filepath, Actions::Modified ); + } + + DiffIterator( FilesDeleted ) { + removeFile( ( *it ).Filepath ); + } + + DiffMovedIterator( FilesMoved ) { + handleAction( ( *mit ).second.Filepath, Actions::Moved, ( *mit ).first ); + removeFile( Directory + ( *mit ).first, false ); + addFile( ( *mit ).second.Filepath, false ); + } + + /// Directories + DiffIterator( DirsCreated ) { + handleFolderAction( ( *it ).Filepath, Actions::Add ); + addWatch( ( *it ).Filepath, Listener, Recursive, this ); + } + + DiffIterator( DirsModified ) { + handleFolderAction( ( *it ).Filepath, Actions::Modified ); + } + + DiffIterator( DirsDeleted ) { + handleFolderAction( ( *it ).Filepath, Actions::Delete ); + + Watcher* watch = findWatcher( ( *it ).Filepath ); + + if ( NULL != watch ) { + removeWatch( watch->ID ); + } + } + + DiffMovedIterator( DirsMoved ) { + moveDirectory( Directory + ( *mit ).first, ( *mit ).second.Filepath ); + } + } +} + +WatchID WatcherKqueue::watchingDirectory( std::string dir ) { + Watcher* watch = findWatcher( dir ); + + if ( NULL != watch ) { + return watch->ID; + } + + return Errors::FileNotFound; +} + +void WatcherKqueue::handleAction( const std::string& filename, efsw::Action action, + const std::string& oldFilename ) { + Listener->handleFileAction( ID, Directory, FileSystem::fileNameFromPath( filename ), action, + FileSystem::fileNameFromPath( oldFilename ) ); +} + +void WatcherKqueue::handleFolderAction( std::string filename, efsw::Action action, + const std::string& oldFilename ) { + FileSystem::dirRemoveSlashAtEnd( filename ); + + handleAction( filename, action, oldFilename ); +} + +void WatcherKqueue::sendDirChanged() { + if ( NULL != mParent ) { + Listener->handleFileAction( mParent->ID, mParent->Directory, + FileSystem::fileNameFromPath( Directory ), Actions::Modified ); + } +} + +void WatcherKqueue::watch() { + if ( -1 == mKqueue ) { + return; + } + + int nev = 0; + KEvent event; + + // First iterate the childs, to get the events from the deepest folder, to the watcher childs + for ( WatchMap::iterator it = mWatches.begin(); it != mWatches.end(); ++it ) { + it->second->watch(); + } + + bool needScan = false; + + // Then we get the the events of the current folder + while ( !mChangeList.empty() && + ( nev = kevent( mKqueue, mChangeList.data(), mChangeListCount + 1, &event, 1, + &mWatcher->mTimeOut ) ) != 0 ) { + // An error ocurred? + if ( nev == -1 ) { + efDEBUG( "watch(): Error on directory %s\n", Directory.c_str() ); + perror( "kevent" ); + break; + } else { + FileInfo* entry = NULL; + + // If udate == NULL means that it is the fisrt element of the change list, the folder. + // otherwise it is an event of some file inside the folder + if ( ( entry = reinterpret_cast( event.udata ) ) != NULL ) { + efDEBUG( "watch(): File: %s ", entry->Filepath.c_str() ); + + // If the event flag is delete... the file was deleted + if ( event.fflags & NOTE_DELETE ) { + efDEBUG( "deleted\n" ); + + mDirSnap.removeFile( entry->Filepath ); + + removeFile( entry->Filepath ); + } else if ( event.fflags & NOTE_EXTEND || event.fflags & NOTE_WRITE || + event.fflags & NOTE_ATTRIB ) { + // The file was modified + efDEBUG( "modified\n" ); + + FileInfo fi( entry->Filepath ); + + if ( fi != *entry ) { + *entry = fi; + + mDirSnap.updateFile( entry->Filepath ); + + handleAction( entry->Filepath, efsw::Actions::Modified ); + } + } else if ( event.fflags & NOTE_RENAME ) { + efDEBUG( "moved\n" ); + + needScan = true; + } + } else { + needScan = true; + } + } + } + + if ( needScan ) { + rescan(); + } +} + +Watcher* WatcherKqueue::findWatcher( const std::string path ) { + WatchMap::iterator it = mWatches.begin(); + + for ( ; it != mWatches.end(); it++ ) { + if ( it->second->Directory == path ) { + return it->second; + } + } + + return NULL; +} + +void WatcherKqueue::moveDirectory( std::string oldPath, std::string newPath, bool emitEvents ) { + // Update the directory path if it's a watcher + std::string opath2( oldPath ); + FileSystem::dirAddSlashAtEnd( opath2 ); + + Watcher* watch = findWatcher( opath2 ); + + if ( NULL != watch ) { + watch->Directory = opath2; + } + + if ( emitEvents ) { + handleFolderAction( newPath, efsw::Actions::Moved, oldPath ); + } +} + +WatchID WatcherKqueue::addWatch( const std::string& directory, FileWatchListener* watcher, + bool recursive, WatcherKqueue* parent ) { + static bool s_ug = false; + + std::string dir( directory ); + + FileSystem::dirAddSlashAtEnd( dir ); + + // This should never happen here + if ( !FileSystem::isDirectory( dir ) ) { + return Errors::Log::createLastError( Errors::FileNotFound, dir ); + } else if ( pathInWatches( dir ) || pathInParent( dir ) ) { + return Errors::Log::createLastError( Errors::FileRepeated, directory ); + } else if ( NULL != parent && FileSystem::isRemoteFS( dir ) ) { + return Errors::Log::createLastError( Errors::FileRemote, dir ); + } + + std::string curPath; + std::string link( FileSystem::getLinkRealPath( dir, curPath ) ); + + if ( "" != link ) { + /// Avoid adding symlinks directories if it's now enabled + if ( NULL != parent && !mWatcher->mFileWatcher->followSymlinks() ) { + return Errors::Log::createLastError( Errors::FileOutOfScope, dir ); + } + + if ( pathInWatches( link ) || pathInParent( link ) ) { + return Errors::Log::createLastError( Errors::FileRepeated, link ); + } else if ( !mWatcher->linkAllowed( curPath, link ) ) { + return Errors::Log::createLastError( Errors::FileOutOfScope, link ); + } else { + dir = link; + } + } + + if ( mWatcher->availablesFD() ) { + WatcherKqueue* watch = + new WatcherKqueue( ++mLastWatchID, dir, watcher, recursive, mWatcher, parent ); + + mWatches.insert( std::make_pair( mLastWatchID, watch ) ); + + watch->addAll(); + + // if failed to open the directory... erase the watcher + if ( !watch->initOK() ) { + int le = watch->lastErrno(); + + mWatches.erase( watch->ID ); + + efSAFE_DELETE( watch ); + + mLastWatchID--; + + // Probably the folder has too many files, create a generic watcher + if ( EACCES != le ) { + WatcherGeneric* watch = + new WatcherGeneric( ++mLastWatchID, dir, watcher, mWatcher, recursive ); + + mWatches.insert( std::make_pair( mLastWatchID, watch ) ); + } else { + return Errors::Log::createLastError( Errors::Unspecified, link ); + } + } + } else { + if ( !s_ug ) { + efDEBUG( "Started using WatcherGeneric, reached file descriptors limit: %ld.\n", + mWatcher->mFileDescriptorCount ); + s_ug = true; + } + + WatcherGeneric* watch = + new WatcherGeneric( ++mLastWatchID, dir, watcher, mWatcher, recursive ); + + mWatches.insert( std::make_pair( mLastWatchID, watch ) ); + } + + return mLastWatchID; +} + +bool WatcherKqueue::initOK() { + return mInitOK; +} + +void WatcherKqueue::removeWatch( WatchID watchid ) { + WatchMap::iterator iter = mWatches.find( watchid ); + + if ( iter == mWatches.end() ) + return; + + Watcher* watch = iter->second; + + mWatches.erase( iter ); + + efSAFE_DELETE( watch ); +} + +bool WatcherKqueue::pathInWatches( const std::string& path ) { + return NULL != findWatcher( path ); +} + +bool WatcherKqueue::pathInParent( const std::string& path ) { + WatcherKqueue* pNext = mParent; + + while ( NULL != pNext ) { + if ( pNext->pathInWatches( path ) ) { + return true; + } + + pNext = pNext->mParent; + } + + if ( mWatcher->pathInWatches( path ) ) { + return true; + } + + if ( path == Directory ) { + return true; + } + + return false; +} + +int WatcherKqueue::lastErrno() { + return mErrno; +} + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/WatcherKqueue.hpp b/vendor/efsw/src/efsw/WatcherKqueue.hpp new file mode 100644 index 0000000..75c0f62 --- /dev/null +++ b/vendor/efsw/src/efsw/WatcherKqueue.hpp @@ -0,0 +1,97 @@ +#ifndef EFSW_WATCHEROSX_HPP +#define EFSW_WATCHEROSX_HPP + +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_KQUEUE || EFSW_PLATFORM == EFSW_PLATFORM_FSEVENTS + +#include +#include +#include +#include +#include + +namespace efsw { + +class FileWatcherKqueue; +class WatcherKqueue; + +typedef struct kevent KEvent; + +/// type for a map from WatchID to WatcherKqueue pointer +typedef std::map WatchMap; + +class WatcherKqueue : public Watcher { + public: + WatcherKqueue( WatchID watchid, const std::string& dirname, FileWatchListener* listener, + bool recursive, FileWatcherKqueue* watcher, WatcherKqueue* parent = NULL ); + + virtual ~WatcherKqueue(); + + void addFile( const std::string& name, bool emitEvents = true ); + + void removeFile( const std::string& name, bool emitEvents = true ); + + // called when the directory is actually changed + // means a file has been added or removed + // rescans the watched directory adding/removing files and sending notices + void rescan(); + + void handleAction( const std::string& filename, efsw::Action action, + const std::string& oldFilename = "" ); + + void handleFolderAction( std::string filename, efsw::Action action, + const std::string& oldFilename = "" ); + + void addAll(); + + void removeAll(); + + WatchID watchingDirectory( std::string dir ); + + void watch() override; + + WatchID addWatch( const std::string& directory, FileWatchListener* watcher, bool recursive, + WatcherKqueue* parent ); + + void removeWatch( WatchID watchid ); + + bool initOK(); + + int lastErrno(); + + protected: + WatchMap mWatches; + int mLastWatchID; + + // index 0 is always the directory + std::vector mChangeList; + size_t mChangeListCount; + DirectorySnapshot mDirSnap; + + /// The descriptor for the kqueue + int mKqueue; + + FileWatcherKqueue* mWatcher; + + WatcherKqueue* mParent; + + bool mInitOK; + int mErrno; + + bool pathInWatches( const std::string& path ); + + bool pathInParent( const std::string& path ); + + Watcher* findWatcher( const std::string path ); + + void moveDirectory( std::string oldPath, std::string newPath, bool emitEvents = true ); + + void sendDirChanged(); +}; + +} // namespace efsw + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/WatcherWin32.cpp b/vendor/efsw/src/efsw/WatcherWin32.cpp new file mode 100644 index 0000000..712419e --- /dev/null +++ b/vendor/efsw/src/efsw/WatcherWin32.cpp @@ -0,0 +1,263 @@ +#include +#include +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + +#include + +namespace efsw { + +struct EFSW_FILE_NOTIFY_EXTENDED_INFORMATION_EX { + DWORD NextEntryOffset; + DWORD Action; + LARGE_INTEGER CreationTime; + LARGE_INTEGER LastModificationTime; + LARGE_INTEGER LastChangeTime; + LARGE_INTEGER LastAccessTime; + LARGE_INTEGER AllocatedLength; + LARGE_INTEGER FileSize; + DWORD FileAttributes; + DWORD ReparsePointTag; + LARGE_INTEGER FileId; + LARGE_INTEGER ParentFileId; + DWORD FileNameLength; + WCHAR FileName[1]; +}; + +typedef EFSW_FILE_NOTIFY_EXTENDED_INFORMATION_EX* EFSW_PFILE_NOTIFY_EXTENDED_INFORMATION_EX; + +typedef BOOL( WINAPI* EFSW_LPREADDIRECTORYCHANGESEXW )( HANDLE hDirectory, LPVOID lpBuffer, + DWORD nBufferLength, BOOL bWatchSubtree, + DWORD dwNotifyFilter, LPDWORD lpBytesReturned, + LPOVERLAPPED lpOverlapped, LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine, + DWORD ReadDirectoryNotifyInformationClass ); + +static EFSW_LPREADDIRECTORYCHANGESEXW pReadDirectoryChangesExW = NULL; + +#define EFSW_ReadDirectoryNotifyExtendedInformation 2 + +static void initReadDirectoryChangesEx() { + static bool hasInit = false; + if ( !hasInit ) { + hasInit = true; + + HMODULE hModule = GetModuleHandleW( L"Kernel32.dll" ); + if ( !hModule ) + return; + + pReadDirectoryChangesExW = + (EFSW_LPREADDIRECTORYCHANGESEXW)GetProcAddress( hModule, "ReadDirectoryChangesExW" ); + } +} + +void WatchCallbackOld( WatcherWin32* pWatch ) { + PFILE_NOTIFY_INFORMATION pNotify; + size_t offset = 0; + do { + bool skip = false; + + pNotify = (PFILE_NOTIFY_INFORMATION)&pWatch->Buffer[offset]; + offset += pNotify->NextEntryOffset; + int count = + WideCharToMultiByte( CP_UTF8, 0, pNotify->FileName, + pNotify->FileNameLength / sizeof( WCHAR ), NULL, 0, NULL, NULL ); + if ( count == 0 ) + continue; + + std::string nfile( count, '\0' ); + + count = WideCharToMultiByte( CP_UTF8, 0, pNotify->FileName, + pNotify->FileNameLength / sizeof( WCHAR ), &nfile[0], count, + NULL, NULL ); + + if ( FILE_ACTION_MODIFIED == pNotify->Action ) { + FileInfo fifile( std::string( pWatch->DirName ) + nfile ); + + if ( pWatch->LastModifiedEvent.file.ModificationTime == fifile.ModificationTime && + pWatch->LastModifiedEvent.file.Size == fifile.Size && + pWatch->LastModifiedEvent.fileName == nfile ) { + skip = true; + } + + pWatch->LastModifiedEvent.fileName = nfile; + pWatch->LastModifiedEvent.file = fifile; + } + + if ( !skip ) { + pWatch->Watch->handleAction( pWatch, nfile, pNotify->Action ); + } + } while ( pNotify->NextEntryOffset != 0 ); +} + +void WatchCallbackEx( WatcherWin32* pWatch ) { + EFSW_PFILE_NOTIFY_EXTENDED_INFORMATION_EX pNotify; + size_t offset = 0; + do { + bool skip = false; + + pNotify = (EFSW_PFILE_NOTIFY_EXTENDED_INFORMATION_EX)&pWatch->Buffer[offset]; + offset += pNotify->NextEntryOffset; + int count = + WideCharToMultiByte( CP_UTF8, 0, pNotify->FileName, + pNotify->FileNameLength / sizeof( WCHAR ), NULL, 0, NULL, NULL ); + if ( count == 0 ) + continue; + + std::string nfile( count, '\0' ); + + count = WideCharToMultiByte( CP_UTF8, 0, pNotify->FileName, + pNotify->FileNameLength / sizeof( WCHAR ), &nfile[0], count, + NULL, NULL ); + + if ( FILE_ACTION_MODIFIED == pNotify->Action ) { + FileInfo fifile( std::string( pWatch->DirName ) + nfile ); + + if ( pWatch->LastModifiedEvent.file.ModificationTime == fifile.ModificationTime && + pWatch->LastModifiedEvent.file.Size == fifile.Size && + pWatch->LastModifiedEvent.fileName == nfile ) { + skip = true; + } + + pWatch->LastModifiedEvent.fileName = nfile; + pWatch->LastModifiedEvent.file = fifile; + } else if ( FILE_ACTION_RENAMED_OLD_NAME == pNotify->Action ) { + pWatch->OldFiles.emplace_back( nfile, pNotify->FileId ); + skip = true; + } else if ( FILE_ACTION_RENAMED_NEW_NAME == pNotify->Action ) { + std::string oldFile; + LARGE_INTEGER oldFileId{}; + + for ( auto it = pWatch->OldFiles.begin(); it != pWatch->OldFiles.end(); ++it ) { + if ( it->second.QuadPart == pNotify->FileId.QuadPart ) { + oldFile = it->first; + oldFileId = it->second; + it = pWatch->OldFiles.erase( it ); + break; + } + } + + if ( oldFile.empty() ) { + pWatch->Watch->handleAction( pWatch, nfile, FILE_ACTION_ADDED ); + skip = true; + } else { + pWatch->Watch->handleAction( pWatch, oldFile, FILE_ACTION_RENAMED_OLD_NAME ); + } + } + + if ( !skip ) { + pWatch->Watch->handleAction( pWatch, nfile, pNotify->Action ); + } + } while ( pNotify->NextEntryOffset != 0 ); +} + +/// Unpacks events and passes them to a user defined callback. +void CALLBACK WatchCallback( DWORD dwNumberOfBytesTransfered, LPOVERLAPPED lpOverlapped ) { + if ( NULL == lpOverlapped ) { + return; + } + + WatcherStructWin32* tWatch = (WatcherStructWin32*)lpOverlapped; + WatcherWin32* pWatch = tWatch->Watch; + + if ( dwNumberOfBytesTransfered == 0 ) { + if ( nullptr != pWatch && !pWatch->StopNow ) { + RefreshWatch( tWatch ); + } else { + return; + } + } + + // Fork watch depending on the Windows API supported + if ( pWatch->Extended ) { + WatchCallbackEx( pWatch ); + } else { + WatchCallbackOld( pWatch ); + } + + if ( !pWatch->StopNow ) { + RefreshWatch( tWatch ); + } +} + +/// Refreshes the directory monitoring. +RefreshResult RefreshWatch( WatcherStructWin32* pWatch ) { + initReadDirectoryChangesEx(); + + bool bRet = false; + RefreshResult ret = RefreshResult::Failed; + pWatch->Watch->Extended = false; + + if ( pReadDirectoryChangesExW ) { + bRet = pReadDirectoryChangesExW( pWatch->Watch->DirHandle, pWatch->Watch->Buffer.data(), + (DWORD)pWatch->Watch->Buffer.size(), pWatch->Watch->Recursive, + pWatch->Watch->NotifyFilter, NULL, &pWatch->Overlapped, + NULL, EFSW_ReadDirectoryNotifyExtendedInformation ) != 0; + if ( bRet ) { + ret = RefreshResult::SucessEx; + pWatch->Watch->Extended = true; + } + } + + if ( !bRet ) { + bRet = ReadDirectoryChangesW( pWatch->Watch->DirHandle, pWatch->Watch->Buffer.data(), + (DWORD)pWatch->Watch->Buffer.size(), pWatch->Watch->Recursive, + pWatch->Watch->NotifyFilter, NULL, &pWatch->Overlapped, + NULL ) != 0; + + if ( bRet ) + ret = RefreshResult::Success; + } + + if ( !bRet ) { + std::string error = std::to_string( GetLastError() ); + Errors::Log::createLastError( Errors::WatcherFailed, error ); + } + + return ret; +} + +/// Stops monitoring a directory. +void DestroyWatch( WatcherStructWin32* pWatch ) { + if ( pWatch ) { + WatcherWin32* tWatch = pWatch->Watch; + tWatch->StopNow = true; + CancelIoEx( pWatch->Watch->DirHandle, &pWatch->Overlapped ); + CloseHandle( pWatch->Watch->DirHandle ); + efSAFE_DELETE_ARRAY( pWatch->Watch->DirName ); + efSAFE_DELETE( pWatch->Watch ); + efSAFE_DELETE( pWatch ); + } +} + +/// Starts monitoring a directory. +WatcherStructWin32* CreateWatch( LPCWSTR szDirectory, bool recursive, + DWORD bufferSize, DWORD notifyFilter, HANDLE iocp ) { + WatcherStructWin32* tWatch = new WatcherStructWin32(); + WatcherWin32* pWatch = new WatcherWin32(bufferSize); + if (tWatch) + tWatch->Watch = pWatch; + + pWatch->DirHandle = CreateFileW( + szDirectory, GENERIC_READ, FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE, NULL, + OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS | FILE_FLAG_OVERLAPPED, NULL ); + + if ( pWatch->DirHandle != INVALID_HANDLE_VALUE && + CreateIoCompletionPort( pWatch->DirHandle, iocp, 0, 1 ) ) { + pWatch->NotifyFilter = notifyFilter; + pWatch->Recursive = recursive; + + if ( RefreshResult::Failed != RefreshWatch( tWatch ) ) { + return tWatch; + } + } + + CloseHandle( pWatch->DirHandle ); + efSAFE_DELETE( pWatch->Watch ); + efSAFE_DELETE( tWatch ); + return NULL; +} + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/WatcherWin32.hpp b/vendor/efsw/src/efsw/WatcherWin32.hpp new file mode 100644 index 0000000..ea1e8e4 --- /dev/null +++ b/vendor/efsw/src/efsw/WatcherWin32.hpp @@ -0,0 +1,79 @@ +#ifndef EFSW_WATCHERWIN32_HPP +#define EFSW_WATCHERWIN32_HPP + +#include +#include +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + +#include + +#ifdef EFSW_COMPILER_MSVC +#pragma comment( lib, "comctl32.lib" ) +#pragma comment( lib, "user32.lib" ) +#pragma comment( lib, "ole32.lib" ) + +// disable secure warnings +#pragma warning( disable : 4996 ) +#endif + +namespace efsw { + +class WatcherWin32; + +enum RefreshResult { Failed, Success, SucessEx }; + +/// Internal watch data +struct WatcherStructWin32 { + OVERLAPPED Overlapped; + WatcherWin32* Watch; +}; + +struct sLastModifiedEvent { + FileInfo file; + std::string fileName; +}; + +RefreshResult RefreshWatch( WatcherStructWin32* pWatch ); + +void CALLBACK WatchCallback( DWORD dwNumberOfBytesTransfered, LPOVERLAPPED lpOverlapped ); + +void DestroyWatch( WatcherStructWin32* pWatch ); + +WatcherStructWin32* CreateWatch( LPCWSTR szDirectory, bool recursive, + DWORD bufferSize, DWORD notifyFilter, HANDLE iocp ); + +class WatcherWin32 : public Watcher { + public: + WatcherWin32(DWORD dwBufferSize) : + Struct( NULL ), + DirHandle( NULL ), + Buffer(), + lParam( 0 ), + NotifyFilter( 0 ), + StopNow( false ), + Extended( false ), + Watch( NULL ), + DirName( NULL ) { + Buffer.resize(dwBufferSize); + } + + WatcherStructWin32* Struct; + HANDLE DirHandle; + std::vector Buffer; + LPARAM lParam; + DWORD NotifyFilter; + bool StopNow; + bool Extended; + FileWatcherImpl* Watch; + char* DirName; + sLastModifiedEvent LastModifiedEvent; + std::vector> OldFiles; +}; + +} // namespace efsw + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/base.hpp b/vendor/efsw/src/efsw/base.hpp new file mode 100644 index 0000000..43abc4f --- /dev/null +++ b/vendor/efsw/src/efsw/base.hpp @@ -0,0 +1,129 @@ +#ifndef EFSW_BASE +#define EFSW_BASE + +#include +#include + +namespace efsw { + +typedef SOPHIST_int8 Int8; +typedef SOPHIST_uint8 Uint8; +typedef SOPHIST_int16 Int16; +typedef SOPHIST_uint16 Uint16; +typedef SOPHIST_int32 Int32; +typedef SOPHIST_uint32 Uint32; +typedef SOPHIST_int64 Int64; +typedef SOPHIST_uint64 Uint64; + +#define EFSW_OS_WIN 1 +#define EFSW_OS_LINUX 2 +#define EFSW_OS_MACOSX 3 +#define EFSW_OS_BSD 4 +#define EFSW_OS_SOLARIS 5 +#define EFSW_OS_HAIKU 6 +#define EFSW_OS_ANDROID 7 +#define EFSW_OS_IOS 8 + +#define EFSW_PLATFORM_WIN32 1 +#define EFSW_PLATFORM_INOTIFY 2 +#define EFSW_PLATFORM_KQUEUE 3 +#define EFSW_PLATFORM_FSEVENTS 4 +#define EFSW_PLATFORM_GENERIC 5 + +#if defined( _WIN32 ) +/// Any Windows platform +#define EFSW_OS EFSW_OS_WIN +#define EFSW_PLATFORM EFSW_PLATFORM_WIN32 + +#if ( defined( _MSCVER ) || defined( _MSC_VER ) ) +#define EFSW_COMPILER_MSVC +#endif + +/// Force windows target version above or equal to Windows Server 2008 or Windows Vista +#if _WIN32_WINNT < 0x600 +#undef _WIN32_WINNT +#define _WIN32_WINNT 0x600 +#endif +#elif defined( __FreeBSD__ ) || defined( __OpenBSD__ ) || defined( __NetBSD__ ) || \ + defined( __DragonFly__ ) +#define EFSW_OS EFSW_OS_BSD +#define EFSW_PLATFORM EFSW_PLATFORM_KQUEUE + +#elif defined( __APPLE_CC__ ) || defined( __APPLE__ ) +#include + +#if defined( __IPHONE__ ) || ( defined( TARGET_OS_IPHONE ) && TARGET_OS_IPHONE ) || \ + ( defined( TARGET_IPHONE_SIMULATOR ) && TARGET_IPHONE_SIMULATOR ) +#define EFSW_OS EFSW_OS_IOS +#define EFSW_PLATFORM EFSW_PLATFORM_KQUEUE +#else +#define EFSW_OS EFSW_OS_MACOSX + +#if defined( EFSW_FSEVENTS_NOT_SUPPORTED ) +#define EFSW_PLATFORM EFSW_PLATFORM_KQUEUE +#else +#define EFSW_PLATFORM EFSW_PLATFORM_FSEVENTS +#endif +#endif + +#elif defined( __linux__ ) +/// This includes Linux and Android +#ifndef EFSW_KQUEUE +#define EFSW_PLATFORM EFSW_PLATFORM_INOTIFY +#else +/// This is for testing libkqueue, sadly it doesnt work +#define EFSW_PLATFORM EFSW_PLATFORM_KQUEUE +#endif + +#if defined( __ANDROID__ ) || defined( ANDROID ) +#define EFSW_OS EFSW_OS_ANDROID +#else +#define EFSW_OS EFSW_OS_LINUX +#endif + +#else +#if defined( __SVR4 ) +#define EFSW_OS EFSW_OS_SOLARIS +#elif defined( __HAIKU__ ) || defined( __BEOS__ ) +#define EFSW_OS EFSW_OS_HAIKU +#endif + +/// Everything else +#define EFSW_PLATFORM EFSW_PLATFORM_GENERIC +#endif + +#if EFSW_PLATFORM != EFSW_PLATFORM_WIN32 +#define EFSW_PLATFORM_POSIX +#endif + +#if 1 == SOPHIST_pointer64 +#define EFSW_64BIT +#else +#define EFSW_32BIT +#endif + +#if defined( arm ) || defined( __arm__ ) +#define EFSW_ARM +#endif + +#define efCOMMA , + +#define efSAFE_DELETE( p ) \ + { \ + if ( p ) { \ + delete ( p ); \ + ( p ) = NULL; \ + } \ + } +#define efSAFE_DELETE_ARRAY( p ) \ + { \ + if ( p ) { \ + delete[] ( p ); \ + ( p ) = NULL; \ + } \ + } +#define efARRAY_SIZE( __array ) ( sizeof( __array ) / sizeof( __array[0] ) ) + +} // namespace efsw + +#endif diff --git a/vendor/efsw/src/efsw/inotify-nosys.h b/vendor/efsw/src/efsw/inotify-nosys.h new file mode 100644 index 0000000..be1e627 --- /dev/null +++ b/vendor/efsw/src/efsw/inotify-nosys.h @@ -0,0 +1,164 @@ +#ifndef _LINUX_INOTIFY_H +#define _LINUX_INOTIFY_H + +#include +#include +#include + +/* + * struct inotify_event - structure read from the inotify device for each event + * + * When you are watching a directory, you will receive the filename for events + * such as IN_CREATE, IN_DELETE, IN_OPEN, IN_CLOSE, ..., relative to the wd. + */ +struct inotify_event { + int wd; /* watch descriptor */ + uint32_t mask; /* watch mask */ + uint32_t cookie; /* cookie to synchronize two events */ + uint32_t len; /* length (including nulls) of name */ + char name __flexarr; /* stub for possible name */ +}; + +/* the following are legal, implemented events that user-space can watch for */ +#define IN_ACCESS 0x00000001 /* File was accessed */ +#define IN_MODIFY 0x00000002 /* File was modified */ +#define IN_ATTRIB 0x00000004 /* Metadata changed */ +#define IN_CLOSE_WRITE 0x00000008 /* Writtable file was closed */ +#define IN_CLOSE_NOWRITE 0x00000010 /* Unwrittable file closed */ +#define IN_OPEN 0x00000020 /* File was opened */ +#define IN_MOVED_FROM 0x00000040 /* File was moved from X */ +#define IN_MOVED_TO 0x00000080 /* File was moved to Y */ +#define IN_CREATE 0x00000100 /* Subfile was created */ +#define IN_DELETE 0x00000200 /* Subfile was deleted */ +#define IN_DELETE_SELF 0x00000400 /* Self was deleted */ +#define IN_MOVE_SELF 0x00000800 /* Self was moved */ + +/* the following are legal events. they are sent as needed to any watch */ +#define IN_UNMOUNT 0x00002000 /* Backing fs was unmounted */ +#define IN_Q_OVERFLOW 0x00004000 /* Event queued overflowed */ +#define IN_IGNORED 0x00008000 /* File was ignored */ + +/* helper events */ +#define IN_CLOSE (IN_CLOSE_WRITE | IN_CLOSE_NOWRITE) /* close */ +#define IN_MOVE (IN_MOVED_FROM | IN_MOVED_TO) /* moves */ + +/* special flags */ +#define IN_ONLYDIR 0x01000000 /* only watch the path if it is a directory */ +#define IN_DONT_FOLLOW 0x02000000 /* don't follow a sym link */ +#define IN_MASK_ADD 0x20000000 /* add to the mask of an already existing watch */ +#define IN_ISDIR 0x40000000 /* event occurred against dir */ +#define IN_ONESHOT 0x80000000 /* only send event once */ + +/* + * All of the events - we build the list by hand so that we can add flags in + * the future and not break backward compatibility. Apps will get only the + * events that they originally wanted. Be sure to add new events here! + */ +#define IN_ALL_EVENTS (IN_ACCESS | IN_MODIFY | IN_ATTRIB | IN_CLOSE_WRITE | \ + IN_CLOSE_NOWRITE | IN_OPEN | IN_MOVED_FROM | \ + IN_MOVED_TO | IN_DELETE | IN_CREATE | IN_DELETE_SELF | \ + IN_MOVE_SELF) + +#if defined (__alpha__) +# define __NR_inotify_init 444 +# define __NR_inotify_add_watch 445 +# define __NR_inotify_rm_watch 446 + +#elif defined (__arm__) +# define __NR_inotify_init (__NR_SYSCALL_BASE+316) +# define __NR_inotify_add_watch (__NR_SYSCALL_BASE+317) +# define __NR_inotify_rm_watch (__NR_SYSCALL_BASE+318) + +#elif defined (__aarch64__) +# define __NR_inotify_init 1043 +# define __NR_inotify_add_watch 27 +# define __NR_inotify_rm_watch 28 + +#elif defined (__frv__) +# define __NR_inotify_init 291 +# define __NR_inotify_add_watch 292 +# define __NR_inotify_rm_watch 293 + +#elif defined(__i386__) +# define __NR_inotify_init 291 +# define __NR_inotify_add_watch 292 +# define __NR_inotify_rm_watch 293 + +#elif defined (__ia64__) +# define __NR_inotify_init 1277 +# define __NR_inotify_add_watch 1278 +# define __NR_inotify_rm_watch 1279 + +#elif defined (__mips__) +# if _MIPS_SIM == _MIPS_SIM_ABI32 +# define __NR_inotify_init (__NR_Linux + 284) +# define __NR_inotify_add_watch (__NR_Linux + 285) +# define __NR_inotify_rm_watch (__NR_Linux + 286) +# endif +# if _MIPS_SIM == _MIPS_SIM_ABI64 +# define __NR_inotify_init (__NR_Linux + 243) +# define __NR_inotify_add_watch (__NR_Linux + 243) +# define __NR_inotify_rm_watch (__NR_Linux + 243) +# endif +# if _MIPS_SIM == _MIPS_SIM_NABI32 +# define __NR_inotify_init (__NR_Linux + 247) +# define __NR_inotify_add_watch (__NR_Linux + 248) +# define __NR_inotify_rm_watch (__NR_Linux + 249) +# endif + +#elif defined(__parisc__) +# define __NR_inotify_init (__NR_Linux + 269) +# define __NR_inotify_add_watch (__NR_Linux + 270) +# define __NR_inotify_rm_watch (__NR_Linux + 271) + +#elif defined(__powerpc__) || defined(__powerpc64__) +# define __NR_inotify_init 275 +# define __NR_inotify_add_watch 276 +# define __NR_inotify_rm_watch 277 + +#elif defined (__s390__) +# define __NR_inotify_init 284 +# define __NR_inotify_add_watch 285 +# define __NR_inotify_rm_watch 286 + +#elif defined (__sh__) +# define __NR_inotify_init 290 +# define __NR_inotify_add_watch 291 +# define __NR_inotify_rm_watch 292 + +#elif defined (__sh64__) +# define __NR_inotify_init 318 +# define __NR_inotify_add_watch 319 +# define __NR_inotify_rm_watch 320 + +#elif defined (__sparc__) || defined (__sparc64__) +# define __NR_inotify_init 151 +# define __NR_inotify_add_watch 152 +# define __NR_inotify_rm_watch 156 + +#elif defined(__x86_64__) +# define __NR_inotify_init 253 +# define __NR_inotify_add_watch 254 +# define __NR_inotify_rm_watch 255 + +#else +# error "Unsupported architecture!" +#endif + +static inline int inotify_init (void) +{ + return syscall (__NR_inotify_init); +} + +static inline int inotify_add_watch (int fd, const char *name, uint32_t mask) +{ + return syscall (__NR_inotify_add_watch, fd, name, mask); +} + +static inline int inotify_rm_watch (int fd, uint32_t wd) +{ + return syscall (__NR_inotify_rm_watch, fd, wd); +} + + +#endif /* _LINUX_INOTIFY_H */ diff --git a/vendor/efsw/src/efsw/platform/platformimpl.hpp b/vendor/efsw/src/efsw/platform/platformimpl.hpp new file mode 100644 index 0000000..5442580 --- /dev/null +++ b/vendor/efsw/src/efsw/platform/platformimpl.hpp @@ -0,0 +1,20 @@ +#ifndef EFSW_PLATFORMIMPL_HPP +#define EFSW_PLATFORMIMPL_HPP + +#include + +#if defined( EFSW_PLATFORM_POSIX ) +#include +#include +#include +#include +#elif EFSW_PLATFORM == EFSW_PLATFORM_WIN32 +#include +#include +#include +#include +#else +#error Thread, Mutex, and System not implemented for this platform. +#endif + +#endif diff --git a/vendor/efsw/src/efsw/platform/posix/FileSystemImpl.cpp b/vendor/efsw/src/efsw/platform/posix/FileSystemImpl.cpp new file mode 100644 index 0000000..92eeb47 --- /dev/null +++ b/vendor/efsw/src/efsw/platform/posix/FileSystemImpl.cpp @@ -0,0 +1,251 @@ +#include + +#if defined( EFSW_PLATFORM_POSIX ) + +#include +#include +#include +#include +#include + +#ifndef _DARWIN_FEATURE_64_BIT_INODE +#define _DARWIN_FEATURE_64_BIT_INODE +#endif + +#ifndef _FILE_OFFSET_BITS +#define _FILE_OFFSET_BITS 64 +#endif + +#include +#include +#include + +#if EFSW_OS == EFSW_OS_LINUX || EFSW_OS == EFSW_OS_SOLARIS || EFSW_OS == EFSW_OS_ANDROID +#include +#elif EFSW_OS == EFSW_OS_MACOSX || EFSW_OS == EFSW_OS_BSD || EFSW_OS == EFSW_OS_IOS +#include +#include +#endif + +/** Remote file systems codes */ +#define S_MAGIC_AFS 0x5346414F +#define S_MAGIC_AUFS 0x61756673 +#define S_MAGIC_CEPH 0x00C36400 +#define S_MAGIC_CIFS 0xFF534D42 +#define S_MAGIC_CODA 0x73757245 +#define S_MAGIC_FHGFS 0x19830326 +#define S_MAGIC_FUSEBLK 0x65735546 +#define S_MAGIC_FUSECTL 0x65735543 +#define S_MAGIC_GFS 0x01161970 +#define S_MAGIC_GPFS 0x47504653 +#define S_MAGIC_KAFS 0x6B414653 +#define S_MAGIC_LUSTRE 0x0BD00BD0 +#define S_MAGIC_NCP 0x564C +#define S_MAGIC_NFS 0x6969 +#define S_MAGIC_NFSD 0x6E667364 +#define S_MAGIC_OCFS2 0x7461636F +#define S_MAGIC_PANFS 0xAAD7AAEA +#define S_MAGIC_PIPEFS 0x50495045 +#define S_MAGIC_SMB 0x517B +#define S_MAGIC_SNFS 0xBEEFDEAD +#define S_MAGIC_VMHGFS 0xBACBACBC +#define S_MAGIC_VXFS 0xA501FCF5 + +#if EFSW_OS == EFSW_OS_LINUX +#include +#include +#endif + +namespace efsw { namespace Platform { + +#if EFSW_OS == EFSW_OS_LINUX + +std::string findMountPoint( std::string file ) { + std::string cwd = FileSystem::getCurrentWorkingDirectory(); + struct stat last_stat; + struct stat file_stat; + + stat( file.c_str(), &file_stat ); + + std::string mp; + + if ( efsw::FileSystem::isDirectory( file ) ) { + last_stat = file_stat; + + if ( !FileSystem::changeWorkingDirectory( file ) ) + return ""; + } else { + std::string dir = efsw::FileSystem::pathRemoveFileName( file ); + + if ( !FileSystem::changeWorkingDirectory( dir ) ) + return ""; + + if ( stat( ".", &last_stat ) < 0 ) + return ""; + } + + while ( true ) { + struct stat st; + + if ( stat( "..", &st ) < 0 ) + goto done; + + if ( st.st_dev != last_stat.st_dev || st.st_ino == last_stat.st_ino ) + break; + + if ( !FileSystem::changeWorkingDirectory( ".." ) ) { + goto done; + } + + last_stat = st; + } + + /* Finally reached a mount point, see what it's called. */ + mp = FileSystem::getCurrentWorkingDirectory(); + +done: + FileSystem::changeWorkingDirectory( cwd ); + + return mp; +} + +std::string findDevicePath( const std::string& directory ) { + struct mntent* ent; + FILE* aFile; + + aFile = setmntent( "/proc/mounts", "r" ); + + if ( aFile == NULL ) + return ""; + + while ( NULL != ( ent = getmntent( aFile ) ) ) { + std::string dirName( ent->mnt_dir ); + + if ( dirName == directory ) { + std::string fsName( ent->mnt_fsname ); + + endmntent( aFile ); + + return fsName; + } + } + + endmntent( aFile ); + + return ""; +} + +bool isLocalFUSEDirectory( std::string directory ) { + efsw::FileSystem::dirRemoveSlashAtEnd( directory ); + + directory = findMountPoint( directory ); + + if ( !directory.empty() ) { + std::string devicePath = findDevicePath( directory ); + + return !devicePath.empty(); + } + + return false; +} + +#endif + +bool FileSystem::changeWorkingDirectory( const std::string& path ) { + return -1 != chdir( path.c_str() ); +} + +std::string FileSystem::getCurrentWorkingDirectory() { + char dir[PATH_MAX + 1]; + char* result = getcwd( dir, PATH_MAX + 1 ); + return result != NULL ? std::string( result ) : std::string(); +} + +FileInfoMap FileSystem::filesInfoFromPath( const std::string& path ) { + FileInfoMap files; + + DIR* dp; + struct dirent* dirp; + + if ( ( dp = opendir( path.c_str() ) ) == NULL ) + return files; + + while ( ( dirp = readdir( dp ) ) != NULL ) { + if ( strcmp( dirp->d_name, ".." ) != 0 && strcmp( dirp->d_name, "." ) != 0 ) { + std::string name( dirp->d_name ); + std::string fpath( path + name ); + + files[name] = FileInfo( fpath ); + } + } + + closedir( dp ); + + return files; +} + +char FileSystem::getOSSlash() { + return '/'; +} + +bool FileSystem::isDirectory( const std::string& path ) { + struct stat st; + int res = stat( path.c_str(), &st ); + + if ( 0 == res ) { + return static_cast( S_ISDIR( st.st_mode ) ); + } + + return false; +} + +bool FileSystem::isRemoteFS( const std::string& directory ) { +#if EFSW_OS == EFSW_OS_LINUX || EFSW_OS == EFSW_OS_MACOSX || EFSW_OS == EFSW_OS_BSD || \ + EFSW_OS == EFSW_OS_SOLARIS || EFSW_OS == EFSW_OS_ANDROID || EFSW_OS == EFSW_OS_IOS + struct statfs statfsbuf; + + statfs( directory.c_str(), &statfsbuf ); + + switch ( statfsbuf.f_type | 0UL ) { + case S_MAGIC_FUSEBLK: /* 0x65735546 remote */ + { +#if EFSW_OS == EFSW_OS_LINUX + return !isLocalFUSEDirectory( directory ); +#endif + } + case S_MAGIC_AFS: /* 0x5346414F remote */ + case S_MAGIC_AUFS: /* 0x61756673 remote */ + case S_MAGIC_CEPH: /* 0x00C36400 remote */ + case S_MAGIC_CIFS: /* 0xFF534D42 remote */ + case S_MAGIC_CODA: /* 0x73757245 remote */ + case S_MAGIC_FHGFS: /* 0x19830326 remote */ + case S_MAGIC_FUSECTL: /* 0x65735543 remote */ + case S_MAGIC_GFS: /* 0x01161970 remote */ + case S_MAGIC_GPFS: /* 0x47504653 remote */ + case S_MAGIC_KAFS: /* 0x6B414653 remote */ + case S_MAGIC_LUSTRE: /* 0x0BD00BD0 remote */ + case S_MAGIC_NCP: /* 0x564C remote */ + case S_MAGIC_NFS: /* 0x6969 remote */ + case S_MAGIC_NFSD: /* 0x6E667364 remote */ + case S_MAGIC_OCFS2: /* 0x7461636F remote */ + case S_MAGIC_PANFS: /* 0xAAD7AAEA remote */ + case S_MAGIC_PIPEFS: /* 0x50495045 remote */ + case S_MAGIC_SMB: /* 0x517B remote */ + case S_MAGIC_SNFS: /* 0xBEEFDEAD remote */ + case S_MAGIC_VMHGFS: /* 0xBACBACBC remote */ + case S_MAGIC_VXFS: /* 0xA501FCF5 remote */ + { + return true; + } + default: { + return false; + } + } +#endif + + return false; +} + +}} // namespace efsw::Platform + +#endif diff --git a/vendor/efsw/src/efsw/platform/posix/FileSystemImpl.hpp b/vendor/efsw/src/efsw/platform/posix/FileSystemImpl.hpp new file mode 100644 index 0000000..0bfba76 --- /dev/null +++ b/vendor/efsw/src/efsw/platform/posix/FileSystemImpl.hpp @@ -0,0 +1,30 @@ +#ifndef EFSW_FILESYSTEMIMPLPOSIX_HPP +#define EFSW_FILESYSTEMIMPLPOSIX_HPP + +#include +#include + +#if defined( EFSW_PLATFORM_POSIX ) + +namespace efsw { namespace Platform { + +class FileSystem { + public: + static FileInfoMap filesInfoFromPath( const std::string& path ); + + static char getOSSlash(); + + static bool isDirectory( const std::string& path ); + + static bool isRemoteFS( const std::string& directory ); + + static bool changeWorkingDirectory( const std::string& path ); + + static std::string getCurrentWorkingDirectory(); +}; + +}} // namespace efsw::Platform + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/platform/posix/MutexImpl.cpp b/vendor/efsw/src/efsw/platform/posix/MutexImpl.cpp new file mode 100644 index 0000000..2233798 --- /dev/null +++ b/vendor/efsw/src/efsw/platform/posix/MutexImpl.cpp @@ -0,0 +1,28 @@ +#include + +#if defined( EFSW_PLATFORM_POSIX ) + +namespace efsw { namespace Platform { + +MutexImpl::MutexImpl() { + pthread_mutexattr_t attributes; + pthread_mutexattr_init( &attributes ); + pthread_mutexattr_settype( &attributes, PTHREAD_MUTEX_RECURSIVE ); + pthread_mutex_init( &mMutex, &attributes ); +} + +MutexImpl::~MutexImpl() { + pthread_mutex_destroy( &mMutex ); +} + +void MutexImpl::lock() { + pthread_mutex_lock( &mMutex ); +} + +void MutexImpl::unlock() { + pthread_mutex_unlock( &mMutex ); +} + +}} // namespace efsw::Platform + +#endif diff --git a/vendor/efsw/src/efsw/platform/posix/MutexImpl.hpp b/vendor/efsw/src/efsw/platform/posix/MutexImpl.hpp new file mode 100644 index 0000000..a33d827 --- /dev/null +++ b/vendor/efsw/src/efsw/platform/posix/MutexImpl.hpp @@ -0,0 +1,30 @@ +#ifndef EFSW_MUTEXIMPLPOSIX_HPP +#define EFSW_MUTEXIMPLPOSIX_HPP + +#include + +#if defined( EFSW_PLATFORM_POSIX ) + +#include + +namespace efsw { namespace Platform { + +class MutexImpl { + public: + MutexImpl(); + + ~MutexImpl(); + + void lock(); + + void unlock(); + + private: + pthread_mutex_t mMutex; +}; + +}} // namespace efsw::Platform + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/platform/posix/SystemImpl.cpp b/vendor/efsw/src/efsw/platform/posix/SystemImpl.cpp new file mode 100644 index 0000000..37d4120 --- /dev/null +++ b/vendor/efsw/src/efsw/platform/posix/SystemImpl.cpp @@ -0,0 +1,168 @@ +#include + +#if defined( EFSW_PLATFORM_POSIX ) + +#include +#include +#include +#include +#include + +#include +#include + +#if EFSW_OS == EFSW_OS_MACOSX +#include +#elif EFSW_OS == EFSW_OS_LINUX || EFSW_OS == EFSW_OS_ANDROID +#include +#include +#elif EFSW_OS == EFSW_OS_HAIKU +#include +#include +#elif EFSW_OS == EFSW_OS_SOLARIS +#include +#elif EFSW_OS == EFSW_OS_BSD +#include +#endif + +namespace efsw { namespace Platform { + +void System::sleep( const unsigned long& ms ) { + // usleep( static_cast( ms * 1000 ) ); + + // usleep is not reliable enough (it might block the + // whole process instead of just the current thread) + // so we must use pthread_cond_timedwait instead + + // this implementation is inspired from Qt + // and taken from SFML + + unsigned long long usecs = ms * 1000; + + // get the current time + timeval tv; + gettimeofday( &tv, NULL ); + + // construct the time limit (current time + time to wait) + timespec ti; + ti.tv_nsec = ( tv.tv_usec + ( usecs % 1000000 ) ) * 1000; + ti.tv_sec = tv.tv_sec + ( usecs / 1000000 ) + ( ti.tv_nsec / 1000000000 ); + ti.tv_nsec %= 1000000000; + + // create a mutex and thread condition + pthread_mutex_t mutex; + pthread_mutex_init( &mutex, 0 ); + pthread_cond_t condition; + pthread_cond_init( &condition, 0 ); + + // wait... + pthread_mutex_lock( &mutex ); + pthread_cond_timedwait( &condition, &mutex, &ti ); + pthread_mutex_unlock( &mutex ); + + // destroy the mutex and condition + pthread_cond_destroy( &condition ); +} + +std::string System::getProcessPath() { +#if EFSW_OS == EFSW_OS_MACOSX + char exe_file[FILENAME_MAX + 1]; + + CFBundleRef mainBundle = CFBundleGetMainBundle(); + + if ( mainBundle ) { + CFURLRef mainURL = CFBundleCopyBundleURL( mainBundle ); + + if ( mainURL ) { + int ok = CFURLGetFileSystemRepresentation( mainURL, ( Boolean ) true, (UInt8*)exe_file, + FILENAME_MAX ); + + if ( ok ) { + return std::string( exe_file ) + "/"; + } + } + } + + return "./"; +#elif EFSW_OS == EFSW_OS_LINUX + char exe_file[FILENAME_MAX + 1]; + + int size; + + size = readlink( "/proc/self/exe", exe_file, FILENAME_MAX ); + + if ( size < 0 ) { + return std::string( "./" ); + } else { + exe_file[size] = '\0'; + return std::string( dirname( exe_file ) ) + "/"; + } + +#elif EFSW_OS == EFSW_OS_BSD + int mib[4]; + mib[0] = CTL_KERN; + mib[1] = KERN_PROC; + mib[2] = KERN_PROC_PATHNAME; + mib[3] = -1; + char buf[1024]; + size_t cb = sizeof( buf ); + sysctl( mib, 4, buf, &cb, NULL, 0 ); + + return FileSystem::pathRemoveFileName( std::string( buf ) ); + +#elif EFSW_OS == EFSW_OS_SOLARIS + return FileSystem::pathRemoveFileName( std::string( getexecname() ) ); + +#elif EFSW_OS == EFSW_OS_HAIKU + image_info info; + int32 cookie = 0; + + while ( B_OK == get_next_image_info( 0, &cookie, &info ) ) { + if ( info.type == B_APP_IMAGE ) + break; + } + + return FileSystem::pathRemoveFileName( std::string( info.name ) ); + +#elif EFSW_OS == EFSW_OS_ANDROID + return "/sdcard/"; + +#else +#warning getProcessPath() not implemented on this platform. ( will return "./" ) + return "./"; + +#endif +} + +void System::maxFD() { + static bool maxed = false; + + if ( !maxed ) { + struct rlimit limit; + getrlimit( RLIMIT_NOFILE, &limit ); + limit.rlim_cur = limit.rlim_max; + setrlimit( RLIMIT_NOFILE, &limit ); + + getrlimit( RLIMIT_NOFILE, &limit ); + + efDEBUG( "File descriptor limit %ld\n", limit.rlim_cur ); + + maxed = true; + } +} + +Uint64 System::getMaxFD() { + static rlim_t max_fd = 0; + + if ( max_fd == 0 ) { + struct rlimit limit; + getrlimit( RLIMIT_NOFILE, &limit ); + max_fd = limit.rlim_cur; + } + + return max_fd; +} + +}} // namespace efsw::Platform + +#endif diff --git a/vendor/efsw/src/efsw/platform/posix/SystemImpl.hpp b/vendor/efsw/src/efsw/platform/posix/SystemImpl.hpp new file mode 100644 index 0000000..9322b06 --- /dev/null +++ b/vendor/efsw/src/efsw/platform/posix/SystemImpl.hpp @@ -0,0 +1,25 @@ +#ifndef EFSW_SYSTEMIMPLPOSIX_HPP +#define EFSW_SYSTEMIMPLPOSIX_HPP + +#include + +#if defined( EFSW_PLATFORM_POSIX ) + +namespace efsw { namespace Platform { + +class System { + public: + static void sleep( const unsigned long& ms ); + + static std::string getProcessPath(); + + static void maxFD(); + + static Uint64 getMaxFD(); +}; + +}} // namespace efsw::Platform + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/platform/posix/ThreadImpl.cpp b/vendor/efsw/src/efsw/platform/posix/ThreadImpl.cpp new file mode 100644 index 0000000..0f96bca --- /dev/null +++ b/vendor/efsw/src/efsw/platform/posix/ThreadImpl.cpp @@ -0,0 +1,62 @@ +#include +#include + +#if defined( EFSW_PLATFORM_POSIX ) + +#include +#include +#include + +namespace efsw { namespace Platform { + +ThreadImpl::ThreadImpl( efsw::Thread* owner ) : mIsActive( false ) { + mIsActive = pthread_create( &mThread, NULL, &ThreadImpl::entryPoint, owner ) == 0; + + if ( !mIsActive ) { + efDEBUG( "Failed to create thread\n" ); + } +} + +ThreadImpl::~ThreadImpl() { + terminate(); +} + +void ThreadImpl::wait() { + // Wait for the thread to finish, no timeout + if ( mIsActive ) { + assert( pthread_equal( pthread_self(), mThread ) == 0 ); + + mIsActive = pthread_join( mThread, NULL ) != 0; + } +} + +void ThreadImpl::terminate() { + if ( mIsActive ) { +#if !defined( __ANDROID__ ) && !defined( ANDROID ) + pthread_cancel( mThread ); +#else + pthread_kill( mThread, SIGUSR1 ); +#endif + + mIsActive = false; + } +} + +void* ThreadImpl::entryPoint( void* userData ) { +// Tell the thread to handle cancel requests immediatly +#ifdef PTHREAD_CANCEL_ASYNCHRONOUS + pthread_setcanceltype( PTHREAD_CANCEL_ASYNCHRONOUS, NULL ); +#endif + + // The Thread instance is stored in the user data + Thread* owner = static_cast( userData ); + + // Forward to the owner + owner->run(); + + return NULL; +} + +}} // namespace efsw::Platform + +#endif diff --git a/vendor/efsw/src/efsw/platform/posix/ThreadImpl.hpp b/vendor/efsw/src/efsw/platform/posix/ThreadImpl.hpp new file mode 100644 index 0000000..2e02f9a --- /dev/null +++ b/vendor/efsw/src/efsw/platform/posix/ThreadImpl.hpp @@ -0,0 +1,39 @@ +#ifndef EFSW_THREADIMPLPOSIX_HPP +#define EFSW_THREADIMPLPOSIX_HPP + +#include + +#if defined( EFSW_PLATFORM_POSIX ) + +#include +#include + +namespace efsw { + +class Thread; + +namespace Platform { + +class ThreadImpl { + public: + explicit ThreadImpl( efsw::Thread* owner ); + + ~ThreadImpl(); + + void wait(); + + void terminate(); + + protected: + static void* entryPoint( void* userData ); + + pthread_t mThread; + Atomic mIsActive; +}; + +} // namespace Platform +} // namespace efsw + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/platform/win/FileSystemImpl.cpp b/vendor/efsw/src/efsw/platform/win/FileSystemImpl.cpp new file mode 100644 index 0000000..2b87513 --- /dev/null +++ b/vendor/efsw/src/efsw/platform/win/FileSystemImpl.cpp @@ -0,0 +1,111 @@ +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + +#include +#ifndef WIN32_LEAN_AND_MEAN +#define WIN32_LEAN_AND_MEAN +#endif +#include + +#ifndef EFSW_COMPILER_MSVC +#include +#else +#include +#endif + +namespace efsw { namespace Platform { + +bool FileSystem::changeWorkingDirectory( const std::string& path ) { + int res; +#ifdef EFSW_COMPILER_MSVC +#ifdef UNICODE + res = _wchdir( String::fromUtf8( path.c_str() ).toWideString().c_str() ); +#else + res = _chdir( String::fromUtf8( path.c_str() ).toAnsiString().c_str() ); +#endif +#else + res = chdir( path.c_str() ); +#endif + return -1 != res; +} + +std::string FileSystem::getCurrentWorkingDirectory() { +#ifdef EFSW_COMPILER_MSVC +#if defined( UNICODE ) && !defined( EFSW_NO_WIDECHAR ) + wchar_t dir[_MAX_PATH]; + return ( 0 != GetCurrentDirectoryW( _MAX_PATH, dir ) ) ? String( dir ).toUtf8() : std::string(); +#else + char dir[_MAX_PATH]; + return ( 0 != GetCurrentDirectory( _MAX_PATH, dir ) ) ? String( dir, std::locale() ).toUtf8() + : std::string(); +#endif +#else + char dir[PATH_MAX + 1]; + getcwd( dir, PATH_MAX + 1 ); + return std::string( dir ); +#endif +} + +FileInfoMap FileSystem::filesInfoFromPath( const std::string& path ) { + FileInfoMap files; + + String tpath( path ); + + if ( tpath[tpath.size() - 1] == '/' || tpath[tpath.size() - 1] == '\\' ) { + tpath += "*"; + } else { + tpath += "\\*"; + } + + WIN32_FIND_DATAW findFileData; + HANDLE hFind = FindFirstFileW( (LPCWSTR)tpath.toWideString().c_str(), &findFileData ); + + if ( hFind != INVALID_HANDLE_VALUE ) { + std::string name( String( findFileData.cFileName ).toUtf8() ); + std::string fpath( path + name ); + + if ( name != "." && name != ".." ) { + files[name] = FileInfo( fpath ); + } + + while ( FindNextFileW( hFind, &findFileData ) ) { + name = String( findFileData.cFileName ).toUtf8(); + fpath = path + name; + + if ( name != "." && name != ".." ) { + files[name] = FileInfo( fpath ); + } + } + + FindClose( hFind ); + } + + return files; +} + +char FileSystem::getOSSlash() { + return '\\'; +} + +bool FileSystem::isDirectory( const std::string& path ) { + DWORD attrs = GetFileAttributesW( String( path ).toWideString().c_str() ); + return attrs != INVALID_FILE_ATTRIBUTES && ( attrs & FILE_ATTRIBUTE_DIRECTORY ) != 0; +} + +bool FileSystem::isRemoteFS( const std::string& directory ) { + if ( ( directory[0] == '\\' || directory[0] == '/' ) && + ( directory[1] == '\\' || directory[1] == '/' ) ) { + return true; + } + + if ( directory.size() >= 3 ) { + return 4 == GetDriveTypeA( directory.substr( 0, 3 ).c_str() ); + } + + return false; +} + +}} // namespace efsw::Platform + +#endif diff --git a/vendor/efsw/src/efsw/platform/win/FileSystemImpl.hpp b/vendor/efsw/src/efsw/platform/win/FileSystemImpl.hpp new file mode 100644 index 0000000..e952efc --- /dev/null +++ b/vendor/efsw/src/efsw/platform/win/FileSystemImpl.hpp @@ -0,0 +1,31 @@ +#ifndef EFSW_FILESYSTEMIMPLWIN_HPP +#define EFSW_FILESYSTEMIMPLWIN_HPP + +#include +#include +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + +namespace efsw { namespace Platform { + +class FileSystem { + public: + static FileInfoMap filesInfoFromPath( const std::string& path ); + + static char getOSSlash(); + + static bool isDirectory( const std::string& path ); + + static bool isRemoteFS( const std::string& directory ); + + static bool changeWorkingDirectory( const std::string& path ); + + static std::string getCurrentWorkingDirectory(); +}; + +}} // namespace efsw::Platform + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/platform/win/MutexImpl.cpp b/vendor/efsw/src/efsw/platform/win/MutexImpl.cpp new file mode 100644 index 0000000..62b7f83 --- /dev/null +++ b/vendor/efsw/src/efsw/platform/win/MutexImpl.cpp @@ -0,0 +1,25 @@ +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + +namespace efsw { namespace Platform { + +MutexImpl::MutexImpl() { + InitializeCriticalSection( &mMutex ); +} + +MutexImpl::~MutexImpl() { + DeleteCriticalSection( &mMutex ); +} + +void MutexImpl::lock() { + EnterCriticalSection( &mMutex ); +} + +void MutexImpl::unlock() { + LeaveCriticalSection( &mMutex ); +} + +}} // namespace efsw::Platform + +#endif diff --git a/vendor/efsw/src/efsw/platform/win/MutexImpl.hpp b/vendor/efsw/src/efsw/platform/win/MutexImpl.hpp new file mode 100644 index 0000000..7b06492 --- /dev/null +++ b/vendor/efsw/src/efsw/platform/win/MutexImpl.hpp @@ -0,0 +1,33 @@ +#ifndef EFSW_MUTEXIMPLWIN_HPP +#define EFSW_MUTEXIMPLWIN_HPP + +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + +#ifndef WIN32_LEAN_AND_MEAN +#define WIN32_LEAN_AND_MEAN +#endif +#include + +namespace efsw { namespace Platform { + +class MutexImpl { + public: + MutexImpl(); + + ~MutexImpl(); + + void lock(); + + void unlock(); + + private: + CRITICAL_SECTION mMutex; +}; + +}} // namespace efsw::Platform + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/platform/win/SystemImpl.cpp b/vendor/efsw/src/efsw/platform/win/SystemImpl.cpp new file mode 100644 index 0000000..d1f2b21 --- /dev/null +++ b/vendor/efsw/src/efsw/platform/win/SystemImpl.cpp @@ -0,0 +1,46 @@ +#include +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + +#ifndef WIN32_LEAN_AND_MEAN +#define WIN32_LEAN_AND_MEAN +#endif +#include +#include + +namespace efsw { namespace Platform { + +void System::sleep( const unsigned long& ms ) { + ::Sleep( ms ); +} + +std::string System::getProcessPath() { + // Get path to executable: + WCHAR szDrive[_MAX_DRIVE]; + WCHAR szDir[_MAX_DIR]; + WCHAR szFilename[_MAX_DIR]; + WCHAR szExt[_MAX_DIR]; + std::wstring dllName( _MAX_DIR, 0 ); + + GetModuleFileNameW( 0, &dllName[0], _MAX_PATH ); + +#ifdef EFSW_COMPILER_MSVC + _wsplitpath_s( dllName.c_str(), szDrive, _MAX_DRIVE, szDir, _MAX_DIR, szFilename, _MAX_DIR, + szExt, _MAX_DIR ); +#else + _wsplitpath( dllName.c_str(), szDrive, szDir, szFilename, szExt ); +#endif + + return String( szDrive ).toUtf8() + String( szDir ).toUtf8(); +} + +void System::maxFD() {} + +Uint64 System::getMaxFD() { // Number of ReadDirectory per thread + return 60; +} + +}} // namespace efsw::Platform + +#endif diff --git a/vendor/efsw/src/efsw/platform/win/SystemImpl.hpp b/vendor/efsw/src/efsw/platform/win/SystemImpl.hpp new file mode 100644 index 0000000..99b4867 --- /dev/null +++ b/vendor/efsw/src/efsw/platform/win/SystemImpl.hpp @@ -0,0 +1,25 @@ +#ifndef EFSW_SYSTEMIMPLWIN_HPP +#define EFSW_SYSTEMIMPLWIN_HPP + +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + +namespace efsw { namespace Platform { + +class System { + public: + static void sleep( const unsigned long& ms ); + + static std::string getProcessPath(); + + static void maxFD(); + + static Uint64 getMaxFD(); +}; + +}} // namespace efsw::Platform + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/platform/win/ThreadImpl.cpp b/vendor/efsw/src/efsw/platform/win/ThreadImpl.cpp new file mode 100644 index 0000000..463934c --- /dev/null +++ b/vendor/efsw/src/efsw/platform/win/ThreadImpl.cpp @@ -0,0 +1,56 @@ +#include +#include +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + +#include + +namespace efsw { namespace Platform { + +ThreadImpl::ThreadImpl( efsw::Thread* owner ) { + mThread = reinterpret_cast( + _beginthreadex( NULL, 0, &ThreadImpl::entryPoint, owner, 0, &mThreadId ) ); + + if ( !mThread ) { + efDEBUG( "Failed to create thread\n" ); + } +} + +ThreadImpl::~ThreadImpl() { + if ( mThread ) { + CloseHandle( mThread ); + } +} + +void ThreadImpl::wait() { + // Wait for the thread to finish, no timeout + if ( mThread ) { + assert( mThreadId != GetCurrentThreadId() ); // A thread cannot wait for itself! + + WaitForSingleObject( mThread, INFINITE ); + } +} + +void ThreadImpl::terminate() { + if ( mThread ) { + TerminateThread( mThread, 0 ); + } +} + +unsigned int __stdcall ThreadImpl::entryPoint( void* userData ) { + // The Thread instance is stored in the user data + Thread* owner = static_cast( userData ); + + // Forward to the owner + owner->run(); + + // Optional, but it is cleaner + _endthreadex( 0 ); + + return 0; +} + +}} // namespace efsw::Platform + +#endif diff --git a/vendor/efsw/src/efsw/platform/win/ThreadImpl.hpp b/vendor/efsw/src/efsw/platform/win/ThreadImpl.hpp new file mode 100644 index 0000000..455f24c --- /dev/null +++ b/vendor/efsw/src/efsw/platform/win/ThreadImpl.hpp @@ -0,0 +1,42 @@ +#ifndef EFSW_THREADIMPLWIN_HPP +#define EFSW_THREADIMPLWIN_HPP + +#include + +#if EFSW_PLATFORM == EFSW_PLATFORM_WIN32 + +#ifndef WIN32_LEAN_AND_MEAN +#define WIN32_LEAN_AND_MEAN +#endif +#include +#include + +namespace efsw { + +class Thread; + +namespace Platform { + +class ThreadImpl { + public: + explicit ThreadImpl( efsw::Thread* owner ); + + ~ThreadImpl(); + + void wait(); + + void terminate(); + + protected: + static unsigned int __stdcall entryPoint( void* userData ); + + HANDLE mThread; + unsigned int mThreadId; +}; + +} // namespace Platform +} // namespace efsw + +#endif + +#endif diff --git a/vendor/efsw/src/efsw/sophist.h b/vendor/efsw/src/efsw/sophist.h new file mode 100644 index 0000000..82e5c36 --- /dev/null +++ b/vendor/efsw/src/efsw/sophist.h @@ -0,0 +1,147 @@ +/* sophist.h - 0.3 - public domain - Sean Barrett 2010 +** Knowledge drawn from Brian Hook's posh.h and http://predef.sourceforge.net +** Sophist provides portable types; you typedef/#define them to your own names +** +** defines: +** - SOPHIST_endian - either SOPHIST_little_endian or SOPHIST_big_endian +** - SOPHIST_has_64 - either 0 or 1; if 0, int64 types aren't defined +** - SOPHIST_pointer64 - either 0 or 1; if 1, pointer is 64-bit +** +** - SOPHIST_intptr, SOPHIST_uintptr - integer same size as pointer +** - SOPHIST_int8, SOPHIST_uint8, SOPHIST_int16, SOPHIST_uint16 +** - SOPHIST_int32, SOPHIST_uint32, SOPHIST_int64, SOPHIST_uint64 +** - SOPHIST_int64_constant(number) - macros for creating 64-bit +** - SOPHIST_uint64_constant(number) integer constants +** - SOPHIST_printf_format64 - string for printf format for int64 +*/ + +#ifndef __INCLUDE_SOPHIST_H__ +#define __INCLUDE_SOPHIST_H__ + +#define SOPHIST_compiletime_assert(name,val) \ + typedef int SOPHIST__assert##name[(val) ? 1 : -1] + +/* define a couple synthetic rules to make code more readable */ +#if (defined(__sparc__) || defined(__sparc)) && \ + (defined(__arch64__) || defined(__sparcv9) || defined(__sparc_v9__)) + #define SOPHIST_sparc64 +#endif + +#if (defined(linux) || defined(__linux__)) && \ + (defined(__alpha)||defined(__alpha__)||defined(__x86_64__)||defined(_M_X64)) + #define SOPHIST_linux64 +#endif + +/* basic types */ +typedef signed char SOPHIST_int8; +typedef unsigned char SOPHIST_uint8; + +typedef signed short SOPHIST_int16; +typedef unsigned short SOPHIST_uint16; + +#ifdef __palmos__ + typedef signed long SOPHIST_int32; + typedef unsigned long SOPHIST_uint32; +#else + typedef signed int SOPHIST_int32; + typedef unsigned int SOPHIST_uint32; +#endif + +#ifndef SOPHIST_NO_64 + #if defined(_MSC_VER) || defined(__WATCOMC__) || defined(__BORLANDC__) \ + || (defined(__alpha) && defined(__DECC)) + + typedef signed __int64 SOPHIST_int64; + typedef unsigned __int64 SOPHIST_uint64; + #define SOPHIST_has_64 1 + #define SOPHIST_int64_constant(x) (x##i64) + #define SOPHIST_uint64_constant(x) (x##ui64) + #define SOPHIST_printf_format64 "I64" + + #elif defined(__LP64__) || defined(__powerpc64__) || defined(SOPHIST_sparc64) + + typedef signed long SOPHIST_int64; + typedef unsigned long SOPHIST_uint64; + + #define SOPHIST_has_64 1 + #define SOPHIST_int64_constant(x) ((SOPHIST_int64) x) + #define SOPHIST_uint64_constant(x) ((SOPHIST_uint64) x) + #define SOPHIST_printf_format64 "l" + + #elif defined(_LONG_LONG) || defined(__SUNPRO_C) || defined(__SUNPRO_CC) \ + || defined(__GNUC__) || defined(__MWERKS__) || defined(__APPLE_CC__) \ + || defined(sgi) || defined (__sgi) || defined(__sgi__) \ + || defined(_CRAYC) + + typedef signed long long SOPHIST_int64; + typedef unsigned long long SOPHIST_uint64; + + #define SOPHIST_has_64 1 + #define SOPHIST_int64_constant(x) (x##LL) + #define SOPHIST_uint64_constant(x) (x##ULL) + #define SOPHIST_printf_format64 "ll" + #endif +#endif + +#ifndef SOPHIST_has_64 +#define SOPHIST_has_64 0 +#endif + +SOPHIST_compiletime_assert( int8 , sizeof(SOPHIST_int8 ) == 1); +SOPHIST_compiletime_assert(uint16, sizeof(SOPHIST_int16) == 2); +SOPHIST_compiletime_assert( int32, sizeof(SOPHIST_int32 ) == 4); +SOPHIST_compiletime_assert(uint32, sizeof(SOPHIST_uint32) == 4); + +#if SOPHIST_has_64 + SOPHIST_compiletime_assert( int64, sizeof(SOPHIST_int64 ) == 8); + SOPHIST_compiletime_assert(uint64, sizeof(SOPHIST_uint64) == 8); +#endif + +/* determine whether pointers are 64-bit */ + +#if defined(SOPHIST_linux64) || defined(SOPHIST_sparc64) \ + || defined(__osf__) || (defined(_WIN64) && !defined(_XBOX)) \ + || defined(__64BIT__) \ + || defined(__LP64) || defined(__LP64__) || defined(_LP64) \ + || defined(_ADDR64) || defined(_CRAYC) \ + + #define SOPHIST_pointer64 1 + + SOPHIST_compiletime_assert(pointer64, sizeof(void*) == 8); + + typedef SOPHIST_int64 SOPHIST_intptr; + typedef SOPHIST_uint64 SOPHIST_uintptr; +#else + + #define SOPHIST_pointer64 0 + + SOPHIST_compiletime_assert(pointer64, sizeof(void*) <= 4); + + /* do we care about pointers that are only 16-bit? */ + typedef SOPHIST_int32 SOPHIST_intptr; + typedef SOPHIST_uint32 SOPHIST_uintptr; + +#endif + +SOPHIST_compiletime_assert(intptr, sizeof(SOPHIST_intptr) == sizeof(char *)); + +/* enumerate known little endian cases; fallback to big-endian */ + +#define SOPHIST_little_endian 1 +#define SOPHIST_big_endian 2 + +#if defined(__386__) || defined(i386) || defined(__i386__) \ + || defined(__X86) || defined(_M_IX86) \ + || defined(_M_X64) || defined(__x86_64__) \ + || defined(alpha) || defined(__alpha) || defined(__alpha__) \ + || defined(_M_ALPHA) \ + || defined(ARM) || defined(_ARM) || defined(__arm__) \ + || defined(WIN32) || defined(_WIN32) || defined(__WIN32__) \ + || defined(_WIN32_WCE) || defined(__NT__) \ + || defined(__MIPSEL__) + #define SOPHIST_endian SOPHIST_little_endian +#else + #define SOPHIST_endian SOPHIST_big_endian +#endif + +#endif /* __INCLUDE_SOPHIST_H__ */ diff --git a/vendor/efsw/src/test/efsw-test.c b/vendor/efsw/src/test/efsw-test.c new file mode 100644 index 0000000..54a3e21 --- /dev/null +++ b/vendor/efsw/src/test/efsw-test.c @@ -0,0 +1,164 @@ +#include + +#include +#include +#include +#include +#include +#include + +#ifdef _WIN32 + #include +#else + #include +#endif + +const char PATH_SEPARATOR = +#ifdef _WIN32 + '\\'; +#else + '/'; +#endif + +bool STOP = false; + +void sigend( int sig ) { + printf( "Bye bye" ); + STOP = true; +} + +void sleepMsecs( int msecs ) { +#ifdef _WIN32 + Sleep( msecs ); +#else + sleep( msecs ); +#endif +} + +const char * getActionName( enum efsw_action action ) { + switch ( action ) { + case EFSW_ADD: + return "Add"; + case EFSW_MODIFIED: + return "Modified"; + case EFSW_DELETE: + return "Delete"; + case EFSW_MOVED: + return "Moved"; + default: + return "Bad Action"; + } +} + +void handleFileAction( efsw_watcher watcher, efsw_watchid watchid, + const char* dir, const char* filename, + enum efsw_action action, const char* oldFilename, + void* param ) { + if ( strlen( oldFilename ) == 0 ) { + printf( "Watch ID %ld DIR (%s) FILE (%s) has event %s\n", + watchid, dir, filename, getActionName( action )); + } else { + printf( "Watch ID %ld DIR (%s) FILE (from file %s to %s) has event %s\n", + watchid, dir, oldFilename, filename, getActionName( action )); + } +} + +efsw_watchid handleWatchID( efsw_watchid watchid ) { + switch ( watchid ) { + case EFSW_NOTFOUND: + case EFSW_REPEATED: + case EFSW_OUTOFSCOPE: + case EFSW_REMOTE: + case EFSW_WATCHER_FAILED: + case EFSW_UNSPECIFIED: { + printf( "%s\n", efsw_getlasterror() ); + break; + } + default: { + printf( "Added WatchID: %ld\n", watchid ); + } + } + + return watchid; +} + +int main( int argc, char** argv ) { + signal( SIGABRT, sigend ); + signal( SIGINT, sigend ); + signal( SIGTERM, sigend ); + + printf("Press ^C to exit demo\n"); + + bool commonTest = true; + bool useGeneric = false; + char *path = 0; + + if ( argc >= 2 ) { + path = argv[1]; + + struct stat s; + if( stat(path,&s) == 0 && (s.st_mode & S_IFDIR) == S_IFDIR ) { + commonTest = false; + } + + if ( argc >= 3 ) { + if ( strcmp( argv[2], "true" ) == 0 ) { + useGeneric = true; + } + } + } + + /// create the file watcher object + efsw_watcher fileWatcher = efsw_create( useGeneric ); + efsw_follow_symlinks( fileWatcher, false ); + efsw_allow_outofscopelinks( fileWatcher, false ); + + if ( commonTest ) { + char cwd[256]; + getcwd( cwd, sizeof(cwd) ); + printf( "CurPath: %s\n", cwd ); + + /// starts watching + efsw_watch( fileWatcher ); + + /// add a watch to the system + char path1[256]; + sprintf(path1, "%s%ctest", cwd, PATH_SEPARATOR ); + handleWatchID( efsw_addwatch_withoptions( fileWatcher, path1, handleFileAction, true, 0, 0, 0 ) ); + + /// adds another watch after started watching... + sleepMsecs( 100 ); + + char path2[256]; + sprintf(path2, "%s%ctest2", cwd, PATH_SEPARATOR ); + efsw_watchid watchID = handleWatchID( + efsw_addwatch_withoptions( fileWatcher, path2, handleFileAction, true, 0, 0, 0 ) ); + + /// delete the watch + if ( watchID > 0 ) { + sleepMsecs( 1000 ); + efsw_removewatch_byid( fileWatcher, watchID ); + } + } else { + if ( efsw_addwatch( fileWatcher, path, handleFileAction, true, 0 ) > 0 ) { + efsw_watch( fileWatcher ); + + printf( "Watching directory: %s\n", path ); + + if ( useGeneric ) { + printf( "Using generic backend watcher\n" ); + } + } else { + printf( "Error trying to watch directory: %s\n", path ); + printf( "%s\n", efsw_getlasterror() ); + } + } + + while ( !STOP ) { + sleepMsecs( 100 ); + } + + efsw_release( fileWatcher ); + + return 0; +} diff --git a/vendor/efsw/src/test/efsw-test.cpp b/vendor/efsw/src/test/efsw-test.cpp new file mode 100644 index 0000000..99f6086 --- /dev/null +++ b/vendor/efsw/src/test/efsw-test.cpp @@ -0,0 +1,139 @@ +#include +#include +#include +#include +#include + +bool STOP = false; + +void sigend( int ) { + std::cout << std::endl << "Bye bye" << std::endl; + STOP = true; +} + +/// Processes a file action +class UpdateListener : public efsw::FileWatchListener { + public: + UpdateListener() {} + + std::string getActionName( efsw::Action action ) { + switch ( action ) { + case efsw::Actions::Add: + return "Add"; + case efsw::Actions::Modified: + return "Modified"; + case efsw::Actions::Delete: + return "Delete"; + case efsw::Actions::Moved: + return "Moved"; + default: + return "Bad Action"; + } + } + + void handleFileAction( efsw::WatchID watchid, const std::string& dir, + const std::string& filename, efsw::Action action, + std::string oldFilename = "" ) override { + std::cout << "Watch ID " << watchid << " DIR (" + << dir + ") FILE (" + + ( oldFilename.empty() ? "" : "from file " + oldFilename + " to " ) + + filename + ") has event " + << getActionName( action ) << std::endl; + } +}; + +efsw::WatchID handleWatchID( efsw::WatchID watchid ) { + switch ( watchid ) { + case efsw::Errors::FileNotFound: + case efsw::Errors::FileRepeated: + case efsw::Errors::FileOutOfScope: + case efsw::Errors::FileRemote: + case efsw::Errors::WatcherFailed: + case efsw::Errors::Unspecified: { + std::cout << efsw::Errors::Log::getLastErrorLog().c_str() << std::endl; + break; + } + default: { + std::cout << "Added WatchID: " << watchid << std::endl; + } + } + + return watchid; +} + +int main( int argc, char** argv ) { + signal( SIGABRT, sigend ); + signal( SIGINT, sigend ); + signal( SIGTERM, sigend ); + + std::cout << "Press ^C to exit demo" << std::endl; + + bool commonTest = true; + bool useGeneric = false; + std::string path; + + if ( argc >= 2 ) { + path = std::string( argv[1] ); + + if ( efsw::FileSystem::isDirectory( path ) ) { + commonTest = false; + } + + if ( argc >= 3 ) { + if ( std::string( argv[2] ) == "true" ) { + useGeneric = true; + } + } + } + + UpdateListener* ul = new UpdateListener(); + + /// create the file watcher object + efsw::FileWatcher fileWatcher( useGeneric ); + + fileWatcher.followSymlinks( false ); + fileWatcher.allowOutOfScopeLinks( false ); + + if ( commonTest ) { + std::string CurPath( efsw::System::getProcessPath() ); + + std::cout << "CurPath: " << CurPath.c_str() << std::endl; + + /// starts watching + fileWatcher.watch(); + + /// add a watch to the system + handleWatchID( fileWatcher.addWatch( CurPath + "test", ul, true ) ); + + /// adds another watch after started watching... + efsw::System::sleep( 100 ); + + efsw::WatchID watchID = + handleWatchID( fileWatcher.addWatch( CurPath + "test2", ul, true ) ); + + /// delete the watch + if ( watchID > 0 ) { + efsw::System::sleep( 1000 ); + fileWatcher.removeWatch( watchID ); + } + } else { + if ( fileWatcher.addWatch( path, ul, true ) > 0 ) { + fileWatcher.watch(); + + std::cout << "Watching directory: " << path.c_str() << std::endl; + + if ( useGeneric ) { + std::cout << "Using generic backend watcher" << std::endl; + } + } else { + std::cout << "Error trying to watch directory: " << path.c_str() << std::endl; + std::cout << efsw::Errors::Log::getLastErrorLog().c_str() << std::endl; + } + } + + while ( !STOP ) { + efsw::System::sleep( 100 ); + } + + return 0; +}