xpathoperation.h

//
//  xpathoperation.h
// These functions are declared in macos_fileoperation, win_fileoperation...
//
//  Created by Mootools on 20/05/2016.
//  Copyright © 2016 Mootools. All rights reserved.
//
 
#ifndef xpathoperation_h
#define xpathoperation_h
 
BEGIN_MOOTOOLS_NAMESPACE
 
typedef enum XURL_TYPE
{
    XURL_INVALID = 0, // This is not an url
    XURL_DIRECTORY = 0x01,
    XURL_FILE = 0x02,
} XURL_TYPE;
 
typedef enum XPATH_GETPART
{
    XPATH_GET_ROOT,
    XPATH_GET_PATH,
    XPATH_STRIP_PATH,
    XPATH_GET_FILENAME,
    XPATH_STRIP_FILENAME,
    XPATH_GET_EXT,
    XPATH_STRIP_EXT,
    XPATH_GET_SHORTEST_PATH, // Return the shortest path when . and .. exists (ie path such C:\abc\..\abc\file.txt). Return the path itself if it fails.
    XPATH_GET_QUERY, // Must be an URL
} XPATH_GETPART;
 
typedef enum XPATH_QUALIFY
{
    XPATH_IS_VALID_NAME = 1, // Check if the name is o/S compatible (ie windows : length < MAX_PATH)
    XPATH_IS_RELATIVE,
    XPATH_IS_ROOT,
    XPATH_IS_VALID_DIRECTORY, // occurs when XFILE_ATTRIBUTE_DIRECTORY attribute is set for the path 
    XPATH_IS_URL,
    XPATH_IS_UNC,
    XPATH_IS_NETWORK,
    XPATH_IS_EXE,
} XPATH_QUALIFY;
 
void xPathSlashTerminate(CXString& path);
bool xPathQualify(const CXString& path, XPATH_QUALIFY part);
CXString xPathGetPart(const CXString& path, XPATH_GETPART part, bool *result = NULL);
unsigned int xPathQualifyURL(const CXString& path); // Return non 0 XURL_TYPE combination if path is an URL, 0 otherwise
CXString xPathConvertToAbsolutePath(const CXString& mainPath, const CXString& relativePath); // If relativePath is relative, make the path absolute using mainPath. Otherwise return relativePath. Cf PathCanonicalize
 
END_MOOTOOLS_NAMESPACE
 
#ifdef __WINDOWS__
    #include "./win/win_pathoperation.h"
#elif defined (__APPLE__)
    #include "./macos/macos_pathoperation.h"
#elif defined (__LINUX__)
    #include "./linux/linux_pathoperation.h"
#endif
 
#endif /* xpathoperation_h */