;; Copyright (C) 2015-2017, 2019 Free Software Foundation, Inc

;; Author: Rocky Bernstein <rocky@gnu.org>

;; 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/>.

;;; gdb debugger

(eval-when-compile (require 'cl-lib))

(require 'load-relative)
(require-relative-list '("../../common/regexp" "../../common/loc") "realgud-")

(defvar realgud-pat-hash)
(declare-function make-realgud-loc-pat 'realgud-regexp)

(defvar realgud:gdb-pat-hash (make-hash-table :test 'equal)
  "Hash key is the what kind of pattern we want to match:
backtrace, prompt, etc.  the values of a hash entry is a
realgud-loc-pat struct")

(declare-function make-realgud-loc "realgud-loc" (a b c d e f))

(defconst realgud:gdb-frame-file-regexp
  (format "\\(.+\\):%s" realgud:regexp-captured-num))

;; Regular expression that describes a lldb location generally shown
;; before a command prompt. NOTE: we assume annotate 1!
;; For example:
;; /src/build/ruby-2.1.5/main.c:24:454:beg:0x55555557659f
(setf (gethash "loc" realgud:gdb-pat-hash)
      (make-realgud-loc-pat
       :regexp (format "^%s:%s:beg:0x\\([0-9a-f]+\\)"
		       realgud:gdb-frame-file-regexp realgud:regexp-captured-num)
       :file-group 1
       :line-group 2
       :char-offset-group 3))

;; Regular expression that describes a gdb prompt
;; For example:
;;   (gdb)
(setf (gethash "prompt" realgud:gdb-pat-hash)
      (make-realgud-loc-pat
       :regexp   "^(gdb) "
       ))

;; Regular expression that describes a "breakpoint set" line
;; For example:
;;   Breakpoint 1, main (argc=1, argv=0x7fffffffdbd8) at main.c:24
(setf (gethash "brkpt-set" realgud:gdb-pat-hash)
      (list
       (make-realgud-loc-pat
	:regexp (format "^Breakpoint %s at 0x\\([0-9a-f]*\\): file \\(.+\\), line %s[.]\n"
			realgud:regexp-captured-num realgud:regexp-captured-num)
	:num 1
	:file-group 3
	:line-group 4)
       ;; Another breakpoint pattern seen
       (make-realgud-loc-pat
	:regexp (format "^Breakpoint %s, .* at \\(.+\\):%s[.]\n"
			realgud:regexp-captured-num realgud:regexp-captured-num)
	:num 1
	:file-group 2
	:line-group 3)
       ))

;; Regular expression that describes a debugger "delete" (breakpoint)
;; response.
;; For example:
;;   Deleted breakpoint 1
;;   Deleted breakpoints 1 2 3 4
(setf (gethash "brkpt-del" realgud:gdb-pat-hash)
      (make-realgud-loc-pat
       :regexp "^Deleted breakpoints? \\(\\([0-9]+ *\\)+\\)\n"
       :num 1))

(defconst realgud:gdb-frame-start-regexp
  "\\(?:^\\|\n\\)")

(defconst realgud:gdb-frame-num-regexp
  (format "#%s " realgud:regexp-captured-num))

;; Regular expression that describes a gdb "backtrace" command line.
;; For example:
;; #0  main (argc=2, argv=0xbffff564, envp=0xbffff570) at main.c:935
;; #1  0xb7e9f4a5 in *__GI___strdup (s=0xbffff760 "/tmp/remake/remake") at strdup.c:42
;; #2  0x080593ac in main (argc=2, argv=0xbffff5a4, envp=0xbffff5b0)
;;    at main.c:952
;; #46 0xb7f51b87 in vm_call_cfunc (th=0x804d188, reg_cfp=0xb7ba9e88, num=0,
;;    recv=157798080, blockptr=0x0, me=0x80d12a0) at vm_insnhelper.c:410

(setf (gethash "debugger-backtrace" realgud:gdb-pat-hash)
      (make-realgud-loc-pat
       :regexp 	(concat realgud:gdb-frame-start-regexp
			realgud:gdb-frame-num-regexp
			"\\(?:.\\|\\(?:[\n] \\)\\)+[ ]+at "
			realgud:gdb-frame-file-regexp
			)
       :num 1
       :file-group 2
       :line-group 3)
      )

;; FIXME breakpoints aren't locations. It should be a different structure
;; Regular expression that describes a gdb "info breakpoint" line
;; For example:
;; 1       breakpoint     keep y   0x0000000000401471 in vcdnav_get_entries at ctest.c:67

(setf (gethash "debugger-breakpoint" realgud:gdb-pat-hash)
  (make-realgud-loc-pat
   :regexp (format "^%s[ \t]+\\(breakpoint\\)[ \t]+\\(keep\\|del\\)[ \t]+\\([yn]\\)[ \t]+.*at \\(.+\\):%s"
		   realgud:regexp-captured-num realgud:regexp-captured-num)
   :num 1
   :text-group 2  ;; misnamed Is "breakpoint" or "watchpoint"
   :string 3      ;; misnamed. Is "keep" or "del"
   ;; Enable is missing
   ;; Skipped address
   :file-group 5
   :line-group 6)
  )


(setf (gethash "font-lock-keywords" realgud:gdb-pat-hash)
      '(
	;; #2  0x080593ac in main (argc=2, argv=0xbffff5a4, envp=0xbffff5b0)
	;;    at main.c:952
	("[ \n]+at \\(.*\\):\\([0-9]+\\)"
	 (1 realgud-file-name-face)
	 (2 realgud-line-number-face))

	;; The frame number and first type name, if present.
	;; E.g. =>#0  Makefile.in at /tmp/Makefile:216
	;;      ---^
	( "#\\(?:^\\|\n\\)\\([0-9]+\\)  "
	 (1 realgud-backtrace-number-face))
	))

(setf (gethash "font-lock-breakpoint-keywords" realgud:gdb-pat-hash)
  '(
    ;; The breakpoint number, type and disposition
    ;; 1       breakpoint     keep y   0x0000000000401471 in vcdnav_get_entries at ctest.c:67
    ;; ^       ^^^^^^^^^^     ^^^^
    ("^\\([0-9]+\\)[ \t]+\\(breakpoint\\)[ \t]+\\(keep\\|del\\)"
     (1 realgud-breakpoint-number-face)
     (2 font-lock-function-name-face nil t)     ; t means optional.
     (3 font-lock-function-name-face nil t))     ; t means optional.

    ;; 1       breakpoint     keep y   0x0000000000401471 in vcdnav_get_entries at ctest.c:67
    ;;                                                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^
    (" in[ \t]+\\(.+*\\):\\([0-9]+\\)"
     (1 realgud-file-name-face)
     (2 realgud-line-number-face))
    ))

(setf (gethash "gdb" realgud-pat-hash) realgud:gdb-pat-hash)

;;  Prefix used in variable names (e.g. short-key-mode-map) for
;; this debugger

(setf (gethash "gdb" realgud:variable-basename-hash) "realgud:gdb")

(defvar realgud:gdb-command-hash (make-hash-table :test 'equal)
  "Hash key is command name like 'continue' and the value is
the gdb command to use, like 'continue'.")

(setf (gethash "break"    realgud:gdb-command-hash) "break %X:%l")
(setf (gethash "clear"    realgud:gdb-command-hash) "clear %X:%l")
(setf (gethash "continue" realgud:gdb-command-hash) "continue")
(setf (gethash "delete"   realgud:gdb-command-hash) "delete %p")
(setf (gethash "eval"     realgud:gdb-command-hash) "print %s")
(setf (gethash "quit"     realgud:gdb-command-hash) "quit")
(setf (gethash "run"      realgud:gdb-command-hash) "run")
(setf (gethash "step"     realgud:gdb-command-hash) "step %p")

(setf (gethash "gdb" realgud-command-hash) realgud:gdb-command-hash)

(setf (gethash "gdb" realgud-pat-hash) realgud:gdb-pat-hash)

(provide-me "realgud:gdb-")