Added command and tools subdirs to source

src/command/command.h

@@ -0,0 +1,52 @@
+/*
+ * command.h
+ *
+ * Copyright (C) 2012, 2013 James Booth <boothj5@gmail.com>
+ *
+ * This file is part of Profanity.
+ *
+ * Profanity is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Profanity is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Profanity.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef COMMAND_H
+#define COMMAND_H
+
+#include <glib.h>
+
+// Command help strings
+struct cmd_help_t {
+    const gchar *usage;
+    const gchar *short_help;
+    const gchar *long_help[50];
+};
+
+void cmd_init(void);
+void cmd_close(void);
+
+void cmd_autocomplete(char *input, int *size);
+void cmd_reset_autocomplete(void);
+
+gboolean cmd_execute(const char * const command, const char * const inp);
+gboolean cmd_execute_default(const char * const inp);
+
+GSList * cmd_get_basic_help(void);
+GSList * cmd_get_settings_help(void);
+GSList * cmd_get_presence_help(void);
+
+void cmd_history_append(char *inp);
+char *cmd_history_previous(char *inp, int *size);
+char *cmd_history_next(char *inp, int *size);
+
+#endif

src/command/history.c

@@ -0,0 +1,69 @@
+/*
+ * command_history.c
+ *
+ * Copyright (C) 2012, 2013 James Booth <boothj5@gmail.com>
+ *
+ * This file is part of Profanity.
+ *
+ * Profanity is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Profanity is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Profanity.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include "tools/history.h"
+
+#define MAX_HISTORY 100
+
+static History history;
+
+void _stringify_input(char *inp, int size, char *string);
+
+void
+cmd_history_init(void)
+{
+    history = history_new(MAX_HISTORY);
+}
+
+void
+cmd_history_append(char *inp)
+{
+    history_append(history, inp);
+}
+
+char *
+cmd_history_previous(char *inp, int *size)
+{
+    char inp_str[*size + 1];
+    _stringify_input(inp, *size, inp_str);
+
+    return history_previous(history, inp_str);
+}
+
+char *
+cmd_history_next(char *inp, int *size)
+{
+    char inp_str[*size + 1];
+    _stringify_input(inp, *size, inp_str);
+
+    return history_next(history, inp_str);
+}
+
+void
+_stringify_input(char *inp, int size, char *string)
+{
+    int i;
+    for (i = 0; i < size; i++) {
+        string[i] = inp[i];
+    }
+    string[size] = '\0';
+}

src/command/history.h

@@ -0,0 +1,28 @@
+/*
+ * command_history.h
+ *
+ * Copyright (C) 2012, 2013 James Booth <boothj5@gmail.com>
+ *
+ * This file is part of Profanity.
+ *
+ * Profanity is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Profanity is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Profanity.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef COMMAND_HISTORY_H
+#define COMMAND_HISTORY_H
+
+void cmd_history_init(void);
+
+#endif

src/command/parser.c

@@ -0,0 +1,263 @@
+/*
+ * command_parser.c
+ *
+ * Copyright (C) 2012, 2013 James Booth <boothj5@gmail.com>
+ *
+ * This file is part of Profanity.
+ *
+ * Profanity is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Profanity is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Profanity.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include <stdlib.h>
+#include <string.h>
+
+#include <glib.h>
+
+/*
+ * Take a full line of input and return an array of strings representing
+ * the arguments of a command.
+ * If the number of arguments found is less than min, or more than max
+ * NULL is returned.
+ *
+ * inp - The line of input
+ * min - The minimum allowed number of arguments
+ * max - The maxmimum allowed number of arguments
+ *
+ * Returns - An NULL terminated array of strings representing the aguments
+ * of the command, or NULL if the validation fails.
+ *
+ * E.g. the following input line:
+ *
+ * /cmd arg1 arg2
+ *
+ * Will return a pointer to the following array:
+ *
+ * { "arg1", "arg2", NULL }
+ *
+ */
+gchar **
+parse_args(const char * const inp, int min, int max)
+{
+    if (inp == NULL) {
+        return NULL;
+    }
+
+    // copy and strip input of leading/trailing whitepsace
+    char *copy = strdup(inp);
+    g_strstrip(copy);
+
+    int inp_size = strlen(copy);
+    gboolean in_token = FALSE;
+    gboolean in_quotes = FALSE;
+    char *token_start = &copy[0];
+    int token_size = 0;
+    GSList *tokens = NULL;
+
+    // add tokens to GSList
+    int i;
+    for (i = 0; i <= inp_size; i++) {
+        if (!in_token) {
+            if (copy[i] == ' ') {
+                continue;
+            } else {
+                in_token = TRUE;
+                if (copy[i] == '"') {
+                    in_quotes = TRUE;
+                    i++;
+                }
+                token_start = &copy[i];
+                token_size++;
+            }
+        } else {
+            if (in_quotes) {
+                if ((copy[i] == '\0') || (copy[i] == '"')) {
+                    tokens = g_slist_append(tokens, g_strndup(token_start,
+                        token_size));
+                    token_size = 0;
+                    in_token = FALSE;
+                    in_quotes = FALSE;
+                } else {
+                    token_size++;
+                }
+            } else {
+                if (copy[i] == ' ' || copy[i] == '\0') {
+                    tokens = g_slist_append(tokens, g_strndup(token_start,
+                        token_size));
+                    token_size = 0;
+                    in_token = FALSE;
+                } else {
+                    token_size++;
+                }
+            }
+        }
+    }
+
+    int num = g_slist_length(tokens) - 1;
+
+    // if num args not valid return NULL
+    if ((num < min) || (num > max)) {
+        g_slist_free_full(tokens, free);
+        g_free(copy);
+        return NULL;
+
+    // if min allowed is 0 and 0 found, return empty char* array
+    } else if (min == 0 && num == 0) {
+        g_slist_free_full(tokens, free);
+        gchar **args = malloc((num + 1) * sizeof(*args));
+        args[0] = NULL;
+        g_free(copy);
+        return args;
+
+    // otherwise return args array
+    } else {
+        gchar **args = malloc((num + 1) * sizeof(*args));
+        GSList *token = tokens;
+        token = g_slist_next(token);
+        int arg_count = 0;
+
+        while (token != NULL) {
+            args[arg_count++] = strdup(token->data);
+            token = g_slist_next(token);
+        }
+
+        args[arg_count] = NULL;
+        g_slist_free_full(tokens, free);
+        g_free(copy);
+
+        return args;
+    }
+}
+
+/*
+ * Take a full line of input and return an array of strings representing
+ * the arguments of a command.  This function handles when the last parameter
+ * to the command is free text e.g.
+ *
+ * /msg user@host here is a message
+ *
+ * If the number of arguments found is less than min, or more than max
+ * NULL is returned.
+ *
+ * inp - The line of input
+ * min - The minimum allowed number of arguments
+ * max - The maxmimum allowed number of arguments
+ *
+ * Returns - An NULL terminated array of strings representing the aguments
+ * of the command, or NULL if the validation fails.
+ *
+ * E.g. the following input line:
+ *
+ * /cmd arg1 arg2 some free text
+ *
+ * Will return a pointer to the following array:
+ *
+ * { "arg1", "arg2", "some free text", NULL }
+ *
+ */
+gchar **
+parse_args_with_freetext(const char * const inp, int min, int max)
+{
+    if (inp == NULL) {
+        return NULL;
+    }
+
+    // copy and strip input of leading/trailing whitepsace
+    char *copy = strdup(inp);
+    g_strstrip(copy);
+
+    int inp_size = strlen(copy);
+    gboolean in_token = FALSE;
+    gboolean in_freetext = FALSE;
+    gboolean in_quotes = FALSE;
+    char *token_start = &copy[0];
+    int token_size = 0;
+    int num_tokens = 0;
+    GSList *tokens = NULL;
+
+    // add tokens to GSList
+    int i;
+    for (i = 0; i <= inp_size; i++) {
+        if (!in_token) {
+            if (copy[i] == ' ') {
+                continue;
+            } else {
+                in_token = TRUE;
+                num_tokens++;
+                if (num_tokens == max + 1) {
+                    in_freetext = TRUE;
+                } else if (copy[i] == '"') {
+                    in_quotes = TRUE;
+                    i++;
+                }
+                token_start = &copy[i];
+                token_size++;
+            }
+        } else {
+            if (in_quotes) {
+                if ((copy[i] == '\0') || (copy[i] == '"')) {
+                    tokens = g_slist_append(tokens, g_strndup(token_start,
+                        token_size));
+                    token_size = 0;
+                    in_token = FALSE;
+                    in_quotes = FALSE;
+                } else {
+                    token_size++;
+                }
+            } else {
+                if ((!in_freetext && copy[i] == ' ') || copy[i] == '\0') {
+                    tokens = g_slist_append(tokens, g_strndup(token_start,
+                        token_size));
+                    token_size = 0;
+                    in_token = FALSE;
+                } else {
+                    token_size++;
+                }
+            }
+        }
+    }
+
+    int num = g_slist_length(tokens) - 1;
+
+    // if num args not valid return NULL
+    if ((num < min) || (num > max)) {
+        g_slist_free_full(tokens, free);
+        free(copy);
+        return NULL;
+
+    // if min allowed is 0 and 0 found, return empty char* array
+    } else if (min == 0 && num == 0) {
+        gchar **args = malloc((num + 1) * sizeof(*args));
+        args[0] = NULL;
+        return args;
+
+    // otherwise return args array
+    } else {
+        gchar **args = malloc((num + 1) * sizeof(*args));
+        GSList *token = tokens;
+        token = g_slist_next(token);
+        int arg_count = 0;
+
+        while (token != NULL) {
+            args[arg_count++] = strdup(token->data);
+            token = g_slist_next(token);
+        }
+
+        args[arg_count] = NULL;
+        g_slist_free_full(tokens, free);
+        free(copy);
+
+        return args;
+    }
+}

src/command/parser.h

@@ -0,0 +1,31 @@
+/*
+ * parser.h
+ *
+ * Copyright (C) 2012, 2013 James Booth <boothj5@gmail.com>
+ *
+ * This file is part of Profanity.
+ *
+ * Profanity is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Profanity is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Profanity.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef PARSER_H
+#define PARSER_H
+
+#include <glib.h>
+
+gchar** parse_args(const char * const inp, int min, int max);
+gchar** parse_args_with_freetext(const char * const inp, int min, int max);
+
+#endif