zzkt/scel
1
0
Fork 0
Code Issues 7 Pull requests Projects Activity Actions

Compare commits

base: zzkt:main
Branches Tags
zzkt:main
zzkt:topic/ninja
..
compare: zzkt:topic/ninja
Branches Tags
zzkt:main
zzkt:topic/ninja

No commits in common. "main" and "topic/ninja" have entirely different histories.
main ... topic/ninj

38 changed files with 1352 additions and 1825 deletions
Show stats Expand all files Collapse all files

5
.dir-locals.el
View file

@ -1,5 +0,0 @@
;; setting for elisp mode and elisp linter
((emacs-lisp-mode . ((fill-column . 80)
(indent-tabs-mode . nil)
(elisp-lint-indent-specs . ((describe . 1)
(it . 1))))))

55
.github/workflows/test.yml vendored
View file

@ -1,55 +0,0 @@
name: CI
on:
push:
paths-ignore:
- '**.md'
pull_request:
paths-ignore:
- '**.md'
- '**.org'
jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
emacs_version:
- 27.2
- 28.1
- snapshot
steps:
- name: Set up Emacs
uses: purcell/setup-emacs@master
with:
version: ${{matrix.emacs_version}}
- name: Install w3m
run: sudo apt-get install -y w3m
- name: Install Eldev
run: curl -fsSL https://raw.github.com/doublep/eldev/master/webinstall/github-eldev | sh
- name: Check out the elisp source code
uses: actions/checkout@v2
# - name: Lint source code with elisp-lint
# run: |
# cd el
# eldev -p -dtT -q lint elisp-lint
- name: Lint documentation with checkdoc
run: |
cd el
eldev -p -dtT lint doc
- name: Test the uncompiled source
run: |
cd el
eldev -p -dtT test
- name: Compile and run tests again
run: |
cd el
eldev compile
eldev -p -dtT test

4
.gitignore vendored
View file

@ -1,4 +0,0 @@
.DS_Store
*.elc
.eldev
/el/sclang-autoloads.el

16
CHANGELOG.md
View file

@ -1,16 +0,0 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- Ability to distribute via package managers
- Support for `completion-at-point-functions` and `company` via `company-capf`
### Changed
- `M-<tab>` or `C-M-i` is no longer bound to `sclang-complete-symbol`
to make builtin completion work as expected.
- `sclang-mode` is now derived from `prog-mode`.

2
CMakeLists.txt
View file

@ -1,4 +1,4 @@
add_subdirectory(el) add_subdirectory(el)
add_subdirectory(sc/scide_scel) add_subdirectory(sc)
install(DIRECTORY HelpSource install(DIRECTORY HelpSource
DESTINATION share/SuperCollider/Extensions/scide_scel/) DESTINATION share/SuperCollider/Extensions/scide_scel/)

203
README.md
View file

