source: perlglue.xs @ 11d55e5

Last change on this file since 11d55e5 was 11d55e5, checked in by Jason Gross <jgross@mit.edu>, 13 years ago
Improved consistency between owl_function_start_* functions
  • Property mode set to 100644
File size: 10.7 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
[7f792c1]69               
70time_t
71getidletime()
72        CODE:
73                RETVAL = owl_global_get_idletime(&g);
74        OUTPUT:
75                RETVAL
[f1e629d]76
[39e81f7]77const utf8 *
[f1e629d]78zephyr_getrealm()
79        CODE:
[8a54409]80                RETVAL = owl_zephyr_get_realm();
[f1e629d]81        OUTPUT:
82                RETVAL
83
[39e81f7]84const utf8 *
[f1e629d]85zephyr_getsender()
86        CODE:
[8a54409]87                RETVAL = owl_zephyr_get_sender();
[f1e629d]88        OUTPUT:
89                RETVAL
90
[e1c4636]91void
[f1e629d]92zephyr_zwrite(cmd,msg)
[e19eb97]93        const char *cmd
94        const char *msg
[e1c4636]95        PREINIT:
96                int i;
97        CODE:
98                i = owl_zwrite_create_and_send_from_line(cmd, msg);
99
[39e81f7]100const utf8 *
[e1c4636]101ztext_stylestrip(ztext)
[e19eb97]102        const char *ztext
[e1c4636]103        PREINIT:
104                char *rv = NULL;
105        CODE:
[1fd0b25]106                rv = owl_function_ztext_stylestrip(ztext);
[e1c4636]107                RETVAL = rv;
108        OUTPUT:
109                RETVAL
110        CLEANUP:
[3b8a563]111                g_free(rv);
[e1c4636]112
[39e81f7]113const utf8 *
[740d5f7]114zephyr_smartstrip_user(in)
[e19eb97]115        const char *in
[740d5f7]116        PREINIT:
117                char *rv = NULL;
118        CODE:
119        {
120                rv = owl_zephyr_smartstripped_user(in);
121                RETVAL = rv;
122        }
123        OUTPUT:
124                RETVAL
125        CLEANUP:
[ddbbcffa]126                g_free(rv);
[740d5f7]127
[39e81f7]128const utf8 *
[acb13bb]129zephyr_getsubs()
130        PREINIT:
131                char *rv = NULL;
132        CODE:
133                rv = owl_zephyr_getsubs();
134                RETVAL = rv;
135    OUTPUT:
136                RETVAL
137    CLEANUP:
[3b8a563]138                g_free(rv);
[acb13bb]139
[a130fc5]140SV *
[5791bf7]141queue_message(msg)
[dd16bdd]142        SV *msg
143        PREINIT:
144                owl_message *m;
145        CODE:
[1b6b2f3]146        {
[dd16bdd]147                if(!SvROK(msg) || SvTYPE(SvRV(msg)) != SVt_PVHV) {
[3066d23]148                        croak("Usage: BarnOwl::queue_message($message)");
[dd16bdd]149                }
[17eed9c]150
[30678ae]151                m = owl_perlconfig_hashref2message(msg);
[dd16bdd]152
153                owl_global_messagequeue_addmsg(&g, m);
[a130fc5]154
155                RETVAL = owl_perlconfig_message2hashref(m);
[1b6b2f3]156        }
[a130fc5]157        OUTPUT:
158                RETVAL
[db8b00b]159
[5791bf7]160void
161admin_message(header, body)
[e19eb97]162        const char *header
163        const char *body
[1c2e0b3]164        CODE:
165        {
166                owl_function_adminmsg(header, body);           
167        }
168
[5791bf7]169void
170start_question(line, callback)
[e19eb97]171        const char *line
[db8b00b]172        SV *callback
173        PREINIT:
[9186c75]174                owl_editwin *e;
[db8b00b]175        CODE:
176        {
177                if(!SV_IS_CODEREF(callback))
178                        croak("Callback must be a subref");
179
[9186c75]180                e = owl_function_start_question(line);
[db8b00b]181
[9186c75]182                owl_editwin_set_cbdata(e,
[1b1cd2c]183                                       newSVsv(callback),
184                                       owl_perlconfig_dec_refcnt);
[9186c75]185                owl_editwin_set_callback(e, owl_perlconfig_edit_callback);
[db8b00b]186        }
187
[5791bf7]188void
189start_password(line, callback)
[e19eb97]190        const char *line
[db8b00b]191        SV *callback
192        PREINIT:
[9186c75]193                owl_editwin *e;
[db8b00b]194        CODE:
195        {
196                if(!SV_IS_CODEREF(callback))
197                        croak("Callback must be a subref");
198
[9186c75]199                e = owl_function_start_password(line);
[db8b00b]200
[9186c75]201                owl_editwin_set_cbdata(e,
[1b1cd2c]202                                       newSVsv(callback),
203                                       owl_perlconfig_dec_refcnt);
[9186c75]204                owl_editwin_set_callback(e, owl_perlconfig_edit_callback);
[db8b00b]205        }
206
[5791bf7]207void
208start_edit_win(line, callback)
[e19eb97]209        const char *line
[db8b00b]210        SV *callback
[11d55e5]211        PREINIT:
212                owl_editwin *e;
[db8b00b]213        CODE:
214        {
215                if(!SV_IS_CODEREF(callback))
216                        croak("Callback must be a subref");
217
[11d55e5]218                e = owl_function_start_edit_win(line);
219                owl_editwin_set_cbdata(e,
220                                       newSVsv(callback),
221                                       owl_perlconfig_dec_refcnt);
222                owl_editwin_set_callback(e, &owl_perlconfig_edit_callback);
[db8b00b]223        }
[6b3f797]224
225
[e19eb97]226const char * 
[6b3f797]227get_data_dir ()
228        CODE:
[ba6c8bd]229                RETVAL = owl_get_datadir();
[6b3f797]230        OUTPUT:
231        RETVAL
[b6a253c]232
[e19eb97]233const char * 
[b363d83]234get_config_dir ()
235        CODE:
[ba6c8bd]236                RETVAL = owl_global_get_confdir(&g);
[b363d83]237        OUTPUT:
238        RETVAL 
239
[b6a253c]240void
241popless_text(text) 
[e19eb97]242        const char *text
[b6a253c]243        CODE:
244        {
245                owl_function_popless_text(text);
246        }
247
248void
249popless_ztext(text) 
[e19eb97]250        const char *text
[b6a253c]251        CODE:
252        {
253                owl_fmtext fm;
254                owl_fmtext_init_null(&fm);
255                owl_fmtext_append_ztext(&fm, text);
256                owl_function_popless_fmtext(&fm);
[7ab0020]257                owl_fmtext_cleanup(&fm);
[b6a253c]258        }
[0ff2528]259
260void
261error(text) 
[e19eb97]262        const char *text
[0ff2528]263        CODE:
264        {
265                owl_function_error("%s", text);
266        }
[b6c067a]267
268void
[eede1bf]269debug(text)
[e19eb97]270        const char *text
[eede1bf]271        CODE:
272        {
273                owl_function_debugmsg("%s", text);
274        }
275
276void
[747d6a5]277message(text)
[e19eb97]278        const char *text
[747d6a5]279        CODE:
280        {
281                owl_function_makemsg("%s", text);
282        }
283
284void
[b67ab6b]285create_style(name, object)
[e19eb97]286     const char *name
[864ed35]287     SV  *object
[b6c067a]288     PREINIT:
289                owl_style *s;
290     CODE:
291        {
[96828e4]292                s = g_new(owl_style, 1);
[fde6d80]293                owl_style_create_perl(s, name, newSVsv(object));
[b6c067a]294                owl_global_add_style(&g, s);
295        }
[c2c5c77]296
297int
298getnumcolors()
299        CODE:
300                RETVAL = owl_function_get_color_count();
301        OUTPUT:
302                RETVAL
303
304void
305_remove_filter(filterName)
[e19eb97]306        const char *filterName
[c2c5c77]307        CODE:
308        {
309                /* Don't delete the current view, or the 'all' filter */
310                if (strcmp(filterName, owl_view_get_filtname(owl_global_get_current_view(&g)))
311                    && strcmp(filterName, "all")) {
312                        owl_global_remove_filter(&g,filterName);
313                }
314        }
[f6b319c]315
[39e81f7]316const utf8 *
[f6b319c]317wordwrap(in, cols)
[e19eb97]318        const char *in
[f6b319c]319        int cols
320        PREINIT:
321                char *rv = NULL;
322        CODE:
[a695a68]323                rv = owl_text_wordwrap(in, cols);
[f6b319c]324                RETVAL = rv;   
325        OUTPUT:
326                RETVAL
327        CLEANUP:
[3b8a563]328                g_free(rv);
[a695a68]329
[d77e909]330AV*
331all_filters()
332        PREINIT:
[ce68f23]333                GPtrArray *fl;
[d77e909]334        CODE:
335        {
[ce68f23]336                fl = owl_dict_get_keys(&g.filters);
337                RETVAL = owl_new_av(fl, (SV*(*)(const void*))owl_new_sv);
[d77e909]338                sv_2mortal((SV*)RETVAL);
[ce68f23]339                owl_ptr_array_free(fl, g_free);
[d77e909]340        }
341        OUTPUT:
342                RETVAL
343
[3ff3d86]344AV*
345all_styles()
346        PREINIT:
[ce68f23]347                GPtrArray *l;
[3ff3d86]348        CODE:
349        {
[ce68f23]350                l = owl_global_get_style_names(&g);
351                RETVAL = owl_new_av(l, (SV*(*)(const void*))owl_new_sv);
[3ff3d86]352                sv_2mortal((SV*)RETVAL);
353        }
354        OUTPUT:
355                RETVAL
356        CLEANUP:
[ce68f23]357                owl_ptr_array_free(l, g_free);
[3ff3d86]358
359
360AV*
361all_variables()
362        PREINIT:
[ce68f23]363                GPtrArray *l;
[3ff3d86]364        CODE:
365        {
[ce68f23]366                l = owl_dict_get_keys(owl_global_get_vardict(&g));
367                RETVAL = owl_new_av(l, (SV*(*)(const void*))owl_new_sv);
[fe7616e]368                sv_2mortal((SV*)RETVAL);
369        }
370        OUTPUT:
371                RETVAL
372        CLEANUP:
[ce68f23]373                owl_ptr_array_free(l, g_free);
[fe7616e]374
375
376AV*
377all_keymaps()
378        PREINIT:
[ce68f23]379                GPtrArray *l;
[fe7616e]380                const owl_keyhandler *kh;
381        CODE:
382        {
383                kh = owl_global_get_keyhandler(&g);
[ce68f23]384                l = owl_keyhandler_get_keymap_names(kh);
385                RETVAL = owl_new_av(l, (SV*(*)(const void*))owl_new_sv);
[3ff3d86]386                sv_2mortal((SV*)RETVAL);
387        }
388        OUTPUT:
389                RETVAL
390        CLEANUP:
[ce68f23]391                owl_ptr_array_free(l, g_free);
[3ff3d86]392
[4df918b]393void
394redisplay()
395        CODE:
396        {
397                owl_messagelist_invalidate_formats(owl_global_get_msglist(&g));
398                owl_function_calculate_topmsg(OWL_DIRECTION_DOWNWARDS);
399                owl_mainwin_redisplay(owl_global_get_mainwin(&g));
400        }
401
[fbadb37]402const char *
[bb79a52]403get_zephyr_variable(name)
[9cb03bf]404        const char *name;
[bb79a52]405        CODE:
[fbadb37]406                RETVAL = owl_zephyr_get_variable(name);
[bb79a52]407        OUTPUT:
408                RETVAL
409
[39e81f7]410const utf8 *
[9e5b5fd]411skiptokens(str, n)
412        const char *str;
413        int n;
414        CODE:
415                RETVAL = skiptokens(str, n);
416        OUTPUT:
417                RETVAL
418
419
[6f0fbe9]420MODULE = BarnOwl                PACKAGE = BarnOwl::Zephyr
421
422int
423have_zephyr()
424        CODE:
425                RETVAL = owl_global_is_havezephyr(&g);
426        OUTPUT:
427                RETVAL
[9e5b5fd]428
[25cccdc]429MODULE = BarnOwl                PACKAGE = BarnOwl::Internal
430
431
432void
433new_command(name, func, summary, usage, description)
434        char *name
435        SV *func
436        char *summary
437        char *usage
438        char *description
439        PREINIT:
440                owl_cmd cmd;
441        CODE:
442        {
443                if(!SV_IS_CODEREF(func)) {
444                        croak("Command function must be a coderef!");
445                }
446                cmd.name = name;
[2fec14b]447                cmd.cmd_perl = newSVsv(func);
[25cccdc]448                cmd.summary = summary;
449                cmd.usage = usage;
450                cmd.description = description;
451                cmd.validctx = OWL_CTX_ANY;
452                cmd.cmd_aliased_to = NULL;
453                cmd.cmd_args_fn = NULL;
454                cmd.cmd_v_fn = NULL;
455                cmd.cmd_i_fn = NULL;
456                cmd.cmd_ctxargs_fn = NULL;
457                cmd.cmd_ctxv_fn = NULL;
458                cmd.cmd_ctxi_fn = NULL;
459                owl_cmddict_add_cmd(owl_global_get_cmddict(&g), &cmd);
460           }
461
462void
463new_variable_string(name, ival, summ, desc)
[e19eb97]464        const char * name
465        const char * ival
466        const char * summ
467        const char * desc
[a695a68]468        CODE:
469        owl_variable_dict_newvar_string(owl_global_get_vardict(&g),
470                                        name,
471                                        summ,
472                                        desc,
473                                        ival);
474
475void
[25cccdc]476new_variable_int(name, ival, summ, desc)
[e19eb97]477        const char * name
[a695a68]478        int ival
[e19eb97]479        const char * summ
480        const char * desc
[a695a68]481        CODE:
482        owl_variable_dict_newvar_int(owl_global_get_vardict(&g),
483                                     name,
484                                     summ,
485                                     desc,
486                                     ival);
487
488void
[25cccdc]489new_variable_bool(name, ival, summ, desc)
[e19eb97]490        const char * name
[a695a68]491        int ival
[e19eb97]492        const char * summ
493        const char * desc
[a695a68]494        CODE:
495        owl_variable_dict_newvar_bool(owl_global_get_vardict(&g),
496                                      name,
497                                      summ,
498                                      desc,
499                                      ival);
[1631825]500
[0190c4d]501MODULE = BarnOwl                PACKAGE = BarnOwl::Editwin
502
[77f605d]503int
504replace(count, string)
505        int count;
[e19eb97]506        const char *string;
[38cc669]507        PREINIT:
508                owl_editwin *e;
[77f605d]509        CODE:
[818f19c]510                e = owl_global_current_typwin(&g);
[38cc669]511                if (e) {
512                        RETVAL = owl_editwin_replace(e, count, string);
513                } else {
514                        RETVAL = 0;
515                }
[77f605d]516        OUTPUT:
517                RETVAL
518
519int
520point_move(delta)
521        int delta;
[38cc669]522        PREINIT:
523                owl_editwin *e;
[77f605d]524        CODE:
[818f19c]525                e = owl_global_current_typwin(&g);
[38cc669]526                if (e) {
527                        RETVAL = owl_editwin_point_move(e, delta);
528                } else {
529                        RETVAL = 0;
530                }
[77f605d]531        OUTPUT:
532                RETVAL
[a88f35a]533
534int
535replace_region(string)
[e19eb97]536        const char *string;
[38cc669]537        PREINIT:
538                owl_editwin *e;
[a88f35a]539        CODE:
[818f19c]540                e = owl_global_current_typwin(&g);
[38cc669]541                if (e) {
542                        RETVAL = owl_editwin_replace_region(e, string);
543                } else {
544                        RETVAL = 0;
545                }
[a88f35a]546        OUTPUT:
547                RETVAL
548
[39e81f7]549const utf8 *
[d41294a]550get_region()
551        PREINIT:
552                char *region;
[38cc669]553                owl_editwin *e;
[d41294a]554        CODE:
[818f19c]555                e = owl_global_current_typwin(&g);
[38cc669]556                if (e) {
[818f19c]557                        region = owl_editwin_get_region(owl_global_current_typwin(&g));
[38cc669]558                } else {
559                        region = NULL;
560                }
[d41294a]561                RETVAL = region;
562        OUTPUT:
563                RETVAL
564        CLEANUP:
[ddbbcffa]565                g_free(region);
[d41294a]566
[a88f35a]567SV *
568save_excursion(sub)
569        SV *sub;
570        PROTOTYPE: &
571        PREINIT:
572                int count;
[38cc669]573                owl_editwin *e;
[a88f35a]574                owl_editwin_excursion *x;
575        CODE:
576        {
[818f19c]577                e = owl_global_current_typwin(&g);
[38cc669]578                if(!e)
579                        croak("The edit window is not currently active!");
580
[818f19c]581                x = owl_editwin_begin_excursion(owl_global_current_typwin(&g));
[6dc2d6b]582                PUSHMARK(SP);
[a88f35a]583                count = call_sv(sub, G_SCALAR|G_EVAL|G_NOARGS);
[6dc2d6b]584                SPAGAIN;
[818f19c]585                owl_editwin_end_excursion(owl_global_current_typwin(&g), x);
[a88f35a]586
587                if(SvTRUE(ERRSV)) {
588                        croak(NULL);
589                }
590
591                if(count == 1)
592                        RETVAL = SvREFCNT_inc(POPs);
593                else
594                        XSRETURN_UNDEF;
595
596        }
597        OUTPUT:
598                RETVAL
[d41294a]599
600int
601current_column()
[38cc669]602        PREINIT:
603                owl_editwin *e;
[d41294a]604        CODE:
[818f19c]605                e = owl_global_current_typwin(&g);
[38cc669]606                if (e) {
607                        RETVAL = owl_editwin_current_column(e);
608                } else {
609                        RETVAL = 0;
610                }
[d41294a]611        OUTPUT:
612                RETVAL
613
614int
615point()
[38cc669]616        PREINIT:
617                owl_editwin *e;
[d41294a]618        CODE:
[818f19c]619                e = owl_global_current_typwin(&g);
[38cc669]620                if (e) {
621                        RETVAL = owl_editwin_get_point(e);
622                } else {
623                        RETVAL = 0;
624                }
[d41294a]625        OUTPUT:
626                RETVAL
627
628int
629mark()
[38cc669]630        PREINIT:
631                owl_editwin *e;
[d41294a]632        CODE:
[818f19c]633                e = owl_global_current_typwin(&g);
[38cc669]634                if (e) {
635                        RETVAL = owl_editwin_get_mark(e);
636                } else {
637                        RETVAL = 0;
638                }
[d41294a]639        OUTPUT:
640                RETVAL
Note: See TracBrowser for help on using the repository browser.