File: internals.html

package info (click to toggle)
eggdrop 1.10.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,596 kB
  • sloc: ansic: 65,863; javascript: 8,908; sh: 5,337; tcl: 3,801; makefile: 1,771; python: 121
file content (462 lines) | stat: -rw-r--r-- 51,158 bytes parent folder | download
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
<!DOCTYPE html>

<html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>Eggdrop Bind Internals &#8212; Eggdrop 1.10.1rc2 documentation</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
    <link rel="stylesheet" type="text/css" href="../_static/eggdrop.css?v=ab48a1b6" />
    <script src="../_static/documentation_options.js?v=290de6c6"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="About Eggdrop" href="../about/about.html" />
    <link rel="prev" title="How to Write an Eggdrop Module" href="writing.html" /> 
  </head><body>
    <div class="header-wrapper" role="banner">
      <div class="header">
        <div class="headertitle"><a
          href="../index.html">Eggdrop 1.10.1rc2 documentation</a></div>
        <div class="rel" role="navigation" aria-label="related navigation">
          <a href="writing.html" title="How to Write an Eggdrop Module"
             accesskey="P">previous</a> |
          <a href="../about/about.html" title="About Eggdrop"
             accesskey="N">next</a>
        </div>
       </div>
    </div>

    <div class="content-wrapper">
      <div class="content">
        <div class="sidebar">
          
          <h3>Table of Contents</h3>
          <p class="caption" role="heading"><span class="caption-text">Installing Eggdrop</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../install/readme.html">README</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install/install.html">Installing Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install/upgrading.html">Upgrading Eggdrop</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Using Eggdrop</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../using/features.html">Eggdrop Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/core.html">Eggdrop Core Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/partyline.html">The Party Line</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/autoscripts.html">Eggdrop Autoscripts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/users.html">Users and Flags</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/bans.html">Bans, Invites, and Exempts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/botnet.html">Botnet Sharing and Linking</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/ipv6.html">IPv6 support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/tls.html">TLS support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/ircv3.html">IRCv3 support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/accounts.html">Account tracking in Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/pbkdf2info.html">Encryption/Hashing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/python.html">Using the Python Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/twitchinfo.html">Twitch</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/tricks.html">Advanced Tips</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/text-sub.html">Textfile Substitutions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/tcl-commands.html">Eggdrop Tcl Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/twitch-tcl-commands.html">Eggdrop Twitch Tcl Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using/patch.html">Patching Eggdrop</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/setup.html">Setting Up Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/firststeps.html">Common First Steps</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/tlssetup.html">Enabling TLS Security on Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/userfilesharing.html">Sharing Userfiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/firstscript.html">Writing an Eggdrop Tcl Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/module.html">Writing a Basic Eggdrop Module</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Eggdrop Modules</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Eggdrop Module Information</a></li>
<li class="toctree-l1"><a class="reference internal" href="included.html">Modules included with Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing.html">How to Write an Eggdrop Module</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Eggdrop Bind Internals</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#general-workflow-to-create-a-new-bind">General Workflow To Create a New Bind</a></li>
<li class="toctree-l2"><a class="reference internal" href="#adding-a-new-bind-type-to-the-bind-table">Adding a New Bind Type to the Bind Table</a></li>
<li class="toctree-l2"><a class="reference internal" href="#adding-bind-functionality">Adding Bind Functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="#using-the-bind-in-tcl">Using the Bind in Tcl</a></li>
<li class="toctree-l2"><a class="reference internal" href="#triggering-any-bind">Triggering any Bind</a></li>
<li class="toctree-l2"><a class="reference internal" href="#c-binding">C Binding</a></li>
<li class="toctree-l2"><a class="reference internal" href="#c-handler">C Handler</a></li>
<li class="toctree-l2"><a class="reference internal" href="#summary">Summary</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">About Eggdrop</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../about/about.html">About Eggdrop</a></li>
<li class="toctree-l1"><a class="reference internal" href="../about/legal.html">Boring legal stuff</a></li>
</ul>

          <div role="search">
            <h3 style="margin-top: 1.5em;">Search</h3>
            <form class="search" action="../search.html" method="get">
                <input type="text" name="q" />
                <input type="submit" value="Go" />
            </form>
          </div>

        </div>
        <div class="document">
            
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <section id="eggdrop-bind-internals">
<h1>Eggdrop Bind Internals<a class="headerlink" href="#eggdrop-bind-internals" title="Link to this heading">¶</a></h1>
<p>This document is intended for C developers who want to understand how Eggdrop’s Tcl binds or C binds work.</p>
<p>For documentation purposes the “dcc” bind type is used as an example.</p>
<p>It already exists and is suitable to illustrate the details of bind handling in Eggdrop.</p>
<p>Note: All code snippets are altered for brevity and simplicity, see original source code for the full and current versions.</p>
<section id="general-workflow-to-create-a-new-bind">
<h2>General Workflow To Create a New Bind<a class="headerlink" href="#general-workflow-to-create-a-new-bind" title="Link to this heading">¶</a></h2>
<p>To create a new type of bind, there are generally three steps. First, you must add the new bind type to the <a class="reference internal" href="#bind-table">Bind Table</a>. Once you have registered the bind type with the bind table, you must create a <a class="reference internal" href="#c-function">C Function</a> that will be called to perform the functionality you wish to occur when the bind is triggered. Finally, once the C code supporting the new bind has been finished, the new Tcl binding is ready to be used in a Tcl script.</p>
</section>
<section id="adding-a-new-bind-type-to-the-bind-table">
<span id="bind-table"></span><h2>Adding a New Bind Type to the Bind Table<a class="headerlink" href="#adding-a-new-bind-type-to-the-bind-table" title="Link to this heading">¶</a></h2>
<p>The bind is added to the bind table is by calling, either at module initialization or startup</p>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cm">/* Global symbol, available to other C files with</span>
<span class="cm"> * extern p_tcl_bind_list H_dcc;</span>
<span class="cm"> */</span>
<span class="n">p_tcl_bind_list</span><span class="w"> </span><span class="n">H_dcc</span><span class="p">;</span>

