xref: /aosp_15_r20/development/tools/winscope/src/common/assert_utils.ts (revision 90c8c64db3049935a07c6143d7fd006e26f8ecca)
1*90c8c64dSAndroid Build Coastguard Worker/*
2*90c8c64dSAndroid Build Coastguard Worker * Copyright (C) 2023 The Android Open Source Project
3*90c8c64dSAndroid Build Coastguard Worker *
4*90c8c64dSAndroid Build Coastguard Worker * Licensed under the Apache License, Version 2.0 (the "License");
5*90c8c64dSAndroid Build Coastguard Worker * you may not use this file except in compliance with the License.
6*90c8c64dSAndroid Build Coastguard Worker * You may obtain a copy of the License at
7*90c8c64dSAndroid Build Coastguard Worker *
8*90c8c64dSAndroid Build Coastguard Worker *      http://www.apache.org/licenses/LICENSE-2.0
9*90c8c64dSAndroid Build Coastguard Worker *
10*90c8c64dSAndroid Build Coastguard Worker * Unless required by applicable law or agreed to in writing, software
11*90c8c64dSAndroid Build Coastguard Worker * distributed under the License is distributed on an "AS IS" BASIS,
12*90c8c64dSAndroid Build Coastguard Worker * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*90c8c64dSAndroid Build Coastguard Worker * See the License for the specific language governing permissions and
14*90c8c64dSAndroid Build Coastguard Worker * limitations under the License.
15*90c8c64dSAndroid Build Coastguard Worker */
16*90c8c64dSAndroid Build Coastguard Worker
17*90c8c64dSAndroid Build Coastguard Workerexport function assertDefined<A>(
18*90c8c64dSAndroid Build Coastguard Worker  value: A | null | undefined,
19*90c8c64dSAndroid Build Coastguard Worker  lazyErrorMessage?: () => string,
20*90c8c64dSAndroid Build Coastguard Worker): A {
21*90c8c64dSAndroid Build Coastguard Worker  if (value === undefined || value === null) {
22*90c8c64dSAndroid Build Coastguard Worker    throw new Error(
23*90c8c64dSAndroid Build Coastguard Worker      lazyErrorMessage
24*90c8c64dSAndroid Build Coastguard Worker        ? lazyErrorMessage()
25*90c8c64dSAndroid Build Coastguard Worker        : `Expected value, but found '${value}'`,
26*90c8c64dSAndroid Build Coastguard Worker    );
27*90c8c64dSAndroid Build Coastguard Worker  }
28*90c8c64dSAndroid Build Coastguard Worker  return value;
29*90c8c64dSAndroid Build Coastguard Worker}
30*90c8c64dSAndroid Build Coastguard Worker
31*90c8c64dSAndroid Build Coastguard Workerexport function assertTrue(value: boolean, lazyErrorMessage?: () => string) {
32*90c8c64dSAndroid Build Coastguard Worker  if (!value) {
33*90c8c64dSAndroid Build Coastguard Worker    throw new Error(
34*90c8c64dSAndroid Build Coastguard Worker      lazyErrorMessage ? lazyErrorMessage() : 'Expected value to be true',
35*90c8c64dSAndroid Build Coastguard Worker    );
36*90c8c64dSAndroid Build Coastguard Worker  }
37*90c8c64dSAndroid Build Coastguard Worker}
38*90c8c64dSAndroid Build Coastguard Worker
39*90c8c64dSAndroid Build Coastguard Worker// Ensure at compile-time that a certain line is not reachable.
40*90c8c64dSAndroid Build Coastguard Worker// E.g. make sure that a switch/case handles all possible input values.
41*90c8c64dSAndroid Build Coastguard Workerexport function assertUnreachable(x: never): never {
42*90c8c64dSAndroid Build Coastguard Worker  throw new Error('This line should never execute');
43*90c8c64dSAndroid Build Coastguard Worker}
44