- Sofaswitch-svn - FreeSWITCH Mailing Lists

[commit] r112 - sofaswitch/trunk/callflow/docs
by SofaSWITCH SVN 22 Sep '06

22 Sep '06

Author: derek Date: Thu Sep 21 22:54:30 2006 New Revision: 112 Added: sofaswitch/trunk/callflow/docs/forloop.png (contents, props changed) sofaswitch/trunk/callflow/docs/overview.dxy Log: Add these files, as we now use a documentation directory. Added: sofaswitch/trunk/callflow/docs/forloop.png ============================================================================== Binary file. No diff available. Added: sofaswitch/trunk/callflow/docs/overview.dxy ============================================================================== --- (empty file) +++ sofaswitch/trunk/callflow/docs/overview.dxy Thu Sep 21 22:54:30 2006 @@ -0,0 +1,66 @@ +/*! \mainpage CallFlow - SofaSwitch control script generator + + +\section introduction Introduction + + This is an Open Source application specifically designed + to ease the development of call control in the SofaSwitch suite + of applications. + + The code is based on wxWidgets (for portability), in C++ (for + functionality and ease of integrating with exWidgets) and has + been released under the MPL license. + +Last updated 15 September 2006 + +Copyright (C) 2006 Indranet Technologies Ltd, All right reserved + +\section WhyCallFlow Why do we neeed CallFlow ? +My (DJS) initial thoughts on the design of SofaSwitch was that there would +be individual entities (server, voip, am etc) all controlled by a custom +script, written in some scripting language. I wrote the entities first, and +then wrote simple python scripts to test the entities. + +The python scripts started to grow quite large. Along the way, I altered the +control protocol, as I realised that there were some aspects missing from the +original design. This had the unfortunate outcome of making those scripts +invalid. A second lesson was learnt - python is not very good on +threads. Things like the global interpreter lock started to get in the +way. python script. + +At this stage, I was uncertain. Should I change to a different (and more +superior) scripting language? Some thought and discussion showed that python +is the way to go. Choosing an unknonw (but superior?) language like XYZ would +indeed solve the above problems, but introduce two new problems: 1)it is now +much harder to get get going in the project and 2)it becomes much harder to +install sofaswitch. Minor considerations such as, "we might loose +cross-platform features if we switch to XYZ" were part of the problem space. + +Clearly, the way ahead was to write a custom utility to write the python +controlscripts. Now, we expect that some may wish to write their own python +scripts. This is fine - you are welcome to learn from our current +codebase. Given the modular structure of SofaSwitch, this is +inevitable. Different modules will be glued together in different ways. + +Thus, the design of CallFlow was such that you can create scripts to do very +complex things with the minimum of effort. + +\section WhatDo What does CallFlow do ? +In this section, I describe, in overview, what CallFlow does + +\li Draw the diagram of the call handling for one call +\li Compile this to python, which creates two files. The first file + describes the graph, and the second file describes the handling of + the graph. The second file is "hardwired" to load that particular + graph file. However, the second file is is, essentially, the same between + every compile. +\li You use Python to execute the second file, which loads the graph file. + + + +\subsection history History + +\li 15 September 2006 - Created by Derek J Smithies +\li 21 September 2006 - Add Why section Derek J Smithies + +*/

1 0

[commit] r111 - in sofaswitch/trunk/callflow: . docs src
by SofaSWITCH SVN 22 Sep '06

22 Sep '06

Author: derek Date: Thu Sep 21 22:53:18 2006 New Revision: 111 Added: sofaswitch/trunk/callflow/docs/ Modified: sofaswitch/trunk/callflow/overview.dxy sofaswitch/trunk/callflow/src/shapelist.cpp Log: Work on docs, and get network events processed right. Modified: sofaswitch/trunk/callflow/overview.dxy ============================================================================== --- sofaswitch/trunk/callflow/overview.dxy (original) +++ sofaswitch/trunk/callflow/overview.dxy Thu Sep 21 22:53:18 2006 @@ -45,6 +45,17 @@ Thus, the design of CallFlow was such that you can create scripts to do very complex things with the minimum of effort. +\section WhatDo What does CallFlow do ? +In this section, I describe, in overview, what CallFlow does + +\li Draw the diagram of the call handling for one call +\li Compile this to python, which creates two files. The first file + describes the graph, and the second file describes the handling of + the graph. The second file is "hardwired" to load that particular + graph file. However, the second file is is, essentially, the same between + every compile. +\li You use Python to execute the second file, which loads the graph file. + \subsection history History Modified: sofaswitch/trunk/callflow/src/shapelist.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/shapelist.cpp (original) +++ sofaswitch/trunk/callflow/src/shapelist.cpp Thu Sep 21 22:53:18 2006 @@ -288,6 +288,10 @@ file.AddLine("import re "); file.AddLine("from twisted.internet import reactor, protocol "); file.AddLine(" "); + file.AddLine("sofaServer = \"localhost\" "); + file.AddLine("if len(sys.argv) > 1: "); + file.AddLine(" sofaServer = sys.argv[1] "); + file.AddLine(" "); file.AddLine("class Controller(protocol.Protocol): "); file.AddLine(" \"\"\" The class which holds all the information on how to manage each entity"); file.AddLine(" on the flow chart, how to connect, and does the requisite calls to twisted "); @@ -302,7 +306,7 @@ file.AddLine(" self.currentHandlers= {} "); file.AddLine(" self.knownNetworkMessages= [] "); file.AddLine(" self.knownNetworkMessages.append(\"REQUESTNEWID\") "); - file.AddLine(" self.knownNetworkMessages.append(\"DTMF\") "); + file.AddLine(" self.knownNetworkMessages.append(\"RECEIVEDDTMF\") "); // file.AddLine(" self.knownNetworkMessages.append(\"\") "); char c= 34; wxString tString = wxString::Format(" self.quote = \"\\%c\"", c); @@ -463,6 +467,8 @@ file.AddLine(" initialise, and activate the next step of initialise. Or, it is an ordinary "); file.AddLine(" message that has to be processed "); file.AddLine(" \"\"\" "); + file.AddLine(" while data.find(\" \") >= 0: "); + file.AddLine(" data = data.replace(\" \", \" \") "); file.AddLine(" ssdata = str(data).split(\'\\0\') "); file.AddLine(" for oneMessage in ssdata: "); file.AddLine(" self.countReceived += 1 "); @@ -485,6 +491,7 @@ file.AddLine(" Note that this method can only deal with certain predefined "); file.AddLine(" types of messages "); file.AddLine(" \"\"\" "); + file.AddLine(" thisMessage = thisMessage.strip() "); file.AddLine(" if len(thisMessage) > 2: "); file.AddLine(" print \"Received \", thisMessage "); file.AddLine(" for msg in self.knownNetworkMessages: "); @@ -539,7 +546,7 @@ file.AddLine(" "); file.AddLine("f = MyFactory() "); file.AddLine("f.setGraph(\"a_graph\") "); - file.AddLine("reactor.connectTCP(\"localhost\", 5000, f) "); + file.AddLine("reactor.connectTCP(sofaServer, 5000, f) "); file.AddLine("reactor.run() "); file.AddLine(" "); file.Write();

