mirror of https://github.com/djcb/mu.git
142 lines
3.4 KiB
C++
142 lines
3.4 KiB
C++
/*
|
|
** Copyright (C) 2023 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
|
|
**
|
|
** This program is free software; you can redistribute it and/or modify it
|
|
** under the terms of the GNU General Public License as published by the
|
|
** Free Software Foundation; either version 3, or (at your option) any
|
|
** later version.
|
|
**
|
|
** This program is distributed in the hope that it will be useful,
|
|
** but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
** GNU General Public License for more details.
|
|
**
|
|
** You should have received a copy of the GNU General Public License
|
|
** along with this program; if not, write to the Free Software Foundation,
|
|
** Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
**
|
|
*/
|
|
|
|
#ifndef MU_UTILS_FILE_HH__
|
|
#define MU_UTILS_FILE_HH__
|
|
|
|
#include <string>
|
|
#include <cinttypes>
|
|
#include <sys/stat.h>
|
|
|
|
#include <utils/mu-sexp.hh>
|
|
#include <utils/mu-option.hh>
|
|
|
|
namespace Mu {
|
|
|
|
/**
|
|
* Try to 'play' (ie., open with it's associated program) a file. On MacOS, the
|
|
* the program 'open' is used for this; on other platforms 'xdg-open' to do the
|
|
* actual opening. In addition you can set it to another program by setting thep
|
|
* MU_PLAY_PROGRAM environment variable
|
|
*
|
|
* This requires a 'native' file, see g_file_is_native()
|
|
*
|
|
* @param path full path of the file to open
|
|
*
|
|
* @return Ok() if succeeded, some error otherwise.
|
|
*/
|
|
Result<void> play(const std::string& path);
|
|
|
|
/**
|
|
* Find program in PATH
|
|
*
|
|
* @param name the name of the program
|
|
*
|
|
* @return either the full path to program, or Nothing if not found.
|
|
*/
|
|
Option<std::string> program_in_path(const std::string& name);
|
|
|
|
/**
|
|
* Check if the directory has the given attributes
|
|
*
|
|
* @param path path to dir
|
|
* @param readable is it readable?
|
|
* @param writeable is it writable?
|
|
*
|
|
* @return true if is is a directory with given attributes; false otherwise.
|
|
*/
|
|
bool check_dir(const std::string& path, bool readable, bool writeable);
|
|
|
|
/**
|
|
* See g_canonicalize_filename
|
|
*
|
|
* @param filename
|
|
* @param relative_to
|
|
*
|
|
* @return
|
|
*/
|
|
std::string canonicalize_filename(const std::string& path, const std::string& relative_to);
|
|
|
|
/*
|
|
* for OSs with out support for direntry->d_type, like Solaris
|
|
*/
|
|
#ifndef DT_UNKNOWN
|
|
enum {
|
|
DT_UNKNOWN = 0,
|
|
#define DT_UNKNOWN DT_UNKNOWN
|
|
DT_FIFO = 1,
|
|
#define DT_FIFO DT_FIFO
|
|
DT_CHR = 2,
|
|
#define DT_CHR DT_CHR
|
|
DT_DIR = 4,
|
|
#define DT_DIR DT_DIR
|
|
DT_BLK = 6,
|
|
#define DT_BLK DT_BLK
|
|
DT_REG = 8,
|
|
#define DT_REG DT_REG
|
|
DT_LNK = 10,
|
|
#define DT_LNK DT_LNK
|
|
DT_SOCK = 12,
|
|
#define DT_SOCK DT_SOCK
|
|
DT_WHT = 14
|
|
#define DT_WHT DT_WHT
|
|
};
|
|
#endif /*DT_UNKNOWN*/
|
|
|
|
/**
|
|
* get the d_type (as in direntry->d_type) for the file at path, using either
|
|
* stat(3) or lstat(3)
|
|
*
|
|
* @param path full path
|
|
* @param use_lstat whether to use lstat (otherwise use stat)
|
|
*
|
|
* @return DT_REG, DT_DIR, DT_LNK, or DT_UNKNOWN (other values are not supported
|
|
* currently)
|
|
*/
|
|
uint8_t determine_dtype(const std::string& path, bool use_lstat);
|
|
|
|
|
|
/**
|
|
* Well-known runtime paths
|
|
*
|
|
*/
|
|
enum struct RuntimePath {
|
|
XapianDb,
|
|
Cache,
|
|
LogFile,
|
|
Config,
|
|
Scripts,
|
|
Bookmarks
|
|
};
|
|
|
|
/**
|
|
* Get some well-known Path for internal use when don't have
|
|
* access to the command-line
|
|
*
|
|
* @param path the RuntimePath to find
|
|
* @param muhome path to muhome directory, or empty for the default.
|
|
*
|
|
* @return the path name
|
|
*/
|
|
std::string runtime_path(RuntimePath path, const std::string& muhome="");
|
|
|
|
}
|
|
#endif /* MU_UTILS_FILE_HH__ */
|
|
|