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

-- |
-- Module      :  Data.BAM.Version1_6.BAM.Alignment.OptionalFields.BigSOPT
-- 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.BigSOPT ( -- * BAM version 1.6 alignment optional fields data type
                                                                  BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT(..)
                                                                ) where

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

-- | Custom BAM (version 1.6) @"BAM_V1_6_Alignment_OptionalFields_BigSOPT"@ 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_BigSOPT = BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT
  { BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT -> ByteString
bam_v1_6_bam_alignment_optionalfields_bigsopt_tag   :: ByteString
  , BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT -> Word16
bam_v1_6_bam_alignment_optionalfields_bigsopt_value :: Word16
  } deriving ((forall x.
 BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT
 -> Rep BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT x)
-> (forall x.
    Rep BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT x
    -> BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT)
-> Generic BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT
forall x.
Rep BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT x
-> BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT
forall x.
BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT
-> Rep BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT 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_BigSOPT
-> Rep BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT x
from :: forall x.
BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT
-> Rep BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT x
$cto :: forall x.
Rep BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT x
-> BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT
to :: forall x.
Rep BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT x
-> BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT
Generic,Typeable)

instance Eq BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT where
  BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT ByteString
bam_v1_6_bam_alignment_optionalfields_bigsopt_tag1
                                                Word16
bam_v1_6_bam_alignment_optionalfields_bigsopt_value1 == :: BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT
-> BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT -> Bool
==
    BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT ByteString
bam_v1_6_bam_alignment_optionalfields_bigsopt_tag2
                                                  Word16
bam_v1_6_bam_alignment_optionalfields_bigsopt_value2 =
      ByteString
bam_v1_6_bam_alignment_optionalfields_bigsopt_tag1   ByteString -> ByteString -> Bool
forall a. Eq a => a -> a -> Bool
== ByteString
bam_v1_6_bam_alignment_optionalfields_bigsopt_tag2 Bool -> Bool -> Bool
&&
      Word16
bam_v1_6_bam_alignment_optionalfields_bigsopt_value1 Word16 -> Word16 -> Bool
forall a. Eq a => a -> a -> Bool
== Word16
bam_v1_6_bam_alignment_optionalfields_bigsopt_value2

instance Show BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT where
  show :: BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT -> String
show (BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT ByteString
tag
                                                      Word16
value
       ) =
    String
"BAM_V1_6_BAM_Alignment_OptionalFields_BigSOPT { "          String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
"bam_v1_6_bam_alignment_optionalfields_bigsopt_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_bigsopt_value = " String -> ShowS
forall a. [a] -> [a] -> [a]
++
    (Word16 -> String
forall a. Show a => a -> String
show Word16
value)                                                String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
" }"