#pragma region CPL License
/*
Nuclex Native Framework
Copyright (C) 2002-2013 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 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
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#pragma endregion // CPL License

#ifndef NUCLEX_STORAGE_FILESYSTEM_LINUXPATHFORMAT_H
#define NUCLEX_STORAGE_FILESYSTEM_LINUXPATHFORMAT_H

#include "Nuclex/Storage/Config.h"

#if defined(NUCLEX_STORAGE_LINUX)

#include <string>

namespace Nuclex { namespace Storage { namespace FileSystem {

  // ------------------------------------------------------------------------------------------- //

  /// <summary>Defines the path format used on Linux-based systems</summary>
  class LinuxPathFormat {

    /// <summary>The preferred path separator of this platform</summary>
    public: static const char PathSeparator;

    /// <summary>Whether this platform has a current working directory</summary>
    public: static const bool HasCurrentWorkingDirectory;

    /// <summary>Determines if the specified character is a path separator</summary>
    /// <param name="character">Character that will be checked for being a path separator</param>
    /// <returns>True if the specified character is a path separator</returns>
    public: static bool IsPathSeparator(char character) {
      return (character == PathSeparator);
    }

    /// <summary>Always returns false since Linux doesn't use drive letters</summary>
    /// <returns>False, always</returns>
    public: static bool ContainsDriveLetter(const std::string &) {
      return false;
    }

    /// <summary>Returns the current working directory</summary>
    /// <returns>The current working directory</returns>
    public: static std::string GetCurrentWorkingDirectory();

    /// <summary>Determines if the specified path is an absolute path</summary>
    /// <param name="path">Path that will be checked</param>
    /// <returns>True if the specified path is an absolute path</returns>
    public: static bool IsAbsolutePath(const std::string &path) {
      return (GetAbsolutePathPrefixLength(path) > 0);
    }

    /// <summary>Determines the length of the absolute path prefix in the path</summary>
    /// <param name="path">
    ///   Path in which the length of the absolute path prefix will be determined
    /// </param>
    /// <returns>The length of the absolute path prefix in the specified path</returns>
    /// <remarks>
    ///   This returns the number of characters that qualify the specified path as
    ///   an absolute path. The path "/tmp/x" would for example return 1 since the starting
    ///   slash makes this an absolute path. "~/myfile" would return 2 since both
    ///   the home directory and slash are required. "moo" returns 0 since it is relative.
    /// </remarks>
    public: static std::size_t GetAbsolutePathPrefixLength(const std::string &path);

  };

  // ------------------------------------------------------------------------------------------- //

}}} // namespace Nuclex::Storage::FileSystem

#endif // defined(NUCLEX_STORAGE_LINUX)
#endif // NUCLEX_STORAGE_FILESYSTEM_LINUXPATHFORMAT_H