Document libbabeltrace2's C API

[babeltrace.git] / src / bindings / python / bt2 / bt2 / native_bt_port.i

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/*
 * Typemap for the user data attached to (and owned by) a self component port.
 * The pointer saved as the port's user data is directly the PyObject *.
 *
 * As per the CPython calling convention, we need to return a new reference to
 * the returned object, which will be transferred to the caller.
 */

%typemap(out) void * {
	Py_INCREF($1);
	$result = $1;
}

%include <babeltrace2/graph/port.h>
%include <babeltrace2/graph/self-component-port.h>

/*
 * Clear this typemap, since it is a bit broad and could apply to something we
 * don't want.
 */
%clear void *;