path.h 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. #pragma once
  2. #include <m-string.h>
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6. /**
  7. * @brief Extract filename without extension from path.
  8. *
  9. * @param path path string
  10. * @param filename output filename string. Must be initialized before.
  11. */
  12. void path_extract_filename_no_ext(const char* path, string_t filename);
  13. /**
  14. * @brief Extract filename string from path.
  15. *
  16. * @param path path string
  17. * @param filename output filename string. Must be initialized before.
  18. * @param trim_ext true - get filename without extension
  19. */
  20. void path_extract_filename(string_t path, string_t filename, bool trim_ext);
  21. /**
  22. * @brief Extract file extension from path.
  23. *
  24. * @param path path string
  25. * @param ext output extension string
  26. * @param ext_len_max maximum extension string length
  27. */
  28. void path_extract_extension(string_t path, char* ext, size_t ext_len_max);
  29. /**
  30. * @brief Extract last path component
  31. *
  32. * @param path path string
  33. * @param filename output string. Must be initialized before.
  34. */
  35. void path_extract_basename(const char* path, string_t basename);
  36. /**
  37. * @brief Extract path, except for last component
  38. *
  39. * @param path path string
  40. * @param filename output string. Must be initialized before.
  41. */
  42. void path_extract_dirname(const char* path, string_t dirname);
  43. /**
  44. * @brief Appends new component to path, adding path delimiter
  45. *
  46. * @param path path string
  47. * @param suffix path part to apply
  48. */
  49. void path_append(string_t path, const char* suffix);
  50. /**
  51. * @brief Appends new component to path, adding path delimiter
  52. *
  53. * @param path first path part
  54. * @param suffix second path part
  55. * @param out_path output string to combine parts into. Must be initialized
  56. */
  57. void path_concat(const char* path, const char* suffix, string_t out_path);
  58. /**
  59. * @brief Check that path contains only ascii characters
  60. *
  61. * @param path
  62. * @return true
  63. * @return false
  64. */
  65. bool path_contains_only_ascii(const char* path);
  66. #ifdef __cplusplus
  67. }
  68. #endif