Add API to allow reading & writing history to file #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

jeanbaptistelab wants to merge 52 commits into master from feature/SI-4830-persist-csh-command-history-across-session-a-la-b

include/slash/dflopt.h

-Original file line number
+Diff line change
@@ -1,5 +1,9 @@
     #pragma once
+    /* TODO: determine when to enable this */
+    #if 0
+    #pragma GCC warning "dflopt.h is deprecated, use  #include <apm/csh_api.h> instead"
+    #endif
     #include <slash/slash.h>
     #include <slash/optparse.h>
@@ Expand All / @@ -15,5 +19,3 @@ extern unsigned int rdp_dfl_ack_timeout; @@
     extern unsigned int rdp_dfl_ack_count;
     void rdp_opt_add(optparse_t * parser);
-    void rdp_opt_set();
-    void rdp_opt_reset();

include/slash/optparse.h

-Original file line number
+Diff line change
@@ Expand Up / @@ -13,7 +13,29 @@ @@
     typedef struct optparse optparse_t;
     typedef struct optparse_opt optparse_opt_t;
+    /**
+     * @brief Create a new option parser context, remeber to free it using optparse_del() when done
+     * @param progname name to be associated with the option parser
+     * @param arg_summary short list of optional command line options and arguments
+     * @return pointer to new context, NULL if something went wrong
+     * @warning the progname and arg_summary arguments, if not NULL, must be valid for the entire lifecycle of the option parser!
+     */
     optparse_t *optparse_new(const char *progname, const char *arg_summary);
+    /**
+     * @brief Create a new options parser context, remeber to free it using optparse_del() when done
+     * @param progname name to be associated with the option parser
+     * @param arg_summary short list of optional command line options and arguments, can be NULL if not relevant
+     * @param help longer description of the command, can be NULL if not relevant.
+     * @return pointer to new context, NULL if something went wrong
+     * @warning the progname, arg_summary and help arguments, if not NULL, must be valid for the entire lifecycle of the option parser!
+     */
+    optparse_t *optparse_new_ex(const char *progname, const char *arg_summary, const char *help);
+    /**
+     * @brief Release the memory for the given option parser object
+     * @param parser pointer to valid option parser obtained by calling optparse_new() or optparse_new_ex()
+     */
     void optparse_del(optparse_t *parser);
     int optparse_parse(optparse_t *parser, int argc, const char *argv[]);
@@ Expand All @@
     optparse_opt_t *optparse_add_string(optparse_t *parser, int short_opt, const char *long_opt, const char *arg_desc, char **ptr, char *help);
+    /**
+     * @brief interface to be implemented for custom option parsers
+     *
+     * This function will be called by the optparse framework when it processes an
+     * option for which this custom option value function was registered
+     * @param data an opaque pointer where the parsed option value must be stored
+     * @param arg the part of the command line containing the option value as a string to be parsed
+     */
+    typedef int (*optparse_custom_func_t)(void *data, const char * arg);
+    /**
+     * @brief Register an option with a custom parser (see the "func" param)
+     * @param parser pointer to valid optparse object the option will be attached to
+     * @param short_opt single character option (for example: 'c' for the corresponding "-c" cmd line option). Set to '\0' if you do not want a short option
+     * @param long_opt string option (for example "test" for the corresponding "--test" cmd line option). Set to NULL if you do not want a long option
+     * @param arg_desc string describing the argument (will be shown when help is invoked), may be NULL
+     * @param help string describing waht this option is/does
+     * @param func ptr to a cutom option value parser, see the optparse_custom_func_t typedef documentation
+     * @param data opaque pointer to a valid memory where the "func" above will store the parsed option value
+     * @return reference to newly created optparse_opt_t object
+     */
+    optparse_opt_t *optparse_add_custom(optparse_t * parser, int short_opt, const char * long_opt, const char * arg_desc, const char * help, optparse_custom_func_t func, void * data);
     #endif /* _OPTPARSE_H */

include/slash/slash.h

-Original file line number
+Diff line change
@@ Expand Up / @@ -26,6 +26,7 @@ @@
     #include <stddef.h>
     #include <stdbool.h>
+    #include <stdio.h>
     #include <slash_config.h>
@@ Expand Down Expand Up / @@ -60,6 +61,7 @@ @@
     		.func  = _func,\
     		.completer  = _completer,\
     		.args  = _args,\
+    		.help = _help, \
             .next = {NULL},  /* Next pointer in case the user wants to implement custom ordering within or across APMs.
     							It should not required by the default implementation. */\
     	};
@@ Expand Down Expand Up / @@ -96,6 +98,7 @@ @@
     /* Command prototype */
     struct slash;
     typedef int (*slash_func_t)(struct slash *slash);
