diff options
Diffstat (limited to 'ctags/man/ctags-lang-r.7.html')
| -rw-r--r-- | ctags/man/ctags-lang-r.7.html | 482 |
1 files changed, 482 insertions, 0 deletions
diff --git a/ctags/man/ctags-lang-r.7.html b/ctags/man/ctags-lang-r.7.html new file mode 100644 index 0000000..3ac7c5e --- /dev/null +++ b/ctags/man/ctags-lang-r.7.html @@ -0,0 +1,482 @@ +<?xml version="1.0" encoding="utf-8" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> +<title>ctags-lang-r</title> +<style type="text/css"> + +/* +:Author: David Goodger (goodger@python.org) +:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $ +:Copyright: This stylesheet has been placed in the public domain. + +Default cascading style sheet for the HTML output of Docutils. + +See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to +customize this style sheet. +*/ + +/* used to remove borders from tables and images */ +.borderless, table.borderless td, table.borderless th { + border: 0 } + +table.borderless td, table.borderless th { + /* Override padding for "table.docutils td" with "! important". + The right padding separates the table cells. */ + padding: 0 0.5em 0 0 ! important } + +.first { + /* Override more specific margin styles with "! important". */ + margin-top: 0 ! important } + +.last, .with-subtitle { + margin-bottom: 0 ! important } + +.hidden { + display: none } + +.subscript { + vertical-align: sub; + font-size: smaller } + +.superscript { + vertical-align: super; + font-size: smaller } + +a.toc-backref { + text-decoration: none ; + color: black } + +blockquote.epigraph { + margin: 2em 5em ; } + +dl.docutils dd { + margin-bottom: 0.5em } + +object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] { + overflow: hidden; +} + +/* Uncomment (and remove this text!) to get bold-faced definition list terms +dl.docutils dt { + font-weight: bold } +*/ + +div.abstract { + margin: 2em 5em } + +div.abstract p.topic-title { + font-weight: bold ; + text-align: center } + +div.admonition, div.attention, div.caution, div.danger, div.error, +div.hint, div.important, div.note, div.tip, div.warning { + margin: 2em ; + border: medium outset ; + padding: 1em } + +div.admonition p.admonition-title, div.hint p.admonition-title, +div.important p.admonition-title, div.note p.admonition-title, +div.tip p.admonition-title { + font-weight: bold ; + font-family: sans-serif } + +div.attention p.admonition-title, div.caution p.admonition-title, +div.danger p.admonition-title, div.error p.admonition-title, +div.warning p.admonition-title, .code .error { + color: red ; + font-weight: bold ; + font-family: sans-serif } + +/* Uncomment (and remove this text!) to get reduced vertical space in + compound paragraphs. +div.compound .compound-first, div.compound .compound-middle { + margin-bottom: 0.5em } + +div.compound .compound-last, div.compound .compound-middle { + margin-top: 0.5em } +*/ + +div.dedication { + margin: 2em 5em ; + text-align: center ; + font-style: italic } + +div.dedication p.topic-title { + font-weight: bold ; + font-style: normal } + +div.figure { + margin-left: 2em ; + margin-right: 2em } + +div.footer, div.header { + clear: both; + font-size: smaller } + +div.line-block { + display: block ; + margin-top: 1em ; + margin-bottom: 1em } + +div.line-block div.line-block { + margin-top: 0 ; + margin-bottom: 0 ; + margin-left: 1.5em } + +div.sidebar { + margin: 0 0 0.5em 1em ; + border: medium outset ; + padding: 1em ; + background-color: #ffffee ; + width: 40% ; + float: right ; + clear: right } + +div.sidebar p.rubric { + font-family: sans-serif ; + font-size: medium } + +div.system-messages { + margin: 5em } + +div.system-messages h1 { + color: red } + +div.system-message { + border: medium outset ; + padding: 1em } + +div.system-message p.system-message-title { + color: red ; + font-weight: bold } + +div.topic { + margin: 2em } + +h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, +h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { + margin-top: 0.4em } + +h1.title { + text-align: center } + +h2.subtitle { + text-align: center } + +hr.docutils { + width: 75% } + +img.align-left, .figure.align-left, object.align-left, table.align-left { + clear: left ; + float: left ; + margin-right: 1em } + +img.align-right, .figure.align-right, object.align-right, table.align-right { + clear: right ; + float: right ; + margin-left: 1em } + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left } + +.align-center { + clear: both ; + text-align: center } + +.align-right { + text-align: right } + +/* reset inner alignment in figures */ +div.align-right { + text-align: inherit } + +/* div.align-center * { */ +/* text-align: left } */ + +.align-top { + vertical-align: top } + +.align-middle { + vertical-align: middle } + +.align-bottom { + vertical-align: bottom } + +ol.simple, ul.simple { + margin-bottom: 1em } + +ol.arabic { + list-style: decimal } + +ol.loweralpha { + list-style: lower-alpha } + +ol.upperalpha { + list-style: upper-alpha } + +ol.lowerroman { + list-style: lower-roman } + +ol.upperroman { + list-style: upper-roman } + +p.attribution { + text-align: right ; + margin-left: 50% } + +p.caption { + font-style: italic } + +p.credits { + font-style: italic ; + font-size: smaller } + +p.label { + white-space: nowrap } + +p.rubric { + font-weight: bold ; + font-size: larger ; + color: maroon ; + text-align: center } + +p.sidebar-title { + font-family: sans-serif ; + font-weight: bold ; + font-size: larger } + +p.sidebar-subtitle { + font-family: sans-serif ; + font-weight: bold } + +p.topic-title { + font-weight: bold } + +pre.address { + margin-bottom: 0 ; + margin-top: 0 ; + font: inherit } + +pre.literal-block, pre.doctest-block, pre.math, pre.code { + margin-left: 2em ; + margin-right: 2em } + +pre.code .ln { color: grey; } /* line numbers */ +pre.code, code { background-color: #eeeeee } +pre.code .comment, code .comment { color: #5C6576 } +pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } +pre.code .literal.string, code .literal.string { color: #0C5404 } +pre.code .name.builtin, code .name.builtin { color: #352B84 } +pre.code .deleted, code .deleted { background-color: #DEB0A1} +pre.code .inserted, code .inserted { background-color: #A3D289} + +span.classifier { + font-family: sans-serif ; + font-style: oblique } + +span.classifier-delimiter { + font-family: sans-serif ; + font-weight: bold } + +span.interpreted { + font-family: sans-serif } + +span.option { + white-space: nowrap } + +span.pre { + white-space: pre } + +span.problematic { + color: red } + +span.section-subtitle { + /* font-size relative to parent (h1..h6 element) */ + font-size: 80% } + +table.citation { + border-left: solid 1px gray; + margin-left: 1px } + +table.docinfo { + margin: 2em 4em } + +table.docutils { + margin-top: 0.5em ; + margin-bottom: 0.5em } + +table.footnote { + border-left: solid 1px black; + margin-left: 1px } + +table.docutils td, table.docutils th, +table.docinfo td, table.docinfo th { + padding-left: 0.5em ; + padding-right: 0.5em ; + vertical-align: top } + +table.docutils th.field-name, table.docinfo th.docinfo-name { + font-weight: bold ; + text-align: left ; + white-space: nowrap ; + padding-left: 0 } + +/* "booktabs" style (no vertical lines) */ +table.docutils.booktabs { + border: 0px; + border-top: 2px solid; + border-bottom: 2px solid; + border-collapse: collapse; +} +table.docutils.booktabs * { + border: 0px; +} +table.docutils.booktabs th { + border-bottom: thin solid; + text-align: left; +} + +h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, +h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { + font-size: 100% } + +ul.auto-toc { + list-style-type: none } + +</style> +</head> +<body> +<div class="document" id="ctags-lang-r"> +<span id="ctags-lang-r-7"></span> +<h1 class="title">ctags-lang-r</h1> +<h2 class="subtitle" id="random-notes-about-tagging-r-source-code-with-universal-ctags">Random notes about tagging R source code with Universal Ctags</h2> +<table class="docinfo" frame="void" rules="none"> +<col class="docinfo-name" /> +<col class="docinfo-content" /> +<tbody valign="top"> +<tr><th class="docinfo-name">Version:</th> +<td>5.9.0</td></tr> +<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Universal Ctags</td> +</tr> +<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">7</td> +</tr> +</tbody> +</table> +<div class="section" id="synopsis"> +<h1>SYNOPSIS</h1> +<div class="line-block"> +<div class="line"><strong>ctags</strong> ... --languages=+R ...</div> +<div class="line"><strong>ctags</strong> ... --language-force=R ...</div> +<div class="line"><strong>ctags</strong> ... --map-Python=+.r ...</div> +</div> +</div> +<div class="section" id="description"> +<h1>DESCRIPTION</h1> +<p>This man page gathers random notes about tagging R source code +with Universal Ctags.</p> +</div> +<div class="section" id="kinds"> +<h1>Kinds</h1> +<p>If a variable gets a value returned from a <em>well-known constructor</em> +and the variable appears for the first time in the current input file, +the R parser makes a tag for the variable and attaches a kind +associated with the constructor to the tag regardless of whether +the variable appears in the top-level context or a function.</p> +<p>Well-known constructor and kind mapping</p> +<blockquote> +<table border="1" class="docutils"> +<colgroup> +<col width="40%" /> +<col width="60%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Constructor</th> +<th class="head">kind</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td>function()</td> +<td>function</td> +</tr> +<tr><td>c()</td> +<td>vector</td> +</tr> +<tr><td>list()</td> +<td>list</td> +</tr> +<tr><td>data.frame()</td> +<td>dataframe</td> +</tr> +</tbody> +</table> +</blockquote> +<p>If a variable doesn't get a value returned from one of well-known +constructors, the R parser attaches <tt class="docutils literal">globalVar</tt> or <tt class="docutils literal">functionVar</tt> kind +to the tag for the variable depending on the context.</p> +<p>Here is an example demonstrating the usage of the kinds:</p> +<p>"input.r"</p> +<pre class="code R literal-block"> +<span class="name">G</span> <span class="operator"><-</span> <span class="literal number">1</span> +<span class="name">v</span> <span class="operator"><-</span> <span class="name function">c</span><span class="punctuation">(</span><span class="literal number">1</span><span class="punctuation">,</span> <span class="literal number">2</span><span class="punctuation">)</span> +<span class="name">l</span> <span class="operator"><-</span> <span class="name function">list</span><span class="punctuation">(</span><span class="literal number">3</span><span class="punctuation">,</span> <span class="literal number">4</span><span class="punctuation">)</span> +<span class="name">d</span> <span class="operator"><-</span> <span class="name function">data.frame</span><span class="punctuation">(</span><span class="name">n</span> <span class="operator">=</span> <span class="name">v</span><span class="punctuation">)</span> +<span class="name">f</span> <span class="operator"><-</span> <span class="name function">function</span><span class="punctuation">(</span><span class="name">a</span><span class="punctuation">)</span> <span class="punctuation">{</span> + <span class="name">g</span> <span class="operator"><-</span> <span class="name function">function </span><span class="punctuation">(</span><span class="name">b</span><span class="punctuation">)</span> <span class="name">a</span> <span class="operator">+</span> <span class="name">b</span> + <span class="name">w</span> <span class="operator"><-</span> <span class="name function">c</span><span class="punctuation">(</span><span class="literal number">1</span><span class="punctuation">,</span> <span class="literal number">2</span><span class="punctuation">)</span> + <span class="name">m</span> <span class="operator"><-</span> <span class="name function">list </span><span class="punctuation">(</span><span class="literal number">3</span><span class="punctuation">,</span> <span class="literal number">4</span><span class="punctuation">)</span> + <span class="name">e</span> <span class="operator"><-</span> <span class="name function">data.frame</span><span class="punctuation">(</span><span class="name">n</span> <span class="operator">=</span> <span class="name">w</span><span class="punctuation">)</span> + <span class="name">L</span> <span class="operator"><-</span> <span class="literal number">2</span> +<span class="punctuation">}</span> +</pre> +<p>"output.tags" +with "--options=NONE --sort=no --fields=+KZ -o - input.r"</p> +<div class="system-message"> +<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">ctags-lang-r.7.rst</tt>, line 68)</p> +<p>Cannot analyze code. No Pygments lexer found for "tags".</p> +<pre class="literal-block"> +.. code-block:: tags + + G input.r /^G <- 1$/;" globalVar + v input.r /^v <- c(1, 2)$/;" vector + l input.r /^l <- list(3, 4)$/;" list + d input.r /^d <- data.frame(n = v)$/;" dataframe + n input.r /^d <- data.frame(n = v)$/;" nameattr scope:dataframe:d + f input.r /^f <- function(a) {$/;" function + g input.r /^ g <- function (b) a + b$/;" function scope:function:f + w input.r /^ w <- c(1, 2)$/;" vector scope:function:f + m input.r /^ m <- list (3, 4)$/;" list scope:function:f + e input.r /^ e <- data.frame(n = w)$/;" dataframe scope:function:f + n input.r /^ e <- data.frame(n = w)$/;" nameattr scope:dataframe:f.e + L input.r /^ L <- 2$/;" functionVar scope:function:f + +</pre> +</div> +<!-- TODO: + +- other kinds +- operators for assignment, <-, <<-, ->>, ->, = +- illuminating duplicated tags +- fields (constructor, assignmentop) +- sub parsers --> +</div> +<div class="section" id="see-also"> +<h1>SEE ALSO</h1> +<p>ctags(1)</p> +</div> +</div> +</body> +</html> |