DDD_PathManager.h

Go to the documentation of this file.

/*! \file DDD_PathManager.h
  
  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#ifndef DDD_PATH_MANAGER_H_
#define DDD_PATH_MANAGER_H_

#include <string>
#include "DDD_Include.h"

namespace disti
{

/** The DDD_PathManager class allows the application to handle multiple base paths for relative path access. 
 *  For example, the location of the assets and converters are relative to that of the application, but
 *  the RSOs loaded by a .ddd file would be relative to the file. This class is easily accessible anywhere where
 *  DataDirector apps are created, so the right working directory can be accessed appropriately whenever relative
 *  paths may be encountered.
 */
class DDD_EXPORT DDD_PathManager
{
private:
    /** Constructor - private to ensure singleton-only access*/
    DDD_PathManager();

public:
    /** singleton interface */
    static DDD_PathManager& Instance();

    /** Destructor */
    ~DDD_PathManager();

    /** Is path a relative path? 
     * \param path Path string to check
     * \return true if given path string is a relative path 
     */
    static bool IsPathRelative(const std::string& pathStr);

    /** Is path a absolute path? 
     * \param path Path string to check
     * \return true if given path string is an absolute path 
     */
    static bool IsPathAbsolute(const std::string& pathStr);

    /** Checks given path string (whether relative or absolute) to determine if given path or file exists
     * \param path Path string to check
     * \return true if given path string is a valid path
     */
    static bool IsPathValid(const std::string& pathStr);

    /** Attempts to convert the relative path to an absolute path 
     * \param pathStr Path string to convert
     * \param absPath Absolute path returned by method
     */
    bool MakeAbsolutePath(const std::string& pathStr, std::string& absPath);

    /** Sets the loaded DDD config path (.ddd) file 
     * \param path Absolute path to config file
     */
    void DDDConfigPath(const std::string& pathStr);

    /** \return The absolute path to the loaded DDD config (.ddd file), if available */
    std::string DDDConfigPath();

    /** Gets the relative path from DDD configuration file
     * \param absPath Absolute pathname
     * \return Path string relative to that of the DDD file
     */
    std::string GetRelativePathFromDDDConfig(const std::string& absPath);

    /** Sets the calling application path 
     * \param path Absolute path to calling application
     */
    void CallingAppPath(const std::string& path);

    /** \return The absolute path to the calling application */
    std::string CallingAppPath();

    /** Gets the relative path from calling app
     * \param absPath Absolute pathname
     * \return Path string relative to that of the calling app
     */
    std::string GetRelativePathFromCallingApp(const std::string& absPath);
};


}   // end namespace disti


#endif // DDD_PATH_MANAGER_H_