code.delx.au - pulseaudio/blob - src/pulsecore/cli.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2004-2006 Lennart Poettering
   5
   6   PulseAudio is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU Lesser General Public License as published
   8   by the Free Software Foundation; either version 2 of the License,
   9   or (at your option) any later version.
  10
  11   PulseAudio is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with PulseAudio; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <string.h>
  28 #include <stdlib.h>
  29
  30 #include <pulse/xmalloc.h>
  31
  32 #include <pulsecore/ioline.h>
  33 #include <pulsecore/module.h>
  34 #include <pulsecore/sink.h>
  35 #include <pulsecore/source.h>
  36 #include <pulsecore/client.h>
  37 #include <pulsecore/sink-input.h>
  38 #include <pulsecore/source-output.h>
  39 #include <pulsecore/tokenizer.h>
  40 #include <pulsecore/strbuf.h>
  41 #include <pulsecore/namereg.h>
  42 #include <pulsecore/cli-text.h>
  43 #include <pulsecore/cli-command.h>
  44 #include <pulsecore/log.h>
  45 #include <pulsecore/macro.h>
  46
  47 #include "cli.h"
  48
  49 #define PROMPT ">>> "
  50
  51 struct pa_cli {
  52     pa_core *core;
  53     pa_ioline *line;
  54
  55     pa_cli_eof_cb_t eof_callback;
  56     void *userdata;
  57
  58     pa_client *client;
  59
  60     pa_bool_t fail, kill_requested;
  61     int defer_kill;
  62 };
  63
  64 static void line_callback(pa_ioline *line, const char *s, void *userdata);
  65 static void client_kill(pa_client *c);
  66
  67 pa_cli* pa_cli_new(pa_core *core, pa_iochannel *io, pa_module *m) {
  68     char cname[256];
  69     pa_cli *c;
  70     pa_assert(io);
  71
  72     c = pa_xnew(pa_cli, 1);
  73     c->core = core;
  74     pa_assert_se(c->line = pa_ioline_new(io));
  75
  76     c->userdata = NULL;
  77     c->eof_callback = NULL;
  78
  79     pa_iochannel_socket_peer_to_string(io, cname, sizeof(cname));
  80     pa_assert_se(c->client = pa_client_new(core, __FILE__, cname));
  81     c->client->kill = client_kill;
  82     c->client->userdata = c;
  83     c->client->module = m;
  84
  85     pa_ioline_set_callback(c->line, line_callback, c);
  86     pa_ioline_puts(c->line, "Welcome to PulseAudio! Use \"help\" for usage information.\n"PROMPT);
  87
  88     c->fail = c->kill_requested = FALSE;
  89     c->defer_kill = 0;
  90
  91     return c;
  92 }
  93
  94 void pa_cli_free(pa_cli *c) {
  95     pa_assert(c);
  96
  97     pa_ioline_close(c->line);
  98     pa_ioline_unref(c->line);
  99     pa_client_free(c->client);
 100     pa_xfree(c);
 101 }
 102
 103 static void client_kill(pa_client *client) {
 104     pa_cli *c;
 105
 106     pa_assert(client);
 107     pa_assert_se(c = client->userdata);
 108
 109     pa_log_debug("CLI client killed.");
 110
 111     if (c->defer_kill)
 112         c->kill_requested = TRUE;
 113     else if (c->eof_callback)
 114         c->eof_callback(c, c->userdata);
 115 }
 116
 117 static void line_callback(pa_ioline *line, const char *s, void *userdata) {
 118     pa_strbuf *buf;
 119     pa_cli *c = userdata;
 120     char *p;
 121
 122     pa_assert(line);
 123     pa_assert(c);
 124
 125     if (!s) {
 126         pa_log_debug("CLI got EOF from user.");
 127
 128         if (c->eof_callback)
 129             c->eof_callback(c, c->userdata);
 130
 131         return;
 132     }
 133
 134     pa_assert_se(buf = pa_strbuf_new());
 135     c->defer_kill++;
 136     pa_cli_command_execute_line(c->core, s, buf, &c->fail);
 137     c->defer_kill--;
 138     pa_ioline_puts(line, p = pa_strbuf_tostring_free(buf));
 139     pa_xfree(p);
 140
 141     if (c->kill_requested) {
 142         if (c->eof_callback)
 143             c->eof_callback(c, c->userdata);
 144     } else
 145         pa_ioline_puts(line, PROMPT);
 146 }
 147
 148 void pa_cli_set_eof_callback(pa_cli *c, pa_cli_eof_cb_t cb, void *userdata) {
 149     pa_assert(c);
 150
 151     c->eof_callback = cb;
 152     c->userdata = userdata;
 153 }