summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ranger.17
-rw-r--r--doc/ranger.pod6
2 files changed, 12 insertions, 1 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1
index 897a2969..2192047c 100644
--- a/doc/ranger.1
+++ b/doc/ranger.1
@@ -124,7 +124,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RANGER 1"
-.TH RANGER 1 "ranger-1.4.3" "09/28/2011" "ranger manual"
+.TH RANGER 1 "ranger-1.4.3" "09/29/2011" "ranger manual"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -174,6 +174,11 @@ write the last visited directory into \fItargetfile\fR.
 Create copies of the default configuration files in your local configuration
 directory.  Existing ones will not be overwritten.  Possible values: \fIall\fR,
 \&\fIapps\fR, \fIcommands\fR, \fIkeys\fR, \fIoptions\fR, \fIscope\fR.
+.IP "\fB\-\-list\-unused\-keys\fR" 14
+.IX Item "--list-unused-keys"
+List common keys which are not bound to any action in the \*(L"browser\*(R" context.
+This list is not complete, you can bind any key that is supported by curses:
+use the key code returned by \f(CW\*(C`getch()\*(C'\fR.
 .IP "\fB\-\-fail\-unless\-c\fRd" 14
 .IX Item "--fail-unless-cd"
 Return the exit code 1 if ranger is used to run a file instead of used for file
diff --git a/doc/ranger.pod b/doc/ranger.pod
index e5cd8987..be1d14fd 100644
--- a/doc/ranger.pod
+++ b/doc/ranger.pod
@@ -65,6 +65,12 @@ Create copies of the default configuration files in your local configuration
 directory.  Existing ones will not be overwritten.  Possible values: I<all>,
 I<apps>, I<commands>, I<keys>, I<options>, I<scope>.
 
+=item B<--list-unused-keys>
+
+List common keys which are not bound to any action in the "browser" context.
+This list is not complete, you can bind any key that is supported by curses:
+use the key code returned by C<getch()>.
+
 =item B<--fail-unless-c>d
 
 Return the exit code 1 if ranger is used to run a file instead of used for file
e the previous revision' href='/danisanti/profani-tty/blame/src/command.c?id=ee6ac9be264db31736bde40af0320fa9542e885f'>^
a7df149e ^
04e021eb ^

86880ede ^

5f60e463 ^
86880ede ^

04e021eb ^

ea5c1f0f ^
04e021eb ^
887278b9 ^
54ef09bf ^
887278b9 ^
d91175e5 ^
6b697054 ^
f5eab875 ^
dd9f6f82 ^
2fe5d3e9 ^


04e021eb ^
240f7bad ^
70310bb5 ^
04e021eb ^
467b5cce ^




6bb12020 ^

467b5cce ^


54ef09bf ^
467b5cce ^




5f60e463 ^
467b5cce ^
ea5c1f0f ^
467b5cce ^



6b697054 ^
467b5cce ^

45e2415b ^
467b5cce ^

45e2415b ^
467b5cce ^
279737ba ^

a7df149e ^
04e021eb ^
94c97e08 ^
a41dab3d ^
94c97e08 ^
cc4c7f3e ^
b11b8824 ^
cc4c7f3e ^
94c97e08 ^
7dfea94c ^

c511d7c9 ^



a7df149e ^
94c97e08 ^
a7df149e ^

b71f61d4 ^
b22a7c5f ^

b71f61d4 ^
a7df149e ^
a7df149e ^

279737ba ^

1730372e ^
6bb12020 ^







1730372e ^


279737ba ^

6bb12020 ^



279737ba ^

6bb12020 ^



279737ba ^

34fba754 ^
467b5cce ^





7dfea94c ^

467b5cce ^
34fba754 ^

279737ba ^

34fba754 ^
04e021eb ^
619496f5 ^
34fba754 ^
a0e5cd28 ^
d7cee5be ^
7dfea94c ^

d7cee5be ^
7dfea94c ^
34fba754 ^
61600cb7 ^
34fba754 ^
61600cb7 ^

34fba754 ^

35d224a2 ^
7dfea94c ^
34fba754 ^
7dfea94c ^
a0e5cd28 ^
61600cb7 ^
a0e5cd28 ^
2fd9e788 ^
a0e5cd28 ^


7dfea94c ^
34fba754 ^




279737ba ^

a7df149e ^



279737ba ^

a7df149e ^
bff2210b ^
a7df149e ^



279737ba ^

5f60e463 ^





279737ba ^

a7df149e ^
619496f5 ^
7dfea94c ^
a0e5cd28 ^
d7cee5be ^
7dfea94c ^

a7df149e ^



279737ba ^

78bd151c ^
619496f5 ^
db259f64 ^

d7cee5be ^
db259f64 ^
a336148c ^
db259f64 ^

78bd151c ^



279737ba ^

a7df149e ^
a7df149e ^


619496f5 ^
7dfea94c ^
a0e5cd28 ^
d7cee5be ^
7dfea94c ^








f533c6c1 ^
7dfea94c ^




d7cee5be ^
7dfea94c ^
9f6356a8 ^
d7cee5be ^
a7df149e ^


a7df149e ^


279737ba ^
ea5c1f0f ^

fe12352b ^






2375b7ae ^


fe12352b ^













ea5c1f0f ^
2375b7ae ^



ea5c1f0f ^





279737ba ^
a7df149e ^
2acf15de ^
9f6356a8 ^
a7df149e ^
a7df149e ^


279737ba ^

b3ae1a7d ^

1b7d9e9e ^
aa26278a ^
b3ae1a7d ^
1b7d9e9e ^
aa26278a ^
b3ae1a7d ^






279737ba ^

54ef09bf ^













279737ba ^

1b7d9e9e ^


aa26278a ^
1b7d9e9e ^

aa26278a ^
1b7d9e9e ^






279737ba ^

d91175e5 ^













279737ba ^

6b697054 ^













279737ba ^

f5eab875 ^
70310bb5 ^
f5eab875 ^


279737ba ^

dd9f6f82 ^
70310bb5 ^
dd9f6f82 ^


279737ba ^

2fe5d3e9 ^
70310bb5 ^
2fe5d3e9 ^


279737ba ^

2fe5d3e9 ^
70310bb5 ^
2fe5d3e9 ^


279737ba ^

2fe5d3e9 ^
70310bb5 ^
2fe5d3e9 ^


279737ba ^

a7df149e ^
7aa1d931 ^
b3f42cd3 ^
9f6356a8 ^

b3f42cd3 ^
a7df149e ^
9f6356a8 ^
a7df149e ^

a7df149e ^

240f7bad ^
279737ba ^

70310bb5 ^
240f7bad ^
70310bb5 ^






240f7bad ^




70310bb5 ^
240f7bad ^
70310bb5 ^









240f7bad ^
70310bb5 ^
240f7bad ^
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489





















                                                                       
                   
                   


                 
                    
                         
                    
                   
               
                 
                        
                              
                    
 

                                                            

                                                  
                                                   

                                                 

                                                     
                                                  
                                                   
                                                      
                                                        
                                                       
                                                            
                                                       
                                                  
                                                    


                                                  
                                                     
                                                               
                                                     
 




                                             

                                 


                                  
                                   




                                 
                             
                         
                           



                                           
                                 

                         
                          

  
                               
    

                        
 
                            
 
                    
 
                        
                            
 
                           

                               



                                               
            
                                   

     
                

                            
 
                  

 

                  
 







                                                            


                   

                       



                                                     

                             



                                      

                                                                   
 





                                              

     
                             

 

                                    
 
                            
                                                                  
 
                                                                                  
                                                                                 

                                  
                                               
                      
            
                           
                                             

                                         

                                  
                        
                    
                                 
                        
        
                                                    
                                             
                                       


                                                          
                      




                  

                                 



                 

                                 
 
                



                

                                  





                 

                                
 
                                                                  
 
                                        
                                                      

                                



                

                                
 
                                                                  

                                          
                                                      
            
                                          

                                        



                

                                
 


                     
                                                                  
 
                                          
                                                      








                                                                     
                          




                                                                              
                                                           
             
                
                                                       


         


                
               

                                 






                                                                       


                                         













                                                         
            



                                         





                
                                  
 
                         
                              
    


                

                                     

                                       
                                    
                             
                                               
                                     
                              






                                           

                                       













                                                     

                                      


                                           
                              

                                                
                               






                                            

                                           













                                                     

                                      













                                                

                                 
 
                                                 


                

                                   
 
                                                     


                

                                
 
                                               


                

                                 
 
                                                 


                

                               
 
                                             


                

                                    
 
                        
                                              

                                                    
                        
            
                              

     

                
 

                                                   
                                                    
 






                                                                              




                                                                  
                                              
                                       









                                                                
     
 
  
/* 
 * command.c
 *
 * Copyright (C) 2012 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 <http://www.gnu.org/licenses/>.
 *
 */

#include <string.h>
#include <stdlib.h>

#include <glib.h>

#include "command.h"
#include "contact_list.h"
#include "history.h"
#include "jabber.h"
#include "ui.h"
#include "util.h"
#include "preferences.h"
#include "prof_autocomplete.h"
#include "tinyurl.h"

static gboolean _handle_command(const char * const command, 
    const char * const inp);
static gboolean _cmd_quit(const char * const inp);
static gboolean _cmd_help(const char * const inp);
static gboolean _cmd_prefs(const char * const inp);
static gboolean _cmd_who(const char * const inp);
static gboolean _cmd_ros(const char * const inp);
static gboolean _cmd_connect(const char * const inp);
static gboolean _cmd_msg(const char * const inp);
static gboolean _cmd_tiny(const char * const inp);
static gboolean _cmd_close(const char * const inp);
static gboolean _cmd_set_beep(const char * const inp);
static gboolean _cmd_set_notify(const char * const inp);
static gboolean _cmd_set_flash(const char * const inp);
static gboolean _cmd_set_showsplash(const char * const inp);
static gboolean _cmd_set_chlog(const char * const inp);
static gboolean _cmd_away(const char * const inp);
static gboolean _cmd_online(const char * const inp);
static gboolean _cmd_dnd(const char * const inp);
static gboolean _cmd_chat(const char * const inp);
static gboolean _cmd_xa(const char * const inp);
static gboolean _cmd_default(const char * const inp);
static void _update_presence(const jabber_presence_t presence, 
    const char * const show, const char * const inp);

struct cmd_t {
    const gchar *cmd;
    gboolean (*func)(const char * const inp);
};

static PAutocomplete commands_ac;

static struct cmd_t commands[] = {
    { "/away", _cmd_away },
    { "/beep", _cmd_set_beep },
    { "/notify", _cmd_set_notify },
    { "/chat", _cmd_chat },
    { "/close", _cmd_close },
    { "/connect", _cmd_connect },
    { "/dnd", _cmd_dnd },
    { "/flash", _cmd_set_flash },
    { "/prefs", _cmd_prefs },
    { "/msg", _cmd_msg },
    { "/tiny", _cmd_tiny },
    { "/online", _cmd_online },
    { "/quit", _cmd_quit },
    { "/ros", _cmd_ros },
    { "/showsplash", _cmd_set_showsplash },
    { "/chlog", _cmd_set_chlog },
    { "/who", _cmd_who },
    { "/xa", _cmd_xa },
    { "/help", _cmd_help }
};

static const int num_cmds = 19;
    
gboolean
process_input(char *inp)
{
    gboolean result = FALSE;

    g_strstrip(inp);

    if (strlen(inp) > 0)
        history_append(inp);

    if (strlen(inp) == 0) {
        result = TRUE;
    } else if (inp[0] == '/') {
        char inp_cpy[strlen(inp) + 1];
        strcpy(inp_cpy, inp);
        char *command = strtok(inp_cpy, " ");
        result = _handle_command(command, inp);
    } else {
        result = _cmd_default(inp);
    }

    inp_clear();
    reset_search_attempts();
    win_page_off();

    return result;
}

void
command_init(void)
{
    commands_ac = p_autocomplete_new();

    int i;
    for (i = 0; i < num_cmds; i++) {
        struct cmd_t *pcmd = commands+i;
        p_autocomplete_add(commands_ac, (gchar *)pcmd->cmd);
    }

    history_init();
}

char *
cmd_complete(char *inp)
{
    return p_autocomplete_complete(commands_ac, inp);
}

void
reset_command_completer(void)
{
    p_autocomplete_reset(commands_ac);
}

static gboolean
_handle_command(const char * const command, const char * const inp)
{
    int i;
    for (i = 0; i < num_cmds; i++) {
        struct cmd_t *pcmd = commands+i;
        if (strcmp(pcmd->cmd, command) == 0) {
            return (pcmd->func(inp));
        }
    }

    return _cmd_default(inp);
}

static gboolean
_cmd_connect(const char * const inp)
{
    gboolean result = FALSE;
    jabber_conn_status_t conn_status = jabber_connection_status();

    if ((conn_status != JABBER_DISCONNECTED) && (conn_status != JABBER_STARTED)) {
        cons_show("You are either connected already, or a login is in process.");
        result = TRUE;
    } else if (strlen(inp) < 10) {
        cons_show("Usage: /connect user@host");
        result = TRUE;
    } else {
        char *user, *lower;
        user = strndup(inp+9, strlen(inp)-9);
        lower = g_utf8_strdown(user, -1);

        status_bar_get_password();
        status_bar_refresh();
        char passwd[21];
        inp_block();
        inp_get_password(passwd);
        inp_non_block();
        
        conn_status = jabber_connect(lower, passwd);
        if (conn_status == JABBER_CONNECTING)
            cons_show("Connecting...");
        if (conn_status == JABBER_DISCONNECTED)
            cons_bad_show("Connection to server failed.");

        result = TRUE;
    }
    
    return result;
}

static gboolean
_cmd_quit(const char * const inp)
{
    return FALSE;
}

static gboolean
_cmd_help(const char * const inp)
{
    cons_help();

    return TRUE;
}

static gboolean
_cmd_prefs(const char * const inp)
{
    cons_prefs();

    return TRUE;
}

static gboolean
_cmd_ros(const char * const inp)
{
    jabber_conn_status_t conn_status = jabber_connection_status();

    if (conn_status != JABBER_CONNECTED)
        cons_show("You are not currently connected.");
    else
        jabber_roster_request();

    return TRUE;
}

static gboolean
_cmd_who(const char * const inp)
{
    jabber_conn_status_t conn_status = jabber_connection_status();

    if (conn_status != JABBER_CONNECTED) {
        cons_show("You are not currently connected.");
    } else {
        GSList *list = get_contact_list();
        cons_show_online_contacts(list);
    }

    return TRUE;
}

static gboolean
_cmd_msg(const char * const inp)
{
    char *usr = NULL;
    char *msg = NULL;

    jabber_conn_status_t conn_status = jabber_connection_status();

    if (conn_status != JABBER_CONNECTED) {
        cons_show("You are not currently connected.");
    } else {
        // copy input    
        char inp_cpy[strlen(inp) + 1];
        strcpy(inp_cpy, inp);

        // get user
        strtok(inp_cpy, " ");
        usr = strtok(NULL, " ");
        if ((usr != NULL) && (strlen(inp) > (5 + strlen(usr) + 1))) {
            // get message
            msg = strndup(inp+5+strlen(usr)+1, strlen(inp)-(5+strlen(usr)+1));
            if (msg != NULL) {
                jabber_send(msg, usr);
                win_show_outgoing_msg("me", usr, msg);
            } else {
                cons_show("Usage: /msg user@host message");
            }
        } else {
            cons_show("Usage: /msg user@host message");
        }
    }

    return TRUE;
}

static gboolean
_cmd_tiny(const char * const inp)
{
    if (strlen(inp) > 6) {
        char *url = strndup(inp+6, strlen(inp)-6);

        if (!tinyurl_valid(url)) {
            GString *error = g_string_new("/tiny, badly formed URL: ");
            g_string_append(error, url);
            cons_bad_show(error->str);
            if (win_in_chat()) {
                win_bad_show(error->str);
            }
            g_string_free(error, TRUE);
            free(url);
        } else if (win_in_chat()) {
            char *tiny = tinyurl_get(url);
            char *recipient = win_get_recipient();
            jabber_send(tiny, recipient);
            win_show_outgoing_msg("me", recipient, tiny);
            free(recipient);
            free(tiny);
            free(url);
        } else {
            cons_bad_command(inp);
            free(url);
        }
    } else {
        cons_show("Usage: /tiny url");
        if (win_in_chat()) {
            win_show("Usage: /tiny url");
        }
    }

    return TRUE;
}

static gboolean
_cmd_close(const char * const inp)
{
    if (!win_close_win())
        cons_bad_command(inp);
    
    return TRUE;
}

static gboolean
_cmd_set_beep(const char * const inp)
{
    if (strcmp(inp, "/beep on") == 0) {
        cons_show("Sound enabled.");
        prefs_set_beep(TRUE);
    } else if (strcmp(inp, "/beep off") == 0) {
        cons_show("Sound disabled.");
        prefs_set_beep(FALSE);
    } else {
        cons_show("Usage: /beep <on/off>");
    }        

    return TRUE;
}

static gboolean
_cmd_set_notify(const char * const inp)
{
    if (strcmp(inp, "/notify on") == 0) {
        cons_show("Desktop notifications enabled.");
        prefs_set_notify(TRUE);
    } else if (strcmp(inp, "/notify off") == 0) {
        cons_show("Desktop notifications disabled.");
        prefs_set_notify(FALSE);
    } else {
        cons_show("Usage: /notify <on/off>");
    }        

    return TRUE;
}

static gboolean
_cmd_set_flash(const char * const inp)
{
    if (strcmp(inp, "/flash on") == 0) {
        cons_show("Screen flash enabled.");
        prefs_set_flash(TRUE);
    } else if (strcmp(inp, "/flash off") == 0) {
        cons_show("Screen flash disabled.");
        prefs_set_flash(FALSE);
    } else {
        cons_show("Usage: /flash <on/off>");
    }        

    return TRUE;
}

static gboolean
_cmd_set_showsplash(const char * const inp)
{
    if (strcmp(inp, "/showsplash on") == 0) {
        cons_show("Splash screen enabled.");
        prefs_set_showsplash(TRUE);
    } else if (strcmp(inp, "/showsplash off") == 0) {
        cons_show("Splash screen disabled.");
        prefs_set_showsplash(FALSE);
    } else {
        cons_show("Usage: /showsplash <on/off>");
    }

    return TRUE;
}

static gboolean
_cmd_set_chlog(const char * const inp)
{
    if (strcmp(inp, "/chlog on") == 0) {
        cons_show("Chat logging enabled.");
        prefs_set_chlog(TRUE);
    } else if (strcmp(inp, "/chlog off") == 0) {
        cons_show("Chat logging disabled.");
        prefs_set_chlog(FALSE);
    } else {
        cons_show("Usage: /chlog <on/off>");
    }

    return TRUE;
}

static gboolean
_cmd_away(const char * const inp)
{
    _update_presence(PRESENCE_AWAY, "away", inp);
    return TRUE;
}

static gboolean
_cmd_online(const char * const inp)
{
    _update_presence(PRESENCE_ONLINE, "online", inp);
    return TRUE;
}

static gboolean
_cmd_dnd(const char * const inp)
{
    _update_presence(PRESENCE_DND, "dnd", inp);
    return TRUE;
}

static gboolean
_cmd_chat(const char * const inp)
{
    _update_presence(PRESENCE_CHAT, "chat", inp);
    return TRUE;
}

static gboolean
_cmd_xa(const char * const inp)
{
    _update_presence(PRESENCE_XA, "xa", inp);
    return TRUE;
}

static gboolean
_cmd_default(const char * const inp)
{
    if (win_in_chat()) {
        char *recipient = win_get_recipient();
        jabber_send(inp, recipient);
        win_show_outgoing_msg("me", recipient, inp);
        free(recipient);
    } else {
        cons_bad_command(inp);
    }

    return TRUE;
}

static void
_update_presence(const jabber_presence_t presence, 
    const char * const show, const char * const inp)
{
    char *msg;
    if (strlen(inp) > strlen(show) + 2) {
        msg = strndup(inp+(strlen(show) + 2), strlen(inp)-(strlen(show) + 2));
    } else {
        msg = NULL;
    }

    jabber_conn_status_t conn_status = jabber_connection_status();
    
    if (conn_status != JABBER_CONNECTED) {
        cons_show("You are not currently connected.");
    } else {
        jabber_update_presence(presence, msg);
        title_bar_set_status(presence);
        if (msg != NULL) {
            char str[14 + strlen(show) + 3 + strlen(msg) + 2];
            sprintf(str, "Status set to %s, \"%s\"", show, msg);
            cons_show(str);
            free(msg);
        } else {
            char str[14 + strlen(show) + 1];
            sprintf(str, "Status set to %s", show);
            cons_show(str);
        }
    }

}