1 0

[commit] r110 - in sofaswitch/trunk/callflow: src tests
by SofaSWITCH SVN 21 Sep '06

21 Sep '06

Author: derek Date: Thu Sep 21 19:47:42 2006 New Revision: 110 Modified: sofaswitch/trunk/callflow/src/conditional.cpp sofaswitch/trunk/callflow/src/eventer.cpp sofaswitch/trunk/callflow/src/python.cpp sofaswitch/trunk/callflow/src/shapelist.cpp sofaswitch/trunk/callflow/src/startfor.cpp sofaswitch/trunk/callflow/src/timer.cpp sofaswitch/trunk/callflow/tests/requestnode.src sofaswitch/trunk/callflow/tests/timetest.src Log: Finish adding python regular expression testing on events. Seperate out notion on competing timer, as this is confusing. Update Test scripts. Modified: sofaswitch/trunk/callflow/src/conditional.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/conditional.cpp (original) +++ sofaswitch/trunk/callflow/src/conditional.cpp Thu Sep 21 19:47:42 2006 @@ -29,7 +29,7 @@ AdjustIoPoints(); displayData[displayData.size()] = - InformationSection(wxT("Test"), wxT("variable == 0")); + InformationSection(wxT("Test (Python code)"), wxT("variable == 0")); } void DndShapeConditional::Draw(wxDC& dc) Modified: sofaswitch/trunk/callflow/src/eventer.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/eventer.cpp (original) +++ sofaswitch/trunk/callflow/src/eventer.cpp Thu Sep 21 19:47:42 2006 @@ -33,9 +33,6 @@ displayData[displayData.size()] = InformationSection(wxT("Event sought (Regular Exp)"), wxT("*DTMF")); - - displayData[displayData.size()] = - InformationSection(wxT("Competing timer label"), wxT("")); } bool DndShapeEventer::TestInternalVariables() @@ -117,7 +114,12 @@ file.AddLine(" link not be connected, a None value will be returned. "); file.AddLine(" \"\"\" "); file.AddLine(" a,b,c = sTuple "); - file.AddLine(" self.currentHandlers[self.data[a][\"Event\"]] = a "); + file.AddLine(" ePyn = self.data[a][\"Event Python\"] "); + file.AddLine(" eReg = self.data[a][\"Event RegExp\"] "); + file.AddLine(" if len(ePyn) > 0: "); + file.AddLine(" self.currentHandlers[eval(ePyn)] = a "); + file.AddLine(" else: "); + file.AddLine(" self.currentHandlers[eReg] = a "); file.AddLine(" return self.data[a][\"OutputKeepGoing\"] "); file.AddLine(""); @@ -150,9 +152,6 @@ file.AddLine(wxString::Format(" \"Event RegExp\" : ")); file.AddLine(wxString::Format(" \"%s\", ", displayData[2].data.c_str())); - - file.AddLine(wxString::Format(" \"Competing timer label\" : ")); - file.AddLine(wxString::Format(" \"%s\", ", displayData[3].data.c_str())); file.AddLine(wxString::Format(" },")); Modified: sofaswitch/trunk/callflow/src/python.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/python.cpp (original) +++ sofaswitch/trunk/callflow/src/python.cpp Thu Sep 21 19:47:42 2006 @@ -35,7 +35,7 @@ void DndShapePython::Draw(wxDC& dc) { DrawCompileError(dc); - dc.SetPen(*wxBLACK_PEN); + dc.SetBrush(wxBrush(*wxBLACK, wxSOLID)); wxPoint p1(m_rect.GetPosition()); wxPoint pA(p1.x + 25, p1.y + 15); Modified: sofaswitch/trunk/callflow/src/shapelist.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/shapelist.cpp (original) +++ sofaswitch/trunk/callflow/src/shapelist.cpp Thu Sep 21 19:47:42 2006 @@ -285,6 +285,7 @@ file.AddLine("import time "); file.AddLine("import socket "); file.AddLine("import distutils "); + file.AddLine("import re "); file.AddLine("from twisted.internet import reactor, protocol "); file.AddLine(" "); file.AddLine("class Controller(protocol.Protocol): "); @@ -358,22 +359,22 @@ file.AddLine(" for which there was no corresponding handler. We cannot have these "); file.AddLine(" hanging around. It would give weird output if they were processed at "); file.AddLine(" some later time when the program adds a handler for this case "); - file.AddLine(" \"\"\" "); - file.AddLine(" #print \"processQueue\" "); - file.AddLine(" #print \"current handlers \", self.currentHandlers "); - file.AddLine(" #print \"current events \", self.generatedEvents "); - file.AddLine(" #print \"pending events \", self.pendingEvents "); - file.AddLine(" keys = self.generatedEvents.keys() "); - file.AddLine(" for k in range(len(keys)): "); - file.AddLine(" if self.currentHandlers.has_key(keys[k]): "); - file.AddLine(" eventNode = self.currentHandlers[keys[k]] "); - file.AddLine(" eventData = self.generatedEvents.pop(keys[k]) "); - file.AddLine(" cTimer = self.data[eventNode][\"Competing timer label\"]"); - file.AddLine(" self.DeleteThisEvent(cTimer) "); - file.AddLine(" handler = self.data[eventNode][\"Event Handler\"]"); - file.AddLine(" a,b,c = handler "); - file.AddLine(" self.data[a][\"Event Data\"] = eventData "); - file.AddLine(" self.DoWork(handler) "); + file.AddLine(" \"\"\" "); + file.AddLine(" #print \"processQueue\" "); + file.AddLine(" #print \"current handlers \", self.currentHandlers "); + file.AddLine(" #print \"current events \", self.generatedEvents "); + file.AddLine(" #print \"pending events \", self.pendingEvents "); + file.AddLine(" for handler in self.currentHandlers.keys(): "); + file.AddLine(" hre = re.compile(handler) "); + file.AddLine(" for event in self.generatedEvents.keys(): "); + file.AddLine(" if len(hre.split(event)) > 1: "); + file.AddLine(" #found a match "); + file.AddLine(" eventNode = self.currentHandlers[handler] "); + file.AddLine(" eventData = self.generatedEvents.pop(event) "); + file.AddLine(" eHandler = self.data[eventNode][\"Event Handler\"] "); + file.AddLine(" a,b,c = eHandler "); + file.AddLine(" self.data[a][\"Event Data\"] = eventData "); + file.AddLine(" self.DoWork(eHandler) "); file.AddLine(" self.generatedEvents.clear() "); file.AddLine(" "); file.AddLine(" def networkEventData(self, eName, data): "); Modified: sofaswitch/trunk/callflow/src/startfor.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/startfor.cpp (original) +++ sofaswitch/trunk/callflow/src/startfor.cpp Thu Sep 21 19:47:42 2006 @@ -30,13 +30,13 @@ AdjustIoPoints(); displayData[displayData.size()] = - InformationSection(wxT("Initialise"), wxT("i = 0")); + InformationSection(wxT("Initialise (Python code)"), wxT("self.i = 0")); displayData[displayData.size()] = - InformationSection(wxT("Test for Termination"), wxT("i < loops")); + InformationSection(wxT("Test for Termination (Python code)"), wxT("self.i < loops")); displayData[displayData.size()] = - InformationSection(wxT("Increment"), wxT("i++")); + InformationSection(wxT("Increment (Python code)"), wxT("self.i++")); } void DndShapeStartFor::Draw(wxDC& dc) Modified: sofaswitch/trunk/callflow/src/timer.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/timer.cpp (original) +++ sofaswitch/trunk/callflow/src/timer.cpp Thu Sep 21 19:47:42 2006 @@ -41,7 +41,7 @@ InformationSection(wxT("Timer period (seconds)"), wxT("2")); displayData[displayData.size()] = - InformationSection(wxT("Timer label"), wxT("thistimer")); + InformationSection(wxT("Timer label (string literal)"), wxT("thistimer")); AdjustIoPoints(); } Modified: sofaswitch/trunk/callflow/tests/requestnode.src ============================================================================== --- sofaswitch/trunk/callflow/tests/requestnode.src (original) +++ sofaswitch/trunk/callflow/tests/requestnode.src Thu Sep 21 19:47:42 2006 @@ -1 +1 @@ -14244255 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought<ms>voipREQUESTNEWID<ms><special>Competing timer label<ms>requestnode<ms><special> <Shape>2230347 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>10232204 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print \"Have requested a node from voip at \", time.asctime()<ms><special> <Shape>1231108 extra <special>Tool Tip<ms>Start Processing<ms><special> <Shape>11232159 extra <special>Tool Tip<ms>Request Node<ms><special>Request node from<ms>voip<ms><special>Timer period (seconds)<ms>1<ms><special>Timer label<ms>requestnode<ms><special> <Shape>10231295 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print \"have a new node on \", self.data[self.currentNode][\"Event Data\"]<ms><special> <Shape> +13231340 extra <special>Tool Tip<ms>Stop Timer<ms><special>Timer to stop<ms>requestnode<ms><special> <Shape>1231108 extra <special>Tool Tip<ms>Start Processing<ms><special> <Shape>10323322 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print \"timer has expired at \", time.asctime()<ms><special> <Shape>2231391 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>9289276289,277,349,276<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>11232159 extra <special>Tool Tip<ms>Request Node<ms><special>Request node from<ms>voip<ms><special>Timer period (seconds)<ms>1<ms><special>Timer label<ms>requestnode<ms><special> <Shape>10232204 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print \"Have requested a node from voip at \", time.asctime()<ms><special> <Shape>10231295 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print \"have a new node on \", self.data[self.currentNode][\"Event Data\"]<ms><special> <Shape>9259371347,371,259,391<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>14243255 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>NEWID<ms><special> <Shape>14334279 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>requestnode<ms><special> <Shape> Modified: sofaswitch/trunk/callflow/tests/timetest.src ============================================================================== --- sofaswitch/trunk/callflow/tests/timetest.src (original) +++ sofaswitch/trunk/callflow/tests/timetest.src Thu Sep 21 19:47:42 2006 @@ -1 +1 @@ -12123122 extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds)<ms>1<ms><special>Timer label<ms>timer1<ms><special> <Shape>9150272151,272,150,344,232,354<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>10126221 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print \"t1 \", time.asctime(), \" data is \", self.data[self.currentNode][\"Event Data\"]<ms><special> <Shape>12206198 extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds)<ms>2<ms><special>Timer label<ms>timer2<ms><special> <Shape>9187196187,196,230,197<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>14137173 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought<ms>timer1<ms><special>Competing timer label<ms><ms><special> <Shape>1012374 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print \"Start \", time.asctime()<ms><special> <Shape>112326 extra <special>Tool Tip<ms>Start Processing<ms><special> <Shape>2207352 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>10207305 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print \"t2 \", time.asctime(), \" data is \", self.data[self.currentNode][\"Event Data\"]<ms><special> <Shape>14218251 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought<ms>timer2<ms><special>Competing timer label<ms><ms><special> <Shape> +12207202 extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds)<ms>2<ms><special>Timer label<ms>timer2<ms><special> <Shape>1012374 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print \"Start \", time.asctime()<ms><special> <Shape>14218254 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>timer2<ms><special> <Shape>2207352 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>14137175 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>timer1<ms><special> <Shape>10247371 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print \"t10 \", time.asctime(), \" data is \", self.data[self.currentNode][\"Event Data\"]<ms><special> <Shape>10207305 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print \"t2 \", time.asctime(), \" data is \", self.data[self.currentNode][\"Event Data\"]<ms><special> <Shape>10126221 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print \"t1 \", time.asctime(), \" data is \", self.data[self.currentNode][\"Event Data\"]<ms><special> <Shape>12244274 extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds)<ms>10<ms><special>Timer label (string literal)<ms>t10<ms><special> <Shape>9188201188,201,231,202<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>14259327 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>10<ms><special> <Shape>9175354275,421,175,421,181,363,228,354<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>12123122 extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds)<ms>1<ms><special>Timer label<ms>timer1<ms><special> <Shape>9150272151,272,150,344,232,354<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>112326 extra <special>Tool Tip<ms>Start Processing<ms><special> <Shape>