<span class="cm">/* Creating the bind table:</span>
<span class="cm"> * @param[in] const char *name Limited in length, see tclhash.h</span>
<span class="cm"> * @param[in] int flags        HT_STACKABLE or 0</span>
<span class="cm"> * @param[in] IntFunc          Function pointer to C handler</span>
<span class="cm"> * @return    p_tcl_bind_list  aka (tcl_bind_list_t *)</span>
<span class="cm"> */</span>
<span class="n">H_dcc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">add_bind_table</span><span class="p">(</span><span class="s">&quot;dcc&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="n">builtin_dcc</span><span class="p">);</span>
</pre></div>
</div>
<p>What the <code class="code docutils literal notranslate"><span class="pre">C</span> <span class="pre">handler</span></code> does is explained later, because a lot happens before it is actually called. <code class="code docutils literal notranslate"><span class="pre">IntFunc</span></code> is a generic function pointer that returns an <code class="code docutils literal notranslate"><span class="pre">int</span></code> with arbitrary arguments.</p>
<p><code class="code docutils literal notranslate"><span class="pre">H_dcc</span></code> can be exported from core and imported into modules as any other variable or function. That should be explained in a separate document.</p>
<section id="stackable-binds-ht-stackable">
<span id="ht-stackable"></span><h3>Stackable Binds: HT_STACKABLE<a class="headerlink" href="#stackable-binds-ht-stackable" title="Link to this heading">¶</a></h3>
<p><code class="code docutils literal notranslate"><span class="pre">HT_STACKABLE</span></code> means that multiple binds can exist for the same mask. An example of what happens when NOT using this flag shown in the code block below.</p>
<div class="highlight-Tcl notranslate"><div class="highlight"><pre><span></span><span class="nv">bind</span><span class="w"> </span>dcc<span class="w"> </span><span class="o">-</span><span class="w"> </span>test<span class="w"> </span>proc1<span class="k">;</span><span class="w"> </span><span class="c"># not stackable</span>
<span class="nv">bind</span><span class="w"> </span>dcc<span class="w"> </span><span class="o">-</span><span class="w"> </span>test<span class="w"> </span>proc2<span class="k">;</span><span class="w"> </span><span class="c"># overwrites the first one, only proc2 will be called</span>
</pre></div>
</div>
<p>To enable this feature, you must set the second argument to <code class="docutils literal notranslate"><span class="pre">add_bind_table()</span></code> with <code class="docutils literal notranslate"><span class="pre">HT_STACKABLE</span></code>. Using <code class="docutils literal notranslate"><span class="pre">HT_STACKABLE</span></code> does not automatically call all the binds that match, see the bind flags listed in <a class="reference internal" href="#id1">Triggering any Bind</a> section for details on the partner flags <code class="docutils literal notranslate"><span class="pre">BIND_STACKABLE</span></code> and <code class="docutils literal notranslate"><span class="pre">BIND_WANTRET</span></code> used in <code class="docutils literal notranslate"><span class="pre">check_tcl_bind()</span></code>.</p>
</section>
</section>
<section id="adding-bind-functionality">
<span id="c-function"></span><h2>Adding Bind Functionality<a class="headerlink" href="#adding-bind-functionality" title="Link to this heading">¶</a></h2>
<p>A C function must created that will be called when the bind is triggered. Importantly, the function is designed to accept specific arguments passed by Tcl.</p>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="kt">int</span><span class="w"> </span><span class="nf">check_tcl_dcc</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">cmd</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">idx</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">args</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w">  </span><span class="k">struct</span><span class="w"> </span><span class="nc">flag_record</span><span class="w"> </span><span class="n">fr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">FR_GLOBAL</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">FR_CHAN</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="p">};</span>
<span class="w">  </span><span class="kt">int</span><span class="w"> </span><span class="n">x</span><span class="p">;</span>
<span class="w">  </span><span class="kt">char</span><span class="w"> </span><span class="n">s</span><span class="p">[</span><span class="mi">11</span><span class="p">];</span>

