FXPath.h

/********************************************************************************
*                                                                               *
*                  P a t h   N a m e   M a n i p u l a t i o n                  *
*                                                                               *
*********************************************************************************
* Copyright (C) 2000,2025 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* 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 3 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 program.  If not, see <http://www.gnu.org/licenses/>          *
********************************************************************************/
#ifndef FXPATH_H
#define FXPATH_H

namespace FX {

namespace FXPath {

  enum {
    PathName   = 1,        
    NoEscape   = 2,        
    DotFile    = 4,        
    LeadDir    = 8,        
    CaseFold   = 16        
    };

  extern FXAPI FXString root(const FXString& file);

  extern FXAPI FXString share(const FXString& file);

  extern FXAPI FXString server(const FXString& file);

  extern FXAPI FXString drive(const FXString& file);

  extern FXAPI FXString directory(const FXString& file);

  extern FXAPI FXString name(const FXString& file);

  extern FXAPI FXString stem(const FXString& file);

  extern FXAPI FXString extension(const FXString& file);

  extern FXAPI FXString stripExtension(const FXString& file);

  extern FXAPI FXString expand(const FXString& file,FXint level=4);

  extern FXAPI FXString convertToWindows(const FXString& path);

  extern FXAPI FXString convertFromWindows(const FXString& path);

  extern FXAPI FXString convert(const FXString& path);
  
  extern FXAPI FXString convertPathList(const FXString& path);

  extern FXAPI FXString contract(const FXString& file,const FXString& user=FXString::null,const FXString& var=FXString::null);

  extern FXAPI FXString simplify(const FXString& file);

  extern FXAPI FXString absolute(const FXString& file);

  extern FXAPI FXString absolute(const FXString& base,const FXString& file);

  extern FXAPI FXString relative(const FXString& file);

  extern FXAPI FXString relative(const FXString& base,const FXString& file);

  extern FXAPI FXString upLevel(const FXString& file);

  extern FXAPI FXbool isInside(const FXString& base,const FXString& file);

  extern FXAPI FXbool isAbsolute(const FXString& file);

  extern FXAPI FXbool isRelative(const FXString& file);

  extern FXAPI FXbool isTopDirectory(const FXString& file);

  extern FXAPI FXbool isShare(const FXString& file);

  extern FXAPI FXbool isServer(const FXString& file);

  extern FXAPI FXbool isHidden(const FXString& file);

  extern FXAPI FXString validPath(const FXString& file);

  extern FXAPI FXbool isValidPath(const FXString& file);

  extern FXAPI FXString enquote(const FXString& file,FXbool force=false);

  extern FXAPI FXString dequote(const FXString& file);

  extern FXAPI FXint parseArgs(FXchar**& argv,const FXchar* command);

  extern FXAPI FXint parseArgs(FXchar**& argv,const FXString& command);

  extern FXAPI FXbool match(const FXchar* string,const FXchar* pattern="*",FXuint flags=(NoEscape|PathName));

  extern FXAPI FXbool match(const FXString& string,const FXchar* pattern="*",FXuint flags=(NoEscape|PathName));

  extern FXAPI FXbool match(const FXchar* string,const FXString& pattern,FXuint flags=(NoEscape|PathName));

  extern FXAPI FXbool match(const FXString& string,const FXString& pattern,FXuint flags=(NoEscape|PathName));

  extern FXAPI FXString unique(const FXString& file);

  extern FXAPI FXString search(const FXString& pathlist,const FXString& file);

  extern FXAPI FXString relativize(const FXString& pathlist,const FXString& file);

  extern FXAPI FXbool hasExecExtension(const FXString& file);

  extern FXAPI FXbool isReservedName(const FXString& file);

  }

}

#endif