/**

 * Copyright (c) Meta Platforms, Inc. and affiliates.

 *

 * This source code is licensed under the MIT license found in the

 * LICENSE file in the root directory of this source tree.

 *

 * @flow

 */

import {enableCreateEventHandleAPI} from 'shared/ReactFeatureFlags';

export type Flags = number;

// Don't change these values. They're used by React Dev Tools.

export const NoFlags = /*                      */ 0b0000000000000000000000000000;

export const PerformedWork = /*                */ 0b0000000000000000000000000001;

export const Placement = /*                    */ 0b0000000000000000000000000010;

export const DidCapture = /*                   */ 0b0000000000000000000010000000;

export const Hydrating = /*                    */ 0b0000000000000001000000000000;

// You can change the rest (and add more).

export const Update = /*                       */ 0b0000000000000000000000000100;

/* Skipped value:                                 0b0000000000000000000000001000; */

export const ChildDeletion = /*                */ 0b0000000000000000000000010000;

export const ContentReset = /*                 */ 0b0000000000000000000000100000;

export const Callback = /*                     */ 0b0000000000000000000001000000;

/* Used by DidCapture:                            0b0000000000000000000010000000; */

export const ForceClientRender = /*            */ 0b0000000000000000000100000000;

export const Ref = /*                          */ 0b0000000000000000001000000000;

export const Snapshot = /*                     */ 0b0000000000000000010000000000;

export const Passive = /*                      */ 0b0000000000000000100000000000;

/* Used by Hydrating:                             0b0000000000000001000000000000; */

export const Visibility = /*                   */ 0b0000000000000010000000000000;

export const StoreConsistency = /*             */ 0b0000000000000100000000000000;

// It's OK to reuse these bits because these flags are mutually exclusive for

// different fiber types. We should really be doing this for as many flags as

// possible, because we're about to run out of bits.

export const ScheduleRetry = StoreConsistency;

export const ShouldSuspendCommit = Visibility;

export const LifecycleEffectMask =

  Passive | Update | Callback | Ref | Snapshot | StoreConsistency;

// Union of all commit flags (flags with the lifetime of a particular commit)

export const HostEffectMask = /*               */ 0b0000000000000111111111111111;

// These are not really side effects, but we still reuse this field.

export const Incomplete = /*                   */ 0b0000000000001000000000000000;

export const ShouldCapture = /*                */ 0b0000000000010000000000000000;

export const ForceUpdateForLegacySuspense = /* */ 0b0000000000100000000000000000;

export const DidPropagateContext = /*          */ 0b0000000001000000000000000000;

export const NeedsPropagation = /*             */ 0b0000000010000000000000000000;

export const Forked = /*                       */ 0b0000000100000000000000000000;

// Static tags describe aspects of a fiber that are not specific to a render,

// e.g. a fiber uses a passive effect (even if there are no updates on this particular render).

// This enables us to defer more work in the unmount case,

// since we can defer traversing the tree during layout to look for Passive effects,

// and instead rely on the static flag as a signal that there may be cleanup work.

export const RefStatic = /*                    */ 0b0000001000000000000000000000;

export const LayoutStatic = /*                 */ 0b0000010000000000000000000000;

export const PassiveStatic = /*                */ 0b0000100000000000000000000000;

export const MaySuspendCommit = /*             */ 0b0001000000000000000000000000;

// Flag used to identify newly inserted fibers. It isn't reset after commit unlike `Placement`.

export const PlacementDEV = /*                 */ 0b0010000000000000000000000000;

export const MountLayoutDev = /*               */ 0b0100000000000000000000000000;

export const MountPassiveDev = /*              */ 0b1000000000000000000000000000;

// Groups of flags that are used in the commit phase to skip over trees that

// don't contain effects, by checking subtreeFlags.

export const BeforeMutationMask: number =

  // TODO: Remove Update flag from before mutation phase by re-landing Visibility

  // flag logic (see #20043)

  Update |

  Snapshot |

  (enableCreateEventHandleAPI

    ? // createEventHandle needs to visit deleted and hidden trees to

      // fire beforeblur

      // TODO: Only need to visit Deletions during BeforeMutation phase if an

      // element is focused.

      ChildDeletion | Visibility

    : 0);

export const MutationMask =

  Placement |

  Update |

  ChildDeletion |

  ContentReset |

  Ref |

  Hydrating |

  Visibility;

export const LayoutMask = Update | Callback | Ref | Visibility;

// TODO: Split into PassiveMountMask and PassiveUnmountMask

export const PassiveMask = Passive | Visibility | ChildDeletion;

// Union of tags that don't get reset on clones.

// This allows certain concepts to persist without recalculating them,

// e.g. whether a subtree contains passive effects or portals.

export const StaticMask =

  LayoutStatic | PassiveStatic | RefStatic | MaySuspendCommit;