add completions and eldoc to repl buffer

Author: hlolli

README.md

@@ -67,10 +67,5 @@ If you're using `csound-mode` directly from the git repo, and you happen to use
 <kbd>M-.</kbd> `csound-score-find-instr-def` cursor needs to be within a score block
 
 
-## Known bugs
-* Only one REPL instance can run at each moment
-* Unexpected crashing of csound within the repl can sometimes lead to Emacs crashing, if Csound crashes (example when the audio server crashes), save your work and restart Emacs.
-
-
 [badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
 [COPYING]: http://www.gnu.org/copyleft/gpl.html

csound-font-lock.el

@@ -330,7 +330,8 @@
 			     (or (save-excursion (beginning-of-buffer)
 						 (search-forward-regexp "<CsScore" end t 1))
 				 0)))
-	    (orchestra-boundry (if (string-match-p ".orc$" (buffer-name (current-buffer)))
+	    (orchestra-boundry (if (or (string-match-p ".orc$" (buffer-name (current-buffer)))
+				       (string-match-p ".udo$" (buffer-name (current-buffer))))
 				   (buffer-size)
 				 (or (save-excursion (beginning-of-buffer)
 						     (search-forward-regexp "</CsInstruments>" end t 1))
@@ -346,7 +347,7 @@
 		(font-lock-default-fontify-region (line-beginning-position) (line-end-position) nil))
 	      (next-line))))))))
 
-(defun csound-font-lock-param--flush-buffer ()
+(defun csound-font-lock--flush-buffer ()
   (save-excursion
     (end-of-buffer)
     (let ((line-count (line-number-at-pos)))
@@ -355,7 +356,7 @@
 	(save-excursion (font-lock-default-fontify-region (line-beginning-position) (line-end-position) nil))
 	(next-line)))))
 
-(defun csound-font-lock-param--flush-score ()
+(defun csound-font-lock--flush-score ()
   (when csound-font-lock-rainbow-score-parameters-p
     (save-excursion
       (beginning-of-buffer)
@@ -366,18 +367,9 @@
 	(when (and score-beg score-end)
 	  (csound-font-lock--fontify-score score-beg score-end))))))
 
