1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// copyright : (C) 2008 by Eran Ifrah
// file name : fileutils.h
//
// -------------------------------------------------------------------------
// A
// _____ _ _ _ _
// / __ \ | | | | (_) |
// | / \/ ___ __| | ___| | _| |_ ___
// | | / _ \ / _ |/ _ \ | | | __/ _ )
// | \__/\ (_) | (_| | __/ |___| | || __/
// \____/\___/ \__,_|\___\_____/_|\__\___|
//
// F i l e
//
// 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.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
#ifndef FILEUTILS_H
#define FILEUTILS_H
#include "codelite_exports.h"
#include "macros.h"
#include "wx/filename.h"
#include <wx/filename.h>
#include <wx/log.h>
#define clRemoveFile(filename) FileUtils::RemoveFile(filename, (wxString() << __FILE__ << ":" << __LINE__))
class WXDLLIMPEXP_CL FileUtils
{
public:
class Deleter
{
wxFileName m_filename;
public:
Deleter(const wxFileName& filename)
: m_filename(filename)
{
}
~Deleter()
{
if(m_filename.Exists()) { clRemoveFile(m_filename); }
}
};
public:
static bool ReadFileContent(const wxFileName& fn, wxString& data, const wxMBConv& conv = wxConvUTF8);
/**
* @brief set the file content (replacing it)
*/
static bool WriteFileContent(const wxFileName& fn, const wxString& content, const wxMBConv& conv = wxConvUTF8);
/**
* @brief open file explorer at given path
*/
static void OpenFileExplorer(const wxString& path);
/**
* @brief open file explorer at given path and select the input file
*/
static void OpenFileExplorerAndSelect(const wxFileName& filename);
/**
* @brief launch the OS default terminal at a given path
*/
static void OpenTerminal(const wxString& path);
/**
* @brief open ssh terminal
* @param sshClient ssh client to use (putty, ssh etc)
* @param connectString e.g. eran@host
* @param password the password
* @param port ssh port
*/
static void OpenSSHTerminal(const wxString& sshClient, const wxString& connectString, const wxString& password,
int port = 22);
/**
* @brief OSX only: open Terminal and return its TTY
* @param path working directory
* @param [output] tty the TTY of the launched terminal
*/
static void OSXOpenDebuggerTerminalAndGetTTY(const wxString& path, wxString& tty, long& pid);
/**
* @brief return the command needed to open OSX terminal at a given directory and launch a command
*/
static wxString GetOSXTerminalCommand(const wxString& command, const wxString& workingDirectory);
/**
* @brief file masking search
*/
static bool WildMatch(const wxString& mask, const wxString& filename);
/**
* @brief file masking search
*/
static bool WildMatch(const wxString& mask, const wxFileName& filename);
/**
* @brief file masking search
*/
static bool WildMatch(const wxArrayString& masks, const wxString& filename);
/**
* @brief return true if needle exists in the haystack. Supports fuzzy search
* @param needle the pattern to search
* @param haystack the string to search on
*/
static bool FuzzyMatch(const wxString& needle, const wxString& haystack);
/**
* @brief an efficient way to tokenize string into words (separated by SPACE and/or TAB)
* @code
* wxString str = "My String That Requires Tokenize";
* wxString word; // The output
* size_t offset = 0;
* while(clNextWord(str, offset, word)) {
* // Do something with "word" here
* }
* @codeend
* @param str the string to tokenize
* @param offset used internally, allocate one on the stack and initialise it to 0
* @param word [output]
* @return true if a word was found
*/
static bool NextWord(const wxString& str, size_t& offset, wxString& word, bool makeLower = false);
/**
* @brief split a string by whitespace
*/
static size_t SplitWords(const wxString& str, wxStringSet_t& outputSet, bool makeLower = false);
/**
* @brief decode URI using percent encoding
*/
static wxString DecodeURI(const wxString& uri);
/**
* @brief encode URI using percent encoding
*/
static wxString EncodeURI(const wxString& uri);
/**
* @brief escape string. Each space and double quotes marker is escaped with backslash
*/
static wxString EscapeString(const wxString& str);
/**
* @brief is the file or folder a hidden file?
*/
static bool IsHidden(const wxFileName& path);
/**
* @brief is the file or folder a hidden file?
*/
static bool IsHidden(const wxString& path);
/**
* @brief set permissions to filename
*/
static bool SetFilePermissions(const wxFileName& filename, mode_t perm);
/**
* @brief get file permissions
*/
static bool GetFilePermissions(const wxFileName& filename, mode_t& perm);
/**
* @brief return the file modification time
*/
static time_t GetFileModificationTime(const wxFileName& filename);
/**
* @brief return the file size, in bytes
*/
static size_t GetFileSize(const wxFileName& filename);
/**
* @brief replace any unwanted characters with underscore
* The chars that we replace are:
* @-^%&$#@!(){}[]+=;,.
* @param name
* @return modified name excluding the above chars (will be replaced with _)
*/
static wxString NormaliseName(const wxString& name);
/**
* @brief remove a file from the file system
* @param filename file name to remove
* @param context unique context string which will be logged to the log file
*/
static bool RemoveFile(const wxFileName& filename, const wxString& context = "")
{
return RemoveFile(filename.GetFullPath(), context);
}
/**
* @brief same as above
*/
static bool RemoveFile(const wxString& filename, const wxString& context = "");
};
#endif // FILEUTILS_H
|
