Store prompts as comments

Issue: #15

Author: dspinellis

src/ai-cli-config

@@ -32,12 +32,14 @@ emacs = \C-xa
 
 ; Multishot command-specific prompts
 [prompt-gdb]
+comment = #
 user-1 = Disable breakpoint number 4
 assistant-1 = delete 4
 user-2 = break on line 67 of foo.cpp when flag is false,
 assistant-3 = break foo.cpp:67 if !flag
 
 [prompt-bash]
+comment = #
 user-1 = List files in current directory
 assistant-1 = ls
 user-2 = How many JavaScript files in the current directory contain the word bar?
@@ -46,6 +48,7 @@ user-3 = xyzzy
 assistant-3 = # Sorry I can't help.
 
 [prompt-sqlite3]
+comment = --
 user-1 = Show available tables
 assistant-1 = .tables
 user-2 = Show average of grade in table students
@@ -54,9 +57,13 @@ user-3 = xyzzy
 assistant-3 = -- Sorry I can't help.
 
 [prompt-bc]
+comment = #
 user-1 = Calculate 2 raised to the 64th power
 assistant-1 = 2^64
 user-2 = Increment variable i by 1
 assistant-2 = i++
 user-3 = xyzzy
 assistant-3 = /* Sorry I can't help. */
+
+[prompt-rl_driver]
+comment = #

src/ai_cli.5

@@ -1,4 +1,4 @@
-.TH AI_READLINE 5 "2023-12-12" "Diomidis Spinellis" \" -*-
+.TH AI_READLINE 5 "2024-03-17" "Diomidis Spinellis" \" -*-
  \" nroff -*
 
 .SH NAME
@@ -238,6 +238,14 @@ The multishot example prompts are provided by
 .B ai_cli
 at the beginning of each API request.
 
+.PP
+\fIcomment=\fR
+.RS 4
+The line comment sequence for the corresponding tool.
+If this is defined, then prompt lines are stored in the
+history and provided as context in the form of line comments.
+.RE
+
 .PP
 \fIuser-n=\fR
 .RS 4

src/ai_cli.c

@@ -28,6 +28,7 @@
 #include <readline/history.h>
 
 #include "config.h"
+#include "support.h"
 
 #include "fetch_anthropic.h"
 #include "fetch_hal.h"
@@ -52,6 +53,28 @@ static config_t config;
 
 char * (*fetch)(config_t *config, const char *prompt, int history_length);
 
+/*
+ * Add the specified prompt to the RL history, as a comment if the
+ * comment prefix is defined.
+ */
+static void
+add_prompt_to_history(const char *prompt)
+{
+	if (prompt == NULL)
+		return;
+
+	if (!config.prompt_comment_set) {
+		add_history(prompt);
+		return;
+	}
+
+	char *commented_prompt;
+	safe_asprintf(&commented_prompt, "%s %s", config.prompt_comment,
+	    prompt);
+	add_history(commented_prompt);
+	free(commented_prompt);
+}
+
 /*
  * The user has has asked for AI to be queried on the typed text
  * Replace the user's text with the queried on
@@ -66,23 +89,30 @@ query_ai(int count, int key)
 		prev_response = NULL;
 	}
 
-	add_history(*rl_line_buffer_ptr);
+	add_prompt_to_history(*rl_line_buffer_ptr);
 	char *response = fetch(&config, *rl_line_buffer_ptr,
 	    *history_length_ptr);
 	if (!response)
 		return -1;
 	rl_crlf();
 	rl_on_new_line();
-	rl_begin_undo_group();
 	rl_delete_text(0, *rl_end_ptr);
 	*rl_point_ptr = 0;
 	if (config.general_response_prefix_set) {
 		rl_insert_text(config.general_response_prefix);
 		rl_insert_text(" ");
 	}
 	rl_insert_text(response);
-	rl_end_undo_group();
 	prev_response = response;
+	/*
+	 * The readline_internal_teardown() function will restore
+	 * the original history line iff the line being edited
+	 * was originally in the history, AND the line has changed.
+	 * Avoid this by clearing the undo list.
+	 * This results in the commented prompt rather than the
+	 * ucommented prompt being stored in the history.
+	 */
+	rl_free_undo_list();
 	return 0;
 }
 

src/config.c

@@ -208,8 +208,9 @@ fixed_program_matcher(config_t *pconfig, const char* name, const char* value)
 			return 1; \
 		} \
 	} while (0)
-        MATCH_PROGRAM(system, safe_strdup);
+        MATCH_PROGRAM(comment, safe_strdup);
         MATCH_PROGRAM(context, strtocard);
+        MATCH_PROGRAM(system, safe_strdup);
 
 	return 0;
 }

src/config.h

@@ -82,6 +82,8 @@ typedef struct {
 	int prompt_context;		// # past prompts to provide as context
 	const char *prompt_system;	// System prompt
 
+	// Specific program's comment character to be prefixed in prompts
+	const char *prompt_comment;
 	// Up to three training shots for a specific program
 	const char *prompt_user[NPROMPTS];
 	const char *prompt_assistant[NPROMPTS];
@@ -129,6 +131,7 @@ typedef struct {
 	bool openai_model_set;
 	bool openai_temperature_set;
 
+	bool prompt_comment_set;
 	bool prompt_context_set;
 	bool prompt_system_set;
 } config_t;

src/rl_driver.c

@@ -30,10 +30,12 @@ main(int argc, char *argv[])
 {
 	char *s;
 
+	using_history();
 	while ((s = readline("> ")) != NULL) {
-		printf("Read [%s]\n", s);
+		printf("\nRead [%s]\n", s);
 		if (*s)
 			add_history(s);
+
 		free(s);
 	}
 }

src/support.c

@@ -101,6 +101,7 @@ range_strdup(const char *begin, const char *end)
 	return p;
 }
 
+// Store the formatted output in the dynamically allocated buffer strp
 int
 safe_asprintf(char **strp, const char *fmt, ...)
 {