mirrors/linphone-iphone
1
0
Fork 1
mirror of https://gitlab.linphone.org/BC/public/linphone-iphone.git synced 2026-05-07 05:53:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

improve daemon's documentation

Browse source 
added --dump-commands-html-help
This commit is contained in:
Simon Morlat 2012-12-06 17:50:06 +01:00
parent 48fd03b536
commit f69018fdf7
4 changed files with 64 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
daemon/commands/help.cc
View file

@ -22,7 +22,7 @@ void HelpCommand::exec(Daemon *app, const char *args) {
if (args==NULL){
for (it = l.begin(); it != l.end(); ++it) {
ost << (*it)->getHelp() << endl;
ost << (*it)->getProto() << endl;
}
}
Response resp;

4
daemon/commands/msfilter-add-fmtp.cc
View file

@ -27,6 +27,10 @@ void MSFilterAddFmtpCommand::exec(Daemon *app, const char *args) {
app->sendResponse(Response("No Call with such id."));
return;
}
if (call->audiostream==NULL || call->audiostream->encoder==NULL){
app->sendResponse(Response("This call doesn't have an active audio stream."));
return;
}
ms_filter_call_method(call->audiostream->encoder, MS_FILTER_ADD_FMTP, (void*) args);
} else if(strcmp(type, "stream") == 0) {
AudioStream *stream = app->findAudioStream(id);

58
daemon/daemon.cc
View file

@ -548,6 +548,59 @@ void Daemon::dumpCommandsHelp() {
}
}
static string htmlEscape(const string &orig){
string ret=orig;
size_t pos;
while(1){
pos=ret.find('<');
if (pos!=string::npos){
ret.erase(pos,1);
ret.insert(pos,"&lt");
continue;
}
pos=ret.find('>');
if (pos!=string::npos){
ret.erase(pos,1);
ret.insert(pos,"&gt");
continue;
}
break;
}
while(1){
pos=ret.find('\n');
if (pos!=string::npos){
ret.erase(pos,1);
ret.insert(pos,"<br>");
continue;
}
break;
}
return ret;
}
void Daemon::dumpCommandsHelpHtml(){
cout << endl;
cout << "<!DOCTYPE html><html><body>"<<endl;
cout << "<h1>List of linphone-daemon commands.</h1>"<<endl;
for (list<DaemonCommand*>::iterator it = mCommands.begin(); it != mCommands.end(); ++it) {
cout<<"<h2>"<<htmlEscape((*it)->getProto())<<"</h2>"<<endl;
cout<<"<h3>"<<"Description"<<"</h3>"<<endl;
cout<<"<p>"<<htmlEscape((*it)->getDescription())<<"</p>"<<endl;
cout<<"<h3>"<<"Examples"<<"</h3>"<<endl;
const std::list<const DaemonCommandExample*> &examples=(*it)->getExamples();
cout<<"<p><i>";
for(list<const DaemonCommandExample*>::const_iterator ex_it=examples.begin();ex_it!=examples.end();++ex_it){
cout<<"<b>"<<htmlEscape("Linphone-daemon>")<<htmlEscape((*ex_it)->getCommand())<<"</b><br>"<<endl;
cout<<htmlEscape((*ex_it)->getOutput())<<"<br>"<<endl;
cout<<"<br><br>";
}
cout<<"</i></p>"<<endl;
}
cout << "</body></html>"<<endl;
}
static void printHelp() {
fprintf(stdout, "daemon-linphone [<options>]\n"
@ -565,6 +618,7 @@ static void printHelp() {
"where options are :\n"
"\t--help\t\t\tPrint this notice.\n"
"\t--dump-commands-help\tDump the help of every available commands.\n"
"\t--dump-commands-html-help\tDump the help of every available commands.\n"
"\t--pipe <pipename>\tCreate an unix server socket to receive commands.\n"
"\t--log <path>\t\tSupply a file where the log will be saved\n"
"\t--factory-config <path>\tSupply a readonly linphonerc style config file to start with.\n"
@ -668,6 +722,10 @@ int main(int argc, char *argv[]) {
Daemon app(NULL, NULL, NULL, NULL, false, false);
app.dumpCommandsHelp();
return 0;
}else if (strcmp(argv[i], "--dump-commands-html-help") == 0) {
Daemon app(NULL, NULL, NULL, NULL, false, false);
app.dumpCommandsHelpHtml();
return 0;
} else if (strcmp(argv[i], "--pipe") == 0) {
if (i + 1 >= argc) {
fprintf(stderr, "no pipe name specify after --pipe");

1
daemon/daemon.h
View file

@ -180,6 +180,7 @@ public:
inline int maxProxyId() { return mProxyIds; };
int updateAudioStreamId(AudioStream *audio_stream);
void dumpCommandsHelp();
void dumpCommandsHelpHtml();
private:
static void* iterateThread(void *arg);
static void callStateChanged(LinphoneCore *lc, LinphoneCall *call, LinphoneCallState state, const char *msg);