summary refs log tree commit diff stats
path: root/doc/pydoc/ranger.ext.html
blob: 3b33e70a349f5a966b4cd92f2e07091392bfa1f5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package ranger.ext</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="ranger.html"><font color="#ffffff">ranger</font></a>.ext</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/hut/work/ranger/ranger/ext/__init__.py">/home/hut/work/ranger/ranger/ext/__init__.py</a></font></td></tr></table>
    <p><tt>This&nbsp;package&nbsp;includes&nbsp;extensions&nbsp;with&nbsp;broader&nbsp;usability</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
    
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="ranger.ext.accumulator.html">accumulator</a><br>
<a href="ranger.ext.command_parser.html">command_parser</a><br>
<a href="ranger.ext.curses_interrupt_handler.html">curses_interrupt_handler</a><br>
</td><td width="25%" valign=top><a href="ranger.ext.debug.html">debug</a><br>
<a href="ranger.ext.get_all_modules.html">get_all_modules</a><br>
<a href="ranger.ext.human_readable.html">human_readable</a><br>
</td><td width="25%" valign=top><a href="ranger.ext.move.html">move</a><br>
<a href="ranger.ext.openstruct.html">openstruct</a><br>
<a href="ranger.ext.relpath.html">relpath</a><br>
</td><td width="25%" valign=top><a href="ranger.ext.shell_escape.html">shell_escape</a><br>
<a href="ranger.ext.shutil_generatorized.html">shutil_generatorized</a><br>
<a href="ranger.ext.waitpid_no_intr.html">waitpid_no_intr</a><br>
</td></tr></table></td></tr></table>
</body></html>
e>
41fe8c22 ^


759d9ccb ^

41fe8c22 ^
759d9ccb ^



41fe8c22 ^
759d9ccb ^



93672eba ^

41fe8c22 ^
759d9ccb ^



41fe8c22 ^
759d9ccb ^
5f393a6d ^
d0397f3d ^

8933d59b ^

d0397f3d ^
8933d59b ^

d0397f3d ^
8933d59b ^
d0397f3d ^
759d9ccb ^



271278dd ^
7ca60846 ^
271278dd ^
41fe8c22 ^

0ed3b53b ^
41fe8c22 ^
a14b7815 ^
41fe8c22 ^
623fbe9e ^

41fe8c22 ^
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164


            
                                                            













                                                                       
                                                                      














                                                                                

                         
 
                             
 
              
                







                                                                               
                                                                                              


                                                           
                                                         
 














                                                                                                                     

                                                                                                                                            








                                                                                                                   
 
                                                                                          

                                                                                                
                                                                                           

                                                                                                 
                                                                                     
                                                                                           




                                                                                                                    

                                                                                       
                                                                                       


                        
                                    
                                 
                                                    


                                      
                                                                                    
                                              
                                                
                                                
                              
 


                               

                                                                                      
 



                                                                                   
 



                                                                                                            

                                                                                                               
 



                                                                                      
 
                                                                 
                                                                             

                                                             

                                                                   
                                                              

                                                                    
                                                        
                                                              
 



                                                                                                                   
                                                          
                                                          
 

                                                     
                                       
                              
                                                     
 

                                        
      
/*
 * plugins.h
 *
 * Copyright (C) 2012 - 2016 James Booth <boothj5@gmail.com>
 *
 * This file is part of Profanity.
 *
 * Profanity is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Profanity is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Profanity.  If not, see <https://www.gnu.org/licenses/>.
 *
 * In addition, as a special exception, the copyright holders give permission to
 * link the code of portions of this program with the OpenSSL library under
 * certain conditions as described in each individual source file, and
 * distribute linked combinations including the two.
 *
 * You must obey the GNU General Public License in all respects for all of the
 * code used other than OpenSSL. If you modify file(s) with this exception, you
 * may extend this exception to your version of the file(s), but you are not
 * obligated to do so. If you do not wish to do so, delete this exception
 * statement from your version. If you delete this exception statement from all
 * source files in the program, then also delete it here.
 *
 */

#ifndef PLUGINS_PLUGINS_H
#define PLUGINS_PLUGINS_H

#include "command/cmd_defs.h"

typedef enum {
    LANG_PYTHON,
    LANG_C
} lang_t;

