ReadDirectory() added in webrtc/test/testsupport/fileutils.h

webrtc/test/testsupport/fileutils.cc

 /*
  *  Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
 #include "webrtc/test/testsupport/fileutils.h"
 
 #include <assert.h>
 
 #ifdef WIN32
 #include <direct.h>
 #include <tchar.h>
 #include <windows.h>
 #include <algorithm>
 
 #include "Shlwapi.h"
 #include "WinDef.h"
 
 #include "webrtc/base/win32.h"
 #define GET_CURRENT_DIR _getcwd
 #else
+#include <dirent.h>
 #include <unistd.h>
 
 #define GET_CURRENT_DIR getcwd
 #endif
 
 #include <sys/stat.h>  // To check for directory existence.
 #ifndef S_ISDIR  // Not defined in stat.h on Windows.
 #define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)
 #endif
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
 #include <memory>
 
+#include "webrtc/base/checks.h"
 #include "webrtc/typedefs.h"  // For architecture defines
 
 namespace webrtc {
 namespace test {
 
 #if defined(WEBRTC_IOS)
 // Defined in iosfileutils.mm.  No header file to discourage use elsewhere.
 std::string IOSOutputPath();
 std::string IOSRootPath();
 std::string IOSResourcePath(std::string name, std::string extension);
@@ skipping 16 matching lines @@
 const char* kFallbackPath = "./";
 #endif  // !defined(WEBRTC_ANDROID)
 
 #if !defined(WEBRTC_IOS)
 const char* kResourcesDirName = "resources";
 #endif
 
 char relative_dir_path[FILENAME_MAX];
 bool relative_dir_path_set = false;
 
+#ifdef WIN32
+rtc::Optional<std::vector<std::string>> ReadDirectoryWin(std::string path) {
+  // Append separator character if needed.
+  if (path.back() != '\\')
+    path += '\\';
+
+  // Init.
+  WIN32_FIND_DATA data;
+  HANDLE handle = ::FindFirstFile(rtc::ToUtf16(path + '*').c_str(), &data);
+  if (handle == INVALID_HANDLE_VALUE)
+    return rtc::Optional<std::vector<std::string>>();
+
+  // Populate output.
+  std::vector<std::string> found_entries;
+  do {
+    const std::string name = rtc::ToUtf8(data.cFileName);
+    if (name != "." && name != "..")
+      found_entries.emplace_back(path + name);
+  } while (::FindNextFile(handle, &data) == TRUE);
+
+  // Release resources.
+  if (handle != INVALID_HANDLE_VALUE)
+    ::FindClose(handle);
+
+  return rtc::Optional<std::vector<std::string>>(std::move(found_entries));
+}
+#else
+rtc::Optional<std::vector<std::string>> ReadDirectoryNotWin(std::string path) {
+  // Append separator character if needed.
+  if (path.back() != '/')
+    path += '/';
+
+  // Init.
+  DIR* dir = ::opendir(path.c_str());
+  if (dir == nullptr)
+    return rtc::Optional<std::vector<std::string>>();
+
+  // Populate output.
+  std::vector<std::string> found_entries;
+  while (dirent* dirent = readdir(dir)) {
+    const std::string& name = dirent->d_name;
+    if (name != "." && name != "..")
+      found_entries.emplace_back(path + name);
+  }
+
+  // Release resources.
+  closedir(dir);
+
+  return rtc::Optional<std::vector<std::string>>(std::move(found_entries));
+}
+#endif
+
 }  // namespace
 
 const char* kCannotFindProjectRootDir = "ERROR_CANNOT_FIND_PROJECT_ROOT_DIR";
 
 void SetExecutablePath(const std::string& path) {
   std::string working_dir = WorkingDir();
   std::string temp_path = path;
 
   // Handle absolute paths; convert them to relative paths to the working dir.
   if (path.find(working_dir) != std::string::npos) {
@@ skipping 30 matching lines @@
 }
 
 std::string OutputPath() {
   return kRootDirName;
 }
 
 std::string WorkingDir() {
   return kRootDirName;
 }
 
-#else // WEBRTC_ANDROID
+#else  // WEBRTC_ANDROID
 
 std::string ProjectRootPath() {
 #if defined(WEBRTC_IOS)
   return IOSRootPath();
 #else
   std::string path = WorkingDir();
   if (path == kFallbackPath) {
     return kCannotFindProjectRootDir;
   }
   if (relative_dir_path_set) {
@@ skipping 65 matching lines @@
     assert(false);
     return "";
   } else {
     ::close(fd);
   }
   std::string ret(tempname.get());
   return ret;
 #endif
 }
 
+rtc::Optional<std::vector<std::string>> ReadDirectory(const std::string& path) {
+  if (path.length() == 0)
+    return rtc::Optional<std::vector<std::string>>();
+#if defined(WEBRTC_WIN)
+  return ReadDirectoryWin(path);

[nisse-webrtc, 2017/05/30 12:18:53]

To me, it was more readable with the windows and non-windows versions inlined
here.

[kwiberg-webrtc, 2017/05/30 12:37:00]

Really? I generally find that readability is hurt a lot when #ifdefs slice a
scope in half.

[nisse-webrtc, 2017/05/30 12:55:25]

At least in this case, when there's clearly two separate implementations, each
only a dozen lines. And I don't like the FooWin and FooNoWin names, for a couple
of reasons.

I'd say, either use the pattern

#ifdef WIN32  // BTW, should it be WEBRTC_WIN?
rtc::Optional<std::vector<std::string>> ReadDirectory(const std::string& path) {
...
}
#else
rtc::Optional<std::vector<std::string>> ReadDirectory(const std::string& path) {
...
}
#endif

using a single function name, and accept a small amount of code duplication. Or

rtc::Optional<std::vector<std::string>> ReadDirectory(const std::string& path) {
  if (path.empty()) ...

  std::vector<...> entries;
#if WIN32
...
#else
...
#endif
  return rtc::Optional<...>(std::move(entries));
}

with some common code collected at the beginning and end of the function body.

+#else
+  return ReadDirectoryNotWin(path);
+#endif
+}
+
 bool CreateDir(const std::string& directory_name) {
   struct stat path_info = {0};
   // Check if the path exists already:
   if (stat(directory_name.c_str(), &path_info) == 0) {
     if (!S_ISDIR(path_info.st_mode)) {
       fprintf(stderr, "Path %s exists but is not a directory! Remove this "
               "file and re-run to create the directory.\n",
               directory_name.c_str());
       return false;
     }
@@ skipping 75 matching lines @@
     if (fseek(f, 0, SEEK_END) == 0) {
       size = ftell(f);
     }
     fclose(f);
   }
   return size;
 }
 
 }  // namespace test
 }  // namespace webrtc