-
Notifications
You must be signed in to change notification settings - Fork 0
/
Wombat.html
316 lines (188 loc) · 15.6 KB
/
Wombat.html
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Crystal Docs 1.13.3">
<meta name="crystal_docs.project_version" content="main">
<meta name="crystal_docs.project_name" content="wombat">
<link href="css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="js/doc.js"></script>
<meta name="repository-name" content="wombat">
<title>Wombat - wombat main</title>
<script type="text/javascript">
CrystalDocs.base_path = "";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill="currentColor" fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<input type="checkbox" id="sidebar-btn">
<label for="sidebar-btn" id="sidebar-btn-label">
<svg class="open" xmlns="http://www.w3.org/2000/svg" height="2em" width="2em" viewBox="0 0 512 512"><title>Open Sidebar</title><path fill="currentColor" d="M80 96v64h352V96H80zm0 112v64h352v-64H80zm0 112v64h352v-64H80z"></path></svg>
<svg class="close" xmlns="http://www.w3.org/2000/svg" width="2em" height="2em" viewBox="0 0 512 512"><title>Close Sidebar</title><path fill="currentColor" d="m118.6 73.4-45.2 45.2L210.7 256 73.4 393.4l45.2 45.2L256 301.3l137.4 137.3 45.2-45.2L301.3 256l137.3-137.4-45.2-45.2L256 210.7Z"></path></svg>
</label>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="project-summary">
<h1 class="project-name">
<a href="index.html">
wombat
</a>
</h1>
<span class="project-version">
main
</span>
</div>
</div>
<div class="search-results hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="wombat/Wombat" data-name="wombat">
<a href="Wombat.html">Wombat</a>
<ul>
<li class=" " data-id="wombat/Wombat/Error" data-name="wombat::error">
<a href="Wombat/Error.html">Error</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">module</span> Wombat
</h1>
<h2>
<a id="defined-in" class="anchor" href="#defined-in">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Defined in:
</h2>
<a href="https://github.com/kojix2/wombat/blob/7026d63738db9ecf28589ebdff275eb13c796e83/src/wombat.cr#L4" target="_blank">
wombat.cr
</a>
<br/>
<a href="https://github.com/kojix2/wombat/blob/7026d63738db9ecf28589ebdff275eb13c796e83/src/wombat/lib_bat.cr#L1" target="_blank">
wombat/lib_bat.cr
</a>
<br/>
<a href="https://github.com/kojix2/wombat/blob/7026d63738db9ecf28589ebdff275eb13c796e83/src/wombat/version.cr#L1" target="_blank">
wombat/version.cr
</a>
<br/>
<h2>
<a id="constant-summary" class="anchor" href="#constant-summary">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Constant Summary
</h2>
<dl>
<dt class="entry-const" id="VERSION">
<strong>VERSION</strong> = <code><span class="o">{{</span> (<span class="s">`shards version /home/runner/work/wombat/wombat/src/wombat`</span>).chomp.stringify }}</code>
</dt>
</dl>
<h2>
<a id="class-method-summary" class="anchor" href="#class-method-summary">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Class Method Summary
</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#bat_c_version%3AString-class-method" class="signature"><strong>.bat_c_version</strong> : String</a>
<div class="summary"><p>Returns the version of the bat_c</p></div>
</li>
<li class="entry-summary">
<a href="#pretty_print%28input%3AString%2Clanguage%3AString%7CNil%3Dnil%2Ctheme%3AString%7CNil%3Dnil%2Ctab_width%3AInt%3D4%2Ccolored_output%3ABool%3Dtrue%2Ctrue_color%3ABool%3Dtrue%2Cheader%3ABool%3Dfalse%2Cline_numbers%3ABool%3Dtrue%2Cgrid%3ABool%3Dtrue%2Crule%3ABool%3Dtrue%2Cshow_nonprintable%3ABool%3Dfalse%2Csnip%3ABool%3Dtrue%2Cwrapping_mode%3AInt%3D1%2Cuse_italics%3ABool%3Dtrue%2Cpaging_mode%3AInt%3D1%2Chighlight_line%3AInt%3D-1%29%3ANil-class-method" class="signature"><strong>.pretty_print</strong>(input : String, language : String | Nil = <span class="n">nil</span>, theme : String | Nil = <span class="n">nil</span>, tab_width : Int = <span class="n">4</span>, colored_output : Bool = <span class="n">true</span>, true_color : Bool = <span class="n">true</span>, header : Bool = <span class="n">false</span>, line_numbers : Bool = <span class="n">true</span>, grid : Bool = <span class="n">true</span>, rule : Bool = <span class="n">true</span>, show_nonprintable : Bool = <span class="n">false</span>, snip : Bool = <span class="n">true</span>, wrapping_mode : Int = <span class="n">1</span>, use_italics : Bool = <span class="n">true</span>, paging_mode : Int = <span class="n">1</span>, highlight_line : Int = <span class="n">-1</span>) : Nil</a>
<div class="summary"><p>Pretty print the input string</p></div>
</li>
<li class="entry-summary">
<a href="#pretty_print_file%28path%3APath%7CString%2Clanguage%3AString%7CNil%3Dnil%2Ctheme%3AString%7CNil%3Dnil%2Ctab_width%3AInt%3D4%2Ccolored_output%3ABool%3Dtrue%2Ctrue_color%3ABool%3Dtrue%2Cheader%3ABool%3Dtrue%2Cline_numbers%3ABool%3Dtrue%2Cgrid%3ABool%3Dtrue%2Crule%3ABool%3Dtrue%2Cshow_nonprintable%3ABool%3Dfalse%2Csnip%3ABool%3Dtrue%2Cwrapping_mode%3AInt%3D1%2Cuse_italics%3ABool%3Dtrue%2Cpaging_mode%3AInt%3D1%2Chighlight_line%3AInt%3D-1%29%3ANil-class-method" class="signature"><strong>.pretty_print_file</strong>(path : Path | String, language : String | Nil = <span class="n">nil</span>, theme : String | Nil = <span class="n">nil</span>, tab_width : Int = <span class="n">4</span>, colored_output : Bool = <span class="n">true</span>, true_color : Bool = <span class="n">true</span>, header : Bool = <span class="n">true</span>, line_numbers : Bool = <span class="n">true</span>, grid : Bool = <span class="n">true</span>, rule : Bool = <span class="n">true</span>, show_nonprintable : Bool = <span class="n">false</span>, snip : Bool = <span class="n">true</span>, wrapping_mode : Int = <span class="n">1</span>, use_italics : Bool = <span class="n">true</span>, paging_mode : Int = <span class="n">1</span>, highlight_line : Int = <span class="n">-1</span>) : Nil</a>
<div class="summary"><p>Pretty print the input file</p></div>
</li>
<li class="entry-summary">
<a href="#pretty_string%28input%3AString%2Clanguage%3AString%7CNil%3Dnil%2Ctheme%3AString%7CNil%3Dnil%2Ctab_width%3AInt%3D4%2Ccolored_output%3ABool%3Dtrue%2Ctrue_color%3ABool%3Dtrue%2Cheader%3ABool%3Dfalse%2Cline_numbers%3ABool%3Dtrue%2Cgrid%3ABool%3Dtrue%2Crule%3ABool%3Dtrue%2Cshow_nonprintable%3ABool%3Dfalse%2Csnip%3ABool%3Dtrue%2Cwrapping_mode%3AInt%3D1%2Cuse_italics%3ABool%3Dtrue%2Cpaging_mode%3AInt%3D2%2Chighlight_line%3AInt%3D-1%29%3AString-class-method" class="signature"><strong>.pretty_string</strong>(input : String, language : String | Nil = <span class="n">nil</span>, theme : String | Nil = <span class="n">nil</span>, tab_width : Int = <span class="n">4</span>, colored_output : Bool = <span class="n">true</span>, true_color : Bool = <span class="n">true</span>, header : Bool = <span class="n">false</span>, line_numbers : Bool = <span class="n">true</span>, grid : Bool = <span class="n">true</span>, rule : Bool = <span class="n">true</span>, show_nonprintable : Bool = <span class="n">false</span>, snip : Bool = <span class="n">true</span>, wrapping_mode : Int = <span class="n">1</span>, use_italics : Bool = <span class="n">true</span>, paging_mode : Int = <span class="n">2</span>, highlight_line : Int = <span class="n">-1</span>) : String</a>
<div class="summary"><p>Get the highlighted string of the input</p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>
<a id="class-method-detail" class="anchor" href="#class-method-detail">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Class Method Detail
</h2>
<div class="entry-detail" id="bat_c_version:String-class-method">
<div class="signature">
def self.<strong>bat_c_version</strong> : String
<a class="method-permalink" href="#bat_c_version%3AString-class-method">#</a>
</div>
<div class="doc">
<p>Returns the version of the bat_c</p>
</div>
<br/>
<div>
[<a href="https://github.com/kojix2/wombat/blob/7026d63738db9ecf28589ebdff275eb13c796e83/src/wombat.cr#L8" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="pretty_print(input:String,language:String|Nil=nil,theme:String|Nil=nil,tab_width:Int=4,colored_output:Bool=true,true_color:Bool=true,header:Bool=false,line_numbers:Bool=true,grid:Bool=true,rule:Bool=true,show_nonprintable:Bool=false,snip:Bool=true,wrapping_mode:Int=1,use_italics:Bool=true,paging_mode:Int=1,highlight_line:Int=-1):Nil-class-method">
<div class="signature">
def self.<strong>pretty_print</strong>(input : String, language : String | Nil = <span class="n">nil</span>, theme : String | Nil = <span class="n">nil</span>, tab_width : Int = <span class="n">4</span>, colored_output : Bool = <span class="n">true</span>, true_color : Bool = <span class="n">true</span>, header : Bool = <span class="n">false</span>, line_numbers : Bool = <span class="n">true</span>, grid : Bool = <span class="n">true</span>, rule : Bool = <span class="n">true</span>, show_nonprintable : Bool = <span class="n">false</span>, snip : Bool = <span class="n">true</span>, wrapping_mode : Int = <span class="n">1</span>, use_italics : Bool = <span class="n">true</span>, paging_mode : Int = <span class="n">1</span>, highlight_line : Int = <span class="n">-1</span>) : Nil
<a class="method-permalink" href="#pretty_print%28input%3AString%2Clanguage%3AString%7CNil%3Dnil%2Ctheme%3AString%7CNil%3Dnil%2Ctab_width%3AInt%3D4%2Ccolored_output%3ABool%3Dtrue%2Ctrue_color%3ABool%3Dtrue%2Cheader%3ABool%3Dfalse%2Cline_numbers%3ABool%3Dtrue%2Cgrid%3ABool%3Dtrue%2Crule%3ABool%3Dtrue%2Cshow_nonprintable%3ABool%3Dfalse%2Csnip%3ABool%3Dtrue%2Cwrapping_mode%3AInt%3D1%2Cuse_italics%3ABool%3Dtrue%2Cpaging_mode%3AInt%3D1%2Chighlight_line%3AInt%3D-1%29%3ANil-class-method">#</a>
</div>
<div class="doc">
<p>Pretty print the input string</p>
</div>
<br/>
<div>
[<a href="https://github.com/kojix2/wombat/blob/7026d63738db9ecf28589ebdff275eb13c796e83/src/wombat.cr#L13" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="pretty_print_file(path:Path|String,language:String|Nil=nil,theme:String|Nil=nil,tab_width:Int=4,colored_output:Bool=true,true_color:Bool=true,header:Bool=true,line_numbers:Bool=true,grid:Bool=true,rule:Bool=true,show_nonprintable:Bool=false,snip:Bool=true,wrapping_mode:Int=1,use_italics:Bool=true,paging_mode:Int=1,highlight_line:Int=-1):Nil-class-method">
<div class="signature">
def self.<strong>pretty_print_file</strong>(path : Path | String, language : String | Nil = <span class="n">nil</span>, theme : String | Nil = <span class="n">nil</span>, tab_width : Int = <span class="n">4</span>, colored_output : Bool = <span class="n">true</span>, true_color : Bool = <span class="n">true</span>, header : Bool = <span class="n">true</span>, line_numbers : Bool = <span class="n">true</span>, grid : Bool = <span class="n">true</span>, rule : Bool = <span class="n">true</span>, show_nonprintable : Bool = <span class="n">false</span>, snip : Bool = <span class="n">true</span>, wrapping_mode : Int = <span class="n">1</span>, use_italics : Bool = <span class="n">true</span>, paging_mode : Int = <span class="n">1</span>, highlight_line : Int = <span class="n">-1</span>) : Nil
<a class="method-permalink" href="#pretty_print_file%28path%3APath%7CString%2Clanguage%3AString%7CNil%3Dnil%2Ctheme%3AString%7CNil%3Dnil%2Ctab_width%3AInt%3D4%2Ccolored_output%3ABool%3Dtrue%2Ctrue_color%3ABool%3Dtrue%2Cheader%3ABool%3Dtrue%2Cline_numbers%3ABool%3Dtrue%2Cgrid%3ABool%3Dtrue%2Crule%3ABool%3Dtrue%2Cshow_nonprintable%3ABool%3Dfalse%2Csnip%3ABool%3Dtrue%2Cwrapping_mode%3AInt%3D1%2Cuse_italics%3ABool%3Dtrue%2Cpaging_mode%3AInt%3D1%2Chighlight_line%3AInt%3D-1%29%3ANil-class-method">#</a>
</div>
<div class="doc">
<p>Pretty print the input file</p>
</div>
<br/>
<div>
[<a href="https://github.com/kojix2/wombat/blob/7026d63738db9ecf28589ebdff275eb13c796e83/src/wombat.cr#L59" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="pretty_string(input:String,language:String|Nil=nil,theme:String|Nil=nil,tab_width:Int=4,colored_output:Bool=true,true_color:Bool=true,header:Bool=false,line_numbers:Bool=true,grid:Bool=true,rule:Bool=true,show_nonprintable:Bool=false,snip:Bool=true,wrapping_mode:Int=1,use_italics:Bool=true,paging_mode:Int=2,highlight_line:Int=-1):String-class-method">
<div class="signature">
def self.<strong>pretty_string</strong>(input : String, language : String | Nil = <span class="n">nil</span>, theme : String | Nil = <span class="n">nil</span>, tab_width : Int = <span class="n">4</span>, colored_output : Bool = <span class="n">true</span>, true_color : Bool = <span class="n">true</span>, header : Bool = <span class="n">false</span>, line_numbers : Bool = <span class="n">true</span>, grid : Bool = <span class="n">true</span>, rule : Bool = <span class="n">true</span>, show_nonprintable : Bool = <span class="n">false</span>, snip : Bool = <span class="n">true</span>, wrapping_mode : Int = <span class="n">1</span>, use_italics : Bool = <span class="n">true</span>, paging_mode : Int = <span class="n">2</span>, highlight_line : Int = <span class="n">-1</span>) : String
<a class="method-permalink" href="#pretty_string%28input%3AString%2Clanguage%3AString%7CNil%3Dnil%2Ctheme%3AString%7CNil%3Dnil%2Ctab_width%3AInt%3D4%2Ccolored_output%3ABool%3Dtrue%2Ctrue_color%3ABool%3Dtrue%2Cheader%3ABool%3Dfalse%2Cline_numbers%3ABool%3Dtrue%2Cgrid%3ABool%3Dtrue%2Crule%3ABool%3Dtrue%2Cshow_nonprintable%3ABool%3Dfalse%2Csnip%3ABool%3Dtrue%2Cwrapping_mode%3AInt%3D1%2Cuse_italics%3ABool%3Dtrue%2Cpaging_mode%3AInt%3D2%2Chighlight_line%3AInt%3D-1%29%3AString-class-method">#</a>
</div>
<div class="doc">
<p>Get the highlighted string of the input</p>
</div>
<br/>
<div>
[<a href="https://github.com/kojix2/wombat/blob/7026d63738db9ecf28589ebdff275eb13c796e83/src/wombat.cr#L105" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>