blob: c7f1abe71498d149accb774e3f30966853592a2f [file] [log] [blame]
pastarmovj@chromium.org8f452092012-05-09 19:50:10 +09001// Copyright (c) 2012 The Chromium Authors. All rights reserved.
license.botf003cfe2008-08-24 09:55:55 +09002// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
initial.commit3f4a7322008-07-27 06:49:38 +09004
jcampan@chromium.org36fe2212009-09-03 02:18:22 +09005#ifndef BASE_PATH_SERVICE_H_
6#define BASE_PATH_SERVICE_H_
initial.commit3f4a7322008-07-27 06:49:38 +09007
initial.commit3f4a7322008-07-27 06:49:38 +09008#include <string>
9
darin@chromium.orge585bed2011-08-06 00:34:00 +090010#include "base/base_export.h"
initial.commit3f4a7322008-07-27 06:49:38 +090011#include "base/base_paths.h"
pastarmovj@chromium.org5dce41a2012-09-27 04:05:12 +090012#include "base/gtest_prod_util.h"
rvargas@google.com4891e7d2011-03-26 03:46:38 +090013#include "build/build_config.h"
initial.commit3f4a7322008-07-27 06:49:38 +090014
pastarmovj@chromium.orge61bf332012-09-27 09:45:36 +090015namespace base {
brettw8f52b652015-09-26 05:08:54 +090016
brettw@chromium.orga7086942013-02-02 14:12:33 +090017class FilePath;
pastarmovj@chromium.orge61bf332012-09-27 09:45:36 +090018class ScopedPathOverride;
pastarmovj@chromium.orge61bf332012-09-27 09:45:36 +090019
initial.commit3f4a7322008-07-27 06:49:38 +090020// The path service is a global table mapping keys to file system paths. It is
21// OK to use this service from multiple threads.
22//
darin@chromium.orge585bed2011-08-06 00:34:00 +090023class BASE_EXPORT PathService {
initial.commit3f4a7322008-07-27 06:49:38 +090024 public:
25 // Retrieves a path to a special directory or file and places it into the
26 // string pointed to by 'path'. If you ask for a directory it is guaranteed
27 // to NOT have a path separator at the end. For example, "c:\windows\temp"
28 // Directories are also guaranteed to exist when this function succeeds.
29 //
30 // Returns true if the directory or file was successfully retrieved. On
31 // failure, 'path' will not be changed.
brettw8f52b652015-09-26 05:08:54 +090032 static bool Get(int key, FilePath* path);
initial.commit3f4a7322008-07-27 06:49:38 +090033
34 // Overrides the path to a special directory or file. This cannot be used to
35 // change the value of DIR_CURRENT, but that should be obvious. Also, if the
36 // path specifies a directory that does not exist, the directory will be
37 // created by this method. This method returns true if successful.
38 //
maruel@chromium.org8fe7adc2009-03-04 00:01:12 +090039 // If the given path is relative, then it will be resolved against
40 // DIR_CURRENT.
initial.commit3f4a7322008-07-27 06:49:38 +090041 //
42 // WARNING: Consumers of PathService::Get may expect paths to be constant
43 // over the lifetime of the app, so this method should be used with caution.
thestig@chromium.org54debc42014-02-26 22:20:36 +090044 //
45 // Unit tests generally should use ScopedPathOverride instead. Overrides from
46 // one test should not carry over to another.
brettw8f52b652015-09-26 05:08:54 +090047 static bool Override(int key, const FilePath& path);
initial.commit3f4a7322008-07-27 06:49:38 +090048
joaodasilva@chromium.org41819c52014-05-03 02:59:42 +090049 // This function does the same as PathService::Override but it takes extra
50 // parameters:
51 // - |is_absolute| indicates that |path| has already been expanded into an
52 // absolute path, otherwise MakeAbsoluteFilePath() will be used. This is
53 // useful to override paths that may not exist yet, since MakeAbsoluteFilePath
54 // fails for those. Note that MakeAbsoluteFilePath also expands symbolic
55 // links, even if path.IsAbsolute() is already true.
56 // - |create| guides whether the directory to be overriden must
pastarmovj@chromium.org8f452092012-05-09 19:50:10 +090057 // be created in case it doesn't exist already.
58 static bool OverrideAndCreateIfNeeded(int key,
brettw8f52b652015-09-26 05:08:54 +090059 const FilePath& path,
joaodasilva@chromium.org41819c52014-05-03 02:59:42 +090060 bool is_absolute,
pastarmovj@chromium.org8f452092012-05-09 19:50:10 +090061 bool create);
62
initial.commit3f4a7322008-07-27 06:49:38 +090063 // To extend the set of supported keys, you can register a path provider,
64 // which is just a function mirroring PathService::Get. The ProviderFunc
65 // returns false if it cannot provide a non-empty path for the given key.
66 // Otherwise, true is returned.
67 //
68 // WARNING: This function could be called on any thread from which the
69 // PathService is used, so a the ProviderFunc MUST BE THREADSAFE.
70 //
brettw8f52b652015-09-26 05:08:54 +090071 typedef bool (*ProviderFunc)(int, FilePath*);
initial.commit3f4a7322008-07-27 06:49:38 +090072
73 // Call to register a path provider. You must specify the range "[key_start,
74 // key_end)" of supported path keys.
75 static void RegisterProvider(ProviderFunc provider,
76 int key_start,
77 int key_end);
pastarmovj@chromium.org5dce41a2012-09-27 04:05:12 +090078
vitalybuka@chromium.org5a75b7e2013-01-29 09:56:56 +090079 // Disable internal cache.
80 static void DisableCache();
81
erikkay@google.coma3ff2752008-08-13 02:33:52 +090082 private:
brettw8f52b652015-09-26 05:08:54 +090083 friend class ScopedPathOverride;
pastarmovj@chromium.org5dce41a2012-09-27 04:05:12 +090084 FRIEND_TEST_ALL_PREFIXES(PathServiceTest, RemoveOverride);
85
86 // Removes an override for a special directory or file. Returns true if there
87 // was an override to remove or false if none was present.
88 // NOTE: This function is intended to be used by tests only!
89 static bool RemoveOverride(int key);
initial.commit3f4a7322008-07-27 06:49:38 +090090};
91
brettw8f52b652015-09-26 05:08:54 +090092} // namespace base
93
94// TODO(brettw) Convert all callers to using the base namespace and remove this.
95using base::PathService;
96
jcampan@chromium.org36fe2212009-09-03 02:18:22 +090097#endif // BASE_PATH_SERVICE_H_