File: osm_base_objects.h

package info (click to toggle)
pyosmium 4.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,584 kB
  • sloc: python: 4,400; cpp: 2,504; makefile: 20
file content (109 lines) | stat: -rw-r--r-- 3,302 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/* SPDX-License-Identifier: BSD-2-Clause
 *
 * This file is part of pyosmium. (https://osmcode.org/pyosmium/)
 *
 * Copyright (C) 2024 Sarah Hoffmann <lonvia@denofr.de> and others.
 * For a full list of authors see the git log.
 */
#ifndef PYOSMIUM_OSM_BASE_OBJECTS_HPP
#define PYOSMIUM_OSM_BASE_OBJECTS_HPP
#include <variant>

#include <pybind11/pybind11.h>

#include <osmium/osm.hpp>

namespace pyosmium {

template <typename T>
class COSMDerivedObject
{
public:
    explicit COSMDerivedObject(T *obj) : m_obj(obj) {}

    T const *get() const {
        if (!m_obj) {
            throw std::runtime_error{"Illegal access to removed OSM object"};
        }
        return m_obj;
    }

    bool is_valid() const noexcept { return m_obj; }

    void invalidate() noexcept { m_obj = nullptr; }

private:
    T *m_obj;
};

using COSMNode = COSMDerivedObject<osmium::Node const>;
using COSMWay = COSMDerivedObject<osmium::Way const>;
using COSMRelation = COSMDerivedObject<osmium::Relation const>;
using COSMArea = COSMDerivedObject<osmium::Area const>;
using COSMChangeset = COSMDerivedObject<osmium::Changeset const>;

/**
 * Storage for a persistent Python object around a osmium object reference.
 *
 * This makes it possible to store additional information in the
 * Python object and carry it over between filters.
 */
template <typename T>
class PyOSMObject
{
public:
    explicit PyOSMObject(osmium::OSMEntity *obj)
    : m_obj(static_cast<T *>(obj)) {}

    ~PyOSMObject()
    {
        if (has_python_object()) {
            m_pyobj.attr("_pyosmium_data").template cast<COSMDerivedObject<T const> *>()->invalidate();
        }
    }

    bool has_python_object() const
    { return m_valid; }

    T *get() const
    { return m_obj; }


    // must be called with GIL acquired
    pybind11::object get_or_create_python_object()
    {
        if (!m_valid) {
            m_valid = true;
            if constexpr (std::is_same_v<T, osmium::Node>) {
                m_pyobj = pybind11::module_::import("osmium.osm.types").attr("Node")(COSMNode{m_obj});
            } else if constexpr (std::is_same_v<T, osmium::Way>) {
                m_pyobj = pybind11::module_::import("osmium.osm.types").attr("Way")(COSMWay{m_obj});
            } else if constexpr (std::is_same_v<T, osmium::Relation>) {
                m_pyobj = pybind11::module_::import("osmium.osm.types").attr("Relation")(COSMRelation{m_obj});
            } else if constexpr (std::is_same_v<T, osmium::Area>) {
                m_pyobj = pybind11::module_::import("osmium.osm.types").attr("Area")(COSMArea{m_obj});
            } else if constexpr (std::is_same_v<T, osmium::Changeset>) {
                m_pyobj = pybind11::module_::import("osmium.osm.types").attr("Changeset")(COSMChangeset{m_obj});
            }
        }

        return m_pyobj;
    }

private:
    T *m_obj;
    bool m_valid = false;
    pybind11::object m_pyobj;
};

using PyOSMNode = PyOSMObject<osmium::Node>;
using PyOSMWay = PyOSMObject<osmium::Way>;
using PyOSMRelation = PyOSMObject<osmium::Relation>;
using PyOSMArea = PyOSMObject<osmium::Area>;
using PyOSMChangeset = PyOSMObject<osmium::Changeset>;

using PyOSMAny = std::variant<bool, PyOSMNode, PyOSMWay, PyOSMRelation, PyOSMArea, PyOSMChangeset>;

} // namespace

#endif //PYOSMIUM_OSM_BASE_OBJECTS_HPP