-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexplore.html
More file actions
498 lines (445 loc) · 20.7 KB
/
explore.html
File metadata and controls
498 lines (445 loc) · 20.7 KB
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.11.6" />
<title>the refinery.explore documentation</title>
<meta name="description" content="On a Mission to Refine Binaries" />
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/tomorrow-night-bright.min.css" rel="stylesheet">
<style>.flex{display:flex !important}body{background-color:#0D0D0D;color:#EEEEEE;font-size:16pt}@font-face{font-family:"FixedSysEx";src:local('Fixedsys Excelsior 3.01-L2'),local('Fixedsys Excelsior 3.01'),local('FixedSysEx'),url(FixedSysEx.ttf) format('truetype')}code,pre,body,html{font-family:FixedSysEx,monospace}b,strong{font-weight:normal}#content{padding:20px}#sidebar{padding:1vw;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #EEEEEE;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}hr{display:none}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#EE8080;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#EEEEEE}// .title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#BB4040}pre code{background:#000000;display:block;padding:1px 0px 4px 0px;line-height:100%}code{background:#000000;padding:1px 0px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#000000;border:0;border-top:1px solid #EEEEEE;border-bottom:1px solid #EEEEEE;margin:1em 0;padding:1ex;overflow-x:auto}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index ul{list-style-type:square;padding:0}// #index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 10px}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#000000;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#0D0D0D}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#EEEEEE;border-left:5px solid #EEEEEE;padding-left:1em}.inheritance em{font-style:normal}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1ch}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition.note,.admonition.info,.admonition.todo,.admonition.versionadded,.admonition.important,.admonition.tip,.admonition.hint{background:#054000}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#998800}.admonition.error,.admonition.danger,.admonition.caution{background:#300000}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:1vw}main{display:flex;flex-direction:row;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #EEEEEE;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>refinery.explore</code></h1>
</header>
<section id="section-intro">
<p>A commandline script to search for binary refinery units based on keywords.</p>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/binref/refinery/blob/a698627431774485162f65b980c1e60c206ef5a7/refinery/explore.py#L1-L203" class="git-link">Browse git</a>
</summary>
<pre><code class="python">"""
A commandline script to search for binary refinery units based on keywords.
"""
from __future__ import annotations
import argparse
import io
import re
import refinery
import refinery.units
from refinery.lib.argparser import RawDescriptionHelpFormatter
from refinery.lib.environment import environment
from refinery.lib.loader import get_all_entry_points
from refinery.lib.tools import documentation, get_terminal_size, normalize_to_display, terminalfit
from refinery.units import ArgparseError, Unit
def highlight(text: str, expression: re.Pattern[str], color: str):
"""
Uses ANSI color codes to highlight matches of the given regular `expression`
in `text`.
"""
return expression.sub(
lambda m: '\033[' + color + 'm' + m[0] + '\033[0m',
text
)
def highlight_word(text: str, word: str, color: str):
"""
Uses ANSI color codes to highlight matches of the string `word` in `text`.
"""
return highlight(text, re.compile('(?i)' + re.escape(word)), color)
def get_help_string(unit: type[Unit], brief: bool = False, width: int = 0, remove_generic: bool = False):
"""
Retrieves the help string from a given refinery unit.
"""
if brief:
return terminalfit(documentation(unit), width=width)
else:
term_size = environment.term_size.value
if width > 0:
environment.term_size.value = width
try:
argp = unit.argparser()
except ArgparseError as fail:
argp = fail.parser
else:
buffer = io.StringIO('w')
argp.print_help(buffer)
info = buffer.getvalue()
if remove_generic:
info, _, _ = info.partition('\ngeneric options:\n')
return info.strip()
finally:
if width > 0:
environment.term_size.value = term_size
def explorer(keyword_color: str = '91', unit_color: str = '93'):
"""
Main routine of the Binary Refinery Explorer.
"""
try:
import colorama
colorama.init()
except ModuleNotFoundError:
pass
headline = (
R'_________ __ __________ ______' '\n'
R'\_____ \__| ____/ ______/____/ ____/' '\n'
R' || | __/ |/ \ /__| / __ \ __/ ' '\n'
R' || | \ | | \_ _| \ ___/| | ' '\n'
R' ||____ /__|___|__/ / | \____]|__| ' '\n'
R' ======\/=========\ /==|__|==({ver})===' '\n'
R' binary refinery \/ full text search ' '\n'
).format(ver=refinery.__version__)
argp = argparse.ArgumentParser(
formatter_class=RawDescriptionHelpFormatter, description=headline)
argp.add_argument(
'keywords',
metavar='keyword',
type=lambda s: s.lower(),
nargs='*',
help='Provide keywords; if any of these keywords match the help description of '
'a unit, it will be listed.'
)
argp.add_argument(
'-o', '--or',
dest='quantifier',
action='store_const',
const=any,
default=all,
help='Any keywords may match rather than requiring all of them to match.'
)
argp.add_argument(
'-V', '--version',
action='store_true',
help='Only show the currently installed version of binary refinery and exit.'
)
argp.add_argument(
'-a', '--all',
action='store_true',
help='Search full help output (not just unit descriptions).'
)
argp.add_argument(
'-c', '--case-sensitive',
action='store_true',
help='Make the search case sensitive.'
)
argp.add_argument(
'-v', '--verbose',
action='store_true',
help='Be verbose.'
)
argp.add_argument(
'-w', '--words',
action='store_true',
help='Keywords only match if they appear as words, not as substrings.'
)
argp.add_argument(
'-x', '--no-wildcards',
dest='wildcards',
action='store_false',
help='Do not allow wildcards in search string'
)
args = argp.parse_args()
if args.version:
print(refinery.__version__)
return
width = get_terminal_size()
separator = '-' * width
result = False
def pattern(keyword):
kw = re.escape(keyword)
if args.wildcards:
kw = kw.replace(R'\*', R'\S*')
kw = kw.replace(R'\?', R'\S')
if args.words:
kw = RF'(?<!\w)(?:{kw})(?!\w)'
if not args.case_sensitive:
kw = '(?i)' + kw
if args.verbose:
print(F'-- final regex: {kw}')
return re.compile(kw)
keywords = [pattern(k) for k in args.keywords]
for unit in get_all_entry_points():
name = unit.name
if not isinstance(unit, type):
continue
if not issubclass(unit, Unit):
continue
if not issubclass(unit, refinery.units.Entry):
continue
if unit is refinery.units.Entry:
continue
info = get_help_string(unit, not args.all, width, remove_generic=True)
if info is None:
continue
if not args.quantifier(k.search(name) or k.search(info) for k in keywords):
continue
result = True
for kw in keywords:
info = highlight(info, kw, keyword_color)
name = normalize_to_display(name)
if not args.all:
header = '{e:-<4}[{}]{e:-<{w}}'.format(name, w=width - len(name) - 6, e='')
header = highlight_word(header, name, unit_color)
else:
info = highlight_word(info, name, unit_color)
header = separator
print(header, info, sep='\n')
print(separator if result else (
'No matching unit was found.'
))
if __name__ == '__main__':
explorer()</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="refinery.explore.highlight"><code class="name flex">
<span>def <span class="ident">highlight</span></span>(<span>text, expression, color)</span>
</code></dt>
<dd>
<section class="desc"><p>Uses ANSI color codes to highlight matches of the given regular <code>expression</code>
in <code>text</code>.</p></section>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/binref/refinery/blob/a698627431774485162f65b980c1e60c206ef5a7/refinery/explore.py#L20-L28" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def highlight(text: str, expression: re.Pattern[str], color: str):
"""
Uses ANSI color codes to highlight matches of the given regular `expression`
in `text`.
"""
return expression.sub(
lambda m: '\033[' + color + 'm' + m[0] + '\033[0m',
text
)</code></pre>
</details>
</dd>
<dt id="refinery.explore.highlight_word"><code class="name flex">
<span>def <span class="ident">highlight_word</span></span>(<span>text, word, color)</span>
</code></dt>
<dd>
<section class="desc"><p>Uses ANSI color codes to highlight matches of the string <code>word</code> in <code>text</code>.</p></section>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/binref/refinery/blob/a698627431774485162f65b980c1e60c206ef5a7/refinery/explore.py#L31-L35" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def highlight_word(text: str, word: str, color: str):
"""
Uses ANSI color codes to highlight matches of the string `word` in `text`.
"""
return highlight(text, re.compile('(?i)' + re.escape(word)), color)</code></pre>
</details>
</dd>
<dt id="refinery.explore.get_help_string"><code class="name flex">
<span>def <span class="ident">get_help_string</span></span>(<span>unit, brief=False, width=0, remove_generic=False)</span>
</code></dt>
<dd>
<section class="desc"><p>Retrieves the help string from a given refinery unit.</p></section>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/binref/refinery/blob/a698627431774485162f65b980c1e60c206ef5a7/refinery/explore.py#L38-L61" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def get_help_string(unit: type[Unit], brief: bool = False, width: int = 0, remove_generic: bool = False):
"""
Retrieves the help string from a given refinery unit.
"""
if brief:
return terminalfit(documentation(unit), width=width)
else:
term_size = environment.term_size.value
if width > 0:
environment.term_size.value = width
try:
argp = unit.argparser()
except ArgparseError as fail:
argp = fail.parser
else:
buffer = io.StringIO('w')
argp.print_help(buffer)
info = buffer.getvalue()
if remove_generic:
info, _, _ = info.partition('\ngeneric options:\n')
return info.strip()
finally:
if width > 0:
environment.term_size.value = term_size</code></pre>
</details>
</dd>
<dt id="refinery.explore.explorer"><code class="name flex">
<span>def <span class="ident">explorer</span></span>(<span>keyword_color='91', unit_color='93')</span>
</code></dt>
<dd>
<section class="desc"><p>Main routine of the Binary Refinery Explorer.</p></section>
<details class="source">
<summary>
<span>Expand source code</span>
<a href="https://github.com/binref/refinery/blob/a698627431774485162f65b980c1e60c206ef5a7/refinery/explore.py#L64-L199" class="git-link">Browse git</a>
</summary>
<pre><code class="python">def explorer(keyword_color: str = '91', unit_color: str = '93'):
"""
Main routine of the Binary Refinery Explorer.
"""
try:
import colorama
colorama.init()
except ModuleNotFoundError:
pass
headline = (
R'_________ __ __________ ______' '\n'
R'\_____ \__| ____/ ______/____/ ____/' '\n'
R' || | __/ |/ \ /__| / __ \ __/ ' '\n'
R' || | \ | | \_ _| \ ___/| | ' '\n'
R' ||____ /__|___|__/ / | \____]|__| ' '\n'
R' ======\/=========\ /==|__|==({ver})===' '\n'
R' binary refinery \/ full text search ' '\n'
).format(ver=refinery.__version__)
argp = argparse.ArgumentParser(
formatter_class=RawDescriptionHelpFormatter, description=headline)
argp.add_argument(
'keywords',
metavar='keyword',
type=lambda s: s.lower(),
nargs='*',
help='Provide keywords; if any of these keywords match the help description of '
'a unit, it will be listed.'
)
argp.add_argument(
'-o', '--or',
dest='quantifier',
action='store_const',
const=any,
default=all,
help='Any keywords may match rather than requiring all of them to match.'
)
argp.add_argument(
'-V', '--version',
action='store_true',
help='Only show the currently installed version of binary refinery and exit.'
)
argp.add_argument(
'-a', '--all',
action='store_true',
help='Search full help output (not just unit descriptions).'
)
argp.add_argument(
'-c', '--case-sensitive',
action='store_true',
help='Make the search case sensitive.'
)
argp.add_argument(
'-v', '--verbose',
action='store_true',
help='Be verbose.'
)
argp.add_argument(
'-w', '--words',
action='store_true',
help='Keywords only match if they appear as words, not as substrings.'
)
argp.add_argument(
'-x', '--no-wildcards',
dest='wildcards',
action='store_false',
help='Do not allow wildcards in search string'
)
args = argp.parse_args()
if args.version:
print(refinery.__version__)
return
width = get_terminal_size()
separator = '-' * width
result = False
def pattern(keyword):
kw = re.escape(keyword)
if args.wildcards:
kw = kw.replace(R'\*', R'\S*')
kw = kw.replace(R'\?', R'\S')
if args.words:
kw = RF'(?<!\w)(?:{kw})(?!\w)'
if not args.case_sensitive:
kw = '(?i)' + kw
if args.verbose:
print(F'-- final regex: {kw}')
return re.compile(kw)
keywords = [pattern(k) for k in args.keywords]
for unit in get_all_entry_points():
name = unit.name
if not isinstance(unit, type):
continue
if not issubclass(unit, Unit):
continue
if not issubclass(unit, refinery.units.Entry):
continue
if unit is refinery.units.Entry:
continue
info = get_help_string(unit, not args.all, width, remove_generic=True)
if info is None:
continue
if not args.quantifier(k.search(name) or k.search(info) for k in keywords):
continue
result = True
for kw in keywords:
info = highlight(info, kw, keyword_color)
name = normalize_to_display(name)
if not args.all:
header = '{e:-<4}[{}]{e:-<{w}}'.format(name, w=width - len(name) - 6, e='')
header = highlight_word(header, name, unit_color)
else:
info = highlight_word(info, name, unit_color)
header = separator
print(header, info, sep='\n')
print(separator if result else (
'No matching unit was found.'
))</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="refinery" href="index.html">refinery</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="refinery.explore.highlight" href="#refinery.explore.highlight">highlight</a></code></li>
<li><code><a title="refinery.explore.highlight_word" href="#refinery.explore.highlight_word">highlight_word</a></code></li>
<li><code><a title="refinery.explore.get_help_string" href="#refinery.explore.get_help_string">get_help_string</a></code></li>
<li><code><a title="refinery.explore.explorer" href="#refinery.explore.explorer">explorer</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.11.6</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>
hljs.configure({languages: []})
hljs.initHighlightingOnLoad()
</script>
</body>
</html>