.hg和.ccg文件

这个宏为从GObject派生的类型声明了一个类型包装器，但是此包装器并不会派生自Gtk::Object。

_CLASS_GOBJECT( C++类, C类, C转换宏, C++基类, C基类 )

示例来自于entry.hg：

_CLASS_GOBJECT(Adjustment, GtkAdjustment, GTK_ADJUSTMENT, Glib::Object, GObject)

这个宏为类型声明了一个类型派生包装器，此包装器将派生自Gtk::Object，例如部件(Widget)和对话框(Dialog)。

_CLASS_GTKOBJECT( C++类, C类, C转换宏, C++基类, C基类 )

来自button.hg文件中的例子：

_CLASS_GTKOBJECT(Button, GtkButton, GTK_BUTTON, Gtk::Widget, GtkWidget)

当类已从Gtk::Object派生时，你通常会使用此宏。例如：你将在封装GTK部件时使用它，因为Gtk::Widget派生自Gtk::Object。

你还可以从Gtk::Object派生非部件类，这样你就可以在不通过Glib::RefPtr直接使用它们。例如：它们将可以使用Gtk::make_managed()实例化也可以作为成员变量在栈上实例化。这样你可以自行决定是否对它们使用引用计数。我们认为对部件使用引用计数很有用。

这个宏声明了一个非GObject结构体类型的包装器，并使用g_boxed_type_register_static()对该类型进行注册。

_CLASS_BOXEDTYPE( C++类, C类, new函数, copy函数, free函数 )

示例来自Gdk::RGBA：

_CLASS_BOXEDTYPE(RGBA, GdkRGBA, NONE, gdk_rgba_copy, gdk_rgba_free)

这个宏为类似于GdkRectangle这样的简单可赋值结构体声明了一个包装器。它和_CLASS_BOXEDTYPE类似，不过其包装的C结构体不是动态分配的。

_CLASS_BOXEDTYPE_STATIC( C++类, C类 )

示例来自Gdk::Rectangle：

_CLASS_BOXEDTYPE_STATIC(Rectangle, GdkRectangle)

这个宏为具有复制和释放函数的不透明结构体声明了一个包装器。新建(new)、复制(copy)、释放(free)函数将用于实例化默认构造函数、复制构造函数、析构函数。

_CLASS_OPAQUE_COPYABLE( C++类, C类, new函数, copy函数, free函数 )

示例来自Glib::Checksum：

_CLASS_OPAQUE_COPYABLE(VariantType, GVariantType, NONE, g_variant_type_copy, g_variant_type_free)

这个宏为使用引用计数的不透明结构体声明了一个包装器。C++包装器将不能直接实例化，需要与Glib::RefPtr一起使用。

_CLASS_OPAQUE_REFCOUNTED( C++函数, C函数, new函数, ref函数, unref函数 )

示例来自Gdk::Rectangle：

_CLASS_OPAQUE_REFCOUNTED(CssSection, GtkCssSection, NONE, gtk_css_section_ref, gtk_css_section_unref)

这个宏用于包装任何不属于专用包装宏的结构体。

_CLASS_GENERIC( C++类, C类 )

示例来自Gdk::Rectangle：

_CLASS_GENERIC(TimeCoord, GdkTimeCoord)

这个宏为派生自GTypeInterface的类型声明了一个包装器。

_CLASS_INTERFACE( C++类, C类, C转换宏, C接口结构体, C++基类(可选的), C基类(可选的) )

示例来自与celleditable.hg：

_CLASS_INTERFACE(CellEditable, GtkCellEditable, GTK_CELL_EDITABLE, GtkCellEditableIface)

对于接口是从其他接口派生的情况，两个附加参数是可选的，GInterface有另一个GInterface作为先决条件时属于此情况。示例来自于loadableicon.hg：

_CLASS_INTERFACE(LoadableIcon, GLoadableIcon, G_LOADABLE_ICON, GLoadableIconIface, Icon, GIcon)

这个宏创建一个不接受参数的默认构造函数