@ -1,142 +1,83 @@
# scel - sclang-mode for emacs Scel
====
SuperCollider/Emacs interface SuperCollider/Emacs interface
## Installation
There are 3 options for installation: Installation requirements
-------------------------
1. Using SuperCollider Quarks (recommended) For the HTML help system, you will need emacs-w3m support.
2. Using an Emacs package manager
3. From debian package `supercollider-emacs`
4. From source
Option #1 is the best cross-platform option, and is recommended. Whatever option
you choose, *make sure not to mix installation methods*. In particular, do not
install the Quark if you already have the supercollider-emacs package or if you
compiled SuperCollider with the `-DSC_EL=ON` option. Otherwise you will get an
error from SuperCollider about duplicated classes.
### Install Option 1: SuperCollider's own package manager Installation (default)
----------------------
The repository contains two subprojects. `/el` contains the emacs-lisp By default emacs-lisp files are installed in
implementation. `/sc` contains the SuperCollider code required to
implement the Emacs interface. SuperCollider has its own package system
called Quarks, which we can use to install both halves.
Evaluate this code in the SuperCollider GUI by pasting it and pressing `$prefix/share/emacs/site-lisp`
shift+enter:
SuperCollider files are put in
`$prefix/share/SuperCollider/Extensions/scide_scel`
The only thing you need to do is loading the sclang interface in your `~/.emacs`:
``` supercollider
Quarks.install("https://github.com/supercollider/scel");
``` ```
The scel repository will be downloaded to your local file system and the path
will be added to your currently used `sclang_conf.yaml` file. (You can find its
location by evaluating `Platform.userConfigDir`)
Next, find out where scel was installed. You will use this install-path in your
emacs config.
``` supercollider
Quarks.folder.postln;
// -> /Users/<username>/Library/Application Support/SuperCollider/downloaded-quarks
```
Now in your emacs config, add the `/el` subdirectory to your load path
``` emacs-lisp
;; in ~/.emacs
;; Paste path from above, appending "/scel/el"
(add-to-list 'load-path "/Users/<username>/Library/Application Support/SuperCollider/downloaded-quarks/scel/el")
(require 'sclang)
```
#### On macOS
If `sclang` executable is not on your path, you may need to add it to your
exec-path.
``` emacs-lisp
;; in ~/.emacs
(setq exec-path (append exec-path '("/Applications/SuperCollider.app/Contents/MacOS/")))
```
### Install Option 2: Emacs package manager
The `sclang` package can be installed from [MELPA](https://melpa.org/#/sclang) and configured with [use-package](https://github.com/jwiegley/use-package).
It's possible to install with
[straight.el](https://github.com/raxod502/straight.el),
[use-package](https://github.com/jwiegley/use-package),
[doom](https://github.com/hlissner/doom-emacs), etc. Instructions for doing so
are beyond the scope of this README, but note that `autoloads` are implemented
for entry-point functions so if you like to have a speedy start-up time you can
use the `:defer t` option.
### Install Option 3: Debian package
There is a debian package which provides emacs integration called
`supercollider-emacs`. Option #1 will likely be more recent, but
if you prefer you can install the package with:
``` shell
sudo apt install supercollider-emacs
```
### Install Option 4: Installing from source
If you are building SuperCollider from source, you can optionally compile and
install this library along with it. The cmake `-DSC_EL` flag controls whether
scel will be compiled. On Linux machines `-DSC_EL=ON` by default. See the
supercollider README files for more info.
``` emacs-lisp
;; in ~/.emacs
(add-to-list 'load-path "/usr/local/share/emacs/site-lisp/SuperCollider/") ;; path will depend on your compilation settings
(require 'sclang) (require 'sclang)
``` ```
## Optional Installation Requirements For the HTML help system to fully function also add
```
There are two options for SuperCollider help files. They can be opened in the
help browser that ships with SuperCollider, or if you prefer an emacs-only
workflow they can be opened using the w3m browser. The browse-in-emacs option
requires an additional dependency.
```emacs-lisp
;; in ~/.emacs
(require 'w3m) (require 'w3m)
``` ```
## Usage
The main function which starts interacting with the sclang interpreter is Installation (detailed)
`sclang-start`. You can execute that anywhere with `M-x sclang-start`, or from -----------------------
within a `.scd` buffer by pressing `C-c C-o`.
If you know you want to launch sclang when you start emacs you can use the `-f` Put all `*.el` files in emacs' load-path. e.g. if you put them in
option to execute that function right away: `~/emacs/`, add the following lines to `~/.emacs` (or whatever your init
file is called):
``` shell ```
# in your terminal (add-to-list 'load-path "~/emacs")
emacs -f sclang-start (require 'sclang)
``` ```
## Configuration for the HTML help system to fully function also add
```
(require 'w3m)
```
To fine-tune the installation from within emacs' graphical customization now put all `*.sc` files in sclang's library path, e.g. if you put them
interface, type: in a non-standard location, such as `~/SuperCollider/Emacs`, add the
following to `~/.config/SuperCollider/sclang_conf.yaml` (Linux) or `~/Library/Application Support/SuperCollider/sclang_conf.yaml` (macOS):
`M-x sclang-customize` ```
includePaths:
[~/SuperCollider/Emacs]
```
NOTE: If you use an sclang configuration file different from the default (note normally this is not needed as they are put into sclang's library
`sclang_conf.yaml`, you need to specify it in scel by customizing the path during installation with scons).
`sclang-library-configuration-file `variable. Otherwise, even after installing
the Quark in SuperCollider, you won't be able to run sclang code in emacs.
## Getting help Usage
-----
In order to automatically start sclang when invoking emacs, use the following command line:
```
$> emacs -sclang
```
you're now ready to edit, inspect and execute sclang code!
Getting help
------------
Inside an sclang-mode buffer (e.g. by editing a .sc file), execute Inside an sclang-mode buffer (e.g. by editing a .sc file), execute
@ -146,16 +87,11 @@ and a window with key bindings in sclang-mode will pop up.
`C-x C-h` lets you search for a help file `C-x C-h` lets you search for a help file
`C-M-h` opens or switches to the Help browser (if no Help file has been opened, `C-M-h` opens or switches to the Help browser (if no Help file has been opened, the default Help file will be opened).
the default Help file will be opened).
`E` copies the buffer, puts it in text mode and sclang-minor-mode, to enable you `E` copies the buffer, puts it in text mode and sclang-minor-mode, to enable you to edit the code parts to try out variations of the provided code in the help file. With `C-M-h` you can then return to the Help browser and browse further from the Help file.
to edit the code parts to try out variations of the provided code in the help
file. With `C-M-h` you can then return to the Help browser and browse further
from the Help file.
`C-c C-e` allows you to edit the source of the HTML file, for example if you `C-c C-e` allows you to edit the source of the HTML file, for example if you want to improve it and commit it to the repository.
want to improve it and commit it to the repository.
To enable moving around in the help file with arrow keys add the following To enable moving around in the help file with arrow keys add the following
in your `~/.emacs`: in your `~/.emacs`:
@ -169,18 +105,25 @@ in your `~/.emacs`:
(define-key w3m-mode-map [down] 'next-line))) (define-key w3m-mode-map [down] 'next-line)))
``` ```
This ensures that the arrow keys are just for moving through the document, and This ensures that the arrow keys are just for moving through the document, and not from hyperlink to hyperlink, which is the default in w3m-mode.
not from hyperlink to hyperlink, which is the default in w3m-mode.
## Server control Customization
-------------
In the post buffer window, right-click on the server name; by default the two To fine-tune the installation from within emacs' graphical customization interface, type:
servers `internal` and `localhost` are available. You will get a menu with
common server control operations.
To select another server, step through the server list by left-clicking on the `M-x sclang-customize`
server name.
Servers instantiated from the language will automatically be available in the In particular, you will have to customize `sclang-runtime-directory'.
mode line.
Server control
--------------
In the post buffer window, right-click on the server name; by default the two servers `internal` and `localhost` are available. You will get a menu with common server control operations.
To select another server, step through the server list by left-clicking on the server name.
Servers instantiated from the language will automatically be available
in the mode line.

5
el/.dir-locals.el
View file

@ -1,5 +0,0 @@
;; setting for elisp mode and elisp linter
((emacs-lisp-mode . ((fill-column . 80)
(indent-tabs-mode . nil)
(elisp-lint-indent-specs . ((describe . 1)
(it . 1))))))

32
el/CMakeLists.txt
View file

@ -1,32 +1,10 @@
option(SC_EL_BYTECOMPILE "Build emacs-based IDE." ON) option(SC_EL_BYTECOMPILE "Build emacs-based IDE." ON)
mark_as_advanced(SC_EL_BYTECOMPILE) mark_as_advanced(SC_EL_BYTECOMPILE)
set(PKG_DATA_DIR ${CMAKE_INSTALL_PREFIX}/share/SuperCollider)
file(GLOB scel_sources file(GLOB scel_sources
RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.el) RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.el)
list(REMOVE_ITEM scel_sources ".dir-locals.el") set(PKG_DATA_DIR ${CMAKE_INSTALL_PREFIX}/share/SuperCollider)
# if w3m in installed locally add to the load-path
file(GLOB local-load-path
LIST_DIRECTORIES true
"$ENV{HOME}/.emacs.d/site-lisp/w3m-*"
"$ENV{HOME}/.emacs.d/elpa/w3m-*")
foreach (path ${local-load-path})
if(NOT IS_DIRECTORY ${path})
list(REMOVE_ITEM local-load-path ${path})
endif()
endforeach()
list(APPEND local-load-path ${CMAKE_CURRENT_BINARY_DIR})
# convert to string of form " dir1 -L dir2 -L dir3 ..." when more than one dir
string(JOIN " -L " load-path ${local-load-path})
# build the argument string
string(CONCAT EMACS_ARGS "-batch -L " ${load-path} " -f batch-byte-compile")
configure_file(sclang-vars.el.in configure_file(sclang-vars.el.in
${CMAKE_CURRENT_BINARY_DIR}/sclang-vars.el) ${CMAKE_CURRENT_BINARY_DIR}/sclang-vars.el)
@ -39,8 +17,6 @@ set(all_scel_sources ${scel_sources} sclang-vars.el)
install (FILES ${scel_sources} ${CMAKE_CURRENT_BINARY_DIR}/sclang-vars.el install (FILES ${scel_sources} ${CMAKE_CURRENT_BINARY_DIR}/sclang-vars.el
DESTINATION share/emacs/site-lisp/SuperCollider) DESTINATION share/emacs/site-lisp/SuperCollider)
# the emacs command needs to be evaled due to layers of (un)escaping required to add load-path
if (SC_EL_BYTECOMPILE) if (SC_EL_BYTECOMPILE)
find_program(EMACS_EXECUTABLE emacs) find_program(EMACS_EXECUTABLE emacs)
if(NOT EMACS_EXECUTABLE) if(NOT EMACS_EXECUTABLE)
@ -49,8 +25,10 @@ if (SC_EL_BYTECOMPILE)
foreach (el ${all_scel_sources}) foreach (el ${all_scel_sources})
add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${el}c add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${el}c
VERBATIM COMMAND ${EMACS_EXECUTABLE} -batch
COMMAND eval "${EMACS_EXECUTABLE} ${EMACS_ARGS} ${CMAKE_CURRENT_BINARY_DIR}/${el}" -L ${CMAKE_CURRENT_BINARY_DIR}
-f batch-byte-compile
${CMAKE_CURRENT_BINARY_DIR}/${el}
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${el} DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${el}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Creating byte-compiled Emacs lisp ${CMAKE_CURRENT_BINARY_DIR}/${el}c") COMMENT "Creating byte-compiled Emacs lisp ${CMAKE_CURRENT_BINARY_DIR}/${el}c")

7
el/Eldev
View file

@ -1,7 +0,0 @@
; -*- mode: emacs-lisp; lexical-binding: t -*-
;
;; You can obtain eldev from https://github.com/doublep/eldev
;; We use it for package development and running tests
(eldev-use-plugin 'autoloads)
(eldev-use-package-archive 'melpa)

89
el/sclang-browser.el
View file

@ -1,9 +1,5 @@
;;; sclang-browser.el --- SuperCollider documentation browser -*- coding: utf-8; lexical-binding: t -*- ;; copyright 2003 stefan kersten <steve@k-hornz.de>
;; ;;
;; Copyright 2003 stefan kersten <steve@k-hornz.de>
;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as ;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of the ;; published by the Free Software Foundation; either version 2 of the
@ -19,40 +15,31 @@
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
;; USA ;; USA
;;; Commentary: (require 'sclang-util)
;; Browser for SuperCollider documentation. (require 'view nil t)
;; TODO: better factoring ;; TODO: better factoring
;; - derive from view mode, make mode-map pluggable ;; derive from view mode, make mode-map pluggable
;; - define derived mode for completion, definition, help ;; define derived mode for completion, definition, help
;; - update 'display-buffer-reuse-frames'
;; - update ‘view-return-to-alist’
(require 'sclang-util) (defun sclang-browser-fill-keymap (map)
(require 'view)
;;; Code:
(defun sclang-browser-fill-keymap ()
"Create keymap and bindings."
(let ((map (make-sparse-keymap)))
(set-keymap-parent map view-mode-map)
(define-key map "\r" 'sclang-browser-follow-link) (define-key map "\r" 'sclang-browser-follow-link)
(define-key map [mouse-2] 'sclang-browser-mouse-follow-link) (define-key map [mouse-2] 'sclang-browser-mouse-follow-link)
(define-key map "\t" 'sclang-browser-next-link) (define-key map "\t" 'sclang-browser-next-link)
(define-key map [backtab] 'sclang-browser-previous-link) (define-key map [backtab] 'sclang-browser-previous-link)
(define-key map [(shift tab)] 'sclang-browser-previous-link) (define-key map [(shift tab)] 'sclang-browser-previous-link)
(define-key map [?q] 'sclang-browser-quit) (define-key map [?q] 'sclang-browser-quit)
map)) map)
(defvar sclang-browser-mode-map (sclang-browser-fill-keymap)) (defvar sclang-browser-mode-map (sclang-browser-fill-keymap (make-sparse-keymap)))
(defvar sclang-browser-mode-hook nil) (defvar sclang-browser-mode-hook nil)
(defvar sclang-browser-show-hook nil) (defvar sclang-browser-show-hook nil)
(defvar sclang-browser-link-function nil) (defvar sclang-browser-link-function nil
(defvar sclang-browser-return-method nil) "buffer local")
(defvar sclang-browser-return-method nil
"buffer local")
(defun sclang-browser-beginning-of-link () (defun sclang-browser-beginning-of-link ()
"Beginning of link."
(interactive) (interactive)
(when (get-text-property (point) 'sclang-browser-link) (when (get-text-property (point) 'sclang-browser-link)
(while (and (not (bobp)) (while (and (not (bobp))
@ -62,7 +49,6 @@
(point))) (point)))
(defun sclang-browser-next-link (&optional n) (defun sclang-browser-next-link (&optional n)
"Next link (or N further)."
(interactive) (interactive)
(let* ((n (or n 1)) (let* ((n (or n 1))
(prop 'sclang-browser-link) (prop 'sclang-browser-link)
@ -87,12 +73,10 @@
(setq pos (point))))))) (setq pos (point)))))))
(defun sclang-browser-previous-link () (defun sclang-browser-previous-link ()
"Previous link."
(interactive) (interactive)
(sclang-browser-next-link -1)) (sclang-browser-next-link -1))
(defun sclang-browser-follow-link (&optional pos) (defun sclang-browser-follow-link (&optional pos)
"Follow link (optionally POS)."
(interactive) (interactive)
(let* ((pos (or pos (point))) (let* ((pos (or pos (point)))
(data (get-text-property pos 'sclang-browser-link))) (data (get-text-property pos 'sclang-browser-link)))
@ -105,7 +89,6 @@
(error (sclang-message "Error in link function") nil))))))) (error (sclang-message "Error in link function") nil)))))))
(defun sclang-browser-mouse-follow-link (event) (defun sclang-browser-mouse-follow-link (event)
"Link. click. EVENT."
(interactive "e") (interactive "e")
(let* ((start (event-start event)) (let* ((start (event-start event))
(window (car start)) (window (car start))
@ -114,54 +97,53 @@
(sclang-browser-follow-link pos)))) (sclang-browser-follow-link pos))))
(defun sclang-browser-mode () (defun sclang-browser-mode ()
"Major mode for viewing hypertext and navigating references. "Major mode for viewing hypertext and navigating references in it.
Entry to this mode runs the normal hook `sclang-browser-mode-hook' Entry to this mode runs the normal hook `sclang-browser-mode-hook'.
Commands: Commands:
\\{sclang-browser-mode-map}" \\{sclang-browser-mode-map}"
(interactive) (interactive)
(view-mode)
(kill-all-local-variables) (kill-all-local-variables)
(use-local-map sclang-browser-mode-map) (use-local-map sclang-browser-mode-map)
(set-keymap-parent sclang-browser-mode-map view-mode-map)
(setq mode-name "Browser") (setq mode-name "Browser")
(setq major-mode 'sclang-browser-mode) (setq major-mode 'sclang-browser-mode)
(set (make-local-variable 'sclang-browser-link-function) nil) (set (make-local-variable 'sclang-browser-link-function) nil)
(set (make-local-variable 'sclang-browser-return-method) nil) (set (make-local-variable 'sclang-browser-return-method) nil)
(set (make-local-variable 'font-lock-defaults) nil) (set (make-local-variable 'font-lock-defaults) nil)
(view-mode)
(set (make-local-variable 'minor-mode-overriding-map-alist) (set (make-local-variable 'minor-mode-overriding-map-alist)
(list (cons 'view-mode sclang-browser-mode-map))) (list (cons 'view-mode sclang-browser-mode-map)))
(set (make-local-variable 'view-no-disable-on-exit) t) (set (make-local-variable 'view-no-disable-on-exit) t)
(run-hooks 'sclang-browser-mode-hook)) (run-hooks 'sclang-browser-mode-hook))
(defun sclang-browser-mode-setup () (defun sclang-browser-mode-setup ()
"Setup sclang-browser-mode."
(sclang-browser-mode) (sclang-browser-mode)
(setq buffer-read-only nil)) (setq buffer-read-only nil))
(defun sclang-browser-mode-finish () (defun sclang-browser-mode-finish ()
"Finish sclang-browser-mode." (toggle-read-only 1)
(read-only-mode) (setq view-return-to-alist
;; ‘view-return-to-alist’ is an obsolete variable (as of 24.1) (list (cons (selected-window) sclang-browser-return-method)))
;;(setq view-return-to-alist
;; (list (cons (selected-window) sclang-browser-return-method)))
(view-mode -1)
(run-hooks 'sclang-browser-show-hook)) (run-hooks 'sclang-browser-show-hook))
(defun sclang-browser-quit () (defun sclang-browser-quit ()
"Quit the sclang help browser."
(interactive) (interactive)
(when (eq major-mode 'sclang-browser-mode) (when (eq major-mode 'sclang-browser-mode)
(kill-buffer (current-buffer)))) (kill-buffer (current-buffer))))
(defun sclang-browser-make-link (link-text &optional link-data link-function) (defun sclang-browser-make-link (link-text &optional link-data link-function)
"Make a link using LINK-TEXT (optional LINK-DATA and LINK-FUNCTION)." (let ((map (make-sparse-keymap)))
(propertize link-text (propertize link-text
'mouse-face 'highlight 'mouse-face 'highlight
'sclang-browser-link (cons link-function link-data))) ;;'help-echo "mouse-2: follow link"
;;'keymap map
'sclang-browser-link (cons link-function link-data)
;;'sclang-browser-link-data link-data
;;'sclang-browser-link-function link-function)))
)))
(defun sclang-display-browser (buffer-name output-function) (defun sclang-display-browser (buffer-name output-function)
"Display browser using BUFFER-NAME and OUTPUT-FUNCTION. "header: what to insert in the buffer
header: what to insert in the buffer.
link-list: list of (link-text link-function link-data) link-list: list of (link-text link-function link-data)
link-function: function with args (link-text link-data)" link-function: function with args (link-text link-data)"
(let ((temp-buffer-setup-hook '(sclang-browser-mode-setup)) (let ((temp-buffer-setup-hook '(sclang-browser-mode-setup))
@ -178,25 +160,18 @@ link-function: function with args (link-text link-data)"
;; Secondly, the buffer has not been displayed yet, ;; Secondly, the buffer has not been displayed yet,
;; so we don't know whether its frame will be selected. ;; so we don't know whether its frame will be selected.
(cons (selected-window) t)) (cons (selected-window) t))
;; display-buffer-reuse-frames is obsolete since 24.3 (display-buffer-reuse-frames
;; replace with something like (cons (selected-window) 'quit-window))
;;+ (add-to-list 'display-buffer-alist
;;+ '("." nil (reusable-frames . t)))
;;- (display-buffer-reuse-frames
;;- (cons (selected-window) 'quit-window))
((not (one-window-p t)) ((not (one-window-p t))
(cons (selected-window) 'quit-window)) (cons (selected-window) 'quit-window))
;; This variable is provided mainly for backward compatibility (pop-up-windows
;; and should not be used in new code. (cons (selected-window) t))
;; (pop-up-windows
;; (cons (selected-window) t))
(t (t
(list (selected-window) (window-buffer) (list (selected-window) (window-buffer)
(window-start) (window-point))))) (window-start) (window-point)))))
(funcall output-function))))) (funcall output-function)))))
(defmacro with-sclang-browser (buffer-name &rest body) (defmacro with-sclang-browser (buffer-name &rest body)
"Display browser in BUFFER-NAME and run BODY."
`(sclang-display-browser ,buffer-name (lambda () ,@body))) `(sclang-display-browser ,buffer-name (lambda () ,@body)))
;; ===================================================================== ;; =====================================================================
@ -205,4 +180,4 @@ link-function: function with args (link-text link-data)"
(provide 'sclang-browser) (provide 'sclang-browser)
;;; sclang-browser.el ends here ;; EOF

34
el/sclang-dev.el
View file

@ -1,9 +1,3 @@
;;; sclang-dev.el --- IDE for working with SuperCollider -*- coding: utf-8;
;;
;; Copyright 2003 stefan kersten <steve@k-hornz.de>
;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as ;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of the ;; published by the Free Software Foundation; either version 2 of the
@ -20,24 +14,36 @@
;; USA ;; USA
;;; Commentary: (eval-when-compile
;; Edit SuperCollider help files.
(require 'sclang-util) (require 'sclang-util)
(require 'sclang-interp) (require 'sclang-interp)
)
;;; Code:
(sclang-set-command-handler (sclang-set-command-handler
'openDevSource 'openDevSource
(lambda (file))) (lambda (file)
)
)
(defun sclang-edit-dev-source () (defun sclang-edit-dev-source ()
"Edit the help file at the development location." "Edit the help file at the development location."
; (sclang-document-name . (prSetTitle (buffer-name)))
(interactive) (interactive)
;; (sclang-document-name . (prSetTitle (buffer-name))) (sclang-perform-command 'openDevSource (buffer-file-name))
(sclang-perform-command 'openDevSource (buffer-file-name))) )
(provide 'sclang-dev) (provide 'sclang-dev)
;;; sclang-dev.el ends here ;(defun sclang-open-dev-source (file)
; "Open the help file at the development location."
; (if (sclang-html-file-p file)
; (html-mode)
; ;; (find-file file)
; )
; (if ( sclang-sc-file-p file )
; (sclang-mode)
; )
; )

14
el/sclang-document.el
View file

@ -1,9 +1,5 @@
;;; sclang-document.el --- IDE for working with SuperCollider -*- coding: utf-8; ;; copyright 2003 stefan kersten <steve@k-hornz.de>
;; ;;
;; Copyright 2003 stefan kersten <steve@k-hornz.de>
;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as ;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of the ;; published by the Free Software Foundation; either version 2 of the
@ -19,12 +15,6 @@
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
;; USA ;; USA
;;; Commentary:
;; ???
;;; Code:
(provide 'sclang-document) (provide 'sclang-document)
;;; sclang-document.el ends here ;; EOF

181
el/sclang-help.el
View file

@ -1,9 +1,5 @@
;;; sclang-help.el --- IDE for working with SuperCollider -*- coding: utf-8; -*- ;; copyright 2003 stefan kersten <steve@k-hornz.de>
;; ;;
;; Copyright 2003 stefan kersten <steve@k-hornz.de>
;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as ;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of the ;; published by the Free Software Foundation; either version 2 of the
@ -19,44 +15,24 @@
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
;; USA ;; USA
;;; Commentary:
;; Access SuperCollider help files.
;;; Code:
(eval-when-compile (eval-when-compile
(require 'font-lock)) (require 'font-lock))
(require 'w3m) ;; (require 'w3m) ;; not needed during compilation
(require 'cl-lib) (require 'cl-lib)
(require 'sclang-util) (require 'sclang-util)
(require 'sclang-interp) (require 'sclang-interp)
(require 'sclang-language) (require 'sclang-language)
(require 'sclang-mode) (require 'sclang-mode)
(require 'sclang-vars nil 'ignore-missing-file) (require 'sclang-vars)
(require 'sclang-minor-mode) (require 'sclang-minor-mode)
(defun sclang-system-root () (defcustom sclang-help-directory "~/SuperCollider/Help"
"Find the common install location for the platform." "*Directory where the SuperCollider help files are kept. OBSOLETE."
(cond
((boundp 'sclang-system-data-dir)
sclang-system-data-dir)
((eql 'darwin system-type)
(expand-file-name "~/Library/Application Support/SuperCollider"))
((and (eql 'gnu/linux system-type)
(file-exists-p "/usr/local/share/SuperCollider"))
"/usr/local/share/SuperCollider")
((eql 'gnu/linux system-type)
"/usr/share/SuperCollider")))
(defcustom sclang-system-help-dir (expand-file-name "Help" (sclang-system-root))
"Installation dependent help directory."
:group 'sclang-interface :group 'sclang-interface
:type 'directory) :version "21.3"
:type 'directory
:options '(:must-match))
(defcustom sclang-help-path (list sclang-system-help-dir (defcustom sclang-help-path (list sclang-system-help-dir
"~/.local/share/SuperCollider/Help") "~/.local/share/SuperCollider/Help")
@ -65,11 +41,6 @@
:version "21.4" :version "21.4"
:type '(repeat directory)) :type '(repeat directory))
(defcustom sclang-system-extension-dir (expand-file-name "Extensions" (sclang-system-root))
"Installation dependent extension directory."
:group 'sclang-interface
:type 'directory)
(defconst sclang-extension-path (list sclang-system-extension-dir (defconst sclang-extension-path (list sclang-system-extension-dir
"~/.local/share/SuperCollider/Extensions") "~/.local/share/SuperCollider/Extensions")
"List of SuperCollider extension directories.") "List of SuperCollider extension directories.")
@ -97,15 +68,12 @@
(defcustom sclang-help-filters (defcustom sclang-help-filters
'(("p\\.p\\([0-9]+\\)" . "#p\\1") '(("p\\.p\\([0-9]+\\)" . "#p\\1")
("<p class=\"\\(.*\\)\">\\(.*\\)</p>" . "<div id=\"\\1\">\\2</div>")) ("<p class=\"\\(.*\\)\">\\(.*\\)</p>" . "<div id=\"\\1\">\\2</div>"))
"Filters to replace html tags. "list of pairs of (regexp . filter) defining html-tags to be replaced by the function sclang-help-substitute-for-filters"
List of pairs of (regexp . filter) defining html-tags to be replaced
using the function `sclang-help-substitute-for-filters'."
:group 'sclang-interface :group 'sclang-interface
:type '(repeat (cons (string :tag "match") (string :tag "replacement")))) :type '(repeat (cons (string :tag "match") (string :tag "replacement"))))
(defun sclang-help-substitute-for-filters (&rest args) (defun sclang-help-substitute-for-filters (&rest args)
"Substitute various tags in SCs html-docs. "substitute various tags in SCs html-docs"
Optional argument ARGS unused?"
(mapcar #'(lambda (filter) (mapcar #'(lambda (filter)
(let ((regexp (car filter)) (let ((regexp (car filter))
(to-string (cdr filter))) (to-string (cdr filter)))
@ -117,12 +85,12 @@ Optional argument ARGS unused?"
;; w3m's content-filtering system ;; w3m's content-filtering system
(setq w3m-use-filter t) (setq w3m-use-filter t)
;; checks if w3m-filter is loaded. Is `eval-after-load' necessary here?
(eval-after-load "w3m-filter" (eval-after-load "w3m-filter"
'(add-to-list 'w3m-filter-rules '(add-to-list 'w3m-filter-rules
;; run on all files read by w3m... ;; run on all files read by w3m...
'(".*" sclang-help-substitute-for-filters))) '(".*" sclang-help-substitute-for-filters)))
(defvar sclang-help-topic-alist nil (defvar sclang-help-topic-alist nil
"Alist mapping help topics to file names.") "Alist mapping help topics to file names.")
@ -149,49 +117,38 @@ Optional argument ARGS unused?"
;; ===================================================================== ;; =====================================================================
(defun sclang-get-help-file (topic) (defun sclang-get-help-file (topic)
"Get the help file for TOPIC."
(let ((topic (or (cdr (assoc topic sclang-special-help-topics)) topic))) (let ((topic (or (cdr (assoc topic sclang-special-help-topics)) topic)))
(cdr (assoc topic sclang-help-topic-alist)))) (cdr (assoc topic sclang-help-topic-alist))))
(defun sclang-get-help-topic (file) (defun sclang-get-help-topic (file)
"Get the help topic for FILE."
(let ((topic (car (rassoc file sclang-help-topic-alist)))) (let ((topic (car (rassoc file sclang-help-topic-alist))))
(or (car (rassoc topic sclang-special-help-topics)) topic))) (or (car (rassoc topic sclang-special-help-topics)) topic)))
(defun sclang-help-buffer-name (topic) (defun sclang-help-buffer-name (topic)
"Set the help buffer name to TOPIC."
(sclang-make-buffer-name (concat "Help:" topic))) (sclang-make-buffer-name (concat "Help:" topic)))
;; file predicate functions
(defun sclang-rtf-file-p (file) (defun sclang-rtf-file-p (file)
"Does an rtf FILE exist?"
(let ((case-fold-search t)) (let ((case-fold-search t))
(string-match ".*\\.rtf$" file))) (string-match ".*\\.rtf$" file)))
;; ========= ADDITION for HTML help files
(defun sclang-html-file-p (file) (defun sclang-html-file-p (file)
"Does an html FILE exist?"
(let ((case-fold-search t)) (let ((case-fold-search t))
(string-match ".*\\.html?$" file))) (string-match ".*\\.html?$" file)))
(defun sclang-sc-file-p (file) (defun sclang-sc-file-p (file)
"Does an sc FILE exist?"
(let ((case-fold-search t)) (let ((case-fold-search t))
(string-match ".*\\.sc$" file))) (string-match ".*\\.sc$" file)))
(defun sclang-scd-file-p (file) (defun sclang-scd-file-p (file)
"Does an scd FILE exist?"
(let ((case-fold-search t)) (let ((case-fold-search t))
(string-match ".*\\.scd$" file))) (string-match ".*\\.scd$" file)))
(defun sclang-help-file-p (file) (defun sclang-help-file-p (file)
"Is FILE a help file?"
(string-match sclang-help-file-regexp file)) (string-match sclang-help-file-regexp file))
(defun sclang-help-topic-name (file) (defun sclang-help-topic-name (file)
"Get the help topic from FILE." (if (string-match sclang-help-file-regexp file)
(when (string-match sclang-help-file-regexp file)
(cons (file-name-nondirectory (replace-match "" nil nil file 1)) (cons (file-name-nondirectory (replace-match "" nil nil file 1))
file))) file)))
@ -202,7 +159,7 @@ Optional argument ARGS unused?"
(defconst sclang-rtf-face-change-token "\0") (defconst sclang-rtf-face-change-token "\0")
(defun sclang-fill-rtf-syntax-table (table) (defun sclang-fill-rtf-syntax-table (table)
"Fill RTF syntax TABLE." ;; character quote
(modify-syntax-entry ?\\ "/" table) (modify-syntax-entry ?\\ "/" table)
(modify-syntax-entry ?\" "." table) (modify-syntax-entry ?\" "." table)
(modify-syntax-entry ?\{ "(" table) (modify-syntax-entry ?\{ "(" table)
@ -228,19 +185,16 @@ Optional argument ARGS unused?"
(defun sclang-code-p (pos) (not (rtf-p pos)))) (defun sclang-code-p (pos) (not (rtf-p pos))))
(defmacro with-sclang-rtf-state-output (state &rest body) (defmacro with-sclang-rtf-state-output (state &rest body)
"Wrap rtf STATE output around BODY."
`(with-current-buffer (sclang-rtf-state-output ,state) `(with-current-buffer (sclang-rtf-state-output ,state)
,@body)) ,@body))
(defmacro sclang-rtf-state-add-font (state font-id font-name) (defmacro sclang-rtf-state-add-font (state font-id font-name)
"Add font to STATE font table using FONT-ID and FONT-NAME."
`(push (cons ,font-id (intern ,font-name)) (sclang-rtf-state-font-table ,state))) `(push (cons ,font-id (intern ,font-name)) (sclang-rtf-state-font-table ,state)))
(defmacro sclang-rtf-state-apply (state) (defmacro sclang-rtf-state-apply (state)
"Apply STATE to rtf output." (let ((pos (gensym))
(let ((pos (cl-gensym)) (font (gensym))
(font (cl-gensym)) (face (gensym)))
(face (cl-gensym)))
`(with-current-buffer (sclang-rtf-state-output ,state) `(with-current-buffer (sclang-rtf-state-output ,state)
(let ((,pos (or (sclang-rtf-state-pos ,state) (point-min))) (let ((,pos (or (sclang-rtf-state-pos ,state) (point-min)))
(,font (cdr (assq (,font (cdr (assq
@ -257,14 +211,12 @@ Optional argument ARGS unused?"
(setf (sclang-rtf-state-pos ,state) (point))))))) (setf (sclang-rtf-state-pos ,state) (point)))))))
(defmacro sclang-rtf-state-set-font (state font) (defmacro sclang-rtf-state-set-font (state font)
"Set FONT in STATE."
`(progn `(progn
(sclang-rtf-state-apply ,state) (sclang-rtf-state-apply ,state)
(setf (sclang-rtf-state-font ,state) ,font))) (setf (sclang-rtf-state-font ,state) ,font)))
(defmacro sclang-rtf-state-push-face (state face) (defmacro sclang-rtf-state-push-face (state face)
"Push FACE to STATE." (let ((list (gensym)))
(let ((list (cl-gensym)))
`(let ((,list (sclang-rtf-state-face state))) `(let ((,list (sclang-rtf-state-face state)))
(sclang-rtf-state-apply ,state) (sclang-rtf-state-apply ,state)
(unless (memq ,face ,list) (unless (memq ,face ,list)
@ -272,14 +224,12 @@ Optional argument ARGS unused?"
(append ,list (list ,face))))))) (append ,list (list ,face)))))))
(defmacro sclang-rtf-state-pop-face (state face) (defmacro sclang-rtf-state-pop-face (state face)
"Pop FACE from STATE." (let ((list (gensym)))
(let ((list (cl-gensym)))
`(let* ((,list (sclang-rtf-state-face ,state))) `(let* ((,list (sclang-rtf-state-face ,state)))
(sclang-rtf-state-apply ,state) (sclang-rtf-state-apply ,state)
(setf (sclang-rtf-state-face ,state) (delq ,face ,list))))) (setf (sclang-rtf-state-face ,state) (delq ,face ,list)))))
(defun sclang-parse-rtf (state) (defun sclang-parse-rtf (state)
"Parse rtf STATE."
(while (not (eobp)) (while (not (eobp))
(cond ((looking-at "{") (cond ((looking-at "{")
;; container ;; container
@ -309,7 +259,6 @@ Optional argument ARGS unused?"
(forward-char 1))))) (forward-char 1)))))
(defun sclang-parse-rtf-container (state) (defun sclang-parse-rtf-container (state)
"Parse RTF container. STATE."
(cond ((looking-at "\\\\rtf1") ; document (cond ((looking-at "\\\\rtf1") ; document
(goto-char (match-end 0)) (goto-char (match-end 0))
(sclang-parse-rtf state)) (sclang-parse-rtf state))
@ -327,10 +276,10 @@ Optional argument ARGS unused?"
(insert-image image) (insert-image image)
(sclang-rtf-state-push-face state 'italic) (sclang-rtf-state-push-face state 'italic)
(insert file) (insert file)
(sclang-rtf-state-pop-face state 'italic))))))) (sclang-rtf-state-pop-face state 'italic)))))
))
(defun sclang-parse-rtf-control (state ctrl) (defun sclang-parse-rtf-control (state ctrl)
"Parse RTF control chars. STATE CTRL."
(let ((char (aref ctrl 0))) (let ((char (aref ctrl 0)))
(cond ((memq char '(?{ ?} ?\\)) (cond ((memq char '(?{ ?} ?\\))
(with-sclang-rtf-state-output state (insert char))) (with-sclang-rtf-state-output state (insert char)))
@ -350,10 +299,10 @@ Optional argument ARGS unused?"
((string= ctrl "b0") ((string= ctrl "b0")
(sclang-rtf-state-pop-face state 'bold)) (sclang-rtf-state-pop-face state 'bold))
((string-match "^f[0-9]+$" ctrl) ((string-match "^f[0-9]+$" ctrl)
(sclang-rtf-state-set-font state ctrl))))) (sclang-rtf-state-set-font state ctrl))
)))
(defun sclang-convert-rtf-buffer (output) (defun sclang-convert-rtf-buffer (output)
"Convert rtf buffer. OUTPUT."
(let ((case-fold-search nil) (let ((case-fold-search nil)
(fill-column sclang-help-fill-column)) (fill-column sclang-help-fill-column))
(save-excursion (save-excursion
@ -369,20 +318,17 @@ Optional argument ARGS unused?"
;; ===================================================================== ;; =====================================================================
(defun sclang-fill-help-syntax-table (table) (defun sclang-fill-help-syntax-table (table)
"Fill help syntax TABLE."
;; make ?- be part of symbols for selection and sclang-symbol-at-point ;; make ?- be part of symbols for selection and sclang-symbol-at-point
(modify-syntax-entry ?- "_" table)) (modify-syntax-entry ?- "_" table))
(defun sclang-fill-help-mode-map (map) (defun sclang-fill-help-mode-map (map)
"Fill sclang help mode keymap MAP."
(define-key map "\C-c}" 'bury-buffer) (define-key map "\C-c}" 'bury-buffer)
(define-key map "\C-c\C-v" 'sclang-edit-help-file)) (define-key map "\C-c\C-v" 'sclang-edit-help-file))
(defmacro sclang-help-mode-limit-point-to-code (&rest body) (defmacro sclang-help-mode-limit-point-to-code (&rest body)
"Limit point to code BODY." (let ((min (gensym))
(let ((min (cl-gensym)) (max (gensym))
(max (cl-gensym)) (res (gensym)))
(res (cl-gensym)))
`(if (and (sclang-code-p (point)) `(if (and (sclang-code-p (point))
(not (or (bobp) (eobp))) (not (or (bobp) (eobp)))
(sclang-code-p (1- (point))) (sclang-code-p (1- (point)))
@ -395,17 +341,14 @@ Optional argument ARGS unused?"
(t ,res))))))) (t ,res)))))))
(defun sclang-help-mode-beginning-of-defun (&optional arg) (defun sclang-help-mode-beginning-of-defun (&optional arg)
"Move to beginning of function (or back ARG)."
(interactive "p") (interactive "p")
(sclang-help-mode-limit-point-to-code (sclang-beginning-of-defun arg))) (sclang-help-mode-limit-point-to-code (sclang-beginning-of-defun arg)))
(defun sclang-help-mode-end-of-defun (&optional arg) (defun sclang-help-mode-end-of-defun (&optional arg)
"Move to end of function (or forward ARG)."
(interactive "p") (interactive "p")
(sclang-help-mode-limit-point-to-code (sclang-end-of-defun arg))) (sclang-help-mode-limit-point-to-code (sclang-end-of-defun arg)))
(defun sclang-help-mode-fontify-region (start end loudly) (defun sclang-help-mode-fontify-region (start end loudly)
"Fontify region from START to END and LOUDLY."
(cl-flet ((fontify-code (cl-flet ((fontify-code
(start end loudly) (start end loudly)
(funcall 'font-lock-default-fontify-region start end loudly)) (funcall 'font-lock-default-fontify-region start end loudly))
@ -433,7 +376,6 @@ Optional argument ARGS unused?"
(defun sclang-help-mode-indent-line () (defun sclang-help-mode-indent-line ()
"Indent sclang code in documentation."
(if (sclang-code-p (point)) (if (sclang-code-p (point))
(sclang-indent-line) (sclang-indent-line)
(insert "\t"))) (insert "\t")))
@ -454,7 +396,7 @@ Optional argument ARGS unused?"
(unwind-protect (unwind-protect
(progn (progn
(sclang-convert-rtf-buffer tmp-buffer) (sclang-convert-rtf-buffer tmp-buffer)
(read-only-mode) (toggle-read-only 0)
(erase-buffer) (erase-buffer)
(insert-buffer-substring tmp-buffer)) (insert-buffer-substring tmp-buffer))
(and (buffer-modified-p) (not modified-p) (set-buffer-modified-p nil)) (and (buffer-modified-p) (not modified-p) (set-buffer-modified-p nil))
@ -464,7 +406,8 @@ Optional argument ARGS unused?"
(append font-lock-defaults (append font-lock-defaults
'((font-lock-fontify-region-function . sclang-help-mode-fontify-region)))) '((font-lock-fontify-region-function . sclang-help-mode-fontify-region))))
(set (make-local-variable 'beginning-of-defun-function) 'sclang-help-mode-beginning-of-defun) (set (make-local-variable 'beginning-of-defun-function) 'sclang-help-mode-beginning-of-defun)
(set (make-local-variable 'indent-line-function) 'sclang-help-mode-indent-line))) (set (make-local-variable 'indent-line-function) 'sclang-help-mode-indent-line)
))
;; ===================================================================== ;; =====================================================================
;; help file access ;; help file access
@ -474,8 +417,7 @@ Optional argument ARGS unused?"
"Answer t if PATH should be skipped during help file indexing." "Answer t if PATH should be skipped during help file indexing."
(let ((directory (file-name-nondirectory path))) (let ((directory (file-name-nondirectory path)))
(cl-some (lambda (regexp) (string-match regexp directory)) (cl-some (lambda (regexp) (string-match regexp directory))
;; skip "." ".." "CVS" ".svn" and "_darcs" directories '("^\.$" "^\.\.$" "^CVS$" "^\.svn$" "^_darcs$"))))
'("\\.\\'" "\\.\\.\\'" "^CVS\\'" "^\\.svn$" "^_darcs\\'"))))
(defun sclang-filter-help-directories (list) (defun sclang-filter-help-directories (list)
"Remove paths to be skipped from LIST of directories." "Remove paths to be skipped from LIST of directories."
@ -485,7 +427,7 @@ Optional argument ARGS unused?"
list)) list))
(defun sclang-directory-files-save (directory &optional full match nosort) (defun sclang-directory-files-save (directory &optional full match nosort)
"List files in DIRECTORY (optionally FULL MATCH NOSORT) or nil." "Return a list of names of files in DIRECTORY, or nil on error."
(condition-case nil (condition-case nil
(directory-files directory full match nosort) (directory-files directory full match nosort)
(error nil))) (error nil)))
@ -544,17 +486,20 @@ Optional argument ARGS unused?"
"Edit the help file associated with the current buffer. "Edit the help file associated with the current buffer.
Switches w3m to edit mode (actually HTML mode)." Switches w3m to edit mode (actually HTML mode)."
(interactive) (interactive)
(w3m-edit-current-url)) (w3m-edit-current-url)
)
(defun sclang-edit-help-code () (defun sclang-edit-help-code ()
"Edit the help file to make code variations. "Edit the help file to make code variations.
Switches to text mode with `sclang-minor-mode'." Switches to text mode with sclang-minor-mode."
(interactive) (interactive)
(w3m-copy-buffer) (w3m-copy-buffer)
;; (text-mode) ;; (text-mode)
(sclang-mode) (sclang-mode)
(read-only-mode) (toggle-read-only)
(rename-buffer "*SC_Help:CodeEdit*")) (rename-buffer "*SC_Help:CodeEdit*")
)
(defun sclang-edit-help-file () (defun sclang-edit-help-file ()
"Edit the help file associated with the current buffer. "Edit the help file associated with the current buffer.
@ -588,7 +533,7 @@ Either visit file internally (.sc) or start external editor (.rtf)."
sclang-help-topic-alist)))))) sclang-help-topic-alist))))))
(defun sclang-goto-help-browser () (defun sclang-goto-help-browser ()
"Switch to the *w3m* buffer to browse help files." "Switch to the *w3m* buffer to browse help files"
(interactive) (interactive)
(let* ((buffer-name "*w3m*") (let* ((buffer-name "*w3m*")
(buffer (get-buffer buffer-name))) (buffer (get-buffer buffer-name)))
@ -600,15 +545,24 @@ Either visit file internally (.sc) or start external editor (.rtf)."
(if buffer2 (if buffer2
(switch-to-buffer buffer2) (switch-to-buffer buffer2)
;; else ;; else
(sclang-find-help "Help")))) (sclang-find-help "Help")
)
)
)
(if buffer (if buffer
(with-current-buffer buffer (with-current-buffer buffer
(rename-buffer "*SC_Help:w3m*") (rename-buffer "*SC_Help:w3m*")
(sclang-help-minor-mode)
;;(setq buffer-read-only false) ;;(setq buffer-read-only false)
(sclang-help-minor-mode))))) )
)
; (if buffer
;
; )
)
)
(defun sclang-find-help (topic) (defun sclang-find-help (topic)
"Find help for TOPIC."
(interactive (interactive
(list (list
(let ((topic (or (and mark-active (buffer-substring-no-properties (region-beginning) (region-end))) (let ((topic (or (and mark-active (buffer-substring-no-properties (region-beginning) (region-end)))
@ -636,15 +590,17 @@ Either visit file internally (.sc) or start external editor (.rtf)."
(set-buffer-modified-p nil))) (set-buffer-modified-p nil)))
(switch-to-buffer buffer)) (switch-to-buffer buffer))
(if (sclang-html-file-p file) (if (sclang-html-file-p file)
(sclang-goto-help-browser))) (sclang-goto-help-browser))
)
(sclang-message "Help file not found") nil) (sclang-message "Help file not found") nil)
(sclang-message "No help for \"%s\"" topic) nil))) (sclang-message "No help for \"%s\"" topic) nil)))
(defun sclang-open-help-gui () (defun sclang-open-help-gui ()
"Open SCDoc Help Browser." "Open SCDoc Help Browser"
(interactive) (interactive)
(sclang-eval-string (sclang-format "Help.gui"))) (sclang-eval-string (sclang-format "Help.gui"))
)
(defvar sclang-scdoc-topics (make-hash-table :size 16385) (defvar sclang-scdoc-topics (make-hash-table :size 16385)
"List of all scdoc topics.") "List of all scdoc topics.")
@ -654,23 +610,24 @@ Either visit file internally (.sc) or start external editor (.rtf)."
(lambda (list-of-symbols) (lambda (list-of-symbols)
(mapcar (lambda (arg) (mapcar (lambda (arg)
(puthash arg nil sclang-scdoc-topics)) (puthash arg nil sclang-scdoc-topics))
list-of-symbols))) list-of-symbols)
))
(defun sclang-find-help-in-gui (topic) (defun sclang-find-help-in-gui (topic)
"Search for TOPIC in Help Browser." "Search for topic in SCDoc Help Browser"
(interactive (interactive
(list (list
(let ((topic (sclang-symbol-at-point))) (let ((topic (sclang-symbol-at-point)))
(completing-read (completing-read (format "Help topic%s: " (if topic
(format "Help topic%s: " (if topic
(format " (default %s)" topic) (format " (default %s)" topic)
"")) ""))
sclang-scdoc-topics nil nil nil 'sclang-help-topic-history topic)))) sclang-scdoc-topics nil nil nil 'sclang-help-topic-history topic)))
)
(if topic (if topic
(sclang-eval-string (sclang-eval-string (sclang-format "HelpBrowser.openHelpFor(%o)" topic))
(sclang-format "HelpBrowser.openHelpFor(%o)" topic)) (sclang-eval-string (sclang-format "Help.gui"))
(sclang-eval-string )
(sclang-format "Help.gui")))) )
;; ===================================================================== ;; =====================================================================
@ -688,18 +645,16 @@ Either visit file internally (.sc) or start external editor (.rtf)."
(lambda () (lambda ()
(clrhash sclang-scdoc-topics))) (clrhash sclang-scdoc-topics)))
(add-to-list 'auto-mode-alist '("\\.rtf\\'" . sclang-help-mode)) (add-to-list 'auto-mode-alist '("\\.rtf$" . sclang-help-mode))
;; ========= ADDITION for HTML help files?? ============ ;; ========= ADDITION for HTML help files?? ============
;; (add-to-list 'auto-mode-alist '("\\.html$" . sclang-help-mode)) ;; (add-to-list 'auto-mode-alist '("\\.html$" . sclang-help-mode))
;; (setq mm-text-html-renderer 'w3m) ;; (setq mm-text-html-renderer 'w3m)
;; (setq mm-inline-text-html-with-images t) ;; (setq mm-inline-text-html-with-images t)
;; (setq mm-inline-text-html-with-w3m-keymap nil) ;; (setq mm-inline-text-html-with-w3m-keymap nil)
;; ===================================================== ;; =====================================================
(sclang-fill-help-syntax-table sclang-help-mode-syntax-table) (sclang-fill-help-syntax-table sclang-help-mode-syntax-table)
(sclang-fill-help-mode-map sclang-help-mode-map) (sclang-fill-help-mode-map sclang-help-mode-map)
(provide 'sclang-help) (provide 'sclang-help)
;;; sclang-help.el ends here ;; EOF

106
el/sclang-interp.el
View file

@ -1,9 +1,5 @@
;;; sclang-interp.el --- IDE for working with SuperCollider -*- coding: utf-8; ;; copyright 2003-2005 stefan kersten <steve@k-hornz.de>
;; ;;
;; Copyright 2003 stefan kersten <steve@k-hornz.de>
;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as ;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of the ;; published by the Free Software Foundation; either version 2 of the
@ -19,12 +15,9 @@
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
;; USA ;; USA
(eval-when-compile
;;; Commentary:
;; SuperCollider interpreter interface
(require 'sclang-util) (require 'sclang-util)
(require 'compile) (require 'compile))
;; ===================================================================== ;; =====================================================================
;; post buffer access ;; post buffer access
@ -32,8 +25,6 @@
;; FIXME: everything will fail when renaming the post buffer! ;; FIXME: everything will fail when renaming the post buffer!
;;; Code:
(defconst sclang-post-buffer (sclang-make-buffer-name "PostBuffer") (defconst sclang-post-buffer (sclang-make-buffer-name "PostBuffer")
"Name of the SuperCollider process output buffer.") "Name of the SuperCollider process output buffer.")
@ -44,7 +35,7 @@
"Character for highlighting errors (utf-8).") "Character for highlighting errors (utf-8).")
(defconst sclang-parse-error-regexp (defconst sclang-parse-error-regexp
"^\\(WARNING\\|ERROR\\): .*\n[\t ]*in file '\\([^']+\\)'\n[\t ]*line \\([0-9]+\\) char \\([0-9]+\\)" "^\\(WARNING\\|ERROR\\): .*\n[\t ]*in file '\\([^']\+\\)'\n[\t ]*line \\([0-9]\+\\) char \\([0-9]\+\\)"
"Regular expression matching parse errors during library compilation.") "Regular expression matching parse errors during library compilation.")
(defcustom sclang-max-post-buffer-size 0 (defcustom sclang-max-post-buffer-size 0
@ -62,11 +53,9 @@ Default behavior is to only scroll when point is not at end of buffer."
:type 'boolean) :type 'boolean)
(defun sclang-get-post-buffer () (defun sclang-get-post-buffer ()
"Get or create the sclang post buffer."
(get-buffer-create sclang-post-buffer)) (get-buffer-create sclang-post-buffer))
(defmacro with-sclang-post-buffer (&rest body) (defmacro with-sclang-post-buffer (&rest body)
"BODY in the sclang post buffer."
`(with-current-buffer (sclang-get-post-buffer) `(with-current-buffer (sclang-get-post-buffer)
,@body)) ,@body))
@ -127,14 +116,13 @@ If EOB-P is non-nil, positions cursor at end of buffer."
(lambda (&rest args))) (lambda (&rest args)))
;; setup compilation mode ;; setup compilation mode
(compilation-minor-mode) (compilation-minor-mode)
;; see elisp docs for `make-variable-buffer-local' and `make-local-variable' use cases (set (make-variable-buffer-local 'compilation-error-screen-columns) nil)
(set (make-local-variable 'compilation-error-screen-columns) nil) (set (make-variable-buffer-local 'compilation-error-regexp-alist)
(set (make-local-variable 'compilation-error-regexp-alist)
(cons (list sclang-parse-error-regexp 2 3 4) compilation-error-regexp-alist)) (cons (list sclang-parse-error-regexp 2 3 4) compilation-error-regexp-alist))
(set (make-local-variable 'compilation-parse-errors-function) (set (make-variable-buffer-local 'compilation-parse-errors-function)
(lambda (limit-search find-at-least) (lambda (limit-search find-at-least)
(compilation-parse-errors limit-search find-at-least))) (compilation-parse-errors limit-search find-at-least)))
(set (make-local-variable 'compilation-parse-errors-filename-function) (set (make-variable-buffer-local 'compilation-parse-errors-filename-function)
(lambda (file-name) (lambda (file-name)
file-name))) file-name)))
(sclang-clear-post-buffer) (sclang-clear-post-buffer)
@ -202,7 +190,6 @@ If EOB-P is non-nil, positions cursor at end of buffer."
;; ===================================================================== ;; =====================================================================
(defun sclang-get-process () (defun sclang-get-process ()
"Return the current sclang process."
(get-process sclang-process)) (get-process sclang-process))
;; ===================================================================== ;; =====================================================================
@ -231,19 +218,16 @@ If EOB-P is non-nil, positions cursor at end of buffer."
;; initialization ;; initialization
(defun sclang-library-initialized-p () (defun sclang-library-initialized-p ()
"Is sclang library initialized?"
(and (sclang-get-process) (and (sclang-get-process)
sclang-library-initialized-p)) sclang-library-initialized-p))
(defun sclang-on-library-startup () (defun sclang-on-library-startup ()
"Initialize sclang library."
(sclang-message "Initializing library...") (sclang-message "Initializing library...")
(setq sclang-library-initialized-p t) (setq sclang-library-initialized-p t)
(run-hooks 'sclang-library-startup-hook) (run-hooks 'sclang-library-startup-hook)
(sclang-message "Initializing library...done")) (sclang-message "Initializing library...done"))
(defun sclang-on-library-shutdown () (defun sclang-on-library-shutdown ()
"Library shutdown."
(when sclang-library-initialized-p (when sclang-library-initialized-p
(run-hooks 'sclang-library-shutdown-hook) (run-hooks 'sclang-library-shutdown-hook)
(setq sclang-library-initialized-p nil) (setq sclang-library-initialized-p nil)
@ -254,7 +238,6 @@ If EOB-P is non-nil, positions cursor at end of buffer."
;; ===================================================================== ;; =====================================================================
(defun sclang-process-sentinel (proc msg) (defun sclang-process-sentinel (proc msg)
"Process sentinel PROC MSG."
(with-sclang-post-buffer (with-sclang-post-buffer
(goto-char (point-max)) (goto-char (point-max))
(insert (insert
@ -266,7 +249,6 @@ If EOB-P is non-nil, positions cursor at end of buffer."
(sclang-stop-command-process))) (sclang-stop-command-process)))
(defun sclang-process-filter (process string) (defun sclang-process-filter (process string)
"Process filter PROCESS STRING."
(let ((buffer (process-buffer process))) (let ((buffer (process-buffer process)))
(with-current-buffer buffer (with-current-buffer buffer
(when (and (> sclang-max-post-buffer-size 0) (when (and (> sclang-max-post-buffer-size 0)
@ -294,16 +276,13 @@ If EOB-P is non-nil, positions cursor at end of buffer."
;; ===================================================================== ;; =====================================================================
(defun sclang-memory-option-p (string) (defun sclang-memory-option-p (string)
"Is STRING an sclang memory option?"
(let ((case-fold-search nil)) (let ((case-fold-search nil))
(string-match "^[1-9][0-9]*[km]?$" string))) (string-match "^[1-9][0-9]*[km]?$" string)))
(defun sclang-port-option-p (number) (defun sclang-port-option-p (number)
"Is NUMBER a valid sclang port?"
(and (integerp number) (>= number 0) (<= number #XFFFF))) (and (integerp number) (>= number 0) (<= number #XFFFF)))
(defun sclang-make-options () (defun sclang-make-options ()
"Make options."
(let ((default-directory "")) (let ((default-directory ""))
(nconc (nconc
(when (and sclang-runtime-directory (when (and sclang-runtime-directory
@ -324,7 +303,6 @@ If EOB-P is non-nil, positions cursor at end of buffer."
(list "-s")) (list "-s"))
(list "-iscel")))) (list "-iscel"))))
;;;###autoload (autoload 'sclang-start "sclang" "Start SuperCollider process." t)
(defun sclang-start () (defun sclang-start ()
"Start SuperCollider process." "Start SuperCollider process."
(interactive) (interactive)
@ -368,7 +346,8 @@ If EOB-P is non-nil, positions cursor at end of buffer."
"Recompile class library." "Recompile class library."
(interactive) (interactive)
(when (sclang-get-process) (when (sclang-get-process)
(process-send-string sclang-process "\x18"))) (process-send-string sclang-process "\x18")
))
;; ===================================================================== ;; =====================================================================
;; command process ;; command process
@ -392,26 +371,23 @@ Change this if \"cat\" has a non-standard name or location."
"Subprocess for receiving command results from sclang.") "Subprocess for receiving command results from sclang.")
(defconst sclang-cmd-helper-proc "SCLang Command Helper" (defconst sclang-cmd-helper-proc "SCLang Command Helper"
"Dummy subprocess that will keep the command fifo open for writing. "Dummy subprocess that will keep the command fifo open for writing
This is needed so reading does not automatically fail when sclang so reading does not fail automatically when sclang closes its own
closes its own writing end of the fifo.") writing end of the fifo")
(defvar sclang-command-fifo nil (defvar sclang-command-fifo nil
"FIFO for communicating with the subprocess.") "FIFO for communicating with the subprocess.")
(defun sclang-delete-command-fifo () (defun sclang-delete-command-fifo ()
"Delete the command fifo."
(and sclang-command-fifo (and sclang-command-fifo
(file-exists-p sclang-command-fifo) (file-exists-p sclang-command-fifo)
(delete-file sclang-command-fifo))) (delete-file sclang-command-fifo)))
(defun sclang-release-command-fifo () (defun sclang-release-command-fifo ()
"Release the command fifo."
(sclang-delete-command-fifo) (sclang-delete-command-fifo)
(setq sclang-command-fifo nil)) (setq sclang-command-fifo nil))
(defun sclang-create-command-fifo () (defun sclang-create-command-fifo ()
"Create the command fifo."
(setq sclang-command-fifo (make-temp-name (setq sclang-command-fifo (make-temp-name
(expand-file-name (expand-file-name
"sclang-command-fifo." temporary-file-directory))) "sclang-command-fifo." temporary-file-directory)))
@ -424,7 +400,6 @@ closes its own writing end of the fifo.")
(setq sclang-command-fifo nil)))) (setq sclang-command-fifo nil))))
(defun sclang-start-command-process () (defun sclang-start-command-process ()
"Start the command process."
(sclang-create-command-fifo) (sclang-create-command-fifo)
(when sclang-command-fifo (when sclang-command-fifo
;; start the dummy process to keep the fifo open ;; start the dummy process to keep the fifo open
@ -448,7 +423,6 @@ closes its own writing end of the fifo.")
(message "SCLang: Couldn't start command process")))) (message "SCLang: Couldn't start command process"))))
(defun sclang-stop-command-process () (defun sclang-stop-command-process ()
"Stop the command process."
(when (get-process sclang-cmd-helper-proc) (when (get-process sclang-cmd-helper-proc)
(kill-process sclang-cmd-helper-proc) (kill-process sclang-cmd-helper-proc)
(delete-process sclang-cmd-helper-proc)) (delete-process sclang-cmd-helper-proc))
@ -460,7 +434,6 @@ closes its own writing end of the fifo.")
"Unprocessed command process output.") "Unprocessed command process output.")
(defun sclang-command-process-filter (proc string) (defun sclang-command-process-filter (proc string)
"Command process filter PROC STRING."
(when sclang-command-process-previous (when sclang-command-process-previous
(setq string (concat sclang-command-process-previous string))) (setq string (concat sclang-command-process-previous string)))
(let (end) (let (end)
@ -479,31 +452,27 @@ closes its own writing end of the fifo.")
;; symbol property: sclang-command-handler ;; symbol property: sclang-command-handler
(defun sclang-set-command-handler (symbol function) (defun sclang-set-command-handler (symbol function)
"Set command handler SYMBOL to FUNCTION."
(put symbol 'sclang-command-handler function)) (put symbol 'sclang-command-handler function))
(defun sclang-perform-command (symbol &rest args) (defun sclang-perform-command (symbol &rest args)
"Eval command SYMBOL with ARGS."
(sclang-eval-string (sclang-format (sclang-eval-string (sclang-format
"Emacs.lispPerformCommand(%o, %o, true)" "Emacs.lispPerformCommand(%o, %o, true)"
symbol args))) symbol args)))
(defun sclang-perform-command-no-result (symbol &rest args) (defun sclang-perform-command-no-result (symbol &rest args)
"Eval command SYMBOL with ARGS. No result."
(sclang-eval-string (sclang-format (sclang-eval-string (sclang-format
"Emacs.lispPerformCommand(%o, %o, false)" "Emacs.lispPerformCommand(%o, %o, false)"
symbol args))) symbol args)))
(defun sclang-default-command-handler (fun arg) (defun sclang-default-command-handler (fun arg)
"Default command handler for FUN with ARG. "Default command handler.
Displays short message on error." Displays short message on error."
(condition-case err (condition-case nil
(funcall fun arg) (funcall fun arg)
(error (sclang-message (error (sclang-message "Error in command handler") nil)))
(format "Error in command handler: %s" err)) nil)))
(defun sclang-debug-command-handler (fun arg) (defun sclang-debug-command-handler (fun arg)
"Debugging command handler for FUN with ARG. "Debugging command handler.
Enters debugger on error." Enters debugger on error."
(let ((debug-on-error t) (let ((debug-on-error t)
(debug-on-signal t)) (debug-on-signal t))
@ -513,21 +482,20 @@ Enters debugger on error."
"Function called when handling command result.") "Function called when handling command result.")
(defun sclang-toggle-debug-command-handler (&optional arg) (defun sclang-toggle-debug-command-handler (&optional arg)
"Toggle debugging of command handler (or set with ARG). "Toggle debugging of command handler.
Activate debugging iff ARG is positive." With arg, activate debugging iff arg is positive."
(interactive "P") (interactive "P")
(setq sclang-command-handler (setq sclang-command-handler
(if (or (and arg (> arg 0)) (if (or (and arg (> arg 0))
(eq sclang-command-handler 'sclang-debug-command-handler)) (eq sclang-command-handler 'sclang-debug-command-handler))
'sclang-default-command-handler 'sclang-default-command-handler
'sclang-debug-command-handler)) 'sclang-default-command-handler))
(sclang-message "Command handler debugging %s." (sclang-message "Command handler debugging %s."
(if (eq sclang-command-handler 'sclang-debug-command-handler) (if (eq sclang-command-handler 'sclang-debug-command-handler)
"enabled" "enabled"
"disabled"))) "disabled")))
(defun sclang-handle-command-result (list) (defun sclang-handle-command-result (list)
"Handle command result LIST."
(condition-case nil (condition-case nil
(let ((fun (get (nth 0 list) 'sclang-command-handler)) (let ((fun (get (nth 0 list) 'sclang-command-handler))
(arg (nth 1 list)) (arg (nth 1 list))
@ -552,26 +520,25 @@ Activate debugging iff ARG is positive."
:type 'boolean) :type 'boolean)
(defun sclang-send-string (token string &optional force) (defun sclang-send-string (token string &optional force)
"Send TOKEN STRING to sclang (optionally FORCE)."
(let ((proc (sclang-get-process))) (let ((proc (sclang-get-process)))
(when (and proc (or (sclang-library-initialized-p) force)) (when (and proc (or (sclang-library-initialized-p) force))
(process-send-string proc (concat string token)) (process-send-string proc (concat string token))
string))) string)))
(defun sclang-eval-string (string &optional print-p) (defun sclang-eval-string (string &optional print-p)
"Evaluate STRING with sclang and print the result if PRINT-P is non-nil. "Send STRING to the sclang process for evaluation and print the result
Return STRING if successful, otherwise nil." if PRINT-P is non-nil. Return STRING if successful, otherwise nil."
(sclang-send-string (sclang-send-string
(if print-p sclang-token-interpret-print-cmd-line sclang-token-interpret-cmd-line) (if print-p sclang-token-interpret-print-cmd-line sclang-token-interpret-cmd-line)
string)) string))
(defun sclang-eval-expression (string &optional silent-p) (defun sclang-eval-expression (string &optional silent-p)
"Evaluate STRING as SuperCollider code (suppress output if SILENT-P is non-nil)." "Execute STRING as SuperCollider code."
(interactive "sEval: \nP") (interactive "sEval: \nP")
(sclang-eval-string string (not silent-p))) (sclang-eval-string string (not silent-p)))
(defun sclang-eval-line (&optional silent-p) (defun sclang-eval-line (&optional silent-p)
"Evaluate current line with sclang (suppress output if SILENT-P is non-nil)." "Execute the current line as SuperCollider code."
(interactive "P") (interactive "P")
(let ((string (sclang-line-at-point))) (let ((string (sclang-line-at-point)))
(when string (when string
@ -582,39 +549,32 @@ Return STRING if successful, otherwise nil."
string)) string))
(defun sclang-eval-region (&optional silent-p) (defun sclang-eval-region (&optional silent-p)
"Evaluate current region with sclang (suppress output if SILENT-P is non-nil)." "Execute the region as SuperCollider code."
(interactive "P") (interactive "P")
(sclang-eval-string (sclang-eval-string
(buffer-substring-no-properties (region-beginning) (region-end)) (buffer-substring-no-properties (region-beginning) (region-end))
(not silent-p))) (not silent-p)))
(defun sclang-eval-region-or-line (&optional silent-p) (defun sclang-eval-region-or-line (&optional silent-p)
"Evaluate current line or region (suppress output if SILENT-P is non-nil)."
(interactive "P") (interactive "P")
(if (and transient-mark-mode mark-active) (if (and transient-mark-mode mark-active)
(sclang-eval-region silent-p) (sclang-eval-region silent-p)
(sclang-eval-line silent-p))) (sclang-eval-line silent-p)))
(defun sclang-eval-defun (&optional silent-p) (defun sclang-eval-defun (&optional silent-p)
"Evaluate current function definition (suppress output if SILENT-P is non-nil)."
(interactive "P") (interactive "P")
(let ((string (sclang-defun-at-point))) (let ((string (sclang-defun-at-point)))
(when (and string (string-match "^(" string)) (when (and string (string-match "^(" string))
(sclang-eval-string string (not silent-p)) (sclang-eval-string string (not silent-p))
string))) string)))
(defun sclang-eval-dwim ()
"Evaluate line, region, function or buffer."
(interactive "P")
(or (sclang-eval-defun)
(sclang-eval-region-or-line)))
(defun sclang-eval-document (&optional silent-p) (defun sclang-eval-document (&optional silent-p)
"Evaluate current buffer with sclang (suppress output if SILENT-P is non-nil)." "Execute the whole document as SuperCollider code."
(interactive "P") (interactive "P")
(save-excursion (save-excursion
(mark-whole-buffer)
(sclang-eval-string (sclang-eval-string
(buffer-substring-no-properties (point-min) (point-max)) (buffer-substring-no-properties (region-beginning) (region-end))
(not silent-p)))) (not silent-p))))
(defvar sclang-eval-results nil (defvar sclang-eval-results nil
@ -625,7 +585,7 @@ Return STRING if successful, otherwise nil."
(lambda (arg) (push arg sclang-eval-results))) (lambda (arg) (push arg sclang-eval-results)))
(defun sclang-eval-sync (string) (defun sclang-eval-sync (string)
"Eval STRING in sclang and return result as a Lisp value." "Eval STRING in sclang and return result as a lisp value."
(let ((proc (get-process sclang-command-process))) (let ((proc (get-process sclang-command-process)))
(if (and (processp proc) (eq (process-status proc) 'run)) (if (and (processp proc) (eq (process-status proc) 'run))
(let ((time (current-time)) (tick 10000) elt) (let ((time (current-time)) (tick 10000) elt)
@ -693,18 +653,15 @@ Return STRING if successful, otherwise nil."
(defconst sclang-workspace-buffer (sclang-make-buffer-name "Workspace")) (defconst sclang-workspace-buffer (sclang-make-buffer-name "Workspace"))
(defun sclang-fill-workspace-mode-map (map) (defun sclang-fill-workspace-mode-map (map)
"Fill the workspace keymap MAP."
(define-key map "\C-c}" 'bury-buffer)) (define-key map "\C-c}" 'bury-buffer))
(defun sclang-switch-to-workspace () (defun sclang-switch-to-workspace ()
"Switch to SuperCollider workspace buffer."
(interactive) (interactive)
(let ((buffer (get-buffer sclang-workspace-buffer))) (let ((buffer (get-buffer sclang-workspace-buffer)))
(unless buffer (unless buffer
(setq buffer (get-buffer-create sclang-workspace-buffer)) (setq buffer (get-buffer-create sclang-workspace-buffer))
(with-current-buffer buffer (with-current-buffer buffer
(sclang-mode) (sclang-mode)
;; why a buffer local keymap?
(let ((map (make-sparse-keymap))) (let ((map (make-sparse-keymap)))
(set-keymap-parent map sclang-mode-map) (set-keymap-parent map sclang-mode-map)
(sclang-fill-workspace-mode-map map) (sclang-fill-workspace-mode-map map)
@ -733,12 +690,10 @@ Return STRING if successful, otherwise nil."
;; ===================================================================== ;; =====================================================================
(defun sclang-main-run () (defun sclang-main-run ()
"Run sclang process."
(interactive) (interactive)
(sclang-eval-string "thisProcess.run")) (sclang-eval-string "thisProcess.run"))
(defun sclang-main-stop () (defun sclang-main-stop ()
"Stop sclang process."
(interactive) (interactive)
(sclang-eval-string "thisProcess.stop")) (sclang-eval-string "thisProcess.stop"))
@ -784,7 +739,6 @@ Return STRING if successful, otherwise nil."
(sclang-mode) (sclang-mode)
(switch-to-buffer (current-buffer)))))))) (switch-to-buffer (current-buffer))))))))
(provide 'sclang-interp) (provide 'sclang-interp)
;;; sclang-interp.el ends here ;; EOF

22
el/sclang-keys.el
View file

@ -1,9 +1,5 @@
;;; sclang-keys.el --- IDE for working with SuperCollider -*- coding: utf-8; ;; copyright 2003 stefan kersten <steve@k-hornz.de>
;; ;;
;; Copyright 2003 stefan kersten <steve@k-hornz.de>
;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as ;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of the ;; published by the Free Software Foundation; either version 2 of the
@ -19,15 +15,6 @@
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
;; USA ;; USA
;;; Commentary:
;; Read & send keys between Emacs and SuperCollider
;;; Code:
(eval-and-compile (require 'sclang-util)
(require 'sclang-interp))
;; (defvar sclang-key-table (make-char-table 'foo)) ;; (defvar sclang-key-table (make-char-table 'foo))
;; (defun sclang-define-key (char beg end) ;; (defun sclang-define-key (char beg end)
@ -38,9 +25,10 @@
;; (defun sclang-execute-key (char) ;; (defun sclang-execute-key (char)
;; (sclang-eval-string (sclang-format "Emacs.executeKey(%o)" char))) ;; (sclang-eval-string (sclang-format "Emacs.executeKey(%o)" char)))
(eval-and-compile (require 'sclang-util)
(require 'sclang-interp))
(defun sclang-read-keys () (defun sclang-read-keys ()
"Read and send keys between Emacs and SuperCollider."
(interactive) (interactive)
(let (char) (let (char)
(clear-this-command-keys) (clear-this-command-keys)
@ -51,7 +39,5 @@
(message "%s (%d)" (char-to-string char) char) (message "%s (%d)" (char-to-string char) char)
(sclang-eval-string (format "Emacs.keys.at(%d).value(%d)" char char)))))) (sclang-eval-string (format "Emacs.keys.at(%d).value(%d)" char char))))))
;; EOF
(provide 'sclang-keys)
;;; sclang-keys.el ends here

125
el/sclang-language.el
View file

@ -1,9 +1,5 @@
;;; sclang-language.el --- IDE for working with SuperCollider -*- coding: utf-8; ;; copyright 2003-2005 stefan kersten <steve@k-hornz.de>
;; ;;
;; Copyright 2003 stefan kersten <steve@k-hornz.de>
;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as ;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of the ;; published by the Free Software Foundation; either version 2 of the
@ -19,20 +15,14 @@
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
;; USA ;; USA
;;; Commentary:
;; Utilities for SuperCollider syntax
(require 'cl-lib) (require 'cl-lib)
(require 'sclang-browser) (require 'sclang-browser)
(require 'sclang-interp) (require 'sclang-interp)
(require 'sclang-util) (require 'sclang-util)
;; =================================================================== ;; =====================================================================
;; regexp utilities ;; regexp utilities
;; =================================================================== ;; =====================================================================
;;; Code:
(defun sclang-regexp-group (regexp &optional addressable) (defun sclang-regexp-group (regexp &optional addressable)
"Enclose REGEXP in grouping parentheses. "Enclose REGEXP in grouping parentheses.
@ -47,9 +37,9 @@ separately after matching."
The expressions are joined as alternatives with the \\| operator." The expressions are joined as alternatives with the \\| operator."
(mapconcat 'sclang-regexp-group regexps "\\|")) (mapconcat 'sclang-regexp-group regexps "\\|"))
;; =================================================================== ;; =====================================================================
;; some useful regular expressions ;; some useful regular expressions
;; =================================================================== ;; =====================================================================
(defconst sclang-symbol-regexp (defconst sclang-symbol-regexp
"\\(?:\\sw\\|\\s_\\)*" "\\(?:\\sw\\|\\s_\\)*"
@ -129,9 +119,9 @@ enclosed by parenthesis (`sclang-block-regexp').")
A specification is of the form <class-name>-<method-name>.") A specification is of the form <class-name>-<method-name>.")
;; =================================================================== ;; =====================================================================
;; regexp building ;; regexp building
;; =================================================================== ;; =====================================================================
(defun sclang-make-class-definition-regexp (name) (defun sclang-make-class-definition-regexp (name)
"Return a regular expression matching the class definition NAME." "Return a regular expression matching the class definition NAME."
@ -148,9 +138,9 @@ A specification is of the form <class-name>-<method-name>.")
"Return a regular expression matching the method definition NAME." "Return a regular expression matching the method definition NAME."
(concat "\\(" (regexp-quote name) "\\)\\s *{")) (concat "\\(" (regexp-quote name) "\\)\\s *{"))
;; =================================================================== ;; =====================================================================
;; string matching ;; string matching
;; =================================================================== ;; =====================================================================
(defun sclang-string-match (regexp string) (defun sclang-string-match (regexp string)
"Match REGEXP with STRING while preserving case." "Match REGEXP with STRING while preserving case."
@ -158,57 +148,48 @@ A specification is of the form <class-name>-<method-name>.")
(string-match regexp string))) (string-match regexp string)))
(defun sclang-symbol-match (symbol-regexp string) (defun sclang-symbol-match (symbol-regexp string)
"Match SYMBOL-REGEXP in STRING."
(sclang-string-match (concat "^" symbol-regexp "$") string)) (sclang-string-match (concat "^" symbol-regexp "$") string))
;; =================================================================== ;; =====================================================================
;; symbol name predicates ;; symbol name predicates
;; =================================================================== ;; =====================================================================
(defun sclang-class-name-p (string) (defun sclang-class-name-p (string)
"Is STRING an sclang class name?"
(sclang-symbol-match sclang-class-name-regexp string)) (sclang-symbol-match sclang-class-name-regexp string))
(defun sclang-meta-class-name-p (string) (defun sclang-meta-class-name-p (string)
"Is STRING an sclang meta class name?"
(and (sclang-class-name-p string) (and (sclang-class-name-p string)
(sclang-string-match "^Meta_" string))) (sclang-string-match "^Meta_" string)))
(defun sclang-method-name-p (string) (defun sclang-method-name-p (string)
"Is STRING an sclang method name?"
(sclang-symbol-match sclang-method-name-regexp string)) (sclang-symbol-match sclang-method-name-regexp string))
(defun sclang-symbol-name-p (string) (defun sclang-symbol-name-p (string)
"Is STRING an sclang symbol name?"
(sclang-symbol-match sclang-symbol-name-regexp string)) (sclang-symbol-match sclang-symbol-name-regexp string))
(defun sclang-method-name-setter-p (method-name) (defun sclang-method-name-setter-p (method-name)
"Is METHOD-NAME an sclang method name setter?"
(string-match "_$" method-name)) (string-match "_$" method-name))
(defun sclang-method-name-getter-p (method-name) (defun sclang-method-name-getter-p (method-name)
"Is METHOD-NAME an sclang method name getter?"
(not (sclang-method-name-setter-p method-name))) (not (sclang-method-name-setter-p method-name)))
;; =================================================================== ;; =====================================================================
;; symbol name manipulation ;; symbol name manipulation
;; =================================================================== ;; =====================================================================
(defun sclang-method-name-setter (method-name) (defun sclang-method-name-setter (method-name)
"Return a method name setter for METHOD-NAME."
(if (sclang-method-name-setter-p method-name) (if (sclang-method-name-setter-p method-name)
method-name method-name
(concat method-name "_"))) (concat method-name "_")))
(defun sclang-method-name-getter (method-name) (defun sclang-method-name-getter (method-name)
"Return a method name getter for METHOD-NAME."
(if (sclang-method-name-setter-p method-name) (if (sclang-method-name-setter-p method-name)
(substring method-name 0 (1- (length method-name))) (substring method-name 0 (1- (length method-name)))
method-name)) method-name))
;; =================================================================== ;; =====================================================================
;; symbol table access ;; symbol table access
;; =================================================================== ;; =====================================================================
(defcustom sclang-use-symbol-table t (defcustom sclang-use-symbol-table t
"*Retrieve symbol table upon library initialization. "*Retrieve symbol table upon library initialization.
@ -257,21 +238,17 @@ low-resource systems."
(sclang-update-font-lock))) (sclang-update-font-lock)))
(defun sclang-get-symbol-completion-table () (defun sclang-get-symbol-completion-table ()
"Get symbol completion table."
(mapcar (lambda (s) (cons s nil)) sclang-symbol-table)) (mapcar (lambda (s) (cons s nil)) sclang-symbol-table))
(defun sclang-make-symbol-completion-predicate (predicate) (defun sclang-make-symbol-completion-predicate (predicate)
"Make symbol completion PREDICATE."
(and predicate (lambda (assoc) (funcall predicate (car assoc))))) (and predicate (lambda (assoc) (funcall predicate (car assoc)))))
(defun sclang-get-symbol (string) (defun sclang-get-symbol (string)
"Get symbol named STRING."
(if (and sclang-use-symbol-table sclang-symbol-table) (if (and sclang-use-symbol-table sclang-symbol-table)
(car (member string sclang-symbol-table)) (car (member string sclang-symbol-table))
string)) string))
(defun sclang-read-symbol (prompt &optional default predicate require-match inherit-input-method) (defun sclang-read-symbol (prompt &optional default predicate require-match inherit-input-method)
"Read symbol PROMPT (options DEFAULT PREDICATE REQUIRE-MATCH and INHERIT-INPUT-METHOD)."
(if sclang-use-symbol-table (if sclang-use-symbol-table
(cl-flet ((make-minibuffer-local-map (cl-flet ((make-minibuffer-local-map
(parent-keymap) (parent-keymap)
@ -294,12 +271,14 @@ low-resource systems."
(read-string (sclang-make-prompt-string prompt default) nil (read-string (sclang-make-prompt-string prompt default) nil
'sclang-symbol-history default inherit-input-method))) 'sclang-symbol-history default inherit-input-method)))
;; =================================================================== ;; =====================================================================
;; buffer movement ;; buffer movement
;; =================================================================== ;; =====================================================================
(defun sclang-point-in-comment-p () (defun sclang-point-in-comment-p ()
"Return non-nil if point is inside a comment." "Return non-nil if point is inside a comment.
Use font-lock information if font-lock-mode is enabled."
(if (and (boundp 'font-lock-mode) (eval 'font-lock-mode)) (if (and (boundp 'font-lock-mode) (eval 'font-lock-mode))
;; use available information in font-lock-mode ;; use available information in font-lock-mode
(eq (get-text-property (point) 'face) 'font-lock-comment-face) (eq (get-text-property (point) 'face) 'font-lock-comment-face)
@ -310,7 +289,6 @@ low-resource systems."
(not (null (nth 4 (parse-partial-sexp (point) beg)))))))) (not (null (nth 4 (parse-partial-sexp (point) beg))))))))
(defun sclang-beginning-of-defun (&optional arg) (defun sclang-beginning-of-defun (&optional arg)
"Move to beginning of function (optionally ARG)."
(interactive "p") (interactive "p")
(let ((case-fold-search nil) (let ((case-fold-search nil)
(arg (or arg (prefix-numeric-value current-prefix-arg))) (arg (or arg (prefix-numeric-value current-prefix-arg)))
@ -346,7 +324,6 @@ Return value is nil or (beg end) of defun."
(list beg end))))) (list beg end)))))
(defun sclang-end-of-defun (&optional arg) (defun sclang-end-of-defun (&optional arg)
"Move to end of function (optionally ARG)."
(interactive "p") (interactive "p")
(let ((case-fold-search nil) (let ((case-fold-search nil)
(arg (or arg (prefix-numeric-value current-prefix-arg))) (arg (or arg (prefix-numeric-value current-prefix-arg)))
@ -374,9 +351,9 @@ Return value is nil or (beg end) of defun."
(when success (when success
(forward-line 1) t))) (forward-line 1) t)))
;; =================================================================== ;; =====================================================================
;; buffer object access ;; buffer object access
;; =================================================================== ;; =====================================================================
(defun sclang-symbol-at-point (&optional symbol-name-regexp) (defun sclang-symbol-at-point (&optional symbol-name-regexp)
"Return the symbol at point, or nil if not a valid symbol. "Return the symbol at point, or nil if not a valid symbol.
@ -417,9 +394,9 @@ A defun may either be a class definition or a code block, see
(cl-multiple-value-bind (beg end) (sclang-point-in-defun-p) (cl-multiple-value-bind (beg end) (sclang-point-in-defun-p)
(and beg end (buffer-substring-no-properties beg end)))))) (and beg end (buffer-substring-no-properties beg end))))))
;; =================================================================== ;; =====================================================================
;; symbol completion ;; symbol completion
;; =================================================================== ;; =====================================================================
(defun sclang-complete-symbol (&optional predicate) (defun sclang-complete-symbol (&optional predicate)
"Perform completion on symbol preceding point. "Perform completion on symbol preceding point.
@ -476,27 +453,9 @@ are considered."
(insert " \n")))) (insert " \n"))))
(sclang-message "Making completion list...%s" "done"))))) (sclang-message "Making completion list...%s" "done")))))
(defun sclang-completion-at-point () ;; =====================================================================
"Function used for `completion-at-point-functions' in `sclang-mode'."
(let* ((end (point))
(beg (save-excursion
(backward-sexp 1)
(skip-syntax-forward "'")
(point)))
(pattern (buffer-substring-no-properties beg end))
(case-fold-search nil)
(predicate (if (sclang-class-name-p pattern)
#'sclang-class-name-p
#'sclang-method-name-p)))
(list beg
end
(all-completions pattern sclang-symbol-table predicate)
:exclusive 'no
:company-docsig #'identity)))
;; ===================================================================
;; introspection ;; introspection
;; =================================================================== ;; =====================================================================
(defcustom sclang-definition-marker-ring-length 32 (defcustom sclang-definition-marker-ring-length 32
"*Length of marker ring `sclang-definition-marker-ring'." "*Length of marker ring `sclang-definition-marker-ring'."
@ -515,7 +474,6 @@ are considered."
(make-ring sclang-definition-marker-ring-length)))) (make-ring sclang-definition-marker-ring-length))))
(defun sclang-open-definition (name file pos &optional pos-func) (defun sclang-open-definition (name file pos &optional pos-func)
"Open definition NAME in FILE at POS (optionally POS-FUNC)."
(let ((buffer (find-file file))) (let ((buffer (find-file file)))
(when (bufferp buffer) (when (bufferp buffer)
(with-current-buffer buffer (with-current-buffer buffer
@ -536,7 +494,6 @@ are considered."
(set-marker marker nil nil)))) (set-marker marker nil nil))))
(defun sclang-browse-definitions (name definitions buffer-name header &optional pos-func) (defun sclang-browse-definitions (name definitions buffer-name header &optional pos-func)
"Browse definitions. NAME DEFINITIONS BUFFER-NAME HEADER (optionally POS-FUNC)."
(if (cdr definitions) (if (cdr definitions)
(let ((same-window-buffer-names (list buffer-name))) (let ((same-window-buffer-names (list buffer-name)))
(with-sclang-browser (with-sclang-browser
@ -655,7 +612,7 @@ are considered."
(sclang-message "No references to '%s'" name))))) (sclang-message "No references to '%s'" name)))))
(defun sclang-show-method-args () (defun sclang-show-method-args ()
"Show method args." "whooha. in full effect."
(interactive) (interactive)
(let ((regexp (concat (let ((regexp (concat
sclang-class-name-regexp sclang-class-name-regexp
@ -708,9 +665,9 @@ are considered."
class 'sclang-class-name-p t)))) class 'sclang-class-name-p t))))
(sclang-eval-string (format "%s.dumpInterface" class))) (sclang-eval-string (format "%s.dumpInterface" class)))
;; =================================================================== ;; =====================================================================
;; cscope interface ;; cscope interface
;; =================================================================== ;; =====================================================================
(defcustom sclang-source-directory nil (defcustom sclang-source-directory nil
"Toplevel SuperCollider source directory. "Toplevel SuperCollider source directory.
@ -723,7 +680,7 @@ database."
:options '(must-match)) :options '(must-match))
(defun sclang-find-primitive (name) (defun sclang-find-primitive (name)
"Find primitive NAME in a cscope database. "Find primitive name a cscope database.
The database is searched in `sclang-source-directory', or the The database is searched in `sclang-source-directory', or the
current-directory, iff `sclang-source-directoy' is nil." current-directory, iff `sclang-source-directoy' is nil."
@ -733,26 +690,23 @@ current-directory, iff `sclang-source-directoy' is nil."
nil nil default)))) nil nil default))))
(if (require 'xcscope nil t) (if (require 'xcscope nil t)
(let ((cscope-initial-directory sclang-source-directory)) (let ((cscope-initial-directory sclang-source-directory))
;; only fboundp when xcscope is loaded
(cscope-find-this-text-string (cscope-find-this-text-string
(if (string-match "^_" name) name (concat "_" name)))) (if (string-match "^_" name) name (concat "_" name))))
(sclang-message "cscope not available"))) (sclang-message "cscope not available")))
;; =================================================================== ;; =====================================================================
;; sc-code formatting ;; sc-code formatting
;; =================================================================== ;; =====================================================================
(defun sclang-list-to-string (list) (defun sclang-list-to-string (list)
"Convert sclang LIST to string."
(mapconcat 'sclang-object-to-string list ", ")) (mapconcat 'sclang-object-to-string list ", "))
(defconst sclang-false 'false) (defconst false 'false)
(defun sclang-object-to-string (obj) (defun sclang-object-to-string (obj)
"Convert sclang object OBJ to string."
(cond ((null obj) (cond ((null obj)
"nil") "nil")
((eq sclang-false obj) ((eq false obj)
"false") "false")
((eq t obj) ((eq t obj)
"true") "true")
@ -763,7 +717,7 @@ current-directory, iff `sclang-source-directoy' is nil."
(t (format "%S" obj)))) (t (format "%S" obj))))
(defun sclang-format (string &rest args) (defun sclang-format (string &rest args)
"Format STRING using ARGS. "format chars:
%s - print string %s - print string
%o - print object %o - print object
%l - print argument list" %l - print argument list"
@ -826,8 +780,7 @@ want smart pattern guessing, use `sclang-format' directly to format your Pseq."
(cl-decf i)))) (cl-decf i))))
(cl-decf rep))) (cl-decf rep)))
(accept-process-output nil 0 100) (accept-process-output nil 0 100)
;; invent better progress info (message "Processed...%S" ret) ;; invent better progress info
(message "Processed...%S" ret)
(setq r (append r (list ret)) (setq r (append r (list ret))
items (nthcdr skip items)))) items (nthcdr skip items))))
r)) r))
@ -845,10 +798,10 @@ want smart pattern guessing, use `sclang-format' directly to format your Pseq."
(mapconcat #'elem-to-string compressed ", ") (mapconcat #'elem-to-string compressed ", ")
" ], 1)"))))) " ], 1)")))))
;; =================================================================== ;; =====================================================================
;; module setup ;; module setup
;; =================================================================== ;; =====================================================================
(provide 'sclang-language) (provide 'sclang-language)
;;; sclang-language.el ends here ;; EOF

13
el/sclang-menu.el
View file

@ -1,9 +1,5 @@
;;; sclang-menu.el --- IDE for working with SuperCollider -*- coding: utf-8; ;; copyright 2003 stefan kersten <steve@k-hornz.de>
;; ;;
;; Copyright 2003 stefan kersten <steve@k-hornz.de>
;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as ;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of the ;; published by the Free Software Foundation; either version 2 of the
@ -19,16 +15,9 @@
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
;; USA ;; USA
;;; Commentary:
;; Menus
;;; Code:
;; (sclang-set-command-handler ;; (sclang-set-command-handler
;; '_updateMenu ;; '_updateMenu
;; (lambda (arg) ;; (lambda (arg)
;; (message "menu: %s" arg))) ;; (message "menu: %s" arg)))
(provide 'sclang-menu) (provide 'sclang-menu)
;;; sclang-menu.el ends here

57
el/sclang-minor-mode.el
View file

@ -1,9 +1,7 @@
;;; sclang-minor-mode.el --- IDE for working with SuperCollider -*- coding: utf-8; ;;; sclang-minor-mode for use in help files
;; ;;; SuperCollider
;; Copyright (c) 2007, Marije Baalman - nescivi <nescivi@gmail.com> ;;; (c) 2007, Marije Baalman - nescivi <nescivi@gmail.com>
;;;
;;; License:
;;; This program is free software; you can redistribute it and/or modify ;;; 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 ;;; it under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 2 of the License, or ;;; the Free Software Foundation; either version 2 of the License, or
@ -18,14 +16,11 @@
;;; along with this program; if not, write to the Free Software ;;; along with this program; if not, write to the Free Software
;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA ;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
(eval-when-compile
;;; Commentary:
;;
;; sclang-minor-mode for use in help files
;;; Code:
(require 'sclang-util) (require 'sclang-util)
(require 'sclang-mode) (require 'sclang-mode)
)
(easy-mmode-define-minor-mode sclang-minor-mode (easy-mmode-define-minor-mode sclang-minor-mode
"Toggle sclang-minor-mode. "Toggle sclang-minor-mode.
@ -33,55 +28,53 @@ With no argument, this command toggles the mode.
Non-null prefix argument turns on the mode. Non-null prefix argument turns on the mode.
Null prefix argument turns off the mode. Null prefix argument turns off the mode.
When sclang-minor-mode is enabled, you can use the key sequences When sclang-minor-mode is enabled, you can execute
\\<sclang-minor-mode-map>\\[sclang-eval-region-or-line] or \\<sclang-minor-mode-map>\\[sclang-eval-region] to eval sclang code." sclang code with the normal command C-c C-c and C-c C-d."
;; The initial value. ;; The initial value.
:init-value nil nil
;; The indicator for the mode line. ;; The indicator for the mode line.
:lighter " sclang" " sclang"
;; The minor mode bindings. ;; The minor mode bindings.
:keymap '(("\C-c\C-c" . sclang-eval-region-or-line) '(("\C-c\C-c" . sclang-eval-region-or-line)
("\C-c\C-d" . sclang-eval-region) ("\C-c\C-d" . sclang-eval-region)
("\C-\M-x" . sclang-eval-defun) ("\C-\M-x" . sclang-eval-defun)
("\C-c\C-h" . sclang-find-help) ("\C-c\C-h" . sclang-find-help)
("\C-\M-h" . sclang-goto-help-browser) ("\C-\M-h" . sclang-goto-help-browser)
("\C-c\C-s" . sclang-main-stop) ("\C-c\C-s" . sclang-main-stop)
("\C-c\C-k" . sclang-edit-dev-source))) ("\C-c\C-k" . sclang-edit-dev-source)
))
(provide 'sclang-minor-mode) (provide 'sclang-minor-mode)
(easy-mmode-define-minor-mode sclang-help-minor-mode (easy-mmode-define-minor-mode sclang-help-minor-mode
"Toggle sclang-minor-mode. "Toggle sclang-minor-mode.
With no argument, this command toggles the mode. With no argument, this command toggles the mode.
Non-null prefix argument turns on the mode. Non-null prefix argument turns on the mode.
Null prefix argument turns off the mode. Null prefix argument turns off the mode.
When sclang-help-minor-mode is enabled, you can use the key sequences When sclang-help-minor-mode is enabled, you can execute
\\<sclang-minor-mode-map>\\[sclang-eval-region-or-line] or \\<sclang-minor-mode-map>\\[sclang-eval-region] to eval sclang code." sclang code with the normal command C-c C-c and C-c C-d."
;; The initial value. ;; The initial value.
:init-value nil nil
;; The indicator for the mode line. ;; The indicator for the mode line.
:lighter " sclang-help" " sclang-help"
;; The minor mode bindings. ;; The minor mode bindings.
:keymap '(("\C-c\C-c" . sclang-eval-region-or-line) '(("\C-c\C-c" . sclang-eval-region-or-line)
("\C-c\C-d" . sclang-eval-region) ("\C-c\C-d" . sclang-eval-region)
("\C-\M-x" . sclang-eval-defun) ("\C-\M-x" . sclang-eval-defun)
("\C-c\C-h" . sclang-find-help) ("\C-c\C-h" . sclang-find-help)
("\C-c\C-s" . sclang-main-stop) ("\C-c\C-s" . sclang-main-stop)
("\C-c\C-v" . sclang-edit-html-help-file) ("\C-c\C-v" . sclang-edit-html-help-file)
("E" . sclang-edit-help-code) ("E" . sclang-edit-help-code)
("\C-c\C-k" . sclang-edit-dev-source))) ("\C-c\C-k" . sclang-edit-dev-source)
))
(provide 'sclang-help-minor-mode) (provide 'sclang-help-minor-mode)
;; mode hooks
(defun sclang-minor-hooks ()
"Sclang minor mode hooks."
(sclang-init-document)
(sclang-make-document))
(add-hook 'sclang-help-minor-mode-hook 'sclang-minor-hooks) (add-hook 'sclang-help-minor-mode-hook 'sclang-minor-hooks)
(add-hook 'sclang-minor-mode-hook 'sclang-minor-hooks) (add-hook 'sclang-minor-mode-hook 'sclang-minor-hooks)
;;; sclang-minor-mode.el ends here (defun sclang-minor-hooks ()
(sclang-init-document)
(sclang-make-document)
)

145
el/sclang-mode.el
View file

@ -1,9 +1,5 @@
;;; sclang-mode.el --- IDE for working with SuperCollider -*- coding: utf-8; ;; copyright 2003-2005 stefan kersten <steve@k-hornz.de>
;; ;;
;; Copyright 2003 stefan kersten <steve@k-hornz.de>
;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as ;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of the ;; published by the Free Software Foundation; either version 2 of the
@ -19,25 +15,18 @@
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
;; USA ;; USA
;;; Commentary:
;; sclang mode
;;; Code:
(require 'cl-lib) (require 'cl-lib)
;; Keep byte-compiler happy by declaring external functions and variables. (eval-when-compile
(declare-function company-mode "ext:company")
(defvar company-backends)
(require 'font-lock) (require 'font-lock)
(require 'sclang-util) (require 'sclang-util))
(require 'sclang-interp) (require 'sclang-interp)
(require 'sclang-language) (require 'sclang-language)
(require 'sclang-dev) (require 'sclang-dev)
(defun sclang-fill-syntax-table (table) (defun sclang-fill-syntax-table (table)
"Fill the sclang syntax TABLE." ;; string
(modify-syntax-entry ?\" "\"" table) (modify-syntax-entry ?\" "\"" table)
(modify-syntax-entry ?\' "\"" table) ; no string syntax class for single quotes (modify-syntax-entry ?\' "\"" table) ; no string syntax class for single quotes
;; expression prefix ;; expression prefix
@ -81,10 +70,10 @@
table) table)
(defun sclang-mode-make-menu (title) (defun sclang-mode-make-menu (title)
"Make mode menu with TITLE."
(easy-menu-create-menu (easy-menu-create-menu
title title
'(["Start Interpreter" sclang-start :included (not (sclang-library-initialized-p))] '(
["Start Interpreter" sclang-start :included (not (sclang-library-initialized-p))]
["Restart Interpreter" sclang-start :included (sclang-library-initialized-p)] ["Restart Interpreter" sclang-start :included (sclang-library-initialized-p)]
["Recompile Class Library" sclang-recompile :included (sclang-library-initialized-p)] ["Recompile Class Library" sclang-recompile :included (sclang-library-initialized-p)]
["Stop Interpreter" sclang-stop :included (sclang-get-process)] ["Stop Interpreter" sclang-stop :included (sclang-get-process)]
@ -116,12 +105,10 @@
"-" "-"
["Run Main" sclang-main-run] ["Run Main" sclang-main-run]
["Stop Main" sclang-main-stop] ["Stop Main" sclang-main-stop]
["Show Server Panels" sclang-show-server-panel]))) ["Show Server Panels" sclang-show-server-panel]
)))
(defun sclang-fill-mode-map (map) (defun sclang-fill-mode-map (map)
"Fill keymap MAP for sclang mode."
;; NOTE: keybindings should follow the conventions in https://www.gnu.org/software/emacs/manual/html_node/elisp/Key-Binding-Conventions.html
;; process control ;; process control
(define-key map "\C-c\C-l" 'sclang-recompile) (define-key map "\C-c\C-l" 'sclang-recompile)
(define-key map "\C-c\C-o" 'sclang-start) (define-key map "\C-c\C-o" 'sclang-start)
@ -138,6 +125,7 @@
(define-key map "\C-c\C-f" 'sclang-eval-document) (define-key map "\C-c\C-f" 'sclang-eval-document)
;; language information ;; language information
(define-key map "\C-c\C-n" 'sclang-complete-symbol) (define-key map "\C-c\C-n" 'sclang-complete-symbol)
(define-key map "\M-\t" 'sclang-complete-symbol)
(define-key map "\C-c:" 'sclang-find-definitions) (define-key map "\C-c:" 'sclang-find-definitions)
(define-key map "\C-c;" 'sclang-find-references) (define-key map "\C-c;" 'sclang-find-references)
(define-key map "\C-c}" 'sclang-pop-definition-mark) (define-key map "\C-c}" 'sclang-pop-definition-mark)
@ -145,10 +133,10 @@
(define-key map "\C-c{" 'sclang-dump-full-interface) (define-key map "\C-c{" 'sclang-dump-full-interface)
(define-key map "\C-c[" 'sclang-dump-interface) (define-key map "\C-c[" 'sclang-dump-interface)
;; documentation access ;; documentation access
(define-key map "\C-c\C-?f" 'sclang-find-help) (define-key map "\C-c\C-h" 'sclang-find-help)
(define-key map "\C-c\C-?g" 'sclang-goto-help-browser) (define-key map "\C-\M-h" 'sclang-goto-help-browser)
(define-key map "" 'sclang-open-help-gui) (define-key map "\C-c\C-y" 'sclang-open-help-gui)
(define-key map "" 'sclang-find-help-in-gui) (define-key map "\C-ch" 'sclang-find-help-in-gui)
;; language control ;; language control
(define-key map "\C-c\C-r" 'sclang-main-run) (define-key map "\C-c\C-r" 'sclang-main-run)
(define-key map "\C-c\C-s" 'sclang-main-stop) (define-key map "\C-c\C-s" 'sclang-main-stop)
@ -171,7 +159,8 @@
;; ===================================================================== ;; =====================================================================
(defconst sclang-font-lock-keyword-list (defconst sclang-font-lock-keyword-list
'("arg" '(
"arg"
"classvar" "classvar"
"const" "const"
"super" "super"
@ -181,18 +170,22 @@
"thisMethod" "thisMethod"
"thisProcess" "thisProcess"
"thisThread" "thisThread"
"var") "var"
)
"*List of keywords to highlight in SCLang mode.") "*List of keywords to highlight in SCLang mode.")
(defconst sclang-font-lock-builtin-list (defconst sclang-font-lock-builtin-list
'("false" '(
"false"
"inf" "inf"
"nil" "nil"
"true") "true"
)
"*List of builtins to highlight in SCLang mode.") "*List of builtins to highlight in SCLang mode.")
(defconst sclang-font-lock-method-list (defconst sclang-font-lock-method-list
'("ar" '(
"ar"
"for" "for"
"forBy" "forBy"
"if" "if"
@ -200,16 +193,19 @@
"kr" "kr"
"tr" "tr"
"loop" "loop"
"while") "while"
)
"*List of methods to highlight in SCLang mode.") "*List of methods to highlight in SCLang mode.")
(defconst sclang-font-lock-error-list (defconst sclang-font-lock-error-list
'("die" '(
"die"
"error" "error"
"exit" "exit"
"halt" "halt"
"verboseHalt" "verboseHalt"
"warn") "warn"
)
"*List of methods signalling errors or warnings.") "*List of methods signalling errors or warnings.")
(defvar sclang-font-lock-class-keywords nil) (defvar sclang-font-lock-class-keywords nil)
@ -229,13 +225,14 @@
(defconst sclang-font-lock-defaults '((sclang-font-lock-keywords (defconst sclang-font-lock-defaults '((sclang-font-lock-keywords
sclang-font-lock-keywords-1 sclang-font-lock-keywords-1
sclang-font-lock-keywords-2 sclang-font-lock-keywords-2
sclang-font-lock-keywords-3) sclang-font-lock-keywords-3
)
nil nil nil nil
nil nil
beginning-of-defun)) beginning-of-defun
))
(defun sclang-font-lock-syntactic-face (state) (defun sclang-font-lock-syntactic-face (state)
"Return font lock face for STATE."
(cond ((eq (nth 3 state) ?') (cond ((eq (nth 3 state) ?')
;; symbol ;; symbol
'font-lock-constant-face) 'font-lock-constant-face)
@ -247,7 +244,6 @@
'font-lock-comment-face))) 'font-lock-comment-face)))
(defun sclang-font-lock-class-keyword-matcher (limit) (defun sclang-font-lock-class-keyword-matcher (limit)
"Font lock class keywords up to LIMIT."
(let ((regexp (concat "\\<" sclang-class-name-regexp "\\>")) (let ((regexp (concat "\\<" sclang-class-name-regexp "\\>"))
(case-fold-search nil) (case-fold-search nil)
(continue t) (continue t)
@ -264,7 +260,6 @@
res)) res))
(defun sclang-set-font-lock-keywords () (defun sclang-set-font-lock-keywords ()
"Set font lock keywords."
(setq (setq
;; level 1 ;; level 1
sclang-font-lock-keywords-1 sclang-font-lock-keywords-1
@ -280,7 +275,8 @@
;; constants ;; constants
(cons "\\s/\\s\\?." 'font-lock-constant-face) ; characters (cons "\\s/\\s\\?." 'font-lock-constant-face) ; characters
(cons (concat "\\\\\\(" sclang-symbol-regexp "\\)") (cons (concat "\\\\\\(" sclang-symbol-regexp "\\)")
'font-lock-constant-face)) ; symbols 'font-lock-constant-face) ; symbols
)
;; level 2 ;; level 2
sclang-font-lock-keywords-2 sclang-font-lock-keywords-2
(append (append
@ -299,19 +295,23 @@
'font-lock-function-name-face) 'font-lock-function-name-face)
;; errors ;; errors
(cons (regexp-opt sclang-font-lock-error-list 'words) (cons (regexp-opt sclang-font-lock-error-list 'words)
'font-lock-warning-face))) 'font-lock-warning-face)
))
;; level 3 ;; level 3
sclang-font-lock-keywords-3 sclang-font-lock-keywords-3
(append (append
sclang-font-lock-keywords-2 sclang-font-lock-keywords-2
(list (list
;; classes ;; classes
(cons 'sclang-font-lock-class-keyword-matcher 'font-lock-type-face))) (cons 'sclang-font-lock-class-keyword-matcher 'font-lock-type-face)
;; (cons (concat "\\<" sclang-class-name-regexp "\\>") 'font-lock-type-face)
))
;; default level ;; default level
sclang-font-lock-keywords sclang-font-lock-keywords-1)) sclang-font-lock-keywords sclang-font-lock-keywords-1
))
(defun sclang-update-font-lock () (defun sclang-update-font-lock ()
"Update font-lock information in all `sclang-mode' buffers." "Update font-lock information in all sclang-mode buffers."
;; too expensive ;; too expensive
;; (dolist (buffer (buffer-list)) ;; (dolist (buffer (buffer-list))
;; (with-current-buffer buffer ;; (with-current-buffer buffer
@ -319,7 +319,7 @@
;; (eq t (car font-lock-keywords)) ;; (eq t (car font-lock-keywords))
;; (setq font-lock-keywords (cdr font-lock-keywords))))) ;; (setq font-lock-keywords (cdr font-lock-keywords)))))
(if (eq major-mode 'sclang-mode) (if (eq major-mode 'sclang-mode)
(font-lock-ensure (point-min) (point-max)))) (font-lock-fontify-buffer)))
;; ===================================================================== ;; =====================================================================
;; indentation ;; indentation
@ -333,7 +333,7 @@
(defun sclang-indent-line () (defun sclang-indent-line ()
"Indent current line as sclang code. "Indent current line as sclang code.
Return the amount the indentation changed by." Return the amount the indentation changed by."
(let ((indent (sclang-calculate-indent)) (let ((indent (calculate-sclang-indent))
beg shift-amt beg shift-amt
(case-fold-search nil) (case-fold-search nil)
(pos (- (point-max) (point)))) (pos (- (point-max) (point))))
@ -352,8 +352,8 @@ Return the amount the indentation changed by."
(goto-char (- (point-max) pos)))) (goto-char (- (point-max) pos))))
shift-amt)) shift-amt))
(defun sclang-calculate-indent (&optional parse-start) (defun calculate-sclang-indent (&optional parse-start)
"Return indentation for current line (optionally from PARSE-START). "Return appropriate indentation for current line as sclang code.
Returns the column to indent to." Returns the column to indent to."
(save-excursion (save-excursion
(beginning-of-line) (beginning-of-line)
@ -406,7 +406,6 @@ Returns the column to indent to."
;; ===================================================================== ;; =====================================================================
(defun sclang-electric-brace (arg) (defun sclang-electric-brace (arg)
"Electrify brace ARG."
(interactive "*P") (interactive "*P")
(self-insert-command (prefix-numeric-value arg)) (self-insert-command (prefix-numeric-value arg))
(and (save-excursion (and (save-excursion
@ -415,7 +414,6 @@ Returns the column to indent to."
(indent-according-to-mode))) (indent-according-to-mode)))
(defun sclang-electric-slash (arg) (defun sclang-electric-slash (arg)
"Electrify slash ARG."
(interactive "*P") (interactive "*P")
(let* ((char (char-before)) (let* ((char (char-before))
(indent-p (or (eq char ?/) (indent-p (or (eq char ?/)
@ -424,7 +422,6 @@ Returns the column to indent to."
(if indent-p (indent-according-to-mode)))) (if indent-p (indent-according-to-mode))))
(defun sclang-electric-star (arg) (defun sclang-electric-star (arg)
"Electrify star ARG."
(interactive "*P") (interactive "*P")
(let ((indent-p (eq (char-before) ?/))) (let ((indent-p (eq (char-before) ?/)))
(self-insert-command (prefix-numeric-value arg)) (self-insert-command (prefix-numeric-value arg))
@ -453,30 +450,24 @@ Returns the column to indent to."
(sclang-document-edited-p . (prSetEdited (buffer-modified-p))))) (sclang-document-edited-p . (prSetEdited (buffer-modified-p)))))
(defmacro sclang-next-document-id () (defmacro sclang-next-document-id ()
"Return next document id."
`(cl-incf sclang-document-counter)) `(cl-incf sclang-document-counter))
(defun sclang-document-id (buffer) (defun sclang-document-id (buffer)
"Document id of BUFFER."
(cdr (assq 'sclang-document-id (buffer-local-variables buffer)))) (cdr (assq 'sclang-document-id (buffer-local-variables buffer))))
(defun sclang-document-p (buffer) (defun sclang-document-p (buffer)
"Is BUFFER an sclang document?"
(integerp (sclang-document-id buffer))) (integerp (sclang-document-id buffer)))
(defmacro with-sclang-document (buffer &rest body) (defmacro with-sclang-document (buffer &rest body)
"With sclang BUFFER BODY."
`(when (sclang-document-p buffer) `(when (sclang-document-p buffer)
(with-current-buffer buffer (with-current-buffer buffer
,@body))) ,@body)))
(defun sclang-get-document (id) (defun sclang-get-document (id)
"Return buffer with document ID or nil."
(cl-find-if (lambda (buffer) (eq id (sclang-document-id buffer))) (cl-find-if (lambda (buffer) (eq id (sclang-document-id buffer)))
sclang-document-list)) sclang-document-list))
(defun sclang-init-document () (defun sclang-init-document ()
"Initialize document."
(set (make-local-variable 'sclang-document-id) (sclang-next-document-id)) (set (make-local-variable 'sclang-document-id) (sclang-next-document-id))
(set (make-local-variable 'sclang-document-envir) nil) (set (make-local-variable 'sclang-document-envir) nil)
(dolist (assoc sclang-document-property-map) (dolist (assoc sclang-document-property-map)
@ -484,7 +475,6 @@ Returns the column to indent to."
(cl-pushnew (current-buffer) sclang-document-list)) (cl-pushnew (current-buffer) sclang-document-list))
(defun sclang-document-update-property-1 (assoc &optional force) (defun sclang-document-update-property-1 (assoc &optional force)
"Update document property ASSOC (optionally FORCE)."
(when (consp assoc) (when (consp assoc)
(let* ((key (car assoc)) (let* ((key (car assoc))
(prop (cdr assoc)) (prop (cdr assoc))
@ -497,21 +487,17 @@ Returns the column to indent to."
(car prop) cur-value))))) (car prop) cur-value)))))
(defun sclang-document-update-property (key &optional force) (defun sclang-document-update-property (key &optional force)
"Update document property KEY (optionally FORCE)."
(sclang-document-update-property-1 (assq key sclang-document-property-map) force)) (sclang-document-update-property-1 (assq key sclang-document-property-map) force))
(defun sclang-document-update-properties (&optional force) (defun sclang-document-update-properties (&optional force)
"Update all document properties (optionally FORCE)."
(dolist (assoc sclang-document-property-map) (dolist (assoc sclang-document-property-map)
(sclang-document-update-property-1 assoc force))) (sclang-document-update-property-1 assoc force)))
(defun sclang-make-document () (defun sclang-make-document ()
"Make a new document."
(sclang-perform-command-no-result 'documentNew sclang-document-id) (sclang-perform-command-no-result 'documentNew sclang-document-id)
(sclang-document-update-properties t)) (sclang-document-update-properties t))
(defun sclang-close-document (buffer) (defun sclang-close-document (buffer)
"Close document in BUFFER."
(with-sclang-document (with-sclang-document
buffer buffer
(setq sclang-document-list (delq buffer sclang-document-list)) (setq sclang-document-list (delq buffer sclang-document-list))
@ -519,32 +505,27 @@ Returns the column to indent to."
'documentClosed sclang-document-id))) 'documentClosed sclang-document-id)))
(defun sclang-set-current-document (buffer &optional force) (defun sclang-set-current-document (buffer &optional force)
"Set current document to BUFFER (optionally FORCE)."
(when (or force (not (eq buffer sclang-current-document))) (when (or force (not (eq buffer sclang-current-document)))
(setq sclang-current-document buffer) (setq sclang-current-document buffer)
(sclang-perform-command-no-result 'documentSetCurrent (sclang-document-id buffer)) (sclang-perform-command-no-result 'documentSetCurrent (sclang-document-id buffer))
t)) t))
(defun sclang-document-library-startup-hook-function () (defun sclang-document-library-startup-hook-function ()
"Document library startup hook."
(dolist (buffer sclang-document-list) (dolist (buffer sclang-document-list)
(with-current-buffer buffer (with-current-buffer buffer
(sclang-make-document))) (sclang-make-document)))
(sclang-set-current-document (current-buffer) t)) (sclang-set-current-document (current-buffer) t))
(defun sclang-document-kill-buffer-hook-function () (defun sclang-document-kill-buffer-hook-function ()
"Document kill buffer hook."
(sclang-close-document (current-buffer))) (sclang-close-document (current-buffer)))
(defun sclang-document-post-command-hook-function () (defun sclang-document-post-command-hook-function ()
"Document post command hook."
(when (and (sclang-library-initialized-p) (when (and (sclang-library-initialized-p)
(sclang-document-p (current-buffer))) (sclang-document-p (current-buffer)))
(sclang-document-update-properties)) (sclang-document-update-properties))
(sclang-set-current-document (current-buffer))) (sclang-set-current-document (current-buffer)))
(defun sclang-document-change-major-mode-hook-function () (defun sclang-document-change-major-mode-hook-function ()
"Document change major mode hook."
(sclang-close-document (current-buffer))) (sclang-close-document (current-buffer)))
;; ===================================================================== ;; =====================================================================
@ -620,7 +601,8 @@ Returns the column to indent to."
(let ((doc (and (integerp id) (sclang-get-document id)))) (let ((doc (and (integerp id) (sclang-get-document id))))
(when doc (when doc
(with-current-buffer doc (with-current-buffer doc
(insert str)) (insert str)
)
nil))))) nil)))))
(sclang-set-command-handler (sclang-set-command-handler
@ -635,7 +617,6 @@ Returns the column to indent to."
;; ===================================================================== ;; =====================================================================
(defun sclang-mode-set-local-variables () (defun sclang-mode-set-local-variables ()
"Local variables."
(set (make-local-variable 'require-final-newline) nil) (set (make-local-variable 'require-final-newline) nil)
;; indentation ;; indentation
(set (make-local-variable 'indent-line-function) (set (make-local-variable 'indent-line-function)
@ -684,29 +665,27 @@ Returns the column to indent to."
:group 'sclang-mode :group 'sclang-mode
:type 'hook) :type 'hook)
;;;###autoload (autoload 'sclang-mode "sclang" "Major mode for editing SuperCollider language" t) (defun sclang-mode ()
(define-derived-mode sclang-mode prog-mode "SCLang"
"Major mode for editing SuperCollider language code. "Major mode for editing SuperCollider language code.
\\{sclang-mode-map}" \\{sclang-mode-map}
:group 'sclang "
:syntax-table sclang-mode-syntax-table (interactive)
(kill-all-local-variables)
(set-syntax-table sclang-mode-syntax-table)
(use-local-map sclang-mode-map)
(setq mode-name "SCLang")
(setq major-mode 'sclang-mode)
(sclang-mode-set-local-variables) (sclang-mode-set-local-variables)
(sclang-set-font-lock-keywords) (sclang-set-font-lock-keywords)
(sclang-init-document) (sclang-init-document)
(sclang-make-document) (sclang-make-document)
(run-hooks 'sclang-mode-hook))
;; Setup completion
(add-hook 'completion-at-point-functions
#'sclang-completion-at-point nil 'local)
(when (fboundp 'company-mode)
(add-to-list 'company-backends 'company-capf)))
;; ===================================================================== ;; =====================================================================
;; module initialization ;; module initialization
;; ===================================================================== ;; =====================================================================
;;;###autoload (add-to-list 'auto-mode-alist '("\\.\\(sc\\|scd\\)$" . sclang-mode))
(add-to-list 'auto-mode-alist '("\\.scd?\\'" . sclang-mode))
(add-to-list 'interpreter-mode-alist '("sclang" . sclang-mode)) (add-to-list 'interpreter-mode-alist '("sclang" . sclang-mode))
(add-hook 'sclang-library-startup-hook 'sclang-document-library-startup-hook-function) (add-hook 'sclang-library-startup-hook 'sclang-document-library-startup-hook-function)
@ -716,4 +695,4 @@ Returns the column to indent to."
(provide 'sclang-mode) (provide 'sclang-mode)
;;; sclang-mode.el ends here ;; EOF

44
el/sclang-server.el
View file

@ -1,9 +1,5 @@
;;; sclang-server.el --- IDE for working with SuperCollider -*- coding: utf-8; ;; copyright 2003-2005 stefan kersten <steve@k-hornz.de>
;; ;;
;; Copyright 2003 stefan kersten <steve@k-hornz.de>
;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as ;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of the ;; published by the Free Software Foundation; either version 2 of the
@ -19,17 +15,13 @@
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
;; USA ;; USA
;;; Commentary:
;; Interface to the sclang server
(require 'cl-lib) (require 'cl-lib)
(eval-when-compile
(require 'sclang-util) (require 'sclang-util)
(require 'sclang-interp) (require 'sclang-interp)
(require 'sclang-language) (require 'sclang-language)
(require 'sclang-mode) (require 'sclang-mode))
;;; Code:
(defcustom sclang-server-panel "Server.default.makeWindow" (defcustom sclang-server-panel "Server.default.makeWindow"
"Expression to execute when `sclang-show-server-panel' is invoked." "Expression to execute when `sclang-show-server-panel' is invoked."
@ -57,12 +49,10 @@
"Face for highlighting a server's running state in the mode-line.") "Face for highlighting a server's running state in the mode-line.")
(defun sclang-get-server (&optional name) (defun sclang-get-server (&optional name)
"Get sclang server (optionally by NAME)."
(unless name (setq name sclang-current-server)) (unless name (setq name sclang-current-server))
(cdr (assq name sclang-server-alist))) (cdr (assq name sclang-server-alist)))
(defun sclang-set-server (&optional name) (defun sclang-set-server (&optional name)
"Set current sclang server (optionally by NAME)."
(unless name (setq name sclang-current-server)) (unless name (setq name sclang-current-server))
(setq sclang-current-server (setq sclang-current-server
(car (or (assq name sclang-server-alist) (car (or (assq name sclang-server-alist)
@ -91,21 +81,18 @@
(setq sclang-current-server (car (car list)))) (setq sclang-current-server (car (car list))))
(sclang-update-server-info)) (sclang-update-server-info))
(defun sclang-mouse-next-server (_event) (defun sclang-mouse-next-server (event)
"Select next server for display." "Select next server for display."
(interactive "e") (interactive "e")
(sclang-next-server)) (sclang-next-server))
(defun sclang-server-running-p (&optional name) (defun sclang-server-running-p (&optional name)
"Is the sclang server NAME running?"
(plist-get (sclang-get-server name) 'running)) (plist-get (sclang-get-server name) 'running))
(defun sclang-server-booting-p (&optional name) (defun sclang-server-booting-p (&optional name)
"Is the sclang server NAME running?"
(plist-get (sclang-get-server name) 'booting)) (plist-get (sclang-get-server name) 'booting))
(defun sclang-create-server-menu (title) (defun sclang-create-server-menu (title)
"Create the server menu with TITLE."
(easy-menu-create-menu (easy-menu-create-menu
title title
'( '(
@ -116,7 +103,6 @@
["Make Default" sclang-server-make-default]))) ["Make Default" sclang-server-make-default])))
(defun sclang-server-fill-mouse-map (map prefix) (defun sclang-server-fill-mouse-map (map prefix)
"Fill mouse MAP using PREFIX."
(define-key map (vector prefix 'mouse-1) 'sclang-mouse-next-server) (define-key map (vector prefix 'mouse-1) 'sclang-mouse-next-server)
(define-key map (vector prefix 'down-mouse-3) (sclang-create-server-menu "Commands")) (define-key map (vector prefix 'down-mouse-3) (sclang-create-server-menu "Commands"))
map) map)
@ -125,7 +111,7 @@
"Keymap used for controlling servers in the mode line.") "Keymap used for controlling servers in the mode line.")
(defun sclang-server-fill-key-map (map) (defun sclang-server-fill-key-map (map)
"Fill server keymap MAP." "Fill server prefix map."
(define-key map [?b] 'sclang-server-boot) (define-key map [?b] 'sclang-server-boot)
(define-key map [?d] 'sclang-server-display-default) (define-key map [?d] 'sclang-server-display-default)
(define-key map [?f] 'sclang-server-free-all) (define-key map [?f] 'sclang-server-free-all)
@ -170,7 +156,6 @@
"Info string used in the post buffer mode line.") "Info string used in the post buffer mode line.")
(defun sclang-update-server-info () (defun sclang-update-server-info ()
"Update server info in the modeline."
(interactive) (interactive)
(sclang-set-server) (sclang-set-server)
(setq sclang-server-info-string (sclang-get-server-info-string)) (setq sclang-server-info-string (sclang-get-server-info-string))
@ -181,10 +166,8 @@
;; ===================================================================== ;; =====================================================================
(defun sclang-perform-server-command (command &rest args) (defun sclang-perform-server-command (command &rest args)
"Perform server COMMAND with ARGS."
(sclang-eval-string (sclang-eval-string
(sclang-format (sclang-format "Server.named.at(%o.asSymbol).performList(\\tryPerform, %o.asSymbol.asArray ++ %o)"
"Server.named.at(%o.asSymbol).performList(\\tryPerform, %o.asSymbol.asArray ++ %o)"
sclang-current-server command args) sclang-current-server command args)
nil)) nil))
@ -232,7 +215,7 @@ if (server.notNil) {
nil)) nil))
(defun sclang-server-dump-osc (&optional code) (defun sclang-server-dump-osc (&optional code)
"Set the current server's dump OSC mode (with optional CODE)." "Set the current server's dump OSC mode."
(interactive "P") (interactive "P")
(sclang-perform-server-command "dumpOSC" (sclang-perform-server-command "dumpOSC"
(cond ((consp code) 0) (cond ((consp code) 0)
@ -240,7 +223,7 @@ if (server.notNil) {
(t code)))) (t code))))
(defun sclang-server-prepare-for-record (&optional path) (defun sclang-server-prepare-for-record (&optional path)
"Prepare current server for recording a sound file (with optional PATH)." "Prepare current server for recording a sound file."
(interactive (interactive
(list (list
(and current-prefix-arg (read-file-name "Record to file: ")))) (and current-prefix-arg (read-file-name "Record to file: "))))
@ -261,10 +244,10 @@ if (server.notNil) {
(interactive) (interactive)
(sclang-perform-server-command "stopRecording")) (sclang-perform-server-command "stopRecording"))
(defun sclang-set-server-latency (latency) (defun sclang-set-server-latency (lat)
"Set the current server's LATENCY instance variable." "Set the current server's `latency' instance variable."
(interactive "nSet latency: ") (interactive "nSet latency: ")
(sclang-perform-server-command "latency_" latency)) (sclang-perform-server-command "latency_" lat))
(defun sclang-show-server-latency () (defun sclang-show-server-latency ()
"Show the current server's latency." "Show the current server's latency."
@ -293,7 +276,6 @@ if (server.notNil) {
(lambda () (lambda ()
(setq sclang-current-server-initialized nil))) (setq sclang-current-server-initialized nil)))
(provide 'sclang-server) (provide 'sclang-server)
;;; sclang-server.el ends here ;; EOF

36
el/sclang-util.el
View file

@ -1,9 +1,5 @@
;;; sclang-util.el --- Utility helpers for sclang -*- coding: utf-8; ;; copyright 2003-2005 stefan kersten <steve@k-hornz.de>
;; ;;
;; Copyright 2003-2005 stefan kersten <steve@k-hornz.de>
;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as ;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of the ;; published by the Free Software Foundation; either version 2 of the
@ -19,20 +15,13 @@
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
;; USA ;; USA
;;; Commentary:
;; Utility helpers for sclang
;;; Code:
(defun sclang-message (string &rest args) (defun sclang-message (string &rest args)
"Create a message from STRING with optional ARGS."
(message "SCLang: %s" (apply 'format string args))) (message "SCLang: %s" (apply 'format string args)))
(defun sclang-make-buffer-name (name &optional private-p) (defun sclang-make-buffer-name (string &optional private-p)
"Set the buffer name to NAME (optimally PRIVATE-P)." (concat (and private-p " ") "*SCLang:" string "*"))
(concat (and private-p " ") "*SCLang:" name "*"))
(defun sclang-make-prompt-string (prompt default) (defun sclang-make-prompt-string (prompt default)
"Return a prompt string using PROMPT and DEFAULT."
(if (and default (string-match "\\(:\\)\\s *" prompt)) (if (and default (string-match "\\(:\\)\\s *" prompt))
(replace-match (replace-match
(format " (default %s):" default) (format " (default %s):" default)
@ -40,23 +29,22 @@
prompt)) prompt))
(defun sclang-string-to-int32 (str) (defun sclang-string-to-int32 (str)
"Convert first 4 bytes of STR (network byteorder) to 32 bit integer." "Convert first 4 bytes of str (network byteorder) to 32 bit integer."
(logior (ash (logand (aref str 0) #XFF) 24) (logior (lsh (logand (aref str 0) #XFF) 24)
(ash (logand (aref str 1) #XFF) 16) (lsh (logand (aref str 1) #XFF) 16)
(ash (logand (aref str 2) #XFF) 8) (lsh (logand (aref str 2) #XFF) 8)
(logand (aref str 3) #XFF))) (logand (aref str 3) #XFF)))
(defun sclang-int32-to-string (n) (defun sclang-int32-to-string (n)
"Convert 32 bit integer N to 4 byte string (network byte order)." "Convert 32 bit integer n to 4 byte string (network byte order)."
(let ((str (make-string 4 0))) (let ((str (make-string 4 0)))
(aset str 0 (logand (ash n -24) #XFF)) (aset str 0 (logand (lsh n -24) #XFF))
(aset str 1 (logand (ash n -16) #XFF)) (aset str 1 (logand (lsh n -16) #XFF))
(aset str 2 (logand (ash n -8) #XFF)) (aset str 2 (logand (lsh n -8) #XFF))
(aset str 3 (logand n #XFF)) (aset str 3 (logand n #XFF))
str)) str))
(defun sclang-compress-newlines (&optional buffer) (defun sclang-compress-newlines (&optional buffer)
"Compress newlines (optionally in BUFFER)."
(with-current-buffer (or buffer (current-buffer)) (with-current-buffer (or buffer (current-buffer))
(save-excursion (save-excursion
(goto-char (point-min)) (goto-char (point-min))
@ -95,4 +83,4 @@
(provide 'sclang-util) (provide 'sclang-util)
;;; sclang-util.el ends here ;; EOF

19
el/sclang-vars.el.in
View file

@ -19,21 +19,16 @@
;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA. ;; Boston, MA 02110-1301, USA.
;;; Commentary:
;;
;; This file is included in the distribution in order to convey system
;; installation variables which are known at compile time, but only when
;; the library is installed with cmake along with SuperCollider source.
;;
;; When using the stand-alone package, this file can be ignored and
;; the constants it defines will have no effect.
;;; Code: ;;; Code:
(defconst sclang-system-data-dir "@PKG_DATA_DIR@" (defconst sclang-system-data-dir "@PKG_DATA_DIR@"
"Installation dependent data directory. "Installation dependent data directory.")
Bound only when library is installed with SuperCollider.")
(defconst sclang-system-help-dir "@PKG_DATA_DIR@/Help"
"Installation dependent help directory.")
(defconst sclang-system-extension-dir "@PKG_DATA_DIR@/Extensions"
"Installation dependent extension directory.")
(provide 'sclang-vars) (provide 'sclang-vars)
;;; sclang-vars.el ends here ;;; sclang-vars.el ends here

27
el/sclang-widgets.el
View file

@ -1,8 +1,9 @@
;;; sclang-widgets.el --- Widget definitions for SCLang -*- coding: utf-8; lexical-binding: t -*- ;;; sclang-widgets.el --- Widget definitions for SCLang
;; Copyright (C) 2005 Free Software Foundation, Inc. ;; Copyright (C) 2005 Free Software Foundation, Inc.
;; Author: Mario Lang <mlang@blind.guru> ;; Author: Mario Lang <mlang@blind.guru>
;; Keywords: comm
;; This file is free software; you can redistribute it and/or modify ;; This file is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by ;; it under the terms of the GNU General Public License as published by
@ -20,18 +21,15 @@
;; Boston, MA 02110-1301, USA. ;; Boston, MA 02110-1301, USA.
;;; Commentary: ;;; Commentary:
;; ;;
;; Widget definitions for SCLang
;;; Code: ;;; Code:
(require 'cl-lib) (require 'cl-lib)
(require 'sclang-util) (eval-when-compile (require 'sclang-util)
(require 'sclang-language) (require 'sclang-language))
(require 'sclang-interp) (eval-and-compile (require 'sclang-interp))
(require 'widget)
(require 'wid-edit)
(defvar sclang-widgets nil) (defvar sclang-widgets nil)
(make-variable-buffer-local 'sclang-widgets) (make-variable-buffer-local 'sclang-widgets)
@ -48,13 +46,13 @@
(widget-specify-insert (widget-specify-insert
(let ((from (point)) (let ((from (point))
button-begin button-end) button-begin button-end)
(setq button-begin from) (setq button-begin (point))
(insert (widget-get-indirect widget :button-prefix)) (insert (widget-get-indirect widget :button-prefix))
(princ (nth (widget-get widget :value) (widget-get widget :states)) (current-buffer)) (princ (nth (widget-get widget :value) (widget-get widget :states)) (current-buffer))
(insert (widget-get-indirect widget :button-suffix)) (insert (widget-get-indirect widget :button-suffix))
(setq button-end from) (setq button-end (point))
;; Specify button, and insert value. ;; Specify button, and insert value.
(and button-begin button-end (and button-begin button-end
@ -67,8 +65,7 @@
(widget-put widget :to to))) (widget-put widget :to to)))
(widget-clear-undo)) (widget-clear-undo))
(defun sclang-widget-button-action (widget _event) (defun sclang-widget-button-action (widget event)
"Set button action for WIDGET."
(widget-value-set widget (widget-value-set widget
(if (>= (widget-get widget :value) (1- (length (widget-get widget :states)))) (if (>= (widget-get widget :value) (1- (length (widget-get widget :states))))
0 0
@ -106,7 +103,7 @@
(let ((from (point)) (let ((from (point))
(inhibit-redisplay t) (inhibit-redisplay t)
button-begin button-end) button-begin button-end)
(setq button-begin from) (setq button-begin (point))
(insert (widget-get-indirect widget :button-prefix)) (insert (widget-get-indirect widget :button-prefix))
(insert-char ?- (widget-get widget :size)) (insert-char ?- (widget-get widget :size))
@ -128,7 +125,6 @@
(widget-clear-undo)) (widget-clear-undo))
(defun sclang-widget-slider-value-set (widget value) (defun sclang-widget-slider-value-set (widget value)
"Set slider WIDGET to VALUE."
(save-excursion (save-excursion
(let ((inhibit-read-only t)) (let ((inhibit-read-only t))
(goto-char (widget-get widget :from)) (goto-char (widget-get widget :from))
@ -149,7 +145,6 @@
:dynargs #'sclang-widget-class-tree-dynargs) :dynargs #'sclang-widget-class-tree-dynargs)
(defun sclang-widget-class-tree-dynargs (widget) (defun sclang-widget-class-tree-dynargs (widget)
"Class tree WIDGET."
(sclang-eval-sync (sclang-format "EmacsClassTree.dynargs(%o)" (sclang-eval-sync (sclang-format "EmacsClassTree.dynargs(%o)"
(widget-get widget :tag)))) (widget-get widget :tag))))
@ -166,7 +161,5 @@
(list (sclang-read-symbol "Class: " "Object" #'sclang-class-name-p))) (list (sclang-read-symbol "Class: " "Object" #'sclang-class-name-p)))
(sclang-eval-string (format "EmacsClassBrowser(%s)" class-name))) (sclang-eval-string (format "EmacsClassBrowser(%s)" class-name)))
(provide 'sclang-widgets) (provide 'sclang-widgets)
;;; sclang-widgets.el ends here ;;; sclang-widgets.el ends here

42
el/sclang.el
View file

@ -1,15 +1,6 @@
;;; sclang.el --- IDE for working with SuperCollider -*- coding: utf-8; lexical-binding: t -*- ;;; sclang.el --- IDE for working with the SuperCollider language
;; copyright 2003 stefan kersten <steve@k-hornz.de>
;; ;;
;; Copyright 2003 stefan kersten <steve@k-hornz.de>
;;
;; Author: stefan kersten
;; Keywords: supercollider, multimedia, languages, tools
;; Version: 1.1.0
;; Package-Requires: ((emacs "27.1") (w3m "0.0"))
;; URL: https://github.com/supercollider/scel
;;; License:
;; This program is free software; you can redistribute it and/or ;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as ;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of the ;; published by the Free Software Foundation; either version 2 of the
@ -25,25 +16,7 @@
;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
;; USA ;; USA
;;; Commentary:
;;
;; This package provides code for interfacing with sclang and scsynth.
;; In order to be useful you need to install SuperCollider and the
;; sc-el Quark. See the README or https://github.com/supercollider/scel
;; for more information.
;;
;; Recent versions of w3m use tab-line which is only available after 27.1
;; However sclang should work on Emacs 26.3 to 27.1 without the help browser.
;;; Credits:
;;
;; stefan kersten <steve@k-hornz.de>
;; and everyone in...
;; git shortlog -s | sort -r | cut -c8-
;;; Code: ;;; Code:
(defgroup sclang nil (defgroup sclang nil
"IDE for working with the SuperCollider language." "IDE for working with the SuperCollider language."
:group 'languages) :group 'languages)
@ -61,19 +34,24 @@
:group 'sclang) :group 'sclang)
(defgroup sclang-programs nil (defgroup sclang-programs nil
"Paths to programs used by `sclang-mode'." "Paths to programs used by sclang-mode."
:group 'sclang-interface) :group 'sclang-interface)
(defgroup sclang-options nil (defgroup sclang-options nil
"Options for the SuperCollider process." "Options for the SuperCollider process."
:group 'sclang-interface) :group 'sclang-interface)
;;;###autoload
(defun sclang-customize () (defun sclang-customize ()
"Customize sclang variables." "Customize sclang variables."
(interactive) (interactive)
(customize-group 'sclang)) (customize-group 'sclang))
(eval-and-compile
(let ((load-path
(if (and (boundp 'byte-compile-dest-file)
(stringp byte-compile-dest-file))
(cons (file-name-directory byte-compile-dest-file) load-path)
load-path)))
(require 'sclang-util) (require 'sclang-util)
(require 'sclang-browser) (require 'sclang-browser)
(require 'sclang-interp) (require 'sclang-interp)
@ -83,7 +61,7 @@
(require 'sclang-minor-mode) (require 'sclang-minor-mode)
(require 'sclang-help) (require 'sclang-help)
(require 'sclang-server) (require 'sclang-server)
(require 'sclang-widgets) (require 'sclang-widgets)))
(provide 'sclang) (provide 'sclang)

1
el/test/fixtures/super-boring.scd vendored
View file

@ -1 +0,0 @@
{ WhiteNoise.ar(0.2!2); }.play;

12
el/test/sclang-mode-test.el
View file

@ -1,12 +0,0 @@
;; -*- no-byte-compile: t; lexical-binding: t; -*-
;;; test/sclang-mode-test.el
(ert-deftest sclang-autoloaded-functions ()
"Some functions should be callable interactively without requiring them"
(should (commandp 'sclang-start t))
(should (commandp 'sclang-mode t)))
(ert-deftest sclang-major-mode-init-test ()
"Loading a file with an scd extension should init sclang-mode"
(find-file "fixtures/super-boring.scd")
(should (eq 'sclang-mode major-mode)))

0
sc/scide_scel/CMakeLists.txt → sc/CMakeLists.txt
View file

0
sc/scide_scel/Document.sc → sc/Document.sc
View file

0
sc/scide_scel/Emacs.sc → sc/Emacs.sc
View file

0
sc/scide_scel/EmacsBuffer.sc → sc/EmacsBuffer.sc
View file

0
sc/scide_scel/EmacsDocument.sc → sc/EmacsDocument.sc
View file

0
sc/scide_scel/ScelDocument.sc → sc/ScelDocument.sc
View file

0
sc/scide_scel/extBuffer.sc → sc/extBuffer.sc
View file

0
sc/scide_scel/extClassBrowser.sc → sc/extClassBrowser.sc
View file

0
sc/scide_scel/extString.sc → sc/extString.sc
View file

0
sc/scide_scel/homeContext.sc → sc/homeContext.sc
View file

0
sc/scide_scel/storeLispOn.sc → sc/storeLispOn.sc
View file

5
scel.quark
View file

@ -1,5 +0,0 @@
(
name: "scel",
summary: "SuperCollider/Emacs interface",
version: "1.0.0",
)