Blame external/pybind11/tests/test_enum.cpp

Packit 534379
/*
Packit 534379
    tests/test_enums.cpp -- enumerations
Packit 534379
Packit 534379
    Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>
Packit 534379
Packit 534379
    All rights reserved. Use of this source code is governed by a
Packit 534379
    BSD-style license that can be found in the LICENSE file.
Packit 534379
*/
Packit 534379
Packit 534379
#include "pybind11_tests.h"
Packit 534379
Packit 534379
TEST_SUBMODULE(enums, m) {
Packit 534379
    // test_unscoped_enum
Packit 534379
    enum UnscopedEnum {
Packit 534379
        EOne = 1,
Packit 534379
        ETwo,
Packit 534379
        EThree
Packit 534379
    };
Packit 534379
    py::enum_<UnscopedEnum>(m, "UnscopedEnum", py::arithmetic(), "An unscoped enumeration")
Packit 534379
        .value("EOne", EOne, "Docstring for EOne")
Packit 534379
        .value("ETwo", ETwo, "Docstring for ETwo")
Packit 534379
        .value("EThree", EThree, "Docstring for EThree")
Packit 534379
        .export_values();
Packit 534379
Packit 534379
    // test_scoped_enum
Packit 534379
    enum class ScopedEnum {
Packit 534379
        Two = 2,
Packit 534379
        Three
Packit 534379
    };
Packit 534379
    py::enum_<ScopedEnum>(m, "ScopedEnum", py::arithmetic())
Packit 534379
        .value("Two", ScopedEnum::Two)
Packit 534379
        .value("Three", ScopedEnum::Three);
Packit 534379
Packit 534379
    m.def("test_scoped_enum", [](ScopedEnum z) {
Packit 534379
        return "ScopedEnum::" + std::string(z == ScopedEnum::Two ? "Two" : "Three");
Packit 534379
    });
Packit 534379
Packit 534379
    // test_binary_operators
Packit 534379
    enum Flags {
Packit 534379
        Read = 4,
Packit 534379
        Write = 2,
Packit 534379
        Execute = 1
Packit 534379
    };
Packit 534379
    py::enum_<Flags>(m, "Flags", py::arithmetic())
Packit 534379
        .value("Read", Flags::Read)
Packit 534379
        .value("Write", Flags::Write)
Packit 534379
        .value("Execute", Flags::Execute)
Packit 534379
        .export_values();
Packit 534379
Packit 534379
    // test_implicit_conversion
Packit 534379
    class ClassWithUnscopedEnum {
Packit 534379
    public:
Packit 534379
        enum EMode {
Packit 534379
            EFirstMode = 1,
Packit 534379
            ESecondMode
Packit 534379
        };
Packit 534379
Packit 534379
        static EMode test_function(EMode mode) {
Packit 534379
            return mode;
Packit 534379
        }
Packit 534379
    };
Packit 534379
    py::class_<ClassWithUnscopedEnum> exenum_class(m, "ClassWithUnscopedEnum");
Packit 534379
    exenum_class.def_static("test_function", &ClassWithUnscopedEnum::test_function);
Packit 534379
    py::enum_<ClassWithUnscopedEnum::EMode>(exenum_class, "EMode")
Packit 534379
        .value("EFirstMode", ClassWithUnscopedEnum::EFirstMode)
Packit 534379
        .value("ESecondMode", ClassWithUnscopedEnum::ESecondMode)
Packit 534379
        .export_values();
Packit 534379
Packit 534379
    // test_enum_to_int
Packit 534379
    m.def("test_enum_to_int", [](int) { });
Packit 534379
    m.def("test_enum_to_uint", [](uint32_t) { });
Packit 534379
    m.def("test_enum_to_long_long", [](long long) { });
Packit 534379
Packit 534379
    // test_duplicate_enum_name
Packit 534379
    enum SimpleEnum
Packit 534379
    {
Packit 534379
        ONE, TWO, THREE
Packit 534379
    };
Packit 534379
Packit 534379
    m.def("register_bad_enum", [m]() {
Packit 534379
        py::enum_<SimpleEnum>(m, "SimpleEnum")
Packit 534379
            .value("ONE", SimpleEnum::ONE)          //NOTE: all value function calls are called with the same first parameter value
Packit 534379
            .value("ONE", SimpleEnum::TWO)
Packit 534379
            .value("ONE", SimpleEnum::THREE)
Packit 534379
            .export_values();
Packit 534379
    });
Packit 534379
}