Foreign.Hoppy.Generator.Version

Utilities for conditional compilation of parts of interfaces.

This module provides wrappers around Maybe and catMaybes so that you can write code such as:

myClass =
  makeClass ...
  [ ...ctors... ] $
  collect
  [ just $ mkMethod "foo" ...
  , test (apiVersion >= [1, 2]) $ mkMethod "bar" ...
  , test featureBaz $ mkMethod "baz" ...
  ]

General filtering

type Filtered = Maybe

Placeholder Maybe-like type that may be more general in the future.

collect :: [Filtered a] -> [a]

Filters a list of Filtered values down to the elements that are actually present.

none :: Filtered a

A Filtered value that is always absent.

just :: a -> Filtered a

Returns a Filtered value that is always present.

test :: Bool -> a -> Filtered a

Returns a Filtered value that is only present if the boolean is true.

C++ Standard version

data CppVersion

Versions of the C++ standard.

Constructors

Cpp1998

Cpp2011

Cpp2014

Cpp2020

Instances

Bounded CppVersion

Defined in Foreign.Hoppy.Generator.Version

Methods

minBound :: CppVersion

maxBound :: CppVersion

Enum CppVersion

Defined in Foreign.Hoppy.Generator.Version

Methods

succ :: CppVersion -> CppVersion

pred :: CppVersion -> CppVersion

toEnum :: Int -> CppVersion

fromEnum :: CppVersion -> Int

enumFrom :: CppVersion -> [CppVersion]

enumFromThen :: CppVersion -> CppVersion -> [CppVersion]

enumFromTo :: CppVersion -> CppVersion -> [CppVersion]

enumFromThenTo :: CppVersion -> CppVersion -> CppVersion -> [CppVersion]

Show CppVersion

Defined in Foreign.Hoppy.Generator.Version

Methods

showsPrec :: Int -> CppVersion -> ShowS

show :: CppVersion -> String

showList :: [CppVersion] -> ShowS

Eq CppVersion

Defined in Foreign.Hoppy.Generator.Version

Methods

(==) :: CppVersion -> CppVersion -> Bool

(/=) :: CppVersion -> CppVersion -> Bool

Ord CppVersion

Defined in Foreign.Hoppy.Generator.Version

Methods

compare :: CppVersion -> CppVersion -> Ordering

(<) :: CppVersion -> CppVersion -> Bool

(<=) :: CppVersion -> CppVersion -> Bool

(>) :: CppVersion -> CppVersion -> Bool

(>=) :: CppVersion -> CppVersion -> Bool

max :: CppVersion -> CppVersion -> CppVersion

min :: CppVersion -> CppVersion -> CppVersion

defaultCppVersion :: CppVersion

The CppVersion chosen when one is not explicitly requested. This is Cpp2011.

activeCppVersion :: CppVersion

The active version of the C++ standard. This looks to the HOPPY_CPP_STD environment variable, and accepts the values c++98, c++11, c++14, and c++20, which map to the corresponding CppVersion values. If a value other than these is set, then a warning is printed and the default is used. If no value is set, the default is used.

This uses unsafePerformIO internally and won't cope with a changing environment.