120 lines
3.8 KiB
C++
120 lines
3.8 KiB
C++
/* Copyright (C) 2016 J.F.Dockes
|
|
* 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 2 of the License, 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 _RCLUTIL_H_INCLUDED_
|
|
#define _RCLUTIL_H_INCLUDED_
|
|
#include "autoconfig.h"
|
|
|
|
// Misc stuff not generic enough to get into smallut or pathut
|
|
|
|
#include <map>
|
|
#include <string>
|
|
#include <memory>
|
|
|
|
|
|
extern void rclutil_init_mt();
|
|
|
|
/// Sub-directory for default recoll config (e.g: .recoll)
|
|
extern std::string path_defaultrecollconfsubdir();
|
|
// Check if path is either non-existing or an empty directory.
|
|
extern bool path_empty(const std::string& path);
|
|
|
|
/// e.g. /usr/share/recoll. Depends on OS and config
|
|
extern const std::string& path_pkgdatadir();
|
|
|
|
#ifdef _WIN32
|
|
extern std::string path_thisexecpath();
|
|
#endif
|
|
|
|
/// Transcode to utf-8 if possible or url encoding, for display.
|
|
extern bool printableUrl(const std::string& fcharset,
|
|
const std::string& in, std::string& out);
|
|
/// Same but, in the case of a Windows local path, also turn "c:/" into
|
|
/// "/c/" This should be used only for splitting the path in rcldb.
|
|
extern std::string url_gpathS(const std::string& url);
|
|
|
|
/// Like strftime but guaranteed utf-8 output (esp. useful on Windows)
|
|
struct tm;
|
|
extern std::string utf8datestring(const std::string& format, struct tm *tm);
|
|
|
|
/// Retrieve the temp dir location: $RECOLL_TMPDIR else $TMPDIR else /tmp
|
|
extern const std::string& tmplocation();
|
|
|
|
/// Create temporary directory (inside the temp location)
|
|
extern bool maketmpdir(std::string& tdir, std::string& reason);
|
|
|
|
/// Temporary file class
|
|
class TempFile {
|
|
public:
|
|
TempFile(const std::string& suffix);
|
|
TempFile();
|
|
const char *filename() const;
|
|
const std::string& getreason() const;
|
|
void setnoremove(bool onoff);
|
|
bool ok() const;
|
|
// Attempt to delete all files which could not be deleted on the
|
|
// first try (typically on Windows: because they are open by some
|
|
// process). Called after clearing the mimeHandler cache. Does
|
|
// nothing if not _WIN32
|
|
static void tryRemoveAgain();
|
|
// Also for Windows: for adding the temp files path to the default
|
|
// skippedPaths
|
|
static const std::string& rcltmpdir();
|
|
|
|
class Internal;
|
|
private:
|
|
std::shared_ptr<Internal> m;
|
|
};
|
|
|
|
/// Temporary directory class. Recursively deleted by destructor.
|
|
class TempDir {
|
|
public:
|
|
TempDir();
|
|
~TempDir();
|
|
const char *dirname() {
|
|
return m_dirname.c_str();
|
|
}
|
|
const std::string& getreason() {
|
|
return m_reason;
|
|
}
|
|
bool ok() {
|
|
return !m_dirname.empty();
|
|
}
|
|
/// Recursively delete contents but not self.
|
|
bool wipe();
|
|
private:
|
|
std::string m_dirname;
|
|
std::string m_reason;
|
|
TempDir(const TempDir&) {}
|
|
TempDir& operator=(const TempDir&) {
|
|
return *this;
|
|
};
|
|
};
|
|
|
|
// Freedesktop thumbnail standard path routine
|
|
// On return, path will have the appropriate value in all cases,
|
|
// returns true if the file already exists
|
|
extern bool thumbPathForUrl(const std::string& url, int size,
|
|
std::string& path);
|
|
|
|
// Duplicate (unordered)map<string,string> while ensuring no shared
|
|
// string data (to pass to other thread):
|
|
template <class T> void map_ss_cp_noshr(T s, T *d);
|
|
|
|
|
|
#endif /* _RCLUTIL_H_INCLUDED_ */
|