{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Comprehend.Types.BlockReference
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Comprehend.Types.BlockReference where

import Amazonka.Comprehend.Types.ChildBlock
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | A reference to a block.
--
-- /See:/ 'newBlockReference' smart constructor.
data BlockReference = BlockReference'
  { -- | Offset of the start of the block within its parent block.
    BlockReference -> Maybe Int
beginOffset :: Prelude.Maybe Prelude.Int,
    -- | Unique identifier for the block.
    BlockReference -> Maybe Text
blockId :: Prelude.Maybe Prelude.Text,
    -- | List of child blocks within this block.
    BlockReference -> Maybe [ChildBlock]
childBlocks :: Prelude.Maybe [ChildBlock],
    -- | Offset of the end of the block within its parent block.
    BlockReference -> Maybe Int
endOffset :: Prelude.Maybe Prelude.Int
  }
  deriving (BlockReference -> BlockReference -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BlockReference -> BlockReference -> Bool
$c/= :: BlockReference -> BlockReference -> Bool
== :: BlockReference -> BlockReference -> Bool
$c== :: BlockReference -> BlockReference -> Bool
Prelude.Eq, ReadPrec [BlockReference]
ReadPrec BlockReference
Int -> ReadS BlockReference
ReadS [BlockReference]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [BlockReference]
$creadListPrec :: ReadPrec [BlockReference]
readPrec :: ReadPrec BlockReference
$creadPrec :: ReadPrec BlockReference
readList :: ReadS [BlockReference]
$creadList :: ReadS [BlockReference]
readsPrec :: Int -> ReadS BlockReference
$creadsPrec :: Int -> ReadS BlockReference
Prelude.Read, Int -> BlockReference -> ShowS
[BlockReference] -> ShowS
BlockReference -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [BlockReference] -> ShowS
$cshowList :: [BlockReference] -> ShowS
show :: BlockReference -> String
$cshow :: BlockReference -> String
showsPrec :: Int -> BlockReference -> ShowS
$cshowsPrec :: Int -> BlockReference -> ShowS
Prelude.Show, forall x. Rep BlockReference x -> BlockReference
forall x. BlockReference -> Rep BlockReference x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep BlockReference x -> BlockReference
$cfrom :: forall x. BlockReference -> Rep BlockReference x
Prelude.Generic)

-- |
-- Create a value of 'BlockReference' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'beginOffset', 'blockReference_beginOffset' - Offset of the start of the block within its parent block.
--
-- 'blockId', 'blockReference_blockId' - Unique identifier for the block.
--
-- 'childBlocks', 'blockReference_childBlocks' - List of child blocks within this block.
--
-- 'endOffset', 'blockReference_endOffset' - Offset of the end of the block within its parent block.
newBlockReference ::
  BlockReference
newBlockReference :: BlockReference
newBlockReference =
  BlockReference'
    { $sel:beginOffset:BlockReference' :: Maybe Int
beginOffset = forall a. Maybe a
Prelude.Nothing,
      $sel:blockId:BlockReference' :: Maybe Text
blockId = forall a. Maybe a
Prelude.Nothing,
      $sel:childBlocks:BlockReference' :: Maybe [ChildBlock]
childBlocks = forall a. Maybe a
Prelude.Nothing,
      $sel:endOffset:BlockReference' :: Maybe Int
endOffset = forall a. Maybe a
Prelude.Nothing
    }

-- | Offset of the start of the block within its parent block.
blockReference_beginOffset :: Lens.Lens' BlockReference (Prelude.Maybe Prelude.Int)
blockReference_beginOffset :: Lens' BlockReference (Maybe Int)
blockReference_beginOffset = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BlockReference' {Maybe Int
beginOffset :: Maybe Int
$sel:beginOffset:BlockReference' :: BlockReference -> Maybe Int
beginOffset} -> Maybe Int
beginOffset) (\s :: BlockReference
s@BlockReference' {} Maybe Int
a -> BlockReference
s {$sel:beginOffset:BlockReference' :: Maybe Int
beginOffset = Maybe Int
a} :: BlockReference)

