package ppx_system

  1. Overview
  2. Docs
A ppx to know host operating system at compile time

Install

Dune Dependency

Authors

Maintainers

Sources

1.0.tar.gz
md5=008cac3324cdb0dde18a8e34ab61dd9d
sha512=ecca2ff8505051cf53b45acb1dca5d65cd1dc9e685436a4533f4eb62aeedfc704e5c91fbe9b50cc22e625e0a0f4f7fe5581284b5ac1186f106245ed4f1973f80

Description

Published: 14 Oct 2022

README

ppx_system

ppx_system is a syntax extension to known host operating system at compile time.

Installation

$ git clone https://github.com/Psi-Prod/ppx_system
$ opam install .

Usage

Add the following stanza to your dune file:

(library
  ...
  (preprocess
    (pps ppx_system))

Syntax

[%get_system]

Use [%get_system] to get the host system as a constructor:

# #require "ppx_system";;
# match [%get_system] with
  | Darwin -> "Darwin"
  | FreeBSD -> "FreeBSD"
  | NetBSD -> "NetBSD"
  | OpenBSD -> "OpenBSD"
  | Unix -> "Unix"
  | Win32 -> "Win32"
  | Unknown sysname -> Printf.sprintf "Unknown system: %S" sysname
- : string = "Unix"

[%system]

Five system are supported: Darwin, UNIX, Win32, FreeBSD, NetBSD, OpenBSD.

Assuming you are on UNIX:

# #require "ppx_system";;
# Printf.sprintf "You are on %s!"
    [%system
      {
        darwin = "Darwin";
        free_bsd = "FreeBSD";
        net_bsd = "NetBSD";
        open_bsd = "OpenBSD";
        unix = "UNIX";
        win32 = "Win32"
      }]
- : string = "You are on UNIX!"
# [%system { darwin = "open"; unix = "xdg-open" }];;
- : string = "xdg-open"

Use the default field to set a default value if your system is not precised:

# [%system { free_bsd = "On FreeBSD"; default = "Not on FreeBSD" }];;
- : string = "Not on FreeBSD"

An empty string is generated in case none of the provided field match the host system:

# [%system { darwin = "Darwin" }];;
- : string = ""

Contributing

Pull requests, bug reports, and feature requests are welcome.

License

  • GPL 3.0 or later. See license for more information.

Dependencies (3)

  1. ppxlib >= "0.18.0"
  2. dune >= "3.3"
  3. ocaml

Dev Dependencies (1)

  1. odoc with-doc

Used by

None

Conflicts

None