lib/util/util_paths.h

   1 /*
   2  * Unix SMB/CIFS implementation.
   3  * Samba utility functions
   4  * Copyright (C) Andrew Tridgell 1992-1998
   5  * Copyright (C) Jeremy Allison 2001-2007
   6  * Copyright (C) Simo Sorce 2001
   7  * Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
   8  * Copyright (C) James Peach 2006
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24 #ifndef __LIB_UTIL_PATHS_H__
  25 #define __LIB_UTIL_PATHS_H__
  26
  27 #include <talloc.h>
  28
  29 /**
  30  * @brief Returns an absolute path to a file in the Samba modules directory.
  31  *
  32  * @param name File to find, relative to MODULESDIR.
  33  *
  34  * @retval Pointer to a string containing the full path.
  35  **/
  36 char *modules_path(TALLOC_CTX *mem_ctx, const char *name);
  37
  38 /**
  39  * @brief Returns an absolute path to a file in the Samba data directory.
  40  *
  41  * @param name File to find, relative to CODEPAGEDIR.
  42  *
  43  * @retval Pointer to a talloc'ed string containing the full path.
  44  **/
  45 char *data_path(TALLOC_CTX *mem_ctx, const char *name);
  46
  47 /**
  48  * @brief Returns the platform specific shared library extension.
  49  *
  50  * @retval Pointer to a const char * containing the extension.
  51  **/
  52 const char *shlib_ext(void);
  53
  54 /**
  55  * @brief Expand a directory starting with a tilde '~'
  56  *
  57  * @param[in]  d        The directory to expand.
  58  *
  59  * @return              The expanded directory, NULL on error.
  60  */
  61 char *path_expand_tilde(TALLOC_CTX *mem_ctx, const char *d);
  62
  63 #endif