typedef struct prof_plugin_t {
    char *name;
    lang_t lang;
    void *module;
    void (*init_func)(struct prof_plugin_t* plugin, const char * const version,
        const char * const status, const char *const account_name, const char *const fulljid);

    void (*on_start_func)(struct prof_plugin_t* plugin);
    void (*on_shutdown_func)(struct prof_plugin_t* plugin);
    void (*on_unload_func)(struct prof_plugin_t* plugin);

    void (*on_connect_func)(struct prof_plugin_t* plugin, const char *const account_name, const char *const fulljid);
    void (*on_disconnect_func)(struct prof_plugin_t* plugin, const char *const account_name,
        const char *const fulljid);

    char* (*pre_chat_message_display)(struct prof_plugin_t* plugin, const char *const jid, const char *message);
    void (*post_chat_message_display)(struct prof_plugin_t* plugin, const char *const jid, const char *message);
    char* (*pre_chat_message_send)(struct prof_plugin_t* plugin, const char *const jid, const char *message);
    void (*post_chat_message_send)(struct prof_plugin_t* plugin, const char *const jid, const char *message);

    char* (*pre_room_message_display)(struct prof_plugin_t* plugin, const char *const room, const char *const nick,
        const char *message);
    void (*post_room_message_display)(struct prof_plugin_t* plugin, const char *const room, const char *const nick,
        const char *message);
    char* (*pre_room_message_send)(struct prof_plugin_t* plugin, const char *const room, const char *message);
    void (*post_room_message_send)(struct prof_plugin_t* plugin, const char *const room, const char *message);
    void (*on_room_history_message)(struct prof_plugin_t* plugin, const char *const room, const char *const nick, const char *const message,
        const char *const timestamp);

    char* (*pre_priv_message_display)(struct prof_plugin_t* plugin, const char *const room, const char *const nick,
        const char *message);
    void (*post_priv_message_display)(struct prof_plugin_t* plugin, const char *const room, const char *const nick,
        const char *message);
    char* (*pre_priv_message_send)(struct prof_plugin_t* plugin, const char *const room, const char *const nick,
        const char *const message);
    void (*post_priv_message_send)(struct prof_plugin_t* plugin, const char *const room, const char *const nick,
        const char *const message);

    char* (*on_message_stanza_send)(struct prof_plugin_t* plugin, const char *const text);
    gboolean (*on_message_stanza_receive)(struct prof_plugin_t* plugin, const char *const text);

    char* (*on_presence_stanza_send)(struct prof_plugin_t* plugin, const char *const text);
    gboolean (*on_presence_stanza_receive)(struct prof_plugin_t* plugin, const char *const text);

    char* (*on_iq_stanza_send)(struct prof_plugin_t* plugin, const char *const text);
    gboolean (*on_iq_stanza_receive)(struct prof_plugin_t* plugin, const char *const text);

    void (*on_contact_offline)(struct prof_plugin_t* plugin, const char *const barejid, const char *const resource,
        const char *const status);
    void (*on_contact_presence)(struct prof_plugin_t* plugin, const char *const barejid, const char *const resource,
        const char *const presence, const char *const status, const int priority);

    void (*on_chat_win_focus)(struct prof_plugin_t* plugin, const char *const barejid);
    void (*on_room_win_focus)(struct prof_plugin_t* plugin, const char *const roomjid);
} ProfPlugin;

void plugins_init(void);
GSList *plugins_unloaded_list(void);
GList *plugins_loaded_list(void);
char* plugins_autocomplete(const char *const input);
void plugins_reset_autocomplete(void);
void plugins_shutdown(void);

gboolean plugins_install(const char *const plugin_name, const char *const filename);
gboolean plugins_load(const char *const name);
gboolean plugins_unload(const char *const name);
gboolean plugins_reload(const char *const name);
void plugins_reload_all(void);

void plugins_on_start(void);
void plugins_on_shutdown(void);

void plugins_on_connect(const char *const account_name, const char *const fulljid);
void plugins_on_disconnect(const char *const account_name, const char *const fulljid);

char* plugins_pre_chat_message_display(const char *const jid, const char *message);
void plugins_post_chat_message_display(const char *const jid, const char *message);
char* plugins_pre_chat_message_send(const char *const jid, const char *message);
void plugins_post_chat_message_send(const char *const jid, const char *message);

char* plugins_pre_room_message_display(const char *const room, const char *const nick, const char *message);
void plugins_post_room_message_display(const char *const room, const char *const nick, const char *message);
char* plugins_pre_room_message_send(const char *const room, const char *message);
void plugins_post_room_message_send(const char *const room, const char *message);
void plugins_on_room_history_message(const char *const room, const char *const nick, const char *const message,
    GDateTime *timestamp);

char* plugins_pre_priv_message_display(const char *const jid, const char *message);
void plugins_post_priv_message_display(const char *const jid, const char *message);
char* plugins_pre_priv_message_send(const char *const jid, const char *const message);
void plugins_post_priv_message_send(const char *const jid, const char *const message);

void plugins_win_process_line(char *win, const char *const line);
void plugins_close_win(const char *const plugin_name, const char *const tag);

char* plugins_on_message_stanza_send(const char *const text);
gboolean plugins_on_message_stanza_receive(const char *const text);

char* plugins_on_presence_stanza_send(const char *const text);
gboolean plugins_on_presence_stanza_receive(const char *const text);

char* plugins_on_iq_stanza_send(const char *const text);
gboolean plugins_on_iq_stanza_receive(const char *const text);

void plugins_on_contact_offline(const char *const barejid, const char *const resource, const char *const status);
void plugins_on_contact_presence(const char *const barejid, const char *const resource, const char *const presence,
    const char *const status, const int priority);

void plugins_on_chat_win_focus(const char *const barejid);
void plugins_on_room_win_focus(const char *const roomjid);

gboolean plugins_run_command(const char * const cmd);
void plugins_run_timed(void);
GList* plugins_get_command_names(void);
gchar * plugins_get_dir(void);
CommandHelp* plugins_get_help(const char *const cmd);

GList* plugins_get_disco_features(void);

#endif