-- | Unique identifier for the block.
blockReference_blockId :: Lens.Lens' BlockReference (Prelude.Maybe Prelude.Text)
blockReference_blockId :: Lens' BlockReference (Maybe Text)
blockReference_blockId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BlockReference' {Maybe Text
blockId :: Maybe Text
$sel:blockId:BlockReference' :: BlockReference -> Maybe Text
blockId} -> Maybe Text
blockId) (\s :: BlockReference
s@BlockReference' {} Maybe Text
a -> BlockReference
s {$sel:blockId:BlockReference' :: Maybe Text
blockId = Maybe Text
a} :: BlockReference)

-- | List of child blocks within this block.
blockReference_childBlocks :: Lens.Lens' BlockReference (Prelude.Maybe [ChildBlock])
blockReference_childBlocks :: Lens' BlockReference (Maybe [ChildBlock])
blockReference_childBlocks = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BlockReference' {Maybe [ChildBlock]
childBlocks :: Maybe [ChildBlock]
$sel:childBlocks:BlockReference' :: BlockReference -> Maybe [ChildBlock]
childBlocks} -> Maybe [ChildBlock]
childBlocks) (\s :: BlockReference
s@BlockReference' {} Maybe [ChildBlock]
a -> BlockReference
s {$sel:childBlocks:BlockReference' :: Maybe [ChildBlock]
childBlocks = Maybe [ChildBlock]
a} :: BlockReference) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Offset of the end of the block within its parent block.
blockReference_endOffset :: Lens.Lens' BlockReference (Prelude.Maybe Prelude.Int)
blockReference_endOffset :: Lens' BlockReference (Maybe Int)
blockReference_endOffset = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BlockReference' {Maybe Int
endOffset :: Maybe Int
$sel:endOffset:BlockReference' :: BlockReference -> Maybe Int
endOffset} -> Maybe Int
endOffset) (\s :: BlockReference
s@BlockReference' {} Maybe Int
a -> BlockReference
s {$sel:endOffset:BlockReference' :: Maybe Int
endOffset = Maybe Int
a} :: BlockReference)

instance Data.FromJSON BlockReference where
  parseJSON :: Value -> Parser BlockReference
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"BlockReference"
      ( \Object
x ->
          Maybe Int
-> Maybe Text -> Maybe [ChildBlock] -> Maybe Int -> BlockReference
BlockReference'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"BeginOffset")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"BlockId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ChildBlocks" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"EndOffset")
      )

instance Prelude.Hashable BlockReference where
  hashWithSalt :: Int -> BlockReference -> Int
hashWithSalt Int
_salt BlockReference' {Maybe Int
Maybe [ChildBlock]
Maybe Text
endOffset :: Maybe Int
childBlocks :: Maybe [ChildBlock]
blockId :: Maybe Text
beginOffset :: Maybe Int
$sel:endOffset:BlockReference' :: BlockReference -> Maybe Int
$sel:childBlocks:BlockReference' :: BlockReference -> Maybe [ChildBlock]
$sel:blockId:BlockReference' :: BlockReference -> Maybe Text
$sel:beginOffset:BlockReference' :: BlockReference -> Maybe Int
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
beginOffset
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
blockId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [ChildBlock]
childBlocks
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
endOffset

instance Prelude.NFData BlockReference where
  rnf :: BlockReference -> ()
rnf BlockReference' {Maybe Int
Maybe [ChildBlock]
Maybe Text
endOffset :: Maybe Int
childBlocks :: Maybe [ChildBlock]
blockId :: Maybe Text
beginOffset :: Maybe Int
$sel:endOffset:BlockReference' :: BlockReference -> Maybe Int
$sel:childBlocks:BlockReference' :: BlockReference -> Maybe [ChildBlock]
$sel:blockId:BlockReference' :: BlockReference -> Maybe Text
$sel:beginOffset:BlockReference' :: BlockReference -> Maybe Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
beginOffset
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
blockId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [ChildBlock]
childBlocks
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
endOffset