-(defun csound-font-lock-param--bugfix ()
-  (save-excursion
-    (when (search-forward-regexp "</CsoundSynthesizer>" nil t 1)
-      (beginning-of-line)
-      (font-lock-default-fontify-region (line-beginning-position) (line-end-position) nil))))
-
 (defun csound-font-lock-flush-buffer ()
-  (progn (csound-font-lock-param--flush-buffer)
-	 (csound-font-lock-param--flush-score)
-	 ;; (csound-font-lock--flush-block-comments)
-	 ;; (csound-font-lock-param--bugfix)
-	 ))
+  (progn (csound-font-lock--flush-buffer)
+	 (csound-font-lock--flush-score)))
 
 (provide 'csound-font-lock)
 

csound-mode.el

@@ -29,7 +29,6 @@
 
 (require 'font-lock)
 (require 'cl)
-(require 'csound-opcodes)
 (require 'csound-eldoc)
 (require 'csound-font-lock)
 (require 'csound-repl)
@@ -93,22 +92,6 @@
 		       ("24" "-3")
 		       (t "-s"))))))
 
-(defun csound-opcode-completion-at-point ()
-  (let ((bounds (bounds-of-thing-at-point 'word)))
-    (when bounds
-      (list (car bounds)
-            (cdr bounds)
-            csdoc-opcode-database
-            :exclusive 'no
-            :company-docsig (lambda (cand)
-			      (csound-util-chomp (replace-regexp-in-string
-						  "\n\\|\s+" "\s"
-						  (nth 3 (gethash cand csdoc-opcode-database)))))
-            :company-doc-buffer (lambda (cand)
-				  (prin1-to-string (nth 11 (gethash cand csdoc-opcode-database))))
-	    ;;:company-location (lambda (cand) (nth 11 (gethash cand csdoc-opcode-database)))
-	    ))))
-
 
 (defun csound-repl-start ()
   "Start the csound-repl."
@@ -148,7 +131,7 @@
   (setq-local compilation-scroll-output t)
   (setq-local ad-redefinition-action 'accept)
   (setq-local font-lock-comment-end-skip "\n")
-  (add-hook 'completion-at-point-functions #'csound-opcode-completion-at-point nil t)
+  (add-hook 'completion-at-point-functions #'csound-util-opcode-completion-at-point nil t)
   ;; (add-hook 'skeleton-end-hook #'csound-font-lock-flush-buffer nil t) 
   (font-lock-add-keywords nil csound-font-lock-list)
   (setq-local font-lock-fontify-region-function 'csound-font-lock-fontify-region)
@@ -157,7 +140,7 @@
   ;; (setq-local jit-lock-contextually t)
   (shut-up
     (with-silent-modifications
-      (csound-font-lock-flush-buffer))))
+      (csound-font-lock--flush-score))))
 
 
 (add-to-list 'auto-mode-alist `(,(concat "\\." (regexp-opt '("csd" "orc" "sco" "udo")) "\\'") . csound-mode))

csound-opcodes.el

@@ -69,7 +69,7 @@ karray[] vbapg kazim [,kelev] [, kspread] [, ilayout]" :doc "Calculates the gain
 (puthash "freeverb" '(:template "aoutL, aoutR freeverb ainL, ainR, kRoomSize, kHFDamp[, iSRate[, iSkip]]" :doc "Opcode version of Jezar's Freeverb") csdoc-opcode-database)
 (puthash "repluck" '(:template "ares repluck iplk, kamp, icps, kpick, krefl, axcite" :doc "Physical model of the plucked string.") csdoc-opcode-database)
 (puthash "pvsout" '(:template "pvsout fsig, kchan" :doc "Write a fsig to the pvs output bus.") csdoc-opcode-database)
-(puthash "mp3scal" '(:template "asig, asig2, ktime mp3scal Sfile,ktimescal,kpitch, kamp [,iskip,ifftsize, idecim, ilock]" :doc "Phase-locked vocoder processing with onset detection/processing, 'tempo-scaling'.") csdoc-opcode-database)
+(puthash "mp3scal" '(:template "asig, asig2, ktime mp3scal Sfile, ktimescal, kpitch, kamp[, iskip, ifftsize, idecim, ilock]" :doc "Phase-locked vocoder processing with onset detection/processing, 'tempo-scaling'.") csdoc-opcode-database)
 (puthash "gogobel" '(:template "ares gogobel kamp, kfreq, ihrd, ipos, imp, kvibf, kvamp, ivfn" :doc "Audio output is a tone related to the striking of a cow bell or similar.") csdoc-opcode-database)
 (puthash "fink" '(:template "fink ifilename, iskipframes, iformat, kin1 [, kin2] [, kin3] [,...]" :doc "Read signals from a file at k-rate.") csdoc-opcode-database)
 (puthash "clear" '(:template "clear avar1 [, avar2] [, avar3] [...]" :doc "Zeroes a list of audio signals.") csdoc-opcode-database)
@@ -466,7 +466,7 @@ tableshufflei itablenum" :doc "shuffles the content of a function table so that
 (puthash "vbap4" '(:template "ar1, ar2, ar3, ar4 vbap4 asig, kazim [, kelev] [, kspread]" :doc "Distributes an audio signal among 4 channels.") csdoc-opcode-database)
 (puthash "pset" '(:template "pset icon1 [, icon2] [...]" :doc "Defines and initializes numeric arrays at orchestra load time.") csdoc-opcode-database)
 (puthash "vaddv_i" '(:template "vaddv_i ifn1, ifn2, ielements [, idstoffset] [, isrcoffset]" :doc "Performs addition between two vectorial control signals at init time.") csdoc-opcode-database)
-(puthash "setscorepos" '(:template "setscorepos ipos" :doc "Sets the playback position of the current score performance to a given position.") csdoc-opcode-database)
+(puthash "setscorepos" '(:template "setscoreposipos" :doc "Sets the playback position of the current score performance to a given position.") csdoc-opcode-database)
 (puthash "ptable3" '(:template "ares ptable3 andx, ifn [, ixmode] [, ixoff] [, iwrap]
 ires ptable3 indx, ifn [, ixmode] [, ixoff] [, iwrap]
 kres ptable3 kndx, ifn [, ixmode] [, ixoff] [, iwrap]" :doc "Accesses table values by direct indexing with cubic interpolation.") csdoc-opcode-database)
@@ -972,6 +972,7 @@ kres cauchy kalpha" :doc "WTF: ") csdoc-opcode-database)
 (puthash "dripwater" '(:template "ares dripwater kamp, idettack [, inum] [, idamp] [, imaxshake] [, ifreq] [, ifreq1] [, ifreq2]" :doc "Semi-physical model of a water drop.") csdoc-opcode-database)
 (puthash "vtablewi" '(:template "vtablewi indx, ifn, ixmode, inarg1 [, inarg2, inarg3 , .... , inargN ]" :doc "Write vectors (to tables -or arrays of vectors).") csdoc-opcode-database)
 (puthash "zkr" '(:template "kres zkr kndx" :doc "Reads from a location in zk space at k-rate.") csdoc-opcode-database)
+(puthash "midiout_i" '(:template "midiout_i istatus, ichan, idata1, idata2" :doc "Sends a generic MIDI message to the MIDI OUT port.") csdoc-opcode-database)
 (puthash "pdhalfy" '(:template "aout pdhalfy ain, kShapeAmount [, ibipolar [, ifullscale]]" :doc "Distorts a phasor for reading two unequal portions of a table in equal periods.") csdoc-opcode-database)
 (puthash "vmult" '(:template "vmult ifn, kval, kelements [, kdstoffset] [, kverbose]" :doc "Multiplies a vector in a table by a scalar value.") csdoc-opcode-database)
 (puthash "outipc" '(:template "outipc ichn, iprog, imin, imax" :doc "Sends MIDI program change messages at i-rate") csdoc-opcode-database)
@@ -1065,6 +1066,7 @@ kans getseed" :doc "Reads the global seed value.") csdoc-opcode-database)
 (puthash "zacl" '(:template "zacl kfirst, klast" :doc "Clears one or more variables in the za space.") csdoc-opcode-database)
 (puthash "strcat" '(:template "Sdst strcat Ssrc1, Ssrc2" :doc "Concatenate strings") csdoc-opcode-database)
 (puthash "tabplay" '(:template "tabplay ktrig, knumtics, kfn, kout1 [,kout2,..., koutN]" :doc "Playing-back control signals.") csdoc-opcode-database)
+(puthash "squinewave" '(:template "aout [, asyncout] squinewave acps, aClip, aSkew [, asyncin] [, iMinSweep] [, iphase]" :doc "A mostly bandlimited shape-shifting square-pulse-saw-sinewave oscillator with hardsync.") csdoc-opcode-database)
 (puthash "printk2" '(:template "printk2 kvar [, inumspaces]" :doc "Prints a new value every time a control variable changes.") csdoc-opcode-database)
 (puthash "filter2" '(:template "ares filter2 asig, iM, iN, ib0, ib1, ..., ibM, ia1, ia2, ..., iaN
 kres filter2 ksig, iM, iN, ib0, ib1, ..., ibM, ia1, ia2, ..., iaN" :doc "Performs filtering using a transposed form-II digital filter lattice with no time-varying control.") csdoc-opcode-database)
@@ -1081,7 +1083,7 @@ karray[] vbapgmove idur, ispread, ifldnum, ifld1 [, ifld2] [...]" :doc "Calculat
 (puthash "passign" '(:template "ivar1, ... passign [istart]" :doc "Assigns a range of p-fields to ivariables.") csdoc-opcode-database)
 (puthash "writescratch" '(:template "writescratchival[, index]" :doc "writes a value into the scratchpad of the instance of an instrument.") csdoc-opcode-database)
 (puthash "readk" '(:template "kres readk ifilname, iformat, iprd" :doc "Periodically reads an orchestra control-signal value from an external file.") csdoc-opcode-database)
-(puthash "OSCsend" '(:template "OSCsend kwhen, ihost, iport, idestination, itype [, xdata1, xdata2, ...]" :doc "Sends data to other processes using the OSC protocol") csdoc-opcode-database)
+(puthash "OSCsend" '(:template "OSCsend kwhen, ihost, iport, idestination[, itype , xdata1, xdata2, ...]" :doc "Sends data to other processes using the OSC protocol") csdoc-opcode-database)
 (puthash "pinkish" '(:template "ares pinkish xin [, imethod] [, inumbands] [, iseed] [, iskip]" :doc "Generates approximate pink noise.") csdoc-opcode-database)
 (puthash "linenr" '(:template "ares linenr xamp, irise, idec, iatdec
 kres linenr kamp, irise, idec, iatdec" :doc "The") csdoc-opcode-database)
@@ -1182,7 +1184,8 @@ kres tablekt kndx, kfn [, ixmode] [, ixoff] [, iwrap]" :doc "Provides k-rate con
 (puthash "chnset" '(:template "chnset ival, Sname
 chnset kval, Sname
 chnset aval, Sname
-chnset Sval, Sname" :doc "Writes data to the named software bus.") csdoc-opcode-database)
+chnset Sval, Sname
+chnsetks Sval, Sname" :doc "Writes data to the named software bus.") csdoc-opcode-database)
 (puthash "midinoteoncps" '(:template "midinoteoncps xcps, xvelocity" :doc "Gets a MIDI note number as a cycles-per-second frequency.") csdoc-opcode-database)
 (puthash "fmb3" '(:template "ares fmb3 kamp, kfreq, kc1, kc2, kvdepth, kvrate[, ifn1, ifn2, ifn3, ifn4, ivfn]" :doc "Uses FM synthesis to create a Hammond B3 organ sound.") csdoc-opcode-database)
 (puthash "phaser2" '(:template "ares phaser2 asig, kfreq, kq, kord, kmode, ksep, kfeedback" :doc "Second-order allpass filters arranged in a series.") csdoc-opcode-database)
@@ -1418,7 +1421,8 @@ kres polyaft inote [, ilow] [, ihigh]" :doc "Returns the polyphonic after-touch
 (puthash "chnget" '(:template "ival chnget Sname
 kval chnget Sname
 aval chnget Sname
-Sval chnget Sname" :doc "Reads data from the software bus.") csdoc-opcode-database)
+Sval chnget Sname
+Sval chngetks Sname" :doc "Reads data from the software bus.") csdoc-opcode-database)
 (puthash "partikkelsync" '(:template "async [,aphase] partikkelsync iopcode_id" :doc "Outputs") csdoc-opcode-database)
 (puthash "mpulse" '(:template "ares mpulse kamp, kintvl [, ioffset]" :doc "Generates a set of impulses.") csdoc-opcode-database)
 (puthash "envlpx" '(:template "ares envlpx xamp, irise, idur, idec, ifn, iatss, iatdec [, ixmod]
@@ -1566,7 +1570,7 @@ iout duserrnd itableNum
 kout duserrnd ktableNum" :doc "Discrete USER-defined-distribution RaNDom generator.") csdoc-opcode-database)
 (puthash "wgbow" '(:template "ares wgbow kamp, kfreq, kpres, krat, kvibf, kvamp [, ifn] [, iminfreq]" :doc "Creates a tone similar to a bowed string.") csdoc-opcode-database)
 (puthash "vdelayxw" '(:template "aout vdelayxw ain, adl, imd, iws [, ist]" :doc "Variable delay opcodes with high quality interpolation.") csdoc-opcode-database)
-(puthash "slicearray" '(:template "karray slicearray kinarray, istart, iend" :doc "Take a slice of a vector.") csdoc-opcode-database)
+(puthash "slicearray" '(:template "karray slicearray kinarray, istart, iend [,istride]" :doc "Take a slice of a vector.") csdoc-opcode-database)
 (puthash "ptrack" '(:template "kcps, kamp ptrack asig, ihopsize[,ipeaks]" :doc "Tracks the pitch of a signal.") csdoc-opcode-database)
 (puthash "dssiactivate" '(:template "dssiactivate ihandle, ktoggle" :doc "Activates or deactivates a DSSI or LADSPA plugin.") csdoc-opcode-database)
 (puthash "vdelayxq" '(:template "aout1, aout2, aout3, aout4 vdelayxq ain1, ain2, ain3, ain4, adl, imd, iws [, ist]" :doc "A 4-channel variable delay opcode with high quality interpolation.") csdoc-opcode-database)
@@ -1801,4 +1805,4 @@ kres xadsr iatt, idec, islev, irel [, idel]" :doc "Calculates the classical ADSR
 (puthash "printks2" '(:template "printks2 "string", kval" :doc "Prints a new value every time a control variable changes using a printf() style syntax.") csdoc-opcode-database)
 
  (provide 'csound-opcodes)
-;;; csound-opcodes.el ends here
+;;; csound-opcodes.el ends here

csound-repl.el

@@ -149,7 +149,7 @@
 	 csound-repl-buffer-name)
 	(split-window-sensibly)
 	(switch-to-buffer-other-window csound-repl-buffer-name)
-	(with-current-buffer (buffer-name) (funcall 'csound-interactive-mode))
+	(with-current-buffer (buffer-name) (funcall 'csound-repl-mode))
 	(switch-to-buffer-other-window prev-buffer)))))
 
 (defun csound-repl-last-visited-csd ()
@@ -177,16 +177,17 @@
 
 
 (defconst csound-repl-prompt
-  (let ((prompt "csnd> ")) 
-    (put-text-property 0 (1- (length prompt)) 'read-only t prompt)
+  (let ((prompt "csnd> "))
+    (put-text-property 0 (length prompt) 'read-only t prompt)
     prompt))
 
+
 (defvar csound-repl--input nil)
 
 (defvar csound-repl--input-history (make-hash-table :test 'equal))
 
 (defun csound-repl--input-sender (proc input)
-  (unless (eq 0 (length input)) 
+  (unless (eq 0 (length (csound-util-chomp input)))
     (let ((id (csound-util--generate-random-uuid))
 	  (buffer-read-only nil)
 	  (lb (- (line-beginning-position) 5))
@@ -209,11 +210,11 @@
 		  "|   )    )|   )|   )| | )|   )     |   )|   )|   )|    \n"
 		  "|__/  __/ |__/ |__/ | |/ |__/      |  / |__/ |__/ |__  \n"))
 	 (s (format (concat "\n"
-			    ";;  file: " cur-file "\n"
-			    ";;  sr: %s\n"
-			    ";;  ksmps: %s\n"
-			    ";;  nchnls: %s\n"
-			    ";;  0dbfs: %s\n\n\n")
+			    "file: " cur-file "\n"
+			    "sr: %s\n"
+			    "ksmps: %s\n"
+			    "nchnls: %s\n"
+			    "0dbfs: %s\n\n\n")
 		    sr
 		    ksmps
 		    nchnls
@@ -261,13 +262,26 @@
 
 (setq csound-repl--filter-multline-hackfix nil)
 
+(setq csound-repl--filter-multline-hackfix-rtevent nil)
+
 (defun csound-repl--filter (_ msg)
   (save-current-buffer
     (set-buffer csound-repl-buffer-name)
     (goto-char (buffer-size))
     (let ((msg (->> msg
 		    (replace-regexp-in-string "\0\\|\n" "")
-		    (replace-regexp-in-string ">>>" " >>> "))))
+		    (replace-regexp-in-string ">>>" " >>> ")
+		    (replace-regexp-in-string "\\s-+rtevent:\\s-+" "rtevent: ")))
+	  (hackfix-p csound-repl--filter-multline-hackfix))
+      (when (string-match-p "rtevent:" msg)
+	(setq csound-repl--filter-multline-hackfix-rtevent 0
+	      csound-repl--filter-multline-hackfix t))
+      (when (numberp csound-repl--filter-multline-hackfix-rtevent)
+	(if (eq 2 csound-repl--filter-multline-hackfix-rtevent)
+	    (setq csound-repl--filter-multline-hackfix-rtevent nil
+		  csound-repl--filter-multline-hackfix nil)
+	  (setq csound-repl--filter-multline-hackfix-rtevent
+		(1+ csound-repl--filter-multline-hackfix-rtevent))))
       (when (string-match-p ">>>" msg)
 	(setq csound-repl--filter-multline-hackfix t))
       (when (string-match-p "<<<" msg)
@@ -277,13 +291,13 @@
 	  (progn 
 	    (beginning-of-line)
 	    (end-of-line 0)
-	    (if csound-repl--filter-multline-hackfix
+	    (if hackfix-p
 		(insert msg)
-	      (insert (concat msg "\n"))))
+	      (insert (concat "\n" msg))))
 	(progn 
 	  (goto-char (buffer-size))
 	  (end-of-line 1)
-	  (if csound-repl--filter-multline-hackfix
+	  (if hackfix-p
 	      (insert msg)
 	    (insert (concat msg "\n")))))
       (when (or (string-match-p  "rtjack\\: error" msg)
@@ -391,7 +405,7 @@
   "Evaluate csound expression on current line."
   (interactive)
   (if (not (csound-repl-buffer-running-p))
-      (message "csound-repl instance was not found")
+      (message "csound-repl is not started")
     (if (save-excursion
 	  (search-backward-regexp "<CsScore" nil t 1))
 	(csound-repl-evaluate-score-region
@@ -436,11 +450,11 @@
 ;; 	(csound-repl-interaction--plot (string-to-number table-num))))))
 
 (defvar csound-repl--font-lock-list
-  '((";+.*" . font-lock-comment-face)
+  '((";.*" . font-lock-comment-face)
     ("SECTION [0-9]+:" . font-lock-string-face)
     ("new alloc.*" . font-lock-comment-face)
-    ("error:" . font-lock-warning-face)
-    ("\\<T[^_]\\|\\<TT\\|M:" . csound-font-lock-i-rate)
+    ("error:\\|instrerror:" . font-lock-warning-face)
+    ;; ("\\<T[^_]\\|\\<TT\\|M:" . csound-font-lock-i-rate)
     (">>>.*<<<" . csound-font-lock-s-variables)
     ("\\<\\w*[^0-9]:\\B" . csound-font-lock-a-rate)))
 
@@ -482,8 +496,16 @@
 		 (format "--nchnls=%s" nchnls)
 		 (format "--0dbfs=%s" zero-db-fs)))
 
+(setq csound-repl-map
+      (let ((map comint-mode-map))
+	(define-key map (kbd "<S-return>")
+	  (lambda ()
+	    (interactive)
+	    (insert "\n      ")))
+	map))
+
 (define-derived-mode
-  csound-interactive-mode comint-mode "CsoundInteractive"
+  csound-repl-mode comint-mode "CsoundRepl"
   "Csound Interactive Message Buffer and REPL."
   :syntax-table csound-mode-syntax-table
   (setq-local comint-input-sender 'csound-repl--input-sender)
@@ -508,14 +530,18 @@
 					ksmps
 					nchnls
 					0dbfs))
-      
+      (add-hook 'completion-at-point-functions #'csound-opcode-completion-at-point nil t)
       (set-process-filter csound-repl--csound-server (lambda (_ stdin) nil))
       (setq csound-repl--udp-client-proc (csound-repl--start-client port))
       (setq csound-repl--console-client-proc (csound-repl--console-client console-port))
       (set-process-query-on-exit-flag csound-repl--csound-server nil)
       (set-process-query-on-exit-flag csound-repl--udp-client-proc nil)
       (set-process-query-on-exit-flag csound-repl--console-client-proc nil)
-      (setq-local font-lock-defaults '(csound-repl--font-lock-list))
+      (setq-local font-lock-defaults '(csound-font-lock-list
+				       csound-repl--font-lock-list))
+      (setq-local comment-start ";; ")
+      (setq-local eldoc-documentation-function 'csound-eldoc-function)
+      (add-hook 'completion-at-point-functions #'csound-util-opcode-completion-at-point nil t)
       ;; (setq-local comint-prompt-read-only t)
       (setq-local comint-scroll-to-bottom-on-input t)
       (setq-local comint-scroll-to-bottom-on-output t)
@@ -525,5 +551,4 @@
 
 (provide 'csound-repl)
 
-
 ;;; csound-repl.el ends here