{-# LANGUAGE DeriveDataTypeable    #-}
{-# LANGUAGE DeriveGeneric         #-}
{-# LANGUAGE FlexibleContexts      #-}
{-# LANGUAGE FlexibleInstances     #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE OverloadedStrings     #-}
{-# LANGUAGE StrictData            #-}
{-# LANGUAGE TypeFamilies          #-}

-- |
-- Module      :  Data.BAM.Version1_6.BAM.Alignment.OptionalFields.AOPT
-- Copyright   :  (c) Matthew Mosior 2024
-- License     :  BSD-style
-- Maintainer  :  mattm.github@gmail.com
-- Portability :  portable
--
-- = WARNING
--
-- This module is considered __internal__.
--
-- The Package Versioning Policy __does not apply__.
--
-- The contents of this module may change __in any way whatsoever__
-- and __without any warning__ between minor versions of this package.
--
-- Authors importing this library are expected to track development
-- closely.
--
-- All credit goes to the author(s)/maintainer(s) of the
-- [containers](https://hackage.haskell.org/package/containers) library
-- for the above warning text.
--
-- = Description
--
-- This library enables the decoding/encoding of SAM, BAM and CRAM file formats.

module Data.BAM.Version1_6.BAM.Alignment.OptionalFields.AOPT ( -- * BAM version 1.6 alignment optional fields data type
                                                               BAM_V1_6_BAM_Alignment_OptionalFields_AOPT(..)
                                                             ) where

import Data.ByteString
import Data.Word
import Data.Data
import Generics.Deriving.Base


-- | Custom BAM (version 1.6) @"BAM_V1_6_Alignment_OptionalFields_AOPT"@ data type.
--
-- See section 4.2 of the [SAM v1.6](http://samtools.github.io/hts-specs/SAMv1.pdf) specification documentation.
data BAM_V1_6_BAM_Alignment_OptionalFields_AOPT = BAM_V1_6_BAM_Alignment_OptionalFields_AOPT
  { BAM_V1_6_BAM_Alignment_OptionalFields_AOPT -> ByteString
bam_v1_6_bam_alignment_optionalfields_aopt_tag   :: ByteString
  , BAM_V1_6_BAM_Alignment_OptionalFields_AOPT -> Word8
bam_v1_6_bam_alignment_optionalfields_aopt_value :: Word8
  } deriving ((forall x.
 BAM_V1_6_BAM_Alignment_OptionalFields_AOPT
 -> Rep BAM_V1_6_BAM_Alignment_OptionalFields_AOPT x)
-> (forall x.
    Rep BAM_V1_6_BAM_Alignment_OptionalFields_AOPT x
    -> BAM_V1_6_BAM_Alignment_OptionalFields_AOPT)
-> Generic BAM_V1_6_BAM_Alignment_OptionalFields_AOPT
forall x.
Rep BAM_V1_6_BAM_Alignment_OptionalFields_AOPT x
-> BAM_V1_6_BAM_Alignment_OptionalFields_AOPT
forall x.
BAM_V1_6_BAM_Alignment_OptionalFields_AOPT
-> Rep BAM_V1_6_BAM_Alignment_OptionalFields_AOPT x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x.
BAM_V1_6_BAM_Alignment_OptionalFields_AOPT
-> Rep BAM_V1_6_BAM_Alignment_OptionalFields_AOPT x
from :: forall x.
BAM_V1_6_BAM_Alignment_OptionalFields_AOPT
-> Rep BAM_V1_6_BAM_Alignment_OptionalFields_AOPT x
$cto :: forall x.
Rep BAM_V1_6_BAM_Alignment_OptionalFields_AOPT x
-> BAM_V1_6_BAM_Alignment_OptionalFields_AOPT
to :: forall x.
Rep BAM_V1_6_BAM_Alignment_OptionalFields_AOPT x
-> BAM_V1_6_BAM_Alignment_OptionalFields_AOPT
Generic,Typeable)

instance Eq BAM_V1_6_BAM_Alignment_OptionalFields_AOPT where
  BAM_V1_6_BAM_Alignment_OptionalFields_AOPT ByteString
bam_v1_6_bam_alignment_optionalfields_aopt_tag1
                                             Word8
bam_v1_6_bam_alignment_optionalfields_aopt_value1 == :: BAM_V1_6_BAM_Alignment_OptionalFields_AOPT
-> BAM_V1_6_BAM_Alignment_OptionalFields_AOPT -> Bool
==
    BAM_V1_6_BAM_Alignment_OptionalFields_AOPT ByteString
bam_v1_6_bam_alignment_optionalfields_aopt_tag2
                                               Word8
bam_v1_6_bam_alignment_optionalfields_aopt_value2 =
      ByteString
bam_v1_6_bam_alignment_optionalfields_aopt_tag1   ByteString -> ByteString -> Bool
forall a. Eq a => a -> a -> Bool
== ByteString
bam_v1_6_bam_alignment_optionalfields_aopt_tag2 Bool -> Bool -> Bool
&&
      Word8
bam_v1_6_bam_alignment_optionalfields_aopt_value1 Word8 -> Word8 -> Bool
forall a. Eq a => a -> a -> Bool
== Word8
bam_v1_6_bam_alignment_optionalfields_aopt_value2

instance Show BAM_V1_6_BAM_Alignment_OptionalFields_AOPT where
  show :: BAM_V1_6_BAM_Alignment_OptionalFields_AOPT -> String
show (BAM_V1_6_BAM_Alignment_OptionalFields_AOPT ByteString
tag
                                                   Word8
value
       ) =
    String
"BAM_V1_6_BAM_Alignment_OptionalFields_AOPT { "          String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
"bam_v1_6_bam_alignment_optionalfields_aopt_tag = "      String -> ShowS
forall a. [a] -> [a] -> [a]
++
    (ByteString -> String
forall a. Show a => a -> String
show ByteString
tag)                                               String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
" , bam_v1_6_bam_alignment_optionalfields_aopt_value = " String -> ShowS
forall a. [a] -> [a] -> [a]
++
    (Word8 -> String
forall a. Show a => a -> String
show Word8
value)                                             String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
" }"