source: perlglue.xs @ e38f315

Last change on this file since e38f315 was 81e93c3, checked in by Jason Gross <jasongross9@gmail.com>, 7 years ago
Add BarnOwl::get_variable_info Returns a dictionary about a given variable.
  • Property mode set to 100644
File size: 12.3 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_slice_new(owl_style);
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
258bool
259message_matches_filter(message, filter_name, quiet = false)
260        SV *message
261        const char *filter_name
262        bool quiet
263        PREINIT:
264                owl_message *m;
265                const owl_filter *f;
266        CODE:
267        {
268                if (!SvROK(message) || SvTYPE(SvRV(message)) != SVt_PVHV) {
269                        croak("Usage: BarnOwl::message_matches_filter($message, $filter_name[, $quiet])");
270                }
271
272                m = owl_perlconfig_hashref2message(message);
273                f = owl_global_get_filter(&g, filter_name);
274                if (!f && !quiet) {
275                        owl_function_error("%s filter is not defined", filter_name);
276                }
277                RETVAL = f && owl_filter_message_match(f, m);
278        }
279        OUTPUT:
280                RETVAL
281        CLEANUP:
282                owl_message_delete(m);
283
284const utf8 *
285wordwrap(in, cols)
286        const char *in
287        int cols
288        PREINIT:
289                char *rv = NULL;
290        CODE:
291                rv = owl_text_wordwrap(in, cols);
292                RETVAL = rv;   
293        OUTPUT:
294                RETVAL
295        CLEANUP:
296                g_free(rv);
297
298AV*
299all_filters()
300        PREINIT:
301                GPtrArray *fl;
302        CODE:
303        {
304                fl = owl_dict_get_keys(&g.filters);
305                RETVAL = owl_new_av(fl, (SV*(*)(const void*))owl_new_sv);
306                sv_2mortal((SV*)RETVAL);
307                owl_ptr_array_free(fl, g_free);
308        }
309        OUTPUT:
310                RETVAL
311
312AV*
313all_styles()
314        PREINIT:
315                GPtrArray *l;
316        CODE:
317        {
318                l = owl_global_get_style_names(&g);
319                RETVAL = owl_new_av(l, (SV*(*)(const void*))owl_new_sv);
320                sv_2mortal((SV*)RETVAL);
321        }
322        OUTPUT:
323                RETVAL
324        CLEANUP:
325                owl_ptr_array_free(l, g_free);
326
327
328AV*
329all_variables()
330        PREINIT:
331                GPtrArray *l;
332        CODE:
333        {
334                l = owl_dict_get_keys(owl_global_get_vardict(&g));
335                RETVAL = owl_new_av(l, (SV*(*)(const void*))owl_new_sv);
336                sv_2mortal((SV*)RETVAL);
337        }
338        OUTPUT:
339                RETVAL
340        CLEANUP:
341                owl_ptr_array_free(l, g_free);
342
343
344AV*
345all_keymaps()
346        PREINIT:
347                GPtrArray *l;
348                const owl_keyhandler *kh;
349        CODE:
350        {
351                kh = owl_global_get_keyhandler(&g);
352                l = owl_keyhandler_get_keymap_names(kh);
353                RETVAL = owl_new_av(l, (SV*(*)(const void*))owl_new_sv);
354                sv_2mortal((SV*)RETVAL);
355        }
356        OUTPUT:
357                RETVAL
358        CLEANUP:
359                owl_ptr_array_free(l, g_free);
360
361void
362redisplay()
363        CODE:
364        {
365                owl_messagelist_invalidate_formats(owl_global_get_msglist(&g));
366                owl_function_calculate_topmsg(OWL_DIRECTION_DOWNWARDS);
367                owl_mainwin_redisplay(owl_global_get_mainwin(&g));
368        }
369
370const char *
371get_zephyr_variable(name)
372        const char *name;
373        CODE:
374                RETVAL = owl_zephyr_get_variable(name);
375        OUTPUT:
376                RETVAL
377
378const utf8 *
379skiptokens(str, n)
380        const char *str;
381        int n;
382        CODE:
383                RETVAL = skiptokens(str, n);
384        OUTPUT:
385                RETVAL
386
387SV *
388get_variable_info(name)
389        const char *name;
390        PREINIT:
391                owl_variable *var;
392                HV *h;
393        CODE:
394                var = owl_variable_get_var(owl_global_get_vardict(&g), name);
395                if (var == NULL) {
396                        croak("No such variable");
397                }
398                h = newHV();
399                (void)hv_store(h, "name", strlen("name"),
400                               owl_new_sv(owl_variable_get_name(var)), 0);
401                (void)hv_store(h, "description", strlen("description"),
402                               owl_new_sv(owl_variable_get_description(var)),
403                               0);
404                (void)hv_store(h, "summary", strlen("summary"),
405                               owl_new_sv(owl_variable_get_summary(var)), 0);
406                (void)hv_store(h, "validsettings", strlen("validsettings"),
407                               owl_new_sv(owl_variable_get_validsettings(var)),
408                               0);
409                (void)hv_store(h, "takes_on_off", strlen("takes_on_off"),
410                               newSViv(owl_variable_takes_on_off(var)), 0);
411                RETVAL = newRV_noinc((SV*)h);
412        OUTPUT:
413                RETVAL
414
415
416MODULE = BarnOwl                PACKAGE = BarnOwl::Zephyr
417
418int
419have_zephyr()
420        CODE:
421                RETVAL = owl_global_is_havezephyr(&g);
422        OUTPUT:
423                RETVAL
424
425MODULE = BarnOwl                PACKAGE = BarnOwl::Internal
426
427
428int
429file_deleteline(filename, line, backup)
430        const char *filename
431        const char *line
432        int backup
433        CODE:
434                RETVAL = owl_util_file_deleteline(filename, line, backup);
435        OUTPUT:
436                RETVAL
437
438void
439new_command(name, func, summary, usage, description)
440        char *name
441        SV *func
442        char *summary
443        char *usage
444        char *description
445        PREINIT:
446                owl_cmd cmd;
447        CODE:
448        {
449                if(!SV_IS_CODEREF(func)) {
450                        croak("Command function must be a coderef!");
451                }
452                cmd.name = name;
453                cmd.cmd_perl = newSVsv(func);
454                cmd.summary = summary;
455                cmd.usage = usage;
456                cmd.description = description;
457                cmd.validctx = OWL_CTX_ANY;
458                cmd.cmd_aliased_to = NULL;
459                cmd.cmd_args_fn = NULL;
460                cmd.cmd_v_fn = NULL;
461                cmd.cmd_i_fn = NULL;
462                cmd.cmd_ctxargs_fn = NULL;
463                cmd.cmd_ctxv_fn = NULL;
464                cmd.cmd_ctxi_fn = NULL;
465                owl_cmddict_add_cmd(owl_global_get_cmddict(&g), &cmd);
466           }
467
468
469MODULE = BarnOwl                PACKAGE = BarnOwl::Internal
470
471void
472new_variable(name, summary, description, validsettings, takes_on_off, get_tostring_fn, set_fromstring_fn, data)
473    const char *name
474    const char *summary
475    const char *description
476    const char *validsettings
477    int takes_on_off
478    SV *get_tostring_fn
479    SV *set_fromstring_fn
480    SV *data
481    CODE:
482{
483        /* data is somewhat redundant given we can create closures, but oh
484         * well. Might be convenient sometimes. */
485        if(!SV_IS_CODEREF(get_tostring_fn)) {
486                croak("To-string function must be a coderef!");
487        }
488        if(!SV_IS_CODEREF(set_fromstring_fn)) {
489                croak("From-string function must be a coderef!");
490        }
491
492        owl_variable_dict_newvar_other(owl_global_get_vardict(&g),
493                                       name, summary, description, validsettings, takes_on_off,
494                                       perl_closure_new(get_tostring_fn, data, false),
495                                       perl_closure_new(set_fromstring_fn, data, false));
496}
497
498void
499start_edit(edit_type, line, callback)
500        const char *edit_type
501        const char *line
502        SV *callback
503        PREINIT:
504                owl_editwin *e;
505        CODE:
506        {
507                if (!SV_IS_CODEREF(callback))
508                        croak("Callback must be a subref");
509
510                if (!strcmp(edit_type, "question"))
511                        e = owl_function_start_question(line);
512                else if (!strcmp(edit_type, "password"))
513                        e = owl_function_start_password(line);
514                else if (!strcmp(edit_type, "edit_win"))
515                        e = owl_function_start_edit_win(line);
516                else
517                        croak("edit_type must be one of 'password', 'question', 'edit_win', not '%s'", edit_type);
518
519                owl_editwin_set_cbdata(e, newSVsv(callback), owl_perlconfig_dec_refcnt);
520                owl_editwin_set_callback(e, owl_perlconfig_edit_callback);
521        }
522
523int
524zephyr_zwrite(cmd,msg)
525        const char *cmd
526        const char *msg
527        CODE:
528                RETVAL = owl_zwrite_create_and_send_from_line(cmd, msg);
529        OUTPUT:
530                RETVAL
531
532MODULE = BarnOwl                PACKAGE = BarnOwl::Editwin
533
534int
535replace(count, string)
536        int count;
537        const char *string;
538        PREINIT:
539                owl_editwin *e;
540        CODE:
541                e = owl_global_current_typwin(&g);
542                if (e) {
543                        RETVAL = owl_editwin_replace(e, count, string);
544                } else {
545                        RETVAL = 0;
546                }
547        OUTPUT:
548                RETVAL
549
550int
551point_move(delta)
552        int delta;
553        PREINIT:
554                owl_editwin *e;
555        CODE:
556                e = owl_global_current_typwin(&g);
557                if (e) {
558                        RETVAL = owl_editwin_point_move(e, delta);
559                } else {
560                        RETVAL = 0;
561                }
562        OUTPUT:
563                RETVAL
564
565int
566replace_region(string)
567        const char *string;
568        PREINIT:
569                owl_editwin *e;
570        CODE:
571                e = owl_global_current_typwin(&g);
572                if (e) {
573                        RETVAL = owl_editwin_replace_region(e, string);
574                } else {
575                        RETVAL = 0;
576                }
577        OUTPUT:
578                RETVAL
579
580const utf8 *
581get_region()
582        PREINIT:
583                char *region;
584                owl_editwin *e;
585        CODE:
586                e = owl_global_current_typwin(&g);
587                if (e) {
588                        region = owl_editwin_get_region(owl_global_current_typwin(&g));
589                } else {
590                        region = NULL;
591                }
592                RETVAL = region;
593        OUTPUT:
594                RETVAL
595        CLEANUP:
596                g_free(region);
597
598SV *
599save_excursion(sub)
600        SV *sub;
601        PROTOTYPE: &
602        PREINIT:
603                int count;
604                owl_editwin *e;
605                owl_editwin_excursion *x;
606        CODE:
607        {
608                e = owl_global_current_typwin(&g);
609                if(!e)
610                        croak("The edit window is not currently active!");
611
612                x = owl_editwin_begin_excursion(owl_global_current_typwin(&g));
613                PUSHMARK(SP);
614                count = call_sv(sub, G_SCALAR|G_EVAL|G_NOARGS);
615                SPAGAIN;
616                owl_editwin_end_excursion(owl_global_current_typwin(&g), x);
617
618                if(SvTRUE(ERRSV)) {
619                        croak(NULL);
620                }
621
622                if(count == 1)
623                        RETVAL = SvREFCNT_inc(POPs);
624                else
625                        XSRETURN_UNDEF;
626
627        }
628        OUTPUT:
629                RETVAL
630
631int
632current_column()
633        PREINIT:
634                owl_editwin *e;
635        CODE:
636                e = owl_global_current_typwin(&g);
637                if (e) {
638                        RETVAL = owl_editwin_current_column(e);
639                } else {
640                        RETVAL = 0;
641                }
642        OUTPUT:
643                RETVAL
644
645int
646point()
647        PREINIT:
648                owl_editwin *e;
649        CODE:
650                e = owl_global_current_typwin(&g);
651                if (e) {
652                        RETVAL = owl_editwin_get_point(e);
653                } else {
654                        RETVAL = 0;
655                }
656        OUTPUT:
657                RETVAL
658
659int
660mark()
661        PREINIT:
662                owl_editwin *e;
663        CODE:
664                e = owl_global_current_typwin(&g);
665                if (e) {
666                        RETVAL = owl_editwin_get_mark(e);
667                } else {
668                        RETVAL = 0;
669                }
670        OUTPUT:
671                RETVAL
Note: See TracBrowser for help on using the repository browser.