File: user_data_dir.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (54 lines) | stat: -rw-r--r-- 2,641 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_INSTALL_STATIC_USER_DATA_DIR_H_
#define CHROME_INSTALL_STATIC_USER_DATA_DIR_H_

#include <string>

namespace install_static {

struct InstallConstants;

// Populates |result| with the user data dir, respecting various overrides in
// the manner of chrome_main_delegate.cc InitializeUserDataDir(). This includes
// overrides on the command line, overrides by registry policy, and fallback to
// the default User Data dir if the directory is invalid or unspecified.
//
// If the process command has --headless switch and user data directory is not
// provided by command line or registry policy overrides, a temporary unique
// user data directory will be created and made available to headless mode
// initialization code in headless::InitHeadlessMode(). This allows headless
// Chrome instances to run in parallel and with headful Chrome also running.
//
// If a directory was given by the user (either on the command line, or by
// registry policy), but it was invalid or unusable, then
// |invalid_supplied_directory| will be filled with the value that was unusable
// for reporting an error to the user.
//
// Other than in test situations, it is generally only appropriate to call this
// function once on startup and use the result for subsequent callers, otherwise
// there's a race with registry modification (which could cause a different
// derivation) so different subsystems would see different values). In normal
// usage, it should be called only once and cached. GetUserDataDirectory() does
// this, and should be preferred.
bool GetUserDataDirectoryImpl(const std::wstring& command_line,
                              const InstallConstants& mode,
                              std::wstring* result,
                              std::wstring* invalid_supplied_directory);

// Retrieves the user data directory, and any invalid directory specified on the
// command line, for reporting an error to the user. These values are cached on
// the first call. |invalid_user_data_directory| may be null if not required.
bool GetUserDataDirectory(std::wstring* user_data_directory,
                          std::wstring* invalid_user_data_directory);

// Returns true if GetUserDataDirectory[Impl]() returns a temporary user
// data directory created when running in headless mode with no explicit user
// data directory specification.
bool IsTemporaryUserDataDirectoryCreatedForHeadless();

}  // namespace install_static

#endif  // CHROME_INSTALL_STATIC_USER_DATA_DIR_H_