source: perlglue.xs @ 69f74c2

Last change on this file since 69f74c2 was 69f74c2, checked in by David Benjamin <davidben@mit.edu>, 8 years ago
And now... the moment you've all been waiting for... Expose OWL_VARIABLE_OTHER variables to perl. Rewrite all perl variable entry points to use that one. From now on, C only thinks of these variables as strings. (This has one regression to be fixed in a later commit: you can't set/unset with no arguments since we don't know how to set from boolean.)
  • Property mode set to 100644
File size: 10.6 KB
Line 
1/* -*- mode: c; indent-tabs-mode: t; c-basic-offset: 8 -*- */
2#define OWL_PERL
3#include "owl.h"
4
5#define SV_IS_CODEREF(sv) (SvROK((sv)) && SvTYPE(SvRV((sv))) == SVt_PVCV)
6
7typedef char utf8;
8
9        /*************************************************************
10         * NOTE
11         *************************************************************
12         * These functions, when they are intended to be user-visible,
13         * are documented in perl/lib/BarnOwl.pm. If you add functions
14         * to this file, add the appropriate documentation there!
15         *
16         * If the function is simple enough, we simply define its
17         * entire functionality here in XS. If, however, it needs
18         * complex argument processing or something, we define a
19         * simple version here that takes arguments in as flat a
20         * manner as possible, to simplify the XS code, put it in
21         * BarnOwl::Internal::, and write a perl wrapper in BarnOwl.pm
22         * that munges the arguments as appropriate and calls the
23         * internal version.
24         */
25
26MODULE = BarnOwl                PACKAGE = BarnOwl
27
28const utf8 *
29command(cmd, ...)
30        const char *cmd
31        PREINIT:
32                char *rv = NULL;
33                const char **argv;
34                int i;
35        CODE:
36        {
37                if (items == 1) {
38                        rv = owl_function_command(cmd);
39                } else {
40                        /* Ensure this is NULL-terminated. */
41                        argv = g_new0(const char *, items + 1);
42                        argv[0] = cmd;
43                        for(i = 1; i < items; i++) {
44                                argv[i] = SvPV_nolen(ST(i));
45                        }
46                        rv = owl_function_command_argv(argv, items);
47                        g_free(argv);
48                }
49                RETVAL = rv;
50        }
51        OUTPUT:
52                RETVAL
53        CLEANUP:
54                g_free(rv);
55
56SV *
57getcurmsg()
58        CODE:
59                RETVAL = owl_perlconfig_curmessage2hashref();
60        OUTPUT:
61                RETVAL
62
63int
64getnumcols()
65        CODE:
66                RETVAL = owl_global_get_cols(&g);
67        OUTPUT:
68                RETVAL
69
70int
71getnumlines()
72        CODE:
73                RETVAL = owl_global_get_lines(&g);
74        OUTPUT:
75                RETVAL
76
77time_t
78getidletime()
79        CODE:
80                RETVAL = owl_global_get_idletime(&g);
81        OUTPUT:
82                RETVAL
83
84const utf8 *
85zephyr_getrealm()
86        CODE:
87                RETVAL = owl_zephyr_get_realm();
88        OUTPUT:
89                RETVAL
90
91const utf8 *
92zephyr_getsender()
93        CODE:
94                RETVAL = owl_zephyr_get_sender();
95        OUTPUT:
96                RETVAL
97
98const utf8 *
99ztext_stylestrip(ztext)
100        const char *ztext
101        PREINIT:
102                char *rv = NULL;
103        CODE:
104                rv = owl_function_ztext_stylestrip(ztext);
105                RETVAL = rv;
106        OUTPUT:
107                RETVAL
108        CLEANUP:
109                g_free(rv);
110
111const utf8 *
112zephyr_smartstrip_user(in)
113        const char *in
114        PREINIT:
115                char *rv = NULL;
116        CODE:
117        {
118                rv = owl_zephyr_smartstripped_user(in);
119                RETVAL = rv;
120        }
121        OUTPUT:
122                RETVAL
123        CLEANUP:
124                g_free(rv);
125
126const utf8 *
127zephyr_getsubs()
128        PREINIT:
129                char *rv = NULL;
130        CODE:
131                rv = owl_zephyr_getsubs();
132                RETVAL = rv;
133    OUTPUT:
134                RETVAL
135    CLEANUP:
136                g_free(rv);
137
138SV *
139queue_message(msg)
140        SV *msg
141        PREINIT:
142                owl_message *m;
143        CODE:
144        {
145                if(!SvROK(msg) || SvTYPE(SvRV(msg)) != SVt_PVHV) {
146                        croak("Usage: BarnOwl::queue_message($message)");
147                }
148
149                m = owl_perlconfig_hashref2message(msg);
150
151                owl_global_messagequeue_addmsg(&g, m);
152
153                RETVAL = owl_perlconfig_message2hashref(m);
154        }
155        OUTPUT:
156                RETVAL
157
158void
159admin_message(header, body)
160        const char *header
161        const char *body
162        CODE:
163        {
164                owl_function_adminmsg(header, body);           
165        }
166
167
168const char * 
169get_data_dir ()
170        CODE:
171                RETVAL = owl_get_datadir();
172        OUTPUT:
173        RETVAL
174
175const char * 
176get_config_dir ()
177        CODE:
178                RETVAL = owl_global_get_confdir(&g);
179        OUTPUT:
180        RETVAL 
181
182void
183popless_text(text) 
184        const char *text
185        CODE:
186        {
187                owl_function_popless_text(text);
188        }
189
190void
191popless_ztext(text) 
192        const char *text
193        CODE:
194        {
195                owl_fmtext fm;
196                owl_fmtext_init_null(&fm);
197                owl_fmtext_append_ztext(&fm, text);
198                owl_function_popless_fmtext(&fm);
199                owl_fmtext_cleanup(&fm);
200        }
201
202void
203error(text) 
204        const char *text
205        CODE:
206        {
207                owl_function_error("%s", text);
208        }
209
210void
211debug(text)
212        const char *text
213        CODE:
214        {
215                owl_function_debugmsg("%s", text);
216        }
217
218void
219message(text)
220        const char *text
221        CODE:
222        {
223                owl_function_makemsg("%s", text);
224        }
225
226void
227create_style(name, object)
228     const char *name
229     SV  *object
230     PREINIT:
231                owl_style *s;
232     CODE:
233        {
234                s = g_new(owl_style, 1);
235                owl_style_create_perl(s, name, newSVsv(object));
236                owl_global_add_style(&g, s);
237        }
238
239int
240getnumcolors()
241        CODE:
242                RETVAL = owl_function_get_color_count();
243        OUTPUT:
244                RETVAL
245
246void
247_remove_filter(filterName)
248        const char *filterName
249        CODE:
250        {
251                /* Don't delete the current view, or the 'all' filter */
252                if (strcmp(filterName, owl_view_get_filtname(owl_global_get_current_view(&g)))
253                    && strcmp(filterName, "all")) {
254                        owl_global_remove_filter(&g,filterName);
255                }
256        }
257
258const utf8 *
259wordwrap(in, cols)
260        const char *in
261        int cols
262        PREINIT:
263                char *rv = NULL;
264        CODE:
265                rv = owl_text_wordwrap(in, cols);
266                RETVAL = rv;   
267        OUTPUT:
268                RETVAL
269        CLEANUP:
270                g_free(rv);
271
272AV*
273all_filters()
274        PREINIT:
275                GPtrArray *fl;
276        CODE:
277        {
278                fl = owl_dict_get_keys(&g.filters);
279                RETVAL = owl_new_av(fl, (SV*(*)(const void*))owl_new_sv);
280                sv_2mortal((SV*)RETVAL);
281                owl_ptr_array_free(fl, g_free);
282        }
283        OUTPUT:
284                RETVAL
285
286AV*
287all_styles()
288        PREINIT:
289                GPtrArray *l;
290        CODE:
291        {
292                l = owl_global_get_style_names(&g);
293                RETVAL = owl_new_av(l, (SV*(*)(const void*))owl_new_sv);
294                sv_2mortal((SV*)RETVAL);
295        }
296        OUTPUT:
297                RETVAL
298        CLEANUP:
299                owl_ptr_array_free(l, g_free);
300
301
302AV*
303all_variables()
304        PREINIT:
305                GPtrArray *l;
306        CODE:
307        {
308                l = owl_dict_get_keys(owl_global_get_vardict(&g));
309                RETVAL = owl_new_av(l, (SV*(*)(const void*))owl_new_sv);
310                sv_2mortal((SV*)RETVAL);
311        }
312        OUTPUT:
313                RETVAL
314        CLEANUP:
315                owl_ptr_array_free(l, g_free);
316
317
318AV*
319all_keymaps()
320        PREINIT:
321                GPtrArray *l;
322                const owl_keyhandler *kh;
323        CODE:
324        {
325                kh = owl_global_get_keyhandler(&g);
326                l = owl_keyhandler_get_keymap_names(kh);
327                RETVAL = owl_new_av(l, (SV*(*)(const void*))owl_new_sv);
328                sv_2mortal((SV*)RETVAL);
329        }
330        OUTPUT:
331                RETVAL
332        CLEANUP:
333                owl_ptr_array_free(l, g_free);
334
335void
336redisplay()
337        CODE:
338        {
339                owl_messagelist_invalidate_formats(owl_global_get_msglist(&g));
340                owl_function_calculate_topmsg(OWL_DIRECTION_DOWNWARDS);
341                owl_mainwin_redisplay(owl_global_get_mainwin(&g));
342        }
343
344const char *
345get_zephyr_variable(name)
346        const char *name;
347        CODE:
348                RETVAL = owl_zephyr_get_variable(name);
349        OUTPUT:
350                RETVAL
351
352const utf8 *
353skiptokens(str, n)
354        const char *str;
355        int n;
356        CODE:
357                RETVAL = skiptokens(str, n);
358        OUTPUT:
359                RETVAL
360
361
362MODULE = BarnOwl                PACKAGE = BarnOwl::Zephyr
363
364int
365have_zephyr()
366        CODE:
367                RETVAL = owl_global_is_havezephyr(&g);
368        OUTPUT:
369                RETVAL
370
371MODULE = BarnOwl                PACKAGE = BarnOwl::Internal
372
373
374void
375new_command(name, func, summary, usage, description)
376        char *name
377        SV *func
378        char *summary
379        char *usage
380        char *description
381        PREINIT:
382                owl_cmd cmd;
383        CODE:
384        {
385                if(!SV_IS_CODEREF(func)) {
386                        croak("Command function must be a coderef!");
387                }
388                cmd.name = name;
389                cmd.cmd_perl = newSVsv(func);
390                cmd.summary = summary;
391                cmd.usage = usage;
392                cmd.description = description;
393                cmd.validctx = OWL_CTX_ANY;
394                cmd.cmd_aliased_to = NULL;
395                cmd.cmd_args_fn = NULL;
396                cmd.cmd_v_fn = NULL;
397                cmd.cmd_i_fn = NULL;
398                cmd.cmd_ctxargs_fn = NULL;
399                cmd.cmd_ctxv_fn = NULL;
400                cmd.cmd_ctxi_fn = NULL;
401                owl_cmddict_add_cmd(owl_global_get_cmddict(&g), &cmd);
402           }
403
404
405MODULE = BarnOwl                PACKAGE = BarnOwl::Internal
406
407void
408new_variable(name, summary, description, validsettings, get_tostring_fn, set_fromstring_fn, data)
409    const char *name
410    const char *summary
411    const char *description
412    const char *validsettings
413    SV *get_tostring_fn
414    SV *set_fromstring_fn
415    SV *data
416    CODE:
417{
418        /* data is somewhat redundant given we can create closures, but oh
419         * well. Might be convenient sometimes. */
420        if(!SV_IS_CODEREF(get_tostring_fn)) {
421                croak("To-string function must be a coderef!");
422        }
423        if(!SV_IS_CODEREF(set_fromstring_fn)) {
424                croak("From-string function must be a coderef!");
425        }
426
427        owl_variable_dict_newvar_other(owl_global_get_vardict(&g),
428                                       name, summary, description, validsettings,
429                                       perl_closure_new(get_tostring_fn, data, false),
430                                       perl_closure_new(set_fromstring_fn, data, false));
431}
432
433void
434start_edit(edit_type, line, callback)
435        const char *edit_type
436        const char *line
437        SV *callback
438        PREINIT:
439                owl_editwin *e;
440        CODE:
441        {
442                if (!SV_IS_CODEREF(callback))
443                        croak("Callback must be a subref");
444
445                if (!strcmp(edit_type, "question"))
446                        e = owl_function_start_question(line);
447                else if (!strcmp(edit_type, "password"))
448                        e = owl_function_start_password(line);
449                else if (!strcmp(edit_type, "edit_win"))
450                        e = owl_function_start_edit_win(line);
451                else
452                        croak("edit_type must be one of 'password', 'question', 'edit_win', not '%s'", edit_type);
453
454                owl_editwin_set_cbdata(e, newSVsv(callback), owl_perlconfig_dec_refcnt);
455                owl_editwin_set_callback(e, owl_perlconfig_edit_callback);
456        }
457
458int
459zephyr_zwrite(cmd,msg)
460        const char *cmd
461        const char *msg
462        CODE:
463                RETVAL = owl_zwrite_create_and_send_from_line(cmd, msg);
464        OUTPUT:
465                RETVAL
466
467MODULE = BarnOwl                PACKAGE = BarnOwl::Editwin
468
469int
470replace(count, string)
471        int count;
472        const char *string;
473        PREINIT:
474                owl_editwin *e;
475        CODE:
476                e = owl_global_current_typwin(&g);
477                if (e) {
478                        RETVAL = owl_editwin_replace(e, count, string);
479                } else {
480                        RETVAL = 0;
481                }
482        OUTPUT:
483                RETVAL
484
485int
486point_move(delta)
487        int delta;
488        PREINIT:
489                owl_editwin *e;
490        CODE:
491                e = owl_global_current_typwin(&g);
492                if (e) {
493                        RETVAL = owl_editwin_point_move(e, delta);
494                } else {
495                        RETVAL = 0;
496                }
497        OUTPUT:
498                RETVAL
499
500int
501replace_region(string)
502        const char *string;
503        PREINIT:
504                owl_editwin *e;
505        CODE:
506                e = owl_global_current_typwin(&g);
507                if (e) {
508                        RETVAL = owl_editwin_replace_region(e, string);
509                } else {
510                        RETVAL = 0;
511                }
512        OUTPUT:
513                RETVAL
514
515const utf8 *
516get_region()
517        PREINIT:
518                char *region;
519                owl_editwin *e;
520        CODE:
521                e = owl_global_current_typwin(&g);
522                if (e) {
523                        region = owl_editwin_get_region(owl_global_current_typwin(&g));
524                } else {
525                        region = NULL;
526                }
527                RETVAL = region;
528        OUTPUT:
529                RETVAL
530        CLEANUP:
531                g_free(region);
532
533SV *
534save_excursion(sub)
535        SV *sub;
536        PROTOTYPE: &
537        PREINIT:
538                int count;
539                owl_editwin *e;
540                owl_editwin_excursion *x;
541        CODE:
542        {
543                e = owl_global_current_typwin(&g);
544                if(!e)
545                        croak("The edit window is not currently active!");
546
547                x = owl_editwin_begin_excursion(owl_global_current_typwin(&g));
548                PUSHMARK(SP);
549                count = call_sv(sub, G_SCALAR|G_EVAL|G_NOARGS);
550                SPAGAIN;
551                owl_editwin_end_excursion(owl_global_current_typwin(&g), x);
552
553                if(SvTRUE(ERRSV)) {
554                        croak(NULL);
555                }
556
557                if(count == 1)
558                        RETVAL = SvREFCNT_inc(POPs);
559                else
560                        XSRETURN_UNDEF;
561
562        }
563        OUTPUT:
564                RETVAL
565
566int
567current_column()
568        PREINIT:
569                owl_editwin *e;
570        CODE:
571                e = owl_global_current_typwin(&g);
572                if (e) {
573                        RETVAL = owl_editwin_current_column(e);
574                } else {
575                        RETVAL = 0;
576                }
577        OUTPUT:
578                RETVAL
579
580int
581point()
582        PREINIT:
583                owl_editwin *e;
584        CODE:
585                e = owl_global_current_typwin(&g);
586                if (e) {
587                        RETVAL = owl_editwin_get_point(e);
588                } else {
589                        RETVAL = 0;
590                }
591        OUTPUT:
592                RETVAL
593
594int
595mark()
596        PREINIT:
597                owl_editwin *e;
598        CODE:
599                e = owl_global_current_typwin(&g);
600                if (e) {
601                        RETVAL = owl_editwin_get_mark(e);
602                } else {
603                        RETVAL = 0;
604                }
605        OUTPUT:
606                RETVAL
Note: See TracBrowser for help on using the repository browser.