159 lines
4.8 KiB
C++
159 lines
4.8 KiB
C++
/** @file
|
|
* @author Edouard DUPIN
|
|
*
|
|
* @copyright 2011, Edouard DUPIN, all right reserved
|
|
*
|
|
* @license APACHE v2.0 (see license file)
|
|
*/
|
|
|
|
#include <etk/types.h>
|
|
|
|
#pragma once
|
|
|
|
namespace etk {
|
|
/**
|
|
* @brief File System Right management
|
|
*/
|
|
class FSNodeRight {
|
|
private:
|
|
uint16_t m_rights; //!< right manage in a bit field
|
|
public:
|
|
/**
|
|
* @brief Right contructor.
|
|
* @param[in] _newRight Right to set by default
|
|
*/
|
|
FSNodeRight(int16_t _newRight = 0);
|
|
/**
|
|
* @brief Copy asignement operator (operator=)
|
|
* @param[in] _obj Object to copy
|
|
* @return Local reference on the object
|
|
*/
|
|
etk::FSNodeRight& operator= (const etk::FSNodeRight &_obj);
|
|
/**
|
|
* @brief Asignement operator (operator=)
|
|
* @param[in] _newVal Value to set on the right
|
|
* @return Local reference on the object
|
|
*/
|
|
etk::FSNodeRight& operator= (const int32_t _newVal );
|
|
/**
|
|
* @brief Clear right (set the value at 0 ==> cant not be read/write/execute
|
|
*/
|
|
void clear();
|
|
/**
|
|
* @brief Get the "Read status" for the "User"
|
|
* @return true The file/folder/... is readable
|
|
* @return false The file/folder/... is NOT readable
|
|
*/
|
|
bool isUserReadable() const;
|
|
/**
|
|
* @brief Get the "Write status" for the "User"
|
|
* @return true The file/folder/... is writable
|
|
* @return false The file/folder/... is NOT writable
|
|
*/
|
|
bool isUserWritable() const;
|
|
/**
|
|
* @brief Get the "execute status" for the "User"
|
|
* @return true The file/folder/... is executable
|
|
* @return false The file/folder/... is NOT executable
|
|
*/
|
|
bool isUserRunable() const;
|
|
/**
|
|
* @brief Set the "Read status" for the "User"
|
|
* @param[in] _newStatus New value to set on the file/folder/...
|
|
*/
|
|
void setUserReadable(bool _newStatus);
|
|
/**
|
|
* @brief Set the "Write status" for the "User"
|
|
* @param[in] _newStatus New value to set on the file/folder/...
|
|
*/
|
|
void setUserWritable(bool _newStatus);
|
|
/**
|
|
* @brief Set the "execute status" for the "User"
|
|
* @param[in] _newStatus New value to set on the file/folder/...
|
|
*/
|
|
void setUserRunable(bool _newStatus);
|
|
/**
|
|
* @brief Get the "Read status" for the "Group"
|
|
* @return true The file/folder/... is readable
|
|
* @return false The file/folder/... is NOT readable
|
|
*/
|
|
bool isGroupReadable() const;
|
|
/**
|
|
* @brief Get the "Write status" for the "Group"
|
|
* @return true The file/folder/... is writable
|
|
* @return false The file/folder/... is NOT writable
|
|
*/
|
|
bool isGroupWritable() const;
|
|
/**
|
|
* @brief Get the "execute status" for the "Group"
|
|
* @return true The file/folder/... is executable
|
|
* @return false The file/folder/... is NOT executable
|
|
*/
|
|
bool isGroupRunable() const;
|
|
/**
|
|
* @brief Set the "Read status" for the "Group"
|
|
* @param[in] _newStatus New value to set on the file/folder/...
|
|
*/
|
|
void setGroupReadable(bool _newStatus);
|
|
/**
|
|
* @brief Set the "Write status" for the "Group"
|
|
* @param[in] _newStatus New value to set on the file/folder/...
|
|
*/
|
|
void setGroupWritable(bool _newStatus);
|
|
/**
|
|
* @brief Set the "Execute status" for the "Group"
|
|
* @param[in] _newStatus New value to set on the file/folder/...
|
|
*/
|
|
void setGroupRunable(bool _newStatus);
|
|
/**
|
|
* @brief Get the "Read status" for the "Other"
|
|
* @return true The file/folder/... is readable
|
|
* @return false The file/folder/... is NOT readable
|
|
*/
|
|
bool isOtherReadable() const;
|
|
/**
|
|
* @brief Get the "Write status" for the "Other"
|
|
* @return true The file/folder/... is writable
|
|
* @return false The file/folder/... is NOT writable
|
|
*/
|
|
bool isOtherWritable() const;
|
|
/**
|
|
* @brief Get the "execute status" for the "Other"
|
|
* @return true The file/folder/... is executable
|
|
* @return false The file/folder/... is NOT executable
|
|
*/
|
|
bool isOtherRunable() const;
|
|
/**
|
|
* @brief Set the "Read status" for the "Other"
|
|
* @param[in] _newStatus New value to set on the file/folder/...
|
|
*/
|
|
void setOtherReadable(bool _newStatus);
|
|
/**
|
|
* @brief Set the "Write status" for the "Other"
|
|
* @param[in] _newStatus New value to set on the file/folder/...
|
|
*/
|
|
void setOtherWritable(bool _newStatus);
|
|
/**
|
|
* @brief Set the "Execute status" for the "Other"
|
|
* @param[in] _newStatus New value to set on the file/folder/...
|
|
*/
|
|
void setOtherRunable(bool _newStatus);
|
|
#if __CPP_VERSION__ >= 2011
|
|
/**
|
|
* @brief Get the write written in a string mode (like in linux rw-r-----)
|
|
* @return String with the right in string
|
|
*/
|
|
std::u32string getURight() const;
|
|
#endif
|
|
/**
|
|
* @brief Get the write written in a string mode (like in linux rw-r-----)
|
|
* @return String with the right in string
|
|
*/
|
|
std::string getRight() const;
|
|
};
|
|
//! @not_in_doc
|
|
std::ostream& operator <<(std::ostream &_os, const etk::FSNodeRight &_obj);
|
|
}
|
|
|
|
|