Blame chdir-notify.h

Packit Service fe3200
#ifndef CHDIR_NOTIFY_H
Packit Service fe3200
#define CHDIR_NOTIFY_H
Packit Service fe3200
Packit Service fe3200
/*
Packit Service fe3200
 * An API to let code "subscribe" to changes to the current working directory.
Packit Service fe3200
 * The general idea is that some code asks to be notified when the working
Packit Service fe3200
 * directory changes, and other code that calls chdir uses a special wrapper
Packit Service fe3200
 * that notifies everyone.
Packit Service fe3200
 */
Packit Service fe3200
Packit Service fe3200
/*
Packit Service fe3200
 * Callers who need to know about changes can do:
Packit Service fe3200
 *
Packit Service fe3200
 *   void foo(const char *old_path, const char *new_path, void *data)
Packit Service fe3200
 *   {
Packit Service fe3200
 *	warning("switched from %s to %s!", old_path, new_path);
Packit Service fe3200
 *   }
Packit Service fe3200
 *   ...
Packit Service fe3200
 *   chdir_notify_register("description", foo, data);
Packit Service fe3200
 *
Packit Service fe3200
 * In practice most callers will want to move a relative path to the new root;
Packit Service fe3200
 * they can use the reparent_relative_path() helper for that. If that's all
Packit Service fe3200
 * you're doing, you can also use the convenience function:
Packit Service fe3200
 *
Packit Service fe3200
 *   chdir_notify_reparent("description", &my_path);
Packit Service fe3200
 *
Packit Service fe3200
 * Whenever a chdir event occurs, that will update my_path (if it's relative)
Packit Service fe3200
 * to adjust for the new cwd by freeing any existing string and allocating a
Packit Service fe3200
 * new one.
Packit Service fe3200
 *
Packit Service fe3200
 * Registered functions are called in the order in which they were added. Note
Packit Service fe3200
 * that there's currently no way to remove a function, so make sure that the
Packit Service fe3200
 * data parameter remains valid for the rest of the program.
Packit Service fe3200
 *
Packit Service fe3200
 * The "name" argument is used only for printing trace output from
Packit Service fe3200
 * $GIT_TRACE_SETUP. It may be NULL, but if non-NULL should point to
Packit Service fe3200
 * storage which lasts as long as the registration is active.
Packit Service fe3200
 */
Packit Service fe3200
typedef void (*chdir_notify_callback)(const char *name,
Packit Service fe3200
				      const char *old_cwd,
Packit Service fe3200
				      const char *new_cwd,
Packit Service fe3200
				      void *data);
Packit Service fe3200
void chdir_notify_register(const char *name, chdir_notify_callback cb, void *data);
Packit Service fe3200
void chdir_notify_reparent(const char *name, char **path);
Packit Service fe3200
Packit Service fe3200
/*
Packit Service fe3200
 *
Packit Service fe3200
 * Callers that want to chdir:
Packit Service fe3200
 *
Packit Service fe3200
 *   chdir_notify(new_path);
Packit Service fe3200
 *
Packit Service fe3200
 * to switch to the new path and notify any callbacks.
Packit Service fe3200
 *
Packit Service fe3200
 * Note that you don't need to chdir_notify() if you're just temporarily moving
Packit Service fe3200
 * to a directory and back, as long as you don't call any subscribed code in
Packit Service fe3200
 * between (but it should be safe to do so if you're unsure).
Packit Service fe3200
 */
Packit Service fe3200
int chdir_notify(const char *new_cwd);
Packit Service fe3200
Packit Service fe3200
/*
Packit Service fe3200
 * Reparent a relative path from old_root to new_root. For example:
Packit Service fe3200
 *
Packit Service fe3200
 *   reparent_relative_path("/a", "/a/b", "b/rel");
Packit Service fe3200
 *
Packit Service fe3200
 * would return the (newly allocated) string "rel". Note that we may return an
Packit Service fe3200
 * absolute path in some cases (e.g., if the resulting path is not inside
Packit Service fe3200
 * new_cwd).
Packit Service fe3200
 */
Packit Service fe3200
char *reparent_relative_path(const char *old_cwd,
Packit Service fe3200
			     const char *new_cwd,
Packit Service fe3200
			     const char *path);
Packit Service fe3200
Packit Service fe3200
#endif /* CHDIR_NOTIFY_H */