From e05601b4f136ff9a6baf698c8260bf6cca8c69cb Mon Sep 17 00:00:00 2001
From: Stef Walter <stefw@gnome.org>
Date: Fri, 10 Feb 2012 16:11:52 +0100
Subject: [PATCH] gcr: More checks and docs for GcrPrompt

---
 gcr/gcr-mock-prompter.c                             | 21 ++++++++-------------
 gcr/gcr-prompt.c                                    | 10 ++++++++++
 gcr/tests/files/prompt-tests/password-choice.prompt |  1 +
 3 files changed, 19 insertions(+), 13 deletions(-)

diff --git a/gcr/gcr-mock-prompter.c b/gcr/gcr-mock-prompter.c
index e506b3b..e72ef85 100644
--- a/gcr/gcr-mock-prompter.c
+++ b/gcr/gcr-mock-prompter.c
@@ -35,24 +35,19 @@
 /**
  * SECTION:gcr-mock-prompter
  * @title: GcrMockPrompter
- * @short_description: XXX
+ * @short_description: a mock GcrSystemPrompter for testing
  *
- * XXXX
- */
-
-/**
- * GcrMockPrompter:
+ * A mock GcrSystemPrompter used for testing against.
  *
- * XXX
- */
-
-/**
- * GcrMockPrompterClass:
+ * Use gcr_mock_prompter_start() to start the mock prompter in another
+ * thread. The returned string is the dbus address of the mock prompter.
+ * You can pass this to gcr_system_prompt_open() as the prompter bus name.
  *
- * The class for #GcrMockPrompter.
+ * Use the gcr_mock_prompter_expect_confirm_ok() function and friends before
+ * prompting to verify that the prompts are displayed as expected, and to
+ * provide a response.
  */
 
-
 GType   _gcr_mock_prompt_get_type       (void) G_GNUC_CONST;
 #define GCR_TYPE_MOCK_PROMPT            (_gcr_mock_prompt_get_type ())
 #define GCR_MOCK_PROMPT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GCR_TYPE_MOCK_PROMPT, GcrMockPrompt))
diff --git a/gcr/gcr-prompt.c b/gcr/gcr-prompt.c
index 379808b..b80c899 100644
--- a/gcr/gcr-prompt.c
+++ b/gcr/gcr-prompt.c
@@ -327,6 +327,7 @@ gchar *
 gcr_prompt_get_title (GcrPrompt *prompt)
 {
 	gchar *title = NULL;
+	g_return_val_if_fail (GCR_IS_PROMPT (prompt), NULL);
 	g_object_get (prompt, "title", &title, NULL);
 	return title;
 }
@@ -364,6 +365,7 @@ gchar *
 gcr_prompt_get_message (GcrPrompt *prompt)
 {
 	gchar *message = NULL;
+	g_return_val_if_fail (GCR_IS_PROMPT (prompt), NULL);
 	g_object_get (prompt, "message", &message, NULL);
 	return message;
 }
@@ -401,6 +403,7 @@ gchar *
 gcr_prompt_get_description (GcrPrompt *prompt)
 {
 	gchar *description = NULL;
+	g_return_val_if_fail (GCR_IS_PROMPT (prompt), NULL);
 	g_object_get (prompt, "description", &description, NULL);
 	return description;
 }
@@ -442,6 +445,7 @@ gchar *
 gcr_prompt_get_warning (GcrPrompt *prompt)
 {
 	gchar *warning = NULL;
+	g_return_val_if_fail (GCR_IS_PROMPT (prompt), NULL);
 	g_object_get (prompt, "warning", &warning, NULL);
 	return warning;
 }
@@ -481,6 +485,7 @@ gchar *
 gcr_prompt_get_choice_label (GcrPrompt *prompt)
 {
 	gchar *choice_label = NULL;
+	g_return_val_if_fail (GCR_IS_PROMPT (prompt), NULL);
 	g_object_get (prompt, "choice-label", &choice_label, NULL);
 	return choice_label;
 }
@@ -523,6 +528,7 @@ gboolean
 gcr_prompt_get_choice_chosen (GcrPrompt *prompt)
 {
 	gboolean choice_chosen;
+	g_return_val_if_fail (GCR_IS_PROMPT (prompt), FALSE);
 	g_object_get (prompt, "choice-chosen", &choice_chosen, NULL);
 	return choice_chosen;
 }
@@ -560,6 +566,7 @@ gboolean
 gcr_prompt_get_password_new (GcrPrompt *prompt)
 {
 	gboolean password_new;
+	g_return_val_if_fail (GCR_IS_PROMPT (prompt), FALSE);
 	g_object_get (prompt, "password-new", &password_new, NULL);
 	return password_new;
 }
@@ -600,6 +607,7 @@ gint
 gcr_prompt_get_password_strength (GcrPrompt *prompt)
 {
 	gboolean password_strength;
+	g_return_val_if_fail (GCR_IS_PROMPT (prompt), 0);
 	g_object_get (prompt, "password-strength", &password_strength, NULL);
 	return password_strength;
 }
@@ -621,6 +629,7 @@ gchar *
 gcr_prompt_get_caller_window (GcrPrompt *prompt)
 {
 	gchar *caller_window = NULL;
+	g_return_val_if_fail (GCR_IS_PROMPT (prompt), NULL);
 	g_object_get (prompt, "caller-window", &caller_window, NULL);
 	return caller_window;
 }
@@ -659,6 +668,7 @@ gchar *
 gcr_prompt_get_continue_label (GcrPrompt *prompt)
 {
 	gchar *continue_label = NULL;
+	g_return_val_if_fail (GCR_IS_PROMPT (prompt), NULL);
 	g_object_get (prompt, "continue-label", &continue_label, NULL);
 	return continue_label;
 }
diff --git a/gcr/tests/files/prompt-tests/password-choice.prompt b/gcr/tests/files/prompt-tests/password-choice.prompt
index 2b68c75..5dfc676 100644
--- a/gcr/tests/files/prompt-tests/password-choice.prompt
+++ b/gcr/tests/files/prompt-tests/password-choice.prompt
@@ -5,3 +5,4 @@ message = Enter password for keyring 'xxx' to unlock
 description = An application wants to use a password in 'xxx', but it is locked
 choice-label = Always unlock this keyring whenever logged in.
 password-new = false
+continue-label = Unlock
-- 
2.7.4