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

-- |
-- Module      :  Data.SAM.Version1_6.Header.HD
-- Copyright   :  (c) Matthew Mosior 2023
-- License     :  BSD-style
-- Maintainer  :  mattm.github@gmail.com
-- Portability :  portable
--
-- = Description
--
-- This library enables the decoding/encoding of SAM, BAM and CRAM file formats.

module Data.SAM.Version1_6.Header.HD ( -- * SAM version 1.6 File-level metadata data type
                                       SAM_V1_6_File_Level_Metadata(..),
                                       -- * SAM version 1.6 File-Level Metadata data types
                                       SAM_V1_6_File_Level_Metadata_Format_Version(..),
                                       SAM_V1_6_File_Level_Metadata_Sorting_Order(..),
                                       SAM_V1_6_File_Level_Metadata_Alignment_Grouping(..),
                                       SAM_V1_6_File_Level_Metadata_SubSorting_Order(..)
                                     ) where

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

-- | Custom SAM (version 1.6) @"SAM_V1_6_File_Level_Metadata"@ data type.
--
-- See section 1.3 of the [SAM v1.6](http://samtools.github.io/hts-specs/SAMv1.pdf) specification documentation.
data SAM_V1_6_File_Level_Metadata = SAM_V1_6_File_Level_Metadata { SAM_V1_6_File_Level_Metadata
-> SAM_V1_6_File_Level_Metadata_Format_Version
sam_v1_6_file_level_metadata_format_version     :: SAM_V1_6_File_Level_Metadata_Format_Version
                                                                 , SAM_V1_6_File_Level_Metadata
-> Maybe SAM_V1_6_File_Level_Metadata_Sorting_Order
sam_v1_6_file_level_metadata_sorting_order      :: Maybe SAM_V1_6_File_Level_Metadata_Sorting_Order
                                                                 , SAM_V1_6_File_Level_Metadata
-> Maybe SAM_V1_6_File_Level_Metadata_Alignment_Grouping
sam_v1_6_file_level_metadata_alignment_grouping :: Maybe SAM_V1_6_File_Level_Metadata_Alignment_Grouping
                                                                 , SAM_V1_6_File_Level_Metadata
-> Maybe SAM_V1_6_File_Level_Metadata_SubSorting_Order
sam_v1_6_file_level_metadata_subsorting_order   :: Maybe SAM_V1_6_File_Level_Metadata_SubSorting_Order
                                                                 }
   deriving ((forall x.
 SAM_V1_6_File_Level_Metadata -> Rep SAM_V1_6_File_Level_Metadata x)
-> (forall x.
    Rep SAM_V1_6_File_Level_Metadata x -> SAM_V1_6_File_Level_Metadata)
-> Generic SAM_V1_6_File_Level_Metadata
forall x.
Rep SAM_V1_6_File_Level_Metadata x -> SAM_V1_6_File_Level_Metadata
forall x.
SAM_V1_6_File_Level_Metadata -> Rep SAM_V1_6_File_Level_Metadata x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x.
SAM_V1_6_File_Level_Metadata -> Rep SAM_V1_6_File_Level_Metadata x
from :: forall x.
SAM_V1_6_File_Level_Metadata -> Rep SAM_V1_6_File_Level_Metadata x
$cto :: forall x.
Rep SAM_V1_6_File_Level_Metadata x -> SAM_V1_6_File_Level_Metadata
to :: forall x.
Rep SAM_V1_6_File_Level_Metadata x -> SAM_V1_6_File_Level_Metadata
Generic,Typeable)

instance Eq SAM_V1_6_File_Level_Metadata where
  SAM_V1_6_File_Level_Metadata SAM_V1_6_File_Level_Metadata_Format_Version
sam_v1_6_file_level_metadata_format_version1
                               Maybe SAM_V1_6_File_Level_Metadata_Sorting_Order
sam_v1_6_file_level_metadata_sorting_order1
                               Maybe SAM_V1_6_File_Level_Metadata_Alignment_Grouping
sam_v1_6_file_level_metadata_alignment_grouping1
                               Maybe SAM_V1_6_File_Level_Metadata_SubSorting_Order
sam_v1_6_file_level_metadata_subsorting_order1 == :: SAM_V1_6_File_Level_Metadata
-> SAM_V1_6_File_Level_Metadata -> Bool
== SAM_V1_6_File_Level_Metadata SAM_V1_6_File_Level_Metadata_Format_Version
sam_v1_6_file_level_metadata_format_version2
                                                                                                              Maybe SAM_V1_6_File_Level_Metadata_Sorting_Order
sam_v1_6_file_level_metadata_sorting_order2
                                                                                                              Maybe SAM_V1_6_File_Level_Metadata_Alignment_Grouping
sam_v1_6_file_level_metadata_alignment_grouping2
                                                                                                              Maybe SAM_V1_6_File_Level_Metadata_SubSorting_Order
sam_v1_6_file_level_metadata_subsorting_order2 = SAM_V1_6_File_Level_Metadata_Format_Version
sam_v1_6_file_level_metadata_format_version1     SAM_V1_6_File_Level_Metadata_Format_Version
-> SAM_V1_6_File_Level_Metadata_Format_Version -> Bool
forall a. Eq a => a -> a -> Bool
== SAM_V1_6_File_Level_Metadata_Format_Version
sam_v1_6_file_level_metadata_format_version2     Bool -> Bool -> Bool
&&
                                                                                                                                                               Maybe SAM_V1_6_File_Level_Metadata_Sorting_Order
sam_v1_6_file_level_metadata_sorting_order1      Maybe SAM_V1_6_File_Level_Metadata_Sorting_Order
-> Maybe SAM_V1_6_File_Level_Metadata_Sorting_Order -> Bool
forall a. Eq a => a -> a -> Bool
== Maybe SAM_V1_6_File_Level_Metadata_Sorting_Order
sam_v1_6_file_level_metadata_sorting_order2      Bool -> Bool -> Bool
&&
                                                                                                                                                               Maybe SAM_V1_6_File_Level_Metadata_Alignment_Grouping
sam_v1_6_file_level_metadata_alignment_grouping1 Maybe SAM_V1_6_File_Level_Metadata_Alignment_Grouping
-> Maybe SAM_V1_6_File_Level_Metadata_Alignment_Grouping -> Bool
forall a. Eq a => a -> a -> Bool
== Maybe SAM_V1_6_File_Level_Metadata_Alignment_Grouping
sam_v1_6_file_level_metadata_alignment_grouping2 Bool -> Bool -> Bool
&&
                                                                                                                                                               Maybe SAM_V1_6_File_Level_Metadata_SubSorting_Order
sam_v1_6_file_level_metadata_subsorting_order1   Maybe SAM_V1_6_File_Level_Metadata_SubSorting_Order
-> Maybe SAM_V1_6_File_Level_Metadata_SubSorting_Order -> Bool
forall a. Eq a => a -> a -> Bool
== Maybe SAM_V1_6_File_Level_Metadata_SubSorting_Order
sam_v1_6_file_level_metadata_subsorting_order2

instance Show SAM_V1_6_File_Level_Metadata where
  show :: SAM_V1_6_File_Level_Metadata -> String
show (SAM_V1_6_File_Level_Metadata SAM_V1_6_File_Level_Metadata_Format_Version
version Maybe SAM_V1_6_File_Level_Metadata_Sorting_Order
sorting_order Maybe SAM_V1_6_File_Level_Metadata_Alignment_Grouping
alignment_grouping Maybe SAM_V1_6_File_Level_Metadata_SubSorting_Order
subsorting_order) =
    String
"SAM_V1_6_File_Level_Metadata { "                       String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
"sam_v1_6_file_level_metadata_format_version = "        String -> ShowS
forall a. [a] -> [a] -> [a]
++
    (SAM_V1_6_File_Level_Metadata_Format_Version -> String
forall a. Show a => a -> String
show SAM_V1_6_File_Level_Metadata_Format_Version
version)                                          String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
" , sam_v1_6_file_level_metadata_sorting_order = "      String -> ShowS
forall a. [a] -> [a] -> [a]
++
    (Maybe SAM_V1_6_File_Level_Metadata_Sorting_Order -> String
forall a. Show a => a -> String
show Maybe SAM_V1_6_File_Level_Metadata_Sorting_Order
sorting_order)                                    String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
" , sam_v1_6_file_level_metadata_alignment_grouping = " String -> ShowS
forall a. [a] -> [a] -> [a]
++
    (Maybe SAM_V1_6_File_Level_Metadata_Alignment_Grouping -> String
forall a. Show a => a -> String
show Maybe SAM_V1_6_File_Level_Metadata_Alignment_Grouping
alignment_grouping)                               String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
" , sam_v1_6_file_level_metadata_subsorting_order = "   String -> ShowS
forall a. [a] -> [a] -> [a]
++
    (Maybe SAM_V1_6_File_Level_Metadata_SubSorting_Order -> String
forall a. Show a => a -> String
show Maybe SAM_V1_6_File_Level_Metadata_SubSorting_Order
subsorting_order)                                 String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
" }" 

-- | VN tag for @"SAM_V1_6_File_Level_Metadata"@.
newtype SAM_V1_6_File_Level_Metadata_Format_Version = SAM_V1_6_File_Level_Metadata_Format_Version { SAM_V1_6_File_Level_Metadata_Format_Version -> ByteString
sam_v1_6_file_level_metadata_format_version_value :: ByteString
                                                                                                  }
  deriving ((forall x.
 SAM_V1_6_File_Level_Metadata_Format_Version
 -> Rep SAM_V1_6_File_Level_Metadata_Format_Version x)
-> (forall x.
    Rep SAM_V1_6_File_Level_Metadata_Format_Version x
    -> SAM_V1_6_File_Level_Metadata_Format_Version)
-> Generic SAM_V1_6_File_Level_Metadata_Format_Version
forall x.
Rep SAM_V1_6_File_Level_Metadata_Format_Version x
-> SAM_V1_6_File_Level_Metadata_Format_Version
forall x.
SAM_V1_6_File_Level_Metadata_Format_Version
-> Rep SAM_V1_6_File_Level_Metadata_Format_Version x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x.
SAM_V1_6_File_Level_Metadata_Format_Version
-> Rep SAM_V1_6_File_Level_Metadata_Format_Version x
from :: forall x.
SAM_V1_6_File_Level_Metadata_Format_Version
-> Rep SAM_V1_6_File_Level_Metadata_Format_Version x
$cto :: forall x.
Rep SAM_V1_6_File_Level_Metadata_Format_Version x
-> SAM_V1_6_File_Level_Metadata_Format_Version
to :: forall x.
Rep SAM_V1_6_File_Level_Metadata_Format_Version x
-> SAM_V1_6_File_Level_Metadata_Format_Version
Generic,Typeable)

instance Eq SAM_V1_6_File_Level_Metadata_Format_Version where
  SAM_V1_6_File_Level_Metadata_Format_Version ByteString
sam_v1_6_file_level_metadata_format_version_value1 == :: SAM_V1_6_File_Level_Metadata_Format_Version
-> SAM_V1_6_File_Level_Metadata_Format_Version -> Bool
== SAM_V1_6_File_Level_Metadata_Format_Version ByteString
sam_v1_6_file_level_metadata_format_version_value2 = ByteString
sam_v1_6_file_level_metadata_format_version_value1 ByteString -> ByteString -> Bool
forall a. Eq a => a -> a -> Bool
== ByteString
sam_v1_6_file_level_metadata_format_version_value2

instance Show SAM_V1_6_File_Level_Metadata_Format_Version where
  show :: SAM_V1_6_File_Level_Metadata_Format_Version -> String
show (SAM_V1_6_File_Level_Metadata_Format_Version ByteString
value) =
    String
"SAM_V1_6_File_Level_Metadata_Format_Version { "       String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
"sam_v1_6_file_level_metadata_format_version_value = " String -> ShowS
forall a. [a] -> [a] -> [a]
++
    (ByteString -> String
forall a. Show a => a -> String
show ByteString
value)                                           String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
" }"

-- | SO tag for @"SAM_V1_6_File_Level_Metadata"@.
newtype SAM_V1_6_File_Level_Metadata_Sorting_Order = SAM_V1_6_File_Level_Metadata_Sorting_Order { SAM_V1_6_File_Level_Metadata_Sorting_Order -> ByteString
sam_v1_6_file_level_metadata_sorting_order_value :: ByteString
                                                                                                }
  deriving ((forall x.
 SAM_V1_6_File_Level_Metadata_Sorting_Order
 -> Rep SAM_V1_6_File_Level_Metadata_Sorting_Order x)
-> (forall x.
    Rep SAM_V1_6_File_Level_Metadata_Sorting_Order x
    -> SAM_V1_6_File_Level_Metadata_Sorting_Order)
-> Generic SAM_V1_6_File_Level_Metadata_Sorting_Order
forall x.
Rep SAM_V1_6_File_Level_Metadata_Sorting_Order x
-> SAM_V1_6_File_Level_Metadata_Sorting_Order
forall x.
SAM_V1_6_File_Level_Metadata_Sorting_Order
-> Rep SAM_V1_6_File_Level_Metadata_Sorting_Order x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x.
SAM_V1_6_File_Level_Metadata_Sorting_Order
-> Rep SAM_V1_6_File_Level_Metadata_Sorting_Order x
from :: forall x.
SAM_V1_6_File_Level_Metadata_Sorting_Order
-> Rep SAM_V1_6_File_Level_Metadata_Sorting_Order x
$cto :: forall x.
Rep SAM_V1_6_File_Level_Metadata_Sorting_Order x
-> SAM_V1_6_File_Level_Metadata_Sorting_Order
to :: forall x.
Rep SAM_V1_6_File_Level_Metadata_Sorting_Order x
-> SAM_V1_6_File_Level_Metadata_Sorting_Order
Generic,Typeable)

instance Eq SAM_V1_6_File_Level_Metadata_Sorting_Order where
  SAM_V1_6_File_Level_Metadata_Sorting_Order ByteString
sam_v1_6_file_level_metadata_sorting_order_value1 == :: SAM_V1_6_File_Level_Metadata_Sorting_Order
-> SAM_V1_6_File_Level_Metadata_Sorting_Order -> Bool
== SAM_V1_6_File_Level_Metadata_Sorting_Order ByteString
sam_v1_6_file_level_metadata_sorting_order_value2 = ByteString
sam_v1_6_file_level_metadata_sorting_order_value1 ByteString -> ByteString -> Bool
forall a. Eq a => a -> a -> Bool
== ByteString
sam_v1_6_file_level_metadata_sorting_order_value2

instance Show SAM_V1_6_File_Level_Metadata_Sorting_Order where
  show :: SAM_V1_6_File_Level_Metadata_Sorting_Order -> String
show (SAM_V1_6_File_Level_Metadata_Sorting_Order ByteString
value) =
    String
"SAM_V1_6_File_Level_Metadata_Sorting_Order { "       String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
"sam_v1_6_file_level_metadata_sorting_order_value = " String -> ShowS
forall a. [a] -> [a] -> [a]
++
    (ByteString -> String
forall a. Show a => a -> String
show ByteString
value)                                          String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
" }"

-- | GO tag for @"SAM_V1_6_File_Level_Metadata"@.
newtype SAM_V1_6_File_Level_Metadata_Alignment_Grouping = SAM_V1_6_File_Level_Metadata_Alignment_Grouping { SAM_V1_6_File_Level_Metadata_Alignment_Grouping -> ByteString
sam_v1_6_file_level_metadata_alignment_grouping_value :: ByteString
                                                                                                          }
  deriving ((forall x.
 SAM_V1_6_File_Level_Metadata_Alignment_Grouping
 -> Rep SAM_V1_6_File_Level_Metadata_Alignment_Grouping x)
-> (forall x.
    Rep SAM_V1_6_File_Level_Metadata_Alignment_Grouping x
    -> SAM_V1_6_File_Level_Metadata_Alignment_Grouping)
-> Generic SAM_V1_6_File_Level_Metadata_Alignment_Grouping
forall x.
Rep SAM_V1_6_File_Level_Metadata_Alignment_Grouping x
-> SAM_V1_6_File_Level_Metadata_Alignment_Grouping
forall x.
SAM_V1_6_File_Level_Metadata_Alignment_Grouping
-> Rep SAM_V1_6_File_Level_Metadata_Alignment_Grouping x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x.
SAM_V1_6_File_Level_Metadata_Alignment_Grouping
-> Rep SAM_V1_6_File_Level_Metadata_Alignment_Grouping x
from :: forall x.
SAM_V1_6_File_Level_Metadata_Alignment_Grouping
-> Rep SAM_V1_6_File_Level_Metadata_Alignment_Grouping x
$cto :: forall x.
Rep SAM_V1_6_File_Level_Metadata_Alignment_Grouping x
-> SAM_V1_6_File_Level_Metadata_Alignment_Grouping
to :: forall x.
Rep SAM_V1_6_File_Level_Metadata_Alignment_Grouping x
-> SAM_V1_6_File_Level_Metadata_Alignment_Grouping
Generic,Typeable)

instance Eq SAM_V1_6_File_Level_Metadata_Alignment_Grouping where
  SAM_V1_6_File_Level_Metadata_Alignment_Grouping ByteString
sam_v1_6_file_level_metadata_alignment_grouping_value1 == :: SAM_V1_6_File_Level_Metadata_Alignment_Grouping
-> SAM_V1_6_File_Level_Metadata_Alignment_Grouping -> Bool
== SAM_V1_6_File_Level_Metadata_Alignment_Grouping ByteString
sam_v1_6_file_level_metadata_alignment_grouping_value2 = ByteString
sam_v1_6_file_level_metadata_alignment_grouping_value1 ByteString -> ByteString -> Bool
forall a. Eq a => a -> a -> Bool
== ByteString
sam_v1_6_file_level_metadata_alignment_grouping_value2

instance Show SAM_V1_6_File_Level_Metadata_Alignment_Grouping where
  show :: SAM_V1_6_File_Level_Metadata_Alignment_Grouping -> String
show (SAM_V1_6_File_Level_Metadata_Alignment_Grouping ByteString
value) =
    String
"SAM_V1_6_File_Level_Metadata_Alignment_Grouping { "       String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
"sam_v1_6_file_level_metadata_alignment_grouping_value = " String -> ShowS
forall a. [a] -> [a] -> [a]
++
    (ByteString -> String
forall a. Show a => a -> String
show ByteString
value)                                               String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
" }"

-- | SS tag for @"SAM_V1_6_File_Level_Metadata"@.
newtype SAM_V1_6_File_Level_Metadata_SubSorting_Order = SAM_V1_6_File_Level_Metadata_SubSorting_Order { SAM_V1_6_File_Level_Metadata_SubSorting_Order -> ByteString
sam_v1_6_file_level_metadata_subsorting_order_value :: ByteString
                                                                                                      }
  deriving ((forall x.
 SAM_V1_6_File_Level_Metadata_SubSorting_Order
 -> Rep SAM_V1_6_File_Level_Metadata_SubSorting_Order x)
-> (forall x.
    Rep SAM_V1_6_File_Level_Metadata_SubSorting_Order x
    -> SAM_V1_6_File_Level_Metadata_SubSorting_Order)
-> Generic SAM_V1_6_File_Level_Metadata_SubSorting_Order
forall x.
Rep SAM_V1_6_File_Level_Metadata_SubSorting_Order x
-> SAM_V1_6_File_Level_Metadata_SubSorting_Order
forall x.
SAM_V1_6_File_Level_Metadata_SubSorting_Order
-> Rep SAM_V1_6_File_Level_Metadata_SubSorting_Order x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x.
SAM_V1_6_File_Level_Metadata_SubSorting_Order
-> Rep SAM_V1_6_File_Level_Metadata_SubSorting_Order x
from :: forall x.
SAM_V1_6_File_Level_Metadata_SubSorting_Order
-> Rep SAM_V1_6_File_Level_Metadata_SubSorting_Order x
$cto :: forall x.
Rep SAM_V1_6_File_Level_Metadata_SubSorting_Order x
-> SAM_V1_6_File_Level_Metadata_SubSorting_Order
to :: forall x.
Rep SAM_V1_6_File_Level_Metadata_SubSorting_Order x
-> SAM_V1_6_File_Level_Metadata_SubSorting_Order
Generic,Typeable)

instance Eq SAM_V1_6_File_Level_Metadata_SubSorting_Order where
  SAM_V1_6_File_Level_Metadata_SubSorting_Order ByteString
sam_v1_6_file_level_metadata_subsorting_order_value1 == :: SAM_V1_6_File_Level_Metadata_SubSorting_Order
-> SAM_V1_6_File_Level_Metadata_SubSorting_Order -> Bool
== SAM_V1_6_File_Level_Metadata_SubSorting_Order ByteString
sam_v1_6_file_level_metadata_subsorting_order_value2 = ByteString
sam_v1_6_file_level_metadata_subsorting_order_value1 ByteString -> ByteString -> Bool
forall a. Eq a => a -> a -> Bool
== ByteString
sam_v1_6_file_level_metadata_subsorting_order_value2

instance Show SAM_V1_6_File_Level_Metadata_SubSorting_Order where
  show :: SAM_V1_6_File_Level_Metadata_SubSorting_Order -> String
show (SAM_V1_6_File_Level_Metadata_SubSorting_Order ByteString
value) =
    String
"SAM_V1_6_File_Level_Metadata_SubSorting_Order { "       String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
"sam_v1_6_file_level_metadata_subsorting_order_value = " String -> ShowS
forall a. [a] -> [a] -> [a]
++
    (ByteString -> String
forall a. Show a => a -> String
show ByteString
value)                                             String -> ShowS
forall a. [a] -> [a] -> [a]
++
    String
" }"