WebRTC: Replace ProjectRootPath by ResourcePath

webrtc/test/testsupport/fileutils.h

 /*
  *  Copyright (c) 2011 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 <stdio.h>
 
-// File utilities for testing purposes.
-//
-// The ProjectRootPath() method is a convenient way of getting an absolute
-// path to the project source tree root directory. Using this, it is easy to
-// refer to test resource files in a portable way.
-//
-// Notice that even if Windows platforms use backslash as path delimiter, it is
-// also supported to use slash, so there's no need for #ifdef checks in test
-// code for setting up the paths to the resource files.
-//
-// Example use:
-// Assume we have the following code being used in a test source file:
-// const std::string kInputFile = webrtc::test::ProjectRootPath() +
-//     "test/data/voice_engine/audio_long16.wav";
-// // Use the kInputFile for the tests...
-//
-// Then here's some example outputs for different platforms:
-// Linux:
-// * Source tree located in /home/user/webrtc/trunk
-// * Test project located in /home/user/webrtc/trunk/src/testproject
-// * Test binary compiled as:
-//   /home/user/webrtc/trunk/out/Debug/testproject_unittests
-// Then ProjectRootPath() will return /home/user/webrtc/trunk/ no matter if
-// the test binary is executed from standing in either of:
-// /home/user/webrtc/trunk
-// or
-// /home/user/webrtc/trunk/out/Debug
-// (or any other directory below the trunk for that matter).
-//
-// Windows:
-// * Source tree located in C:\Users\user\webrtc\trunk
-// * Test project located in C:\Users\user\webrtc\trunk\src\testproject
-// * Test binary compiled as:
-//   C:\Users\user\webrtc\trunk\src\testproject\Debug\testproject_unittests.exe
-// Then ProjectRootPath() will return C:\Users\user\webrtc\trunk\ when the
-// test binary is executed from inside Visual Studio.
-// It will also return the same path if the test is executed from a command
-// prompt standing in C:\Users\user\webrtc\trunk\src\testproject\Debug
-//
-// Mac:
-// * Source tree located in /Users/user/webrtc/trunk
-// * Test project located in /Users/user/webrtc/trunk/src/testproject
-// * Test binary compiled as:
-//   /Users/user/webrtc/trunk/xcodebuild/Debug/testproject_unittests
-// Then ProjectRootPath() will return /Users/user/webrtc/trunk/ no matter if
-// the test binary is executed from standing in either of:
-// /Users/user/webrtc/trunk
-// or
-// /Users/user/webrtc/trunk/out/Debug
-// (or any other directory below the trunk for that matter).
-
 #ifndef WEBRTC_TEST_TESTSUPPORT_FILEUTILS_H_
 #define WEBRTC_TEST_TESTSUPPORT_FILEUTILS_H_
 
 #include <string>
 
 namespace webrtc {
 namespace test {
 
 // This is the "directory" returned if the ProjectPath() function fails
 // to find the project root.
 extern const char* kCannotFindProjectRootDir;
 
-// Finds the root dir of the project, to be able to set correct paths to
-// resource files used by tests.
-// For desktop, we assume that the project root is two levels above (i.e. the
-// current working directory + /../../)
-// For Android, it is assumed to be /sdcard/chromium_tests_root/
-// For iOS, the resource files are assumed to be included in the test's .app
-// bundle.
-// If the current working directory is above the project root dir, it will not
-// be found.
-//
-// If symbolic links occur in the path they will be resolved and the actual
-// directory will be returned.
-//
-// Returns the absolute path to the project root dir (usually the trunk dir)
-// WITH a trailing path delimiter.
-// If the project root is not found, the string specified by
-// kCannotFindProjectRootDir is returned.
-std::string ProjectRootPath();
-
 // Creates and returns the absolute path to the output directory where log files
 // and other test artifacts should be put. The output directory is generally a
 // directory named "out" at the top-level of the project, i.e. a subfolder to
 // the path returned by ProjectRootPath(). The exception is Android where we use
 // /sdcard/ instead.
 //
-// Details described for ProjectRootPath() apply here too.
+// If symbolic links occur in the path they will be resolved and the actual
+// directory will be returned.
 //
 // Returns the path WITH a trailing path delimiter. If the project root is not
 // found, the current working directory ("./") is returned as a fallback.
 std::string OutputPath();
 
 // Generates an empty file with a unique name in the specified directory and
 // returns the file name and path.
 std::string TempFilename(const std::string &dir, const std::string &prefix);
 
 // Returns a path to a resource file for the currently executing platform.
@@ skipping 39 matching lines @@
 // but can also be an absolute path. The intention with this function is to pass
 // the argv[0] being sent into the main function to make it possible for
 // fileutils.h to find the correct project paths even when the working directory
 // is outside the project tree (which happens in some cases).
 void SetExecutablePath(const std::string& path_to_executable);
 
 }  // namespace test
 }  // namespace webrtc
 
 #endif  // WEBRTC_TEST_TESTSUPPORT_FILEUTILS_H_