/* This file is part of
- * ======================================================
- *
+ * ======================================================
+ *
* LyX, The Document Processor
- *
+ *
* Copyright 1995 Matthias Ettrich
* Copyright 1995-2001 The LyX Team.
*
/**
Docu : To use the lyxserver define the name of the pipe in your
- lyxrc:
- \serverpipe "/home/myhome/.lyxpipe"
- Then use .lyxpipe.in and .lyxpipe.out to communicate to LyX.
- Each message consists of a single line in ASCII. Input lines
- (client -> LyX) have the following format:
-
"LYXCMD:<clientname>:<functionname>:<argument>"
- Answers from LyX look like this:
- "INFO:<clientname>:<functionname>:<data>"
+ lyxrc:
+ \serverpipe "/home/myhome/.lyxpipe"
+ Then use .lyxpipe.in and .lyxpipe.out to communicate to LyX.
+ Each message consists of a single line in ASCII. Input lines
+ (client -> LyX) have the following format:
+ "LYXCMD:<clientname>:<functionname>:<argument>"
+ Answers from LyX look like this:
+ "INFO:<clientname>:<functionname>:<data>"
[asierra970531] Or like this in case of error:
- "ERROR:<clientname>:<functionname>:<error message>"
- where <clientname> and <functionname> are just echoed.
- If LyX notifies about a user defined extension key-sequence,
- the line looks like this:
- "NOTIFY:<key-sequence>"
+ "ERROR:<clientname>:<functionname>:<error message>"
+ where <clientname> and <functionname> are just echoed.
+ If LyX notifies about a user defined extension key-sequence,
+ the line looks like this:
+ "NOTIFY:<key-sequence>"
[asierra970531] New server-only messages to implement a simple protocol
-
"LYXSRV:<clientname>:<protocol message>"
-
where <protocol message> can be "hello" or "bye". If hello is
- received LyX will inform the client that it's listening its
- messages, and 'bye' will inform that lyx is closing.
+ "LYXSRV:<clientname>:<protocol message>"
+ where <protocol message> can be "hello" or "bye". If hello is
+ received LyX will inform the client that it's listening its
+ messages, and 'bye' will inform that lyx is closing.
- See development/server_monitor.c for an example client.
+ See development/server_monitor.c for an example client.
Purpose: implement a client/server lib for LyX
*/
#include <unistd.h>
#include <fcntl.h>
#include <cerrno>
-#include FORMS_H_LOCATION
#ifdef __GNUG__
#pragma implementation
#include "lyxserver.h"
#include "lyx_main.h"
#include "debug.h"
-#include "LyXAction.h"
#include "lyxfunc.h"
#include "support/lstrings.h"
#include "support/lyxlib.h"
+#include "frontends/lyx_gui.h"
#ifdef __EMX__
#include <cstdlib>
using std::endl;
// provide an empty mkfifo() if we do not have one. This disables the
-// lyxserver.
+// lyxserver.
#ifndef HAVE_MKFIFO
int mkfifo(char const * __path, mode_t __mode) {
- return 0;
+ return 0;
}
#endif
-/* === variables ========================================================= */
-
-extern LyXAction lyxaction;
-
-
-extern "C" {
-
- // C wrapper
- static
- void C_LyXComm_callback(int fd, void *v)
- {
- LyXComm::callback(fd, v);
- }
-
-}
-
-
-// LyXComm class
-
-// Open pipes
void LyXComm::openConnection()
{
lyxerr[Debug::LYXSERVER] << "LyXComm: Opening connection" << endl;
-
+
// If we are up, that's an error
if (ready) {
lyxerr << "LyXComm: Already connected" << endl;
}
// We assume that we don't make it
ready = false;
-
+
if (pipename.empty()) {
lyxerr[Debug::LYXSERVER]
<< "LyXComm: server is disabled, nothing to do"
return;
if ((outfd = startPipe(outPipeName(), true)) == -1) {
- endPipe(infd, inPipeName());
+ endPipe(infd, inPipeName(), false);
return;
}
-
+
if (fcntl(outfd, F_SETFL, O_NONBLOCK) < 0) {
lyxerr << "LyXComm: Could not set flags on pipe " << outPipeName()
<< '\n' << strerror(errno) << endl;
return;
}
-
+
// We made it!
ready = true;
lyxerr[Debug::LYXSERVER] << "LyXComm: Connection established" << endl;
}
-
+
/// Close pipes
void LyXComm::closeConnection()
{
- lyxerr[Debug::LYXSERVER] << "LyXComm: Closing connection" << endl;
+ lyxerr[Debug::LYXSERVER] << "LyXComm: Closing connection" << endl;
if (pipename.empty()) {
lyxerr[Debug::LYXSERVER]
<< "LyXComm: server is disabled, nothing to do"
<< endl;
- return;
+ return;
}
if (!ready) {
lyxerr << "LyXComm: Already disconnected" << endl;
return;
}
-
- endPipe(infd, inPipeName());
- endPipe(outfd, outPipeName());
-
+
+ endPipe(infd, inPipeName(), false);
+ endPipe(outfd, outPipeName(), true);
+
ready = false;
}
int LyXComm::startPipe(string const & filename, bool write)
{
int fd;
-
+
#ifdef __EMX__
HPIPE os2fd;
APIRET rc;
pipename.erase();
return -1;
}
-
+
if (rc != NO_ERROR) {
errnum = TranslateOS2Error(rc);
lyxerr <<"LyXComm: Could not create pipe " << filename
return -1;
};
// Imported handles can be used both with OS/2 APIs and emx
- // library functions.
+ // library functions.
fd = _imphandle(os2fd);
#else
if (::access(filename.c_str(), F_OK) == 0) {
pipename.erase();
return -1;
}
-
+
if (::mkfifo(filename.c_str(), 0600) < 0) {
lyxerr << "LyXComm: Could not create pipe " << filename << '\n'
<< strerror(errno) << endl;
};
fd = ::open(filename.c_str(), write ? (O_RDWR) : (O_RDONLY|O_NONBLOCK));
#endif
-
+
if (fd < 0) {
lyxerr << "LyXComm: Could not open pipe " << filename << '\n'
<< strerror(errno) << endl;
lyx::unlink(filename);
return -1;
}
-
- if (!write)
- fl_add_io_callback(fd, FL_READ, C_LyXComm_callback, this);
-
+
+ if (!write) {
+ lyx_gui::set_read_callback(fd, this);
+ }
+
return fd;
}
-void LyXComm::endPipe(int & fd, string const & filename)
+void LyXComm::endPipe(int & fd, string const & filename, bool write)
{
if (fd < 0)
return;
+ if (!write) {
+ lyx_gui::remove_read_callback(fd);
+ }
+
#ifdef __EMX__
APIRET rc;
int errnum;
-
+
rc = DosDisConnectNPipe(fd);
if (rc != NO_ERROR) {
errnum = TranslateOS2Error(rc);
return;
}
#endif
-
+
if (::close(fd) < 0) {
lyxerr << "LyXComm: Could not close pipe " << filename
<< '\n' << strerror(errno) << endl;
}
-
+
// OS/2 pipes are deleted automatically
#ifndef __EMX__
if (lyx::unlink(filename) < 0) {
void LyXComm::emergencyCleanup()
{
if (!pipename.empty()) {
- endPipe(infd, inPipeName());
- endPipe(outfd, outPipeName());
+ endPipe(infd, inPipeName(), false);
+ endPipe(outfd, outPipeName(), true);
}
}
// Receives messages and sends then to client
-void LyXComm::callback(int fd, void *v)
+void LyXComm::read_ready()
{
- LyXComm * c = static_cast<LyXComm*>(v);
-
- if (lyxerr.debugging(Debug::LYXSERVER)) {
- lyxerr << "LyXComm: Receiving from fd " << fd << endl;
- }
-
- const int CMDBUFLEN = 100;
- char charbuf[CMDBUFLEN];
- string cmd;
-// nb! make lsbuf a class-member for multiple sessions
- static string lsbuf;
+ // nb! make read_buffer_ a class-member for multiple sessions
+ static string read_buffer_;
+ read_buffer_.erase();
+
+ int const charbuf_size = 100;
+ char charbuf[charbuf_size];
errno = 0;
int status;
// the single = is intended here.
- while ((status = read(fd, charbuf, CMDBUFLEN-1)))
- {// break and return in loop
- if (status > 0) // got something
- {
- charbuf[status]= '\0'; // turn it into a c string
- lsbuf += strip(charbuf, '\r');
- // commit any commands read
- while (lsbuf.find('\n') != string::npos) // while still
- // commands
- // left
- {
- // split() grabs the entire string if
- // the delim /wasn't/ found. ?:-P
- lsbuf= split(lsbuf, cmd,'\n');
- lyxerr[Debug::LYXSERVER]
- << "LyXComm: status:" << status
- << ", lsbuf:" << lsbuf
- << ", cmd:" << cmd << endl;
- if (!cmd.empty())
- c->clientcb(c->client, cmd);
- //\n or not \n?
+ while ((status = ::read(infd, charbuf, charbuf_size - 1))) {
+
+ if (status > 0) {
+ charbuf[status] = '\0'; // turn it into a c string
+ read_buffer_ += rtrim(charbuf, "\r");
+
+ } else if (errno != EAGAIN) {
+ if (!read_buffer_.empty()) {
+ lyxerr << "LyXComm: truncated command: "
+ << read_buffer_ << '\n'
+ << "Resetting connection" << endl;
+ read_buffer_.erase();
}
- }
- if (errno == EAGAIN)
- { // EAGAIN is not really an error , it means we're
- // only reading too fast for the writing process on
- // the other end of the pipe.
- errno = 0;
- return; // up to libforms select-loop (*crunch*)
- }
- if (errno != 0)
- {
- lyxerr << "LyXComm: " << strerror(errno) << endl;
- if (!lsbuf.empty())
- {
- lyxerr << "LyxComm: truncated command: "
- << lsbuf << endl;
- lsbuf.erase();
- }
- break; // reset connection
+
+ // reset connection
+ closeConnection();
+ openConnection();
+ break;
+
+ } else {
+ // errno == EAGAIN
+ // Nothing new has arrived, so now's the time
+ // to tell the outside world if there's anything
+ // in the read buffer.
+ break;
}
}
- c->closeConnection();
- c->openConnection();
- errno= 0;
+
+ if (!read_buffer_.empty()) {
+ read_buffer_ = rtrim(read_buffer_, "\n");
+ lyxerr[Debug::LYXSERVER]
+ << "LyXComm: Received from fd "
+ << infd << '\n'
+ << '\"' << read_buffer_ << '\"' << endl;
+ clientcb(client, read_buffer_);
+ }
+
+ errno = 0;
}
{
lyxerr[Debug::LYXSERVER] << "LyXServer: Received: '"
<< msg << '\'' << endl;
-
+
char const * p = msg.c_str();
-
+
// --- parse the string --------------------------------------------
//
// Format: LYXCMD:<client>:<func>:<argstring>\n
while (*p) {
// --- 1. check 'header' ---
- if (compare(p, "LYXSRV:", 7) == 0) {
- server_only = true;
+ if (compare(p, "LYXSRV:", 7) == 0) {
+ server_only = true;
} else if (0 != compare(p, "LYXCMD:", 7)) {
lyxerr << "LyXServer: Unknown request \"" << p << "\"" << endl;
return;
}
p += 7;
-
+
// --- 2. for the moment ignore the client name ---
string client;
while (*p && *p != ':')
client += char(*p++);
if (*p == ':') ++p;
if (!*p) return;
-
+
// --- 3. get function name ---
string cmd;
while (*p && *p != ':')
cmd += char(*p++);
-
+
// --- 4. parse the argument ---
string arg;
if (!server_only && *p == ':' && *(++p)) {
arg += char(*p++);
if (*p) ++p;
}
-
+
lyxerr[Debug::LYXSERVER]
<< "LyXServer: Client: '" << client
<< "' Command: '" << cmd
<< "' Argument: '" << arg << '\'' << endl;
-
+
// --- lookup and exec the command ------------------
-
+
if (server_only) {
string buf;
- // return the greeting to inform the client that
+ // return the greeting to inform the client that
// we are listening.
if (cmd == "hello") {
// One more client
return;
}
int i= 0; //find place in clients[]
- while (!serv->clients[i].empty()
- && i<serv->numclients)
+ while (!serv->clients[i].empty()
+ && i<serv->numclients)
++i;
serv->clients[i] = client;
serv->numclients++;
}
return;
}
-
+
if (!cmd.empty()) {
// which lyxfunc should we let it connect to?
// The correct solution would be to have a
// connect to the lyxfunc in the single LyXView we
// support currently. (Lgb)
- kb_action action = static_cast<kb_action>(lyxaction.LookupFunc(cmd));
- //int action = -1;
- string rval, buf;
-
- if (action>= 0) {
- rval = serv->func->dispatch(action, arg);
- } else {
- rval = "Unknown command";
- }
- //modified june 1999 stefano@zool.su.se:
+ serv->func->dispatch(cmd + ' ' + arg);
+ string const rval = serv->func->getMessage();
+
+ //modified june 1999 stefano@zool.su.se:
//all commands produce an INFO or ERROR message
//in the output pipe, even if they do not return
//anything. See chapter 4 of Customization doc.
- if (action<0 || serv->func->errorStat())
+ string buf;
+ if (serv->func->errorStat())
buf = "ERROR:";
else
buf = "INFO:";
- buf += string(client) + ":" + cmd + ":" + rval + "\n";
+ buf += client + ":" + cmd + ":" + rval + "\n";
serv->pipes.send(buf);
// !!! we don't do any error checking -
// message is lost and others too
// maybe; so the client should empty
// the outpipe before issuing a request.
-
+
// not found
}
} /* while *p */
/* ---F+------------------------------------------------------------------ *\
- Function : LyxNotifyClient
+ Function : LyXNotifyClient
Called by : WorkAreaKeyPress
Purpose : send a notify messge to a client
Parameters: s - string to send
string buf = string("NOTIFY:") + s + "\n";
pipes.send(buf);
}
-
projects / lyx.git / blobdiff