BaseTools: Clean up source files

[mirror_edk2.git] / BaseTools / Source / C / Common / OsPath.h

/** @file\r
Header file for helper functions useful to operate file directories by parsing\r
file path.\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _EFI_OS_PATH_H\r
#define _EFI_OS_PATH_H\r
\r
#include <Common/UefiBaseTypes.h>\r
\r
//\r
// Functions declarations\r
//\r
\r
CHAR8*\r
OsPathDirName (\r
  IN CHAR8    *FilePath\r
  )\r
;\r
/**\r
\r
Routine Description:\r
\r
  This function returns the directory path which contains the particular path.\r
  Some examples:\r
    "a/b/c"  -> "a/b"\r
    "a/b/c/" -> "a/b"\r
    "a"      -> "."\r
    "."      -> ".."\r
    "/"      -> NULL\r
\r
  This function does not check for the existence of the file.\r
\r
  The caller must free the string returned.\r
\r
Arguments:\r
\r
  FilePath     Path name of file to get the parent directory for.\r
\r
Returns:\r
\r
  NULL if error\r
\r
**/\r
\r
\r
VOID\r
OsPathNormPathInPlace (\r
  IN CHAR8    *Path\r
  )\r
;\r
/**\r
\r
Routine Description:\r
\r
  This function returns the directory path which contains the particular path.\r
  Some examples:\r
    "a/b/../c" -> "a/c"\r
    "a/b//c"   -> "a/b/c"\r
    "a/./b"    -> "a/b"\r
\r
  This function does not check for the existence of the file.\r
\r
Arguments:\r
\r
  Path     Path name of file to normalize\r
\r
Returns:\r
\r
  The string is altered in place.\r
\r
**/\r
\r
\r
CHAR8*\r
OsPathPeerFilePath (\r
  IN CHAR8    *OldPath,\r
  IN CHAR8    *Peer\r
  )\r
;\r
/**\r
\r
Routine Description:\r
\r
  This function replaces the final portion of a path with an alternative\r
  'peer' filename.  For example:\r
    "a/b/../c", "peer" -> "a/b/../peer"\r
    "a/b/", "peer"     -> "a/b/peer"\r
    "/a", "peer"       -> "/peer"\r
    "a", "peer"        -> "peer"\r
\r
  This function does not check for the existence of the file.\r
\r
Arguments:\r
\r
  OldPath     Path name of replace the final segment\r
  Peer        The new path name to concatinate to become the peer path\r
\r
Returns:\r
\r
  A CHAR8* string, which must be freed by the caller\r
\r
**/\r
\r
\r
BOOLEAN\r
OsPathExists (\r
  IN CHAR8    *InputFileName\r
  )\r
;\r
/**\r
\r
Routine Description:\r
\r
  Checks if a file exists\r
\r
Arguments:\r
\r
  InputFileName     The name of the file to check for existence\r
\r
Returns:\r
\r
  TRUE              The file exists\r
  FALSE             The file does not exist\r
\r
**/\r
\r
\r
#endif\r