about summary refs log tree commit diff stats
path: root/203stack.subx
blob: 0ab80b9911fa7dfc648721ba4f74f4bf85a75825 (plain) (blame)
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
# A stack looks like this:
#   top: int
#   data: (array byte)  # prefixed by size as usual
#
# TODO: is it confusing that the push opcodes grow memory downward, but the
# push function grows stacks upward?

== code
#   instruction                     effective address                                                   register    displacement    immediate
# . op          subop               mod             rm32          base        index         scale       r32
# . 1-3 bytes   3 bits              2 bits          3 bits        3 bits      3 bits        2 bits      2 bits      0/1/2/4 bytes   0/1/2/4 bytes

clear-stack:  # s: (addr stack)
    # . prologue
    55/push-ebp
    89/copy                         3/mod/direct    5/rm32/ebp    .           .             .           4/r32/esp   .               .                 # copy esp to ebp
    # . save registers
    50/push-eax
    51/push-ecx
    # eax = s
    8b/copy                         1/mod/*+disp8   5/rm32/ebp    .           .             .           0/r32/eax   8/disp8         .                 # copy *(ebp+8) to eax
    # var max/ecx: (addr byte) = &s->data[s->size]
    8b/copy                         1/mod/*+disp8   0/rm32/eax    .           .             .           1/r32/ecx   4/disp8         .                 # copy *(eax+4) to eax
    8d/copy-address                 1/mod/*+disp8   4/rm32/sib    0/base/eax  1/index/ecx   .           1/r32/ecx   8/disp8         .                 # copy eax+ecx+8 to ecx
    # s->top = 0
    c7          0/subop/copy        0/mod/direct    0/rm32/eax    .           .             .           .           .               0/imm32           # copy to *eax
    # var curr/eax: (addr byte) = s->data
    81          0/subop/add         3/mod/direct    0/rm32/eax    .           .             .           .           .               8/imm32           # add to eax
$clear-stack:loop:
    # if (curr >= max) break
    39/compare                      3/mod/direct    0/rm32/eax    .           .             .           1/r32/ecx   .               .                 # compare eax with ecx
    73/jump-if-addr>=  $clear-stack:end/disp8
    # *curr = 0
    c6          0/subop/copy        0/mod/direct    0/rm32/eax    .           .             .           .           .               0/imm8            # copy byte to *eax
    # ++curr
    40/increment-eax
    eb/jump $clear-stack:loop/disp8
$clear-stack:end:
    # . restore registers
    59/pop-to-ecx
    58/pop-to-eax
    # . epilogue
    89/copy                         3/mod/direct    4/rm32/esp    .           .             .           5/r32/ebp   .               .                 # copy ebp to esp
    5d/pop-to-ebp
    c3/return

test-clear-stack:
    # . prologue
    55/push-ebp
    89/copy                         3/mod/direct    5/rm32/ebp    .           .             .           4/r32/esp   .               .                 # copy esp to ebp
    # var stack/ecx = stack of size 8 with random data in it
    68/push 34/imm32
    68/push 35/imm32
    68/push 8/imm32/size
    68/push 14/imm32/top
    89/copy                         3/mod/direct    1/rm32/ecx    .           .             .           4/r32/esp   .               .                 # copy esp to ecx
    # clear(stack)
    # . . push args
    51/push-ecx
    # . . call
    e8/call  clear-stack/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               4/imm32           # add to esp
    # top should be 0
    58/pop-to-eax
    # . check-ints-equal(eax, 0, msg)
    # . . push args
    68/push  "F - test-clear-stack: top"/imm32
    68/push  0/imm32
    50/push-eax
    # . . call
    e8/call  check-ints-equal/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               0xc/imm32         # add to esp
    # size should remain 8
    58/pop-to-eax
    # . check-ints-equal(eax, 8, msg)
    # . . push args
    68/push  "F - test-clear-stack: size"/imm32
    68/push  8/imm32
    50/push-eax
    # . . call
    e8/call  check-ints-equal/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               0xc/imm32         # add to esp
    # first word is 0
    58/pop-to-eax
    # . check-ints-equal(eax, 0, msg)
    # . . push args
    68/push  "F - test-clear-stack: data[0..3]"/imm32
    68/push  0/imm32
    50/push-eax
    # . . call
    e8/call  check-ints-equal/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               0xc/imm32         # add to esp
    # second word is 0
    58/pop-to-eax
    # . check-ints-equal(eax, 0, msg)
    # . . push args
    68/push  "F - test-clear-stack: data[4..7]"/imm32
    68/push  0/imm32
    50/push-eax
    # . . call
    e8/call  check-ints-equal/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               0xc/imm32         # add to esp
    # . epilogue
    89/copy                         3/mod/direct    4/rm32/esp    .           .             .           5/r32/ebp   .               .                 # copy ebp to esp
    5d/pop-to-ebp
    c3/return

# TODO: make this generic
push:  # s: (addr stack), n: int
    # . prologue
    55/push-ebp
    89/copy                         3/mod/direct    5/rm32/ebp    .           .             .           4/r32/esp   .               .                 # copy esp to ebp
    # . save registers
    50/push-eax
    51/push-ecx
    56/push-esi
    # esi = s
    8b/copy                         1/mod/*+disp8   5/rm32/ebp    .           .             .           6/r32/esi   8/disp8         .                 # copy *(ebp+8) to esi
    # ecx = s->top
    8b/copy                         0/mod/indirect  6/rm32/esi    .           .             .           1/r32/ecx   .               .                 # copy *esi to ecx
    # if (s->top >= s->size) abort
    39/compare                      1/mod/*+disp8   6/rm32/esi    .           .             .           1/r32/ecx   4/disp8         .                 # compare *(esi+4) and ecx
    7e/jump-if-<=  $push:abort/disp8
    # s->data[s->top] = n
    8b/copy                         1/mod/*+disp8   5/rm32/ebp    .           .             .           0/r32/eax   0xc/disp8       .                 # copy *(ebp+12) to eax
    89/copy                         1/mod/*+disp8   4/rm32/sib    6/base/esi  1/index/ecx   .           0/r32/eax   8/disp8         .                 # copy eax to *(esi+ecx+8)
    # s->top += 4
    81          0/subop/add         0/mod/direct    6/rm32/esi    .           .             .           .           .               4/imm32           # subtract from *esi
$push:end:
    # . restore registers
    5e/pop-to-esi
    59/pop-to-ecx
    58/pop-to-eax
    # . epilogue
    89/copy                         3/mod/direct    4/rm32/esp    .           .             .           5/r32/ebp   .               .                 # copy ebp to esp
    5d/pop-to-ebp
    c3/return

$push:abort:
    # print(stderr, "error: push: no space left")
    # . write-buffered(Stderr, "error: push: no space left")
    # . . push args
    68/push  "error: push: no space left"/imm32
    68/push  Stderr/imm32
    # . . call
    e8/call  write-buffered/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               8/imm32           # add to esp
    # . flush(Stderr)
    # . . push args
    68/push  Stderr/imm32
    # . . call
    e8/call  flush/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               4/imm32           # add to esp
    # . syscall(exit, 1)
    bb/copy-to-ebx  1/imm32
    e8/call  syscall_exit/disp32
    # never gets here

test-push:
    # . prologue
    55/push-ebp
    89/copy                         3/mod/direct    5/rm32/ebp    .           .             .           4/r32/esp   .               .                 # copy esp to ebp
    # var stack/ecx = empty stack of size 8
    68/push 0/imm32
    68/push 0/imm32
    68/push 8/imm32/size
    68/push 0/imm32/top
    89/copy                         3/mod/direct    1/rm32/ecx    .           .             .           4/r32/esp   .               .                 # copy esp to ecx
    # push(stack, 0x42)
    # . . push args
    68/push  0x42/imm32
    51/push-ecx
    # . . call
    e8/call  push/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               8/imm32           # add to esp
    # check top
    58/pop-to-eax
    # . check-ints-equal(eax, 4, msg)
    # . . push args
    68/push  "F - test-push: top"/imm32
    68/push  4/imm32
    50/push-eax
    # . . call
    e8/call  check-ints-equal/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               0xc/imm32         # add to esp
    # check size
    58/pop-to-eax
    # . check-ints-equal(eax, 8, msg)
    # . . push args
    68/push  "F - test-push: size"/imm32
    68/push  8/imm32
    50/push-eax
    # . . call
    e8/call  check-ints-equal/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               0xc/imm32         # add to esp
    # first word is 0x42
    58/pop-to-eax
    # . check-ints-equal(eax, 0x42, msg)
    # . . push args
    68/push  "F - test-push: data[0..3]"/imm32
    68/push  0x42/imm32
    50/push-eax
    # . . call
    e8/call  check-ints-equal/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               0xc/imm32         # add to esp
    # second word is 0
    58/pop-to-eax
    # . check-ints-equal(eax, 0, msg)
    # . . push args
    68/push  "F - test-push: data[4..7]"/imm32
    68/push  0/imm32
    50/push-eax
    # . . call
    e8/call  check-ints-equal/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               0xc/imm32         # add to esp
    # . epilogue
    89/copy                         3/mod/direct    4/rm32/esp    .           .             .           5/r32/ebp   .               .                 # copy ebp to esp
    5d/pop-to-ebp
    c3/return

# TODO: make this generic
pop:  # s: (addr stack) -> n/eax: int
    # . prologue
    55/push-ebp
    89/copy                         3/mod/direct    5/rm32/ebp    .           .             .           4/r32/esp   .               .                 # copy esp to ebp
    # . save registers
    51/push-ecx
    56/push-esi
    # esi = s
    8b/copy                         1/mod/*+disp8   5/rm32/ebp    .           .             .           6/r32/esi   8/disp8         .                 # copy *(ebp+8) to esi
    # if (s->top <= 0) abort
    81          7/subop/compare     0/mod/indirect  6/rm32/esi    .           .             .           .           .               0/imm32           # compare *esi
    7e/jump-if-<=  $pop:abort/disp8
    # s->top -= 4
    81          5/subop/subtract    0/mod/direct    6/rm32/esi    .           .             .           .           .               4/imm32           # subtract from *esi
    # eax = s->data[s->top]
    8b/copy                         0/mod/indirect  6/rm32/esi    .           .             .           1/r32/ecx   .               .                 # copy *esi to ecx
    8b/copy                         1/mod/*+disp8   4/rm32/sib    6/base/esi  1/index/ecx   .           0/r32/eax   8/disp8         .                 # copy *(esi+ecx+8) to eax
    # s->data[s->top] = 0
    c7          0/subop/copy        1/mod/*+disp8   4/rm32/sib    6/base/esi  1/index/ecx   .           0/r32/eax   8/disp8         0/imm32           # copy to *(esi+ecx+8)
$pop:end:
    # . restore registers
    5e/pop-to-esi
    59/pop-to-ecx
    # . epilogue
    89/copy                         3/mod/direct    4/rm32/esp    .           .             .           5/r32/ebp   .               .                 # copy ebp to esp
    5d/pop-to-ebp
    c3/return

$pop:abort:
    # print(stderr, "error: pop: nothing left in stack")
    # . write-buffered(Stderr, "error: pop: nothing left in stack")
    # . . push args
    68/push  "error: pop: nothing left in stack"/imm32
    68/push  Stderr/imm32
    # . . call
    e8/call  write-buffered/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               8/imm32           # add to esp
    # . flush(Stderr)
    # . . push args
    68/push  Stderr/imm32
    # . . call
    e8/call  flush/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               4/imm32           # add to esp
    # . syscall(exit, 1)
    bb/copy-to-ebx  1/imm32
    e8/call  syscall_exit/disp32
    # never gets here

test-pop:
    # . prologue
    55/push-ebp
    89/copy                         3/mod/direct    5/rm32/ebp    .           .             .           4/r32/esp   .               .                 # copy esp to ebp
    # var stack/ecx = stack of size 8 containing just 0x42
    68/push 0/imm32
    68/push 0x42/imm32
    68/push 8/imm32/size
    68/push 4/imm32/top
    89/copy                         3/mod/direct    1/rm32/ecx    .           .             .           4/r32/esp   .               .                 # copy esp to ecx
    # eax = pop(stack)
    # . . push args
    51/push-ecx
    # . . call
    e8/call  pop/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               4/imm32           # add to esp
    # check-ints-equal(eax, 0x42, msg)
    # . . push args
    68/push  "F - test-pop: result"/imm32
    68/push  0x42/imm32
    50/push-eax
    # . . call
    e8/call  check-ints-equal/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               0xc/imm32         # add to esp
    # check top
    58/pop-to-eax
    # . check-ints-equal(eax, 0, msg)
    # . . push args
    68/push  "F - test-pop: top"/imm32
    68/push  0/imm32
    50/push-eax
    # . . call
    e8/call  check-ints-equal/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               0xc/imm32         # add to esp
    # check size
    58/pop-to-eax
    # . check-ints-equal(eax, 8, msg)
    # . . push args
    68/push  "F - test-pop: size"/imm32
    68/push  8/imm32
    50/push-eax
    # . . call
    e8/call  check-ints-equal/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               0xc/imm32         # add to esp
    # . epilogue
    89/copy                         3/mod/direct    4/rm32/esp    .           .             .           5/r32/ebp   .               .                 # copy ebp to esp
    5d/pop-to-ebp
    c3/return

# TODO: make this generic
top:  # s: (addr stack) -> n/eax: int
    # . prologue
    55/push-ebp
    89/copy                         3/mod/direct    5/rm32/ebp    .           .             .           4/r32/esp   .               .                 # copy esp to ebp
    # . save registers
    51/push-ecx
    56/push-esi
    # esi = s
    8b/copy                         1/mod/*+disp8   5/rm32/ebp    .           .             .           6/r32/esi   8/disp8         .                 # copy *(ebp+8) to esi
    # if (s->top <= 0) abort
    81          7/subop/compare     0/mod/indirect  6/rm32/esi    .           .             .           .           .               0/imm32           # compare *esi
    7e/jump-if-<=  $top:abort/disp8
    # n = s->data[s->top - 4]
    8b/copy                         0/mod/indirect  6/rm32/esi    .           .             .           1/r32/ecx   .               .                 # copy *esi to ecx
    81          5/subop/subtract    3/mod/direct    1/rm32/ecx    .           .             .           .           .               4/imm32           # subtract from ecx
    8b/copy                         1/mod/*+disp8   4/rm32/sib    6/base/esi  1/index/ecx   .           0/r32/eax   8/disp8         .                 # copy *(esi+ecx+8) to eax
$top:end:
    # . restore registers
    5e/pop-to-esi
    59/pop-to-ecx
    # . epilogue
    89/copy                         3/mod/direct    4/rm32/esp    .           .             .           5/r32/ebp   .               .                 # copy ebp to esp
    5d/pop-to-ebp
    c3/return

$top:abort:
    # print(stderr, "error: top: nothing left in stack")
    # . write-buffered(Stderr, "error: top: nothing left in stack")
    # . . push args
    68/push  "error: top: nothing left in stack"/imm32
    68/push  Stderr/imm32
    # . . call
    e8/call  write-buffered/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               8/imm32           # add to esp
    # . flush(Stderr)
    # . . push args
    68/push  Stderr/imm32
    # . . call
    e8/call  flush/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               4/imm32           # add to esp
    # . syscall(exit, 1)
    bb/copy-to-ebx  1/imm32
    e8/call  syscall_exit/disp32
    # never gets here

test-top:
    # . prologue
    55/push-ebp
    89/copy                         3/mod/direct    5/rm32/ebp    .           .             .           4/r32/esp   .               .                 # copy esp to ebp
    # var stack/ecx = stack of size 8 containing just 0x42
    68/push  0/imm32
    68/push  0x42/imm32
    68/push  8/imm32/size
    68/push  4/imm32/top
    89/copy                         3/mod/direct    1/rm32/ecx    .           .             .           4/r32/esp   .               .                 # copy esp to ecx
    # eax = top(stack)
    # . . push args
    51/push-ecx
    # . . call
    e8/call  top/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               4/imm32           # add to esp
    # check-ints-equal(eax, 42, msg")
    # . . push args
    68/push  "F - test-top: result"/imm32
    68/push  0x42/imm32
    50/push-eax
    # . . call
    e8/call  check-ints-equal/disp32
    # . . discard args
    81          0/subop/add         3/mod/direct    4/rm32/esp    .           .             .           .           .               0xc/imm32         # add to esp
    # . epilogue
    89/copy                         3/mod/direct    4/rm32/esp    .           .             .           5/r32/ebp   .               .                 # copy ebp to esp
    5d/pop-to-ebp
    c3/return

# . . vim:nowrap:textwidth=0
" pass def register_command(name, min_args, max_args, synopsis, description, arguments, examples, callback): """Register a new command, with help information, and callback for command execution.\n Profanity will do some basic validation when the command is called using the argument range. :param name: the command name with leading slash, e.g. ``"/say"`` :param min_args: minimum number or arguments that the command considers to be a valid call :param max_args: maximum number or arguments that the command considers to be a valid call :param synopsis: command usages :param description: a short description of the command :param arguments: argument descriptions, each element should be of the form [arguments, description] :param examples: example usages :param callback: function to call when the command is executed :type name: str or unicode :type min_args: int :type max_args: int :type synopsis: list of str or unicode :type description: str or unicode :type arguments: list of list of str or unicode :type examples: list of str or unicode :type callback: function Example: :: synopsis = [ "/newcommand action1|action2", "/newcommand print <argument>", "/newcommand dosomething [<optional_argument>]" ] description = "An example for the documentation" args = [ [ "action1|action2", "Perform action1 or action2" ], [ "print <argument>", "Print argument" ], [ "dosomething [<optional_argument>]", "Do something, optionally with the argument" ] ] examples = [ "/newcommand action1", "/newcommand print \\"Test debug message\\"", "/newcommand dosomething" ] prof.register_command("/newcommand", 1, 2, synopsis, description, args, examples, my_function) """ pass def register_timed(callback, interval): """Register a function that Profanity will call periodically. :param callback: the function to call :param interval: the time between each call to the function, in seconds :type callback: function :type interval: int Example: :: prof.register_timed(some_function, 30) """ pass def completer_add(key, items): """Add values to be autocompleted by Profanity for a command, or command argument. If the key already exists, Profanity will add the items to the existing autocomplete items for that key. :param key: the prefix to trigger autocompletion :param items: the items to return on autocompletion :type key: str or unicode :type items: list of str or unicode Examples: :: prof.completer_add("/mycommand", [ "action1", "action2", "dosomething" ]) prof.completer_add("/mycommand dosomething", [ "thing1", "thing2" ]) """ pass def completer_remove(key, items): """Remove values from autocompletion for a command, or command argument. :param key: the prefix from which to remove the autocompletion items :param items: the items to remove :type key: str or unicode :type items: list of str or unicode Examples: :: prof.completer_remove("/mycommand", [ "action1", "action2" ]) prof.completer_add("/mycommand dosomething", [ "thing1" ]) """ pass def completer_clear(key): """Remove all values from autocompletion for a command, or command argument. :param key: the prefix from which to clear the autocompletion items Examples: :: prof.completer_clear("/mycommand") prof.completer_add("/mycommand dosomething") """ pass def filepath_completer_add(prefix): """Add filepath autocompletion for a command, or command argument. :param prefix: the prefix from which filepath autocompletion will be triggered Examples: :: prof.filepath_completer_add("/filecmd") prof.filepath_completer_add("/mycommand open") """ pass def send_line(line): """Send a line of input to Profanity to execute. :param line: the line to send :type line: str or unicode Example: :: prof.send_line("/who online") """ pass def notify(message, timeout, category): """Send a desktop notification. :param message: the message to display in the notification :param timeout: the length of time before the notification disappears in milliseconds :param category: the category of the notification, also displayed :type message: str or unicode :type timeout: int :type category: str or unicode Example: :: prof.notify("Example notification for 5 seconds", 5000, "Example plugin") """ pass def get_current_recipient(): """Retrieve the Jabber ID of the current chat recipient, when in a chat window. :return: the Jabber ID of the current chat recipient e.g. ``"buddy@chat.org"``, or ``None`` if not in a chat window. :rtype: str """ pass def get_current_muc(): """Retrieve the Jabber ID of the current room, when in a chat room window. :return: the Jabber ID of the current chat room e.g. ``"metalchat@conference.chat.org"``, or ``None`` if not in a chat room window. :rtype: str """ pass def get_current_nick(): """Retrieve the users nickname in a chat room, when in a chat room window. :return: the users nickname in the current chat room e.g. ``"eddie"``, or ``None`` if not in a chat room window. :rtype: str """ pass def get_name_from_roster(barejid): """Retrieve a nickname from a barejid if it is in the roster. :return: the users nickname e.g. "eddie", or the input barejid if it is not in the roster. :rtype: str """ pass def get_barejid_from_roster(name): """Retrieve the barejid for a given nickname if it is in the roster. :return: the users barejid e.g. "eddie@server.tld", or ``None`` if the nickname is not in the roster. :rtype: str """ pass def get_current_occupants(): """Retrieve nicknames of all occupants in a chat room, when in a chat room window. :return: nicknames of all occupants in the current room or an empty list if not in a chat room window. :rtype: list of str """ pass def get_room_nick(barejid): """Retrieve current nickname used in chat room. :return: Room nickname. :rtype: str """ pass def current_win_is_console(): """Determine whether or not the Console window is currently focused. :return: ``True`` if the user is currently in the Console window, ``False`` otherwise. :rtype: boolean """ pass def log_debug(message): """Write to the Profanity log at level ``DEBUG``. :param message: the message to log :type message: str or unicode """ pass def log_info(): """Write to the Profanity log at level ``INFO``. :param message: the message to log :type message: str or unicode """ pass def log_warning(): """Write to the Profanity log at level ``WARNING``. :param message: the message to log :type message: str or unicode """ pass def log_error(): """Write to the Profanity log at level ``ERROR``. :param message: the message to log :type message: str or unicode """ pass def win_exists(tag): """Determine whether or not a plugin window currently exists for the tag. :param tag: The tag used when creating the plugin window :type tag: str or unicode :return: ``True`` if the window exists, ``False`` otherwise. :rtype: boolean Example: :: prof.win_exists("My Plugin") """ pass def win_create(tag, callback): """Create a plugin window. :param tag: The tag used to refer to the window :type tag: str or unicode :param callback: function to call when the window receives input :type callback: function Example: :: prof.win_create("My Plugin", window_handler) """ pass def win_focus(tag): """Focus a plugin window. :param tag: The tag of the window to focus :type tag: str or unicode Example: :: prof.win_focus("My Plugin") """ pass def win_show(tag, message): """Show a message in the plugin window. :param tag: The tag of the window to display the message :type tag: str or unicode :param message: the message to print :type message: str or unicode Example: :: prof.win_show("My Plugin", "This will appear in the plugin window") """ pass def win_show_themed(tag, group, key, default, message): """Show a message in the plugin window, using the specified theme.\n Themes are specified in ``~/.local/share/profanity/plugin_themes`` :param tag: The tag of the window to display the message :type tag: str or unicode :param group: the group name in the themes file :param key: the item name within the group :param default: default colour if the theme cannot be found :param message: the message to print :type group: str, unicode or None :type key: str, unicode or None :type default: str, unicode or None :type message: str or unicode Example: :: prof.win_show_themed("My Plugin", "myplugin", "text", None, "Plugin themed message") """ pass def send_stanza(stanza): """Send an XMPP stanza :param stanza: An XMPP stanza :type stanza: str or unicode :return: ``True`` if the stanza was sent successfully, ``False`` otherwise :rtype: boolean Example: :: prof.send_stanza("<iq to='juliet@capulet.lit/balcony' id='s2c1' type='get'><ping xmlns='urn:xmpp:ping'/></iq>") """ pass def settings_boolean_get(group, key, default): """Get a boolean setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings`` :param group: the group name in the settings file :param key: the item name within the group :param default: default value if setting not found :type group: str or unicode :type key: str or unicode :type default: boolean Example: :: prof.settings_boolean_get("myplugin", "notify", False) """ pass def settings_boolean_set(group, key, value): """Set a boolean setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings`` :param group: the group name in the settings file :param key: the item name within the group :param value: value to set :type group: str or unicode :type key: str or unicode :type value: boolean Example: :: prof.settings_boolean_set("myplugin", "activate", True) """ pass def settings_string_get(group, key, default): """Get a string setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings`` :param group: the group name in the settings file :param key: the item name within the group :param default: default value if setting not found :type group: str or unicode :type key: str or unicode :type default: str Example: :: prof.settings_string_get("myplugin", "prefix", "prefix-->") """ pass def settings_string_set(group, key, value): """Set a string setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings`` :param group: the group name in the settings file :param key: the item name within the group :param value: value to set :type group: str or unicode :type key: str or unicode :type value: str Example: :: prof.settings_string_set("myplugin", "prefix", "myplugin, ") """ pass def settings_string_list_get(group, key): """Get a string list setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings``\n The string list setting items are separated by semicolons. :param group: the group name in the settings file :param key: the item name within the group :type group: str or unicode :type key: str or unicode :return: the list setting :rtype: list of str or unicode Example: :: prof.settings_string_list_get("someplugin", "somelist") """ pass def settings_string_list_add(group, key, value): """Add an item to a string list setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings``\n If the list does not exist, a new one will be created with the element added :param group: the group name in the settings file :param key: the item name within the group :param value: item to add :type group: str or unicode :type key: str or unicode :type value: str Example: :: prof.settings_string_list_add("someplugin", "somelist", "anelement") """ pass def settings_string_list_remove(group, key, value): """Remove an item from a string list setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings``\n :param group: the group name in the settings file :param key: the item name within the group :param value: item to remove :type group: str or unicode :type key: str or unicode :type value: str :return: ``True`` if the item was removed, or is not in the list, ``False`` if the list does not exist :rtype: boolean Example: :: prof.settings_string_list_remove("someplugin", "somelist", "anelement") """ pass def settings_string_list_clear(group, key): """Remove all items from a string list setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings``\n :param group: the group name in the settings file :param key: the item name within the group :type group: str or unicode :type key: str or unicode :return: ``True`` if the list was cleared, ``False`` if the list does not exist :rtype: boolean Example: :: prof.settings_string_list_clear("someplugin", "somelist") """ pass def settings_int_get(group, key, default): """Get an integer setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings`` :param group: the group name in the settings file :param key: the item name within the group :param default: default value if setting not found :type group: str or unicode :type key: str or unicode :type default: int Example: :: prof.settings_int_get("myplugin", "timeout", 10) """ pass def settings_int_set(group, key, value): """Set an integer setting\n Settings must be specified in ``~/.local/share/profanity/plugin_settings`` :param group: the group name in the settings file :param key: the item name within the group :param value: value to set :type group: str or unicode :type key: str or unicode :type value: int Example: :: prof.settings_int_set("myplugin", "timeout", 100) """ pass def incoming_message(barejid, resource, message): """Trigger incoming message handling, this plugin will make profanity act as if the message has been received :param barejid: Jabber ID of the sender of the message :param resource: resource of the sender of the message :param message: the message text :type barejid: str or unicode :type resource: str or unicode :type message: str or unicode Example: :: prof.incoming_message("bob@server.org", "laptop", "Hello there") """ pass def disco_add_feature(feature): """Add a service discovery feature the list supported by Profanity.\n If a session is already connected, a presence update will be sent to allow any client/server caches to update their feature list for Profanity :param feature: the service discovery feature to be added :type feature: str Example: :: prof.disco_add_feature("urn:xmpp:omemo:0:devicelist+notify") """ pass def encryption_reset(barejid): """End any encrypted session with the specified user :param barejid: Jabber ID of the recipient :type barejid: str or unicode Example: :: prof.encryption_reset("alice@server.org") """ pass def chat_set_titlebar_enctext(barejid, enctext): """Set the text to display in the titlebar encryption indicator for recipient. :param barejid: Jabber ID of the recipient :param enctext: The text to display :type barejid: str or unicode :type enctext: str or unicode :return: ``True`` if the text was set successfully, ``False`` otherwise :rtype: boolean Example: :: prof.chat_set_titlebar_enctext("bob@chat.org", "safe") """ pass def chat_unset_titlebar_enctext(barejid): """Let profanity decide what to show in the titlebar encryption indicator for recipient. :param barejid: Jabber ID of the recipient :type barejid: str or unicode :return: ``True`` if the text was unset successfully, ``False`` otherwise :rtype: boolean Example: :: prof.chat_unset_titlebar_enctext("bob@chat.org") """ pass def chat_set_incoming_char(barejid, ch): """Set the incoming message prefix character for specified contact. :param barejid: Jabber ID of the recipient :param enctext: The character to display :type barejid: str or unicode :type enctext: str or unicode :return: ``True`` if the character was set successfully, ``False`` otherwise :rtype: boolean Example: :: prof.chat_set_incoming_char("kristine@chat.org", "*") """ pass def chat_unset_incoming_char(barejid): """Reset the incoming message prefix character for specified contact. :param barejid: Jabber ID of the recipient :type barejid: str or unicode :return: ``True`` if the char was unset successfully, ``False`` otherwise :rtype: boolean Example: :: prof.chat_unset_incoming_char("kristine@chat.org") """ pass def chat_set_outgoing_char(barejid, ch): """Set the outgoing message prefix character for specified contact. :param barejid: Jabber ID of the recipient :param enctext: The character to display :type barejid: str or unicode :type enctext: str or unicode :return: ``True`` if the character was set successfully, ``False`` otherwise :rtype: boolean Example: :: prof.chat_set_outgoing_char("david@chat.org", "+") """ pass def chat_unset_outgoing_char(barejid): """Reset the outgoing message prefix character for specified contact. :param barejid: Jabber ID of the recipient :type barejid: str or unicode :return: ``True`` if the char was unset successfully, ``False`` otherwise :rtype: boolean Example: :: prof.chat_unset_outgoing_char("david@chat.org") """ pass def room_set_titlebar_enctext(roomjid, enctext): """Set the text to display in the titlebar encryption indicator for room. :param roomjid: Jabber ID of the room :param enctext: The text to display :type roomjid: str or unicode :type enctext: str or unicode :return: ``True`` if the text was set successfully, ``False`` otherwise :rtype: boolean Example: :: prof.room_set_titlebar_enctext("generalchat@conference.service.com", "secret") """ pass def room_unset_titlebar_enctext(roomjid): """Let profanity decide what to show in the titlebar encryption indicator for room. :param roomjid: Jabber ID of the room :type roomjid: str or unicode :return: ``True`` if the text was unset successfully, ``False`` otherwise :rtype: boolean Example: :: prof.room_unset_titlebar_enctext("generalchat@conference.service.com") """ pass def room_set_message_char(roomjid, ch): """Set the message prefix character for specified room. :param roomjid: Jabber ID of the room :param enctext: The character to display :type roomjid: str or unicode :type enctext: str or unicode :return: ``True`` if the character was set successfully, ``False`` otherwise :rtype: boolean Example: :: prof.room_set_message_char("ohnoes@conference.chat.org", "^") """ pass def room_unset_message_char(roomjid): """Reset the message prefix character for specified room. :param roomjid: Jabber ID of the room :type roomjid: str or unicode :return: ``True`` if the char was unset successfully, ``False`` otherwise :rtype: boolean Example: :: prof.room_unset_message_char("ohnoes@conference.chat.org") """ pass def chat_show(barejid, message): """Show a message in a chat window. :param barejid: Jabber ID of the recipient :param message: the message to print :type barejid: str or unicode :type message: str or unicode :return: ``True`` if the message was printed, ``False`` otherwise :rtype: boolean Example: :: prof.chat_show("bob@server.org", "From a plugin in the chat window for bob") """ pass def chat_show_themed(barejid, group, key, default, ch, message): """Show a message a chat window, using the specified theme and prefix character.\n Themes are specified in ``~/.local/share/profanity/plugin_themes`` :param barejid: Jabber ID of the recipient :param group: the group name in the themes file or ``None`` :param key: the item name within the group or ``None`` :param default: default colour if the theme cannot be found or ``None`` :param ch: The prefix character to show, or ``None`` for default behaviour :param message: the message to print :type barejid: str or unicode :type group: str, unicode or None :type key: str, unicode or None :type default: str, unicode or None :type ch: str or unicode :type message: str or unicode :return: ``True`` if the message was printed, ``False`` otherwise :rtype: boolean Example: :: prof.chat_show_themed("bob@server.org", "myplugin", "text", None, "!", "Plugin themed message") """ pass def room_show(roomjid, message): """Show a message in a chat room window. :param roomjid: Jabber ID of the room :param message: the message to print :type roomjid: str or unicode :type message: str or unicode :return: ``True`` if the message was printed, ``False`` otherwise :rtype: boolean Example: :: prof.room_show("chat@conference.chat.org", "From a plugin in the chat room window") """ pass def room_show_themed(roomjid, group, key, default, ch, message): """Show a message a chat room window, using the specified theme and prefix character.\n Themes are specified in ``~/.local/share/profanity/plugin_themes`` :param roomjid: Jabber ID of the room :param group: the group name in the themes file or ``None`` :param key: the item name within the group or ``None`` :param default: default colour if the theme cannot be found or ``None`` :param ch: The prefix character to show, or ``None`` for default behaviour :param message: the message to print :type roomjid: str or unicode :type group: str, unicode or None :type key: str, unicode or None :type default: str, unicode or None :type ch: str or unicode :type message: str or unicode :return: ``True`` if the message was printed, ``False`` otherwise :rtype: boolean Example: :: prof.room_show_themed("chat@conference.chat.org", "myplugin", "text", None, "!", "Plugin themed message") """ pass