.. currentmodule:: pyke

.. _convenient_path_functions:

Convenient path functions
=======================================
There are some functions that you are encouraged to use when referencing paths, like
:func:`pyke.masterpath` and :func:`pyke.workpath`, which return absolute paths relative to
the master pyke file or the current pyke script.

On the other hand, :func:`absolutize` is used internally by almost all builtin functions in
order to make sure that all paths are absolutized when calling :func:`build` function. Knowing about this
function might be useful if you plan to create your own rules, otherwise, using :func:`pyke.masterpath` and :func:`pyke.workpath` will be enough.

.. autofunction:: pyke.masterpath ([path = None])
  :noindex:
.. autofunction:: pyke.workpath ([path = None])
  :noindex:
.. autofunction:: pyke.build.absolutize
  :noindex:
.. autofunction:: pyke.build.isMasterFile
  :noindex:
.. autofunction:: pyke.build.rel2masterpath
  :noindex:
.. autofunction:: pyke.build.pykepath
  :noindex:


Basic file rules
=======================================
This section describes pyke's builtin file system common operations. Think of them as a multi-platform
replacement for common operating system operations.

.. currentmodule:: pyke.rules
.. autofunction:: mkdir
.. autofunction:: rmdir
.. autofunction:: cp
.. autofunction:: cptree
.. autofunction:: clean
.. autofunction:: rm
.. autofunction:: rmtree

.. autofunction:: chmod

.. autofunction:: touch
.. autofunction:: putfile
.. autofunction:: fileappend
.. autofunction:: filereplace
.. autofunction:: concatfiles 

.. autofunction:: download

Compression rules
=======================================
Thanks to python, Pyke has builtin support to compress and uncompress zip, tar, tar.gz and tar.bz2
files. This section describes the compression and uncompression functions.

.. autofunction:: makezip
.. autofunction:: maketar
.. autofunction:: compress
.. autofunction:: unzip
.. autofunction:: untar
.. autofunction:: uncompress

Functions to get depencencies
=======================================
There are currently a couple of functions that can be used by some rules to build C/C++ and Java projects.

Please note that these are python functions not rules.

.. currentmodule:: pyke.useful

.. autofunction:: findCppDependencies
  :noindex:

.. autofunction:: getJavaClassFiles
  :noindex: