Loading...
Searching...
No Matches
GlibMemory.h
/*
* Copyright (C) 2017 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authored by: Pete Woods <pete.woods@canonical.com>
* Michi Henning <michi.henning@canonical.com>
* James Henstridge <james.henstridge@canonical.com>
*/
#ifndef LOMIRI_UTIL_GLIBMEMORY_H
#define LOMIRI_UTIL_GLIBMEMORY_H
#include <memory>
#include <glib.h>
#include <lomiri/util/ResourcePtr.h>
namespace lomiri
{
namespace util
{
namespace internal
{
template<typename T> struct GlibDeleter;
template<typename T> using GlibSPtr = std::shared_ptr<T>;
template<typename T> using GlibUPtr = std::unique_ptr<T, GlibDeleter<T>>;
template<typename SP>
class GlibAssigner
{
public:
typedef typename SP::element_type ElementType;
GlibAssigner(SP& smart_ptr) noexcept :
smart_ptr_(smart_ptr)
{
}
GlibAssigner(const GlibAssigner& other) = delete;
GlibAssigner(GlibAssigner&& other) noexcept:
ptr_(other.ptr_), smart_ptr_(other.smart_ptr_)
{
other.ptr_ = nullptr;
}
~GlibAssigner() noexcept
{
smart_ptr_ = SP(ptr_, GlibDeleter<ElementType>());
}
GlibAssigner& operator=(const GlibAssigner& other) = delete;
operator ElementType**() noexcept
{
return &ptr_;
}
private:
ElementType* ptr_ = nullptr;
SP& smart_ptr_;
};
struct GSourceUnsubscriber
{
void operator()(guint tag) noexcept
{
if (tag != 0)
{
g_source_remove(tag);
}
}
};
}
#define LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(TypeName, func) \
using TypeName##Deleter = internal::GlibDeleter<TypeName>; \
using TypeName##SPtr = internal::GlibSPtr<TypeName>; \
using TypeName##UPtr = internal::GlibUPtr<TypeName>; \
namespace internal \
{ \
template<> struct GlibDeleter<TypeName> \
{ \
void operator()(TypeName* ptr) noexcept \
{ \
if (ptr) \
{ \
func(ptr); \
} \
} \
}; \
}
template<typename T>
inline internal::GlibSPtr<T> share_glib(T* ptr) noexcept
{
return internal::GlibSPtr<T>(ptr, internal::GlibDeleter<T>());
}
template<typename T>
inline internal::GlibUPtr<T> unique_glib(T* ptr) noexcept
{
return internal::GlibUPtr<T>(ptr, internal::GlibDeleter<T>());
}
template<typename SP>
inline internal::GlibAssigner<SP> assign_glib(SP& smart_ptr) noexcept
{
return internal::GlibAssigner<SP>(smart_ptr);
}
using GSourceManager = ResourcePtr<guint, internal::GSourceUnsubscriber>;
inline GSourceManager g_source_manager(guint id)
{
return GSourceManager(id, internal::GSourceUnsubscriber());
}
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GAsyncQueue, g_async_queue_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GBookmarkFile, g_bookmark_file_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GBytes, g_bytes_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GChecksum, g_checksum_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GDateTime, g_date_time_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GDir, g_dir_close)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GError, g_error_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GHashTable, g_hash_table_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GHmac, g_hmac_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GIOChannel, g_io_channel_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GKeyFile, g_key_file_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GList, g_list_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GArray, g_array_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GPtrArray, g_ptr_array_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GByteArray, g_byte_array_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GMainContext, g_main_context_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GMainLoop, g_main_loop_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GSource, g_source_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GMappedFile, g_mapped_file_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GMarkupParseContext, g_markup_parse_context_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GNode, g_node_destroy)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GOptionContext, g_option_context_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GOptionGroup, g_option_group_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GPatternSpec, g_pattern_spec_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GQueue, g_queue_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GRand, g_rand_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GRegex, g_regex_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GMatchInfo, g_match_info_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GScanner, g_scanner_destroy)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GSequence, g_sequence_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GSList, g_slist_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GString, g_autoptr_cleanup_gstring_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GStringChunk, g_string_chunk_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GThread, g_thread_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GMutex, g_mutex_clear)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GCond, g_cond_clear)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GTimer, g_timer_destroy)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GTimeZone, g_time_zone_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GTree, g_tree_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GVariant, g_variant_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GVariantBuilder, g_variant_builder_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GVariantIter, g_variant_iter_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GVariantDict, g_variant_dict_unref)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(GVariantType, g_variant_type_free)
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(gchar, g_free)
typedef gchar* gcharv;
LOMIRI_UTIL_DEFINE_GLIB_SMART_POINTERS(gcharv, g_strfreev)
} // namespace until
} // namespace lomiri
#endif
lomiri::util::ResourcePtr
Class to guarantee deallocation of arbitrary resources.
Definition ResourcePtr.h:121
lomiri
Top-level namespace for all things Lomiri-related.
Definition Version.h:38