Refactoring the dotnettool (#231)

[platform/core/dotnet/launcher.git] / NativeLauncher / inc / utils.h

diff --git a/NativeLauncher/inc/utils.h b/NativeLauncher/inc/utils.h
index f1d4306..90cc23d 100644 (file)
--- a/NativeLauncher/inc/utils.h
+++ b/NativeLauncher/inc/utils.h
@@ -39,6 +39,12 @@ enum FSFlag : int {
   FS_PRESERVE_OWNERSHIP_AND_PERMISSIONS = (1 << 3)
 };
 
+/**
+ * @brief an iterator to the begin element in the range that compares equal to option
+ * @param[in] begin element
+ * @param[in] end elment
+ * return return true when elements match
+ */
 bool cmdOptionExists(char** begin, char** end, const std::string& option);
 
 /**
@@ -70,6 +76,15 @@ std::string absolutePath(const std::string& path);
 std::string baseName(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 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
@@ -77,6 +92,21 @@ std::string baseName(const std::string& path);
 int getRootPath(std::string pkgId, std::string& rootPath);
 
 /**
+ * @brief get exec name
+ * @param[in] package id
+ * @param[out] exec name
+ */
+int getExecName(std::string pkgId, std::string& execName);
+
+/**
+ * @brief get metadata value
+ * @param[in] package id
+ * @param[in] metadata key
+ * @param[out] metadata value
+ */
+int getMetadataValue(std::string pkgId, std::string metadataKey, std::string& metadataValue);
+
+/**
  * @brief split path with ":" delimiter and put that in the vector
  * @param[in] source path
  * @param[out] string vector
@@ -91,6 +121,20 @@ void splitPath(const std::string& path, std::vector<std::string>& out);
 bool isFileExist(const std::string& path);
 
 /**
+ * @brief check directory is exist
+ * @param[in] source path
+ * @return bool
+ */
+bool isDirectoryExist(const std::string& path);
+
+/**
+ * @brief get file size
+ * @param[in] source path
+ * @return size of file
+ */
+uintptr_t getFileSize(const std::string& path);
+
+/**
  * @brief check the file is managed assembly or not.
  * @param[in] file path
  * @return return true when the file is managed assembly.
@@ -106,24 +150,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 addAssembliesFromDirectories(const std::vector<std::string>& directories, std::string& list);
+
+/**
+ * @brief File search callback
+ * @param[in] path      full path to a resolved file
+ * @param[in] filename  file name
  */
-void assembliesInDirectory(const std::vector<std::string>& directories, std::string& tpaList);
+typedef std::function<void (const std::string& path, const std::string& filename)> FileReader;
 
 /**
- * @brief function pointer for file reader
+ * @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
  */
-typedef std::function<void (const std::string&, const char*)> FileReader;
+void scanFilesInDirectory(const std::string& directory, FileReader reader, unsigned int depth);
 
 /**
- * @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 copy smack and ownership.
+ * @param[in] get path
+ * @param[in] set path
+ * @param[in] symbolic link
  */
-void scanFilesInDir(const std::string& directory, FileReader reader, unsigned int depth);
+void copySmackAndOwnership(const std::string& fromPath, const std::string& toPath, bool isSymlink = false);
 
 /**
  * @brief create the new directory.
@@ -133,13 +189,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
@@ -178,4 +227,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__ */