jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Functionality fixes, small tweaks to make DoxygenTranslator more robust and the beginnings of a doxygen example collection

Browse source 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2008-cherylfoil@10656 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Cheryl Foil 2008-07-10 04:18:22 +00:00
commit c727877cf9
7 changed files with 186 additions and 86 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Source/DoxygenTranslator/DoxygenEntity.cpp
View file

@ -24,7 +24,7 @@ string commandArray2[] = {"a", "addindex", "addtogroup", "anchor", "arg", "atten
"sa", "section", "see", "showinitializer", "since", "skip", "skipline", "struct", "subpage", "sa", "section", "see", "showinitializer", "since", "skip", "skipline", "struct", "subpage",
"subsection", "subsubsection", "test", "throw", "todo", "tparam", "typedef", "union", "until", "subsection", "subsubsection", "test", "throw", "todo", "tparam", "typedef", "union", "until",
"var", "verbatim", "verbinclude", "version", "warning", "weakgroup", "xmlonly", "xrefitem", "var", "verbatim", "verbinclude", "version", "warning", "weakgroup", "xmlonly", "xrefitem",
"$", "@", string(1, 92), string(1, '&'), "~", "<", ">", string(1, '#'), "%"}; "$", "@", string(1, 92), "&", "~", "<", ">", "#", "%"};
string findCommand(int commandNum){ string findCommand(int commandNum){
@ -56,7 +56,7 @@ DoxygenEntity::DoxygenEntity(string typeEnt, string param1){
/* Nonterminal node /* Nonterminal node
* contains * contains
*/ */
DoxygenEntity::DoxygenEntity(string typeEnt, list <DoxygenEntity> entList){ DoxygenEntity::DoxygenEntity(string typeEnt, list <DoxygenEntity> &entList ){
typeOfEntity = typeEnt; typeOfEntity = typeEnt;
data = ""; data = "";
isLeaf = 0; isLeaf = 0;
@ -65,18 +65,20 @@ DoxygenEntity::DoxygenEntity(string typeEnt, list <DoxygenEntity> entList){
void DoxygenEntity::printEntity(int level){ void DoxygenEntity::printEntity(int level){
int thisLevel = level;
if (isLeaf) { if (isLeaf) {
for (int i = 0; i < level; i++) {cout << "\t";} for (int i = 0; i < thisLevel; i++) {cout << "\t";}
cout << "Node Command: " << typeOfEntity << " "; cout << "Node Command: " << typeOfEntity << " ";
if (data.compare("") != 0) cout << "Node Data: " << data; if (data.compare("") != 0) cout << "Node Data: " << data;
cout << endl; cout << endl;
} }
else{ else{
for (int i = 0; i < thisLevel; i++) {cout << "\t";}
cout << "Node Command : " << typeOfEntity << endl; cout << "Node Command : " << typeOfEntity << endl;
list<DoxygenEntity>::iterator p = entityList.begin(); list<DoxygenEntity>::iterator p = entityList.begin();
level++; thisLevel++;
while (p != entityList.end()){ while (p != entityList.end()){
(*p).printEntity(level); (*p).printEntity(thisLevel);
p++; p++;
} }
} }

2
Source/DoxygenTranslator/DoxygenEntity.h
View file

@ -11,7 +11,7 @@ class DoxygenEntity{
public: public:
DoxygenEntity(string typeEnt); DoxygenEntity(string typeEnt);
DoxygenEntity(string typeEnt, string param1); DoxygenEntity(string typeEnt, string param1);
DoxygenEntity(string typeEnt, list <DoxygenEntity> entList); DoxygenEntity(string typeEnt, list <DoxygenEntity> &entList );
virtual ~DoxygenEntity(); virtual ~DoxygenEntity();
void printEntity(int level); void printEntity(int level);
string typeOfEntity; string typeOfEntity;

230
Source/DoxygenTranslator/DoxygenTranslator.cpp
View file

@ -24,7 +24,8 @@ to test. */
int testCodeCrawlingFunctions = 0; int testCodeCrawlingFunctions = 0;
int demonstrateParsing = 1; int demonstrateParsing = 1;
int noisy = 1; // set this to 1 for extra chatter from the parsing stage. int runExamples = 1;
int noisy = 0; // set this to 1 for extra chatter from the parsing stage.
int addCommand(string commandName, int &startInd, list <DoxygenEntity> &doxyList, string doxygenString); int addCommand(string commandName, int &startInd, list <DoxygenEntity> &doxyList, string doxygenString);
////////////////////////////////////////// //////////////////////////////////////////
@ -51,7 +52,7 @@ string commandArray[] = {"a", "addindex", "addtogroup", "anchor", "arg", "attent
"sa", "section", "see", "showinitializer", "since", "skip", "skipline", "struct", "subpage", "sa", "section", "see", "showinitializer", "since", "skip", "skipline", "struct", "subpage",
"subsection", "subsubsection", "test", "throw", "todo", "tparam", "typedef", "union", "until", "subsection", "subsubsection", "test", "throw", "todo", "tparam", "typedef", "union", "until",
"var", "verbatim", "verbinclude", "version", "warning", "weakgroup", "xmlonly", "xrefitem", "var", "verbatim", "verbinclude", "version", "warning", "weakgroup", "xmlonly", "xrefitem",
"$", "@", string(1, 92), string(1, '&'), "~", "<", ">", string(1, '#'), "%"}; "$", "@", "//","&", "~", "<", ">", "#", "%"};
string sectionIndicators[] = { "attention", "author", "brief", "bug", "cond", "date", "deprecated", "details", string sectionIndicators[] = { "attention", "author", "brief", "bug", "cond", "date", "deprecated", "details",
@ -60,7 +61,7 @@ string sectionIndicators[] = { "attention", "author", "brief", "bug", "cond", "d
"version", "warning", "xrefitem" }; "version", "warning", "xrefitem" };
/* All of the doxygen commands divided up by how they are parsed */ /* All of the doxygen commands divided up by how they are parsed */
string simpleCommands[] = {"n", "$", "@", string(1, 92), string(1, '&'), "~", "<", ">", string(1, '#'), "%"}; string simpleCommands[] = {"n", "$", "@", "//", "&", "~", "<", ">", "#", "%"};
string ignoredSimpleCommands[] = {"nothing at the moment"}; string ignoredSimpleCommands[] = {"nothing at the moment"};
string commandWords[] = {"a", "b", "c", "e", "em", "p", "def", "enum", "example", "package", string commandWords[] = {"a", "b", "c", "e", "em", "p", "def", "enum", "example", "package",
"relates", "namespace", "relatesalso","anchor", "dontinclude", "include", "includelineno"}; "relates", "namespace", "relatesalso","anchor", "dontinclude", "include", "includelineno"};
@ -84,10 +85,8 @@ string commandErrorThrowings[] = {"annotatedclasslist", "classhierarchy", "defin
string commandUniques[] = {"xrefitem", "ingroup", "par", "headerfile", "overload", "weakgroup", "ref", string commandUniques[] = {"xrefitem", "ingroup", "par", "headerfile", "overload", "weakgroup", "ref",
"subpage", "dotfile", "image", "addtogroup", "li"}; "subpage", "dotfile", "image", "addtogroup", "li"};
int startIndex = 0; //int startIndex = 0;
int endIndex = 0;
int isNewLine = 0; int isNewLine = 0;
//string doxygenString = "";
int briefDescExists = 0; int briefDescExists = 0;
/* Entity list is the root list. /* Entity list is the root list.
@ -186,8 +185,8 @@ string commandUniques[] = {"xrefitem", "ingroup", "par", "headerfile", "overload
int isSectionIndicator(string smallString){ int isSectionIndicator(string smallString){
smallString = StringToLower(smallString); smallString = StringToLower(smallString);
for (int i = 0; i < sizeof(commandArray)/sizeof(*commandArray); i++){ for (int i = 0; i < sizeof( sectionIndicators)/sizeof(* sectionIndicators); i++){
if( smallString.compare(commandArray[i]) == 0){ if( smallString.compare( sectionIndicators[i]) == 0){
return 1; return 1;
} }
} }
@ -207,7 +206,7 @@ string commandUniques[] = {"xrefitem", "ingroup", "par", "headerfile", "overload
int amountRemoved = 0; int amountRemoved = 0;
while(doxygenString[startIndex] == '/'|| doxygenString[startIndex] == '!' || doxygenString[startIndex] == '*' while(doxygenString[startIndex] == '/'|| doxygenString[startIndex] == '!' || doxygenString[startIndex] == '*'
|| doxygenString[startIndex] == '\n' || doxygenString[startIndex] == ' '){ || doxygenString[startIndex] == '\n' || doxygenString[startIndex] == ' '|| doxygenString[startIndex] == '\t'){
startIndex++; startIndex++;
amountRemoved++; amountRemoved++;
} }
@ -222,9 +221,9 @@ string commandUniques[] = {"xrefitem", "ingroup", "par", "headerfile", "overload
string getNextWord(int &startInd, string doxygenString){ string getNextWord(int &startInd, string doxygenString){
int startIndex = startInd; int startIndex = startInd;
string nextWord = ""; string nextWord;
while (startIndex < doxygenString.length() && (doxygenString[startIndex] == '/'|| doxygenString[startIndex] == ' ' while (startIndex < doxygenString.length() && (doxygenString[startIndex] == '/'|| doxygenString[startIndex] == ' '
|| doxygenString[startIndex] == '*' || doxygenString[startIndex]== '\n' || doxygenString[startIndex] == '*' || doxygenString[startIndex]== '\n' || doxygenString[startIndex] == '\t'
|| doxygenString[startIndex] == '!')){ || doxygenString[startIndex] == '!')){
if(doxygenString[startIndex]== '\n'){ startInd = startIndex; return nextWord;} if(doxygenString[startIndex]== '\n'){ startInd = startIndex; return nextWord;}
startIndex++; startIndex++;
@ -233,7 +232,7 @@ string commandUniques[] = {"xrefitem", "ingroup", "par", "headerfile", "overload
//cout << doxygenString[startIndex] << endl; //cout << doxygenString[startIndex] << endl;
int endIndex = startIndex; int endIndex = startIndex;
while (doxygenString[endIndex]!= '\n' && doxygenString[endIndex]!= ' '){ while (endIndex < doxygenString.length() && (doxygenString[endIndex]!= '\n' && doxygenString[endIndex]!= ' ')){
endIndex++; endIndex++;
//cout << "End Index " << endIndex << endl; //cout << "End Index " << endIndex << endl;
} }
@ -251,7 +250,7 @@ string commandUniques[] = {"xrefitem", "ingroup", "par", "headerfile", "overload
int startIndex = startInd; int startIndex = startInd;
while (doxygenString[startIndex] == '/'|| doxygenString[startIndex] == ' ' while (doxygenString[startIndex] == '/'|| doxygenString[startIndex] == ' '
|| doxygenString[startIndex] == '*' || doxygenString[startIndex]== '\n' || doxygenString[startIndex] == '*' || doxygenString[startIndex]== '\n'
|| doxygenString[startIndex] == '!'){ || doxygenString[startIndex] == '!' || doxygenString[startIndex] == '\t'){
if(doxygenString[startIndex]== '\n') return ""; if(doxygenString[startIndex]== '\n') return "";
startIndex++; startIndex++;
} }
@ -274,7 +273,7 @@ string getStringTilCommand(int &startInd, string doxygenString){
if (startInd >= doxygenString.length()) return ""; if (startInd >= doxygenString.length()) return "";
int startIndex = startInd; int startIndex = startInd;
int endIndex = startInd; int endIndex = startInd;
string description = ""; string description;
/* Find the End of the description */ /* Find the End of the description */
int keepLooping = 1; int keepLooping = 1;
int spareIndex = 0; int spareIndex = 0;
@ -293,7 +292,7 @@ string getStringTilCommand(int &startInd, string doxygenString){
//cout << "Counter :" << counter << endl; //cout << "Counter :" << counter << endl;
while(keepLooping && endIndex < doxygenString.length() && (doxygenString[counter] == ' ' || while(keepLooping && endIndex < doxygenString.length() && (doxygenString[counter] == ' ' ||
doxygenString[counter] == '*'|| doxygenString[counter] == '\n'|| doxygenString[counter] == '/' doxygenString[counter] == '*'|| doxygenString[counter] == '\n'|| doxygenString[counter] == '/'
|| doxygenString[counter] == '!') ){ || doxygenString[counter] == '!' || doxygenString[startIndex] == '\t') ){
if(doxygenString[counter] == '\n') { if(doxygenString[counter] == '\n') {
//cout << "Blank line found" << endl; //cout << "Blank line found" << endl;
keepLooping = 0; keepLooping = 0;
@ -304,7 +303,7 @@ string getStringTilCommand(int &startInd, string doxygenString){
} }
//endIndex = counter; //endIndex = counter;
} }
else if (doxygenString[endIndex] == 92 || doxygenString[endIndex] == '@'){ else if (doxygenString[endIndex] == '\\' || doxygenString[endIndex] == '@'){
finalIndex = endIndex; finalIndex = endIndex;
keepLooping = 0; keepLooping = 0;
} }
@ -321,13 +320,13 @@ string getStringTilCommand(int &startInd, string doxygenString){
} }
//cout << "Done with EndIndex" << endl; //cout << "Done with EndIndex" << endl;
while(doxygenString[startIndex] == '!' || doxygenString[startIndex] == ' ' while(doxygenString[startIndex] == '!' || doxygenString[startIndex] == ' '
|| doxygenString[startIndex] == '/' || doxygenString[startIndex] == '*') startIndex++; || doxygenString[startIndex] == '/' || doxygenString[startIndex] == '*' || doxygenString[startIndex] == '\t') startIndex++;
for (int i = startIndex; i < endIndex; i++){ for (int i = startIndex; i < endIndex; i++){
if (doxygenString[i] == '\n') { if (doxygenString[i] == '\n') {
while ((doxygenString[i] == '\n' || doxygenString[i] == ' ' while ((doxygenString[i] == '\n' || doxygenString[startIndex] == '\t'|| doxygenString[i] == ' '
|| doxygenString[i] == '*' || doxygenString[i] == '/')&& endIndex < doxygenString.length() - 1){ || doxygenString[i] == '*' || doxygenString[i] == '/')&& endIndex < doxygenString.length() - 1){
i++; i++;
} }
@ -351,7 +350,7 @@ string getStringTilCommand(int &startInd, string doxygenString){
if (startInd >= doxygenString.length()) return ""; if (startInd >= doxygenString.length()) return "";
int startIndex = startInd; int startIndex = startInd;
int endIndex = startInd; int endIndex = startInd;
string description = ""; string description;
/* Find the End of the description */ /* Find the End of the description */
int keepLooping = 1; int keepLooping = 1;
int spareIndex = 0; int spareIndex = 0;
@ -369,7 +368,7 @@ string getStringTilCommand(int &startInd, string doxygenString){
counter++; counter++;
//cout << "Counter :" << counter << endl; //cout << "Counter :" << counter << endl;
while(keepLooping && endIndex < doxygenString.length() && (doxygenString[counter] == ' ' || while(keepLooping && endIndex < doxygenString.length() && (doxygenString[counter] == ' ' ||
doxygenString[counter] == '*'|| doxygenString[counter] == '\n'|| doxygenString[counter] == '/' doxygenString[counter] == '*'|| doxygenString[startIndex] == '\t' || doxygenString[counter] == '\n'|| doxygenString[counter] == '/'
|| doxygenString[counter] == '!') ){ || doxygenString[counter] == '!') ){
if(doxygenString[counter] == '\n') { if(doxygenString[counter] == '\n') {
//cout << "Blank line found" << endl; //cout << "Blank line found" << endl;
@ -381,30 +380,32 @@ string getStringTilCommand(int &startInd, string doxygenString){
} }
//endIndex = counter; //endIndex = counter;
} }
else if (doxygenString[endIndex] == 92 || doxygenString[endIndex] == '@'){ //todo this fix for not immediately exciting while parsing a paragraph seems somewhat cheap
//cout << "2 "; else if (endIndex != startInd && doxygenString[endIndex] == '\\' || doxygenString[endIndex] == '@'){
spareIndex = endIndex; spareIndex = endIndex +1;
if (isSectionIndicator(getNextWord(spareIndex, doxygenString))) keepLooping = 0;
if (isSectionIndicator(getNextWord(spareIndex, doxygenString))) {
keepLooping = 0;
finalIndex = endIndex;}
} }
else if(endIndex < doxygenString.length() - 1 else if(endIndex < doxygenString.length() - 1
&& string("*/").compare(doxygenString.substr(endIndex , endIndex + 1)) == 0){ && string("*/").compare(doxygenString.substr(endIndex , endIndex + 1)) == 0){
//cout << "3 ";
keepLooping = 0; keepLooping = 0;
finalIndex = endIndex;
} }
if(keepLooping){ if(keepLooping){
//cout << "4 ";
endIndex++; endIndex++;
} }
} }
//cout << "Done with EndIndex" << endl; //cout << "Done with EndIndex" << endl;
while(doxygenString[startIndex] == '!' || doxygenString[startIndex] == ' ' while(doxygenString[startIndex] == '!' || doxygenString[startIndex] == ' ' || doxygenString[startIndex] == '\t'
|| doxygenString[startIndex] == '/' || doxygenString[startIndex] == '*') startIndex++; || doxygenString[startIndex] == '/' || doxygenString[startIndex] == '*') startIndex++;
for (int i = startIndex; i < endIndex; i++){ for (int i = startIndex; i < endIndex; i++){
if (doxygenString[i] == '\n') { if (doxygenString[i] == '\n') {
while ((doxygenString[i] == '\n' || doxygenString[i] == ' ' while ((doxygenString[i] == '\n' || doxygenString[startIndex] == '\t' || doxygenString[i] == ' ' ||doxygenString[startIndex] == '!'
|| doxygenString[i] == '*' || doxygenString[i] == '/')&& endIndex < doxygenString.length() - 1){ || doxygenString[i] == '*' || doxygenString[i] == '/')&& endIndex < doxygenString.length() - 1){
i++; i++;
} }
@ -425,9 +426,9 @@ string getStringTilCommand(int &startInd, string doxygenString){
*/ */
//TODO Make progressTilCommand return a formatted string //TODO Make progressTilCommand return a formatted string
int progressTilEndCommand(string theCommand, int &startInd, string doxygenString){ int progressTilEndCommand(string theCommand, int &startInd, string doxygenString){
endIndex = startInd; int endIndex = startInd;
while (endIndex < doxygenString.length()){ while (endIndex < doxygenString.length()){
if (doxygenString[endIndex] == 92 || doxygenString[endIndex] == '@'){ if (doxygenString[endIndex] == '\\' || doxygenString[endIndex] == '@'){
//cout << doxygenString.substr(endIndex + 1 , theCommand.length())<< endl; //cout << doxygenString.substr(endIndex + 1 , theCommand.length())<< endl;
if (theCommand.compare(doxygenString.substr(endIndex + 1 , theCommand.length())) == 0){ if (theCommand.compare(doxygenString.substr(endIndex + 1 , theCommand.length())) == 0){
startInd = endIndex + theCommand.length() + 1; startInd = endIndex + theCommand.length() + 1;
@ -440,34 +441,78 @@ string getStringTilCommand(int &startInd, string doxygenString){
return 0; return 0;
} }
/* A specialty method for commands such as \arg that end at the end of a paragraph OR when another \arg is encountered
*/
string getStringTilAnyCommand(string theCommand, int &startInd, string doxygenString){ string getStringTilAnyCommand(string theCommand, int &startInd, string doxygenString){
endIndex = startInd; if (startInd >= doxygenString.length()) return "";
startIndex = startInd; int startIndex = startInd;
int keepLooping = 1; int endIndex = startInd;
while (keepLooping && endIndex < doxygenString.length()){ string description;
if (doxygenString[endIndex] == 92 || doxygenString[endIndex] == '@'){ /* Find the End of the description */
startInd = endIndex; int keepLooping = 1;
keepLooping = 0; int spareIndex = 0;
} int counter;
endIndex++; int finalIndex;
} while(keepLooping){
string description = ""; if(endIndex >= theCommand.length()){
for (int i = startIndex; i < endIndex; i++){ finalIndex = endIndex;
keepLooping = 0;
}
else if (doxygenString[endIndex] == '\n'){
//cout << "1 ";
counter = endIndex;
if ( keepLooping && endIndex < doxygenString.length()-1) {
counter++;
//cout << "Counter :" << counter << endl;
while(keepLooping && endIndex < doxygenString.length() && (doxygenString[counter] == ' ' ||
doxygenString[counter] == '*'|| doxygenString[counter] == '\n'|| doxygenString[counter] == '/'
|| doxygenString[counter] == '!' || doxygenString[startIndex] == '\t') ){
if(doxygenString[counter] == '\n') {
//cout << "Blank line found" << endl;
keepLooping = 0;
finalIndex = counter;}
else{ counter++;}
}
if (doxygenString[i] == '\n') { }
//endIndex = counter;
}
else if (doxygenString[endIndex] == '\\' || doxygenString[endIndex] == '@'){
//cout << "2 ";
spareIndex = endIndex;
if (endIndex + theCommand.length() < theCommand.length()
&& theCommand.compare(doxygenString.substr(endIndex, theCommand.length())) == 0) keepLooping = 0;
}
else if(endIndex < doxygenString.length() - 1
&& string("*/").compare(doxygenString.substr(endIndex , endIndex + 1)) == 0){
//cout << "3 ";
keepLooping = 0;
}
if(keepLooping){
//cout << "4 ";
endIndex++;
}
}
//cout << "Done with EndIndex" << endl;
while(doxygenString[startIndex] == '!' || doxygenString[startIndex] == ' '
|| doxygenString[startIndex] == '/' || doxygenString[startIndex] == '*' || doxygenString[startIndex] == '\t') startIndex++;
while ((doxygenString[i] == '\n' || doxygenString[i] == ' ' for (int i = startIndex; i < endIndex; i++){
|| doxygenString[i] == '*' || doxygenString[i] == '/')&& endIndex < doxygenString.length() - 1){
i++; if (doxygenString[i] == '\n') {
}
description.append(" "); while ((doxygenString[i] == '\n' || doxygenString[i] == ' ' || doxygenString[startIndex] == '\t'
} || doxygenString[i] == '*' || doxygenString[i] == '/')&& endIndex < doxygenString.length() - 1){
description.push_back(doxygenString[i]); i++;
//cout << doxygenString[i]; }
} description.append(" ");
startInd = endIndex; }
return description; description.push_back(doxygenString[i]);
return 0; //cout << doxygenString[i];
}
startInd = finalIndex;
return description;
} }
///////////////TEST CLASSES AND MAIN BELOW///////////////// ///////////////TEST CLASSES AND MAIN BELOW/////////////////
@ -477,7 +522,7 @@ string getStringTilCommand(int &startInd, string doxygenString){
* differs wildly */ * differs wildly */
int testClearFluff(){ int testClearFluff(){
string doxygenString = ""; string doxygenString;
string cases[] = {"/** WORD", "/*! WORD", "/******* WORD", "///// WORD", "//! WORD", "//! WORD", "///WORD", string cases[] = {"/** WORD", "/*! WORD", "/******* WORD", "///// WORD", "//! WORD", "//! WORD", "///WORD",
"/**\nWORD", "/**\n*WORD", "/** \n WORD"}; "/**\nWORD", "/**\n*WORD", "/** \n WORD"};
int testPassed = 1; int testPassed = 1;
@ -498,10 +543,10 @@ string getStringTilCommand(int &startInd, string doxygenString){
}; };
int testGetNextWord(){ int testGetNextWord(){
string doxygenString = ""; string doxygenString;
string cases[] = {"/** WORD ", " * WORD ", "///!WORD ", " WORD ", "//! WORD ", " * WORD ", "*WORD "}; string cases[] = {"/** WORD ", " * WORD ", "///!WORD ", " WORD ", "//! WORD ", " * WORD ", "*WORD "};
int testPassed = 1; int testPassed = 1;
string testWord = ""; string testWord;
int placement = 0; int placement = 0;
int casesSize = sizeof(cases)/sizeof(*cases); int casesSize = sizeof(cases)/sizeof(*cases);
for (int i = 0; i < casesSize; i++){ for (int i = 0; i < casesSize; i++){
@ -523,10 +568,10 @@ string getStringTilCommand(int &startInd, string doxygenString){
testPassed = 0;} testPassed = 0;}
//else cout << "GetNextWord passed for string :" << doxygenString << endl; //else cout << "GetNextWord passed for string :" << doxygenString << endl;
testWord = " * "; testWord = " * ";
testWord.push_back(92); testWord.push_back('\\');
testWord = testWord + "WORD "; testWord = testWord + "WORD ";
string commandWord = ""; string commandWord;
commandWord.push_back(92); commandWord.push_back('\\');
commandWord = commandWord + "WORD"; commandWord = commandWord + "WORD";
doxygenString = testWord; doxygenString = testWord;
placement = 0; placement = 0;
@ -581,7 +626,7 @@ string getStringTilCommand(int &startInd, string doxygenString){
} }
int testGetOneLine(){ int testGetOneLine(){
string doxygenString = ""; string doxygenString;
string cases[] = {" * Crop this sentence after this period.\n", string cases[] = {" * Crop this sentence after this period.\n",
" * Crop this sentence after this period.\n", " * Crop this sentence after this period.\n",
"Crop this sentence after this period.\n", "Crop this sentence after this period.\n",
@ -589,7 +634,7 @@ string getStringTilCommand(int &startInd, string doxygenString){
" Crop this sentence after this period.\n" " Crop this sentence after this period.\n"
}; };
int testPassed = 1; int testPassed = 1;
string testWord = ""; string testWord;
int placement = 0; int placement = 0;
int casesSize = sizeof(cases)/sizeof(*cases); int casesSize = sizeof(cases)/sizeof(*cases);
for (int i = 0; i < casesSize; i++){ for (int i = 0; i < casesSize; i++){
@ -625,7 +670,7 @@ string getStringTilCommand(int &startInd, string doxygenString){
} }
//TODO Flesh testGetStringTilEndOfParagraph out, fix weird spacing problems //TODO Flesh testGetStringTilEndOfParagraph out, fix weird spacing problems
int testGetStringTilEndOfParagraph(){ int testGetStringTilEndOfParagraph(){
string doxygenString = ""; string doxygenString;
int placement = 0; int placement = 0;
int testPassed = 1; int testPassed = 1;
string testParagraph; string testParagraph;
@ -647,7 +692,7 @@ string getStringTilCommand(int &startInd, string doxygenString){
//cout << "String Length: " << doxygenString.length() << endl; //cout << "String Length: " << doxygenString.length() << endl;
doxygenString = "/* This is a description,\n * thus it continues on\n * for several lines.\n * \n * "; doxygenString = "/* This is a description,\n * thus it continues on\n * for several lines.\n * \n * ";
doxygenString.push_back(92); doxygenString.push_back('//');
doxygenString += "author cheryl foil \n\n **/"; doxygenString += "author cheryl foil \n\n **/";
placement = 0; placement = 0;
testParagraph = getStringTilEndOfParagraph(placement, doxygenString); testParagraph = getStringTilEndOfParagraph(placement, doxygenString);
@ -662,7 +707,7 @@ string getStringTilCommand(int &startInd, string doxygenString){
} }
int testGetStringTilCommand(){ int testGetStringTilCommand(){
string doxygenString = ""; string doxygenString;
int placement = 0; int placement = 0;
int testPassed = 1; int testPassed = 1;
string testParagraph; string testParagraph;
@ -678,12 +723,12 @@ string getStringTilCommand(int &startInd, string doxygenString){
} }
int testProgressTilEndCommand(){ int testProgressTilEndCommand(){
string doxygenString = ""; string doxygenString ;
int placement = 0; int placement = 0;
int testPassed = 1; int testPassed = 1;
string testParagraph; string testParagraph;
doxygenString = "Let's pretend this \n * is a bunch of code to be ended in "; doxygenString = "Let's pretend this \n * is a bunch of code to be ended in ";
doxygenString.push_back(92); doxygenString.push_back('\\');
doxygenString += "endcodeSTOP"; doxygenString += "endcodeSTOP";
progressTilEndCommand("endcode", placement, doxygenString); progressTilEndCommand("endcode", placement, doxygenString);
//cout << "Placement : " << placement << endl; //cout << "Placement : " << placement << endl;
@ -733,11 +778,11 @@ string getStringTilCommand(int &startInd, string doxygenString){
list<DoxygenEntity> parse(int startInd, string doxygenString){ list<DoxygenEntity> parse(int startInd, string doxygenString){
string currWord = ""; string currWord;
int startIndex = startInd; int startIndex = startInd;
int savedIndex; int savedIndex;
list <DoxygenEntity> aNewList; list <DoxygenEntity> aNewList;
endIndex = doxygenString.length(); int endIndex = doxygenString.length();
int currCommand; int currCommand;
while (startIndex < endIndex){ while (startIndex < endIndex){
savedIndex = startIndex; savedIndex = startIndex;
@ -746,12 +791,12 @@ string getStringTilCommand(int &startInd, string doxygenString){
if(currWord == ""){ if(currWord == ""){
if (startIndex < endIndex) startIndex++; if (startIndex < endIndex) startIndex++;
} }
else if(currWord[0] == 92 || currWord[0] == '@'){ else if(currWord[0] == '\\' || currWord[0] == '@'){
currWord = currWord.substr(1, currWord.length() - 1); currWord = currWord.substr(1, currWord.length() - 1);
currCommand = findCommand(currWord); currCommand = findCommand(currWord);
if (currCommand < 0 ){ cout << "BAD COMMAND: " << currWord << endl; exit(1);} if (currCommand < 0 ){ if(noisy) cout << "BAD COMMAND: " << currWord << endl;}
//cout << "Command: " << currWord << " " << currCommand << endl; //cout << "Command: " << currWord << " " << currCommand << endl;
addCommand(currWord, startIndex, aNewList, doxygenString); else addCommand(currWord, startIndex, aNewList, doxygenString);
} }
else{ else{
startIndex = savedIndex; startIndex = savedIndex;
@ -783,7 +828,6 @@ string getStringTilCommand(int &startInd, string doxygenString){
if (noisy) cout << "Not Adding " << theCommand << endl; if (noisy) cout << "Not Adding " << theCommand << endl;
return 1; return 1;
//doxyList.push_back(DoxygenEntity(108));
} }
/* CommandWord /* CommandWord
@ -1051,7 +1095,7 @@ string getStringTilCommand(int &startInd, string doxygenString){
int weirdTest(){ int weirdTest(){
string doxygenString = "this is a test."; string doxygenString = "this is a test.";
string restOfParagraph = ""; string restOfParagraph;
int startIndex = 0; int startIndex = 0;
restOfParagraph = getStringTilEndOfParagraph(startIndex , doxygenString); restOfParagraph = getStringTilEndOfParagraph(startIndex , doxygenString);
cout << restOfParagraph<< " " << startIndex << endl; cout << restOfParagraph<< " " << startIndex << endl;
@ -1061,16 +1105,42 @@ string getStringTilCommand(int &startInd, string doxygenString){
cout << restOfParagraph<< " " << startIndex << endl; cout << restOfParagraph<< " " << startIndex << endl;
} }
int doRunExamples(){
string line;
string filename;
string exampleNames[] = {"Examples/Example1","Examples/Example2", "Examples/Example3", "Examples/Example4", "Examples/Example5"};
int placement;
string doxygenString;
ifstream doxCommentFile;
for (int i = 0; i < 5; i++){
doxCommentFile.open(exampleNames[i].c_str());
doxCommentFile >> doxygenString;
while(getline(doxCommentFile, line)){
doxygenString += line + "\n";}
doxCommentFile.close();
placement = 0;
cout << "---RAW CODE---" << endl << doxygenString << endl<<endl;
clearFluff(placement, doxygenString);
rootList = parse(placement, doxygenString);
cout << "---THE TREE---" << endl;
printTree();
}
return 1;
}
/* Returns a parse tree for a string */ /* Returns a parse tree for a string */
int main(int argc, char *argv[]){ int main(int argc, char *argv[]){
//weirdTest(); //weirdTest();
if(testCodeCrawlingFunctions) testCCF(); if(testCodeCrawlingFunctions) testCCF();
if(runExamples) doRunExamples();
if (demonstrateParsing){ if (demonstrateParsing){
string doxygenString = " This is a small sentence.\n *\n This is a line with a @b bold letter \n * \n @brief small @b description. **/"; string doxygenString = "//! A normal member taking two arguments and returning an integer value.\n/*!\n \\param a an integer argument. \\param s a constant character pointer\n \\return The test results\n \\sa Test(), ~Test(), testMeToo() and publicVar()\n */";
//string doxygenString = "This is a description.\n\n * @param x this is a parameter."; //string doxygenString = " /** This is a small sentence.\n *\n@param x this is a parameter. \n \n This is a line with a @b bold letter \n * \n @brief small @b description. \n\n * **/";
//string doxygenString = "This is a description.";
int placement = 0; int placement = 0;
clearFluff(placement, doxygenString); clearFluff(placement, doxygenString);
rootList = parse(placement, doxygenString); rootList = parse(placement, doxygenString);

6
Source/DoxygenTranslator/Examples/Example1 Normal file
View file

@ -0,0 +1,6 @@
/*! \brief Brief description.
* Brief description continued.
*
* Detailed description starts here.
*/

7
Source/DoxygenTranslator/Examples/Example2 Normal file
View file

@ -0,0 +1,7 @@
//! A normal member taking two arguments and returning an integer value.
/*!
\param a an integer argument.
\param s a constant character pointer.
\return The test results
\sa Test(), ~Test(), testMeToo() and publicVar()
*/

10
Source/DoxygenTranslator/Examples/Example3 Normal file
View file

@ -0,0 +1,10 @@
/**
* a normal member taking two arguments and returning an integer value.
* @param a an integer argument.
* @param s a constant character pointer.
* @see Test()
* @see ~Test()
* @see testMeToo()
* @see publicVar()
* @return The test results
*/

5
Source/DoxygenTranslator/Examples/Example4 Normal file
View file

@ -0,0 +1,5 @@
//! Brief descripion.
//! Detailed description
//! starts here.