First commit.

2022-03-29 19:21:13 -04:00
commit da8f068975
293 changed files with 3002 additions and 0 deletions
--- a/private/packages/php-doc-block/php-doc-block.el
+++ b/private/packages/php-doc-block/php-doc-block.el
@ -0,0 +1,120 @@
+;;; php-doc-block.el --- Php DocBlock generator
+
+;; Copyright (C) 2016 Dmitriy Moskalyov
+
+;; Author: Dmitriy Moskalyov <moskalyovd@gmail.com>
+;; Keywords: php docblock
+;; Version: 0.0.1
+;; URL: https://github.com/moskalyovd/emacs-php-doc-block
+
+;; 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 <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; This package provides php DocBlock generator.
+;; How to use:
+;; Clone repository from https://github.com/moskalyovd/emacs-php-doc-block
+;; and add to your .emacs(or init.el) file:
+
+;; (add-to-list 'load-path "~/.emacs.d/emacs-php-doc-block")
+;; (require 'php-doc-block)
+
+;; Then bind command 'php-doc-block to any key you like:
+
+;; (add-hook 'php-mode-hook
+;;          (lambda ()
+;;              (local-set-key (kbd "<C-tab>") 'php-doc-block)))
+
+;;; Code:
+
+(defun insert-to-prev-line-and-indent (text)
+  "Insert TEXT to the previous line with indentation."
+  (beginning-of-line)
+  (open-line 1)
+  (insert text)
+  (indent-according-to-mode))
+
+(defun insert-to-next-line-and-indent (text)
+  "Insert TEXT to the next line with indentation."
+  (end-of-line)
+  (newline-and-indent)
+  (insert text)
+  (indent-according-to-mode))
+
+(defun php-doc-block-var-or-attr (tag-type type name value is-nullable)
+  "Insert doc block for a property or an attribute"
+  (cond
+   ((and value (= (string-width type) 0))
+    (cond
+     ((string-match "^=\s*\\(array(.*)\\|\\[\.*\]\\)" value) (setq type "array"))
+     ((string-match "^=\s*\[0-9\]*\\.\[0-9\]+$" value)  (setq type "float"))
+     ((string-match "^=\s*\[0-9\]+$" value) (setq type "int"))
+     ((string-match "^=\s*\['\"]" value) (setq type "string"))
+     ((string-match "^=\s*\\(true\\|false\\)" value) (setq type "bool"))))
+
+   ((and (= (string-width type) 0) (not value))
+    (setq type "mixed")))
+
+  (when (equal is-nullable "?")
+    (setq type (concat type "|null")))
+
+  (insert-to-next-line-and-indent (concat "* @" tag-type " " type  " " name)))
+
+(defun php-doc-block-function (name arguments return-type is-return-nullable)
+  "Insert php docblock for function"
+  (insert-to-next-line-and-indent (concat "* " name))
+
+  (when (> (string-width arguments) 0)
+    (insert-to-next-line-and-indent "*")
+    (dolist (arg (split-string arguments "\s*,\s*"))
+      (string-match "\s*\\(\[\?\]?\\)\s*\\(\[\\\]?\[a-zA-Z0-9_\]*\\)?\s*\\($\[a-zA-Z0-9_\]+\\)\s*\\(=.*\\)?" arg)
+      (php-doc-block-var-or-attr "param" (match-string 2 arg) (match-string 3 arg) (match-string 4 arg) (match-string 1 arg))))
+
+  (when (> (string-width return-type) 0)
+    (insert-to-next-line-and-indent "*")
+    (when (equal is-return-nullable "?")
+      (setq return-type (concat return-type "|null")))
+    (insert-to-next-line-and-indent (concat "* @return " return-type))))
+
+(defun php-doc-block-class (type name)
+  "Insert php doc block for class, interface etc."
+
+  (insert-to-next-line-and-indent (concat "* " name " " type)))
+
+(defun php-doc-block ()
+  "Insert php docblock."
+  (interactive)
+  (let ((line (thing-at-point 'line)))
+    (insert-to-prev-line-and-indent "/**")
+    (cond
+     ((string-match "function\s*" line)
+      (beginning-of-line)
+      (let ((line (thing-at-point 'line)) (func-defun "") (s-point (point)) (e-point (re-search-forward ";\\|{" nil '(nil))))
+        (goto-char s-point)
+        (if e-point
+            (setq func-defun (replace-regexp-in-string "{\\|\n" "" (buffer-substring s-point e-point)))
+          (progn
+            (end-of-line)
+            (setq func-defun (buffer-substring s-point (point))))
+          )
+        (when (string-match "function\s+\\([A-Za-z0-9_]+\\)\s*(\\(.*\\))\s*:*\s*\\(\[\?\]?\\)\s*\\(\[A-Za-z0-9_\\\]*\\)" func-defun)
+          (php-doc-block-function (match-string 1 func-defun) (match-string 2 func-defun) (match-string 4 func-defun) (match-string 3 func-defun)))))
+     ((string-match "\s*\\([a-zA-Z0-9_]+\\)?\s*\\($\[a-zA-Z0-9_\]+\\)\s*\\(=\[^;\]*\\)?" line)
+      (php-doc-block-var-or-attr "var" "" (match-string 2 line) (match-string 3 line) ""))
+     ((string-match "\\(class\\|interface\\|trait\\|abstract class\\)\s+\\(\[a-zA-Z0-9_\]+\\)" line)
+      (php-doc-block-class (match-string 1 line) (match-string 2 line))))
+    (insert-to-next-line-and-indent "*/")))
+
+(provide 'php-doc-block)
+;;; php-doc-block.el ends here