On this page:
drracket:  modes:  add-mode
drracket:  modes:  mode
drracket:  modes:  struct:  mode
drracket:  modes:  get-modes

20 drracket:modes

procedure

(drracket:modes:add-mode name 
  surrogate 
  repl-submit 
  matches-language) 
  drracket:modes:mode?
  name : string?
  surrogate : (or/c #f (is-a?/c mode:surrogate-text<%>))
  repl-submit : (-> (is-a?/c drracket:rep:text%) number? boolean?)
  matches-language : (-> (or/c #f (listof string?)) boolean?)
Adds a mode to DrRacket. Returns a mode value that identifies the mode.

The first argument, name, is the name of the mode, used in DrRacket’s GUI to allow the user to select this mode.

The surrogate argument is set to the definitions text and the interactions text (via the mode:host-text set-surrogate<%> method) whenever this mode is enabled.

The repl-submit procedure is called whenever the user types a return in the interactions window. It is passed the interactions editor and the position where the last prompt occurs. If it returns #t, the text after the last prompt is treated as a program fragment and evaluated, according to the language settings. If it returns #f, the text is assumed to be an incomplete program fragment, and the keystroke is not treated specially.

The matches-language predicate is called whenever the language changes. If it returns #t this mode is installed. It is passed the list of strings that correspond to the names of the language in the language dialog.

Modes are tested in the opposite order that they are added. That is, the last mode to be added gets tested first when the filename changes or when the language changes.

struct

(struct drracket:modes:mode (name
    surrogate
    repl-submit
    matches-language))
  name : string?
  surrogate : (or/c #f (is-a?/c mode:surrogate-text<%>))
  repl-submit : (-> (is-a?/c drracket:rep:text%) number? boolean?)
  matches-language : (-> (or/c #f (listof string?)) boolean?)
See drracket:modes:add-mode for details on modes.
Returns all of the modes currently added to DrRacket.

See also drracket:modes:add-mode.