aboutsummaryrefslogtreecommitdiff
path: root/doc/modules/colorizer.matcher.html
blob: 9b2b67ea68ba43e7d8532ac59b65aa91c44c3cf7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>colorizer Docs</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>colorizer</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../modules/colorizer.html">colorizer</a></li>
  <li><a href="../modules/colorizer.buffer.html">buffer</a></li>
  <li><a href="../modules/colorizer.color.html">color</a></li>
  <li><strong>matcher</strong></li>
  <li><a href="../modules/colorizer.sass.html">sass</a></li>
  <li><a href="../modules/colorizer.tailwind.html">tailwind</a></li>
  <li><a href="../modules/colorizer.trie.html">trie</a></li>
  <li><a href="../modules/utils.html">utils</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>colorizer.matcher</code></h1>
<p>Helper functions for colorizer to enable required parsers</p>
<p>

</p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#compile">compile (matchers, matchers_trie)</a></td>
	<td class="summary">Form a trie stuct with the given prefixes</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#make">make (options)</a></td>
	<td class="summary">Parse the given options and return a function with enabled parsers.</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "compile"></a>
    <strong>compile (matchers, matchers_trie)</strong>
    </dt>
    <dd>
    Form a trie stuct with the given prefixes


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">matchers</span>
         table: List of prefixes, {"rgb", "hsl"}
        </li>
        <li><span class="parameter">matchers_trie</span>
         table: Table containing information regarding non-trie based parsers
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        function: function which will just parse the line for enabled parsers
    </ol>




</dd>
    <dt>
    <a name = "make"></a>
    <strong>make (options)</strong>
    </dt>
    <dd>
    Parse the given options and return a function with enabled parsers.
if no parsers enabled then return false
Do not try make the function again if it is present in the cache


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">options</span>
         table: options created in <a href="../modules/colorizer.html#setup">colorizer.setup</a>
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        function|boolean: function which will just parse the line for enabled parsers
    </ol>




</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated - September </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>