cygport/lib/check_funcs.cygpart

Cygport Reference Manual

### TABLE OF CONTENTS

- Checks

- check_header
- check_lib
- check_prog
- check_prog_req
- check_tool
- check_target_tool
- check_pkg_config
- check_girepository_module
- check_lua_module
- check_ocaml_module
- check_perl_module
- check_php_module
- check_python_module
- check_python3_module
- check_pypy_module
- check_R_module
- check_ruby_module
- check_tcl_module
- check_tex_module
- check_vala_module

- DEPEND

## Checks

[ Top ] [ Chapter 7 ] [ Concepts ]

## check_prog

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_prog PROGRAM [PROGRAM2] ...

DESCRIPTION

Checks for the presence of the given program(s) in PATH. Returns TRUE if all programs are present, else FALSE.

## check_prog_req

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_prog_req PROGRAM [PACKAGE]

DESCRIPTION

Check that the given required program is present in PATH. If not, call error() indicating which package contains the program that needs to be installed. If only the program name is given, the package is assumed to be eponymous.

## check_tool

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_tool TOOL [TOOL] ...

DESCRIPTION

Checks for the presence of the given host compiler tool(s) in PATH. Returns TRUE if all tools are present, else FALSE.

## check_target_tool

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_target_tool TOOL [TOOL] ...

DESCRIPTION

Checks for the presence of the given target compiler tool(s) in PATH. Returns TRUE if all tools are present, else FALSE.

## check_pkg_config

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_pkg_config NAME "PKG_CONFIG_SPEC"

DESCRIPTION

Checks for the presence of the given development packages with pkg-config. If given pkg-config spec is found, return TRUE and defines NAME_CFLAGS and NAME_LIBS. If not found, returns FALSE.

REQUIRES

pkg-config

## check_girepository_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_girepository_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given GObject Introspection module(s). If all given module(s) are present, returns TRUE, else FALSE.

NOTE

check_girepository_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.

REQUIRES

gobject-introspection

## check_lua_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_lua_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given Lua module(s). If all given module(s) are present, returns TRUE, else FALSE.

NOTE

check_lua_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.

REQUIRES

lua

## check_ocaml_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_ocaml_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given Objective Caml module(s). If all given module(s) are present, returns TRUE, else FALSE.

NOTE

check_ocaml_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.

REQUIRES

ocaml, ocaml-findlib

## check_perl_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_perl_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given Perl module(s). If all given module(s) are present, returns TRUE, else FALSE.

NOTE

check_perl_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.

REQUIRES

perl

## check_php_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_php_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given PHP extension(s), either binary (PECL) or PHP (PEAR) extensions. If all given module(s) are present, returns TRUE, else FALSE.

NOTE

check_php_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.

REQUIRES

php

## check_python_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_python_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given Python2 module(s). If all given module(s) are present, returns TRUE, else FALSE.

NOTES

- check_python_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.
- For Python 3 modules, use check_python3_module.
- For PyPy modules, use check_pypy_module.

REQUIRES

python

## check_python3_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_python3_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given Python3 module(s). If all given module(s) are present, returns TRUE, else FALSE.

NOTES

- check_python3_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.
- For Python 2 modules, use check_python_module.
- For PyPy modules, use check_pypy_module.

REQUIRES

python3

## check_pypy_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_pypy_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given PyPy module(s). If all given module(s) are present, returns TRUE, else FALSE.

NOTES

- check_pypy_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.
- For CPython modules, use check_python_module or check_python3_module.

REQUIRES

pypy

## check_R_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_R_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given R module(s). If all given module(s) are present, returns TRUE, else FALSE.

NOTE

check_R_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.

REQUIRES

R

## check_ruby_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_ruby_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given Ruby module(s). If all given module(s) are present, returns TRUE, else FALSE.

NOTE

check_ruby_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.

REQUIRES

ruby

## check_tcl_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_tcl_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given Tcl module(s). If all given module(s) are present, returns TRUE, else FALSE.

NOTE

check_tcl_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.

REQUIRES

tcl

## check_tex_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_tex_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given TeX module(s). If all given module(s) are present, returns TRUE, else FALSE.

NOTE

check_tex_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.

REQUIRES

texlive

## check_vala_module

[ Top ] [ Checks ] [ General Functions ]

SYNOPSIS

      check_vala_module MODULE [MODULE2] ...

DESCRIPTION

Checks the presence of the given Vala module(s). If all given module(s) are present, returns TRUE, else FALSE.

NOTE

check_vala_module does not distinguish how the given module(s) were installed, whether they are from a Cygwin package or manually.

REQUIRES

vala

## DEPEND

[ Top ] [ Information ] [ General Functions ]

SYNOPSIS

      DEPEND="ATOM [ATOM] ..."

DESCRIPTION

A list of build-time (not runtime) dependencies to be checked before calling src_compile. Each ATOM can be in one of the following forms:

- girepository(Foo-1.0): GObject Introspection modules
- lua(foo): Lua extensions
- ocaml(foo): Objective Caml libraries
- perl(Foo::Bar): Perl modules
- php(foo): PHP binary (PECL) extensions
- php(Foo/Bar.php): PHP (PEAR) extensions
- pkgconfig(foo-1.0): A -devel package providing this pkg-config file
- pypy(foo): PyPy modules
- python(foo): Python 2 modules
- python3(foo): Python 3 modules
- R(foo): R packages
- ruby(foo): Ruby modules
- tcl(foo): Tcl/Tk packages
- tex(foo.ext): TeX modules
- vala(foo-1.0): Vala bindings
- foo: A Cygwin package (check skipped on non-Cygwin build systems)