retro_dirent.h 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. /* Copyright (C) 2010-2019 The RetroArch team
  2. *
  3. * ---------------------------------------------------------------------------------------
  4. * The following license statement only applies to this file (retro_dirent.h).
  5. * ---------------------------------------------------------------------------------------
  6. *
  7. * Permission is hereby granted, free of charge,
  8. * to any person obtaining a copy of this software and associated documentation files (the "Software"),
  9. * to deal in the Software without restriction, including without limitation the rights to
  10. * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
  11. * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
  12. *
  13. * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  14. *
  15. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  16. * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  18. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  19. * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21. */
  22. #ifndef __RETRO_DIRENT_H
  23. #define __RETRO_DIRENT_H
  24. #include <libretro.h>
  25. #include <retro_common_api.h>
  26. #include <retro_miscellaneous.h>
  27. #include <boolean.h>
  28. RETRO_BEGIN_DECLS
  29. #define DIRENT_REQUIRED_VFS_VERSION 3
  30. void dirent_vfs_init(const struct retro_vfs_interface_info* vfs_info);
  31. typedef struct RDIR RDIR;
  32. /**
  33. *
  34. * retro_opendir:
  35. * @name : path to the directory to open.
  36. *
  37. * Opens a directory for reading. Tidy up with retro_closedir.
  38. *
  39. * Returns: RDIR pointer on success, NULL if name is not a
  40. * valid directory, null itself or the empty string.
  41. */
  42. struct RDIR *retro_opendir(const char *name);
  43. struct RDIR *retro_opendir_include_hidden(const char *name, bool include_hidden);
  44. int retro_readdir(struct RDIR *rdir);
  45. /* Deprecated, returns false, left for compatibility */
  46. bool retro_dirent_error(struct RDIR *rdir);
  47. const char *retro_dirent_get_name(struct RDIR *rdir);
  48. /**
  49. *
  50. * retro_dirent_is_dir:
  51. * @rdir : pointer to the directory entry.
  52. * @unused : deprecated, included for compatibility reasons, pass NULL
  53. *
  54. * Is the directory listing entry a directory?
  55. *
  56. * Returns: true if directory listing entry is
  57. * a directory, false if not.
  58. */
  59. bool retro_dirent_is_dir(struct RDIR *rdir, const char *unused);
  60. void retro_closedir(struct RDIR *rdir);
  61. RETRO_END_DECLS
  62. #endif