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 'h3-hs' generated by
-- 'cabal init'. For further documentation, see:
--   http://haskell.org/cabal/users-guide/
--
-- The name of the package.
name:               h3-hs

-- 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:            0.2.0.0

-- A short (one-line) description of the package.
synopsis:           A Haskell binding for H3

-- A longer description of the package.
description:        This package provides bindings to the 
                    [H3 C API v4](https://h3geo.org/docs/api/indexing).  
                    H3 is a geospatial indexing system that partitions the world 
                    into hexagonal cells. 
                    
                    For users with experience with bindings for other languages, 
                    we recommend reviewing the project README, as we have 
                    included notes for using the methods provided in this package. 
                    In particular, as we bind to the C methods with few adjustments 
                    to inputs and outputs beyond data marshalling, 
                    there will be some differences for those familiar with the 
                    python (and likely other) bindings, e.g. the methods 
                    provided in this package expect the latitude and longitude 
                    to be in radians rather than degrees. 

-- URL for the project homepage or repository.
homepage:           https://github.com/jvstinian/h3-hs

bug-reports:        https://github.com/jvstinian/h3-hs/issues

-- The license under which the package is released.
license:            BSD-3-Clause

-- The file containing the license text.
license-file:       LICENSE

-- The package author(s).
author:             Justin Smith

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

-- A copyright notice.
copyright:          (c) 2024 Justin Smith
category:           Geography
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

source-repository head
  type: git
  location: git://github.com/jvstinian/h3-hs.git

common warnings
    ghc-options: -Wall -g

library
    -- Import common warning flags.
    import:           warnings

    -- Modules exported by the library.
    exposed-modules:  
        H3.Data
        H3.Miscellaneous
        H3.Indexing
        H3.Inspection
        H3.Regions
        H3.Traversal
        H3.Hierarchy
        H3.DirectedEdges
        H3.Vertexes

    -- Modules included in this library but not exported.
    other-modules:
        H3.Internal.H3Api
        H3.Internal.FFI
        H3.Internal.Utils

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

    -- Other library packages from which modules are imported.
    build-depends:
        base ^>=4.17.2.1

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

    extra-libraries: h3

    -- build-tool-depends: c2hs:c2hs

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


test-suite h3-hs-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:
      MiscellaneousTest
      IndexingTest
      InspectionTest
      RegionsTest
      TraversalTest
      HierarchyTest
      DirectedEdgesTest
      VertexesTest
      TestTypes

    -- 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,
        h3-hs,
        QuickCheck ^>= 2.14.3,
        test-framework ^>= 0.8.2,
        test-framework-quickcheck2 ^>= 0.3.0.5