Code cleanup (#251)
[platform/core/dotnet/launcher.git] / NativeLauncher / inc / utils.h
index c8843b5..1c930ee 100644 (file)
@@ -39,14 +39,6 @@ enum FSFlag : int {
   FS_PRESERVE_OWNERSHIP_AND_PERMISSIONS = (1 << 3)
 };
 
-bool cmdOptionExists(char** begin, char** end, const std::string& option);
-
-/**
- * @brief get current executable path
- * return std::string path
- */
-std::string readSelfPath();
-
 /**
  * @brief concat path with PATH_SEPARATOR
  * @param[in] destination path
@@ -56,25 +48,56 @@ std::string readSelfPath();
 std::string concatPath(const std::string& path1, const std::string& path2);
 
 /**
- * @brief get absolute Path
+ * @brief get canonicalized absolute Path
  * @param[in] source path
  * return std::string result path
  */
-std::string absolutePath(const std::string& path);
+std::string getAbsolutePath(const std::string& path);
 
 /**
  * @brief get the directory of file
  * @param[in] source path
  * return std::string result path
  */
-std::string baseName(const std::string& path);
+std::string getBaseName(const std::string& path);
+
+/**
+ * @brief replaces all matching substrings of the regular expression with a given replacement
+ * @param[in] original string
+ * @param[in] pattern to match
+ * @param[in] replacement string
+ * return std::string the modified string
+ */
+std::string replaceAll(const std::string& str, const std::string& pattern, const std::string& replace);
 
 /**
  * @brief get root path
  * @param[in] package id
- * @param[out] root path
+ * return std::string root path
+ */
+std::string getRootPath(const std::string& pkgId);
+
+/**
+ * @brief get exec name
+ * @param[in] package id
+ * return std::string exec name
+ */
+std::string getExecName(const std::string& pkgId);
+
+/**
+ * @brief get app type
+ * @param[in] package id
+ * return std::string app type
+ */
+std::string getAppType(const std::string& pkgId);
+
+/**
+ * @brief get metadata value
+ * @param[in] package id
+ * @param[in] metadata key
+ * return std::string metadata value
  */
-int getRootPath(std::string pkgId, std::string& rootPath);
+std::string getMetadataValue(const std::string& pkgId, const std::string& key);
 
 /**
  * @brief split path with ":" delimiter and put that in the vector
@@ -84,18 +107,18 @@ int getRootPath(std::string pkgId, std::string& rootPath);
 void splitPath(const std::string& path, std::vector<std::string>& out);
 
 /**
- * @brief check file is exist
+ * @brief check file exists
  * @param[in] source path
  * @return bool
  */
-bool isFileExist(const std::string& path);
+bool isFile(const std::string& path);
 
 /**
- * @brief get file size
+ * @brief check directory exists
  * @param[in] source path
- * @return size of file
+ * @return bool
  */
-uintptr_t getFileSize(const std::string& path);
+bool isDirectory(const std::string& path);
 
 /**
  * @brief check the file is managed assembly or not.
@@ -113,24 +136,36 @@ bool isManagedAssembly(const std::string& filePath);
 bool isNativeImage(const std::string& filePath);
 
 /**
- * @brief find assembly files in the directories
- * @param[in] directories
- * @param[out] ":" seperated assembly path list
+ * @brief Resolve assembly files from directories and append their paths to the given list.
+ * @remark If a native image exists for an assembly in the same directory, it will be used.
+ *         If multiple assemblies of the same name exist, the first one will be used.
+ * @param[in]  directories  list of directories
+ * @param[out] list         colon-separated string of assembly paths
  */
-void assembliesInDirectory(const std::vector<std::string>& directories, std::string& tpaList);
+void addAssembliesFromDirectories(const std::vector<std::string>& directories, std::string& list);
 
 /**
- * @brief function pointer for file reader
+ * @brief File search callback
+ * @param[in] path      full path to a resolved file
+ * @param[in] filename  file name
  */
-typedef std::function<void (const std::string&, const char*)> FileReader;
+typedef std::function<void (const std::string& path, const std::string& filename)> FileReader;
 
 /**
- * @brief scan files in the given directory and run file reader function for that
- * @param[in] directory
- * @param[in] file reader function
- * @param[in] scan depth
+ * @brief Scan all files in the given directory.
+ * @param[in] directory path to a root directory
+ * @param[in] reader    callback for iteration
+ * @param[in] depth     recursive search depth
  */
-void scanFilesInDir(const std::string& directory, FileReader reader, unsigned int depth);
+void scanFilesInDirectory(const std::string& directory, FileReader reader, unsigned int depth);
+
+/**
+ * @brief copy smack and ownership.
+ * @param[in] get path
+ * @param[in] set path
+ * @param[in] symbolic link
+ */
+void copySmackAndOwnership(const std::string& fromPath, const std::string& toPath, bool isSymlink = false);
 
 /**
  * @brief create the new directory.
@@ -140,13 +175,6 @@ void scanFilesInDir(const std::string& directory, FileReader reader, unsigned in
 bool createDir(const bf::path& path);
 
 /**
- * @brief update assembly file info.
- * @param[in] get path
- * @param[in] set path
- */
-void updateAssemblyInfo(const std::string& getPath, const std::string& setPath);
-
-/**
  * @brief copy the directory.
  * @param[in] path to the source directory
  * @param[in] path to the target directory
@@ -185,4 +213,18 @@ bool removeFile(const bf::path& path);
  */
 bool removeAll(const bf::path& path);
 
+/**
+ * @brief change command name of the current process for access via ps command
+ * @param[in] name
+ */
+void setCmdName(const std::string& name);
+
+/**
+ * @brief Get the file name from the specified path.
+ * @remark An empty string will be returned if the path string ends with a path separator character.
+ * @param[in] path  path to a file
+ * @return a substring after the path separator character
+ */
+std::string getFileName(const std::string& path);
+
 #endif /* __UTILS_H__ */