diff options
author | 2014-03-26 10:15:53 -0400 | |
---|---|---|
committer | 2014-03-26 10:15:53 -0400 | |
commit | f65b2b2a66f05b20010256ca1d81cc3252ea1471 (patch) | |
tree | c7ee3cd4753a9e8a73f9e9d3e8a45f96eb5b36c7 /core/.proc.luadoc | |
parent | 6304010d93b3cfe43e246dbb49c60d147a366b1b (diff) | |
download | textadept-f65b2b2a66f05b20010256ca1d81cc3252ea1471.tar.gz textadept-f65b2b2a66f05b20010256ca1d81cc3252ea1471.zip |
Include my new "lspawn" module by default for spawning processes.
The `textadept.run` module now uses `spawn()` instead of `io.popen()`.
This module replaces the dependency on winapi. Removed experimental
`io.popen()` and `os.execute()` hooks. They may be re-implemented later using
`spawn()`.
Diffstat (limited to 'core/.proc.luadoc')
-rw-r--r-- | core/.proc.luadoc | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/core/.proc.luadoc b/core/.proc.luadoc new file mode 100644 index 00000000..ae62bdf8 --- /dev/null +++ b/core/.proc.luadoc @@ -0,0 +1,29 @@ +-- Copyright 2012-2014 Mitchell mitchell.att.foicica.com. See LICENSE. +-- This is a DUMMY FILE used for making LuaDoc for functions in the proc +-- userdata defined by the lspawn module. + +--- +-- Userdata representing a process created by `spawn()`. +module('proc') + +--- +-- Returns the status of `proc`, which is either "running" or "terminated". +-- @param proc A process created by `spawn()`. +-- @return "running" or "terminated" +function status(proc) end + +--- +-- Blocks until `proc` finishes. +-- @param proc A process created by `spawn()`. +function wait(proc) end + +--- +-- Writes string `input` to the stdin of `proc`. +-- @param proc A process created by `spawn()`. +-- @param ... Standard input for `proc`. +function write(proc, ...) end + +--- +-- Kills running `proc`. +-- @param proc A running process created by `spawn()`. +function kill(proc) end |