<span class="w">  </span><span class="n">get_user_flagrec</span><span class="p">(</span><span class="n">dcc</span><span class="p">[</span><span class="n">idx</span><span class="p">].</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="n">fr</span><span class="p">,</span><span class="w"> </span><span class="n">dcc</span><span class="p">[</span><span class="n">idx</span><span class="p">].</span><span class="n">u</span><span class="p">.</span><span class="n">chat</span><span class="o">-&gt;</span><span class="n">con_chan</span><span class="p">);</span>
<span class="w">  </span><span class="n">egg_snprintf</span><span class="p">(</span><span class="n">s</span><span class="p">,</span><span class="w"> </span><span class="k">sizeof</span><span class="w"> </span><span class="n">s</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;%ld&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">dcc</span><span class="p">[</span><span class="n">idx</span><span class="p">].</span><span class="n">sock</span><span class="p">);</span>
<span class="w">  </span><span class="n">Tcl_SetVar</span><span class="p">(</span><span class="n">interp</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;_dcc1&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="p">)</span><span class="w"> </span><span class="n">dcc</span><span class="p">[</span><span class="n">idx</span><span class="p">].</span><span class="n">nick</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">);</span>
<span class="w">  </span><span class="n">Tcl_SetVar</span><span class="p">(</span><span class="n">interp</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;_dcc2&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="p">)</span><span class="w"> </span><span class="n">s</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">);</span>
<span class="w">  </span><span class="n">Tcl_SetVar</span><span class="p">(</span><span class="n">interp</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;_dcc3&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="p">)</span><span class="w"> </span><span class="n">args</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">);</span>
<span class="w">  </span><span class="n">x</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">check_tcl_bind</span><span class="p">(</span><span class="n">H_dcc</span><span class="p">,</span><span class="w"> </span><span class="n">cmd</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="n">fr</span><span class="p">,</span><span class="w"> </span><span class="s">&quot; $_dcc1 $_dcc2 $_dcc3&quot;</span><span class="p">,</span>
<span class="w">                  </span><span class="n">MATCH_PARTIAL</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">BIND_USE_ATTR</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">BIND_HAS_BUILTINS</span><span class="p">);</span>
<span class="w">  </span><span class="cm">/* snip ..., return code handling */</span>
<span class="w">  </span><span class="k">return</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The global Tcl variables <code class="code docutils literal notranslate"><span class="pre">$_dcc1</span> <span class="pre">$_dcc2</span> <span class="pre">$_dcc3</span></code> are used as temporary string variables and passed as arguments to the registered Tcl proc.</p>
<p>This shows which arguments the callbacks in Tcl get:</p>
<ul class="simple">
<li><p>the nickname of the DCC chat user (handle of the user)</p></li>
<li><p>the IDX (socket id) of the partyline so <code class="code docutils literal notranslate"><span class="pre">[putdcc]</span></code> can respond back</p></li>
<li><p>another string argument that depends on the caller</p></li>
</ul>
<p>The call to <code class="code docutils literal notranslate"><span class="pre">check_tcl_dcc</span></code> can be found in the DCC parsing in <cite>src/dcc.c</cite>.</p>
</section>
<section id="using-the-bind-in-tcl">
<h2>Using the Bind in Tcl<a class="headerlink" href="#using-the-bind-in-tcl" title="Link to this heading">¶</a></h2>
<p>After the bind table is created with <code class="code docutils literal notranslate"><span class="pre">add_bind_table</span></code>, Tcl procs can already be registered to this bind by calling</p>
<div class="highlight-Tcl notranslate"><div class="highlight"><pre><span></span><span class="nv">bind</span><span class="w"> </span>dcc<span class="w"> </span><span class="o">-|-</span><span class="w"> </span>test<span class="w"> </span>myproc
<span class="k">proc</span><span class="w"> </span>myproc<span class="w"> </span><span class="k">{</span><span class="nv">args</span><span class="k">}</span><span class="w"> </span><span class="k">{</span>
<span class="w">  </span><span class="nv">putlog</span><span class="w"> </span><span class="s2">&quot;myproc was called, argument list: &#39;[join $args &#39;,&#39;]&#39;&quot;</span>
<span class="w">  </span><span class="k">return</span><span class="w"> </span><span class="mi">0</span>
<span class="k">}</span>
</pre></div>
</div>
<p>Of course it is not clear so far:</p>
<ul class="simple">
<li><p>If flags <code class="code docutils literal notranslate"><span class="pre">-|-</span></code> matter for this bind at all and what they are checked against</p></li>
<li><p>If channel flags have a meaning or global/bot only</p></li>
<li><p>What <code class="code docutils literal notranslate"><span class="pre">test</span></code> is matched against to see if the bind should trigger</p></li>
<li><p>Which arguments <code class="code docutils literal notranslate"><span class="pre">myproc</span></code> receives, the example just accepts all arguments</p></li>
</ul>
</section>
<section id="triggering-any-bind">
<span id="id1"></span><h2>Triggering any Bind<a class="headerlink" href="#triggering-any-bind" title="Link to this heading">¶</a></h2>
<p><cite>check_tcl_bind</cite> is used by all binds and does the following</p>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cm">/* Generic function to call one/all matching binds</span>
<span class="cm"> * @param[in] tcl_bind_list_t *tl      Bind table (e.g. H_dcc)</span>
<span class="cm"> * @param[in] const char *match        String to match the bind-masks against</span>
<span class="cm"> * @param[in] struct flag_record *atr  Flags of the user calling the bind</span>
<span class="cm"> * @param[in] const char *param        Arguments to add to the bind callback proc (e.g. &quot; $_dcc1 $_dcc2 $_dcc3&quot;)</span>
<span class="cm"> * @param[in] int match_type           Matchtype and various flags</span>
<span class="cm"> * @returns   int                      Match result code</span>
<span class="cm"> */</span>

