00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047
00048
00056 #ifndef __FUNC2DOCBUDDY_H___
00057 #define __FUNC2DOCBUDDY_H___
00058
00059 #include <boost/filesystem/path.hpp>
00060
00061 #include <openfluid/dllexport.hpp>
00062 #include <openfluid/buddies/OFBuddy.hpp>
00063
00064
00065 namespace openfluid { namespace buddies {
00066
00067
00068 class DLLEXPORT Func2DocBuddy : public OpenFLUIDBuddy
00069 {
00070 private:
00071 typedef std::map< std::string,std::vector<std::string> > SignatureData_t;
00072
00073 std::string m_CPPFile;
00074 std::string m_LatexOutFile;
00075
00076 boost::filesystem::path m_InputDirPath;
00077 boost::filesystem::path m_OutputDirPath;
00078 boost::filesystem::path m_InputFilePath;
00079 boost::filesystem::path m_OutputLatexFilePath;
00080 boost::filesystem::path m_TplFilePath;
00081 boost::filesystem::path m_CProcessedFilePath;
00082 boost::filesystem::path m_PDFLatexPath;
00083 boost::filesystem::path m_BibtexPath;
00084 boost::filesystem::path m_Latex2HTMLPath;
00085
00086 boost::filesystem::path m_CPreProcessorPath;
00087
00088 std::string m_ExtractedLatexDoc;
00089
00090 std::string m_Title;
00091 std::string m_NewCommands;
00092 std::string m_FuncID;
00093 std::string m_FuncName;
00094 std::string m_FuncVersion;
00095 std::string m_FuncAuthorName;
00096 std::string m_FuncAuthorEmail;
00097 std::string m_FuncDomain;
00098 std::string m_FuncDescription;
00099 std::string m_FuncData;
00100
00101 std::string m_BeginSignatureTag;
00102 std::string m_EndSignatureTag;
00103 std::string m_BeginFunc2DocTag;
00104 std::string m_EndFunc2DocTag;
00105
00106 std::string m_HTMLPackageLatexCommand;
00107
00108 SignatureData_t m_InVars;
00109 SignatureData_t m_OutVars;
00110 SignatureData_t m_ModVars;
00111 SignatureData_t m_InData;
00112 SignatureData_t m_ParamsData;
00113 SignatureData_t m_Events;
00114 SignatureData_t m_ExtraFiles;
00115
00116 std::string extractBetweenTags(std::string Content, const std::string BeginTag, const std::string EndTag);
00117
00118 std::string toLatexFriendly(std::string Content);
00119
00120 void addLatexDataCatBegin(std::string& Content, const std::string Title, const std::string ColsFormat);
00121
00122 void addLatexDataCatEnd(std::string& Content);
00123
00124 std::vector<std::string> extractSignatureLines();
00125
00126 std::vector<std::string> searchStringLitterals(std::string StrToParse);
00127
00128 void copyDocDirectory();
00129
00130 void extractLatexDocFromCPP();
00131
00132 void cpreprocessCPP();
00133
00134 void processSignature();
00135
00136 void generateLatex();
00137
00138 bool isErrorInPDFLatexLog();
00139
00140 void buildPDF();
00141
00142 void buildHTML();
00143
00144
00145 public:
00146
00147 Func2DocBuddy(openfluid::buddies::BuddiesListener* Listener);
00148
00149 ~Func2DocBuddy();
00150
00151 bool run();
00152
00153 };
00154
00155
00156 } }
00157
00158 #endif