/usr/include/gwenhywfar4/gwenhywfar/pathmanager.h is in libgwenhywfar-core-dev 4.15.3-5+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 | /***************************************************************************
$RCSfile$
-------------------
cvs : $Id$
begin : Mon Mar 01 2004
copyright : (C) 2004 by Martin Preuss
email : martin@libchipcard.de
***************************************************************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the Free Software *
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
* MA 02111-1307 USA *
* *
***************************************************************************/
#ifndef GWENHYWFAR_PATHMANAGER_H
#define GWENHYWFAR_PATHMANAGER_H
#include <gwenhywfar/error.h>
#include <gwenhywfar/stringlist.h>
#include <gwenhywfar/buffer.h>
typedef enum {
/** relative to the current working directory at calling time */
GWEN_PathManager_RelModeCwd=0,
/**
* This mode is interpreted differently in Windows and non-Windows systems
* due to the different handling of paths.
* <ul>
* <li>
* Windows: Releative to the folder in which the currently running
* executable is located.
* </li>
* <li>
* Non-Windows: Relative to the installation prefix of the currently
* running executable
* </li>
* </ul>
*/
GWEN_PathManager_RelModeExe,
/** relative to the user's home directory */
GWEN_PathManager_RelModeHome
} GWEN_PATHMANAGER_RELMODE;
#ifdef __cplusplus
extern "C" {
#endif
/** @name Path Management
*
* Gwenhywfar keeps track of registered directory paths for itself
* and for other libraries.
*
* The paths are registered and stored in one global object (of
* GWEN_DB_NODE type), so write-access to this GWEN_PathManager
* functions is unfortunately not thread-safe.
*
* This technique is used internally to
* determine some important paths.
*/
/*@{*/
/**
* Register a path to be managed by the global GWEN_PathManager
* module. This must be done before calling one of the other
* functions of this group. The actual path is not yet set.
*
* @param destLib The name of the library that this path is supposed to
* belong to.
*
* @param pathName A string identifier for this registered path.
*
* @return Zero on success, or GWEN_ERROR_INVALID if the @c
* pathName already exists.
*/
GWENHYWFAR_API
int GWEN_PathManager_DefinePath(const char *destLib,
const char *pathName);
/**
* Unregister a path that was registered by
* GWEN_PathManager_DefinePath().
*
* @param destLib The name of the library that this path is supposed to
* belong to.
*
* @param pathName A string identifier for this registered path.
*
* @return Zero on success, or GWEN_ERROR_NOT_FOUND if the @c
* pathName was not found.
*/
GWENHYWFAR_API
int GWEN_PathManager_UndefinePath(const char *destLib,
const char *pathName);
/**
* Add a directory path entry to a registered path entry in the
* global GWEN_PathManager.
*
* @param callingLib The name of the library that adds this path entry.
*
* @param destLib The name of the library that this path is supposed to
* belong to.
*
* @param pathName A string identifier for this registered path.
*
* @param pathValue The actual directory path that should be added to
* this registered path.
*
* @param rm path relative to what? (see @ref GWEN_PathManager_RelModeCwd)
*
* @return Zero on success, or GWEN_ERROR_NOT_FOUND if the @c
* pathName was not found.
*/
GWENHYWFAR_API
int GWEN_PathManager_AddPath(const char *callingLib,
const char *destLib,
const char *pathName,
const char *pathValue);
/**
* Same as @ref GWEN_PathManager_AddPath but the path to add is given
* relative to some directory. The "relmode" argument chooses the base
* directory to which the given sub-directory path is appended and the
* result is added to this PathManager:
*
* - RelModeCwd appends the path to the current working directory at
* the time of calling. So future changes to the CWD do not affect
* this setting.
*
* - RelModeExe appends the path to the prefix of the installation
* location of the calling executable. This function looks up the
* current working directory, removes the last component (i.e. the
* "/bin/") to get the prefix, then adds the given relative path to
* it.
*
* - RelModeHome appends the path to the return value of
* GWEN_Directory_GetHomeDirectory().
*
* All three variantes will then add the resulting path
* to the PathManager.
*
* @param callingLib The name of the library that adds this path entry.
*
* @param destLib The name of the library that this path is supposed to
* belong to.
*
* @param pathName A string identifier for this registered path.
*
* @param pathValue The actual directory path relative to the prefix
* of the current working directory that should be added to this
* registered path.
*
* @param rm The Flag to choose the starting directory to which the
* path is appended.
*
* @return Zero on success, or GWEN_ERROR_NOT_FOUND if the @c
* pathName was not found.
*/
GWENHYWFAR_API
int GWEN_PathManager_AddRelPath(const char *callingLib,
const char *destLib,
const char *pathName,
const char *pathValue,
GWEN_PATHMANAGER_RELMODE rm);
/**
* Add a directory path entry to a registered path entry in the
* global GWEN_PathManager by looking up the directory path in the
* Windows registry.
*
* On non-windows platforms, the function does nothing and returns
* zero, so you can safely call this in your multi-platform code.
*
* Note: Gwenhywfar-2.6.0 and older used to lookup the paths under
* HKEY_CURRENT_USER, but with gwen-2.6.1 this was changed to
* HKEY_LOCAL_MACHINE because we're talking about installation paths
* as opposed to per-user configuration settings.
*
* @param callingLib The name of the library that adds this path entry.
*
* @param destLib The name of the library that this path is supposed to
* belong to.
*
* @param pathName A string identifier for this registered path.
*
* @param keypath The key's path in the windows registry under
* HKEY_LOCAL_MACHINE, e.g. "Software\MyProgram\Paths".
*
* @param varname The variable name of the string variable with the
* actual directory path.
*
* @return Zero on success, or nonzero if the @c pathName or the
* registry key was not found.
*/
GWENHYWFAR_API
int GWEN_PathManager_AddPathFromWinReg(const char *callingLib,
const char *destLib,
const char *pathName,
const char *keypath,
const char *varname);
/**
* Insert a directory path entry to a registered path entry in the
* global GWEN_PathManager. While @ref GWEN_PathManager_AddPath adds a path
* to the end of the list for this particular @c pathName this function
* here inserts it at the beginning of the list. This can be used e.g. to
* ensure that plugins/files from a given path take precedence over already
* added paths.
*
* @param callingLib The name of the library that adds this path entry.
*
* @param destLib The name of the library that this path is supposed to
* belong to.
*
* @param pathName A string identifier for this registered path.
*
* @param pathValue The actual directory path that should be added to
* this registered path.
*/
GWENHYWFAR_API
int GWEN_PathManager_InsertPath(const char *callingLib,
const char *destLib,
const char *pathName,
const char *pathValue);
/**
* Same as @ref GWEN_PathManager_InsertPath but the path to insert is given
* relative to some directory. The "relmode" argument chooses the base
* directory to which the given sub-directory path is appended and the
* result is added to this PathManager:
*
* - RelModeCwd appends the path to the current working directory at
* the time of calling. So future changes to the CWD do not affect
* this setting.
*
* - RelModeExe appends the path to the prefix of the installation
* location of the calling executable. This function looks up the
* current working directory, removes the last component (i.e. the
* "/bin/") to get the prefix, then adds the given relative path to
* it.
*
* - RelModeHome appends the path to the return value of
* GWEN_Directory_GetHomeDirectory().
*
* All three variantes will then add the resulting path
* to the PathManager.
*
* @param callingLib The name of the library that adds this path entry.
*
* @param destLib The name of the library that this path is supposed to
* belong to.
*
* @param pathName A string identifier for this registered path.
*
* @param pathValue The actual directory path relative to the prefix
* of the current working directory that should be added to this
* registered path.
*
* @param rm The Flag to choose the starting directory to which the
* path is appended.
*
* @return Zero on success, or GWEN_ERROR_NOT_FOUND if the @c
* pathName was not found.
*/
GWENHYWFAR_API
int GWEN_PathManager_InsertRelPath(const char *callingLib,
const char *destLib,
const char *pathName,
const char *pathValue,
GWEN_PATHMANAGER_RELMODE rm);
/**
* Removes a directory path entry from a registered path entry in
* the global GWEN_PathManager.
*
* @param callingLib The name of the library that added this path entry.
*
* @param destLib The name of the library that this path is supposed to
* belong to.
*
* @param pathName A string identifier for this registered path.
*
* @param pathValue The actual directory path that should be added to
* this registered path.
*
* @return Zero on success, or nonzero if the @c pathName was not
* found.
*/
GWENHYWFAR_API
int GWEN_PathManager_RemovePath(const char *callingLib,
const char *destLib,
const char *pathName,
const char *pathValue);
/**
* Removes all directory path entries that were registered by the
* @c callingLib from the global GWEN_PathManager.
*
* @param callingLib The name of the library that added path entries.
*
* @return Zero on success.
*/
GWENHYWFAR_API
int GWEN_PathManager_RemovePaths(const char *callingLib);
/**
* This function checks whether the path list for @c pathName has changed
* since the last call to this function (i.e. whether paths have been
* added, inserted or removed).
*
* @param destLib The name of the library that this path is supposed to
* belong to.
*
* @param pathName A string identifier for this registered path.
*
* @return Zero on success, or GWEN_ERROR_NOT_FOUND if the @c
* pathName was not found.
*/
GWENHYWFAR_API
int GWEN_PathManager_PathChanged(const char *destLib,
const char *pathName);
/**
* Returns a string list of all path entries that exist under the
* registered @c pathName.
*
* @param destLib The name of the library that this path is supposed to
* belong to.
*
* @param pathName A string identifier for this registered path.
*
* @return A newly allocated @ref GWEN_STRINGLIST with all added
* path entries, or NULL if no path entry or no registered @c
* pathName exists. Delete this list with @ref GWEN_StringList_free()
* when no longer needed.
*/
GWENHYWFAR_API
GWEN_STRINGLIST *GWEN_PathManager_GetPaths(const char *destLib,
const char *pathName);
/**
* This functions tries to find a given file using all
* path entries under the registered @c pathName.
*
* @param destLib The name of the library that this path is supposed to
* belong to.
*
* @param pathName A string identifier for this registered path.
*
* @param fileName Name of the file (may contain partial paths, like in
* "dialogs/testdialog.xml"
*
* @param fbuf buffer to receive the full path to access the file
*
* @return 0 on success (in that case @c fbuf will be filled), an
* error code otherwise.
*/
GWENHYWFAR_API
int GWEN_PathManager_FindFile(const char *destLib,
const char *pathName,
const char *fileName,
GWEN_BUFFER *fbuf);
/**
* This function calls @ref GWEN_Directory_GetMatchingFilesRecursively() on every
* path entry under the registered @c pathName.
*
* @return 0 if ok, error code on error
*
* @param destLib The name of the library that this path is supposed to
* belong to.
*
* @param pathName A string identifier for this registered path.
*
* @param subFolderName if given then this folder name is appended to every path under
* the registered @c pathName before caling @ref GWEN_Directory_GetMatchingFilesRecursively()
* on it. You can use this parameter to search only in specific sub folders of the paths.
*
* @param sl string list to receive the paths of all matching files
*/
GWENHYWFAR_API
int GWEN_PathManager_GetMatchingFilesRecursively(const char *destLib,
const char *pathName,
const char *subFolderName,
GWEN_STRINGLIST *sl,
const char *mask);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif /* GWENHYWFAR_PATHMANAGER_H */
|