source: perlglue.xs @ 9e596f5

Last change on this file since 9e596f5 was d2ba33c, checked in by Jason Gross <jasongross9@gmail.com>, 7 years ago
Use g_utf8_casefold and g_utf8_normalize We define a convenience function compat_casefold in util.c for reuse in filters.
  • Property mode set to 100644
File size: 12.8 KB
RevLine 
[dd16bdd]1/* -*- mode: c; indent-tabs-mode: t; c-basic-offset: 8 -*- */
[1152d45]2#define OWL_PERL
3#include "owl.h"
[8ee73f8d]4
[db8b00b]5#define SV_IS_CODEREF(sv) (SvROK((sv)) && SvTYPE(SvRV((sv))) == SVt_PVCV)
6
[39e81f7]7typedef char utf8;
8
[74fc22a]9        /*************************************************************
10         * NOTE
11         *************************************************************
12         * These functions, when they are intended to be user-visible,
[fd8dfe7]13         * are documented in perl/lib/BarnOwl.pm. If you add functions
14         * to this file, add the appropriate documentation there!
[74fc22a]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
[25cccdc]20         * manner as possible, to simplify the XS code, put it in
[952f137]21         * BarnOwl::Internal::, and write a perl wrapper in BarnOwl.pm
[25cccdc]22         * that munges the arguments as appropriate and calls the
23         * internal version.
[74fc22a]24         */
[8ee73f8d]25
[65fea01]26MODULE = BarnOwl                PACKAGE = BarnOwl
27
[39e81f7]28const utf8 *
[c4ba74d]29command(cmd, ...)
[e19eb97]30        const char *cmd
[8ee73f8d]31        PREINIT:
32                char *rv = NULL;
[e19eb97]33                const char **argv;
[c4ba74d]34                int i;
[8ee73f8d]35        CODE:
[c4ba74d]36        {
37                if (items == 1) {
38                        rv = owl_function_command(cmd);
39                } else {
[6a71113]40                        /* Ensure this is NULL-terminated. */
41                        argv = g_new0(const char *, items + 1);
[c4ba74d]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);
[ddbbcffa]47                        g_free(argv);
[c4ba74d]48                }
49                RETVAL = rv;
50        }
[8ee73f8d]51        OUTPUT:
52                RETVAL
53        CLEANUP:
[3b8a563]54                g_free(rv);
[8ee73f8d]55
[f1e629d]56SV *
57getcurmsg()
58        CODE:
[19bab8e]59                RETVAL = owl_perlconfig_curmessage2hashref();
60        OUTPUT:
61                RETVAL
[f1e629d]62
63int
64getnumcols()
65        CODE:
66                RETVAL = owl_global_get_cols(&g);
67        OUTPUT:
68                RETVAL
[b303ba2]69
70int
71getnumlines()
72        CODE:
73                RETVAL = owl_global_get_lines(&g);
74        OUTPUT:
75                RETVAL
76
[7f792c1]77time_t
78getidletime()
79        CODE:
80                RETVAL = owl_global_get_idletime(&g);
81        OUTPUT:
82                RETVAL
[f1e629d]83
[39e81f7]84const utf8 *
[f1e629d]85zephyr_getrealm()
86        CODE:
[8a54409]87                RETVAL = owl_zephyr_get_realm();
[f1e629d]88        OUTPUT:
89                RETVAL
90
[39e81f7]91const utf8 *
[f1e629d]92zephyr_getsender()
93        CODE:
[8a54409]94                RETVAL = owl_zephyr_get_sender();
[f1e629d]95        OUTPUT:
96                RETVAL
97
[39e81f7]98const utf8 *
[e1c4636]99ztext_stylestrip(ztext)
[e19eb97]100        const char *ztext
[e1c4636]101        PREINIT:
102                char *rv = NULL;
103        CODE:
[1fd0b25]104                rv = owl_function_ztext_stylestrip(ztext);
[e1c4636]105                RETVAL = rv;
106        OUTPUT:
107                RETVAL
108        CLEANUP:
[3b8a563]109                g_free(rv);
[e1c4636]110
[39e81f7]111const utf8 *
[740d5f7]112zephyr_smartstrip_user(in)
[e19eb97]113        const char *in
[740d5f7]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:
[ddbbcffa]124                g_free(rv);
[740d5f7]125
[39e81f7]126const utf8 *
[acb13bb]127zephyr_getsubs()
128        PREINIT:
129                char *rv = NULL;
130        CODE:
131                rv = owl_zephyr_getsubs();
132                RETVAL = rv;
133    OUTPUT:
134                RETVAL
135    CLEANUP:
[3b8a563]136                g_free(rv);
[acb13bb]137
[a130fc5]138SV *
[5791bf7]139queue_message(msg)
[dd16bdd]140        SV *msg
141        PREINIT:
142                owl_message *m;
143        CODE:
[1b6b2f3]144        {
[dd16bdd]145                if(!SvROK(msg) || SvTYPE(SvRV(msg)) != SVt_PVHV) {
[3066d23]146                        croak("Usage: BarnOwl::queue_message($message)");
[dd16bdd]147                }
[17eed9c]148
[30678ae]149                m = owl_perlconfig_hashref2message(msg);
[dd16bdd]150
151                owl_global_messagequeue_addmsg(&g, m);
[a130fc5]152
153                RETVAL = owl_perlconfig_message2hashref(m);
[1b6b2f3]154        }
[a130fc5]155        OUTPUT:
156                RETVAL
[db8b00b]157
[5791bf7]158void
159admin_message(header, body)
[e19eb97]160        const char *header
161        const char *body
[1c2e0b3]162        CODE:
163        {
164                owl_function_adminmsg(header, body);           
165        }
166
[6b3f797]167
[e19eb97]168const char * 
[6b3f797]169get_data_dir ()
170        CODE:
[ba6c8bd]171                RETVAL = owl_get_datadir();
[6b3f797]172        OUTPUT:
173        RETVAL
[b6a253c]174
[e19eb97]175const char * 
[b363d83]176get_config_dir ()
177        CODE:
[ba6c8bd]178                RETVAL = owl_global_get_confdir(&g);
[b363d83]179        OUTPUT:
180        RETVAL 
181
[b6a253c]182void
183popless_text(text) 
[e19eb97]184        const char *text
[b6a253c]185        CODE:
186        {
187                owl_function_popless_text(text);
188        }
189
190void
191popless_ztext(text) 
[e19eb97]192        const char *text
[b6a253c]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);
[7ab0020]199                owl_fmtext_cleanup(&fm);
[b6a253c]200        }
[0ff2528]201
202void
203error(text) 
[e19eb97]204        const char *text
[0ff2528]205        CODE:
206        {
207                owl_function_error("%s", text);
208        }
[b6c067a]209
210void
[eede1bf]211debug(text)
[e19eb97]212        const char *text
[eede1bf]213        CODE:
214        {
215                owl_function_debugmsg("%s", text);
216        }
217
218void
[747d6a5]219message(text)
[e19eb97]220        const char *text
[747d6a5]221        CODE:
222        {
223                owl_function_makemsg("%s", text);
224        }
225
226void
[b67ab6b]227create_style(name, object)
[e19eb97]228     const char *name
[864ed35]229     SV  *object
[b6c067a]230     PREINIT:
231                owl_style *s;
232     CODE:
233        {
[7dcef03]234                s = g_slice_new(owl_style);
[fde6d80]235                owl_style_create_perl(s, name, newSVsv(object));
[b6c067a]236                owl_global_add_style(&g, s);
237        }
[c2c5c77]238
239int
240getnumcolors()
241        CODE:
242                RETVAL = owl_function_get_color_count();
243        OUTPUT:
244                RETVAL
245
246void
247_remove_filter(filterName)
[e19eb97]248        const char *filterName
[c2c5c77]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        }
[f6b319c]257
[1ced34f]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
[39e81f7]284const utf8 *
[f6b319c]285wordwrap(in, cols)
[e19eb97]286        const char *in
[f6b319c]287        int cols
288        PREINIT:
289                char *rv = NULL;
290        CODE:
[a695a68]291                rv = owl_text_wordwrap(in, cols);
[f6b319c]292                RETVAL = rv;   
293        OUTPUT:
294                RETVAL
295        CLEANUP:
[3b8a563]296                g_free(rv);
[a695a68]297
[d77e909]298AV*
299all_filters()
300        PREINIT:
[ce68f23]301                GPtrArray *fl;
[d77e909]302        CODE:
303        {
[ce68f23]304                fl = owl_dict_get_keys(&g.filters);
305                RETVAL = owl_new_av(fl, (SV*(*)(const void*))owl_new_sv);
[d77e909]306                sv_2mortal((SV*)RETVAL);
[ce68f23]307                owl_ptr_array_free(fl, g_free);
[d77e909]308        }
309        OUTPUT:
310                RETVAL
311
[3ff3d86]312AV*
313all_styles()
314        PREINIT:
[ce68f23]315                GPtrArray *l;
[3ff3d86]316        CODE:
317        {
[ce68f23]318                l = owl_global_get_style_names(&g);
319                RETVAL = owl_new_av(l, (SV*(*)(const void*))owl_new_sv);
[3ff3d86]320                sv_2mortal((SV*)RETVAL);
321        }
322        OUTPUT:
323                RETVAL
324        CLEANUP:
[ce68f23]325                owl_ptr_array_free(l, g_free);
[3ff3d86]326
327
328AV*
329all_variables()
330        PREINIT:
[ce68f23]331                GPtrArray *l;
[3ff3d86]332        CODE:
333        {
[ce68f23]334                l = owl_dict_get_keys(owl_global_get_vardict(&g));
335                RETVAL = owl_new_av(l, (SV*(*)(const void*))owl_new_sv);
[fe7616e]336                sv_2mortal((SV*)RETVAL);
337        }
338        OUTPUT:
339                RETVAL
340        CLEANUP:
[ce68f23]341                owl_ptr_array_free(l, g_free);
[fe7616e]342
343
344AV*
345all_keymaps()
346        PREINIT:
[ce68f23]347                GPtrArray *l;
[fe7616e]348                const owl_keyhandler *kh;
349        CODE:
350        {
351                kh = owl_global_get_keyhandler(&g);
[ce68f23]352                l = owl_keyhandler_get_keymap_names(kh);
353                RETVAL = owl_new_av(l, (SV*(*)(const void*))owl_new_sv);
[3ff3d86]354                sv_2mortal((SV*)RETVAL);
355        }
356        OUTPUT:
357                RETVAL
358        CLEANUP:
[ce68f23]359                owl_ptr_array_free(l, g_free);
[3ff3d86]360
[4df918b]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
[fbadb37]370const char *
[bb79a52]371get_zephyr_variable(name)
[9cb03bf]372        const char *name;
[bb79a52]373        CODE:
[fbadb37]374                RETVAL = owl_zephyr_get_variable(name);
[bb79a52]375        OUTPUT:
376                RETVAL
377
[39e81f7]378const utf8 *
[9e5b5fd]379skiptokens(str, n)
380        const char *str;
381        int n;
382        CODE:
383                RETVAL = skiptokens(str, n);
384        OUTPUT:
385                RETVAL
386
[81e93c3]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
[d2ba33c]415const utf8 *
416compat_casefold(in)
417        const char * in
418        PREINIT:
419                char *rv;
420        CODE:
421                rv = owl_util_compat_casefold(in);
422                RETVAL = rv;
423        OUTPUT:
424                RETVAL
425        CLEANUP:
426                g_free(rv);
427
[9e5b5fd]428
[6f0fbe9]429MODULE = BarnOwl                PACKAGE = BarnOwl::Zephyr
430
431int
432have_zephyr()
433        CODE:
434                RETVAL = owl_global_is_havezephyr(&g);
435        OUTPUT:
436                RETVAL
[9e5b5fd]437
[25cccdc]438MODULE = BarnOwl                PACKAGE = BarnOwl::Internal
439
440
[ae2b830]441int
442file_deleteline(filename, line, backup)
443        const char *filename
444        const char *line
445        int backup
446        CODE:
447                RETVAL = owl_util_file_deleteline(filename, line, backup);
448        OUTPUT:
449                RETVAL
450
[da7341e]451const utf8 *
452makepath(in)
453        const char * in
454        PREINIT:
455                char *rv;
456        CODE:
457                rv = owl_util_makepath(in);
458                RETVAL = rv;
459        OUTPUT:
460                RETVAL
461        CLEANUP:
462                g_free(rv);
463
[25cccdc]464void
465new_command(name, func, summary, usage, description)
466        char *name
467        SV *func
468        char *summary
469        char *usage
470        char *description
471        PREINIT:
472                owl_cmd cmd;
473        CODE:
474        {
475                if(!SV_IS_CODEREF(func)) {
476                        croak("Command function must be a coderef!");
477                }
478                cmd.name = name;
[2fec14b]479                cmd.cmd_perl = newSVsv(func);
[25cccdc]480                cmd.summary = summary;
481                cmd.usage = usage;
482                cmd.description = description;
483                cmd.validctx = OWL_CTX_ANY;
484                cmd.cmd_aliased_to = NULL;
485                cmd.cmd_args_fn = NULL;
486                cmd.cmd_v_fn = NULL;
487                cmd.cmd_i_fn = NULL;
488                cmd.cmd_ctxargs_fn = NULL;
489                cmd.cmd_ctxv_fn = NULL;
490                cmd.cmd_ctxi_fn = NULL;
491                owl_cmddict_add_cmd(owl_global_get_cmddict(&g), &cmd);
492           }
493
[06e04a9]494
495MODULE = BarnOwl                PACKAGE = BarnOwl::Internal
496
497void
[3b9ca71]498new_variable(name, summary, description, validsettings, takes_on_off, get_tostring_fn, set_fromstring_fn, data)
[06e04a9]499    const char *name
500    const char *summary
[69f74c2]501    const char *description
502    const char *validsettings
[3b9ca71]503    int takes_on_off
[69f74c2]504    SV *get_tostring_fn
505    SV *set_fromstring_fn
[06e04a9]506    SV *data
507    CODE:
508{
[69f74c2]509        /* data is somewhat redundant given we can create closures, but oh
510         * well. Might be convenient sometimes. */
511        if(!SV_IS_CODEREF(get_tostring_fn)) {
[06e04a9]512                croak("To-string function must be a coderef!");
513        }
[69f74c2]514        if(!SV_IS_CODEREF(set_fromstring_fn)) {
[06e04a9]515                croak("From-string function must be a coderef!");
516        }
517
[69f74c2]518        owl_variable_dict_newvar_other(owl_global_get_vardict(&g),
[3b9ca71]519                                       name, summary, description, validsettings, takes_on_off,
[69f74c2]520                                       perl_closure_new(get_tostring_fn, data, false),
521                                       perl_closure_new(set_fromstring_fn, data, false));
522}
[1631825]523
[e89ec48]524void
525start_edit(edit_type, line, callback)
526        const char *edit_type
527        const char *line
528        SV *callback
529        PREINIT:
530                owl_editwin *e;
531        CODE:
532        {
533                if (!SV_IS_CODEREF(callback))
534                        croak("Callback must be a subref");
535
536                if (!strcmp(edit_type, "question"))
537                        e = owl_function_start_question(line);
538                else if (!strcmp(edit_type, "password"))
539                        e = owl_function_start_password(line);
540                else if (!strcmp(edit_type, "edit_win"))
541                        e = owl_function_start_edit_win(line);
542                else
543                        croak("edit_type must be one of 'password', 'question', 'edit_win', not '%s'", edit_type);
544
545                owl_editwin_set_cbdata(e, newSVsv(callback), owl_perlconfig_dec_refcnt);
546                owl_editwin_set_callback(e, owl_perlconfig_edit_callback);
547        }
548
[374089a]549int
550zephyr_zwrite(cmd,msg)
551        const char *cmd
552        const char *msg
553        CODE:
554                RETVAL = owl_zwrite_create_and_send_from_line(cmd, msg);
555        OUTPUT:
556                RETVAL
557
[0190c4d]558MODULE = BarnOwl                PACKAGE = BarnOwl::Editwin
559
[77f605d]560int
561replace(count, string)
562        int count;
[e19eb97]563        const char *string;
[38cc669]564        PREINIT:
565                owl_editwin *e;
[77f605d]566        CODE:
[818f19c]567                e = owl_global_current_typwin(&g);
[38cc669]568                if (e) {
569                        RETVAL = owl_editwin_replace(e, count, string);
570                } else {
571                        RETVAL = 0;
572                }
[77f605d]573        OUTPUT:
574                RETVAL
575
576int
577point_move(delta)
578        int delta;
[38cc669]579        PREINIT:
580                owl_editwin *e;
[77f605d]581        CODE:
[818f19c]582                e = owl_global_current_typwin(&g);
[38cc669]583                if (e) {
584                        RETVAL = owl_editwin_point_move(e, delta);
585                } else {
586                        RETVAL = 0;
587                }
[77f605d]588        OUTPUT:
589                RETVAL
[a88f35a]590
591int
592replace_region(string)
[e19eb97]593        const char *string;
[38cc669]594        PREINIT:
595                owl_editwin *e;
[a88f35a]596        CODE:
[818f19c]597                e = owl_global_current_typwin(&g);
[38cc669]598                if (e) {
599                        RETVAL = owl_editwin_replace_region(e, string);
600                } else {
601                        RETVAL = 0;
602                }
[a88f35a]603        OUTPUT:
604                RETVAL
605
[39e81f7]606const utf8 *
[d41294a]607get_region()
608        PREINIT:
609                char *region;
[38cc669]610                owl_editwin *e;
[d41294a]611        CODE:
[818f19c]612                e = owl_global_current_typwin(&g);
[38cc669]613                if (e) {
[818f19c]614                        region = owl_editwin_get_region(owl_global_current_typwin(&g));
[38cc669]615                } else {
616                        region = NULL;
617                }
[d41294a]618                RETVAL = region;
619        OUTPUT:
620                RETVAL
621        CLEANUP:
[ddbbcffa]622                g_free(region);
[d41294a]623
[a88f35a]624SV *
625save_excursion(sub)
626        SV *sub;
627        PROTOTYPE: &
628        PREINIT:
629                int count;
[38cc669]630                owl_editwin *e;
[a88f35a]631                owl_editwin_excursion *x;
632        CODE:
633        {
[818f19c]634                e = owl_global_current_typwin(&g);
[38cc669]635                if(!e)
636                        croak("The edit window is not currently active!");
637
[818f19c]638                x = owl_editwin_begin_excursion(owl_global_current_typwin(&g));
[6dc2d6b]639                PUSHMARK(SP);
[a88f35a]640                count = call_sv(sub, G_SCALAR|G_EVAL|G_NOARGS);
[6dc2d6b]641                SPAGAIN;
[818f19c]642                owl_editwin_end_excursion(owl_global_current_typwin(&g), x);
[a88f35a]643
644                if(SvTRUE(ERRSV)) {
645                        croak(NULL);
646                }
647
648                if(count == 1)
649                        RETVAL = SvREFCNT_inc(POPs);
650                else
651                        XSRETURN_UNDEF;
652
653        }
654        OUTPUT:
655                RETVAL
[d41294a]656
657int
658current_column()
[38cc669]659        PREINIT:
660                owl_editwin *e;
[d41294a]661        CODE:
[818f19c]662                e = owl_global_current_typwin(&g);
[38cc669]663                if (e) {
664                        RETVAL = owl_editwin_current_column(e);
665                } else {
666                        RETVAL = 0;
667                }
[d41294a]668        OUTPUT:
669                RETVAL
670
671int
672point()
[38cc669]673        PREINIT:
674                owl_editwin *e;
[d41294a]675        CODE:
[818f19c]676                e = owl_global_current_typwin(&g);
[38cc669]677                if (e) {
678                        RETVAL = owl_editwin_get_point(e);
679                } else {
680                        RETVAL = 0;
681                }
[d41294a]682        OUTPUT:
683                RETVAL
684
685int
686mark()
[38cc669]687        PREINIT:
688                owl_editwin *e;
[d41294a]689        CODE:
[818f19c]690                e = owl_global_current_typwin(&g);
[38cc669]691                if (e) {
692                        RETVAL = owl_editwin_get_mark(e);
693                } else {
694                        RETVAL = 0;
695                }
[d41294a]696        OUTPUT:
697                RETVAL
[5093c6f]698
699MODULE = BarnOwl                PACKAGE = BarnOwl::Logging
700
701void
702enqueue_text(log_text, filename)
703        const char * log_text
704        const char * filename
705        CODE:
706                owl_log_enqueue_message(log_text, filename);
Note: See TracBrowser for help on using the repository browser.