The R Project SVN R

Rev

Rev 62131 | Rev 64657 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 62131 Rev 62152
Line 243... Line 243...
243
 
243
 
244
  }
244
  }
245
}
245
}
246
 
246
 
247
\value{
247
\value{
-
 
248
  If \code{rc.settings} is called without any arguments, it returns the
-
 
249
  current settings as a named logical vector.  Otherwise, it returns
-
 
250
  \code{NULL} invisibly. 
-
 
251
  
248
  \code{rc.status} returns, as a list, the contents of an internal
252
  \code{rc.status} returns, as a list, the contents of an internal
249
  (unexported) environment that is used to record the results of the
253
  (unexported) environment that is used to record the results of the
250
  last completion attempt.  This can be useful for debugging.  For such
254
  last completion attempt.  This can be useful for debugging.  For such
251
  use, one must resist the temptation to use completion when typing the
255
  use, one must resist the temptation to use completion when typing the
252
  call to \code{rc.status} itself, as that then becomes the last attempt
256
  call to \code{rc.status} itself, as that then becomes the last attempt
253
  by the time the call is executed.
257
  by the time the call is executed.
254
 
258
 
255
  The items of primary interest in the returned list are:
259
  The items of primary interest in the returned list are:
256
 
260
 
257
  \item{comps}{ the possible completions generated by the last
261
  \item{comps}{ The possible completions generated by the last
258
    call to \code{.completeToken}, as a character vector }
262
    call to \code{.completeToken}, as a character vector. }
259
  \item{token}{ the token that was (or, is to be) completed, as
263
  \item{token}{ The token that was (or, is to be) completed, as
260
    set by the last call to \code{.assignToken} (possibly inside a call
264
    set by the last call to \code{.assignToken} (possibly inside a call
261
    to \code{.guessTokenFromLine}) }
265
    to \code{.guessTokenFromLine}). }
262
  \item{linebuffer}{ the full line, as set by the last call to
266
  \item{linebuffer}{ The full line, as set by the last call to
263
    \code{.assignLinebuffer}}
267
    \code{.assignLinebuffer}. }
264
  \item{start}{ the start position of the token in the line
268
  \item{start}{ The start position of the token in the line
265
    buffer, as set by the last call to \code{.assignStart} }
269
    buffer, as set by the last call to \code{.assignStart}. }
266
  \item{end}{ the end position of the token in the line
270
  \item{end}{ The end position of the token in the line
267
    buffer, as set by the last call to \code{.assignEnd} }
271
    buffer, as set by the last call to \code{.assignEnd}. }
268
  \item{fileName}{ logical, indicating whether the cursor is
272
  \item{fileName}{ Logical, indicating whether the cursor is
269
    currently inside quotes.  If so, no completion is attempted.  A
-
 
270
    reasonable default behaviour for the backend in that case is to fall
-
 
271
    back to filename completion.  }
273
    currently inside quotes. }
272
  \item{fguess}{ the name of the function \code{rcompgen} thinks
274
  \item{fguess}{ The name of the function the cursor is currently inside. }
273
    the cursor is currently inside }
-
 
274
  \item{isFirstArg}{ logical.  If cursor is inside a function, is it the
275
  \item{isFirstArg}{ Logical.  If cursor is inside a function, is it the
275
    first argument? }
276
    first argument? }
276
 
277
 
277
  In addition, the components \code{settings} and \code{options} give
278
  In addition, the components \code{settings} and \code{options} give
278
  the current values of settings and options respectively.
279
  the current values of settings and options respectively.
279
 
280