cmnPath.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */
 
/*
  Author(s):  Anton Deguet
  Created on: 2005-04-18
 
  (C) Copyright 2005-2023 Johns Hopkins University (JHU), All Rights Reserved.
 
--- begin cisst license - do not edit ---
 
This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.
 
--- end cisst license ---
 
*/
 

#pragma once
 
#ifndef _cmnPath_h
#define _cmnPath_h
 
#include <cisstCommon/cmnPortability.h>
#include <cisstCommon/cmnGenericObject.h>
#include <cisstCommon/cmnTokenizer.h>
 
#include <string>
#include <list>
#include <sstream>
#include <iostream>
 
// Always the last cisst include
#include <cisstCommon/cmnExport.h>
 
 
#if (CISST_OS == CISST_WINDOWS)
#  include <io.h>
#else
#  include <unistd.h>
#endif
 

class CISST_EXPORT cmnPath: public cmnGenericObject {
    CMN_DECLARE_SERVICES(CMN_NO_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT);
 
public:
    typedef std::list<std::string> ContainerType;

    typedef ContainerType::iterator iterator;
    typedef ContainerType::const_iterator const_iterator;
 
private:
    ContainerType Path;
    cmnTokenizer Tokenizer;

    void ConfigureTokenizer(void);

    static std::string FromNative(const std::string & nativePath);
 
public:
    enum {HEAD = true,
          TAIL = false
    };

#if (CISST_OS == CISST_WINDOWS)
    enum {EXIST = 00,
          WRITE = 02,
          READ = 04,
          EXECUTE = 04
    };
#else
    enum {READ = R_OK,
          WRITE = W_OK,
          EXECUTE = X_OK,
          EXIST = F_OK
    };
#endif
 
    cmnPath(void);

    cmnPath(const std::string & path);

    virtual ~cmnPath(void) {}

    void Set(const std::string & path);

    void Add(const std::string & path, bool head = HEAD);

    bool AddFromEnvironment(const std::string & variableName, bool head = HEAD);

    bool AddRelativeToCisstRoot(const std::string & relativePath, bool head = HEAD);

    bool AddRelativeToCisstShare(const std::string & relativePath, bool head = HEAD);

    std::string Find(const std::string & filename, short mode = READ) const;

    std::string FindWithSubdirectory(const std::string & filename,
                                     const std::string & subdirectory,
                                     short mode = READ) const;

    bool Remove(const std::string & directory);

    bool Has(const std::string & directory) const;

    void ToStream(std::ostream & outputStream) const override;

    static const std::string & DirectorySeparator(void);

    static std::string GetWorkingDirectory(void);

    static bool GetCisstRoot(std::string & result);

    static bool GetCisstShare(std::string & result);

    static bool Exists(const std::string & fullPath, short more = READ);

    static bool DeleteFile(const std::string & fullPath);

    static bool RenameFile(const std::string & fullPathOld,
                           const std::string & fullPathNew);

    inline static std::string SharedLibrary(const std::string & name) {
        return CISST_SHARED_LIBRARY_PREFIX + name + CISST_SHARED_LIBRARY_SUFFIX;
    }

    inline static std::string Executable(const std::string & name) {
        return name + CISST_EXECUTABLE_SUFFIX;
    }
};
 
 
// Add services instantiation
CMN_DECLARE_SERVICES_INSTANTIATION(cmnPath)
 
 
#endif // _cmnPath_h