这个宏创建一个接受参数的构造函数，与*_new() C函数等效。但是他不会调用*_new()函数，只会创建有相同参数类型的构造函数。它需要一个C++构造函数签名和一个C函数名。

他还有需要额外的可选参数：

有时因为*_new() C函数的参数不与对象属性直接对应，或是*_new() C函数不只是简单的调用g_object_new()，你将必须手写一部分构造函数。在此时你可以在》ccg文件中使用_CONSTRUCT()宏来保存一些工作。_CONSTRUCT宏接受一系列属性名与值作为参数。示例来自button.ccg：

Button::Button(const Glib::ustring& label, bool mnemonic)
:
  _CONSTRUCT("label", label.c_str(), "use_underline", gboolean(mnemonic))
{}

抑制_CLASS_BOXEDTYPE、_CLASS_BOXEDTYPE_STATIC、_CLASS_OPAQUE_COPYABLE生成默认构造函数的声明和定义。

抑制_CLASS_BOXEDTYPE和_CLASS_BOXEDTYPE_STATIC生成接受指向其所包装的C类型的指针的构造函数的声明和定义。

抑制_CLASS_INTERFACE和_CLASS_OPAQUE_COPYABLE生成接受指向其所包装的C类型的指针的构造函数的定义。

抑制_CLASS_GOBJECT和_CLASS_GTKOBJECT生成接受指向其所包装的C类型的指针且接受其他构造参数的构造函数的定义。

抑制_CLASS_GOBJECT和_CLASS_GTKOBJECT生成析构函数的定义

抑制_CLASS_GOBJECT_CLASS_GTKOBJECT生成移动构造函数和移动赋值运算符的声明和定义。

例如：

class Derived : public Glib::Object
{
  _CLASS_GOBJECT(Derived, GDerived, G_DERIVED, Glib::Object, GObject)

  _CUSTOM_MOVE_OPERATIONS

public:
  Derived(Derived&& src) noexcept;
  Derived& operator=(Derived&& src) noexcept;
  // ...
};

抑制_CLASS_GOBJECT生成Glib::wrap_new()的定义。

抑制_CLASS_GOBJECT和_CLASS_GTKOBJECT生成Glib::wrap()函数的定义。

抑制_CLASS_GOBJECT、_CLASS_BOXEDTYPE、_CLASS_BOXEDTYPE_STATIC、_CLASS_OPAQUE_COPYABLE、_CLASS_INTERFACE和_CLASS_GTKOBJECT生成Glib::wrap()函数的声明和定义。

这个宏用于生成封装C函数的C++方法。

_WRAP_METHOD( C++方法签名, C函数名)

示例来自于entry.hg：

_WRAP_METHOD(void set_text(const Glib::ustring& text), gtk_entry_set_text)

在.defs文件中有对C函数更全面的描述，convert*.m4文件中包含了从C++参数类型到C参数类型的必要转换。这个宏还基于*_docs.xml和*_docs_override.xml文件生成doxygen文档注释。

有一些可选的额外参数：

封装C API时，选择对应的C++类型也很重要。尽管多数时候应该在C++方法中使用什么C++类型是很明显的，但我们还是想给你一些提示：

这个宏类似于_WRAP_METHOD()，但是它只生成封装C函数的C++方法的文档。当你需要手动编写该方法又不想手动编写文档时，请使用这个宏。

_WRAP_METHOD_DOCS_ONLY(C function name)

示例来自于container.hg：

_WRAP_METHOD_DOCS_ONLY(gtk_recent_info_get_applications)

有一些可选的额外参数：

gmmproc会在stdout上警告你忘了封装相关的函数、信号、属性、子属性，这有助于确保API被完整的封装。但有时候你会不想对某些函数、信号、属性、子属性封装，或者你想要手动编写一些函数，那么你可以使用_IGNORE()、_IGNORE_SIGNAL()、_IGNORE_PROPERTY()宏使gmmproc停止发出部分警告。

示例来自flowbox.hg：

