juce/source/extras/Introjucer/Source/Utility/jucer_RelativePath.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-10 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCER_RELATIVEPATH_JUCEHEADER__
  27 #define __JUCER_RELATIVEPATH_JUCEHEADER__
  28
  29
  30 //==============================================================================
  31 /** Manipulates a cross-platform partial file path. (Needed because File is designed
  32     for absolute paths on the active OS)
  33 */
  34 class RelativePath
  35 {
  36 public:
  37     //==============================================================================
  38     enum RootFolder
  39     {
  40         unknown,
  41         projectFolder,
  42         buildTargetFolder
  43     };
  44
  45     //==============================================================================
  46     RelativePath()
  47         : root (unknown)
  48     {}
  49
  50     RelativePath (const String& path_, const RootFolder root_)
  51         : path (path_.replaceCharacter ('\\', '/')), root (root_)
  52     {
  53     }
  54
  55     RelativePath (const File& file, const File& rootFolder, const RootFolder root_)
  56         : path (file.getRelativePathFrom (rootFolder).replaceCharacter ('\\', '/')), root (root_)
  57     {
  58     }
  59
  60     RootFolder getRoot() const                              { return root; }
  61
  62     const String toUnixStyle() const                        { return FileHelpers::unixStylePath (path); }
  63     const String toWindowsStyle() const                     { return FileHelpers::windowsStylePath (path); }
  64
  65     const String getFileName() const                        { return getFakeFile().getFileName(); }
  66     const String getFileNameWithoutExtension() const        { return getFakeFile().getFileNameWithoutExtension(); }
  67
  68     const String getFileExtension() const                   { return getFakeFile().getFileExtension(); }
  69     bool hasFileExtension (const String& extension) const   { return getFakeFile().hasFileExtension (extension); }
  70     bool isAbsolute() const                                 { return isAbsolute (path); }
  71
  72     const RelativePath withFileExtension (const String& extension) const
  73     {
  74         return RelativePath (path.upToLastOccurrenceOf (".", ! extension.startsWithChar ('.'), false) + extension, root);
  75     }
  76
  77     const RelativePath getParentDirectory() const
  78     {
  79         String p (path);
  80         if (path.endsWithChar ('/'))
  81             p = p.dropLastCharacters (1);
  82
  83         return RelativePath (p.upToLastOccurrenceOf ("/", false, false), root);
  84     }
  85
  86     const RelativePath getChildFile (const String& subpath) const
  87     {
  88         if (isAbsolute (subpath))
  89             return RelativePath (subpath, root);
  90
  91         String p (toUnixStyle());
  92         if (! p.endsWithChar ('/'))
  93             p << '/';
  94
  95         return RelativePath (p + subpath, root);
  96     }
  97
  98     const RelativePath rebased (const File& originalRoot, const File& newRoot, const RootFolder newRootType) const
  99     {
 100         if (isAbsolute())
 101             return RelativePath (path, newRootType);
 102
 103         return RelativePath (originalRoot.getChildFile (toUnixStyle()).getRelativePathFrom (newRoot), newRootType);
 104     }
 105
 106 private:
 107     //==============================================================================
 108     String path;
 109     RootFolder root;
 110
 111     const File getFakeFile() const
 112     {
 113         return File::getCurrentWorkingDirectory().getChildFile (path);
 114     }
 115
 116     static bool isAbsolute (const String& path)
 117     {
 118         return File::isAbsolutePath (path)
 119                 || path.startsWithChar ('/') // (needed because File::isAbsolutePath will ignore forward-slashes on win32)
 120                 || path.startsWithChar ('$')
 121                 || path.startsWithChar ('~')
 122                 || (CharacterFunctions::isLetter (path[0]) && path[1] == ':')
 123                 || path.startsWithIgnoreCase ("smb:");
 124     }
 125 };
 126
 127
 128 #endif   // __JUCER_RELATIVEPATH_JUCEHEADER__