google/tmppy

Project: tmppy (GitHub Link)

tmppy-master
- include
  - tmppy
    - tmppy.h
- .coveragerc
- _py2tmp
  - ir0_optimization
    - _replace_var_with_expr.py
    - _split_template_defn_with_multiple_outputs.py
    - remove_no_op_stmts.py
    - _template_instantiation_inlining.py
    - _recalculate_template_instantiation_can_trigger_static_asserts_info.py
    - _normalize_expressions.py
    - _optimization_execution.py
    - _unify.py
    - replace_templates_with_templated_using_declarations.py
    - _optimize.py
    - __init__.py
    - tests
      - test_unify_ir0.py
      - __init__.py
    - _remove_unused_toplevel_elems.py
    - _common_subexpression_elimination.py
    - _constant_folding.py
    - _expression_simplification.py
    - _compute_non_expanded_variadic_vars.py
    - _configuration_knobs.py
    - _local_optimizations.py
  - cpp
    - _writers.py
    - __init__.py
  - ir2
    - _return_type.py
    - _free_variables.py
    - _visitor.py
    - ir.py
    - _transformation.py
    - __init__.py
  - utils
    - _clang_format.py
    - _ast_to_string.py
    - _graphs.py
    - __init__.py
    - _ir_to_string.py
  - ir1
    - _visitor.py
    - ir.py
    - __init__.py
    - free_variables.py
  - ir2_optimization
    - _recalculate_function_can_throw_info.py
    - _optimize.py
    - __init__.py
  - compiler
    - _link.py
    - stages
      - _ir2_to_ir1.py
      - _ir0_to_cpp.py
      - __init__.py
      - _ir1_to_ir0.py
      - _ast_to_ir2.py
    - _generate_ir0_builtins.py
    - output_files
      - __init__.py
      - _tmppy_object_file.py
    - _tmppy_builtins.py
    - __init__.py
    - _compile.py
    - tests
      - test_sets.py
      - test_comparisons.py
      - test_misc.py
      - test_attribute_access.py
      - test_exceptions.py
      - test_pass.py
      - test_bools.py
      - test_assertions.py
      - test_type_expr_to_cpp.py
      - test_lists.py
      - test_underscore_variable.py
      - test_type_annotations.py
      - test_ints.py
      - test_ifelse.py
      - test_type_literals.py
      - test_imports.py
      - test_functions.py
      - __init__.py
      - test_optimizations.py
      - test_variables.py
      - test_custom_types.py
      - test_match.py
    - testing
      - _utils.py
      - __init__.py
  - CMakeLists.txt
  - __init__.py
  - coverage
    - _source_branch.py
    - _is_enabled.py
    - __init__.py
    - _plugin.py
    - _hooks.py
  - ir0
    - _template_dependency_graph.py
    - _visitor.py
    - _writers.py
    - ir.py
    - _builtin_literals.py
    - _transformation.py
    - _is_variadic.py
    - __init__.py
  - unification
    - _exceptions.py
    - _strategy.py
    - _canonicalization.py
    - _utils.py
    - _unification.py
    - __init__.py
    - tests
      - test_unification.py
      - __init__.py
- extras
  - examples
    - example.py
    - CMakeLists.txt
    - tests
      - example_test.py
  - CMakeLists.txt
  - scripts
    - release.sh
    - postsubmit.sh
    - travis_ci_install_linux.sh
    - travis_ci_install_osx.sh
    - postsubmit-helper.sh
    - travis_yml_generator.py
- LICENSE
- py2tmp
  - __init__.py
  - main.py
  - testing
    - pytest_plugin.py
    - __init__.py
- CONTRIBUTING.md
- tmppy
  - __init__.py
- _tmppy
  - lists.py
  - type.py
  - __init__.py
- setup.py
- .cache
  - v
    - cache
      - lastfailed
- CMakeLists.txt
- setup.cfg
- .travis.yml
- README.md
- .gitignore
- MANIFEST.in

TMPPy is a subset of Python that can be compiled to C++ meta-functions using the py2tmp compiler. This project is aimed at C++ library developers whose libraries include a non-trivial amount of C++ metaprogramming.

Compared to writing C++ metaprogramming code directly, using TMPPy allows that code to be expressed in a more concise and readable way, provides static type checking (avoiding some classes of instantiation-time errors) and produces optimized C++ meta-functions, reducing the compile time for the C++ compilation.

Example

As an example, let's write a metafunction (aka type trait class) add_pointer_multiple such that:

add_pointer_multiple<T, 0>::type is T
add_pointer_multiple<T, 1>::type is T*
add_pointer_multiple<T, 2>::type is T**
(and so on)

This can be written as a template, as follows:

template <typename T, int64_t n>
struct add_pointer_multiple {
    using type = typename add_pointer_multiple<T, n - 1>::type*;
};

template <typename T>
struct add_pointer_multiple<T, 0> {
    using type = T;
};

However this syntax is quite verbose and not very readable. For more complex metafunctions this becomes a significant issue, leading to more bugs and more effort when debugging or maintaining the code.

Some C++ metaprogramming libraries (notably Boost's MPL library) can be used to reduce the verbosity, however that comes at the price of slower compile times.

Using TMPPy, the above can be written as:

def add_pointer_multiple(t: Type, n: int) -> Type:
    if n == 0:
        return t
    else:
        return add_pointer_multiple(Type.pointer(t), n-1)

And this TMPPy code can then be compiled to C++ code equivalent to the metafunction above (without the overhead of e.g. MPL).

For more information on TMPPy, see the wiki.

License

TMPPy is released under the Apache 2.0 license. See the LICENSE file for details.

This is not an official Google product.