swank.R

   1 ### This program is free software; you can redistribute it and/or
   2 ### modify it under the terms of the GNU General Public Licence as
   3 ### published by the Free Software Foundation; either version 2 of the
   4 ### Licence, or (at your option) any later version.
   5 ###
   6 ### This program is distributed in the hope that it will be useful,
   7 ### but WITHOUT ANY WARRANTY; without even the implied warranty of
   8 ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   9 ### GNU General Public Licence for more details.
  10 ###
  11 ### A copy of version 2 of the GNU General Public Licence is available
  12 ### at <http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt>; the
  13 ### latest version of the GNU General Public Licence is available at
  14 ### <http://www.gnu.org/licenses/gpl.txt>.
  15
  16 swank <- function(port=4005) {
  17   acceptConnections(port, FALSE)
  18 }
  19
  20 startSwank <- function(portFile) {
  21   acceptConnections(FALSE, portFile)
  22 }
  23
  24 acceptConnections <- function(port, portFile) {
  25   s <- socketConnection(host="localhost", server=TRUE, port=port, open="r+b")
  26   on.exit(close(s))
  27   serve(s)
  28 }
  29
  30 serve <- function(io) {
  31   mainLoop(io)
  32 }
  33
  34 mainLoop <- function(io) {
  35   slimeConnection <- new.env()
  36   slimeConnection$io <- io
  37   while(TRUE) {
  38     withRestarts(tryCatch(dispatch(slimeConnection, readPacket(io)),
  39                           swankTopLevel=function(c) NULL),
  40                  abort="return to SLIME's toplevel")
  41   }
  42 }
  43
  44 dispatch <- function(slimeConnection, event, sldbState=NULL) {
  45   str(event)
  46   kind <- event[[1]]
  47   if(kind == quote(`:emacs-rex`)) {
  48     do.call("emacsRex", c(list(slimeConnection), list(sldbState), event[-1]))
  49   }
  50 }
  51
  52 sendToEmacs <- function(slimeConnection, obj) {
  53   io <- slimeConnection$io
  54   str(obj)
  55   payload <- writeSexpToString(obj)
  56   writeChar(sprintf("%06x", nchar(payload)), io, eos=NULL)
  57   writeChar(payload, io, eos=NULL)
  58   flush(io)
  59   cat(sprintf("%06x", nchar(payload)), payload, sep="")
  60 }
  61
  62 callify <- function(form) {
  63   ## we implement here the conversion from Lisp S-expression (or list)
  64   ## expressions of code into our own, swankr, calling convention,
  65   ## with slimeConnection and sldbState as first and second arguments.
  66   ## as.call() gets us part of the way, but we need to walk the list
  67   ## recursively to mimic CL:EVAL; we need to avoid converting R
  68   ## special operators which we are punning (only `quote`, for now)
  69   ## into this calling convention.
  70   if(is.list(form)) {
  71     if(form[[1]] == quote(quote)) {
  72       as.call(form)
  73     } else {
  74       as.call(c(list(form[[1]], quote(slimeConnection), quote(sldbState)), lapply(form[-1], callify)))
  75     }
  76   } else {
  77     form
  78   }
  79 }
  80
  81 emacsRex <- function(slimeConnection, sldbState, form, pkg, thread, id, level=0) {
  82   ok <- FALSE
  83   value <- NULL
  84   tryCatch({
  85     withCallingHandlers({
  86       call <- callify(form)
  87       value <- eval(call)
  88       ok <- TRUE
  89     }, error=function(c) {
  90       newSldbState <- makeSldbState(c, if(is.null(sldbState)) 0 else sldbState$level+1, id)
  91       withRestarts(sldbLoop(slimeConnection, newSldbState, id), abort=paste("return to sldb level", newSldbState$level)) })},
  92     finally=sendToEmacs(slimeConnection, list(quote(`:return`), if(ok) list(quote(`:ok`), value) else list(quote(`:abort`)), id)))
  93 }
  94
  95 makeSldbState <- function(condition, level, id) {
  96   calls <- rev(sys.calls())[-1]
  97   frames <- rev(sys.frames())[-1]
  98   restarts <- rev(computeRestarts(condition))[-1]
  99   ret <- list(condition=condition, level=level, id=id, restarts=restarts, calls=calls, frames=frames)
 100   class(ret) <- c("sldbState", class(ret))
 101   ret
 102 }
 103
 104 sldbLoop <- function(slimeConnection, sldbState, id) {
 105   tryCatch({
 106     io <- slimeConnection$io
 107     sendToEmacs(slimeConnection, c(list(quote(`:debug`), id, sldbState$level), `swank:debugger-info-for-emacs`(slimeConnection, sldbState)))
 108     sendToEmacs(slimeConnection, list(quote(`:debug-activate`), id, sldbState$level, FALSE))
 109     while(TRUE) {
 110       dispatch(slimeConnection, readPacket(io), sldbState)
 111     }
 112   }, finally=sendToEmacs(slimeConnection, c(list(quote(`:debug-return`), id, sldbState$level, FALSE))))
 113 }
 114
 115 readPacket <- function(io) {
 116   socketSelect(list(io))
 117   header <- readChunk(io, 6)
 118   len <- strtoi(header, base=16)
 119   payload <- readChunk(io, len)
 120   readSexpFromString(payload)
 121 }
 122
 123 readChunk <- function(io, len) {
 124   buffer <- readChar(io, len)
 125   if(nchar(buffer) != len) {
 126     stop("short read in readChunk")
 127   }
 128   buffer
 129 }
 130
 131 readSexpFromString <- function(string) {
 132   pos <- 1
 133   read <- function() {
 134     skipWhitespace()
 135     char <- substr(string, pos, pos)
 136     switch(char,
 137            "("=readList(),
 138            "\""=readString(),
 139            "'"=readQuote(),
 140            {
 141              if(pos > nchar(string))
 142                stop("EOF during read")
 143              obj <- readNumberOrSymbol()
 144              if(obj == quote(`.`)) {
 145                stop("Consing dot not implemented")
 146              }
 147              obj
 148            })
 149   }
 150   skipWhitespace <- function() {
 151     while(substr(string, pos, pos) %in% c(" ", "\t", "\n")) {
 152       pos <<- pos + 1
 153     }
 154   }
 155   readList <- function() {
 156     ret <- list()
 157     pos <<- pos + 1
 158     while(TRUE) {
 159       skipWhitespace()
 160       char <- substr(string, pos, pos)
 161       if(char == ")") {
 162         pos <<- pos + 1
 163         break
 164       } else {
 165         obj <- read()
 166         if(length(obj) == 1 && obj == quote(`.`)) {
 167           stop("Consing dot not implemented")
 168         }
 169         ret <- c(ret, list(obj))
 170       }
 171     }
 172     ret
 173   }
 174   readString <- function() {
 175     ret <- ""
 176     addChar <- function(c) { ret <<- paste(ret, c, sep="") }
 177     while(TRUE) {
 178       pos <<- pos + 1
 179       char <- substr(string, pos, pos)
 180       switch(char,
 181              "\""={ pos <<- pos + 1; break },
 182              "\\"={ pos <<- pos + 1
 183                     char2 <- substr(string, pos, pos)
 184                     switch(char2,
 185                            "\""=addChar(char2),
 186                            "\\"=addChar(char2),
 187                            stop("Unrecognized escape character")) },
 188              addChar(char))
 189     }
 190     ret
 191   }
 192   readNumberOrSymbol <- function() {
 193     token <- readToken()
 194     if(nchar(token)==0) {
 195       stop("End of file reading token")
 196     } else if(grepl("^[0-9]+$", token)) {
 197       strtoi(token)
 198     } else if(grepl("^[0-9]+\\.[0-9]+$", token)) {
 199       as.double(token)
 200     } else {
 201       as.name(token)
 202     }
 203   }
 204   readToken <- function() {
 205     token <- ""
 206     while(TRUE) {
 207       char <- substr(string, pos, pos)
 208       if(char == "") {
 209         break;
 210       } else if(char %in% c(" ", "\n", "\t", "(", ")", "\"", "'")) {
 211         break;
 212       } else {
 213         token <- paste(token, char, sep="")
 214         pos <<- pos + 1
 215       }
 216     }
 217     token
 218   }
 219   read()
 220 }
 221
 222 writeSexpToString <- function(obj) {
 223   writeSexpToStringLoop <- function(obj) {
 224     switch(typeof(obj),
 225            "character"={ string <- paste(string, "\"", gsub("([\"\\])", "\\\\\\1", obj), "\"", sep="") },
 226            "list"={ string <- paste(string, "(", sep="")
 227                     max <- length(obj)
 228                     if(max > 0) {
 229                       for(i in 1:max) {
 230                         string <- paste(string, writeSexpToString(obj[[i]]), sep="")
 231                         if(i != max) {
 232                           string <- paste(string, " ", sep="")
 233                         }
 234                       }
 235                     }
 236                     string <- paste(string, ")", sep="") },
 237            "symbol"={ string <- paste(string, as.character(obj), sep="") },
 238            "logical"={ string <- if(obj) { paste(string, "t", sep="") } else { paste(string, "nil", sep="") }},
 239            "double"={ string <- paste(string, as.character(obj), sep="") },
 240            "integer"={ string <- paste(string, as.character(obj), sep="") },
 241            stop(paste("can't write object ", obj, sep="")))
 242     string
 243   }
 244   string <- ""
 245   writeSexpToStringLoop(obj)
 246 }
 247
 248 printToString <- function(val) {
 249   f <- fifo("")
 250   sink(f)
 251   tryCatch({
 252     tryCatch(str(val, indent.str="", list.len=5, max.level=2),
 253              finally=sink())
 254     readLines(f) },
 255            finally=close(f))
 256 }
 257
 258 `swank:connection-info` <- function (slimeConnection, sldbState) {
 259   list(quote(`:pid`), Sys.getpid(),
 260        quote(`:package`), list(quote(`:name`), "R", quote(`:prompt`), "R> "),
 261        quote(`:lisp-implementation`), list(quote(`:type`), "R",
 262                                            quote(`:name`), "R",
 263                                            quote(`:version`), paste(R.version$major, R.version$minor, sep=".")))
 264 }
 265
 266 `swank:swank-require` <- function (slimeConnection, sldbState, contribs) {
 267   for(contrib in contribs) {
 268     filename <- sprintf("%s.R", as.character(contrib))
 269     if(file.exists(filename)) {
 270       source(filename, verbose=TRUE)
 271     }
 272   }
 273   list()
 274 }
 275
 276 `swank:create-repl` <- function(slimeConnection, sldbState, env, ...) {
 277   list("R", "R")
 278 }
 279
 280 sendReplResult <- function(slimeConnection, value) {
 281   string <- printToString(value)
 282   sendToEmacs(slimeConnection,
 283               list(quote(`:write-string`),
 284                    paste(string, collapse="\n"),
 285                    quote(`:repl-result`)))
 286 }
 287
 288 sendReplResultFunction <- sendReplResult
 289
 290 `swank:listener-eval` <- function(slimeConnection, sldbState, string) {
 291   string <- gsub("#\\.\\(swank:lookup-presented-object-or-lose([^)]*)\\)", ".(`swank:lookup-presented-object-or-lose`(slimeConnection, sldbState,\\1))", string)
 292   expr <- parse(text=string)[[1]]
 293   lookedup <- do.call("bquote", list(expr))
 294   value <- eval(lookedup, envir = globalenv())
 295   sendReplResultFunction(slimeConnection, value)
 296   list()
 297 }
 298
 299 `swank:autodoc` <- function(slimeConnection, sldbState, rawForm, ...) {
 300   "No Arglist Information"
 301 }
 302
 303 `swank:operator-arglist` <- function(slimeConnection, sldbState, op, package) {
 304   list()
 305 }
 306
 307 `swank:throw-to-toplevel` <- function(slimeConnection, sldbState) {
 308   condition <- simpleCondition("Throw to toplevel")
 309   class(condition) <- c("swankTopLevel", class(condition))
 310   signalCondition(condition)
 311 }
 312
 313 `swank:backtrace` <- function(slimeConnection, sldbState, from=0, to=NULL) {
 314   calls <- sldbState$calls
 315   if(is.null(to)) to <- length(calls)
 316   from <- from+1
 317   calls <- lapply(calls[from:to],
 318                   { frameNumber <- from-1;
 319                     function (x) {
 320                       ret <- list(frameNumber, paste(format(x), sep="", collapse=" "))
 321                       frameNumber <<- 1+frameNumber
 322                       ret
 323                     }
 324                   })
 325 }
 326
 327 computeRestartsForEmacs <- function (sldbState) {
 328   lapply(sldbState$restarts,
 329          function(x) {
 330            ## this is all a little bit internalsy
 331            restartName <- x[[1]][[1]]
 332            description <- restartDescription(x)
 333            list(restartName, if(is.null(description)) restartName else description)
 334          })
 335 }
 336
 337 `swank:debugger-info-for-emacs` <- function(slimeConnection, sldbState, from=0, to=NULL) {
 338   list(list(as.character(sldbState$condition), sprintf("  [%s]", class(sldbState$condition)[[1]]), FALSE),
 339        computeRestartsForEmacs(sldbState),
 340        `swank:backtrace`(slimeConnection, sldbState, from, to),
 341        list(sldbState$id))
 342 }
 343
 344 `swank:invoke-nth-restart-for-emacs` <- function(slimeConnection, sldbState, level, n) {
 345   if(sldbState$level == level) {
 346     invokeRestart(sldbState$restarts[[n+1]])
 347   }
 348 }
 349
 350 `swank:frame-source-location` <- function(slimeConnection, sldbState, n) {
 351   call <- sldbState$calls[[n+1]]
 352   srcref <- attr(call, "srcref")
 353   srcfile <- attr(srcref, "srcfile")
 354   if(is.null(srcfile)) {
 355     list(quote(`:error`), "no srcfile")
 356   } else {
 357     list(quote(`:location`),
 358          list(quote(`:file`), sprintf("%s/%s", srcfile$wd, srcfile$filename)),
 359          list(quote(`:line`), srcref[[1]], srcref[[2]]-1),
 360          FALSE)
 361   }
 362 }
 363
 364 `swank:buffer-first-change` <- function(slimeConnection, sldbState, filename) {
 365   FALSE
 366 }
 367
 368 `swank:frame-locals-and-catch-tags` <- function(slimeConnection, sldbState, index) {
 369   str(sldbState$frames)
 370   frame <- sldbState$frames[[1+index]]
 371   objs <- ls(envir=frame)
 372   list(lapply(objs, function(name) { list(quote(`:name`), name,
 373                                           quote(`:id`), 0,
 374                                           quote(`:value`), paste(printToString(eval(parse(text=name), envir=frame)), sep="", collapse="\n")) }),
 375        list())
 376 }
 377
 378 `swank:simple-completions` <- function(slimeConnection, sldbState, prefix, package) {
 379   ## fails multiply if prefix contains regexp metacharacters
 380   matches <- apropos(sprintf("^%s", prefix), ignore.case=FALSE)
 381   nmatches <- length(matches)
 382   if(nmatches == 0) {
 383     list(list(), "")
 384   } else {
 385     longest <- matches[order(nchar(matches))][1]
 386     while(length(grep(sprintf("^%s", longest), matches)) < nmatches) {
 387       longest <- substr(longest, 1, nchar(longest)-1)
 388     }
 389     list(as.list(matches), longest)
 390   }
 391 }
 392
 393 `swank:compile-string-for-emacs` <- function(slimeConnection, sldbState, string, buffer, position, filename, policy) {
 394   # FIXME: I think in parse() here we can use srcref to associate
 395   # buffer/filename/position to the objects.  Or something.
 396   withRestarts({ times <- system.time(eval(parse(text=string), envir = globalenv())) },
 397                abort="abort compilation")
 398   list(quote(`:compilation-result`), list(), TRUE, times[3])
 399 }
 400
 401 `swank:interactive-eval` <-  function(slimeConnection, sldbState, string) {
 402   retry <- TRUE
 403   value <- ""
 404   while(retry) {
 405     retry <- FALSE
 406     withRestarts(value <- eval(parse(text=string), envir = globalenv()),
 407                  retry=list(description="retry SLIME interactive evaluation request", handler=function() retry <<- TRUE))
 408   }
 409   printToString(value)
 410 }
 411
 412 `swank:eval-and-grab-output` <- function(slimeConnection, sldbState, string) {
 413   retry <- TRUE
 414   value <- ""
 415   output <- NULL
 416   f <- fifo("")
 417   tryCatch({
 418     sink(f)
 419     while(retry) {
 420       retry <- FALSE
 421       withRestarts(value <- eval(parse(text=string), envir = globalenv()),
 422                    retry=list(description="retry SLIME interactive evaluation request", handler=function() retry <<- TRUE))}},
 423            finally={sink(); output <- readLines(f); close(f)})
 424   list(output, printToString(value))
 425 }
 426
 427 `swank:find-definitions-for-emacs` <- function(slimeConnection, sldbState, string) {
 428   if(exists(string, envir = globalenv())) {
 429     thing <- get(string, envir = globalenv())
 430     if(inherits(thing, "function")) {
 431       body <- body(thing)
 432       srcref <- attr(body, "srcref")
 433       srcfile <- attr(body, "srcfile")
 434       if(is.null(srcfile)) {
 435         list()
 436       } else {
 437         filename <- get("filename", srcfile)
 438         list(list(sprintf("function %s", string),
 439                   list(quote(`:location`),
 440                        list(quote(`:file`), sprintf("%s/%s", srcfile$wd, srcfile$filename)),
 441                        list(quote(`:line`), srcref[[2]][[1]], srcref[[2]][[2]]-1),
 442                        list())))
 443       }
 444     } else {
 445       list()
 446     }
 447   } else {
 448     list()
 449   }
 450 }