_IGNORE(gtk_flow_box_set_filter_func, gtk_flow_box_set_sort_func)
_IGNORE_SIGNAL(activate-cursor-child, toggle-cursor-child, move-cursor)

这个宏生成用来封装C GObject信号的C++ libsigc++风格的信号。实际上它会生成一个公有访问器方法，例如signal_clicked()，它返回一个代理对象。gmmproc使用.defs文件寻找C参数类型并使用.m4转换文件查找如何将其转换为适当的类型。

_WRAP_SIGNAL( C++信号处理函数签名, C信号名)

来自button.hg文件中的例子：

_WRAP_SIGNAL(void clicked(),"clicked")

信号通常在GTK结构体中具有函数指针，在.c文件中有对应的枚举值和g_signal_new()函数。

有一些可选的额外参数：

这个宏生成用于包装C GObject属性的C++方法。你需要为该属性指定属性名以及其值所需的C++类型。gmmproc使用.defs文件寻找C参数类型并使用.m4转换文件查找如何将其转换为适当的类型。

_WRAP_PROPERTY(C属性名, C++类型)

来自button.hg文件中的例子：

_WRAP_PROPERTY("label", Glib::ustring)

有一些可选的额外参数：

这个宏生成用于封装C虚函数的C++成员函数。

_WRAP_VFUNC( C++成员函数签名, C函数名)

示例来自于widget.hg：

_WRAP_VFUNC(SizeRequestMode get_request_mode() const, get_request_mode)

在*_vfuncs.defs文件中有对C函数更全面的描述，convert*.m4文件中包含了从C++参数类型到C参数类型的必要转换。转换也可以写入.hg文件。虚函数通常需要额外的转换，这些转换最好保存在使用这些虚函数的.hg文件文件中。

有一些可选的额外参数：

一个可能有例外的规则：如果一个C虚函数返回了指向派生自GObject的对象的指针，也即一个引用计数对象的指针，那么C++虚函数应该返回Glib::RefPtr<>对象。且需要refreturn或refreturn_ctype额外参数。

这个宏为接口生成初始化代码

_IMPLEMENTS_INTERFACE(C++接口名)

示例来自于grid.hg：

_IMPLEMENTS_INTERFACE(Orientable)

有一个可选的额外参数：

这个宏生成一个C++枚举以包装C枚举。你必须指定所需的C++名称和底层C枚举的名称。

示例来自于enums.hg：

_WRAP_ENUM(Orientation, GtkOrientation)

有一些可选的额外参数：

这个宏只是为枚举生成一个Doxygen文档块。这对于因为过于复杂（这通常是因为使用了C宏）而无法使用_WRAP_ENUM()包装，且依然需要包含为枚举生成的文档的枚举类型很有用。它与_WRAP_ENUM()使用同一语法，也处理一样的参数（尽管有些额外参数因为没有作用会被忽略）

这个宏会生成一个C++异常类，生成的类派生自Glib::Error，并具有一个Code枚举成员变量和一个code()成员函数。你必须指定所需的C++名称、以及与其对应的C枚举名、C枚举值前缀。

然后可以由带有errthrow选项的_WRAP_METHOD()生成的成员函数抛出此异常。

示例来自于pixbuf.hg：

_WRAP_GERROR(PixbufError, GdkPixbufError, GDK_PIXBUF_ERROR)

_WRAP_GERROR()接受与_WRAP_ENUM()一样的可选参数（尽管CONV_TO_INT参数因为没有作用而被忽略）。

如果要包装可以被直接访问其数据成员的简单结构体或装箱类型，请使用这些宏。这些宏会为其数据成员创建访问器成员函数（getter和setter）。

_MEMBER_GET(C++名, C名, C++类型, C类型)

_MEMBER_SET(C++名, C名, C++类型, C类型)

示例来自于rectangle.hg：

_MEMBER_GET(x, x, int, int)

使用这些宏可以自动为指针类型的数据成员提供访问器（getter和setter）。对于getter函数，将创建两个版本，一个const版本一个非const版本。

_MEMBER_GET_PTR(C++名, C名, C++类型, C类型)