<span class="cm">/* Source code changed, only illustrative */</span>
<span class="kt">int</span><span class="w"> </span><span class="nf">check_tcl_bind</span><span class="p">(</span><span class="n">tcl_bind_list_t</span><span class="w"> </span><span class="o">*</span><span class="n">tl</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">match</span><span class="p">,</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">flag_record</span><span class="w"> </span><span class="o">*</span><span class="n">atr</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">param</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">match_type</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w">  </span><span class="kt">int</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">BIND_NOMATCH</span><span class="p">;</span>
<span class="w">  </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="n">tm</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tl</span><span class="o">-&gt;</span><span class="n">first</span><span class="p">;</span><span class="w"> </span><span class="n">tm</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="o">!</span><span class="n">finish</span><span class="p">;</span><span class="w"> </span><span class="n">tm_last</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tm</span><span class="p">,</span><span class="w"> </span><span class="n">tm</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tm</span><span class="o">-&gt;</span><span class="n">next</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w">    </span><span class="cm">/* Check if bind mask matches */</span>
<span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="n">check_bind_match</span><span class="p">(</span><span class="n">match</span><span class="p">,</span><span class="w"> </span><span class="n">tm</span><span class="o">-&gt;</span><span class="n">mask</span><span class="p">,</span><span class="w"> </span><span class="n">match_type</span><span class="p">))</span>
<span class="w">      </span><span class="k">continue</span><span class="p">;</span>
<span class="w">    </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="n">tc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tm</span><span class="o">-&gt;</span><span class="n">first</span><span class="p">;</span><span class="w"> </span><span class="n">tc</span><span class="p">;</span><span class="w"> </span><span class="n">tc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tc</span><span class="o">-&gt;</span><span class="n">next</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w">      </span><span class="cm">/* Check if the provided flags suffice for this command. */</span>
<span class="w">      </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">check_bind_flags</span><span class="p">(</span><span class="o">&amp;</span><span class="n">tc</span><span class="o">-&gt;</span><span class="n">flags</span><span class="p">,</span><span class="w"> </span><span class="n">atr</span><span class="p">,</span><span class="w"> </span><span class="n">match_type</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>
<span class="w">        </span><span class="n">tc</span><span class="o">-&gt;</span><span class="n">hits</span><span class="o">++</span><span class="p">;</span>
<span class="w">        </span><span class="cm">/* not much more than Tcl_Eval(interp, &quot;&lt;procname&gt; &lt;arguments&gt;&quot;); and grab the result */</span>
<span class="w">        </span><span class="n">x</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">trigger_bind</span><span class="p">(</span><span class="n">tc</span><span class="o">-&gt;</span><span class="n">func_name</span><span class="p">,</span><span class="w"> </span><span class="n">param</span><span class="p">,</span><span class="w"> </span><span class="n">tm</span><span class="o">-&gt;</span><span class="n">mask</span><span class="p">);</span>
<span class="w">      </span><span class="p">}</span>
<span class="w">    </span><span class="p">}</span>
<span class="w">  </span><span class="p">}</span>
<span class="w">  </span><span class="k">return</span><span class="w"> </span><span class="n">x</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<section id="bind-flags">
<h3>Bind Flags<a class="headerlink" href="#bind-flags" title="Link to this heading">¶</a></h3>
<p>The last argument to <code class="code docutils literal notranslate"><span class="pre">check_tcl_bind</span></code> in <cite>check_tcl_dcc</cite> sets additional configurations for the bind. These are the allowed defined values:</p>
<table class="docutils align-default">
<tbody>
<tr class="row-odd"><td><p><strong>Value</strong></p></td>
<td><p><strong>Description</strong></p></td>
</tr>
<tr class="row-even"><td><p>MATCH_PARTIAL</p></td>
<td><p>Check the triggering value against the beginning of the bind mask, ie DIR triggers a mask for DIRECTORY (case insensitive)</p></td>
</tr>
<tr class="row-odd"><td><p>MATCH_EXACT</p></td>
<td><p>Check the triggering value exactly against the bind mask value (case insensitive)</p></td>
</tr>
<tr class="row-even"><td><p>MATCH_CASE</p></td>
<td><p>Check the triggering value exactly against the bind mask value (case sensitive)</p></td>
</tr>
<tr class="row-odd"><td><p>MATCH_MASK</p></td>
<td><p>Check if the bind mask is matched against the triggering value as a wildcarded value</p></td>
</tr>
<tr class="row-even"><td><p>MATCH_MODE</p></td>
<td><p>Special mode for <cite>bind mode</cite> similar to <cite>MATCH_MASK</cite>. This uses case-insensitive matching before the first space in the mask,
(the channel), and then case sensitive after the first space (the modes)</p></td>
</tr>
<tr class="row-odd"><td><p>MATCH_CRON</p></td>
<td><p>Check the triggering value against a bind mask formatted as a cron entry, ie “30 7 6 7 5 “ triggers a mask for “30 7 * * * “</p></td>
</tr>
<tr class="row-even"><td><p>BIND_USE_ATTR</p></td>
<td><p>Check the flags of the user match the flags required to trigger the bind</p></td>
</tr>
<tr class="row-odd"><td><p>BIND_STACKABLE</p></td>
<td><p>Allow one mask to be re-used to call multiple Tcl proc. Must be used with <a class="reference internal" href="#ht-stackable">HT_STACKABLE</a></p></td>
</tr>
<tr class="row-even"><td><p>BIND_WANTRET</p></td>
<td><p>With stacked binds, if the called Tcl proc called returns a ‘1’, halt processing any further binds triggered by the action</p></td>
</tr>
<tr class="row-odd"><td><p>BIND_STACKRET</p></td>
<td><p>Used with BIND_WANTRET; allow stacked binds to continue despite receiving a ‘1’</p></td>
</tr>
</tbody>
</table>
</section>
<section id="bind-return-values">
<h3>Bind Return Values<a class="headerlink" href="#bind-return-values" title="Link to this heading">¶</a></h3>
<p>The value returned by the bind is often matched against a desired value to return a ‘1’ (often used with BIND_WANTRET and BIND_STACKRET) to the calling function.</p>
<table class="docutils align-default">
<tbody>
<tr class="row-odd"><td><p><strong>Value</strong></p></td>
<td><p><strong>Description</strong></p></td>
</tr>
<tr class="row-even"><td><p>BIND_NOMATCH</p></td>
<td><p>The bind was not triggered due to not meeting the criteria set for the bind</p></td>
</tr>
<tr class="row-odd"><td><p>BIND_AMBIGUOUS</p></td>
<td><p>The triggering action matched multiple non-stackable binds</p></td>
</tr>
<tr class="row-even"><td><p>BIND_MATCHED</p></td>
<td><p>The bind criteria was met, but the Tcl proc it tried to call could not be found</p></td>
</tr>
<tr class="row-odd"><td><p>BIND_EXECUTED</p></td>
<td><p>The bind criteria was met and the Tcl proc was called</p></td>
</tr>
<tr class="row-even"><td><p>BIND_EXEC_LOG</p></td>
<td><p>The bind criteria was met, the Tcl proc was called, and Eggdrop logged the bind being called</p></td>
</tr>
<tr class="row-odd"><td><p>BIND_QUIT</p></td>
<td><p>Sentinel value to signal that quit was triggered by the target leaving the partyline or filesys area.
(Virtual bind to CMD_LEAVE)</p></td>
</tr>
</tbody>
</table>
<p>Note: For a bind type to be stackable it needs to be registered with <code class="code docutils literal notranslate"><span class="pre">HT_STACKABLE</span></code> AND <code class="code docutils literal notranslate"><span class="pre">check_tcl_bind</span></code> must be called with <code class="code docutils literal notranslate"><span class="pre">BIND_STACKABLE</span></code>.</p>
</section>
</section>
<section id="c-binding">
<h2>C Binding<a class="headerlink" href="#c-binding" title="Link to this heading">¶</a></h2>
<p>To create a C function that is called by the bind, Eggdrop provides the <code class="code docutils literal notranslate"><span class="pre">add_builtins</span></code> function.</p>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cm">/* Add a list of C function callbacks to a bind</span>
<span class="cm"> * @param[in] tcl_bind_list_t *  the bind type (e.g. H_dcc)</span>
<span class="cm"> * @param[in] cmd_t *            a NULL-terminated table of binds:</span>
<span class="cm"> * cmd_t *mycmds = {</span>
<span class="cm"> *   {char *name, char *flags, IntFunc function, char *tcl_name},</span>
<span class="cm"> *   ...,</span>
<span class="cm"> *   {NULL, NULL, NULL, NULL}</span>
<span class="cm"> * };</span>
<span class="cm"> */</span>
<span class="kt">void</span><span class="w"> </span><span class="nf">add_builtins</span><span class="p">(</span><span class="n">tcl_bind_list_t</span><span class="w"> </span><span class="o">*</span><span class="n">tl</span><span class="p">,</span><span class="w"> </span><span class="n">cmd_t</span><span class="w"> </span><span class="o">*</span><span class="n">cc</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w">  </span><span class="kt">char</span><span class="w"> </span><span class="n">p</span><span class="p">[</span><span class="mi">1024</span><span class="p">];</span>
<span class="w">  </span><span class="n">cd_tcl_cmd</span><span class="w"> </span><span class="n">tclcmd</span><span class="p">;</span>

<span class="w">  </span><span class="n">tclcmd</span><span class="p">.</span><span class="n">name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">p</span><span class="p">;</span>
<span class="w">  </span><span class="n">tclcmd</span><span class="p">.</span><span class="n">callback</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tl</span><span class="o">-&gt;</span><span class="n">func</span><span class="p">;</span>
<span class="w">  </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="n">i</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span><span class="w"> </span><span class="n">cc</span><span class="p">[</span><span class="n">i</span><span class="p">].</span><span class="n">name</span><span class="p">;</span><span class="w"> </span><span class="n">i</span><span class="o">++</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w">    </span><span class="cm">/* Create Tcl command with automatic or given names *&lt;bindtype&gt;:&lt;funcname&gt;, e.g.</span>
<span class="cm">     * - H_raw {&quot;324&quot;, &quot;&quot;, got324, &quot;irc:324&quot;} =&gt; *raw:irc:324</span>
<span class="cm">     * - H_dcc {&quot;boot&quot;, &quot;t&quot;, cmd_boot, NULL} =&gt; *dcc:boot</span>
<span class="cm">     */</span>
<span class="w">    </span><span class="n">egg_snprintf</span><span class="p">(</span><span class="n">p</span><span class="p">,</span><span class="w"> </span><span class="k">sizeof</span><span class="w"> </span><span class="n">p</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;*%s:%s&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">tl</span><span class="o">-&gt;</span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">cc</span><span class="p">[</span><span class="n">i</span><span class="p">].</span><span class="n">funcname</span><span class="w"> </span><span class="o">?</span><span class="w"> </span><span class="n">cc</span><span class="p">[</span><span class="n">i</span><span class="p">].</span><span class="n">funcname</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="n">cc</span><span class="p">[</span><span class="n">i</span><span class="p">].</span><span class="n">name</span><span class="p">);</span>
<span class="w">    </span><span class="cm">/* arbitrary void * can be included, we include C function pointer */</span>
<span class="w">    </span><span class="n">tclcmd</span><span class="p">.</span><span class="n">cdata</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="kt">void</span><span class="w"> </span><span class="o">*</span><span class="p">)</span><span class="w"> </span><span class="n">cc</span><span class="p">[</span><span class="n">i</span><span class="p">].</span><span class="n">func</span><span class="p">;</span>
<span class="w">    </span><span class="n">add_cd_tcl_cmd</span><span class="p">(</span><span class="n">tclcmd</span><span class="p">);</span>
<span class="w">    </span><span class="n">bind_bind_entry</span><span class="p">(</span><span class="n">tl</span><span class="p">,</span><span class="w"> </span><span class="n">cc</span><span class="p">[</span><span class="n">i</span><span class="p">].</span><span class="n">flags</span><span class="p">,</span><span class="w"> </span><span class="n">cc</span><span class="p">[</span><span class="n">i</span><span class="p">].</span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">p</span><span class="p">);</span>
<span class="w">  </span><span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>It automatically creates Tcl commands (e.g. <code class="code docutils literal notranslate"><span class="pre">*dcc:cmd_boot</span></code>) that will call the <cite>C handler</cite> from <cite>add_bind_table</cite> in the first section <a class="reference internal" href="#bind-table">Bind Table</a> and it gets a context (void *) argument with the C function it is supposed to call (e.g. <cite>cmd_boot()</cite>).</p>
<p>Now we can actually look at the C function handler for dcc as an example and what it has to implement.</p>
</section>
<section id="c-handler">
<h2>C Handler<a class="headerlink" href="#c-handler" title="Link to this heading">¶</a></h2>
<p>The example handler for DCC looks as follows</p>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cm">/* Typical Tcl_Command arguments, just like e.g. tcl_putdcc is a Tcl/C command for [putdcc] */</span>
<span class="k">static</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="nf">builtin_dcc</span><span class="w"> </span><span class="p">(</span><span class="n">ClientData</span><span class="w"> </span><span class="n">cd</span><span class="p">,</span><span class="w"> </span><span class="n">Tcl_Interp</span><span class="w"> </span><span class="o">*</span><span class="n">irp</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">argc</span><span class="p">,</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">argv</span><span class="p">[])</span><span class="w"> </span><span class="p">{</span>
<span class="w">  </span><span class="kt">int</span><span class="w"> </span><span class="n">idx</span><span class="p">;</span>
<span class="w">  </span><span class="cm">/* F: The C function we want to call, if the bind is okay, e.g. cmd_boot() */</span>
<span class="w">  </span><span class="n">Function</span><span class="w"> </span><span class="n">F</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">Function</span><span class="p">)</span><span class="w"> </span><span class="n">cd</span><span class="p">;</span>

<span class="w">  </span><span class="cm">/* Task of C function: verify argument count and syntax as any Tcl command */</span>
<span class="w">  </span><span class="n">BADARGS</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w"> </span><span class="s">&quot; hand idx param&quot;</span><span class="p">);</span>

<span class="w">  </span><span class="cm">/* C Macro only used in C handlers for bind types, sanity checks the Tcl proc name</span>
<span class="cm">   * for *&lt;bindtype&gt;:&lt;name&gt; and that we are in the right C handler</span>
<span class="cm">   */</span>
<span class="w">  </span><span class="n">CHECKVALIDITY</span><span class="p">(</span><span class="n">builtin_dcc</span><span class="p">);</span>

<span class="w">  </span><span class="n">idx</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">findidx</span><span class="p">(</span><span class="n">atoi</span><span class="p">(</span><span class="n">argv</span><span class="p">[</span><span class="mi">2</span><span class="p">]));</span>
<span class="w">  </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">idx</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="mi">0</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w">      </span><span class="n">Tcl_AppendResult</span><span class="p">(</span><span class="n">irp</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;invalid idx&quot;</span><span class="p">,</span><span class="w"> </span><span class="nb">NULL</span><span class="p">);</span>
<span class="w">      </span><span class="k">return</span><span class="w"> </span><span class="n">TCL_ERROR</span><span class="p">;</span>
<span class="w">  </span><span class="p">}</span>

<span class="w">  </span><span class="cm">/* Call the desired C function, e.g. cmd_boot() with their arguments */</span>
<span class="w">  </span><span class="n">F</span><span class="p">(</span><span class="n">dcc</span><span class="p">[</span><span class="n">idx</span><span class="p">].</span><span class="n">user</span><span class="p">,</span><span class="w"> </span><span class="n">idx</span><span class="p">,</span><span class="w"> </span><span class="n">argv</span><span class="p">[</span><span class="mi">3</span><span class="p">]);</span>
<span class="w">  </span><span class="n">Tcl_ResetResult</span><span class="p">(</span><span class="n">irp</span><span class="p">);</span>
<span class="w">  </span><span class="n">Tcl_AppendResult</span><span class="p">(</span><span class="n">irp</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;0&quot;</span><span class="p">,</span><span class="w"> </span><span class="nb">NULL</span><span class="p">);</span>
<span class="w">  </span><span class="k">return</span><span class="w"> </span><span class="n">TCL_OK</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<p>This is finally the part where we see the arguments a C function gets for a DCC bind as opposed to a Tcl proc.</p>
<p><code class="code docutils literal notranslate"><span class="pre">F(dcc[idx].user,</span> <span class="pre">idx,</span> <span class="pre">argv[3])</span></code>:</p>
<ul class="simple">
<li><p>User information as struct userrec *</p></li>
<li><p>IDX as int</p></li>
<li><p>The 3rd string argument from the Tcl call to *dcc:cmd_boot, which was <code class="code docutils literal notranslate"><span class="pre">$_dcc3</span></code> which was <code class="code docutils literal notranslate"><span class="pre">args</span></code> to <code class="code docutils literal notranslate"><span class="pre">check_tcl_dcc</span></code> which was everything after the dcc command</p></li>
</ul>
<p>So this is how we register C callbacks for binds with the correct arguments</p>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cm">/* We know the return value is ignored because the return value of F</span>
<span class="cm"> * in builtin_dcc is ignored, so it can be void, but for other binds</span>
<span class="cm"> * it could be something else and used in the C handler for the bind.</span>
<span class="cm"> */</span>
<span class="kt">void</span><span class="w"> </span><span class="nf">cmd_boot</span><span class="p">(</span><span class="k">struct</span><span class="w"> </span><span class="nc">userrec</span><span class="w"> </span><span class="o">*</span><span class="n">u</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">idx</span><span class="p">,</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">par</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="cm">/* snip */</span><span class="w"> </span><span class="p">}</span>

<span class="n">cmd_t</span><span class="w"> </span><span class="o">*</span><span class="n">mycmds</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
<span class="w">  </span><span class="p">{</span><span class="s">&quot;boot&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;t&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">(</span><span class="n">IntFunc</span><span class="p">)</span><span class="w"> </span><span class="n">cmd_boot</span><span class="p">,</span><span class="w"> </span><span class="nb">NULL</span><span class="w"> </span><span class="cm">/* automatic name: *dcc:boot */</span><span class="p">},</span>
<span class="w">  </span><span class="p">{</span><span class="nb">NULL</span><span class="p">,</span><span class="w"> </span><span class="nb">NULL</span><span class="p">,</span><span class="w"> </span><span class="nb">NULL</span><span class="p">,</span><span class="w"> </span><span class="nb">NULL</span><span class="p">}</span>
<span class="p">};</span>
<span class="n">add_builtins</span><span class="p">(</span><span class="n">H_dcc</span><span class="p">,</span><span class="w"> </span><span class="n">mycmds</span><span class="p">);</span>
</pre></div>
</div>
</section>
<section id="summary">
<h2>Summary<a class="headerlink" href="#summary" title="Link to this heading">¶</a></h2>
<p>In summary, this is how the dcc bind is called:</p>
<ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">check_tcl_dcc()</span></code> creates Tcl variables <code class="code docutils literal notranslate"><span class="pre">$_dcc1</span> <span class="pre">$_dcc2</span> <span class="pre">$_dcc3</span></code> and lets <code class="code docutils literal notranslate"><span class="pre">check_tcl_bind</span></code> call the binds</p></li>
<li><p>Tcl binds are done at this point</p></li>
<li><p>C binds mean the Tcl command associated with the bind is <code class="code docutils literal notranslate"><span class="pre">*dcc:boot</span></code> which calls <code class="code docutils literal notranslate"><span class="pre">builtin_dcc</span></code> which gets <code class="code docutils literal notranslate"><span class="pre">cmd_boot</span></code> as ClientData cd argument</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">gbuildin_dcc</span></code> performs some sanity checking to avoid crashes and then calls <code class="code docutils literal notranslate"><span class="pre">cmd_boot()</span></code> aka <code class="code docutils literal notranslate"><span class="pre">F()</span></code> with the arguments it wants C callbacks to have</p></li>
</ul>
<p>Example edited and annotated gdb backtrace in :code::<cite>cmd_boot</cite> after doing <code class="code docutils literal notranslate"><span class="pre">.boot</span> <span class="pre">test</span></code> on the partyline as user <code class="code docutils literal notranslate"><span class="pre">thommey</span></code> with typical owner flags.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>#0  cmd_boot (u=0x55e8bd8a49b0, idx=4, par=0x55e8be6a0010 &quot;test&quot;) at cmds.c:614
    *u = {next = 0x55e8bd8aec90, handle = &quot;thommey&quot;, flags = 8977024, flags_udef = 0, chanrec = 0x55e8bd8aeae0, entries = 0x55e8bd8a4a10}
#1  builtin_dcc (cd=0x55e8bbf002d0 &lt;cmd_boot&gt;, irp=0x55e8bd59b1c0, argc=4, argv=0x55e8bd7e3e00) at tclhash.c:678
    idx = 4
    argv = {0x55e8be642fa0 &quot;*dcc:boot&quot;, 0x55e8be9f6bd0 &quot;thommey&quot;, 0x55e8be7d9020 &quot;4&quot;, 0x55e8be6a0010 &quot;test&quot;, 0x0}
    F = 0x55e8bbf002d0 &lt;cmd_boot&gt;
#5  Tcl_Eval (interp=0x55e8bd59b1c0, script = &quot;*dcc:boot $_dcc1 $_dcc2 $_dcc3&quot;) from /usr/lib/x86_64-linux-gnu/libtcl8.6.so
    Tcl: return $_dcc1 = &quot;thommey&quot;
    Tcl: return $_dcc2 = &quot;4&quot;
    Tcl: return $_dcc3 = &quot;test&quot;
    Tcl: return $lastbind = &quot;boot&quot; (set automatically by trigger_bind)
#8  trigger_bind (proc=proc@entry=0x55e8bd5efda0 &quot;*dcc:boot&quot;, param=param@entry=0x55e8bbf4112b &quot; $_dcc1 $_dcc2 $_dcc3&quot;, mask=mask@entry=0x55e8bd5efd40 &quot;boot&quot;) at tclhash.c:742
#9  check_tcl_bind (tl=0x55e8bd5eecb0 &lt;H_dcc&gt;, match=match@entry=0x7ffcf3f9dac1 &quot;boot&quot;, atr=atr@entry=0x7ffcf3f9d100, param=param@entry=0x55e8bbf4112b &quot; $_dcc1 $_dcc2 $_dcc3&quot;, match_type=match_type@entry=80) at tclhash.c:942
    proc = 0x55e8bd5efda0 &quot;*dcc:boot&quot;
    mask = 0x55e8bd5efd40 &quot;boot&quot;
    brkt = 0x7ffcf3f9dac6 &quot;test&quot;
#10 check_tcl_dcc (cmd=cmd@entry=0x7ffcf3f9dac1 &quot;boot&quot;, idx=idx@entry=4, args=0x7ffcf3f9dac6 &quot;test&quot;) at tclhash.c:974
    fr = {match = 5, global = 8977024, udef_global = 0, bot = 0, chan = 0, udef_chan = 0}
#11 dcc_chat (idx=idx@entry=4, buf=&lt;optimized out&gt;, i=&lt;optimized out&gt;) at dcc.c:1068
    v = 0x7ffcf3f9dac1 &quot;boot&quot;
</pre></div>
</div>
</section>
</section>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
        </div>
        <div class="clearer"></div>
      </div>
    </div>

    <div class="footer-wrapper">
      <div class="footer">
        <div class="left">
          <div role="navigation" aria-label="related navigaton">
            <a href="writing.html" title="How to Write an Eggdrop Module"
              >previous</a> |
            <a href="../about/about.html" title="About Eggdrop"
              >next</a>
          </div>
          <div role="note" aria-label="source link">
          </div>
        </div>

        <div class="right">
          
    <div class="footer" role="contentinfo">
    &#169; Copyright 2025, Eggheads.
      Last updated on Aug 15, 2025.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
    </div>
        </div>
        <div class="clearer"></div>
      </div>
    </div>

  </body>
</html>