package oui

  1. Overview
  2. Docs
On This Page
  1. File Operations
A tool that builds standalone installers for your OCaml applications

Install 

dune-project
 Dependency

github.com Readme Changelog GPL-3.0-only License Edit opam file Versions (1)

Authors

  1. R
    Raja Boujbel
  2. M
    Mohamed Hernouf

Maintainers

  1. M
    Mohamed Hernouf <mohamed.hernouf@ocamlpro.com>

Sources

oui-0.1.0.tbz
sha256=b806a63c9acd581a00729a48f1faf86b294cc82936fc705fc628a20ede33f977
sha512=e61c35a6e08671634c1edabd7b0add926ac6e0c6c43c9e0a095e89efab7696b6ae5cc1ea0844283a80640c19adb36478bdfb2414bbcab5077ceb7fd16ae45e66

doc/oui.lib/Oui/Macos_app_bundle/index.html

Module Oui.Macos_app_bundleSource

Sourcetype t = {
  1. app_bundle_dir : OpamFilename.Dir.t;
    (*

    MyApp.app

    *)
  2. contents : OpamFilename.Dir.t;
    (*

    MyApp.app/Contents

    *)
  3. macos : OpamFilename.Dir.t;
    (*

    MyApp.app/Contents/MacOS - executables go here

    *)
  4. frameworks : OpamFilename.Dir.t;
    (*

    MyApp.app/Contents/Frameworks - dylibs go here

    *)
  5. resources : OpamFilename.Dir.t;
    (*

    MyApp.app/Contents/Resources - everything else

    *)
  6. app_name : string;
    (*

    Capitalized app name

    *)
  7. binary_name : string;
    (*

    Main binary name

    *)
  8. bundle_id : string;
    (*

    Bundle identifier

    *)
}

Type representing a macOS .app bundle structure with all its directories

Sourceval create : installer_config:Installer_config.internal -> work_dir:OpamFilename.Dir.t -> t

create ~installer_config ~work_dir creates the .app bundle directory structure and returns a bundle t.

Creates the following directory structure:

  • work_dir/AppName.app/Contents/MacOS/
  • work_dir/AppName.app/Contents/Frameworks/
  • work_dir/AppName.app/Contents/Resources/
Sourceval add_subdir : t -> relative_path:string -> OpamFilename.Dir.t

add_subdir bundle ~relative_path creates a subdirectory under Resources. Example: add_subdir bundle ~relative_path:"lib/myapp" creates Resources/lib/myapp/

File Operations

Sourceval copy_bundle_contents : t -> bundle_dir:OpamFilename.Dir.t -> unit

copy_bundle_contents bundle ~bundle_dir copies all contents from bundle_dir to the Resources directory.

Sourceval install_binary : t -> binary_path:OpamFilename.t -> OpamFilename.t

install_binary bundle ~binary_path copies the binary to the MacOS directory and makes it executable (chmod 755). The binary is copied as bundle.binary_name.

Sourceval copy_dylib : t -> dylib:OpamFilename.t -> OpamFilename.t

copy_dylib bundle ~dylib copies a dylib to the Frameworks directory

Sourceval copy_to_resources : t -> src:OpamFilename.t -> relative_path:string -> OpamFilename.t

copy_to_resources bundle ~src ~relative_path copies a file to Resources/relative_path/basename(src). Creates the relative_path subdirectory if it doesn't exist