_MEMBER_GET_PTR(C++名, C名, C++类型, C类型)

示例来自于item.hg文件中的Pango::Analysis：

// _MEMBER_GET_PTR(engine_lang, lang_engine, EngineLang*, PangoEngineLang*)
// It's just a comment. It's difficult to find a real-world example.

使用这些宏可以为返回之前必须被引用的GObject类型数据成员提供访问器（getters和setters）。

_MEMBER_GET_GOBJECT(C++名, C名, C++类型, C类型)

_MEMBER_SET_GOBJECT(C++名, C名, C++类型, C类型)

示例来自于Pangomm中的layoutline.hg：

_MEMBER_GET_GOBJECT(layout, layout, Pango::Layout, PangoLayout*)

对于所有处理成员函数签名的宏，可以为C++参数指定一个与C函数、虚函数、信号中现有顺序不同的顺序。例如，假设如下所示的C函数将被封装为Gtk::Widget类的C++成员函数：

void gtk_widget_set_device_events(GtkWidget* widget, GdkDevice* device,
  GdkEventMask events);

_WRAP_METHOD(void set_device_events(Gdk::EventMask events{events},
  const Glib::RefPtr<const Gdk::Device>& device{device}),
  gtk_widget_set_device_events)

_WRAP_METHOD(void set_device_events(Gdk::EventMask events{.},
  const Glib::RefPtr<const Gdk::Device>& device{.}),
  gtk_widget_set_device_events)

对于除了_WRAP_SIGNAL()和_WRAP_VFUNC()以外的所有处理成员函数签名的宏，都可以讲参数设为可选的，这样就可以在没有指定可选参数的情况下额外生成C++成员函数。例如，假设以下所示的*_new()将被封装为Gtk::ToolButton类的构造函数：

GtkToolItem* gtk_tool_button_new(GtkWidget* icon_widget, const gchar* label);

_WRAP_CTOR(ToolButton(Widget& icon_widget, const Glib::ustring& label{?}),
  gtk_tool_button_new)

使用_WRAP_METHOD()也可以将封装好的C函数的返回值放到C++成员函数的输出参数中，而不是让C++成员函数和C函数一样返回一个值。要做到这个，只需要在C++成员函数参数列表中的输出参数名后附加{OUT}即可。例如，如果gtk_widget_get_request_mode()的声明如下所示：

GtkSizeRequestMode gtk_widget_get_request_mode(GtkWidget* widget);

_WRAP_METHOD(void get_request_mode(SizeRequestMode& mode{OUT}) const,
  gtk_widget_get_request_mode)

_INITIALIZATION(`SizeRequestMode&',`GtkSizeRequestMode',`$3 = (SizeRequestMode)($4)')

_INITIALIZATION(`SizeRequestMode&',`GtkSizeRequestMode',`$3 = ($1)($4)')

如果被封装的C函数有输出参数，_WRAP_METHOD()也支持将C输出参数设置为C++输出参数。例如，假设我们想封装以下C函数，该函数在C输出参数rect中返回一个值：

gboolean gtk_icon_view_get_cell_rect(GtkIconView* icon_view,
  GtkTreePath* path, GtkCellRenderer* cell, GdkRectangle* rect);

_WRAP_METHOD(bool get_cell_rect(const TreeModel::Path& path,
  const CellRenderer& cell, Gdk::Rectangle& rect{>>}) const,
  gtk_icon_view_get_cell_rect)

_INITIALIZATION(`Gdk::Rectangle&',`GdkRectangle',`$3 = Glib::wrap(&($4))')

在C++成员函数中的字符串值的输入参数通常是const Glib::ustring&或者是const std::string&。而在C代码中，它是const gchar*。在将空字符串转换为const gchar*的时候，可以将其转换为nullptr或者是一个指向空字符串的指针（用c_str()）。一些C函数的一些参数接受nullptr，并以特殊方式解释它。其他参数不能为nullptr。

_WRAP_METHOD()和类似的宏的默认转换是：