xilinx-lava.cabal

cabal-version:      3.0
-- The cabal-version field refers to the version of the .cabal specification,
-- and can be different from the cabal-install (the tool) version and the
-- Cabal (the library) version you are using. As such, the Cabal (the library)
-- version used must be equal or greater than the version stated in this field.
-- Starting from the specification version 2.2, the cabal-version field must be
-- the first thing in the cabal file.

-- Initial package description 'xilinx-lava' generated by
-- 'cabal init'. For further documentation, see:
--   http://haskell.org/cabal/users-guide/
--
-- The name of the package.
name:               xilinx-lava

-- The package version.
-- See the Haskell package versioning policy (PVP) for standards
-- guiding when and how versions should be incremented.
-- https://pvp.haskell.org
-- PVP summary:     +-+------- breaking API changes
--                  | | +----- non-breaking API additions
--                  | | | +--- code changes with no API change
version:            6.0.0.0

copyright:          Satnam Singh, 2024.
-- A short (one-line) description of the package.
synopsis:
    A library for the combinator-based design of systems, especially hardware.

description: This combinator-based library supports APL-like combinator-style
             description of circuits and other computations.

-- URL for the project homepage or repository.
homepage:           https://github.com/satnam6502/xilinx-lava

license:            BSD-2-Clause
license-file:       LICENSE
author:             Satnam Singh

-- An email address to which users can send suggestions, bug reports, and patches.
maintainer:         satnam6502@gmail.com

-- A copyright notice.
-- copyright:
category:           Hardware
build-type:         Simple

-- Extra doc files to be distributed with the package, such as a CHANGELOG or a README.
extra-doc-files:    CHANGELOG.md

-- Extra source files to be distributed with the package, such as examples, or a tutorial module.
-- extra-source-files:

tested-with: GHC==9.4.8, GHC==9.8.2

data-files: verilator.vlt

common warnings
    ghc-options: -Wall

library
    -- Import common warning flags.
    import:           warnings

    -- Modules exported by the library.
    exposed-modules:  Lava
                      Lava.Examples.NandGate

    -- Modules included in this library but not exported.
    other-modules:    Lava.Combinators,
                      Lava.Graph,
                      Lava.Hardware,
                      Lava.RTL,
                      Lava.Simulation,
                      Lava.SimVal,
                      Lava.SystemVerilog

    -- LANGUAGE extensions used by modules in this package.
    -- other-extensions:

    -- Other library packages from which modules are imported.
    build-depends:    base >= 4.17.2 && <= 4.20.0.0,
                      bv ^>= 0.5,
                      mtl >= 2.2.2 && <= 2.3.1,

    -- Directories containing source files.
    hs-source-dirs:   src

    -- Base language which the package is written in.
    default-language: Haskell2010

-- Test basic features of Lava that don't require any external tools
-- like SystemVerilog simulators.
test-suite xilinx-lava-test
    -- Import common warning flags.
    import:           warnings

    -- Base language which the package is written in.
    default-language: Haskell2010

    -- Modules included in this executable, other than Main.
    -- other-modules:

    -- LANGUAGE extensions used by modules in this package.
    -- other-extensions:

    -- The interface type and version of the test suite.
    type:             exitcode-stdio-1.0

    -- Directories containing source files.
    hs-source-dirs:   test

    -- The entrypoint to the test suite.
    main-is:          Main.hs

    -- Test dependencies.
    build-depends:
        base >= 4.17.2 && <= 4.20.0.0,
        xilinx-lava

-- Lava tests that use the Verilator SystemVerilog simulator.
test-suite test-verilator
    -- Import common warning flags.
    import:           warnings

    -- Base language which the package is written in.
    default-language: Haskell2010

    -- Modules included in this executable, other than Main.
    -- other-modules:

    -- LANGUAGE extensions used by modules in this package.
    -- other-extensions:

    -- The interface type and version of the test suite.
    type:             exitcode-stdio-1.0

    -- Directories containing source files.
    hs-source-dirs:   test-verilator

    -- The entrypoint to the test suite.
    main-is:          Main.hs

    -- Test dependencies.
    build-depends:
        base >= 4.17.2 && <= 4.20.0.0,
        bitvec >= 1.1.2.0,
        xilinx-lava,
        process