From 6542dbd9ddf452c327722ea3427ffb248c2f1907 Mon Sep 17 00:00:00 2001 From: Dm1tr1y147 Date: Sun, 12 Jul 2020 19:04:19 +0500 Subject: [PATCH] Added global object for shell state and history suggestions on arrow up/down --- README.md | 4 +- include/complete.h | 8 +-- include/history.h | 8 +++ include/input.h | 2 + include/keys.h | 4 +- include/shell.h | 33 ++++++++++ include/tree.h | 4 +- include/utils.h | 2 - src/complete.c | 70 ++++++++++++++++++--- src/history.c | 46 ++++++++++++++ src/input.c | 27 +++++++-- src/keys.c | 147 ++++++++++++++++++++++++++++++++++++++++++++- src/main.c | 65 ++++++++++++++------ src/shell.c | 11 ++++ src/tree.c | 64 +++++++++++++++++--- src/utils.c | 34 +++++++++++ 16 files changed, 476 insertions(+), 53 deletions(-) create mode 100644 include/history.h create mode 100644 src/history.c diff --git a/README.md b/README.md index 0896c37..4b7bd26 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ Work is still in porgress, buf when you will see a "finished" topic assigned to * Running commands in separate process and termination them with `ctrl+c` * `cd`, `exit` and `exec` builtin commands * Files and commands from `/usr/bin` autocompletion on `Tab` keypress +* History of commands and navigation through it with `up/down` keys # Builtin commands * `cd`: changes current working directory to the one specified by user. If no arguments provided, shows error. @@ -20,5 +21,4 @@ Work is still in porgress, buf when you will see a "finished" topic assigned to * Replace linux `echo` command with builtin one with support of environmental variables * Environmental variables * `Ctrl+Z` running programm with `fd` -* Getting commands path from system `PATH` environment variable -* Create global struture for shell to save data between commands \ No newline at end of file +* Getting commands path from system `PATH` environment variable \ No newline at end of file diff --git a/include/complete.h b/include/complete.h index 740f4bc..cdd8963 100644 --- a/include/complete.h +++ b/include/complete.h @@ -12,9 +12,9 @@ #include bool check_if_executable(char *path, char *file_name); -size_t get_dir_list(char ***dir_list, char *path, int ex); -size_t get_complete_options(char ***opts, char *line, char **to_complete); -size_t complete_line(int *pos, int *n, char **line, char **out); -size_t filter_options(char ***comp_list, size_t *size, char *filter_string); +ssize_t get_dir_list(char ***dir_list, char *path, int ex); +ssize_t get_complete_options(char ***opts, char *line, char **to_complete); +ssize_t complete_line(int *pos, int *n, char **line, char **out); +ssize_t filter_options(char ***comp_list, ssize_t *size, char *filter_string); #endif \ No newline at end of file diff --git a/include/history.h b/include/history.h new file mode 100644 index 0000000..ac10b36 --- /dev/null +++ b/include/history.h @@ -0,0 +1,8 @@ +#ifndef _HISTORY_H +#define _HISTORY_H + +void append_to_history(char *line); +void clear_search_tree(); +char *previous_hist_entry(); + +#endif \ No newline at end of file diff --git a/include/input.h b/include/input.h index 58795e5..0a9e196 100644 --- a/include/input.h +++ b/include/input.h @@ -8,6 +8,8 @@ enum keys { DELETE_KEY = 1000, + UP_KEY, + DOWN_KEY, LEFT_KEY, RIGHT_KEY, HOME_KEY, diff --git a/include/keys.h b/include/keys.h index 4346281..8c7584b 100644 --- a/include/keys.h +++ b/include/keys.h @@ -4,12 +4,14 @@ #include void delete_key(int pos, int *n, char **line); +void up_key(int *pos, int *n, char **line); +void down_key(int *pos, int *n, char **line); void move_left(int *pos); void move_right(int *pos, int n); void home_key(int *pos); void end_key(int *pos, int n); void backspace_key(int *pos, int *n, char **line); -void new_line(); +void new_line(char *line); void tab_key(int *pos, int *n, char **line); void printable_key(int *pos, int *n, char c, char **line); diff --git a/include/shell.h b/include/shell.h index 77285a3..01b4a11 100644 --- a/include/shell.h +++ b/include/shell.h @@ -8,13 +8,46 @@ #include #include #include +#include #include #include +#include "../include/tree.h" + +// Defines #define BUFF_SIZE 1024 #define ARG_SIZE 32 +// Types definitions +struct hist_tree +{ + struct tree_node *r; + int length; + int pos; +}; + +struct history +{ + char **content; + int length; + int pos; + + struct hist_tree tree; +}; + +typedef struct +{ + int last_status; + struct history hist; + char **envs; +} t_; + +//Globals defenition +extern t_ term; +extern char *builtin[]; + +// Functions prototypes int process_line(char *line, char ***args); int launch(char **args); void process_command(); diff --git a/include/tree.h b/include/tree.h index f4e1820..de6a638 100644 --- a/include/tree.h +++ b/include/tree.h @@ -18,7 +18,7 @@ void insert_tree(struct tree_node *root, char *key); void free_tree(struct tree_node *root); int search_tree(struct tree_node *root, char *key); int is_last_node(struct tree_node *root); -size_t list_strings_containing(struct tree_node *root, char *key, char ***strings); -void get_all_substrings(struct tree_node *root, size_t *amount, char **curr_prefix, char ***strings); +ssize_t list_strings_containing(struct tree_node *root, char *key, char ***strings); +void get_all_substrings(struct tree_node *root, ssize_t *amount, char **curr_prefix, char ***strings); #endif \ No newline at end of file diff --git a/include/utils.h b/include/utils.h index a3b28b0..cedd6a8 100644 --- a/include/utils.h +++ b/include/utils.h @@ -8,8 +8,6 @@ #include #include -extern FILE *log_file; - #define log(fmt, ...) \ { \ log_file = fopen("/var/log/mshell.log", "a"); \ diff --git a/src/complete.c b/src/complete.c index 8df2a37..76b08db 100644 --- a/src/complete.c +++ b/src/complete.c @@ -3,6 +3,14 @@ #include "../include/tree.h" #include "../include/utils.h" +/** + * @brief Checks if file located at specified path is executable + * + * @param path + * @param file_name + * @return true + * @return false + */ bool check_if_executable(char *path, char *file_name) { char *file_path = malloc(strlen(path) + strlen(file_name) + 2); @@ -17,7 +25,15 @@ bool check_if_executable(char *path, char *file_name) return ret; } -size_t get_dir_list(char ***dir_list, char *path, int ex) +/** + * @brief Gets the list of files and directories at the specified path + * + * @param dir_list + * @param path + * @param ex + * @return ssize_t + */ +ssize_t get_dir_list(char ***dir_list, char *path, int ex) { DIR *dir; struct dirent *ent; @@ -28,7 +44,7 @@ size_t get_dir_list(char ***dir_list, char *path, int ex) return -1; } - size_t n = 0; + ssize_t n = 0; while ((ent = readdir(dir)) != NULL) { if (ex != 0 && !check_if_executable(path, ent->d_name)) @@ -50,10 +66,37 @@ size_t get_dir_list(char ***dir_list, char *path, int ex) return n; } -size_t get_complete_options(char ***opts, char *line, char **to_complete) +/** + * @brief Append builtin commands to the completions list + * + * @param commands_list + * @param size + * @return ssize_t + */ +ssize_t append_builtin_list(char ***commands_list, size_t *size) +{ + for (int i = 0; i < 3; i++) + { + (*size)++; + *commands_list = realloc(*commands_list, sizeof(char *) * *size); + (*commands_list)[*size - 1] = strdup(builtin[i]); + } + + return *size; +} + +/** + * @brief Gets the complete options based on user input + * + * @param opts + * @param line + * @param to_complete + * @return ssize_t + */ +ssize_t get_complete_options(char ***opts, char *line, char **to_complete) { char **args = NULL, **folders = malloc(0); - size_t sz; + ssize_t sz; int am = sep_string(line, &args, " "); @@ -98,12 +141,14 @@ size_t get_complete_options(char ***opts, char *line, char **to_complete) ABSOLUTE: *to_complete = strdup(line); sz = get_dir_list(opts, "/usr/bin", 1); + + append_builtin_list(opts, &sz); } free_str_arr(args); free_str_arr(folders); - if (sz == -1) + if (sz < 0) return sz; if ((*to_complete)[0] != '\0') @@ -114,10 +159,21 @@ size_t get_complete_options(char ***opts, char *line, char **to_complete) return sz; } -size_t filter_options(char ***comp_list, size_t *size, char *filter_string) +/** + * @brief Gets completing options which begins with user input + * + * @param comp_list + * @param size + * @param filter_string + * @return ssize_t + */ +ssize_t filter_options(char ***comp_list, ssize_t *size, char *filter_string) { + if (*size < 0) + return *size; + struct tree_node *child_dirs_root = get_new_node(); - for (size_t i = 0; i < *size; i++) + for (ssize_t i = 0; i < *size; i++) insert_tree(child_dirs_root, (*comp_list)[i]); char **folders = NULL; diff --git a/src/history.c b/src/history.c new file mode 100644 index 0000000..5524646 --- /dev/null +++ b/src/history.c @@ -0,0 +1,46 @@ +#include "../include/history.h" +#include "../include/shell.h" + +/** + * @brief Append entry to commands history + * + * @param line + */ +void append_to_history(char *line) +{ + if (term.hist.length > 0) + if (strcmp(line, term.hist.content[term.hist.length - 1]) == 0) + return; + + term.hist.length++; + term.hist.content = (char **)realloc(term.hist.content, term.hist.length * sizeof(char *)); + term.hist.content[term.hist.length - 1] = strdup(line); + + term.hist.pos = -1; +} + +/** + * @brief Clear history entries search tree + * + */ +void clear_search_tree() +{ + term.hist.tree.length = -1; + term.hist.tree.pos = -1; + free_tree(term.hist.tree.r); +} + +/** + * @brief Get previous history entry + * + * @param line + * @return char* + */ +char *previous_hist_entry(char *line) +{ + if (line == NULL) + { + term.hist.pos++; + return term.hist.content[term.hist.length - term.hist.pos - 1]; + } +} \ No newline at end of file diff --git a/src/input.c b/src/input.c index 05d14c4..55fef00 100644 --- a/src/input.c +++ b/src/input.c @@ -1,5 +1,6 @@ #include "../include/input.h" #include "../include/keys.h" +#include "../include/shell.h" /** * @brief Switches console raw mode @@ -46,6 +47,14 @@ char *read_line() delete_key(pos, &n, &line); break; + case UP_KEY: + up_key(&pos, &n, &line); + break; + + case DOWN_KEY: + down_key(&pos, &n, &line); + break; + case LEFT_KEY: move_left(&pos); break; @@ -67,7 +76,7 @@ char *read_line() break; case ENTER_KEY: - new_line(); + new_line(line); return line; break; @@ -122,21 +131,29 @@ int process_keypress(char c) } switch (seq[1]) { - case 'D': - return LEFT_KEY; + case 'A': + return UP_KEY; break; + case 'B': + return DOWN_KEY; + break; + case 'C': return RIGHT_KEY; break; - case 'H': - return HOME_KEY; + case 'D': + return LEFT_KEY; break; case 'F': return END_KEY; break; + + case 'H': + return HOME_KEY; + break; } } return ESCAPE_KEY; diff --git a/src/keys.c b/src/keys.c index 4cf9068..5fde5ee 100644 --- a/src/keys.c +++ b/src/keys.c @@ -3,6 +3,7 @@ #include "../include/utils.h" #include "../include/complete.h" #include "../include/shell.h" +#include "../include/history.h" /** * @brief Delete key action @@ -31,6 +32,133 @@ void delete_key(int pos, int *n, char **line) } } +/** + * @brief Up key action + * + * @param pos + * @param n + * @param line + */ +void up_key(int *pos, int *n, char **line) +{ + if (term.hist.pos + 1 == term.hist.length) + return; + + print_str("\033[K", 3); + (*line)[*pos] = '\0'; + + char *buff = strdup(""); + size_t buff_size = 1; + + if (*pos == 0) + { + *line = strdup(previous_hist_entry(NULL)); + *n = strlen(*line); + + append_to_buff(&buff, &buff_size, "\0337", 2); + append_to_buff(&buff, &buff_size, *line, *n); + append_to_buff(&buff, &buff_size, "\0338", 2); + + print_str(buff, buff_size); + free(buff); + } + else + { + if (term.hist.tree.length < 0) + { + term.hist.tree.r = get_new_node(); + for (int i = 0; i < term.hist.length; i++) + insert_tree(term.hist.tree.r, term.hist.content[i]); + + term.hist.tree.length = term.hist.length; + term.hist.tree.pos = 0; + } + + char **tmp_strings = malloc(0); + ssize_t sz = list_strings_containing(term.hist.tree.r, *line, &tmp_strings); + + if (sz < 1) + { + free(buff); + return; + } + + free(*line); + *line = strdup(tmp_strings[term.hist.tree.pos]); + *n = strlen(*line); + + append_to_buff(&buff, &buff_size, "\033[2K", 4); + append_to_buff(&buff, &buff_size, "\033[2A", 4); + + char *prompt = compose_prompt(); + append_to_buff(&buff, &buff_size, prompt, strlen(prompt)); + + append_to_buff(&buff, &buff_size, *line, *n); + for (int i = 0; i < *n - *pos; i++) + append_to_buff(&buff, &buff_size, "\033[D", 3); + + print_str(buff, buff_size); + free(buff); + + for (int i = 0; i < sz; i++) + insert_tree(term.hist.tree.r, tmp_strings[i]); + } +} + +/** + * @brief Down key action + * + * @param pos + * @param n + * @param line + */ +void down_key(int *pos, int *n, char **line) +{ + if (term.hist.pos < 0) + return; + + print_str("\033[K", 3); + (*line)[*pos] = '\0'; + + char *buff = strdup(""); + size_t buff_size = 1; + + if (term.hist.pos == 0) + { + term.hist.pos--; + + free(*line); + *line = strdup(buff); + *n = 0; + *pos = *n; + + for (int i = 0; i < *pos; i++) + append_to_buff(&buff, &buff_size, "\033[D", 3); + + append_to_buff(&buff, &buff_size, "\033[K", 3); + + print_str(buff, buff_size); + free(buff); + + return; + } + + if (*pos == 0) + { + term.hist.pos--; + *line = strdup(term.hist.content[term.hist.length - term.hist.pos - 1]); + *n = strlen(*line); + + append_to_buff(&buff, &buff_size, "\0337", 2); + append_to_buff(&buff, &buff_size, *line, *n); + append_to_buff(&buff, &buff_size, "\0338", 2); + + print_str(buff, buff_size); + free(buff); + } + +} + /** * @brief Arrow left key action * @@ -38,6 +166,7 @@ void delete_key(int pos, int *n, char **line) */ void move_left(int *pos) { + clear_search_tree(); if (*pos > 0) { print_str("\033[D", 3); @@ -67,6 +196,7 @@ void move_right(int *pos, int n) */ void home_key(int *pos) { + clear_search_tree(); char *buff = strdup(""); size_t buff_size = 1; @@ -87,7 +217,7 @@ void home_key(int *pos) */ void end_key(int *pos, int n) { - char *buff =strdup(""); + char *buff = strdup(""); size_t buff_size = 1; for (int i = 0; i < n - *pos; i++) @@ -111,6 +241,8 @@ void backspace_key(int *pos, int *n, char **line) { if (*pos > 0) { + clear_search_tree(); + remove_on_pos(line, *pos); (*n)--; (*pos)--; @@ -134,13 +266,24 @@ void backspace_key(int *pos, int *n, char **line) * @brief Enter key action * */ -void new_line() +void new_line(char *line) { + append_to_history(line); + clear_search_tree(); print_str("\n", 1); } +/** + * @brief Tab key action + * + * @param pos + * @param n + * @param line + */ void tab_key(int *pos, int *n, char **line) { + clear_search_tree(); + (*line)[*pos] = '\0'; *line = realloc(*line, strlen(*line) + 1); diff --git a/src/main.c b/src/main.c index 6c4f003..3b98a9c 100644 --- a/src/main.c +++ b/src/main.c @@ -6,32 +6,57 @@ #include "../include/utils.h" #include "../include/shell.h" -FILE *log_file; - -void exit_shell() -{ - change_mode(0); -} +// Definitions +t_ term; +void exit_shell(); +t_ init_term(); +// Main int main(int argc, char **argv) { - log_file = fopen("/var/log/mshell.log", "w"); - if (log_file == NULL) - { - fprintf(stderr, "Couldn't open log file\n"); - } - else { - fprintf(log_file, "\n New session:\n"); - fclose(log_file); - } - - change_mode(1); - signal(SIGINT, SIG_IGN); - - atexit(exit_shell); + term = init_term(); while (1) { process_command(); } +} + +// Init +t_ init_term() +{ + t_ term; + + FILE *log_file = fopen("/var/log/mshell.log", "w"); + if (log_file == NULL) + { + fprintf(stderr, "Couldn't open log file\n"); + } + else + { + fprintf(log_file, "\n New session:\n"); + fclose(log_file); + } + + change_mode(1); + + term.hist.length = 0; + term.hist.pos = -1; + term.hist.content = (char **)malloc(sizeof(char *) * term.hist.length); + + term.hist.tree.length = -1; + term.hist.tree.pos = -1; + term.hist.tree.r = NULL; + + signal(SIGINT, SIG_IGN); + + atexit(exit_shell); + + return term; +} + +// Exit +void exit_shell() +{ + change_mode(0); } \ No newline at end of file diff --git a/src/shell.c b/src/shell.c index bb1e757..8d3db7c 100644 --- a/src/shell.c +++ b/src/shell.c @@ -144,6 +144,12 @@ int sh_exit(char **args) exit(0); } +/** + * @brief Shell builtin command. Executes command replacing shell with it + * + * @param args + * @return int + */ int sh_exec(char **args) { change_mode(0); @@ -160,6 +166,11 @@ int sh_exec(char **args) exit(EXIT_FAILURE); } +/** + * @brief Creates prompt string + * + * @return char* + */ char *compose_prompt() { char *prompt = strdup("\n"); diff --git a/src/tree.c b/src/tree.c index e53e190..1995165 100644 --- a/src/tree.c +++ b/src/tree.c @@ -1,5 +1,10 @@ #include "../include/tree.h" +/** + * @brief Create new trie tree + * + * @return struct tree_node* + */ struct tree_node *get_new_node() { struct tree_node *node = (struct tree_node *)malloc(sizeof(struct tree_node)); @@ -13,6 +18,12 @@ struct tree_node *get_new_node() return node; } +/** + * @brief Inserts a string into trie + * + * @param root + * @param key + */ void insert_tree(struct tree_node *root, char *key) { struct tree_node *current = root; @@ -31,20 +42,35 @@ void insert_tree(struct tree_node *root, char *key) current->is_leaf = 1; } +/** + * @brief Frees memory allocated for trie + * + * @param root + */ void free_tree(struct tree_node *root) { - for (int i = 0; i < ALPHABET_SIZE; i++) + if (root != NULL) { - if (root->child[i] != NULL) + for (int i = 0; i < ALPHABET_SIZE; i++) { - free_tree(root->child[i]); + if (root->child[i] != NULL) + { + free_tree(root->child[i]); + } } - } - free(root); + free(root); + } return; } +/** + * @brief Checks if key is in trie + * + * @param root + * @param key + * @return int + */ int search_tree(struct tree_node *root, char *key) { struct tree_node *current = root; @@ -64,6 +90,12 @@ int search_tree(struct tree_node *root, char *key) return (current != NULL && current->is_leaf); } +/** + * @brief Checks if trie node is last + * + * @param root + * @return int + */ int is_last_node(struct tree_node *root) { for (int i = 0; i < ALPHABET_SIZE; i++) @@ -73,9 +105,17 @@ int is_last_node(struct tree_node *root) return 1; } -size_t list_strings_containing(struct tree_node *root, char *key, char ***strings) +/** + * @brief Lists all strings in trie begining with key + * + * @param root + * @param key + * @param strings + * @return ssize_t + */ +ssize_t list_strings_containing(struct tree_node *root, char *key, char ***strings) { - size_t amount = 0; + ssize_t amount = 0; free(*strings); @@ -119,7 +159,15 @@ size_t list_strings_containing(struct tree_node *root, char *key, char ***string return -1; } -void get_all_substrings(struct tree_node *root, size_t *amount, char **curr_prefix, char ***strings) +/** + * @brief Recursive substrings search for list_strings_containing + * + * @param root + * @param amount + * @param curr_prefix + * @param strings + */ +void get_all_substrings(struct tree_node *root, ssize_t *amount, char **curr_prefix, char ***strings) { if (root->is_leaf) { diff --git a/src/utils.c b/src/utils.c index bcd6a9b..085dad7 100644 --- a/src/utils.c +++ b/src/utils.c @@ -46,6 +46,14 @@ void remove_on_pos(char **str, int pos) fprintf(stderr, "Can't remove symbol outside the string\n"); } +/** + * @brief Separates string with "sep" characters + * + * @param line + * @param toks + * @param sep + * @return int + */ int sep_string(char *line, char ***toks, char *sep) { free(*toks); @@ -67,6 +75,12 @@ int sep_string(char *line, char ***toks, char *sep) return n; } +/** + * @brief Removes extra spaces + * + * @param str + * @return char* + */ char *trim_string(char **str) { while ((*str)[0] == ' ') @@ -82,6 +96,11 @@ char *trim_string(char **str) return *str; } +/** + * @brief Frees array of strings + * + * @param arr + */ void free_str_arr(char **arr) { if (arr[0] != NULL) @@ -90,6 +109,15 @@ void free_str_arr(char **arr) free(arr); } +/** + * @brief Creates a slice of array + * + * @param arr + * @param beg + * @param end + * @param asc + * @return char** + */ char **slice_array(char **arr, int beg, int end, bool asc) { if (beg == -1) @@ -109,6 +137,12 @@ char **slice_array(char **arr, int beg, int end, bool asc) return new_arr; } +/** + * @brief Gets size of null-terminated array + * + * @param arr + * @return int + */ int get_null_term_arr_size(char **arr) { int k = 0;