mermaid
Version:
Markdownish syntax for generating flowcharts, sequence diagrams and gantt charts.
339 lines (309 loc) • 25.1 kB
HTML
<html>
<head>
<title>utils.js</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="stylesheet" media="all" href="../doc-style.css" />
<script src="../doc-filelist.js"></script>
<script>
var relativeDir = "../", thisFile = "Users/knut/Documents/source/mermaid/src/utils.js", defaultSidebar = true;
</script>
<script src="../doc-script.js"></script>
<script src="../mermaid.js"></script>
<link rel="stylesheet" href="../mermaid.css" />
</head>
<body>
<div id="sidebar_wrapper">
<div id="sidebar_switch">
<span class="tree">Files</span>
<span class="headings">Headings</span>
</div>
<div id="tree"></div>
<div id="headings">
<div class="heading h1">
<a href="#utils.js">utils.js</a>
</div>
</div>
</div>
<div id="sidebar-toggle"></div>
<div id="container"><div class="background highlight"></div>
<table cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="docs">
<div class="pilwrap" id="utils.js">
<h1>
<a href="#utils.js" name="utils.js" class="pilcrow">¶</a>utils.js
</h1>
</div>
</td>
<td class="code highlight"></td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-1" id="section-1">¶</a>
</div>
<div class="dox">
<div class="summary"><p>Created by knut on 14-11-23.</p>
</div>
<div class="body">
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre><span class="kd">var</span> <span class="nx">log</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'./logger'</span><span class="p">).</span><span class="nx">create</span><span class="p">();</span>
</pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-2" id="section-2">¶</a>
</div>
<div class="dox">
<div class="summary">
</div>
<div class="body">
</div>
<div class="details">
<div class="dox_tag_title">function</div>
<div class="dox_tag_detail">
<span>detectType
Detects the type of the graph text.
<script>mermaid.initialize({startOnLoad:true});</script><div class="mermaid">graph LR
a-->b
b-->c
c-->d
d-->e
e-->f
f-->g
g-->h</div></span>
</div>
<div class="dox_tag_title">Params</div>
<div class="dox_tag_detail">
<span class="dox_tag_name">text</span>
<span class="dox_type">string</span>
<span>The text defining the graph
</span>
</div>
<div class="dox_tag_detail">
<span class="dox_tag_name">text</span>
<span class="dox_type">string</span>
<span>The second text defining the graph
</span>
</div>
<div class="dox_tag_title">Returns</div>
<div class="dox_tag_detail">
<span class="dox_tag_name"></span>
<span class="dox_type">string</span>
<span>A graph definition key
</span>
</div>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre>
<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">detectType</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">text</span><span class="p">,</span><span class="nx">a</span><span class="p">){</span>
<span class="k">if</span><span class="p">(</span><span class="nx">text</span><span class="p">.</span><span class="nx">match</span><span class="p">(</span><span class="sr">/^\s*sequenceDiagram/</span><span class="p">)){</span>
<span class="k">return</span> <span class="s2">"sequenceDiagram"</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span><span class="p">(</span><span class="nx">text</span><span class="p">.</span><span class="nx">match</span><span class="p">(</span><span class="sr">/^\s*sequence/</span><span class="p">)){</span>
</pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-3" id="section-3">¶</a>
</div>
<div class="dox">
<div class="summary"><div class="mermaid">graph TB
a-->b
b-->c</div>
</div>
<div class="body">
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre>
<span class="k">return</span> <span class="s2">"sequence"</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span><span class="p">(</span><span class="nx">text</span><span class="p">.</span><span class="nx">match</span><span class="p">(</span><span class="sr">/^\s*digraph/</span><span class="p">))</span> <span class="p">{</span>
</pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-4" id="section-4">¶</a>
</div>
<p>log.debug('Detected dot syntax');</p>
</td>
<td class="code highlight"><div class="highlight"><pre>
<span class="k">return</span> <span class="s2">"dotGraph"</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span><span class="p">(</span><span class="nx">text</span><span class="p">.</span><span class="nx">match</span><span class="p">(</span><span class="sr">/^\s*info/</span><span class="p">))</span> <span class="p">{</span>
</pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-5" id="section-5">¶</a>
</div>
<p>log.debug('Detected info syntax');</p>
</td>
<td class="code highlight"><div class="highlight"><pre>
<span class="k">return</span> <span class="s2">"info"</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span><span class="p">(</span><span class="nx">text</span><span class="p">.</span><span class="nx">match</span><span class="p">(</span><span class="sr">/^\s*gantt/</span><span class="p">))</span> <span class="p">{</span>
</pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-6" id="section-6">¶</a>
</div>
<p>log.debug('Detected info syntax');</p>
</td>
<td class="code highlight"><div class="highlight"><pre>
<span class="k">return</span> <span class="s2">"gantt"</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">return</span> <span class="s2">"graph"</span><span class="p">;</span>
<span class="p">};</span>
</pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-7" id="section-7">¶</a>
</div>
<div class="dox">
<div class="summary"><p>Copies all relevant CSS content into the graph SVG.
This allows the SVG to be copied as is while keeping class based styling</p>
</div>
<div class="body">
</div>
<div class="details">
<div class="dox_tag_title">Params</div>
<div class="dox_tag_detail">
<span class="dox_tag_name">svg</span>
<span class="dox_type">element</span>
<span>The root element of the SVG
</span>
</div>
<div class="dox_tag_detail">
<span class="dox_tag_name">Hash</span>
<span class="dox_type">object</span>
<span>table of class definitions from the graph definition
</span>
</div>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre>
<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">cloneCssStyles</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">svg</span><span class="p">,</span> <span class="nx">classes</span><span class="p">){</span>
<span class="kd">var</span> <span class="nx">usedStyles</span> <span class="o">=</span> <span class="s2">""</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">sheets</span> <span class="o">=</span> <span class="nb">document</span><span class="p">.</span><span class="nx">styleSheets</span><span class="p">;</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">sheets</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span>
</pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-8" id="section-8">¶</a>
</div>
<p>Avoid multiple inclusion on pages with multiple graphs</p>
</td>
<td class="code highlight"><div class="highlight"><pre>
<span class="k">if</span> <span class="p">(</span><span class="nx">sheets</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">title</span> <span class="o">!==</span> <span class="s1">'mermaid-svg-internal-css'</span><span class="p">)</span> <span class="p">{</span>
<span class="k">try</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">rules</span> <span class="o">=</span> <span class="nx">sheets</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">cssRules</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">rules</span> <span class="o">!==</span> <span class="kc">null</span><span class="p">)</span> <span class="p">{</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">j</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">j</span> <span class="o"><</span> <span class="nx">rules</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">j</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">rule</span> <span class="o">=</span> <span class="nx">rules</span><span class="p">[</span><span class="nx">j</span><span class="p">];</span>
<span class="k">if</span> <span class="p">(</span><span class="k">typeof</span><span class="p">(</span><span class="nx">rule</span><span class="p">.</span><span class="nx">style</span><span class="p">)</span> <span class="o">!==</span> <span class="s1">'undefined'</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">elems</span><span class="p">;</span>
<span class="nx">elems</span> <span class="o">=</span> <span class="nx">svg</span><span class="p">.</span><span class="nx">querySelectorAll</span><span class="p">(</span><span class="nx">rule</span><span class="p">.</span><span class="nx">selectorText</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">elems</span><span class="p">.</span><span class="nx">length</span> <span class="o">></span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">usedStyles</span> <span class="o">+=</span> <span class="nx">rule</span><span class="p">.</span><span class="nx">selectorText</span> <span class="o">+</span> <span class="s2">" { "</span> <span class="o">+</span> <span class="nx">rule</span><span class="p">.</span><span class="nx">style</span><span class="p">.</span><span class="nx">cssText</span> <span class="o">+</span> <span class="s2">" }\n"</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="k">catch</span><span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span><span class="p">(</span><span class="k">typeof</span> <span class="nx">console</span> <span class="o">!==</span> <span class="s1">'undefined'</span><span class="p">){</span>
<span class="k">if</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">warn</span> <span class="o">!==</span> <span class="s1">'undefined'</span><span class="p">){</span>
<span class="k">if</span><span class="p">(</span><span class="nx">rule</span> <span class="o">!==</span> <span class="s1">'undefined'</span><span class="p">){</span>
<span class="nx">console</span><span class="p">.</span><span class="nx">warn</span><span class="p">(</span><span class="s1">'Invalid CSS selector "'</span> <span class="o">+</span> <span class="nx">rule</span><span class="p">.</span><span class="nx">selectorText</span> <span class="o">+</span> <span class="s1">'"'</span><span class="p">,</span> <span class="nx">err</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="kd">var</span> <span class="nx">defaultStyles</span> <span class="o">=</span> <span class="s2">""</span><span class="p">;</span>
<span class="kd">var</span> <span class="nx">embeddedStyles</span> <span class="o">=</span> <span class="s2">""</span><span class="p">;</span>
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">className</span> <span class="k">in</span> <span class="nx">classes</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">classes</span><span class="p">.</span><span class="nx">hasOwnProperty</span><span class="p">(</span><span class="nx">className</span><span class="p">)</span> <span class="o">&&</span> <span class="k">typeof</span><span class="p">(</span><span class="nx">className</span><span class="p">)</span> <span class="o">!=</span> <span class="s2">"undefined"</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">className</span> <span class="o">===</span> <span class="s1">'default'</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">classes</span><span class="p">.</span><span class="k">default</span><span class="p">.</span><span class="nx">styles</span> <span class="k">instanceof</span> <span class="nb">Array</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">defaultStyles</span> <span class="o">+=</span> <span class="s2">"#"</span> <span class="o">+</span> <span class="nx">svg</span><span class="p">.</span><span class="nx">id</span><span class="p">.</span><span class="nx">trim</span><span class="p">()</span> <span class="o">+</span> <span class="s1">' .node'</span> <span class="o">+</span> <span class="s1">' { '</span> <span class="o">+</span> <span class="nx">classes</span><span class="p">[</span><span class="nx">className</span><span class="p">].</span><span class="nx">styles</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s2">"; "</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'; }\n'</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">classes</span><span class="p">.</span><span class="k">default</span><span class="p">.</span><span class="nx">nodeLabelStyles</span> <span class="k">instanceof</span> <span class="nb">Array</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">defaultStyles</span> <span class="o">+=</span> <span class="s2">"#"</span> <span class="o">+</span> <span class="nx">svg</span><span class="p">.</span><span class="nx">id</span><span class="p">.</span><span class="nx">trim</span><span class="p">()</span> <span class="o">+</span> <span class="s1">' .node text '</span> <span class="o">+</span> <span class="s1">' { '</span> <span class="o">+</span> <span class="nx">classes</span><span class="p">[</span><span class="nx">className</span><span class="p">].</span><span class="nx">nodeLabelStyles</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s2">"; "</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'; }\n'</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">classes</span><span class="p">.</span><span class="k">default</span><span class="p">.</span><span class="nx">edgeLabelStyles</span> <span class="k">instanceof</span> <span class="nb">Array</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">defaultStyles</span> <span class="o">+=</span> <span class="s2">"#"</span> <span class="o">+</span> <span class="nx">svg</span><span class="p">.</span><span class="nx">id</span><span class="p">.</span><span class="nx">trim</span><span class="p">()</span> <span class="o">+</span> <span class="s1">' .edgeLabel text '</span> <span class="o">+</span> <span class="s1">' { '</span> <span class="o">+</span> <span class="nx">classes</span><span class="p">[</span><span class="nx">className</span><span class="p">].</span><span class="nx">edgeLabelStyles</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s2">"; "</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'; }\n'</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">classes</span><span class="p">.</span><span class="k">default</span><span class="p">.</span><span class="nx">clusterStyles</span> <span class="k">instanceof</span> <span class="nb">Array</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">defaultStyles</span> <span class="o">+=</span> <span class="s2">"#"</span> <span class="o">+</span> <span class="nx">svg</span><span class="p">.</span><span class="nx">id</span><span class="p">.</span><span class="nx">trim</span><span class="p">()</span> <span class="o">+</span> <span class="s1">' .cluster rect '</span> <span class="o">+</span> <span class="s1">' { '</span> <span class="o">+</span> <span class="nx">classes</span><span class="p">[</span><span class="nx">className</span><span class="p">].</span><span class="nx">clusterStyles</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s2">"; "</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'; }\n'</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">classes</span><span class="p">[</span><span class="nx">className</span><span class="p">].</span><span class="nx">styles</span> <span class="k">instanceof</span> <span class="nb">Array</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">embeddedStyles</span> <span class="o">+=</span> <span class="s2">"#"</span> <span class="o">+</span> <span class="nx">svg</span><span class="p">.</span><span class="nx">id</span><span class="p">.</span><span class="nx">trim</span><span class="p">()</span> <span class="o">+</span> <span class="s1">' .'</span> <span class="o">+</span> <span class="nx">className</span> <span class="o">+</span> <span class="s1">' { '</span> <span class="o">+</span> <span class="nx">classes</span><span class="p">[</span><span class="nx">className</span><span class="p">].</span><span class="nx">styles</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s2">"; "</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'; }\n'</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">usedStyles</span> <span class="o">!==</span> <span class="s2">""</span> <span class="o">||</span> <span class="nx">defaultStyles</span> <span class="o">!==</span> <span class="s2">""</span> <span class="o">||</span> <span class="nx">embeddedStyles</span> <span class="o">!==</span> <span class="s2">""</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">s</span> <span class="o">=</span> <span class="nb">document</span><span class="p">.</span><span class="nx">createElement</span><span class="p">(</span><span class="s1">'style'</span><span class="p">);</span>
<span class="nx">s</span><span class="p">.</span><span class="nx">setAttribute</span><span class="p">(</span><span class="s1">'type'</span><span class="p">,</span> <span class="s1">'text/css'</span><span class="p">);</span>
<span class="nx">s</span><span class="p">.</span><span class="nx">setAttribute</span><span class="p">(</span><span class="s1">'title'</span><span class="p">,</span> <span class="s1">'mermaid-svg-internal-css'</span><span class="p">);</span>
<span class="nx">s</span><span class="p">.</span><span class="nx">innerHTML</span> <span class="o">=</span> <span class="s2">"/* <![CDATA[ */\n"</span><span class="p">;</span>
</pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-9" id="section-9">¶</a>
</div>
<p>Make this CSS local to this SVG</p>
</td>
<td class="code highlight"><div class="highlight"><pre>
<span class="k">if</span> <span class="p">(</span><span class="nx">defaultStyles</span> <span class="o">!==</span> <span class="s2">""</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">s</span><span class="p">.</span><span class="nx">innerHTML</span> <span class="o">+=</span> <span class="nx">defaultStyles</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">usedStyles</span> <span class="o">!==</span> <span class="s2">""</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">s</span><span class="p">.</span><span class="nx">innerHTML</span> <span class="o">+=</span> <span class="nx">usedStyles</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">embeddedStyles</span> <span class="o">!==</span> <span class="s2">""</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">s</span><span class="p">.</span><span class="nx">innerHTML</span> <span class="o">+=</span> <span class="nx">embeddedStyles</span><span class="p">;</span>
<span class="p">}</span>
<span class="nx">s</span><span class="p">.</span><span class="nx">innerHTML</span> <span class="o">+=</span> <span class="s2">"/* ]]> */\n"</span><span class="p">;</span>
<span class="nx">svg</span><span class="p">.</span><span class="nx">insertBefore</span><span class="p">(</span><span class="nx">s</span><span class="p">,</span> <span class="nx">svg</span><span class="p">.</span><span class="nx">firstChild</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">};</span>
</pre></div>
</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>