blob: d090b7ac4700cf087b0683f38257226fd4b9cb74 [file] [log] [blame]
#!/usr/bin/env vpython
# Copyright 2017 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Utilities for checking for disallowed usage of non-Blink declarations.
The scanner assumes that usage of non-Blink code is always namespace qualified.
Identifiers in the global namespace are always ignored. For convenience, the
script can be run in standalone mode to check for existing violations.
Example command:
$ git ls-files third_party/blink \
| python third_party/blink/tools/blinkpy/presubmit/audit_non_blink_usage.py
"""
from __future__ import print_function
import os
import re
import sys
_DISALLOW_NON_BLINK_MOJOM = (
# network::mojom::Foo is allowed to use as non-blink mojom type.
'(|::)(?!network::)(\w+::)?mojom::(?!blink).+',
'Using non-blink mojom types, consider using "::mojom::blink::Foo" instead'
'of "::mojom::Foo" unless you have clear reasons not to do so.',
'Warning')
_CONFIG = [
{
'paths': ['third_party/blink/renderer/'],
'allowed': [
# TODO(dcheng): Should these be in a more specific config?
'gfx::ColorSpace',
'gfx::CubicBezier',
'gfx::ICCProfile',
'gfx::RadToDeg',
# absl optional constructs.
'absl::optional',
'absl::in_place',
# //base constructs that are allowed everywhere
'base::AdoptRef',
'base::ApplyMetadataToPastSamples',
'base::AutoReset',
'base::Contains',
'base::CreateSequencedTaskRunner',
'base::ValuesEquivalent',
'base::Days',
'base::DefaultTickClock',
'base::ElapsedTimer',
'base::JobDelegate',
'base::JobHandle',
'base::PostJob',
'base::File',
'base::FileErrorOr',
'base::FilePath',
'base::GetUniqueIdForProcess',
'base::GUID',
'base::HexStringToUInt64',
'base::Hours',
"base::i18n::TextDirection",
"base::i18n::ToChar16Ptr",
"base::i18n::ToUCharPtr",
'base::Location',
'base::MakeRefCounted',
'base::Microseconds',
'base::Milliseconds',
'base::Minutes',
'base::Nanoseconds',
'base::OptionalFromPtr',
'base::OptionalOrNullptr',
'base::PlatformThread',
'base::PlatformThreadId',
'base::RefCountedData',
'base::RunLoop',
'base::ReadOnlySharedMemoryMapping',
'base::ReadOnlySharedMemoryRegion',
'base::RemoveChars',
'base::RepeatingTimer',
'base::Seconds',
'base::SequencedTaskRunner',
'base::SingleThreadTaskRunner',
'base::ScopedAllowBlocking',
'base::ScopedFD',
'base::ScopedClosureRunner',
'base::StringPiece',
'base::SupportsWeakPtr',
'base::SysInfo',
'base::ThreadChecker',
'base::ThreadTicks',
'base::TickClock',
'base::Time',
'base::TimeDelta',
'base::TimeTicks',
'base::trace_event::.*',
'base::Token',
'base::UnguessableToken',
'base::UnguessableTokenHash',
'base::UnsafeSharedMemoryRegion',
'base::WeakPtr',
'base::WeakPtrFactory',
'base::WrapRefCounted',
'base::WritableSharedMemoryMapping',
'base::as_bytes',
'base::in_place',
'absl::make_optional',
'base::make_span',
'absl::nullopt',
'absl::nullopt_t',
'base::ranges::.+',
'base::sequence_manager::TaskTimeObserver',
'base::size',
'base::span',
'logging::GetVlogLevel',
'logging::SetLogItems',
'base::PassKey',
# //base/allocator/partition_allocator/partition_alloc_constants.h
'base::kAlignment',
# //base/task/bind_post_task.h
'base::BindPostTask',
# //base/bits.h
'base::bits::.+',
# //base/observer_list.h.
'base::ObserverList',
'base::CheckedObserver',
# //base/callback_helpers.h.
'base::DoNothing',
'base::SplitOnceCallback',
# //base/callback.h is allowed, but you need to use WTF::Bind or
# WTF::BindRepeating to create callbacks in Blink.
'base::BarrierClosure',
'base::NullCallback',
'base::OnceCallback',
'base::OnceClosure',
'base::RepeatingCallback',
'base::RepeatingClosure',
# //base/cancelable_callback.h
'base::CancelableOnceCallback',
'base::CancelableOnceClosure',
'base::CancelableRepeatingCallback',
'base::CancelableRepeatingClosure',
# //base/mac/scoped_nsobject.h
'base::scoped_nsobject',
# //base/memory/scoped_policy.h
'base::scoped_policy::RETAIN',
# //base/memory/ptr_util.h.
'base::WrapUnique',
# //base/allocator/partition_allocator/oom_callback.h.
'base::SetPartitionAllocOomCallback',
# //base/containers/adapters.h
'base::Reversed',
# //base/metrics/histogram_functions.h
'base::UmaHistogram.+',
# //base/metrics/histogram.h
'base::Histogram',
'base::HistogramBase',
'base::LinearHistogram',
# //base/metrics/field_trial_params.h.
'base::GetFieldTrialParamValueByFeature',
'base::GetFieldTrialParamByFeatureAsBool',
'base::GetFieldTrialParamByFeatureAsDouble',
'base::GetFieldTrialParamByFeatureAsInt',
# //base/numerics/safe_conversions.h.
'base::as_signed',
'base::as_unsigned',
'base::checked_cast',
'base::saturated_cast',
'base::strict_cast',
'base::ClampCeil',
'base::ClampFloor',
'base::IsTypeInRangeForNumericType',
'base::IsValueInRangeForNumericType',
'base::IsValueNegative',
'base::MakeStrictNum',
'base::ClampRound',
'base::SafeUnsignedAbs',
'base::StrictNumeric',
# //base/strings/char_traits.h.
'base::CharTraits',
# //base/synchronization/waitable_event.h.
'base::WaitableEvent',
# //base/numerics/checked_math.h.
'base::CheckedNumeric',
'base::IsValidForType',
'base::ValueOrDieForType',
'base::ValueOrDefaultForType',
'base::MakeCheckedNum',
'base::CheckMax',
'base::CheckMin',
'base::CheckAdd',
'base::CheckSub',
'base::CheckMul',
'base::CheckDiv',
'base::CheckMod',
'base::CheckLsh',
'base::CheckRsh',
'base::CheckAnd',
'base::CheckOr',
'base::CheckXor',
# //base/numerics/clamped_math.h.
'base::ClampAdd',
'base::ClampedNumeric',
'base::ClampMax',
'base::ClampSub',
'base::MakeClampedNum',
# //base/cxx17_backports.h.
"base::clamp",
# //base/strings/strcat.h.
'base::StrCat',
# //base/template_util.h.
'base::void_t',
'base::remove_cvref_t',
# Debugging helpers from //base/debug are allowed everywhere.
'base::debug::.+',
# Base atomic utilities
'base::AtomicFlag',
'base::AtomicSequenceNumber',
# Task traits
'base::TaskTraits',
'base::MayBlock',
'base::TaskPriority',
'base::TaskShutdownBehavior',
'base::WithBaseSyncPrimitives',
'base::ThreadPolicy',
'base::ThreadPool',
# Byte order
'base::ByteSwap',
'base::ReadBigEndian',
'base::NetToHost(16|32|64)',
'base::HostToNet(16|32|64)',
# (Cryptographic) random number generation
'base::RandUint64',
'base::RandInt',
'base::RandGenerator',
'base::RandDouble',
'base::RandBytes',
'base::RandBytesAsString',
# Feature list checking.
'base::Feature.*',
'base::FEATURE_.+',
"base::GetFieldTrial.*",
'features::.+',
# PartitionAlloc
'base::PartitionFree',
'base::PartitionAllocZeroFill',
'base::PartitionAllocReturnNull',
# For TaskObserver.
'base::PendingTask',
# Time
'base::Clock',
'base::DefaultClock',
'base::DefaultTickClock',
'base::TestMockTimeTaskRunner',
'base::TickClock',
# cc painting types.
'cc::PaintCanvas',
'cc::PaintFlags',
'cc::PaintImage',
'cc::PaintImageBuilder',
'cc::PaintRecord',
'cc::RecordPaintCanvas',
'cc::PaintShader',
'cc::PaintWorkletInput',
'cc::NodeId',
'cc::NodeInfo',
'cc::UsePaintCache',
# Chromium geometry types.
'gfx::Insets',
'gfx::InsetsF',
'gfx::Outsets',
'gfx::OutsetsF',
'gfx::Point',
'gfx::PointF',
'gfx::Point3F',
'gfx::QuadF',
'gfx::Quaternion',
'gfx::Rect',
'gfx::RectF',
'gfx::RRectF',
'gfx::Size',
'gfx::SizeF',
'gfx::Transform',
'gfx::Vector2d',
'gfx::Vector2dF',
'gfx::Vector3dF',
# Chromium geometry operations.
'cc::MathUtil',
'gfx::AngleBetweenVectorsInDegrees',
'gfx::BoundingRect',
'gfx::ComputeApproximateMaxScale',
'gfx::CrossProduct',
'gfx::DotProduct',
'gfx::IntersectRects',
'gfx::MapRect',
'gfx::PointAtOffsetFromOrigin',
'gfx::PointFToSkPoint',
'gfx::PointToSkIPoint',
'gfx::MapRect',
'gfx::MaximumCoveredRect',
'gfx::RectFToSkRect',
'gfx::RectToSkIRect',
'gfx::RectToSkRect',
'gfx::ScalePoint',
'gfx::ScaleToCeiledSize',
'gfx::ScaleToEnclosingRect',
'gfx::ScaleToFlooredSize',
'gfx::ScaleToRoundedRect',
'gfx::ScaleToRoundedSize',
'gfx::ScaleSize',
'gfx::ScalePoint',
'gfx::ScaleToRoundedPoint',
'gfx::ScaleVector2d',
'gfx::ScaleVector3d',
'gfx::SizeFToSkSize',
'gfx::SizeToSkISize',
'gfx::SkIPointToPoint',
'gfx::SkIRectToRect',
'gfx::SkISizeToSize',
'gfx::SkPointToPointF',
'gfx::SkRectToRectF',
'gfx::SkSizeToSizeF',
'gfx::SubtractRects',
'gfx::ToCeiledPoint',
'gfx::ToCeiledSize',
'gfx::ToCeiledVector2d',
'gfx::ToEnclosedRect',
'gfx::ToEnclosingRect',
'gfx::ToFlooredPoint',
'gfx::ToFlooredSize',
'gfx::ToFlooredVector2d',
'gfx::ToRoundedPoint',
'gfx::ToRoundedRect',
'gfx::ToRoundedSize',
'gfx::ToRoundedVector2d',
'gfx::TransposePoint',
'gfx::TransposeRect',
'gfx::TransposeSize',
'gfx::TryComputeTransform2dScaleComponents',
'gfx::UnionRects',
# Range type.
'gfx::Range',
# Wrapper of SkRegion used in Chromium.
'cc::Region',
# A geometric set of TouchActions associated with areas, and only
# depends on the geometry types above.
'cc::TouchActionRegion',
# Selection bounds.
'cc::LayerSelection',
'cc::LayerSelectionBound',
'gfx::SelectionBound',
# cc::Layers.
'cc::Layer',
'cc::LayerClient',
'cc::LayerTreeDebugState',
'cc::LayerTreeHost',
'cc::PictureLayer',
'cc::SurfaceLayer',
# cc::Layer helper data structs.
'cc::BrowserControlsParams',
'cc::ElementId',
'cc::LayerPositionConstraint',
'cc::OverscrollBehavior',
'cc::Scrollbar',
'cc::ScrollbarLayerBase',
'cc::ScrollbarOrientation',
'cc::ScrollbarPart',
'cc::StickyPositionConstraint',
'cc::StickyPositionNodeData',
'cc::ViewportLayers',
# cc::Layer helper enums.
'cc::HORIZONTAL',
'cc::VERTICAL',
'cc::THUMB',
'cc::TRACK_BUTTONS_TICKMARKS',
'cc::BrowserControlsState',
'cc::EventListenerClass',
'cc::EventListenerProperties',
# Animation
'cc::AnimationHost',
# UMA Enums
'cc::PaintHoldingCommitTrigger',
'cc::PaintHoldingReason',
# Scrolling
'cc::kManipulationInfoPinchZoom',
'cc::kManipulationInfoPrecisionTouchPad',
'cc::kManipulationInfoTouch',
'cc::kManipulationInfoWheel',
'cc::kManipulationInfoScrollbar',
'cc::kManipulationInfoNone',
'cc::kPixelsPerLineStep',
'cc::kMinFractionToStepWhenPaging',
'cc::kPercentDeltaForDirectionalScroll',
'cc::MainThreadScrollingReason',
'cc::ManipulationInfo',
'cc::ScrollSnapAlign',
'cc::ScrollSnapType',
'cc::ScrollOffsetAnimationCurve',
'cc::ScrollStateData',
'cc::ScrollUtils',
'cc::SnapAlignment',
'cc::SnapAreaData',
'cc::SnapAxis',
'cc::SnapContainerData',
'cc::SnapFlingClient',
'cc::SnapFlingController',
'cc::SnapSelectionStrategy',
'cc::SnapStrictness',
'cc::TargetSnapAreaElementIds',
'ui::ScrollGranularity',
# Document transitions
'cc::DocumentTransitionRequest',
'cc::DocumentTransitionContentLayer',
'viz::SharedElementResourceId',
# base/types/strong_alias.h
'base::StrongAlias',
# Common display structs across display <-> Blink.
'display::ScreenInfo',
'display::ScreenInfos',
# Standalone utility libraries that only depend on //base
'skia::.+',
'url::.+',
# Power scheduling instrumentation, which only depends on //base
"power_scheduler::.+",
# Nested namespaces under the blink namespace
'bindings::.+',
'canvas_heuristic_parameters::.+',
'compositor_target_property::.+',
'cors::.+',
'css_parsing_utils::.+',
'cssvalue::.+',
'encoding::.+',
'encoding_enum::.+',
'event_handling_util::.+',
'event_util::.+',
'file_error::.+',
'geometry_util::.+',
'inspector_\\w+_event::.+',
'inspector_async_task::.+',
'inspector_set_layer_tree_id::.+',
'inspector_tracing_started_in_frame::.+',
'keywords::.+',
'layered_api::.+',
'layout_invalidation_reason::.+',
'media_constraints_impl::.+',
'media_element_parser_helpers::.+',
'mobile_metrics_test_helpers::.+',
'file_system_access_error::.+',
'network_utils::.+',
'origin_trials::.+',
'paint_filter_builder::.+',
'root_scroller_util::.+',
'scheduler::.+',
'scroll_customization::.+',
'scroll_timeline_util::.+',
'style_change_extra_data::.+',
'style_change_reason::.+',
'svg_path_parser::.+',
'touch_action_util::.+',
'trace_event::.+',
'unicode::.+',
'vector_math::.+',
'web_core_test_support::.+',
'worker_pool::.+',
'xpath::.+',
'[a-z_]+_names::.+',
# Third-party libraries that don't depend on non-Blink Chrome code
# are OK.
'icu::.+',
'perfetto::.+', # tracing
'testing::.+', # googlemock / googletest
'v8::.+',
'v8_inspector::.+',
'inspector_protocol_encoding::.+',
# Inspector instrumentation and protocol
'probe::.+',
'protocol::.+',
# Blink code shouldn't need to be qualified with the Blink namespace,
# but there are exceptions.
'blink::.+',
# Assume that identifiers where the first qualifier is internal are
# nested in the blink namespace.
'internal::.+',
# HTTP structured headers
'net::structured_headers::.+',
# CanonicalCookie and related headers
'net::CanonicalCookie',
'net::CookiePriority',
'net::CookieSameSite',
'net::CookieSourceScheme',
# HTTP status codes
'net::HTTP_.+',
# For ConnectionInfo enumeration
'net::HttpResponseInfo',
# Network service.
'network::.+',
# Used in network service types.
'net::SiteForCookies',
# Some test helpers live in the blink::test namespace.
'test::.+',
# Some test helpers that live in the blink::frame_test_helpers
# namespace.
'frame_test_helpers::.+',
# Blink uses Mojo, so it needs mojo::Receiver, mojo::Remote, et
# cetera, as well as generated Mojo bindings.
# Note that the Mojo callback helpers are explicitly forbidden:
# Blink already has a signal for contexts being destroyed, and
# other types of failures should be explicitly signalled.
'mojo::(?!WrapCallback).+',
'mojo_base::BigBuffer.*',
'(?:.+::)?mojom::.+',
'service_manager::InterfaceProvider',
# STL containers such as std::string and std::vector are discouraged
# but still needed for interop with WebKit/common. Note that other
# STL types such as std::unique_ptr are encouraged.
'std::.+',
# UI Cursor
'ui::Cursor',
# UI Pointer and Hover
'ui::PointerType',
'ui::POINTER_TYPE_.*',
'ui::HoverType',
'ui::HOVER_TYPE_.*',
# UI Keyconverter
'ui::DomCode',
'ui::DomKey',
'ui::KeycodeConverter',
# Accessibility base types and the non-Blink enums they
# depend on.
'ui::AXActionData',
'ui::AXEvent',
'ui::AXEventIntent',
'ui::AXMode',
'ui::AXNodeData',
'ui::AXTreeID',
'ui::kAXModeBasic',
'ui::kAXModeComplete',
'ax::mojom::BoolAttribute',
'ax::mojom::HasPopup',
'ax::mojom::State',
'ax::mojom::Restriction',
# Accessibility helper functions - mostly used in Blink for
# serialization. Please keep alphabetized.
'ui::CanHaveInlineTextBoxChildren',
'ui::IsCellOrTableHeader',
'ui::IsClickable',
'ui::IsComboBox',
'ui::IsContainerWithSelectableChildren',
'ui::IsDialog',
'ui::IsHeading',
'ui::IsLandmark',
'ui::IsPlatformDocument',
'ui::IsPresentational',
'ui::IsSelectRequiredOrImplicit',
'ui::IsStructure',
'ui::IsTableLike',
'ui::IsTableRow',
'ui::IsTableHeader',
# Blink uses UKM for logging e.g. always-on leak detection (crbug/757374)
'ukm::.+',
# Permit using crash keys inside Blink without jumping through
# hoops.
'crash_reporter::.*CrashKey.*',
# Useful for platform-specific code.
'base::mac::(CFToNSCast|NSToCFCast)',
'base::mac::Is(AtMost|AtLeast)?OS.+',
'base::(scoped_nsobject|ScopedCFTypeRef)',
# absl::variant and getters:
'absl::get',
'absl::get_if',
'absl::holds_alternative',
'absl::variant',
'absl::visit',
],
'disallowed': [
('base::Bind(|Once|Repeating)',
'Use WTF::Bind or WTF::BindRepeating.'),
('std::(deque|map|multimap|set|vector|unordered_set|unordered_map)',
'Use WTF containers like WTF::Deque, WTF::HashMap, WTF::HashSet or WTF::Vector instead of the banned std containers. '
'However, it is fine to use std containers at the boundary layer between Blink and Chromium. '
'If you are in this case, you can use --bypass-hooks option to avoid the presubmit check when uploading your CL.'
),
_DISALLOW_NON_BLINK_MOJOM,
],
},
{
'paths': ['third_party/blink/renderer/bindings/'],
'allowed': ['gin::.+'],
},
{
'paths':
['third_party/blink/renderer/bindings/core/v8/script_streamer.cc'],
'allowed': [
# For the script streaming to be able to block when reading from a
# mojo datapipe.
'base::ScopedAllowBaseSyncPrimitives',
'base::ScopedBlockingCall',
'base::BlockingType',
],
},
{
'paths': [
'third_party/blink/renderer/bindings/core/v8/v8_gc_for_context_dispose.cc'
],
'allowed': [
# For memory reduction histogram.
'base::ProcessMetrics',
],
},
{
'paths':
['third_party/blink/renderer/controller/oom_intervention_impl.cc'],
'allowed': [
'base::BindOnce',
],
},
{
'paths': [
'third_party/blink/renderer/controller/user_level_memory_pressure_signal_generator.cc'
],
'allowed': [
'base::MemoryPressureListener',
],
},
{
'paths': ['third_party/blink/renderer/core/animation'],
'allowed': [
'[a-z_]+_functions::.+',
],
},
{
'paths': [
'third_party/blink/renderer/core/animation_frame',
'third_party/blink/renderer/core/offscreencanvas',
'third_party/blink/renderer/core/html/canvas'
],
'allowed': [
'viz::BeginFrameArgs',
],
},
{
'paths': ['third_party/blink/renderer/core/offscreencanvas'],
'allowed': [
# Flags to be used to set up sharedImage
'gpu::SHARED_IMAGE_USAGE_DISPLAY',
'gpu::SHARED_IMAGE_USAGE_SCANOUT',
],
},
{
'paths': [
'third_party/blink/renderer/core/html/canvas/canvas_rendering_context_host.cc'
],
'allowed': [
'gpu::SHARED_IMAGE_USAGE_DISPLAY',
'gpu::SHARED_IMAGE_USAGE_SCANOUT',
'gpu::SHARED_IMAGE_USAGE_CONCURRENT_READ_WRITE',
],
},
{
'paths': [
'third_party/blink/renderer/core/exported',
'third_party/blink/renderer/core/frame',
],
'allowed': [
'cc::ActiveFrameSequenceTrackers',
'cc::ApplyViewportChangesArgs',
'cc::LayerTreeSettings',
'cc::PaintBenchmarkResult',
'cc::RenderFrameMetadata',
'cc::TaskGraphRunner',
'cc::ContentLayerClient',
'cc::DeadlinePolicy',
'cc::DisplayItemList',
'cc::DrawColorOp',
'cc::DrawImageOp',
'cc::SaveOp',
'cc::ScaleOp',
'cc::RestoreOp',
'cc::TranslateOp',
'gfx::DisplayColorSpaces',
'gfx::FontRenderParams',
'ui::ImeTextSpan',
'viz::FrameSinkId',
'viz::LocalSurfaceId',
'viz::SurfaceId',
],
},
{
'paths': ['third_party/blink/renderer/core/clipboard'],
'allowed': ['net::EscapeForHTML'],
},
{
'paths': ['third_party/blink/renderer/core/css'],
'allowed': [
# Internal implementation details for CSS.
'css_property_parser_helpers::.+',
'detail::.+',
],
},
{
'paths': ['third_party/blink/renderer/core/css/media_values.cc'],
'allowed': [
'color_space_utilities::GetColorSpaceGamut',
],
},
{
'paths': ['third_party/blink/renderer/core/editing/ime'],
'allowed': [
'ui::ImeTextSpan',
'ui::TextInputAction',
],
},
{
'paths': [
'third_party/blink/renderer/core/editing/commands/undo_stack.cc',
'third_party/blink/renderer/core/editing/commands/undo_stack.h'
],
'allowed': [
'base::MemoryPressureListener',
],
},
{
'paths': [
'third_party/blink/renderer/core/fetch/data_consumer_handle_test_util.cc'
],
'allowed': [
# The existing code already contains gin::IsolateHolder.
'gin::IsolateHolder',
],
},
{
'paths': ['third_party/blink/renderer/core/frame/visual_viewport.cc'],
'allowed': [
'cc::SolidColorScrollbarLayer',
],
},
{
'paths':
['third_party/blink/renderer/core/frame/web_frame_widget_impl.cc'],
'allowed': [
'cc::CompositorCommitData',
'cc::InputHandlerScrollResult',
'cc::SwapPromise',
'viz::CompositorFrameMetadata',
],
},
{
'paths':
['third_party/blink/renderer/core/frame/web_frame_widget_impl.h'],
'allowed': [
'cc::CompositorCommitData',
],
},
{
'paths':
['third_party/blink/renderer/core/frame/web_local_frame_impl.cc'],
'allowed': [
'ui::AXTreeID',
'ui::AXTreeIDUnknown',
],
},
{
'paths':
['third_party/blink/renderer/core/frame/web_local_frame_impl.h'],
'allowed': [
'ui::AXTreeID',
],
},
{
'paths': [
'third_party/blink/renderer/core/fileapi/file_reader_loader.cc',
'third_party/blink/renderer/modules/file_system_access/file_system_underlying_sink.cc'
],
'allowed': [
'net::ERR_.+',
'net::OK',
],
},
{
'paths': ['third_party/blink/renderer/core/html/forms'],
'allowed': [
'ui::TextInputType',
],
},
{
'paths': [
'third_party/blink/renderer/core/loader/alternate_signed_exchange_resource_info.cc'
],
'allowed': [
# Used by WebPackageRequestMatcher in //third_party/blink/common.
'net::HttpRequestHeaders',
],
},
{
'paths': ['third_party/blink/renderer/core/paint'],
'allowed': [
# cc painting types.
'cc::ContentLayerClient',
'cc::DisplayItemList',
'cc::DrawRecordOp',
# blink paint tree debugging namespace
'paint_property_tree_printer::UpdateDebugNames',
],
},
{
'paths': ['third_party/blink/renderer/core/fragment_directive'],
'allowed': [
'cc::ScrollbarLayerBase',
'shared_highlighting::.+',
],
},
{
'paths': ['third_party/blink/renderer/core/page'],
'allowed': [
'touch_adjustment::.+',
'viz::FrameSinkId',
],
},
{
'paths': ['third_party/blink/renderer/core/style/computed_style.h'],
'allowed': [
'css_longhand::.+',
],
},
{
'paths': [
'third_party/blink/renderer/core/inspector/inspector_memory_agent.cc'
],
'allowed': [
'base::ModuleCache',
'base::PoissonAllocationSampler',
'base::SamplingHeapProfiler',
],
},
{
'paths': [
'third_party/blink/renderer/core/inspector/inspector_overlay_agent.cc'
],
'allowed': [
# cc painting types.
'cc::ContentLayerClient',
'cc::DisplayItemList',
'cc::DrawRecordOp',
],
},
{
'paths': [
'third_party/blink/renderer/core/inspector/inspector_contrast.cc',
'third_party/blink/renderer/core/inspector/inspector_contrast.h'
],
'allowed': [
'color_utils::GetContrastRatio',
'cc::RTree',
],
},
{
'paths':
['third_party/blink/renderer/core/inspector/locale_controller.cc'],
'allowed': [
'base::i18n::SetICUDefaultLocale',
],
},
{
'paths': ['third_party/blink/renderer/core/inspector'],
'allowed': [
# Devtools binary protocol uses std::vector<uint8_t> for serialized
# objects.
'std::vector',
# [C]h[R]ome [D]ev[T]ools [P]rotocol implementation support library
# (see third_party/inspector_protocol/crdtp).
'crdtp::.+',
# DevTools manages certificates from the net stack.
'net::X509Certificate',
'net::x509_util::CryptoBufferAsSpan',
],
},
{
'paths': [
'third_party/blink/renderer/core/inspector',
'third_party/blink/renderer/controller/dev_tools_frontend_impl.h',
'third_party/blink/renderer/controller/dev_tools_frontend_impl.cc',
'third_party/blink/renderer/modules/filesystem/dev_tools_host_file_system.cc'
],
'allowed': [
# Commands from the DevTools window are parsed from a JSON string in
# the devtools renderer and sent on as base::Value.
'base::Value',
],
},
{
'paths':
['third_party/blink/renderer/core/inspector/dev_tools_host.cc'],
'allowed': [
# Commands from the DevTools window are parsed from a JSON string in
# the devtools renderer and sent on as base::Value.
'base::JSONReader',
],
},
{
'paths': [
'third_party/blink/renderer/core/inspector/inspector_performance_agent.cc'
],
'allowed': [
'base::subtle::TimeTicksNowIgnoringOverride',
],
},
{
'paths': [
'third_party/blink/renderer/core/inspector/inspector_network_agent.cc'
],
'allowed': [
'base::flat_set',
'base::HexEncode',
'net::ct::.+',
'net::IPAddress',
'net::SourceStream',
'net::SSL.+',
],
},
{
'paths': ['third_party/blink/renderer/core/workers/worker_thread.cc'],
'allowed': [
'base::ScopedAllowBaseSyncPrimitives',
],
},
{
'paths': [
'third_party/blink/renderer/bindings/core/v8/v8_code_cache.cc',
'third_party/blink/renderer/bindings/core/v8/v8_code_cache.h',
'third_party/blink/renderer/core/loader/document_loader.cc',
'third_party/blink/renderer/core/loader/document_loader.h',
'third_party/blink/renderer/core/workers/worklet_global_scope.h',
'third_party/blink/renderer/core/workers/worklet_global_scope.cc',
'third_party/blink/renderer/core/workers/worker_global_scope.cc',
'third_party/blink/renderer/core/workers/worker_global_scope.h',
'third_party/blink/renderer/core/workers/worker_or_worklet_global_scope.h',
'third_party/blink/renderer/core/execution_context/execution_context.h',
'third_party/blink/renderer/core/execution_context/execution_context.cc',
'third_party/blink/renderer/modules/service_worker/service_worker_script_cached_metadata_handler.h',
'third_party/blink/renderer/modules/service_worker/service_worker_script_cached_metadata_handler.cc',
'third_party/blink/renderer/bindings/core/v8/v8_wasm_response_extensions.cc',
],
'allowed': [
# TODO(mythria): Allow use of non-blink mojo interface. Once
# //content/renderer/loader is moved to Blink as a part of onion
# soup we can update all uses to blink::mojom::blink::CodeCacheHost.
'blink::mojom::CodeCacheHost',
],
},
{
'paths': ['third_party/blink/renderer/core/xml'],
'allowed': [
'xpathyy::.+',
],
},
{
'paths': [
'third_party/blink/renderer/modules/device_orientation/',
'third_party/blink/renderer/modules/gamepad/',
'third_party/blink/renderer/modules/sensor/',
'third_party/blink/renderer/modules/xr/',
],
'allowed': [
'base::subtle::Atomic32',
'device::.+',
],
},
{
'paths': [
'third_party/blink/renderer/core/html/media/',
'third_party/blink/renderer/modules/canvas/',
'third_party/blink/renderer/modules/vr/',
'third_party/blink/renderer/modules/webgl/',
'third_party/blink/renderer/modules/webgpu/',
'third_party/blink/renderer/modules/xr/',
],
# The modules listed above need access to the following GL drawing and
# display-related types.
'allowed': [
'base::LRUCache',
'gl::GpuPreference',
'gpu::SHARED_IMAGE_USAGE_.+',
'gpu::gles2::GLES2Interface',
'gpu::raster::RasterInterface',
'gpu::Mailbox',
'gpu::MailboxHolder',
'gpu::SyncToken',
'gpu::webgpu::ReservedTexture',
'display::Display',
'media::IsOpaque',
'media::kNoTransformation',
'media::PaintCanvasVideoRenderer',
'media::PIXEL_FORMAT_Y16',
'media::VideoFrame',
'viz::RasterContextProvider',
'viz::ReleaseCallback',
'viz::ResourceFormat',
'viz::ResourceFormatToClosestSkColorType',
'viz::TransferableResource',
],
},
{
'paths': [
'third_party/blink/renderer/modules/webgl/webgl_rendering_context_base.cc',
],
# This class needs access to a GPU driver bug workaround entry.
'allowed': [
'gpu::ENABLE_WEBGL_TIMER_QUERY_EXTENSIONS',
],
},
{
'paths': [
'third_party/blink/renderer/core/html/media/',
],
# This module needs access to the following for media's base::Feature
# list.
'allowed': [
'media::.+',
]
},
{
'paths': [
'third_party/blink/renderer/core/timing/background_tracing_helper.cc',
'third_party/blink/renderer/core/timing/background_tracing_helper.h',
],
'allowed': [
'base::MD5Digest',
'base::MD5Sum',
'base::StringPiece',
]
},
{
'paths': [
'third_party/blink/renderer/modules/breakout_box/',
],
'allowed': [
'media::.+',
# Some media APIs require std::vector.
"std::vector",
]
},
{
'paths': [
'third_party/blink/renderer/modules/mediasource/',
],
'allowed': [
'base::CommandLine',
'media::.+',
'switches::kLacrosEnablePlatformEncryptedHevc',
]
},
{
'paths': [
'third_party/blink/renderer/modules/encryptedmedia/',
'third_party/blink/renderer/modules/media/',
'third_party/blink/renderer/modules/media_capabilities/',
'third_party/blink/renderer/modules/video_rvfc/',
],
'allowed': [
'media::.+',
'media_capabilities_identifiability_metrics::.+',
]
},
{
'paths': [
'third_party/blink/renderer/modules/media/audio/',
],
'allowed': [
# TODO(https://crbug.com/787252): Remove most of the entries below,
# once the directory is fully Onion soup'ed.
'base::Bind.*',
'base::Unretained',
'base::NoDestructor',
'base::flat_map',
'base::AutoLock',
'base::Lock',
'base::EraseIf',
'base::ScopedPlatformFile',
'mojo::WrapCallbackWithDefaultInvokeIfNotRun',
# TODO(https://crrev.com/787252): Consider allowlisting fidl::*
# usage more broadly in Blink.
'fidl::InterfaceHandle',
]
},
{
'paths': [
'third_party/blink/renderer/modules/imagecapture/',
],
'allowed': [
'cc::SkiaPaintCanvas',
'libyuv::.+',
'media::.+',
]
},
{
'paths': [
'third_party/blink/renderer/modules/media_capabilities/media_capabilities_fuzzer.cc',
],
'allowed': [
'mc_fuzzer::.+',
'google::protobuf::RepeatedField',
]
},
{
'paths': [
'third_party/blink/renderer/modules/mediacapturefromelement/',
],
'allowed': [
'gpu::MailboxHolder',
'media::.+',
'libyuv::.+',
'viz::SkColorTypeToResourceFormat',
]
},
{
'paths': [
'third_party/blink/renderer/modules/mediarecorder/',
],
'allowed': [
'base::data',
# TODO(crbug.com/960665): Remove base::queue once it is replaced with a WTF equivalent.
'base::queue',
'base::SharedMemory',
'base::StringPiece',
'base::ThreadTaskRunnerHandle',
'media::.+',
'libopus::.+',
'libyuv::.+',
'video_track_recorder::.+',
]
},
{
'paths': [
'third_party/blink/renderer/modules/mediastream/',
],
'allowed': [
'media::.+',
'base::AutoLock',
'base::Hash',
'base::Lock',
'base::StringPrintf',
'base::TaskRunner',
# TODO(crbug.com/704136): Switch to using frame-based task runners.
'base::ThreadTaskRunnerHandle',
'base::subtle::Atomic32',
'base::subtle::Acquire_Load',
'base::subtle::NoBarrier_.+',
'base::subtle::Release_Store',
'cc::SkiaPaintCanvas',
'cc::UpdateSubmissionStateCB',
'cc::VideoFrameProvider',
'cc::VideoLayer',
'gpu::gles2::GLES2Interface',
'libyuv::.+',
'media_constraints::.+',
"rtc::RefCountedObject",
'rtc::TaskQueue',
'rtc::scoped_refptr',
'viz::.+',
'webrtc::Aec3ConfigFromJsonString',
'webrtc::AudioProcessingBuilder',
'webrtc::AudioProcessing',
'webrtc::AudioProcessorInterface',
'webrtc::AudioTrackInterface',
'webrtc::Config',
'webrtc::EchoCanceller3Config',
'webrtc::EchoCanceller3Factory',
'webrtc::ExperimentalAgc',
'webrtc::ExperimentalNs',
'webrtc::MediaStreamTrackInterface',
'webrtc::ObserverInterface',
'webrtc::StreamConfig',
'webrtc::TypingDetection',
'webrtc::VideoTrackInterface',
]
},
{
'paths': [
'third_party/blink/renderer/modules/indexeddb/',
],
'allowed': [
'indexed_db::.+',
],
},
{
'paths': [
'third_party/blink/renderer/modules/remote_objects/',
],
'allowed': [
'gin::.+',
# gin::NamedPropertyInterceptor uses std::vector.
'std::vector',
],
},
{
'paths': [
'third_party/blink/renderer/modules/webcodecs/',
],
'allowed': [
'base::PlatformThreadRef',
'base::WrapRefCounted',
'cc::kNumYUVPlanes',
'cc::YUVIndex',
'cc::YUVSubsampling',
'gpu::kNullSurfaceHandle',
'gpu::SHARED_IMAGE_.+',
'gpu::raster::RasterInterface',
'gpu::Mailbox',
'gpu::MailboxHolder',
'gpu::SharedImageInterface',
'gpu::SyncToken',
'viz::RasterContextProvider',
'viz::ReleaseCallback',
'viz::ResourceFormat',
'media::.+',
'libyuv::.+',
]
},
{
'paths': [
'third_party/blink/renderer/modules/webcodecs/video_decoder_fuzzer.cc',
'third_party/blink/renderer/modules/webcodecs/fuzzer_utils.cc',
'third_party/blink/renderer/modules/webcodecs/fuzzer_utils.h',
],
'allowed': [
'wc_fuzzer::.+',
]
},
{
'paths': [
'third_party/blink/renderer/modules/webgpu/',
],
# The WebGPU Blink module needs access to the WebGPU control
# command buffer interface.
'allowed': [
'gpu::webgpu::PowerPreference',
'gpu::webgpu::WebGPUInterface',
],
},
{
'paths': [
'third_party/blink/renderer/modules/webrtc/',
],
'allowed': [
'base::AutoLock',
'base::Erase',
'base::Lock',
'base::StringPrintf',
'media::.+',
'rtc::scoped_refptr',
'webrtc::AudioDeviceModule',
'webrtc::AudioSourceInterface',
'webrtc::AudioTransport',
'webrtc::kAdmMaxDeviceNameSize',
'webrtc::kAdmMaxGuidSize',
]
},
{
'paths': [
'third_party/blink/renderer/platform/',
],
# Suppress almost all checks on platform since code in this directory is
# meant to be a bridge between Blink and non-Blink code. However,
# base::RefCounted should still be explicitly blocked, since
# WTF::RefCounted should be used instead. base::RefCountedThreadSafe is
# still needed for cross_thread_copier.h though.
'allowed': ['base::RefCountedThreadSafe', '(?!base::RefCounted).+'],
'disallowed': [
# TODO(https://crbug.com/1267866): this warning is shown twice for
# renderer/platform/ violations.
_DISALLOW_NON_BLINK_MOJOM,
]
},
{
'paths': [
'third_party/blink/renderer/platform/scheduler/common/single_thread_idle_task_runner.h',
],
# base::RefCounted is prohibited in platform/ as defined above, but
# SingleThreadIdleTaskRunner needs to be constructed before WTF and
# PartitionAlloc are initialized, which forces us to use
# base::RefCountedThreadSafe for it.
'allowed': ['.+'],
},
{
'paths': [
'third_party/blink/renderer/core/exported/',
'third_party/blink/renderer/core/input/',
],
'allowed': [
'ui::LatencyInfo',
],
},
{
'paths': [
'third_party/blink/renderer/modules/animationworklet/',
],
'allowed': [
'cc::AnimationOptions',
'cc::AnimationEffectTimings',
],
},
{
'paths': [
'third_party/blink/renderer/modules/url_pattern/',
],
'allowed': [
# Required to provide a canonicalization functor to liburlpattern.
"absl::InvalidArgumentError",
"absl::StatusOr",
# Required by liburlpattern API in order to pass string data
# efficiently.
"absl::string_view",
# Needed to work with std::string values returned from
# liburlpattern API.
"base::IsStringASCII",
# Needed to use part of the StringUTF8Adaptor API.
"base::StringPiece",
# //third_party/liburlpattern
'liburlpattern::.+',
# The liburlpattern API requires using std::vector.
'std::vector',
# Internal namespace used by url_pattern module.
'url_pattern::.+',
],
},
{
'paths': [
'third_party/blink/renderer/modules/webaudio/',
],
'allowed': ['audio_utilities::.+'],
},
{
'paths': [
'third_party/blink/renderer/modules/webdatabase/',
],
'allowed': ['sql::.+'],
},
{
'paths': [
'third_party/blink/renderer/core/layout/layout_theme.cc',
'third_party/blink/renderer/core/layout/layout_theme_mac.mm',
'third_party/blink/renderer/core/paint/outline_painter.cc',
'third_party/blink/renderer/core/paint/theme_painter.cc',
'third_party/blink/renderer/core/paint/theme_painter_default.cc',
],
'allowed': ['ui::NativeTheme.*', 'ui::color_utils.*'],
},
{
'paths': [
'third_party/blink/renderer/core/scroll/mac_scrollbar_animator_impl.h',
'third_party/blink/renderer/core/scroll/mac_scrollbar_animator_impl.mm',
],
'allowed': [
'ui::ScrollbarAnimationTimerMac',
'ui::OverlayScrollbarAnimatorMac',
],
},
{
'paths': [
'third_party/blink/renderer/modules/crypto/',
],
'allowed': ['crypto::.+'],
},
{
'paths': [
'third_party/blink/renderer/modules/p2p',
],
'allowed': [
# TODO(crbug.com/787254): Remove GURL usage.
'GURL',
'cricket::.*',
'rtc::.+',
]
},
{
'paths': [
# TODO(crbug.com/787254): Separate the two paths below and their own
# allowlist.
'third_party/blink/renderer/modules/peerconnection/',
'third_party/blink/renderer/bindings/modules/v8/serialization/',
],
'allowed': [
'absl::.+',
'base::AutoLock',
'base::AutoUnlock',
# TODO(crbug.com/1266408): Temporarily added to enable splitting UMA stats based on tier.
'base::CPU',
'base::LazyInstance',
'base::Lock',
# TODO(crbug.com/787254): Remove base::BindOnce, base::Unretained,
# base::Passed, base::OnceClosure, base::RepeatingClosure,
# base::CurrentThread and base::RetainedRef.
'base::Bind.*',
'base::MD5.*',
'base::CurrentThread',
'base::.*Closure',
'base::Passed',
'base::PowerObserver',
'base::RetainedRef',
'base::StringPrintf',
'base::Value',
'base::Unretained',
# TODO(crbug.com/787254): Replace base::Thread with the appropriate Blink class.
'base::Thread',
'base::WrapRefCounted',
'cricket::.*',
'jingle_glue::JingleThreadWrapper',
# TODO(crbug.com/787254): Remove GURL usage.
'GURL',
'media::.+',
'net::NetworkTrafficAnnotationTag',
'net::DefineNetworkTrafficAnnotation',
# TODO(crbug.com/1266408): Temporarily added to enable splitting UMA stats based on tier.
're2::RE2',
'rtc::.+',
'webrtc::.+',
'quic::.+',
'quiche::.+',
]
},
{
'paths': [
'third_party/blink/renderer/modules/peerconnection/adapters/',
],
# The code in adapters/ wraps WebRTC APIs using STL/WebRTC types only.
# Thus, the restriction that objects should only be created and
# destroyed on the same thread can be relaxed since no Blink types (like
# AtomicString or HeapVector) are used cross thread. These Blink types
# are converted to the STL/WebRTC counterparts in the parent directory.
'allowed': [
'base::OnTaskRunnerDeleter',
'sigslot::.+',
],
},
{
'paths': [
'third_party/blink/renderer/modules/direct_sockets/',
],
'allowed': [
'net::DefineNetworkTrafficAnnotation',
'net::Error',
'net::MutableNetworkTrafficAnnotationTag',
'net::NetworkTrafficAnnotationTag',
]
},
{
'paths': ['third_party/blink/renderer/modules/manifest/'],
'allowed': [
'net::IsValidTopLevelMimeType',
'net::ParseMimeTypeWithoutParameter',
'net::registry_controlled_domains::.+',
],
},
{
'paths':
['third_party/blink/renderer/core/fetch/fetch_request_data.cc'],
'allowed': ['net::RequestPriority'],
},
{
'paths':
['third_party/blink/renderer/core/fetch/fetch_response_data.cc'],
'allowed': [
'storage::ComputeRandomResponsePadding',
'storage::ComputeStableResponsePadding',
'storage::ShouldPadResponseType'
],
},
{
'paths': ['third_party/blink/renderer/core/frame/local_frame_view.cc'],
'allowed': [
'base::LapTimer',
'cc::frame_viewer_instrumentation::IsTracingLayerTreeSnapshots',
],
},
{
'paths': [
'third_party/blink/renderer/modules/webaudio/offline_audio_worklet_thread.cc',
'third_party/blink/renderer/modules/webaudio/realtime_audio_worklet_thread.cc',
'third_party/blink/renderer/modules/webaudio/semi_realtime_audio_worklet_thread.cc',
],
'allowed': ['base::ThreadPriority'],
},
{
'paths': [
'third_party/blink/renderer/core/frame/local_frame_mojo_handler.cc',
'third_party/blink/renderer/core/frame/local_frame_mojo_handler.h'
],
'allowed': ['base::Value'],
},
{
'paths': ['third_party/blink/renderer/core/frame/local_dom_window.cc'],
'allowed': [
'net::registry_controlled_domains::.+',
],
},
{
'paths': [
'third_party/blink/renderer/platform/audio/',
'third_party/blink/renderer/modules/webaudio/',
],
'allowed': ['fdlibm::.+'],
},
{
'paths': [
'third_party/blink/renderer/core/html/canvas/html_canvas_element.cc',
'third_party/blink/renderer/core/html/canvas/html_canvas_element.h',
],
'allowed': ['viz::ResourceId'],
},
{
'paths': [
'third_party/blink/renderer/platform/graphics/document_transition_shared_element_id.h'
],
'allowed': ['cc::DocumentTransitionSharedElementId'],
},
{
'paths': [
'third_party/blink/renderer/core/',
],
'allowed': ['ui::k200Percent'],
},
{
'paths': [
'third_party/blink/renderer/core/loader/frame_client_hints_preferences_context.cc',
],
'allowed': [
'base::NoDestructor',
]
},
{
'paths': [
'third_party/blink/renderer/modules/webdatabase/dom_window_web_database.cc',
'third_party/blink/renderer/controller/blink_initializer.cc',
],
'allowed': [
'base::CommandLine',
]
},
{
'paths': [
'third_party/blink/renderer/controller/blink_shutdown.cc',
],
'allowed': [
'base::CommandLine',
'switches::kDumpRuntimeCallStats',
]
},
{
'paths':
['third_party/blink/renderer/bindings/core/v8/local_window_proxy.cc'],
'allowed': [
'base::SingleSampleMetric',
'base::SingleSampleMetricsFactory',
],
},
{
'paths': [
'third_party/blink/renderer/modules/service_worker/navigation_preload_request.cc',
'third_party/blink/renderer/modules/service_worker/navigation_preload_request.h',
],
'allowed': [
'net::ERR_.+',
'net::HttpResponseHeaders',
'net::OK',
'net::RedirectInfo',
],
},
{
# base::Value is used in test-only script execution in worker contexts.
'paths': [
'third_party/blink/renderer/modules/service_worker/service_worker_global_scope.cc',
],
'allowed': [
'base::Value',
],
},
]
def _precompile_config():
"""Turns the raw config into a config of compiled regex."""
match_nothing_re = re.compile('.^')
def compile_regexp(match_list, is_list=True):
"""Turns a match list into a compiled regexp.
If match_list is None, a regexp that matches nothing is returned.
"""
if (match_list and is_list):
match_list = '(?:%s)$' % '|'.join(match_list)
if match_list:
return re.compile(match_list)
return match_nothing_re
def compile_disallowed(disallowed_list):
"""Transforms the disallowed list to one with the regexps compiled."""
if not disallowed_list:
return match_nothing_re, []
match_list = []
advice_list = []
for entry in disallowed_list:
if isinstance(entry, tuple):
warning = ''
if len(entry) == 2:
match, advice = entry
else:
match, advice, warning = entry
match_list.append(match)
advice_list.append((compile_regexp(match, False), advice,
warning == 'Warning'))
else:
# Just a string
match_list.append(entry)
return compile_regexp(match_list), advice_list
compiled_config = []
for raw_entry in _CONFIG:
disallowed, advice = compile_disallowed(raw_entry.get('disallowed'))
compiled_config.append({
'paths':
raw_entry['paths'],
'allowed':
compile_regexp(raw_entry.get('allowed')),
'disallowed':
disallowed,
'advice':
advice,
})
return compiled_config
_COMPILED_CONFIG = _precompile_config()
# Attempt to match identifiers qualified with a namespace. Since parsing C++ in
# Python is hard, this regex assumes that namespace names only contain lowercase
# letters, numbers, and underscores, matching the Google C++ style guide. This
# is intended to minimize the number of matches where :: is used to qualify a
# name with a class or enum name.
#
# As a bit of a minor hack, this regex also hardcodes a check for GURL, since
# GURL isn't namespace qualified and wouldn't match otherwise.
_IDENTIFIER_WITH_NAMESPACE_RE = re.compile(
r'\b(?:(?:[a-z_][a-z0-9_]*::)+[A-Za-z_][A-Za-z0-9_]*|GURL)\b')
def _find_matching_entries(path):
"""Finds entries that should be used for path.
Returns:
A list of entries, sorted in order of relevance. Each entry is a
dictionary with keys:
allowed: A regexp for identifiers that should be allowed.
disallowed: A regexp for identifiers that should not be allowed.
advice: (optional) A regexp for identifiers along with advice
"""
entries = []
for entry in _COMPILED_CONFIG:
for entry_path in entry['paths']:
if path.startswith(entry_path):
entries.append({'sortkey': len(entry_path), 'entry': entry})
# The path length is used as the sort key: a longer path implies more
# relevant, since that config is a more exact match.
entries.sort(key=lambda x: x['sortkey'], reverse=True)
return [entry['entry'] for entry in entries]
def _check_entries_for_identifier(entries, identifier):
"""Check if an identifier is allowed"""
for entry in entries:
if entry['disallowed'].match(identifier):
return False
if entry['allowed'].match(identifier):
return True
# Disallow by default.
return False
def _find_advice_for_identifier(entries, identifier):
advice_list = []
for entry in entries:
for matcher, advice, warning in entry.get('advice', []):
if matcher.match(identifier):
advice_list.append(advice)
return advice_list, warning
class BadIdentifier(object):
"""Represents a single instance of a bad identifier."""
def __init__(self, identifier, line, advice=None, warning=False):
self.identifier = identifier
self.line = line
self.advice = advice
self.warning = warning
def check(path, contents):
"""Checks for disallowed usage of non-Blink classes, functions, et cetera.
Args:
path: The path of the file to check.
contents: An array of line number, line tuples to check.
Returns:
A list of (line number, disallowed identifier, advice) tuples.
"""
results = []
# Because Windows.
path = path.replace('\\', '/')
basename, ext = os.path.splitext(path)
# Only check code. Ignore tests and fuzzers.
if (ext not in ('.cc', '.cpp', '.h', '.mm') or path.find('/testing/') >= 0
or path.find('/core/web_test/') >= 0 or path.find('/tests/') >= 0
or basename.endswith('_test') or basename.endswith('_test_helpers')
or basename.endswith('_unittest') or basename.endswith('_fuzzer')
or basename.endswith('_perftest')):
return results
entries = _find_matching_entries(path)
if not entries:
return
for line_number, line in contents:
idx = line.find('//')
if idx >= 0:
line = line[:idx]
identifiers = _IDENTIFIER_WITH_NAMESPACE_RE.findall(line)
for identifier in identifiers:
if not _check_entries_for_identifier(entries, identifier):
advice, warning = _find_advice_for_identifier(
entries, identifier)
results.append(
BadIdentifier(identifier, line_number, advice, warning))
return results
def main():
for path in sys.stdin.read().splitlines():
try:
with open(path, 'r') as f:
contents = f.read()
disallowed_identifiers = check(
path,
[(i + 1, l) for i, l in enumerate(contents.splitlines())])
if disallowed_identifiers:
print('%s uses disallowed identifiers:' % path)
for i in disallowed_identifiers:
print(i.line, i.identifier, i.advice)
except IOError as e:
print('could not open %s: %s' % (path, e))
if __name__ == '__main__':
sys.exit(main())