Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

proof-shell: document call graph #739

Merged
merged 1 commit into from
Feb 19, 2024
Merged

proof-shell: document call graph #739

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions generic/proof-shell.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,35 @@
;; Mode for buffer which interacts with proof assistant.
;; Includes management of a queue of commands waiting to be sent.
;;
;; A big portion of the code in this file implements the callback
;; function that Emacs calls when output arrives from the proof
;; assistant. This callback implements a major feature of Proof
;; General: Sending one command after the other to the proof assistant
;; and processing/displaying the reply.
;;
;; The following documents the call graph of important functions that
;; contribute to this callback. The entry point is
;; `proof-shell-filter-wrapper', which is configured in
;; `scomint-output-filter-functions'. Sending the next comand to the
;; proof assistant and calling the callbacks of the spans happens in
;; `proof-shell-exec-loop'.
;;
;; proof-shell-filter-wrapper
;; -> proof-shell-filter
;; -> proof-shell-process-urgent-messages
;; -> proof-shell-filter-manage-output
;; -> proof-shell-handle-immediate-output
;; -> proof-shell-exec-loop
;; -> proof-tree-check-proof-finish
;; -> proof-shell-handle-error-or-interrupt
;; -> proof-shell-insert-action-item
;; -> proof-shell-invoke-callback
;; -> proof-release-lock
;; -> proof-shell-handle-delayed-output
;; -> proof-tree-handle-delayed-output
;; -> proof-release-lock
;; -> proof-start-prover-with-priority-items-maybe
;;

;;; Code:

Expand Down
Loading