docshell/base/nsDocShellLoadTypes.h

Wed, 31 Dec 2014 06:09:35 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 06:09:35 +0100
changeset 0
6474c204b198
permissions
-rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

michael@0 1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
michael@0 2 * vim: set ts=4 sw=4 et tw=80:
michael@0 3 *
michael@0 4 * This Source Code Form is subject to the terms of the Mozilla Public
michael@0 5 * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0 6 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0 7
michael@0 8 #ifndef nsDocShellLoadTypes_h_
michael@0 9 #define nsDocShellLoadTypes_h_
michael@0 10
michael@0 11 #ifdef MOZILLA_INTERNAL_API
michael@0 12
michael@0 13 #include "nsIDocShell.h"
michael@0 14 #include "nsIWebNavigation.h"
michael@0 15
michael@0 16 /**
michael@0 17 * Load flag for error pages. This uses one of the reserved flag
michael@0 18 * values from nsIWebNavigation.
michael@0 19 */
michael@0 20 #define LOAD_FLAGS_ERROR_PAGE 0x0001U
michael@0 21
michael@0 22 #define MAKE_LOAD_TYPE(type, flags) ((type) | ((flags) << 16))
michael@0 23 #define LOAD_TYPE_HAS_FLAGS(type, flags) ((type) & ((flags) << 16))
michael@0 24
michael@0 25 /**
michael@0 26 * These are flags that confuse ConvertLoadTypeToDocShellLoadInfo and should
michael@0 27 * not be passed to MAKE_LOAD_TYPE. In particular this includes all flags
michael@0 28 * above 0xffff (e.g. LOAD_FLAGS_BYPASS_CLASSIFIER), since MAKE_LOAD_TYPE would
michael@0 29 * just shift them out anyway.
michael@0 30 */
michael@0 31 #define EXTRA_LOAD_FLAGS (LOAD_FLAGS_FIRST_LOAD | \
michael@0 32 LOAD_FLAGS_ALLOW_POPUPS | \
michael@0 33 0xffff0000)
michael@0 34
michael@0 35
michael@0 36
michael@0 37 /* load types are legal combinations of load commands and flags
michael@0 38 *
michael@0 39 * NOTE:
michael@0 40 * Remember to update the IsValidLoadType function below if you change this
michael@0 41 * enum to ensure bad flag combinations will be rejected.
michael@0 42 */
michael@0 43 enum LoadType {
michael@0 44 LOAD_NORMAL = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_NONE),
michael@0 45 LOAD_NORMAL_REPLACE = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_REPLACE_HISTORY),
michael@0 46 LOAD_NORMAL_EXTERNAL = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_FROM_EXTERNAL),
michael@0 47 LOAD_HISTORY = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_HISTORY, nsIWebNavigation::LOAD_FLAGS_NONE),
michael@0 48 LOAD_NORMAL_BYPASS_CACHE = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_BYPASS_CACHE),
michael@0 49 LOAD_NORMAL_BYPASS_PROXY = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_BYPASS_PROXY),
michael@0 50 LOAD_NORMAL_BYPASS_PROXY_AND_CACHE = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_BYPASS_CACHE | nsIWebNavigation::LOAD_FLAGS_BYPASS_PROXY),
michael@0 51 LOAD_NORMAL_ALLOW_MIXED_CONTENT = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_ALLOW_MIXED_CONTENT | nsIWebNavigation::LOAD_FLAGS_BYPASS_CACHE),
michael@0 52 LOAD_RELOAD_NORMAL = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_RELOAD, nsIWebNavigation::LOAD_FLAGS_NONE),
michael@0 53 LOAD_RELOAD_BYPASS_CACHE = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_RELOAD, nsIWebNavigation::LOAD_FLAGS_BYPASS_CACHE),
michael@0 54 LOAD_RELOAD_BYPASS_PROXY = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_RELOAD, nsIWebNavigation::LOAD_FLAGS_BYPASS_PROXY),
michael@0 55 LOAD_RELOAD_ALLOW_MIXED_CONTENT = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_RELOAD, nsIWebNavigation::LOAD_FLAGS_ALLOW_MIXED_CONTENT | nsIWebNavigation::LOAD_FLAGS_BYPASS_CACHE),
michael@0 56 LOAD_RELOAD_BYPASS_PROXY_AND_CACHE = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_RELOAD, nsIWebNavigation::LOAD_FLAGS_BYPASS_CACHE | nsIWebNavigation::LOAD_FLAGS_BYPASS_PROXY),
michael@0 57 LOAD_LINK = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_IS_LINK),
michael@0 58 LOAD_REFRESH = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_IS_REFRESH),
michael@0 59 LOAD_RELOAD_CHARSET_CHANGE = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_RELOAD, nsIWebNavigation::LOAD_FLAGS_CHARSET_CHANGE),
michael@0 60 LOAD_BYPASS_HISTORY = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_BYPASS_HISTORY),
michael@0 61 LOAD_STOP_CONTENT = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_STOP_CONTENT),
michael@0 62 LOAD_STOP_CONTENT_AND_REPLACE = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_STOP_CONTENT | nsIWebNavigation::LOAD_FLAGS_REPLACE_HISTORY),
michael@0 63 LOAD_PUSHSTATE = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_PUSHSTATE, nsIWebNavigation::LOAD_FLAGS_NONE),
michael@0 64 LOAD_REPLACE_BYPASS_CACHE = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_REPLACE_HISTORY | nsIWebNavigation::LOAD_FLAGS_BYPASS_CACHE),
michael@0 65 /**
michael@0 66 * Load type for an error page. These loads are never triggered by users of
michael@0 67 * Docshell. Instead, Docshell triggers the load itself when a
michael@0 68 * consumer-triggered load failed.
michael@0 69 */
michael@0 70 LOAD_ERROR_PAGE = MAKE_LOAD_TYPE(nsIDocShell::LOAD_CMD_NORMAL, LOAD_FLAGS_ERROR_PAGE)
michael@0 71
michael@0 72 // NOTE: Adding a new value? Remember to update IsValidLoadType!
michael@0 73 };
michael@0 74 static inline bool IsValidLoadType(uint32_t aLoadType)
michael@0 75 {
michael@0 76 switch (aLoadType)
michael@0 77 {
michael@0 78 case LOAD_NORMAL:
michael@0 79 case LOAD_NORMAL_REPLACE:
michael@0 80 case LOAD_NORMAL_EXTERNAL:
michael@0 81 case LOAD_NORMAL_BYPASS_CACHE:
michael@0 82 case LOAD_NORMAL_BYPASS_PROXY:
michael@0 83 case LOAD_NORMAL_BYPASS_PROXY_AND_CACHE:
michael@0 84 case LOAD_NORMAL_ALLOW_MIXED_CONTENT:
michael@0 85 case LOAD_HISTORY:
michael@0 86 case LOAD_RELOAD_NORMAL:
michael@0 87 case LOAD_RELOAD_BYPASS_CACHE:
michael@0 88 case LOAD_RELOAD_BYPASS_PROXY:
michael@0 89 case LOAD_RELOAD_BYPASS_PROXY_AND_CACHE:
michael@0 90 case LOAD_RELOAD_ALLOW_MIXED_CONTENT:
michael@0 91 case LOAD_LINK:
michael@0 92 case LOAD_REFRESH:
michael@0 93 case LOAD_RELOAD_CHARSET_CHANGE:
michael@0 94 case LOAD_BYPASS_HISTORY:
michael@0 95 case LOAD_STOP_CONTENT:
michael@0 96 case LOAD_STOP_CONTENT_AND_REPLACE:
michael@0 97 case LOAD_PUSHSTATE:
michael@0 98 case LOAD_REPLACE_BYPASS_CACHE:
michael@0 99 case LOAD_ERROR_PAGE:
michael@0 100 return true;
michael@0 101 }
michael@0 102 return false;
michael@0 103 }
michael@0 104
michael@0 105 #endif // MOZILLA_INTERNAL_API
michael@0 106 #endif

mercurial