Merge branch 'cleanups' into 'main'

Some cleanups I noticed while looking at the code

See merge request Librem5/feedbackd!79

libfeedback/lfb-event.c

@@ -30,7 +30,7 @@
  *
  * |[
  *    g_autoptr (GError) err = NULL;
- *    LpfEvent *event = lfb_event_new ("message-new-instant");
+ *    LfbEvent *event = lfb_event_new ("message-new-instant");
  *    lfb_event_set_timeout (event, 0);
  *    if (!lfb_event_trigger_feedback (event, &err))
  *      g_warning ("Failed to trigger feedback: %s", err->message);
@@ -104,10 +104,10 @@ typedef struct _LfbEvent {
 
 G_DEFINE_TYPE (LfbEvent, lfb_event, G_TYPE_OBJECT);
 
-typedef struct _LpfAsyncData {
+typedef struct _LfbAsyncData {
   LfbEvent *event;
   GTask    *task;
-} LpfAsyncData;
+} LfbAsyncData;
 
 static void
 lfb_event_set_state (LfbEvent *self, LfbEventState state)
@@ -143,7 +143,7 @@ build_hints (LfbEvent *self)
 static void
 on_trigger_feedback_finished (LfbGdbusFeedback *proxy,
                               GAsyncResult     *res,
-                              LpfAsyncData     *data)
+                              LfbAsyncData     *data)
 
 {
   GTask *task = data->task;
@@ -176,7 +176,7 @@ on_trigger_feedback_finished (LfbGdbusFeedback *proxy,
 static void
 on_end_feedback_finished (LfbGdbusFeedback *proxy,
                           GAsyncResult     *res,
-                          LpfAsyncData     *data)
+                          LfbAsyncData     *data)
 
 {
   GTask *task = data->task;
@@ -415,10 +415,8 @@ lfb_event_trigger_feedback (LfbEvent *self, GError **error)
   g_return_val_if_fail (LFB_IS_EVENT (self), FALSE);
   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
 
-   if (!lfb_is_initted ()) {
+   if (!lfb_is_initted ())
-     g_warning ("you must call lfb_init() before triggering events");
+     g_error ("You must call lfb_init() before triggering events.");
-     g_assert_not_reached ();
-   }
 
    proxy = _lfb_get_proxy ();
    g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), FALSE);
@@ -462,14 +460,12 @@ lfb_event_trigger_feedback_async (LfbEvent            *self,
                                   GAsyncReadyCallback  callback,
                                   gpointer             user_data)
 {
-  LpfAsyncData *data;
+  LfbAsyncData *data;
   LfbGdbusFeedback *proxy;
 
   g_return_if_fail (LFB_IS_EVENT (self));
-  if (!lfb_is_initted ()) {
+  if (!lfb_is_initted ())
-     g_warning ("you must call lfb_init() before triggering events");
+     g_error ("You must call lfb_init() before triggering events.");
-     g_assert_not_reached ();
-  }
 
   proxy = _lfb_get_proxy ();
   g_return_if_fail (LFB_GDBUS_IS_FEEDBACK (proxy));
@@ -482,7 +478,7 @@ lfb_event_trigger_feedback_async (LfbEvent            *self,
                                                 G_CONNECT_SWAPPED);
   }
 
-  data = g_new0 (LpfAsyncData, 1);
+  data = g_new0 (LfbAsyncData, 1);
   data->task = g_task_new (self, cancellable, callback, user_data);
   data->event = g_object_ref (self);
   lfb_gdbus_feedback_call_trigger_feedback (proxy,
@@ -537,10 +533,8 @@ lfb_event_end_feedback (LfbEvent *self, GError **error)
   g_return_val_if_fail (LFB_IS_EVENT (self), FALSE);
   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
 
-  if (!lfb_is_initted ()) {
+  if (!lfb_is_initted ())
-     g_warning ("you must call lfb_init() before ending events");
+     g_error ("You must call lfb_init() before ending events.");
-     g_assert_not_reached ();
-  }
 
   proxy = _lfb_get_proxy ();
   g_return_val_if_fail (LFB_GDBUS_IS_FEEDBACK (proxy), FALSE);
@@ -589,19 +583,17 @@ lfb_event_end_feedback_async (LfbEvent            *self,
                               GAsyncReadyCallback  callback,
                               gpointer             user_data)
 {
-  LpfAsyncData *data;
+  LfbAsyncData *data;
   LfbGdbusFeedback *proxy;
 
   g_return_if_fail (LFB_IS_EVENT (self));
-  if (!lfb_is_initted ()) {
+  if (!lfb_is_initted ())
-     g_warning ("you must call lfb_init() before ending events");
+     g_error ("You must call lfb_init() before ending events.");
-     g_assert_not_reached ();
-  }
 
   proxy = _lfb_get_proxy ();
   g_return_if_fail (LFB_GDBUS_IS_FEEDBACK (proxy));
 
-  data = g_new0 (LpfAsyncData, 1);
+  data = g_new0 (LfbAsyncData, 1);
   data->task = g_task_new (self, cancellable, callback, user_data);
   data->event = g_object_ref (self);
   lfb_gdbus_feedback_call_end_feedback (proxy,

libfeedback/libfeedback.c

@@ -192,10 +192,8 @@ lfb_get_feedback_profile (void)
 {
   LfbGdbusFeedback *proxy;
 
-  if (!lfb_is_initted ()) {
+  if (!lfb_is_initted ())
-     g_warning ("you must call lfb_init() before getting the profile");
+    g_error ("You must call lfb_init() before ending events.");
-     g_assert_not_reached ();
-   }
 
   proxy = _lfb_get_proxy ();
   g_return_val_if_fail (LFB_GDBUS_IS_FEEDBACK (proxy), NULL);
@@ -218,10 +216,8 @@ lfb_set_feedback_profile (const gchar *profile)
 {
   LfbGdbusFeedback *proxy;
 
-  if (!lfb_is_initted ()) {
+  if (!lfb_is_initted ())
-     g_warning ("you must call lfb_init() before setting the profile");
+    g_error ("You must call lfb_init() before ending events.");
-     g_assert_not_reached ();
-   }
 
   proxy = _lfb_get_proxy ();
   g_return_if_fail (LFB_GDBUS_IS_FEEDBACK (proxy));

tests/test-lfb-event.c

@@ -47,7 +47,6 @@ static void
 test_lfb_event_trigger (void)
 {
   g_autoptr(LfbEvent) event = NULL;
-  g_autofree gchar *evname = NULL;
   g_autoptr (GError) err = NULL;
 
   g_assert_true (lfb_init (TEST_APP_ID, NULL));

tests/test-lfb-integration.c

@@ -60,6 +60,8 @@ on_feedback_ended (LfbEvent *event, LfbEvent **cmp)
 	   lfb_event_get_event (event),
 	   lfb_event_get_end_reason (event));
 
+  g_assert_cmpint (lfb_event_get_state (event), ==, LFB_EVENT_STATE_ENDED);
+
   /* "Return" event */
   *cmp = event;
 }
@@ -68,9 +70,7 @@ static void
 test_lfb_integration_event_sync (void)
 {
   g_autoptr(LfbEvent) event0 = NULL;
-  g_autoptr(LfbEvent) event1 = NULL;
   g_autoptr(LfbEvent) event10 = NULL;
-  g_autofree gchar *evname = NULL;
   g_autoptr (GError) err = NULL;
   LfbEvent *cmp = NULL;
   gboolean success;
@@ -103,7 +103,6 @@ static void
 test_lfb_integration_event_not_found (void)
 {
   g_autoptr(LfbEvent) event0 = NULL;
-  g_autofree gchar *evname = NULL;
   g_autoptr (GError) err = NULL;
   LfbEvent *cmp = NULL;
   gboolean success;
@@ -162,6 +161,7 @@ on_event_end_finished (LfbEvent      *event,
   g_assert_no_error (err);
   g_assert_true (success);
 
+  /* This is not guaranteed for all types of feedback, see `feedback-ended` */
   g_assert_cmpint (lfb_event_get_state (event), ==, LFB_EVENT_STATE_ENDED);
 
   /* "Return" event */
@@ -174,8 +174,6 @@ test_lfb_integration_event_async (void)
 {
   g_autoptr(LfbEvent) event0 = NULL;
   g_autoptr(LfbEvent) event10 = NULL;
-  g_autofree gchar *evname = NULL;
-  g_autoptr (GError) err = NULL;
   LfbEvent *cmp1 = NULL, *cmp2 = NULL, *cmp3 = NULL;
 
   event0 = lfb_event_new ("test-dummy-0");