--   of bytecode files. It is the backbone of the @--show-byte-code@ option.

 module GHC.ByteCode.Show (showByteCode) where

 -- Prelude

 import GHC.Prelude

 import GHC.Data.FlatBag (FlatBag, elemsFlatBag)

 import GHC.Fingerprint (Fingerprint)

 import GHC.Types.SrcLoc (noSrcSpan)

 import GHC.Types.Tickish (BreakTickIndex, BreakpointId (..))

 import GHC.Types.SptEntry (SptEntry (..))

 import GHC.Types.Error (MessageClass (MCDump))

 import GHC.Utils.Panic.Plain (assert)

 import GHC.Utils.Logger (Logger, logMsg)

 import GHC.Utils.Binary (BinSrcSpan (..))

 import GHC.Utils.Outputable

        (

          defaultDumpStyle,

          SDoc,

          text,

          (<>),

          (<+>),

          hsep,

          vcat,

          hang,

        )

 import GHC.Unit.Types (Module, moduleName)

 import GHC.Iface.Type (IfaceType, IfaceTvBndr, IfaceIdBndr)

 -- Basic things

 import Control.Arrow ((>>>))

 import Data.List (zipWith4)

 import Data.ByteString (ByteString)

 import Data.ByteString.Short (ShortByteString)

     literals are output without quotes, because they stick out by themselves.

   * Infix operators are output with parentheses around them. To ensure that this

 -}

          MCDump

          noSrcSpan

          (withPprStyle defaultDumpStyle $ pprOnDiskModuleByteCode byteCode)

 -- | Constructs textual information about the contents of a bytecode file.

 pprOnDiskModuleByteCode :: OnDiskModuleByteCode -> SDoc

 pprCompiledByteCode :: Module           -- ^ The enclosing module

                     -> CompiledByteCode -- ^ The bytecode

                     -> SDoc             -- ^ The textual information

   = vcat [

          ]

 -- | Constructs textual information about bytecode objects.

 pprByteCodeObjects :: Module              -- ^ The enlosing module

                    -> FlatBag UnlinkedBCO -- ^ The bytecode objects

                    -> SDoc                -- ^ The textual information

 -- | Constructs textual information about a single bytecode object.

 pprByteCodeObject :: Module      -- ^ The enclosing module

                   -> UnlinkedBCO -- ^ The bytecode object

                   -> SDoc        -- ^ The textual information

   UnlinkedBCO {..}

        vcat [

             ]

   UnlinkedStaticCon {..}

     -> entry (

                text "static-construction object" <+>

              )

        $

        vcat [

             ]

 -- | Constructs textual information about the arity of a bytecode object.

 -- | Constructs textual information about the data constructor of a

 --   static-construction bytecode object.

 pprDataConstructor :: Name -> SDoc

 -- | Constructs textual information about the liftedness of a

 --   static-construction bytecode object.

 pprLiterals :: Module          -- ^ The enclosing module

             -> FlatBag BCONPtr -- ^ The literals

             -> SDoc            -- ^ The textual information

 -- | Constructs textual information about a single literal.

 pprLiteral :: Module  -- ^ The enclosing module

            -> BCONPtr -- ^ The literal

            -> SDoc    -- ^ The textual information

   BCONPtrWord word

     -> text "word" <+>

        ppr word

        quotes (ppr label)

   BCONPtrItbl infoTableName

     -> text "info table of" <+>

   BCONPtrAddr addrName

     -> text "address" <+>

   BCONPtrStr encoded_string

     -> text "top-level string" <+>

        text (show (utf8DecodeByteString encoded_string))

        quotes (pprFFIInfo ffiInfo)

   BCONPtrCostCentre breakpointID

     -> text "cost center of breakpoint" <+>

 -- | Constructs textual information about FFI info.

 pprFFIInfo :: FFIInfo -> SDoc

   :: Module               -- ^ The enclosing module

   -> InternalBreakpointId -- ^ The ID of the bytecode breakpoint

   -> SDoc                 -- ^ The textual information

   where

   index_doc :: SDoc

 pprUsedItems :: Module          -- ^ The enclosing module

              -> FlatBag BCOPtr  -- ^ The used items

              -> SDoc            -- ^ The textual information

 -- | Constructs textual information about a single used item.

 pprUsedItem :: Module -- ^ The enclosing module

             -> BCOPtr -- ^ The used item

             -> SDoc   -- ^ The textual information

   BCOPtrName name

   BCOPtrPrimOp primOp

     -> text "primitive operation" <+> quotes (ppr primOp)

   BCOPtrBCO byte_code_object

   BCOPtrBreakArray breakArrayModule

     -> text "break array of module" <+> quotes (ppr breakArrayModule)

 -- | Constructs textual information about a single data constructor info table.

 pprDataConstructorInfoTable :: Name -> ConInfoTable -> SDoc

     vcat [

            pprPointerWordCount    $ conItblPtrs,

            pprNonPointerWordCount $ conItblNPtrs

 -- | Constructs textual information about a single top-level string.

 pprTopLevelString :: Name -> ByteString -> SDoc

 -- | Constructs textual information about breakpoints.

 pprBreakpoints :: Module                  -- ^ The enclosing module

                -> Maybe InternalModBreaks -- ^ The breakpoints

                -> SDoc                    -- ^ The textual information

   = entry (text "breakpoints") .

 -- | Constructs textual information about actual breakpoints.

 pprActualBreakpoints :: Module            -- ^ The enclosing module

                      -> InternalModBreaks -- ^ The actual breakpoints

                      -> SDoc              -- ^ The textual information

   = vcat [

          ]

 -- | Constructs textual information about source breakpoints.

 pprSourceBreakpoints :: Module    -- ^ The enclosing module

                      -> ModBreaks -- ^ The source breakpoints

                      -> SDoc      -- ^ The textual information

   = entry (text "source breakpoints")                         $

     assert (bounds modBreaks_locs_ == bounds modBreaks_decls) $

     assert (bounds modBreaks_locs_ == bounds modBreaks_vars)  $

     vcatOrNone                                                $

     -- the source spans in 'modBreaks_locs_' and are therefore never shown.

 -- | Constructs textual information about a single source breakpoint.

   = entry (text "source breakpoint" <+> ppr ix) $

     vcat [

          ]

 -- | Constructs textual information about a source span.

 pprSrcSpan :: BinSrcSpan -> SDoc

 pprSrcSpan = entry (text "source span") . ppr . unBinSrcSpan

 pprDeclarationPath :: [String] -> SDoc

 pprDeclarationPath = entry (text "declaration path") . vcatOrEmpty . map text

 -- | Constructs textual information about free variables.

 pprFreeVariables :: [OccName] -> SDoc

 -- | Constructs textual information about bytecode breakpoints.

 pprByteCodeBreakpoints :: Module             -- ^ The enclosing module

                        -> IntMap CgBreakInfo -- ^ The bytecode breakpoints

                        -> SDoc               -- ^ The textual information

     IntMap.toList

 -- | Constructs textual information about a single bytecode breakpoint.

                       -> Int         -- ^ The index of the bytecode breakpoint

                       -> CgBreakInfo -- ^ The bytecode breakpoint

                       -> SDoc        -- ^ The textual information

   = entry (text "bytecode breakpoint" <+> ppr ix) $

     vcat [

          ]

   -- That the 'cgb_resty' field holds the type of the breakpoint is apparent

   -- from the fact that this field is set by

                                     -- ^ A reference to the source breakpoint

                                  -> SDoc

                                     -- ^ The textual information

   = entry (text "corresponding source breakpoint") .

     either internalBreakLoc id

 -- | Constructs textual information about the ID of a source breakpoint.

 pprBreakpointID :: Module       -- ^ The enclosing module

                 -> BreakpointId -- ^ The ID of the source breakpoint

                 -> SDoc         -- ^ The textual information

     where

     index_doc :: SDoc

 -- | Constructs textual information about a single static-pointer table entry.

 pprStaticPointerTableEntry :: SptEntry -> SDoc

 pprStaticPointerTableEntry (SptEntry name fingerprint)

 -- | Constructs textual information about HPC info.

 pprHPCInfo :: Module                       -- ^ The enclosing module

            -> Strict.Maybe ByteCodeHpcInfo -- ^ The HPC info

            -> SDoc                         -- ^ The textual information

   = entry (text "HPC information") .

 -- | Constructs textual information about actual HPC info.

 pprActualHPCInfo :: Module          -- ^ The enclosing module

                  -> ByteCodeHpcInfo -- ^ The actual HPC info

                  -> SDoc            -- ^ The textual information

   = assert (

              utf8DecodeShortByteString bchi_module_name

              ==

            )

     $

     vcat [

 pprTickBox :: ShortByteString -> SDoc

 pprTickBox = entry (text "tick box") . text . utf8DecodeShortByteString

 pprTickCount :: Int -> SDoc

 pprTickCount = entry (text "number of ticks") . ppr

 -- | Constructs a hexadecimal representation of a natural number such that the

 --   number of hexadecimal digits fits the number of bits used to represent the

 -- | Constructs a textual representation of a boolean, interpreting 'True' and

 --   'False' as “yes” and “no”, respectively.

 noOrYes :: Bool -> SDoc

 -- | Constructs an entry in a list of textual data representations.

 entry :: SDoc -- ^ The title of the entry

       -> SDoc -- ^ The contents of the entry

       -> SDoc -- ^ The entry

 -- | Composes documents vertically in general, but presents an empty document

 vcatOrNone :: [SDoc] -> SDoc

 vcatOrNone []   = text "<none>"

 vcatOrNone docs = vcat docs

 -- | Composes documents vertically in general, but presents an empty document

 vcatOrEmpty :: [SDoc] -> SDoc

 vcatOrEmpty []   = text "<empty>"

 vcatOrEmpty docs = vcat docs

 module Example where

 import Numeric.Natural (Natural)

 import Foreign.Ptr (Ptr)

 fibonaccis :: [Natural]

 fibonaccis = 0 : positiveFibonaccis where

 {

   sed -E -e '

     s/_r[[:alnum:]]+/_@name_suffix@/g

   '

 }