1 0

[commit] r109 - in sofaswitch/trunk/callflow: . src
by SofaSWITCH SVN 21 Sep '06

21 Sep '06

Author: derek Date: Thu Sep 21 01:19:27 2006 New Revision: 109 Modified: sofaswitch/trunk/callflow/Makefile.am sofaswitch/trunk/callflow/overview.dxy sofaswitch/trunk/callflow/src/callflow.cpp sofaswitch/trunk/callflow/src/dnd.cpp sofaswitch/trunk/callflow/src/dnd.h sofaswitch/trunk/callflow/src/eventer.cpp sofaswitch/trunk/callflow/src/eventer.h sofaswitch/trunk/callflow/src/information.cpp sofaswitch/trunk/callflow/src/shapelist.cpp Log: Documentation improvement. Add ability to specify a regular expression to describe the event sought. In this way, an event handler could catch every dtmf event sent by any node (that is controlled by this particular call flow). Add some new Make targets, and associated documentation. Resize the information window. Resize the main window. Modified: sofaswitch/trunk/callflow/Makefile.am ============================================================================== --- sofaswitch/trunk/callflow/Makefile.am (original) +++ sofaswitch/trunk/callflow/Makefile.am Thu Sep 21 01:19:27 2006 @@ -5,6 +5,7 @@ doc:docs +both:all docs: doxygen callflow.dxy @@ -16,6 +17,10 @@ @echo " " @echo "Available make targets" @echo "=================================================" + @echo " " + @echo "all build everything" + @echo " " + @echo "both build everything" @echo " " @echo "dist create a tarball of the source files" @echo " " Modified: sofaswitch/trunk/callflow/overview.dxy ============================================================================== --- sofaswitch/trunk/callflow/overview.dxy (original) +++ sofaswitch/trunk/callflow/overview.dxy Thu Sep 21 01:19:27 2006 @@ -15,10 +15,41 @@ Copyright (C) 2006 Indranet Technologies Ltd, All right reserved +\section WhyCallFlow Why do we neeed CallFlow ? +My (DJS) initial thoughts on the design of SofaSwitch was that there would +be individual entities (server, voip, am etc) all controlled by a custom +script, written in some scripting language. I wrote the entities first, and +then wrote simple python scripts to test the entities. -\subsection history History +The python scripts started to grow quite large. Along the way, I altered the +control protocol, as I realised that there were some aspects missing from the +original design. This had the unfortunate outcome of making those scripts +invalid. A second lesson was learnt - python is not very good on +threads. Things like the global interpreter lock started to get in the +way. python script. -\li 15 September 2005 - Created by Derek J Smithies +At this stage, I was uncertain. Should I change to a different (and more +superior) scripting language? Some thought and discussion showed that python +is the way to go. Choosing an unknonw (but superior?) language like XYZ would +indeed solve the above problems, but introduce two new problems: 1)it is now +much harder to get get going in the project and 2)it becomes much harder to +install sofaswitch. Minor considerations such as, "we might loose +cross-platform features if we switch to XYZ" were part of the problem space. +Clearly, the way ahead was to write a custom utility to write the python +controlscripts. Now, we expect that some may wish to write their own python +scripts. This is fine - you are welcome to learn from our current +codebase. Given the modular structure of SofaSwitch, this is +inevitable. Different modules will be glued together in different ways. + +Thus, the design of CallFlow was such that you can create scripts to do very +complex things with the minimum of effort. + + + +\subsection history History + +\li 15 September 2006 - Created by Derek J Smithies +\li 21 September 2006 - Add Why section Derek J Smithies */ Modified: sofaswitch/trunk/callflow/src/callflow.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/callflow.cpp (original) +++ sofaswitch/trunk/callflow/src/callflow.cpp Thu Sep 21 01:19:27 2006 @@ -162,6 +162,11 @@ CreateStatusBar(); SetStatusText(" Welcome to Call Flow. "); + + int w, h; + GetSize(&w, &h); + w= w << 1; + SetSize(w, h); } Modified: sofaswitch/trunk/callflow/src/dnd.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/dnd.cpp (original) +++ sofaswitch/trunk/callflow/src/dnd.cpp Thu Sep 21 01:19:27 2006 @@ -338,6 +338,12 @@ return outputPoints.AllLinked(); } +bool DndShape::TestInternalVariables() +{ + ClearCompileError(); + return true; +} + void DndShape::StoreNewKey(wxString newKey) { uniqueKey = newKey; Modified: sofaswitch/trunk/callflow/src/dnd.h ============================================================================== --- sofaswitch/trunk/callflow/src/dnd.h (original) +++ sofaswitch/trunk/callflow/src/dnd.h Thu Sep 21 01:19:27 2006 @@ -480,6 +480,17 @@ void SetCompileError(const wxString & newError) { compileError = newError; } + /**Examine the different shape specific variables, and check them for + correctness. This method is called as part of the compile process. One + illustration is DndShapeEventer, which is required to name one event to + look for. Conversely, there is nothing the DndShapeSelect can do which + will stop the compilation process. + + On finding a fault, the compileError variable will be set, and false + returned. On success, true will be returned and compileError will be + cleared.*/ + virtual bool TestInternalVariables(); + /**Draw to the screen the current compile message for this shape */ void DrawCompileError(wxDC & dc); Modified: sofaswitch/trunk/callflow/src/eventer.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/eventer.cpp (original) +++ sofaswitch/trunk/callflow/src/eventer.cpp Thu Sep 21 01:19:27 2006 @@ -29,12 +29,38 @@ AdjustIoPoints(); displayData[displayData.size()] = - InformationSection(wxT("Event sought"), wxT("incoming")); + InformationSection(wxT("Event sought (Python code)"), wxT("")); displayData[displayData.size()] = + InformationSection(wxT("Event sought (Regular Exp)"), wxT("*DTMF")); + + displayData[displayData.size()] = InformationSection(wxT("Competing timer label"), wxT("")); } +bool DndShapeEventer::TestInternalVariables() +{ + DndShape::TestInternalVariables(); + + bool oneEmpty = displayData[1].data.IsEmpty(); + bool twoEmpty = displayData[2].data.IsEmpty(); + + if (oneEmpty && (!twoEmpty)) { + return true; + } + + if (twoEmpty && (!oneEmpty)) { + return true; + } + + if (oneEmpty && twoEmpty) + SetCompileError(wxT("Cannot specify both python code and a regular expression.\nEnter just one statement.")); + else + SetCompileError(wxT("You must enter one statement.\nEither python code, or a regular expression")); + + return false; +} + void DndShapeEventer::Draw(wxDC& dc) { DrawCompileError(dc); @@ -88,7 +114,7 @@ file.AddLine(" def Eventer(self, sTuple): "); file.AddLine(" \"\"\"Register the left down output as being available to handle a particular event "); file.AddLine(" After registration, continue execution to right horizontal output. Should this "); - file.AddLine(" link not be connected, a None value will be returned. "); + file.AddLine(" link not be connected, a None value will be returned. "); file.AddLine(" \"\"\" "); file.AddLine(" a,b,c = sTuple "); file.AddLine(" self.currentHandlers[self.data[a][\"Event\"]] = a "); @@ -119,11 +145,14 @@ file.AddLine(wxString::Format(" \"OutputKeepGoing\" : ")); file.AddLine(wxString::Format(" %s, ", outputLabel2.c_str())); - file.AddLine(wxString::Format(" \"Event\" : ")); + file.AddLine(wxString::Format(" \"Event Python\" : ")); file.AddLine(wxString::Format(" \"%s\", ", displayData[1].data.c_str())); - file.AddLine(wxString::Format(" \"Competing timer label\" : ")); + file.AddLine(wxString::Format(" \"Event RegExp\" : ")); file.AddLine(wxString::Format(" \"%s\", ", displayData[2].data.c_str())); + + file.AddLine(wxString::Format(" \"Competing timer label\" : ")); + file.AddLine(wxString::Format(" \"%s\", ", displayData[3].data.c_str())); file.AddLine(wxString::Format(" },")); Modified: sofaswitch/trunk/callflow/src/eventer.h ============================================================================== --- sofaswitch/trunk/callflow/src/eventer.h (original) +++ sofaswitch/trunk/callflow/src/eventer.h Thu Sep 21 01:19:27 2006 @@ -3,10 +3,20 @@ #include "dnd.h" -////////////////////////////////////////////////////////////////////////////////////////////// -/**Define a event registration, and wait for event shape. Normal flow of execution enters this shape, -and an event is registered for. There is always a connection to the event detected and process output. -There is an optional outgoing connection for the "do other things while waiting" output. */ +///////////////////////////////////////////////////////////////////////////// +/**Define a event registration, and wait for event shape. Normal flow of + execution enters this shape, and an event is registered for. + + There is always a connection to the event detected and process output. + There is an optional outgoing connection for the "do other things while + waiting" output. + + The user may specify the event in one of two ways. Either as a 1) python + regular expression, or as 2)the outcome of some python calculations. The + outcome of either way is treated as a python regular expression, which is + compared with the current events. It is an error to specify the event + sought for in both ways. +*/ class DndShapeEventer : public DndShape { public: @@ -33,6 +43,9 @@ /**Check that every output point of this shape goes somewhere. Return False if there is a dangling output point */ virtual bool CheckOutputPointsLinked(); + + /**Make cerrtain that there is one valid event to look for.*/ + virtual bool TestInternalVariables(); }; #endif // SHAPE_EVENTER_H Modified: sofaswitch/trunk/callflow/src/information.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/information.cpp (original) +++ sofaswitch/trunk/callflow/src/information.cpp Thu Sep 21 01:19:27 2006 @@ -46,9 +46,10 @@ mainsizer -> Add (staticText[i], 0, wxALL | wxEXPAND, 1); wxString initialMessage = wxString::Format("initial value %d", i + 1); + wxSize nSize = wxSize(400,50); textEntry[i] = new wxTextCtrl(this, wxID_ANY, initialMessage, - wxDefaultPosition, wxDefaultSize, + wxDefaultPosition, nSize, wxTE_MULTILINE); textEntry[i]->SetValue(data[i].data); mainsizer -> Add(textEntry[i], 0, wxALL | wxEXPAND, 10); Modified: sofaswitch/trunk/callflow/src/shapelist.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/shapelist.cpp (original) +++ sofaswitch/trunk/callflow/src/shapelist.cpp Thu Sep 21 01:19:27 2006 @@ -219,15 +219,19 @@ ClearConnectionPoints(); MarkConnectionPoints(); - /***Zero, go through and remove all previous compiler errors */ - MyListShapes::iterator it = begin(); + /* First, go through and check that all variables etc are set correctly. + This will also remove all previous compiler errors */ + MyListShapes::iterator it = begin(); + bool variablesOk = true; while (it != end()) { DndShape *thisShape = it->second; - thisShape->ClearCompileError(); + if (thisShape != NULL) { + variablesOk = thisShape->TestInternalVariables(); + } it++; - } + } - /**First, go through and check all output points link to something. */ + /**Second, go through and check all output points link to something. */ bool pointsLinked = true; it = begin(); while (it != end()) { @@ -239,10 +243,10 @@ it++; } - if (!pointsLinked) + if ((!pointsLinked) || (!variablesOk)) return false; - /**second go through and calculate reverse links etc. */ + /**third go through and calculate reverse links etc. */ it = begin(); while (it != end()) { DndShape *thisShape = it->second; @@ -254,7 +258,7 @@ it++; } - /**third, go through and set the kind variable on all input&output points */ + /**fourth, go through and set the kind variable on all input&output points */ it = begin(); while (it != end()) { DndShape *thisShape = it->second;

1 0

[commit] r108 - sofaswitch/trunk/callflow
by SofaSWITCH SVN 19 Sep '06

19 Sep '06

Author: derek Date: Tue Sep 19 00:54:56 2006 New Revision: 108 Modified: sofaswitch/trunk/callflow/Makefile.am sofaswitch/trunk/callflow/callflow.dxy sofaswitch/trunk/callflow/overview.dxy Log: Get documentatin to work correctly. Modified: sofaswitch/trunk/callflow/Makefile.am ============================================================================== --- sofaswitch/trunk/callflow/Makefile.am (original) +++ sofaswitch/trunk/callflow/Makefile.am Tue Sep 19 00:54:56 2006 @@ -3,7 +3,33 @@ MAKEFLAGS=-j$(shell cat /proc/cpuinfo | grep processor | wc -l) SUBDIRS = src +doc:docs + docs: doxygen callflow.dxy + +veryclean:distclean + @rm -fR html + +help: + @echo " " + @echo "Available make targets" + @echo "=================================================" + @echo " " + @echo "dist create a tarball of the source files" + @echo " " + @echo "doc generate html description files of the source code" + @echo "docs generate html description files of the source code" + @echo " " + @echo "help print this message out" + @echo " " + @echo "clean remove the object and executable files" + @echo " " + @echo "distclean a clean plus the working log files of the build" + @echo " " + @echo "veryclean remove every possible file that is not needed." + + + Modified: sofaswitch/trunk/callflow/callflow.dxy ============================================================================== --- sofaswitch/trunk/callflow/callflow.dxy (original) +++ sofaswitch/trunk/callflow/callflow.dxy Tue Sep 19 00:54:56 2006 @@ -3,7 +3,7 @@ #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -PROJECT_NAME = CallFlow - An automated control script generator +PROJECT_NAME = CallFlow - SofaSwitch control script generator PROJECT_NUMBER = 1.0.0 OUTPUT_DIRECTORY = CREATE_SUBDIRS = NO @@ -72,8 +72,8 @@ #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = -FILE_PATTERNS = *.h overview.cxx +INPUT = src . +FILE_PATTERNS = *.h overview.dxy RECURSIVE = NO EXCLUDE = EXCLUDE_SYMLINKS = NO Modified: sofaswitch/trunk/callflow/overview.dxy ============================================================================== --- sofaswitch/trunk/callflow/overview.dxy (original) +++ sofaswitch/trunk/callflow/overview.dxy Tue Sep 19 00:54:56 2006 @@ -1,4 +1,4 @@ -/*! \mainpage CallFlow - Generate call handling scripts for SofaSwitch +/*! \mainpage CallFlow - SofaSwitch control script generator \section introduction Introduction

1 0

[commit] r107 - sofaswitch/trunk/callflow
by SofaSWITCH SVN 19 Sep '06

19 Sep '06

Author: derek Date: Tue Sep 19 00:04:31 2006 New Revision: 107 Added: sofaswitch/trunk/callflow/callflow.dxy Log: Add Dot equipped doxygen file. Added: sofaswitch/trunk/callflow/callflow.dxy ============================================================================== --- (empty file) +++ sofaswitch/trunk/callflow/callflow.dxy Tue Sep 19 00:04:31 2006 @@ -0,0 +1,223 @@ +# Doxyfile 1.4.6 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = CallFlow - An automated control script generator +PROJECT_NUMBER = 1.0.0 +OUTPUT_DIRECTORY = +CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +USE_WINDOWS_ENCODING = NO +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +DETAILS_AT_TOP = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 8 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +BUILTIN_STL_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_BY_SCOPE_NAME = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_DIRECTORIES = NO +FILE_VERSION_FILTER = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = +FILE_PATTERNS = *.h overview.cxx +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +USE_HTAGS = NO +VERBATIM_HEADERS = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1024 +MAX_DOT_GRAPH_HEIGHT = 1024 +MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO

1 0

[commit] r106 - sofaswitch/trunk/callflow
by SofaSWITCH SVN 19 Sep '06

19 Sep '06

Author: derek Date: Mon Sep 18 23:58:03 2006 New Revision: 106 Removed: sofaswitch/trunk/callflow/callflow.dxy Log: Temporarily remove this file.

1 0

[commit] r105 - sofaswitch/trunk/sound
by SofaSWITCH SVN 19 Sep '06

19 Sep '06

Author: derek Date: Mon Sep 18 23:47:21 2006 New Revision: 105 Modified: sofaswitch/trunk/sound/comms.cxx sofaswitch/trunk/sound/comms.h sofaswitch/trunk/sound/main.cxx Log: Use library method to advise the remote controller of dtmf received (read from the keyboard). Modified: sofaswitch/trunk/sound/comms.cxx ============================================================================== --- sofaswitch/trunk/sound/comms.cxx (original) +++ sofaswitch/trunk/sound/comms.cxx Mon Sep 18 23:47:21 2006 @@ -112,12 +112,6 @@ MessageFrame::WaitForTermination(); } -void Comms::SendMessageToController(PString & message) -{ - SendThisMessageTo(message, GetRemoteController()); -} - - void Comms::SilentlyEndAll() { Modified: sofaswitch/trunk/sound/comms.h ============================================================================== --- sofaswitch/trunk/sound/comms.h (original) +++ sofaswitch/trunk/sound/comms.h Mon Sep 18 23:47:21 2006 @@ -69,11 +69,7 @@ /**Block the calling process, and return when the threads have terminated */ virtual void WaitForTermination(); - - /**Send this message to the current controller. Typically, this will be a - * message stating that dtmf has been read from the keyboard. */ - void SendMessageToController(PString & message); - + /**Report if we were stopped by hangup */ BOOL StoppedByHangup() { return stopByHangup; } Modified: sofaswitch/trunk/sound/main.cxx ============================================================================== --- sofaswitch/trunk/sound/main.cxx (original) +++ sofaswitch/trunk/sound/main.cxx Mon Sep 18 23:47:21 2006 @@ -68,8 +68,7 @@ case 'd' : { PString message; console >> message; - message = PString("SENDDTMF ") + message; - comms.SendMessageToController(message); + comms.DtmfReceivedFromTheWorld(message); cout << "Command ? " << flush; } break;

1 0

[commit] r104 - in sofaswitch/trunk: server sound
by SofaSWITCH SVN 19 Sep '06

19 Sep '06

Author: derek Date: Mon Sep 18 23:28:46 2006 New Revision: 104 Modified: sofaswitch/trunk/server/docs.cfg sofaswitch/trunk/sound/docs.cfg Log: Fix docs configuration files. Modified: sofaswitch/trunk/server/docs.cfg ============================================================================== --- sofaswitch/trunk/server/docs.cfg (original) +++ sofaswitch/trunk/server/docs.cfg Mon Sep 18 23:28:46 2006 @@ -1,41 +1,43 @@ -# Doxyfile 1.0.0 +# Doxyfile 1.4.6 #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -PROJECT_NAME = "SSServer, or Sofa Switch Server" -PROJECT_NUMBER = +PROJECT_NAME = Server - from the SofaSwitch set of utilities +PROJECT_NUMBER = 1.0.0 OUTPUT_DIRECTORY = -#CREATE_SUBDIRS = NO +CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English USE_WINDOWS_ENCODING = NO BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES -#ABBREVIATE_BRIEF = +ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO FULL_PATH_NAMES = YES STRIP_FROM_PATH = -#STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = SHORT_NAMES = NO JAVADOC_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO DETAILS_AT_TOP = NO INHERIT_DOCS = YES -DISTRIBUTE_GROUP_DOC = NO +SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 8 ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO -#SUBGROUPING = YES +BUILTIN_STL_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- -EXTRACT_ALL = NO -EXTRACT_PRIVATE = NO -EXTRACT_STATIC = NO +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES EXTRACT_LOCAL_CLASSES = YES -#EXTRACT_LOCAL_METHODS = NO +EXTRACT_LOCAL_METHODS = NO HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = NO @@ -46,8 +48,8 @@ SHOW_INCLUDE_FILES = YES INLINE_INFO = YES SORT_MEMBER_DOCS = YES -#SORT_BRIEF_DOCS = NO -#SORT_BY_SCOPE_NAME = NO +SORT_BRIEF_DOCS = NO +SORT_BY_SCOPE_NAME = NO GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES @@ -55,6 +57,8 @@ ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES +SHOW_DIRECTORIES = NO +FILE_VERSION_FILTER = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -62,13 +66,14 @@ WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- INPUT = . -FILE_PATTERNS = +FILE_PATTERNS = *.h overview.cxx RECURSIVE = NO EXCLUDE = EXCLUDE_SYMLINKS = NO @@ -76,9 +81,9 @@ EXAMPLE_PATH = EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NO -IMAGE_PATH = . +IMAGE_PATH = INPUT_FILTER = -#FILTER_PATTERNS = +FILTER_PATTERNS = FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # configuration options related to source browsing @@ -88,18 +93,19 @@ STRIP_CODE_COMMENTS = YES REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES +USE_HTAGS = NO VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = NO +ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- GENERATE_HTML = YES -HTML_OUTPUT = html +HTML_OUTPUT = HTML_FILE_EXTENSION = .html HTML_HEADER = HTML_FOOTER = @@ -113,7 +119,7 @@ TOC_EXPAND = NO DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 -GENERATE_TREEVIEW = YES +GENERATE_TREEVIEW = NO TREEVIEW_WIDTH = 250 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output @@ -153,7 +159,7 @@ XML_OUTPUT = xml XML_SCHEMA = XML_DTD = -#XML_PROGRAMLISTING = YES +XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- @@ -174,7 +180,7 @@ SEARCH_INCLUDES = YES INCLUDE_PATH = INCLUDE_FILE_PATTERNS = -PREDEFINED = DOCPLUSLUS DOC_PLUS_PLUS +PREDEFINED = EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- @@ -193,18 +199,22 @@ HAVE_DOT = YES CLASS_GRAPH = YES COLLABORATION_GRAPH = YES -UML_LOOK = YES -TEMPLATE_RELATIONS = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +TEMPLATE_RELATIONS = NO INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES CALL_GRAPH = YES GRAPHICAL_HIERARCHY = YES -DOT_IMAGE_FORMAT = jpg +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = png DOT_PATH = DOTFILE_DIRS = MAX_DOT_GRAPH_WIDTH = 1024 MAX_DOT_GRAPH_HEIGHT = 1024 MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- Modified: sofaswitch/trunk/sound/docs.cfg ============================================================================== --- sofaswitch/trunk/sound/docs.cfg (original) +++ sofaswitch/trunk/sound/docs.cfg Mon Sep 18 23:28:46 2006 @@ -1,33 +1,35 @@ -# Doxyfile 1.3.8 +# Doxyfile 1.4.6 #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -PROJECT_NAME = "SSSound : Sofa Switch Sound" -PROJECT_NUMBER = +PROJECT_NAME = Sound - part of the Sofa Switch set of utilities +PROJECT_NUMBER = 1.0.0 OUTPUT_DIRECTORY = -#CREATE_SUBDIRS = NO +CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English USE_WINDOWS_ENCODING = NO BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES -#ABBREVIATE_BRIEF = +ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO FULL_PATH_NAMES = YES STRIP_FROM_PATH = -#STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = SHORT_NAMES = NO JAVADOC_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO DETAILS_AT_TOP = NO INHERIT_DOCS = YES -DISTRIBUTE_GROUP_DOC = NO +SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 8 ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO -#SUBGROUPING = YES +BUILTIN_STL_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -35,7 +37,7 @@ EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO EXTRACT_LOCAL_CLASSES = YES -#EXTRACT_LOCAL_METHODS = NO +EXTRACT_LOCAL_METHODS = NO HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = NO @@ -46,8 +48,8 @@ SHOW_INCLUDE_FILES = YES INLINE_INFO = YES SORT_MEMBER_DOCS = YES -#SORT_BRIEF_DOCS = NO -#SORT_BY_SCOPE_NAME = NO +SORT_BRIEF_DOCS = NO +SORT_BY_SCOPE_NAME = NO GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES @@ -55,6 +57,8 @@ ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES +SHOW_DIRECTORIES = NO +FILE_VERSION_FILTER = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -62,13 +66,14 @@ WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = . ../sofa/docs.cfg ../sofa/src ../sofa/include/sofa -FILE_PATTERNS = +INPUT = +FILE_PATTERNS = *.h overview.cxx RECURSIVE = NO EXCLUDE = EXCLUDE_SYMLINKS = NO @@ -78,7 +83,7 @@ EXAMPLE_RECURSIVE = NO IMAGE_PATH = INPUT_FILTER = -#FILTER_PATTERNS = +FILTER_PATTERNS = FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # configuration options related to source browsing @@ -88,11 +93,12 @@ STRIP_CODE_COMMENTS = YES REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES +USE_HTAGS = NO VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = NO +ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = #--------------------------------------------------------------------------- @@ -103,7 +109,7 @@ HTML_FILE_EXTENSION = .html HTML_HEADER = HTML_FOOTER = -HTML_STYLESHEET = +HTML_STYLESHEET = YES HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO CHM_FILE = @@ -113,7 +119,7 @@ TOC_EXPAND = NO DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 -GENERATE_TREEVIEW = YES +GENERATE_TREEVIEW = NO TREEVIEW_WIDTH = 250 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output @@ -153,7 +159,7 @@ XML_OUTPUT = xml XML_SCHEMA = XML_DTD = -#XML_PROGRAMLISTING = YES +XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- @@ -174,7 +180,7 @@ SEARCH_INCLUDES = YES INCLUDE_PATH = INCLUDE_FILE_PATTERNS = -PREDEFINED = DOCPLUSLUS DOC_PLUS_PLUS +PREDEFINED = EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- @@ -190,21 +196,25 @@ #--------------------------------------------------------------------------- CLASS_DIAGRAMS = YES HIDE_UNDOC_RELATIONS = YES -HAVE_DOT = NO +HAVE_DOT = YES CLASS_GRAPH = YES COLLABORATION_GRAPH = YES -UML_LOOK = YES -TEMPLATE_RELATIONS = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +TEMPLATE_RELATIONS = NO INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES CALL_GRAPH = YES GRAPHICAL_HIERARCHY = YES -DOT_IMAGE_FORMAT = jpg +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = png DOT_PATH = DOTFILE_DIRS = MAX_DOT_GRAPH_WIDTH = 1024 MAX_DOT_GRAPH_HEIGHT = 1024 MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES DOT_CLEANUP = YES #---------------------------------------------------------------------------

1 0

[commit] r103 - sofaswitch/trunk/sofa
by SofaSWITCH SVN 19 Sep '06

19 Sep '06

Author: derek Date: Mon Sep 18 23:28:08 2006 New Revision: 103 Added: sofaswitch/trunk/sofa/docs.cfg Removed: sofaswitch/trunk/sofa/sofa_cfg.dxy Modified: sofaswitch/trunk/sofa/Makefile Log: Rename the file back to docs.cfg.. Fix target in Makefile. Modified: sofaswitch/trunk/sofa/Makefile ============================================================================== --- sofaswitch/trunk/sofa/Makefile (original) +++ sofaswitch/trunk/sofa/Makefile Mon Sep 18 23:28:08 2006 @@ -243,7 +243,7 @@ $(DESTDIR)${exec_prefix}/lib/$(LIBNAME_PAT) docs: - doxygen sofa_cfg.dxy + doxygen docs.cfg distclean: Added: sofaswitch/trunk/sofa/docs.cfg ============================================================================== --- (empty file) +++ sofaswitch/trunk/sofa/docs.cfg Mon Sep 18 23:28:08 2006 @@ -0,0 +1,213 @@ +# Doxyfile 1.0.0 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = "Sofa Switch library" +PROJECT_NUMBER = +OUTPUT_DIRECTORY = +#CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +USE_WINDOWS_ENCODING = NO +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +#ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = +#STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +DETAILS_AT_TOP = NO +INHERIT_DOCS = YES +DISTRIBUTE_GROUP_DOC = NO +TAB_SIZE = 8 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +#SUBGROUPING = YES +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = NO +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = YES +#EXTRACT_LOCAL_METHODS = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +#SORT_BRIEF_DOCS = NO +#SORT_BY_SCOPE_NAME = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = . ./include/sofa ./src +FILE_PATTERNS = +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +#FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +VERBATIM_HEADERS = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = NO +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = YES +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +#XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = DOCPLUSLUS DOC_PLUS_PLUS +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +UML_LOOK = YES +TEMPLATE_RELATIONS = YES +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = YES +GRAPHICAL_HIERARCHY = YES +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1024 +MAX_DOT_GRAPH_HEIGHT = 1024 +MAX_DOT_GRAPH_DEPTH = 0 +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO

1 0