* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* Author: Ryan Lortie <desrt@desrt.ca>
*/
#include "config.h"
#include "gpermission.h"
+
+#include "gioerror.h"
+#include "gioenums.h"
+#include "gasyncresult.h"
+#include "gsimpleasyncresult.h"
#include "glibintl.h"
-#include "gioalias.h"
/**
* SECTION:gpermission
* @title: GPermission
- * @short_description: an object representing the permission to perform
- * a certain action
+ * @short_description: An object representing the permission
+ * to perform a certain action
+ * @include: gio/gio.h
*
* A #GPermission represents the status of the caller's permission to
* perform a certain action.
* using the following functions.
**/
-G_DEFINE_ABSTRACT_TYPE (GPermission, g_permission, G_TYPE_OBJECT)
-
struct _GPermissionPrivate
{
gboolean allowed;
PROP_CAN_RELEASE
};
+G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GPermission, g_permission, G_TYPE_OBJECT)
+
/**
* g_permission_acquire:
* @permission: a #GPermission instance
- * @cancellable: a #GCancellable, or %NULL
+ * @cancellable: (allow-none): a #GCancellable, or %NULL
* @error: a pointer to a %NULL #GError, or %NULL
- * @returns: %TRUE if the permission was successfully acquired
*
* Attempts to acquire the permission represented by @permission.
*
* user interaction is required). See g_permission_acquire_async() for
* the non-blocking version.
*
+ * Returns: %TRUE if the permission was successfully acquired
+ *
* Since: 2.26
*/
gboolean
GCancellable *cancellable,
GError **error)
{
+ g_return_val_if_fail (G_IS_PERMISSION (permission), FALSE);
return G_PERMISSION_GET_CLASS (permission)
->acquire (permission, cancellable, error);
}
/**
* g_permission_acquire_async:
* @permission: a #GPermission instance
- * @cancellable: a #GCancellable, or %NULL
+ * @cancellable: (allow-none): a #GCancellable, or %NULL
* @callback: the #GAsyncReadyCallback to call when done
* @user_data: the user data to pass to @callback
*
GAsyncReadyCallback callback,
gpointer user_data)
{
+ g_return_if_fail (G_IS_PERMISSION (permission));
G_PERMISSION_GET_CLASS (permission)
->acquire_async (permission, cancellable, callback, user_data);
}
* @permission: a #GPermission instance
* @result: the #GAsyncResult given to the #GAsyncReadyCallback
* @error: a pointer to a %NULL #GError, or %NULL
- * @returns: %TRUE if the permission was successfully acquired
*
* Collects the result of attempting to acquire the permission
* represented by @permission.
* This is the second half of the asynchronous version of
* g_permission_acquire().
*
+ * Returns: %TRUE if the permission was successfully acquired
+ *
* Since: 2.26
**/
gboolean
GAsyncResult *result,
GError **error)
{
+ g_return_val_if_fail (G_IS_PERMISSION (permission), FALSE);
return G_PERMISSION_GET_CLASS (permission)
->acquire_finish (permission, result, error);
}
/**
* g_permission_release:
* @permission: a #GPermission instance
- * @cancellable: a #GCancellable, or %NULL
+ * @cancellable: (allow-none): a #GCancellable, or %NULL
* @error: a pointer to a %NULL #GError, or %NULL
- * @returns: %TRUE if the permission was successfully released
*
* Attempts to release the permission represented by @permission.
*
* user interaction is required). See g_permission_release_async() for
* the non-blocking version.
*
+ * Returns: %TRUE if the permission was successfully released
+ *
* Since: 2.26
**/
gboolean
GCancellable *cancellable,
GError **error)
{
+ g_return_val_if_fail (G_IS_PERMISSION (permission), FALSE);
return G_PERMISSION_GET_CLASS (permission)
->release (permission, cancellable, error);
}
/**
* g_permission_release_async:
* @permission: a #GPermission instance
- * @cancellable: a #GCancellable, or %NULL
+ * @cancellable: (allow-none): a #GCancellable, or %NULL
* @callback: the #GAsyncReadyCallback to call when done
* @user_data: the user data to pass to @callback
*
GAsyncReadyCallback callback,
gpointer user_data)
{
+ g_return_if_fail (G_IS_PERMISSION (permission));
G_PERMISSION_GET_CLASS (permission)
->release_async (permission, cancellable, callback, user_data);
}
* @permission: a #GPermission instance
* @result: the #GAsyncResult given to the #GAsyncReadyCallback
* @error: a pointer to a %NULL #GError, or %NULL
- * @returns: %TRUE if the permission was successfully released
*
* Collects the result of attempting to release the permission
* represented by @permission.
* This is the second half of the asynchronous version of
* g_permission_release().
*
+ * Returns: %TRUE if the permission was successfully released
+ *
* Since: 2.26
**/
gboolean
GAsyncResult *result,
GError **error)
{
+ g_return_val_if_fail (G_IS_PERMISSION (permission), FALSE);
return G_PERMISSION_GET_CLASS (permission)
->release_finish (permission, result, error);
}
/**
* g_permission_get_allowed:
* @permission: a #GPermission instance
- * @returns: the value of the 'allowed' property
*
* Gets the value of the 'allowed' property. This property is %TRUE if
* the caller currently has permission to perform the action that
* @permission represents the permission to perform.
*
+ * Returns: the value of the 'allowed' property
+ *
* Since: 2.26
**/
gboolean
g_permission_get_allowed (GPermission *permission)
{
+ g_return_val_if_fail (G_IS_PERMISSION (permission), FALSE);
return permission->priv->allowed;
}
/**
* g_permission_get_can_acquire:
* @permission: a #GPermission instance
- * @returns: the value of the 'can-acquire' property
*
* Gets the value of the 'can-acquire' property. This property is %TRUE
* if it is generally possible to acquire the permission by calling
* g_permission_acquire().
*
+ * Returns: the value of the 'can-acquire' property
+ *
* Since: 2.26
**/
gboolean
g_permission_get_can_acquire (GPermission *permission)
{
+ g_return_val_if_fail (G_IS_PERMISSION (permission), FALSE);
return permission->priv->can_acquire;
}
/**
* g_permission_get_can_release:
* @permission: a #GPermission instance
- * @returns: the value of the 'can-release' property
*
* Gets the value of the 'can-release' property. This property is %TRUE
* if it is generally possible to release the permission by calling
* g_permission_release().
*
+ * Returns: the value of the 'can-release' property
+ *
* Since: 2.26
**/
gboolean
g_permission_get_can_release (GPermission *permission)
{
+ g_return_val_if_fail (G_IS_PERMISSION (permission), FALSE);
return permission->priv->can_release;
}
gboolean can_acquire,
gboolean can_release)
{
- GObject *object = G_OBJECT (permission);
+ GObject *object;
+
+ g_return_if_fail (G_IS_PERMISSION (permission));
+ object = G_OBJECT (permission);
g_object_freeze_notify (object);
+ allowed = allowed != FALSE;
if (allowed != permission->priv->allowed)
{
- permission->priv->allowed = !!allowed;
+ permission->priv->allowed = allowed;
g_object_notify (object, "allowed");
}
+ can_acquire = can_acquire != FALSE;
if (can_acquire != permission->priv->can_acquire)
{
- permission->priv->can_acquire = !!can_acquire;
+ permission->priv->can_acquire = can_acquire;
g_object_notify (object, "can-acquire");
}
+ can_release = can_release != FALSE;
if (can_release != permission->priv->can_release)
{
- permission->priv->can_release = !!can_release;
+ permission->priv->can_release = can_release;
g_object_notify (object, "can-release");
}
static void
g_permission_init (GPermission *permission)
{
- permission->priv = G_TYPE_INSTANCE_GET_PRIVATE (permission,
- G_TYPE_PERMISSION,
- GPermissionPrivate);
+ permission->priv = g_permission_get_instance_private (permission);
+}
+
+static gboolean
+acquire_or_release (GPermission *permission,
+ GCancellable *cancellable,
+ GError **error)
+{
+ g_set_error_literal (error,
+ G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ "Can't acquire or release permission");
+ return FALSE;
+}
+
+static void
+acquire_or_release_async (GPermission *permission,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
+{
+ g_simple_async_report_error_in_idle (G_OBJECT (permission),
+ callback, user_data,
+ G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ "Can't acquire or release permission");
+}
+
+static gboolean
+acquire_or_release_finish (GPermission *permission,
+ GAsyncResult *result,
+ GError **error)
+{
+ g_async_result_legacy_propagate_error (result, error);
+ return FALSE;
}
static void
object_class->get_property = g_permission_get_property;
+ class->acquire = acquire_or_release;
+ class->release = acquire_or_release;
+ class->acquire_async = acquire_or_release_async;
+ class->release_async = acquire_or_release_async;
+ class->acquire_finish = acquire_or_release_finish;
+ class->release_finish = acquire_or_release_finish;
+
/**
* GPermission:allowed:
*
*/
g_object_class_install_property (object_class, PROP_ALLOWED,
g_param_spec_boolean ("allowed",
- P(("Is allowed"),
+ P_("Is allowed"),
P_("If the caller is allowed to perform the action"),
FALSE,
G_PARAM_STATIC_STRINGS | G_PARAM_READABLE));
P_("If calling g_permission_release() makes sense"),
FALSE,
G_PARAM_STATIC_STRINGS | G_PARAM_READABLE));
-
- g_type_class_add_private (class, sizeof (GPermissionPrivate));
}
-
-#define __G_PERMISSION_C__
-#include "gioaliasdef.c"
projects / platform / upstream / glib.git / blobdiff