+    typedef int (*slash_func_context_t)(struct slash *slash, void *context);
     /* Wait function prototype,
      * this function is implemented by user, so use a void* instead of struct slash* */
@@ Expand All @@
     struct slash_command {
     	/* Static data */
     	char *name;
-    	const slash_func_t func;
+    	union {
+    		/* Traditional function used by the `slash_command()` macros. */
+    		const slash_func_t func;
+    		/* Function with context pointer, for advanced API usage. */
+    		const slash_func_context_t func_ctx;
+    	};
     	const char *args;
+    	const char *help;
     	const slash_completer_func_t completer;
     	/* Next pointer in case the user wants to implement custom ordering within or across APMs.
     		It should not required by the default implementation. */
     	/* single linked list:
     	 * The weird definition format comes from sys/queue.h SLINST_ENTRY() macro */
         struct { struct slash_command *sle_next; } next;
+    	/* Optional context pointer (after `next` for ABI compatibility).
+    		Will be supplied to `func_ctx` if specified.  */
+    	void *context;
     };
     /* Slash context */
@@ Expand All / @@ -140,6 +153,8 @@ struct slash { @@
     	int fd_read;
     	slash_waitfunc_t waitfunc;
     	bool use_activate;
+    	int signal;
+    	int busy;
     	/* Line editing */
     	size_t line_size;
@@ Expand All / @@ -161,7 +176,7 @@ struct slash { @@
     	char *history_head;
     	char *history_tail;
     	char *history_cursor;
+    	FILE *history_file;
     	/* Command interface */
     	char **argv;
     	int argc;
@@ Expand All / @@ -176,8 +191,12 @@ struct slash { @@
         /* Command list */
         struct slash_command * cmd_list;
-    	/* Completions */
-    	bool in_completion;
+    	/* Allow calling complete functions while already in in one of those functions.
+    	 * Use case: when completing "help", you only want to complete the *name* of commands to get help for
+    	 * BUT while completing "watch" (or watch-like commands), you want to carry on completing as much as possible,
+    	 * for instance, typing: "w<TAB>g<TAB>s<TAB>" would result in the completed command line "watch get serial0" in 6 keystrokes
+    	 */
+    	bool complete_in_completion;
     };
     /**
@@ Expand All / @@ -195,13 +214,53 @@ void slash_destroy(struct slash *slash); @@
     char *slash_readline(struct slash *slash);
+    void slash_sigint(struct slash *slash, int signum);
     /**
      * @brief Implement this function to do something with the current line (logging, etc)
      *
      * @param line the slash line about to be executed
      */
     void slash_on_execute_hook(const char *line);
+    /**
+     * @param line the slash line which was just executed
+     */
+    void slash_on_execute_post_hook(const char *line, struct slash_command *command);
+    /**
+     * @brief Will be called before a file is executed by "run <file>", implement it to set environment variables for example.
+     *
+     * @param filename name of the file to be executed.
+     * @param ctx_for_post Assignable context pointer which will be passed to the corresponding post_hook call. If it is malloc, it should be freed in the post-hook.
+     */
+    void slash_on_run_pre_hook(const char * const filename, void ** ctx_for_post);
+    /**
+     * @brief Will be called after a file has been executed by "run <file>", implement it to set clear variables for example.
+     *
+     * @param filename name of the file which was executed.
+     * @param ctx customizable context from corresponding pre-hook.
+     */
+    void slash_on_run_post_hook(const char * const filename, void * ctx);
+    typedef char *(*slash_process_cmd_line_hook_t)(const char *line);
+    /**
+     * @brief Set this variable to a function if you wish to modify the command line about to be executed
+     *
+     * @param line the slash line about to be executed
+     * @return a malloc'ed pointer to the processed command line, this will be free()'d for you, NULL is a valid
+     * return value and will cause the original line to be used as-is.
+     */
+    extern slash_process_cmd_line_hook_t slash_process_cmd_line_hook;
+    /**
+     * @brief Set this variable to a function if you wish to execute general completions after specific completions have been executed
+     * @see slash_completer_func_t
+     */
+    extern slash_completer_func_t slash_global_completer;
     int slash_execute(struct slash *slash, char *line);
     int slash_loop(struct slash *slash);
@@ Expand Down Expand Up @@
     int slash_run(struct slash *slash, char * filename, int printcmd);
+    /**
+     * @brief Populate Slash history buffer with the content of the given file
+     * @param slash pointer to valid slash context
+     * @param history_filename filename to use (will be created if it doesn't exist) to read and write history
+     */
+    void slash_init_history_from_file(struct slash *slash, const char *history_filename);
     void slash_history_add(struct slash *slash, char *line);
     typedef struct slash_list_iterator_s {
@@ Expand All / @@ -251,4 +317,19 @@ int slash_list_add(struct slash_command * item); @@
     int slash_list_remove(const struct slash_command * item);
     int slash_list_init();
+    /**
+     * @brief let slash handle stdout/stdin
+     * @param slash pointer to valid slash instance
+     */
+    void slash_acquire_std_in_out(struct slash *slash);
+    /**
+     * @brief let slash release handling of stdout/stdin to default. Use this function if you have for instance an APM that needs stdin/stdout control
+     * @warning remember to call slash_acquire_std_in_out when you are done!
+     * @param slash pointer to valid slash instance
+     * @return 0 if success, -ENOTTY in case of failure
+     */
+    void slash_release_std_in_out(struct slash *slash);
     #endif /* _SLASH_H_ */

meson.build

-Original file line number
+Diff line change
@@ Expand Up / @@ -10,7 +10,6 @@ slash_sources = files([ @@
     if get_option('builtins')
     	slash_sources += files([
     		'src/builtins.c',
-    		'src/dflopt.c',
     		'src/run.c',
     	])
     endif
@@ Expand Down Expand Up / @@ -40,9 +39,14 @@ slash_lib = library('slash', @@
     	dependencies : dependencies,
     	install : false,
     )
     slash_dep = declare_dependency(
     	include_directories : slash_inc,
     	link_with : slash_lib,
     )
+    slash_link_whole_dep = declare_dependency(
+    	include_directories : slash_inc,
+    	link_with : slash_lib,
+    	link_whole: [slash_lib]
+    )

src/builtins.c

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -2,9 +2,9 @@
  
    #include <stdlib.h>

    #include <string.h>

    #include <stdbool.h>

    #include <time.h>

    #include <slash/slash.h>

    #include <slash/dflopt.h>

    #include <slash/optparse.h>

    #include <slash/completer.h>

    @@ -99,7 +99,7 @@ slash_command(confirm, slash_builtin_confirm, "", "Block until user confirmation
  
    static int slash_builtin_watch(struct slash *slash)

    {

    	unsigned int interval = slash_dfl_timeout;

    	unsigned int interval = 1000;

    	unsigned int count = 0;

        optparse_t * parser = optparse_new("watch", "<command...>");

    @@ -130,19 +130,31 @@ static int slash_builtin_watch(struct slash *slash)
  
    		char cmd_exec[slash->line_size];

    		strncpy(cmd_exec, line, slash->line_size);

    		/* Read time it takes to execute command */

    		struct timespec time_before, time_after;

    		clock_gettime(CLOCK_MONOTONIC, &time_before);

    		/* Execute command */

    		slash_execute(slash, cmd_exec);

    		clock_gettime(CLOCK_MONOTONIC, &time_after);

    		if ((count > 0) && (count-- == 1)) {

    				break;

    		}		

    		/* Calculate remaining time to ensure execution is running no more often than what interval dictates */

    		unsigned int elapsed = (time_after.tv_sec-time_before.tv_sec)*1000 + (time_after.tv_nsec-time_before.tv_nsec)/1000000;

    		unsigned int remaining = 0;

    		if (interval > elapsed) remaining = interval - elapsed;

    		/* Delay (press enter to exit) */

    		if (slash_wait_interruptible(slash, interval) != 0)

    		if (slash_wait_interruptible(slash, remaining) != 0)

    			break;

    	}

    	optparse_del(parser);

    	return SLASH_SUCCESS;

    }

    slash_command_completer(watch, slash_builtin_watch, slash_watch_completer, "<command...>", "Repeat a command")

src/builtins.h

-Original file line number
+Diff line change
@@ Expand Up / @@ -3,12 +3,17 @@ @@
     #include <sys/types.h>
+    /* Configuration */
+    #define SLASH_ARG_MAX		32	/* Maximum number of arguments */
+    #define SLASH_SHOW_MAX		25	/* Maximum number of commands to list */
     /* Declarations for required implementation functions in slash.c */
     void slash_command_usage(struct slash *slash, struct slash_command *command);
     char *slash_history_increment(struct slash *slash, char *ptr);
     int slash_putchar(struct slash *slash, char c);
     struct slash_command * slash_command_find(struct slash *slash, char *line, size_t linelen, char **args);
     void slash_command_description(struct slash *slash, struct slash_command *command);
+    int slash_build_args(char *args, char **argv, int *argc);
     /* Define and initialize section variables */
     /* __attribute__((visibility("hidden"))) prevents the section symbols from linking with
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add API to allow reading & writing history to file #9

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Add API to allow reading & writing history to file #9

Are you sure you want to change the base?

Uh oh!

Add API to allow reading & writing history to file #9

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!