summaryrefslogtreecommitdiffstats
path: root/modules/libpref/init/StaticPrefListBegin.h
blob: 27bd726cc8a46b6ec115a962d4f45dbef1105956 (plain)
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
55
56
57
58
59
60
61
62
63
64
65
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

// This file does not make sense on its own. It must be #included along with
// StaticPrefsListEnd.h in all headers that contribute prefs to the StaticPrefs
// namespace.

#include "StaticPrefsBase.h"
#include "Preferences.h"
#include "MainThreadUtils.h"  // for NS_IsMainThread()
#include "nsXULAppAPI.h"      // for XRE_IsContentProcess()

namespace mozilla {
namespace StaticPrefs {

// For mirrored prefs we generate an extern variable declaration and three
// getter declarations/definitions.
#define NEVER_PREF(name, cpp_type, default_value)
#define ALWAYS_PREF(name, base_id, full_id, cpp_type, default_value)          \
  extern cpp_type sMirror_##full_id;                                          \
  inline StripAtomic<cpp_type> full_id() {                                    \
    if (IsString<cpp_type>::value && sCrashOnBlocklistedPref) {               \
      MOZ_DIAGNOSTIC_ASSERT(!IsPreferenceSanitized(name),                     \
                            "Should not access the preference '" name         \
                            "' in Content Processes");                        \
    }                                                                         \
    MOZ_DIAGNOSTIC_ASSERT(IsAtomic<cpp_type>::value || NS_IsMainThread(),     \
                          "Non-atomic static pref '" name                     \
                          "' being accessed on background thread by getter"); \
    return sMirror_##full_id;                                                 \
  }                                                                           \
  inline const char* GetPrefName_##base_id() { return name; }                 \
  inline StripAtomic<cpp_type> GetPrefDefault_##base_id() {                   \
    return default_value;                                                     \
  }
#define ALWAYS_DATAMUTEX_PREF(name, base_id, full_id, cpp_type, default_value) \
  extern cpp_type sMirror_##full_id;                                           \
  inline cpp_type::ConstAutoLock full_id() {                                   \
    if (IsString<cpp_type>::value && sCrashOnBlocklistedPref) {                \
      MOZ_DIAGNOSTIC_ASSERT(!IsPreferenceSanitized(name),                      \
                            "Should not access the preference '" name          \
                            "' in Content Processes");                         \
    }                                                                          \
    return sMirror_##full_id.ConstLock();                                      \
  }                                                                            \
  inline const char* GetPrefName_##base_id() { return name; }                  \
  inline StripAtomic<cpp_type> GetPrefDefault_##base_id() {                    \
    return default_value;                                                      \
  }
#define ONCE_PREF(name, base_id, full_id, cpp_type, default_value)    \
  extern cpp_type sMirror_##full_id;                                  \
  inline cpp_type full_id() {                                         \
    MaybeInitOncePrefs();                                             \
    if (IsString<cpp_type>::value && sCrashOnBlocklistedPref) {       \
      MOZ_DIAGNOSTIC_ASSERT(!IsPreferenceSanitized(name),             \
                            "Should not access the preference '" name \
                            "' in Content Processes");                \
    }                                                                 \
    return sMirror_##full_id;                                         \
  }                                                                   \
  inline const char* GetPrefName_##base_id() { return name; }         \
  inline cpp_type GetPrefDefault_##base_id() { return default_value; }