source: perlglue.xs @ e7ab1d7

Last change on this file since e7ab1d7 was e7ab1d7, checked in by Jason Gross <jgross@mit.edu>, 8 years ago
Made owl_util_makepath available from perl There's probably a better way to do this. Maybe sub makepath { my $filename = shift; $filename =~ s{ ^ ~ ( [^/]* ) } { $1 ? (getpwnam($1))[7] : ( $ENV{HOME} || $ENV{LOGDIR} || (getpwuid($>))[7] ) }ex; return $filename; } (http://docstore.mik.ua/orelly/perl/cookbook/ch07_04.htm) or something. Additionally, I'm not sure why PREINIT: char *rv = NULL; CODE: { rv = foo(); RETVAL = rv; } OUTPUT: RETVAL CLEANUP: g_free(rv); is the paradigm for functions returning strings, when foo returns `char *` and not `const char *`. I've removed the `= NULL` part of the initlization, which I assume is left over from when we had to NULL-check things before freeing them, but I've copied the rest of the code.
  • Property mode set to 100644
File size: 11.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_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
387
388MODULE = BarnOwl                PACKAGE = BarnOwl::Zephyr
389
390int
391have_zephyr()
392        CODE:
393                RETVAL = owl_global_is_havezephyr(&g);
394        OUTPUT:
395                RETVAL
396
397MODULE = BarnOwl                PACKAGE = BarnOwl::Internal
398
399
400int
401file_deleteline(filename, line, backup)
402        const char *filename
403        const char *line
404        int backup
405        CODE:
406                RETVAL = owl_util_file_deleteline(filename, line, backup);
407        OUTPUT:
408                RETVAL
409
410const utf8 *
411makepath(in)
412        const char * in
413        PREINIT:
414                char *rv;
415        CODE:
416                rv = owl_util_makepath(in);
417                RETVAL = rv;
418        OUTPUT:
419                RETVAL
420        CLEANUP:
421                g_free(rv);
422
423void
424new_command(name, func, summary, usage, description)
425        char *name
426        SV *func
427        char *summary
428        char *usage
429        char *description
430        PREINIT:
431                owl_cmd cmd;
432        CODE:
433        {
434                if(!SV_IS_CODEREF(func)) {
435                        croak("Command function must be a coderef!");
436                }
437                cmd.name = name;
438                cmd.cmd_perl = newSVsv(func);
439                cmd.summary = summary;
440                cmd.usage = usage;
441                cmd.description = description;
442                cmd.validctx = OWL_CTX_ANY;
443                cmd.cmd_aliased_to = NULL;
444                cmd.cmd_args_fn = NULL;
445                cmd.cmd_v_fn = NULL;
446                cmd.cmd_i_fn = NULL;
447                cmd.cmd_ctxargs_fn = NULL;
448                cmd.cmd_ctxv_fn = NULL;
449                cmd.cmd_ctxi_fn = NULL;
450                owl_cmddict_add_cmd(owl_global_get_cmddict(&g), &cmd);
451           }
452
453
454MODULE = BarnOwl                PACKAGE = BarnOwl::Internal
455
456void
457new_variable(name, summary, description, validsettings, takes_on_off, get_tostring_fn, set_fromstring_fn, data)
458    const char *name
459    const char *summary
460    const char *description
461    const char *validsettings
462    int takes_on_off
463    SV *get_tostring_fn
464    SV *set_fromstring_fn
465    SV *data
466    CODE:
467{
468        /* data is somewhat redundant given we can create closures, but oh
469         * well. Might be convenient sometimes. */
470        if(!SV_IS_CODEREF(get_tostring_fn)) {
471                croak("To-string function must be a coderef!");
472        }
473        if(!SV_IS_CODEREF(set_fromstring_fn)) {
474                croak("From-string function must be a coderef!");
475        }
476
477        owl_variable_dict_newvar_other(owl_global_get_vardict(&g),
478                                       name, summary, description, validsettings, takes_on_off,
479                                       perl_closure_new(get_tostring_fn, data, false),
480                                       perl_closure_new(set_fromstring_fn, data, false));
481}
482
483void
484start_edit(edit_type, line, callback)
485        const char *edit_type
486        const char *line
487        SV *callback
488        PREINIT:
489                owl_editwin *e;
490        CODE:
491        {
492                if (!SV_IS_CODEREF(callback))
493                        croak("Callback must be a subref");
494
495                if (!strcmp(edit_type, "question"))
496                        e = owl_function_start_question(line);
497                else if (!strcmp(edit_type, "password"))
498                        e = owl_function_start_password(line);
499                else if (!strcmp(edit_type, "edit_win"))
500                        e = owl_function_start_edit_win(line);
501                else
502                        croak("edit_type must be one of 'password', 'question', 'edit_win', not '%s'", edit_type);
503
504                owl_editwin_set_cbdata(e, newSVsv(callback), owl_perlconfig_dec_refcnt);
505                owl_editwin_set_callback(e, owl_perlconfig_edit_callback);
506        }
507
508int
509zephyr_zwrite(cmd,msg)
510        const char *cmd
511        const char *msg
512        CODE:
513                RETVAL = owl_zwrite_create_and_send_from_line(cmd, msg);
514        OUTPUT:
515                RETVAL
516
517MODULE = BarnOwl                PACKAGE = BarnOwl::Editwin
518
519int
520replace(count, string)
521        int count;
522        const char *string;
523        PREINIT:
524                owl_editwin *e;
525        CODE:
526                e = owl_global_current_typwin(&g);
527                if (e) {
528                        RETVAL = owl_editwin_replace(e, count, string);
529                } else {
530                        RETVAL = 0;
531                }
532        OUTPUT:
533                RETVAL
534
535int
536point_move(delta)
537        int delta;
538        PREINIT:
539                owl_editwin *e;
540        CODE:
541                e = owl_global_current_typwin(&g);
542                if (e) {
543                        RETVAL = owl_editwin_point_move(e, delta);
544                } else {
545                        RETVAL = 0;
546                }
547        OUTPUT:
548                RETVAL
549
550int
551replace_region(string)
552        const char *string;
553        PREINIT:
554                owl_editwin *e;
555        CODE:
556                e = owl_global_current_typwin(&g);
557                if (e) {
558                        RETVAL = owl_editwin_replace_region(e, string);
559                } else {
560                        RETVAL = 0;
561                }
562        OUTPUT:
563                RETVAL
564
565const utf8 *
566get_region()
567        PREINIT:
568                char *region;
569                owl_editwin *e;
570        CODE:
571                e = owl_global_current_typwin(&g);
572                if (e) {
573                        region = owl_editwin_get_region(owl_global_current_typwin(&g));
574                } else {
575                        region = NULL;
576                }
577                RETVAL = region;
578        OUTPUT:
579                RETVAL
580        CLEANUP:
581                g_free(region);
582
583SV *
584save_excursion(sub)
585        SV *sub;
586        PROTOTYPE: &
587        PREINIT:
588                int count;
589                owl_editwin *e;
590                owl_editwin_excursion *x;
591        CODE:
592        {
593                e = owl_global_current_typwin(&g);
594                if(!e)
595                        croak("The edit window is not currently active!");
596
597                x = owl_editwin_begin_excursion(owl_global_current_typwin(&g));
598                PUSHMARK(SP);
599                count = call_sv(sub, G_SCALAR|G_EVAL|G_NOARGS);
600                SPAGAIN;
601                owl_editwin_end_excursion(owl_global_current_typwin(&g), x);
602
603                if(SvTRUE(ERRSV)) {
604                        croak(NULL);
605                }
606
607                if(count == 1)
608                        RETVAL = SvREFCNT_inc(POPs);
609                else
610                        XSRETURN_UNDEF;
611
612        }
613        OUTPUT:
614                RETVAL
615
616int
617current_column()
618        PREINIT:
619                owl_editwin *e;
620        CODE:
621                e = owl_global_current_typwin(&g);
622                if (e) {
623                        RETVAL = owl_editwin_current_column(e);
624                } else {
625                        RETVAL = 0;
626                }
627        OUTPUT:
628                RETVAL
629
630int
631point()
632        PREINIT:
633                owl_editwin *e;
634        CODE:
635                e = owl_global_current_typwin(&g);
636                if (e) {
637                        RETVAL = owl_editwin_get_point(e);
638                } else {
639                        RETVAL = 0;
640                }
641        OUTPUT:
642                RETVAL
643
644int
645mark()
646        PREINIT:
647                owl_editwin *e;
648        CODE:
649                e = owl_global_current_typwin(&g);
650                if (e) {
651                        RETVAL = owl_editwin_get_mark(e);
652                } else {
653                        RETVAL = 0;
654                }
655        OUTPUT:
656                RETVAL
Note: See TracBrowser for help on using the repository browser.