Refactor commands to open files in Godot

Closes #11

gdscript-customization.el

@@ -110,12 +110,5 @@ PATH."
   "The path to the Godot executable.
 By default, it assumes that the executable is in the system's
 PATH."
-  :type 'string
-  :group 'gdscript)
-
-(defcustom gdscript-shell-buffer-name "*Godot*"
-  "Default buffer name for Godot running process."
-  :type 'string
   :type 'string
-  :safe 'stringp)
   :group 'gdscript)

gdscript-godot.el

@@ -0,0 +1,116 @@
+;;; gdscript-godot.el --- Open and run projects in Godot -*- lexical-binding: t; -*-
+;;
+;; Copyright (C) 2020 GDQuest and contributors
+;;
+;; Author: Franco Eusébio Garcia <francoegarcia@outlook.com>, Nathan Lovato <nathan@gdquest.com>
+;; URL: https://github.com/GDQuest/emacs-gdscript-mode/
+;; Version: 1.0.0
+;; Package-Requires: ((emacs "26.3"))
+;; Maintainer: nathan@gdquest.com
+;; Created: Mar 2020
+;; Keywords: languages
+;;
+;; This file is not part of GNU Emacs.
+;;
+;; This program 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.
+
+;; This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+;;
+;;; Commentary:
+;;
+;;  Open files, projects, and run commands in the Godot engine or editor.
+;;  This package contains commands that runs Godot processes.
+;;
+;;; Code:
+
+(require 'gdscript-customization)
+(require 'gdscript-utils)
+
+;;;###autoload
+(defun gdscript-run-command (cmd &optional show)
+  "Run a Godot process.
+Input and output via buffer named after `*godot*'. If there is a process
+already running in that buffer, just switch to it.
+
+With argument, allows you to define CMD so you can edit the
+command used to call the interpreter.
+When numeric prefix arg is other than 0 or 4 do not SHOW."
+  (interactive
+   (if current-prefix-arg
+       (list
+        (read-string "Run Godot: " (gdscript-godot--build-shell-command))
+        (y-or-n-p "Make dedicated process? ")
+        (= (prefix-numeric-value current-prefix-arg) 4))
+     (list (gdscript-godot--build-shell-command) nil t)))
+  (start-process-shell-command "Godot Process" (if show
+                                                   "*godot*" nil) cmd))
+
+(defun gdscript-godot--build-shell-command (&optional path)
+  "Build a shell command to with the Godot executable.
+
+If PATH is not provided, try to find it using the current
+file's directory as starting point."
+  (let* ((project-path (or path (gdscript-util--find-project-configuration-file))))
+    (concat gdscript-godot-executable " --path " project-path)))
+
+(defun gdscript-godot-open-project-in-editor ()
+  "Run Godot Engine Editor."
+  (interactive)
+  (gdscript-run-command
+   (concat (gdscript-godot--build-shell-command) " -e")))
+
+(defun gdscript-godot-run-project ()
+  "Run the current project in Godot Engine."
+  (interactive)
+  (let* ()
+    (gdscript-run-command
+     (gdscript-godot--build-shell-command))))
+
+(defun gdscript-godot-run-project-debug ()
+  "Run the current project in Godot Engine."
+  (interactive)
+  (let* ()
+    (gdscript-run-command
+     (concat (gdscript-godot--build-shell-command) " -d"))))
+
+(defun gdscript-godot-run-current-scene ()
+  "Run the current script file in Godot Engine."
+  (interactive)
+  (gdscript-run-command
+   (concat (gdscript-godot--build-shell-command) " "
+           (gdscript-util--get-godot-project-file-path-relative buffer-file-name) ".tscn")))
+
+(defun gdscript-godot-run-current-scene-debug ()
+  "Run the current script file in Godot Engine."
+  (interactive)
+  (gdscript-run-command
+   (concat (gdscript-godot--build-shell-command) " -d "
+           (gdscript-util--get-godot-project-file-path-relative buffer-file-name) ".tscn")))
+
+(defun gdscript-godot-edit-current-scene ()
+  "Run the current script file in Godot Engine."
+  (interactive)
+  (gdscript-run-command
+   (concat (gdscript-godot--build-shell-command) " -e "
+           (gdscript-util--get-godot-project-file-path-relative buffer-file-name) ".tscn")))
+
+(defun gdscript-godot-run-current-script ()
+  "Run the current script file in Godot Engine.
+
+For this to work, the script must inherit either from
+\"SceneTree\" or \"MainLoop\"."
+  (interactive)
+  (gdscript-run-command
+   (concat (gdscript-godot--build-shell-command) " -s " (file-relative-name buffer-file-name))))
+
+(provide 'gdscript-godot)
+;;; gdscript-godot.el ends here

gdscript-mode.el

@@ -61,7 +61,7 @@
                             (define-key map "\C-c\C-g" 'gdscript--run-godot-editor)
                             (define-key map "\C-c\C-p" 'gdscript--run-project-in-godot)
                             (define-key map "\C-c\C-s" 'gdscript--run-current-scene-in-godot)
-                            (define-key map "\C-c\C-e" 'gdscript--edit-current-scene-in-godot)
+                            (define-key map "\C-c\C-e" 'gdscript-godot-edit-current-scene)
                             (define-key map "\C-c\C-r" 'gdscript--run-current-script-in-godot)
                             (define-key map "\C-c\C-dp" 'gdscript--run-project-in-godot-debug-mode)
                             (define-key map "\C-c\C-ds" 'gdscript--run-current-scene-in-godot-debug-mode)

gdscript-utils.el

@@ -31,6 +31,7 @@
 ;;; Code:
 
 (require 'gdscript-syntax)
+(require 'gdscript-customization)
 
 (defun gdscript--util-goto-line (line-number)
   "Move point to LINE-NUMBER."
@@ -90,119 +91,34 @@ allowed files."
                          (list full-file-name))))
                    (directory-files dir-name)))))
 
-;;;###autoload
-(defun gdscript--run-command (cmd &optional dedicated show)
-  "Run a Godot process.
-Input and output via buffer named after
-`gdscript--shell-buffer-name'.  If there is a process already
-running in that buffer, just switch to it.
 
-With argument, allows you to define CMD so you can edit the
+(defun gdscript-util--find-project-configuration-file (&optional start-path)
-command used to call the interpreter and define DEDICATED, so a
+  "Return the path to the file \"project.godot\".
-dedicated process for the current buffer is open.  When numeric
-prefix arg is other than 0 or 4 do not SHOW."
-  (interactive
-   (if current-prefix-arg
-       (list
-        (read-string "Run Godot: " (gdscript--build-shell-command))
-        (y-or-n-p "Make dedicated process? ")
-        (= (prefix-numeric-value current-prefix-arg) 4))
-     (list (gdscript--build-shell-command) nil t)))
-  (start-process-shell-command "Godot Process" (if show
-                                                   gdsript-shell-buffer-name nil)
-                               cmd))    ; gdscript-godot-executable))
 
-(defun gdscript--build-shell-command ()
+Start the search from START-PATH if provided. Otherwise, the search
-  "Calculate the string used to execute the inferior Godot-GDScript process."
+starts from the current buffer path.
-  (format "%s %s"
-          (shell-quote-argument
-           (executable-find gdscript-godot-executable))
-          gdscript-godot-executable-args))
 
-(defun gdscript--build-shell-command (&optional path)
+WARNING: the Godot project must exist for this function to work."
-  "Build base shell command to run Godot Engine with the
+  (let ((base-path (or start-path default-directory)))
-project's base PATH. If PATH is not provided, try to find it
-using the current file's directory as starting point."
-  (let* ((project-path (or path (gdscript--find-project-configuration-path))))
-    (concat gdscript-godot-executable " --path " project-path)))
-
-(defun gdscript--run-godot-editor ()
-  "Run Godot Engine Editor."
-  (interactive)
-  (gdscript--run-command
-   (concat (gdscript--build-shell-command) " -e")))
-
-(defun gdscript--run-project-in-godot ()
-  "Run the current project in Godot Engine."
-  (interactive)
-  (let* ((project-path (gdscript--find-project-configuration-path)))
-    (gdscript--run-command
-     (gdscript--build-shell-command))))
-
-(defun gdscript--run-project-in-godot-debug-mode ()
-  "Run the current project in Godot Engine."
-  (interactive)
-  (let* ((project-path (gdscript--find-project-configuration-path)))
-    (gdscript--run-command
-     (concat (gdscript--build-shell-command) " -d"))))
-
-(defun gdscript--run-current-scene-in-godot ()
-  "Run the current script file in Godot Engine."
-  (interactive)
-  (gdscript--run-command
-   (concat (gdscript--build-shell-command) " "
-           (gdscript--get-file-relative-path-to-project buffer-file-name) ".tscn")))
-
-(defun gdscript--run-current-scene-in-godot-debug-mode ()
-  "Run the current script file in Godot Engine."
-  (interactive)
-  (gdscript--run-command
-   (concat (gdscript--build-shell-command) " -d "
-           (gdscript--get-file-relative-path-to-project buffer-file-name) ".tscn")))
-
-(defun gdscript--edit-current-scene-in-godot ()
-  "Run the current script file in Godot Engine."
-  (interactive)
-  (gdscript--run-command
-   (concat (gdscript--build-shell-command) " -e "
-           (gdscript--get-file-relative-path-to-project buffer-file-name) ".tscn")))
-
-(defun gdscript--run-current-script-in-godot ()
-  "Run the current script file in Godot Engine.
-
-For this to work, the script must inherit either from
-\"SceneTree\" or \"MainLoop\"."
-  (interactive)
-  (gdscript--run-command
-   (concat (gdscript--build-shell-command) " -s " (file-relative-name buffer-file-name))))
-
-(defun gdscript--find-project-configuration-path (&optional path)
-  "Return the path where Godot's configuration File (\"project.godot\") is stored.
-
-If PATH is given, starts searching by it. Otherwise, the search
-starts by the current buffer path."
-  ;; This assumes that the project does exist (i.e. it was created before the
-  ;; call). The function will fail if the project is not found.
-  (let ((base-path (or path default-directory)))
     (locate-dominating-file base-path
                             (lambda (parent)
                               (directory-files parent t "project.godot")))))
 
-(defun gdscript--get-project-name ()
+(defun gdscript-util--get-godot-project-name ()
   "Retrieve the project name from Godot's configuration file."
   (with-temp-buffer
-    (insert-file-contents (concat (gdscript--find-project-configuration-path) "project.godot"))
+    (insert-file-contents (concat (gdscript-util--find-project-configuration-file) "project.godot"))
     (goto-char (point-min))
     (if (re-search-forward "config/name=\"\\([^\"]*\\)\"" nil t)
         (match-string 1)
       (error "Could not find the name of the project"))))
 
-(defun gdscript--get-file-relative-path-to-project (file-path)
+(defun gdscript-util--get-godot-project-file-path-relative (file-path)
-  "Return the relative path of `file-path' to Godot's configuration file."
+  "Return the relative path of `FILE-PATH' to Godot's configuration file."
-  (concat (gdscript--build-shell-command) " -d "
+  (concat (gdscript-godot--build-shell-command) " -d "
           (file-name-sans-extension
            (file-relative-name file-path
-                               (gdscript--find-project-configuration-path)))))
+                               (gdscript-util--find-project-configuration-file)))))
 
 (provide 'gdscript-utils)